← Back to branch summary

~ubuntu-branches/ubuntu/precise/xfonts-utils/precise

« back to all changes in this revision

Viewing changes to debian/local/update-fonts-alias.8

  • Committer: Bazaar Package Importer
  • Author(s): Colin Watson, Tollef Fog Heen, Colin Watson
  • Date: 2006-07-12 16:37:08 UTC
  • Revision ID: james.westby@ubuntu.com-20060712163708-1rhlbakh87jfixxy
Tags: 1:1.0.0-6ubuntu1
[ Tollef Fog Heen ]
* Remove /usr/share/X11/fonts and any empty sub-directories to clean up
  cruft left by fc-cache as well as update-fonts-{scale,dir,alias}

[ Colin Watson ]
* Slightly improve error-handling in the above, and do the .postinst.in
  boilerplate stuff so that the XSF build system doesn't clean it up for
  us.

Show diffs side-by-side

added added

removed removed

Lines of Context:
debian/local/update-fonts-alias.8
 
1
.\" $Id: update-fonts-alias.8 189 2005-06-11 00:04:27Z branden $
 
2
.\"
 
3
.\" Copyright 1999, 2002, 2004 Branden Robinson <branden@debian.org>.
 
4
.\"
 
5
.\" This is free software; you can redistribute it and/or modify it under
 
6
.\" the terms of the GNU General Public License as published by the Free
 
7
.\" Software Foundation, version 2.
 
8
.\"
 
9
.\" This is distributed in the hope that it will be useful, but WITHOUT
 
10
.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 
11
.\" FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 
12
.\" for more details.
 
13
.\"
 
14
.\" You should have received a copy of the GNU General Public License with
 
15
.\" the Debian operating system, in /usr/share/common-licenses/GPL;  if
 
16
.\" not, write to the Free Software Foundation, Inc., 59 Temple Place,
 
17
.\" Suite 330, Boston, MA 02111-1307 USA
 
18
.\"
 
19
.\" We need the URL macro from groff's www macro package, but also want
 
20
.\" things to work all right for people who don't have it.  So we define
 
21
.\" our own URL macro and let the www macro package override it if it's
 
22
.\" available.
 
23
.de URL
 
24
\\$2 \(laURL: \\$1 \(ra\\$3
 
25
..
 
26
.if \n[.g] .mso www.tmac
 
27
.TH update\-fonts\-alias 8 "2004\-11\-11" "Debian Project"
 
28
.SH NAME
 
29
update\-fonts\-alias \- compile fonts.alias files
 
30
.SH SYNOPSIS
 
31
.B update\-fonts\-alias
 
32
[\fIOPTION\fR]
 
33
.I directory ...
 
34
.SH DESCRIPTION
 
35
.B update\-fonts\-alias
 
36
assembles a
 
37
.I fonts.alias
 
38
file in an X font directory using one or more alias files found in a
 
39
subdirectory of
 
40
.IR /etc/X11/fonts/ .
 
41
It is typically invoked only from the post\-installation and post\-removal
 
42
scripts of a
 
43
.I  package
 
44
containing X Window System fonts that provide aliases for their XLFD names,
 
45
but may be invoked at any time to reconstruct
 
46
.I fonts.alias
 
47
files.
 
48
For each
 
49
.IR directory ,
 
50
which is simply the last component of its path (such as \(oq75dpi\(cq or
 
51
\(oqmisc\(cq),
 
52
.B update\-fonts\-alias
 
53
will assemble either
 
54
.IR /usr/lib/X11/fonts/ directory /fonts.alias
 
55
or
 
56
.IR /usr/share/fonts/X11/ directory /fonts.alias
 
57
from the files found in
 
58
.IR /etc/X11/fonts/ directory / package .alias .
 
59
.PP
 
60
This enables multiple packages to provide aliases for fonts in the same
 
61
directory.
 
62
No font package actually provides the
 
63
.I fonts.alias
 
64
file in the X font directory itself, so there is no danger of overwriting
 
65
one package's aliases with those of another.
 
66
.PP
 
67
For instance, the two packages \(oqxfonts\-base\(cq and
 
68
\(oqxfonts\-base\-transcoded\(cq may both install fonts into the directory
 
69
.IR /usr/lib/X11/fonts/misc .
 
70
They each place their
 
71
.I fonts.alias
 
72
files in
 
73
.I /etc/X11/fonts/misc/xfonts\-base.alias
 
74
and
 
75
.I /etc/X11/fonts/misc/xfonts\-base\-transcoded.alias
 
76
(respectively).
 
77
.B update\-fonts\-alias
 
78
concatenates these two files (as well as any others that match
 
79
.IR /etc/X11/fonts/misc/*.alias )
 
80
into
 
81
.IR /usr/lib/X11/fonts/misc/fonts.alias .
 
82
.PP
 
83
The format of
 
84
.I fonts.alias
 
85
files is described in the
 
86
.BR mkfontdir (1x)
 
87
manual page.
 
88
.PP
 
89
An example of how to use
 
90
.B update\-fonts\-alias
 
91
in package maintainer scripts is provided in the Debian Policy Manual.
 
92
.SH OPTIONS
 
93
.B \-h\fR, \fB\-\-help
 
94
displays a brief usage message and exits.
 
95
.SH OPERANDS
 
96
.B update\-fonts\-alias
 
97
takes one or more X font directory names to operate on as operands.
 
98
Only the final path component of the directory name should be specified;
 
99
e.g.,
 
100
.RS
 
101
.B update\-fonts\-alias 75dpi
 
102
.RE
 
103
is correct, while
 
104
.RB \(oq "update\-fonts\-alias /usr/X11R6/lib/X11/fonts/75dpi" \(cq
 
105
and
 
106
.RB \(oq "update\-fonts\-alias /usr/lib/X11/fonts/75dpi" \(cq
 
107
are not.
 
108
.SH ENVIRONMENT
 
109
.TP
 
110
.B COLUMNS
 
111
indicates the width of the terminal device in character cells.
 
112
This value is used for formatting diagnostic messages.
 
113
If not set, the terminal is queried using
 
114
.BR stty (1)
 
115
to determine its width.
 
116
If that fails, a value of \(oq80\(cq is assumed.
 
117
.SH DIAGNOSTICS
 
118
.SS Errors
 
119
.TP
 
120
.B usage error: one or more font directories must be provided
 
121
.B update\-fonts\-alias
 
122
was invoked without operands.
 
123
Supply one or more X font directory names to operate on.
 
124
.TP
 
125
.B usage error: unrecognized option
 
126
.B update\-fonts\-alias
 
127
was invoked with an unrecognized option argument.
 
128
Use only the options documented in \(lqOPTIONS\(rq, above.
 
129
.TP
 
130
.B fatal error: path to X font directory must be used
 
131
A directory name was supplied that was not an X font directory name.
 
132
Supply X font directory names only.
 
133
.SS Warnings
 
134
.TP
 
135
.BI "warning: absolute path " directory " was provided"
 
136
Usage of absolute paths is deprecated.
 
137
Use only the final component of the X font directory name for
 
138
.IR directory .
 
139
.TP
 
140
.BI "warning: " directory " does not exist or is not a directory"
 
141
The supplied
 
142
.I directory
 
143
was invalid.
 
144
.B update\-fonts\-alias
 
145
skipped it.
 
146
.SH "EXIT STATUS"
 
147
.TP
 
148
0
 
149
.B update\-fonts\-alias
 
150
ran successfully.
 
151
.TP
 
152
1
 
153
.B update\-fonts\-alias
 
154
experienced a fatal error; see the section on diagnostic messages above.
 
155
.TP
 
156
2
 
157
.B update\-fonts\-alias
 
158
was invoked with invalid arguments.
 
159
.SH BUGS
 
160
See
 
161
.URL "http://bugs.debian.org/xfonts\-utils" "the Debian Bug Tracking System" .
 
162
If you wish to report a bug in
 
163
.BR update\-fonts\-alias ,
 
164
please see
 
165
.I /usr/share/doc/debian/bug\-reporting.txt
 
166
or the
 
167
.BR reportbug (1)
 
168
command.
 
169
.SH AUTHOR
 
170
.B update\-fonts\-alias
 
171
was written by Branden Robinson.
 
172
.SH "SEE ALSO"
 
173
.BR mkfontdir (1x)
 
174
.\" vim:set et tw=80: