chiark / gitweb /
fix wrong bug# (oops!) (again)
[xfonts-traditional.git] / update-xfonts-traditional.8
1 .\" Hey, Emacs!  This is an -*- nroff -*- source file.
2 .TH UPDATE\-XFONTS\-TRADITIONAL 8 "2012" "Greenend" "chiark utilities"
3 .SH NAME
4 update\-xfonts\-traditional \- generate traditional ASCII fixed-with fonts
5 .SH SYNOPSIS
6 .B update\-xfonts\-traditional --bdf-filter
7 .LP
8 .B update\-xfonts\-traditional --process-pcf \fIin.pcf.gz\fP \fIout.pcf.gz\fP
9 .LP
10 .B update\-xfonts\-traditional --process-fontdirs \fIfontdir\fR ...
11 .LP
12 .B update\-xfonts\-traditional --process-fonttrees \fIfonttree\fR ...
13 .SH DESCRIPTION
14 .B update\-xfonts\-traditional
15 generates versions of X11 PCF fonts which have been edited to restore
16 compatibility with traditional versions of US-ASCII, and to restore
17 some of the glyphs to more traditional appearance.
18 .SH MODES
19 .TP
20 .BI --bdf-filter
21 Takes a BDF on standard input and tries to generate an edited BDF on
22 standard output.
23 .TP
24 .BI --process-pcf
25 Takes to PCF filename arguments; the input PCF is uncompressed,
26 decompiled to a BDF, processed, recompiled to a PCF and recompressed.
27 .TP
28 .BI --process-fontdirs
29 In each
30 .I fontdir
31 all files
32 .IB font .pcf.gz
33 are processed, to generate where applicable corresponding
34 .BI trad-- font .pcf.gz
35 files.  The mtime, ctime and inode number of the input files are
36 recorded so that reprocessing the same directory later will be fast.
37 .TP
38 .BI --process-fonttrees
39 Each
40 .I fonttree
41 is searched for font directories which are processed as above.
42 .TP
43 .BI --update
44 Each built in font tree location is searched for font directories
45 which are processed as above.
46 .SH OPTIONS
47 .TP
48 \fB-R\fP|\fB--rules-path\fP \fIrulespath\fP
49 Prepend
50 .I rulespath
51 to the path of directories from which to load glyph editing rules.
52 .TP
53 \fB--share-dir\fP \fIshare-dir\fP
54 Use
55 .I share-dir
56 instead of
57 .BR "/usr[/local]/share/xfonts-traditional" .
58 .TP
59 \fB--parallel\fP|\fB-j\fP \fIcpus\fP
60 Use up to
61 .I cpus
62 cores for processing fonts.  The default is all the cpus available.
63 .TP
64 \fB--always-reprocess
65 When scanning font directories, always reprocess all the fonts,
66 regardless of whether we think they have been done already.
67 .TP
68 \fB--no-tolerate-bad-fonts
69 Treat bad input fonts (eg, ones for which pcf2bdf crashes, or ones
70 with other problems) as a fatal error.  Normally they just produce
71 a warning.
72 .SH FILES
73 .TP
74 .B xfonts-traditional.done
75 In each font directory, records information about processed fonts, so
76 as to optimise away unnecessary reprocessing.
77 .TP
78 .B xfonts-traditional.log
79 In each font directory, records a lot of which fonts were processed
80 and to a certain extent if not why not.
81 .TP
82 .B /usr/share/fonts/X11 /usr/local/share/fonts/X11
83 Default font tree paths for --update.
84 .TP
85 .BI trad-- font .pcf.gz
86 In any font directory, our output files.  Any other files matching
87 this pattern may be overwritten or deleted.
88 .SH EXIT STATUS
89 .TP
90 .B 0
91 All went well and there were no warnings.
92 .TP
93 .B 2
94 With
95 .B --bdf-filter
96 and
97 .B --process-pcf
98 only, indicates that the input font did not need to
99 be edited, or was not suitable for editing, and has
100 .B not
101 been written out, so the output is incomplete, but this is not an
102 error.
103 .TP
104 any other
105 There were problems.
106 .SH BUGS
107 Only the 6x13 font conventionally called \"fixed\" is currently
108 supported.  This package comes too late to rescue Unix from an
109 incompatible change to its character set.