unifont-7.0.06.tar.gz
[unifont.git] / doc / unihexfill.texi
1 @comment TROFF INPUT: .TH UNIHEXFILL 1 "2014 Jun 30"
2
3 @node unihexfill
4 @section unihexfill
5 @c DEBUG: print_menu("@section")
6
7 @menu
8 * unihexfill NAME::
9 * unihexfill SYNOPSIS::
10 * unihexfill DESCRIPTION::
11 * unihexfill OPTIONS::
12 * unihexfill FILES::
13 * unihexfill EXAMPLE::
14 * unihexfill SEE ALSO::
15 * unihexfill AUTHOR::
16 * unihexfill LICENSE::
17 * unihexfill BUGS::
18
19 @end menu
20
21
22 @comment TROFF INPUT: .SH NAME
23
24 @node unihexfill NAME
25 @subsection unihexfill NAME
26 @c DEBUG: print_menu("unihexfill NAME")
27
28 unihexfill @minus{} Generate range of Unifont 4- or 6-digit hexadecimal glyphs
29 @comment TROFF INPUT: .SH SYNOPSIS
30
31 @node unihexfill SYNOPSIS
32 @subsection unihexfill SYNOPSIS
33 @c DEBUG: print_menu("unihexfill SYNOPSIS")
34
35 @comment TROFF INPUT: .br
36 @comment .br
37 @comment TROFF INPUT: .B unihexfill
38 @b{unihexfill}
39 <
40 @comment TROFF INPUT: .I unassigned-ranges.txt
41 @i{unassigned-ranges.txt}
42 >
43 @comment TROFF INPUT: .I filler-glyphs.hex
44 @i{filler-glyphs.hex}
45 @comment TROFF INPUT: .SH DESCRIPTION
46
47 @node unihexfill DESCRIPTION
48 @subsection unihexfill DESCRIPTION
49 @c DEBUG: print_menu("unihexfill DESCRIPTION")
50
51 @comment TROFF INPUT: .B unihexfill
52 @b{unihexfill}
53 is a shell script that reads a list of code point ranges from STDIN
54 and produces filler glyphs of 4- or 6-digit code points on STDOUT.
55 @comment TROFF INPUT: .P
56 @comment .P
57 The format of the input file is a combination of comment lines,
58 single code points on a line, and start/stop pairs of code points on
59 a line separated by a space.  Comment lines start with a semicolon (';')
60 by convention.  Start and stop code points are strings of hexadecimal
61 digits, by convention either four or six digits.
62 @comment TROFF INPUT: .P
63 @comment .P
64 @comment TROFF INPUT: .B unihexfill
65 @b{unihexfill}
66 invokes
67 @comment TROFF INPUT: .B unihexgen
68 @b{unihexgen}
69 for each non-comment line in its input file.  If a codepoint is less than
70 or equal to "FFFF" (i.e., 0xFFFF), a four-digit hexadecimal number is encoded
71 within the corresponding Unifont glyph as two digits on each of
72 two rows.  Otherwise, a six-digit hexadecimal number is encoded as
73 three digits on each of two rows.
74 @comment TROFF INPUT: .SH OPTIONS
75
76 @node unihexfill OPTIONS
77 @subsection unihexfill OPTIONS
78 @c DEBUG: print_menu("unihexfill OPTIONS")
79
80 There are no options.
81 @comment TROFF INPUT: .SH FILES
82
83 @node unihexfill FILES
84 @subsection unihexfill FILES
85 @c DEBUG: print_menu("unihexfill FILES")
86
87 *.txt as input; *.hex as output.
88 @comment TROFF INPUT: .SH EXAMPLE
89
90 @node unihexfill EXAMPLE
91 @subsection unihexfill EXAMPLE
92 @c DEBUG: print_menu("unihexfill EXAMPLE")
93
94 In the Unifont source package, the file font/plane01/Makefile generates
95 Unicode Plane 1 hexadecimal filler glyphs of unassigned code points within
96 assigned scripts with this single-line command:
97 @comment TROFF INPUT: .PP
98
99 @comment TROFF INPUT: .RS
100
101 @c ---------------------------------------------------------------------
102 @quotation
103 @comment TROFF INPUT: .B ../../bin/unihexfill
104 @b{../../bin/unihexfill}
105 < unassigned-ranges.txt > unassigned.hex
106 @comment TROFF INPUT: .RE
107
108 @end quotation
109
110 @c ---------------------------------------------------------------------
111 @comment TROFF INPUT: .SH SEE ALSO
112
113 @node unihexfill SEE ALSO
114 @subsection unihexfill SEE ALSO
115 @c DEBUG: print_menu("unihexfill SEE ALSO")
116
117 @comment TROFF INPUT: .BR bdfimplode(1),
118 @b{bdfimplode(1),}
119 @comment TROFF INPUT: .BR hex2bdf(1),
120 @b{hex2bdf(1),}
121 @comment TROFF INPUT: .BR hex2sfd(1),
122 @b{hex2sfd(1),}
123 @comment TROFF INPUT: .BR hexbraille(1),
124 @b{hexbraille(1),}
125 @comment TROFF INPUT: .BR hexdraw(1),
126 @b{hexdraw(1),}
127 @comment TROFF INPUT: .BR hexkinya(1),
128 @b{hexkinya(1),}
129 @comment TROFF INPUT: .BR hexmerge(1),
130 @b{hexmerge(1),}
131 @comment TROFF INPUT: .BR johab2ucs2(1),
132 @b{johab2ucs2(1),}
133 @comment TROFF INPUT: .BR unibdf2hex(1),
134 @b{unibdf2hex(1),}
135 @comment TROFF INPUT: .BR unibmp2hex(1),
136 @b{unibmp2hex(1),}
137 @comment TROFF INPUT: .BR unicoverage(1),
138 @b{unicoverage(1),}
139 @comment TROFF INPUT: .BR unidup(1),
140 @b{unidup(1),}
141 @comment TROFF INPUT: .BR unifont(5),
142 @b{unifont(5),}
143 @comment TROFF INPUT: .BR unifont-viewer(1),
144 @b{unifont-viewer(1),}
145 @comment TROFF INPUT: .BR unifontchojung(1),
146 @b{unifontchojung(1),}
147 @comment TROFF INPUT: .BR unifontksx(1),
148 @b{unifontksx(1),}
149 @comment TROFF INPUT: .BR unifontpic(1),
150 @b{unifontpic(1),}
151 @comment TROFF INPUT: .BR unigencircles(1),
152 @b{unigencircles(1),}
153 @comment TROFF INPUT: .BR unigenwidth(1),
154 @b{unigenwidth(1),}
155 @comment TROFF INPUT: .BR unihex2bmp(1),
156 @b{unihex2bmp(1),}
157 @comment TROFF INPUT: .BR unihex2png(1),
158 @b{unihex2png(1),}
159 @comment TROFF INPUT: .BR unihexgen(1),
160 @b{unihexgen(1),}
161 @comment TROFF INPUT: .BR unipagecount(1),
162 @b{unipagecount(1),}
163 @comment TROFF INPUT: .BR unipng2hex(1)
164 @b{unipng2hex(1)}
165 @comment TROFF INPUT: .SH AUTHOR
166
167 @node unihexfill AUTHOR
168 @subsection unihexfill AUTHOR
169 @c DEBUG: print_menu("unihexfill AUTHOR")
170
171 @comment TROFF INPUT: .B unihexfill
172 @b{unihexfill}
173 was written by Paul Hardy.
174 @comment TROFF INPUT: .SH LICENSE
175
176 @node unihexfill LICENSE
177 @subsection unihexfill LICENSE
178 @c DEBUG: print_menu("unihexfill LICENSE")
179
180 @comment TROFF INPUT: .B unihexfill
181 @b{unihexfill}
182 is Copyright @copyright{} 2014 Paul Hardy.
183 @comment TROFF INPUT: .PP
184
185 This program is free software; you can redistribute it and/or modify
186 it under the terms of the GNU General Public License as published by
187 the Free Software Foundation; either version 2 of the License, or
188 (at your option) any later version.
189 @comment TROFF INPUT: .SH BUGS
190
191 @node unihexfill BUGS
192 @subsection unihexfill BUGS
193 @c DEBUG: print_menu("unihexfill BUGS")
194
195 No known real bugs exist, except that this software does not perform
196 extensive error checking on its input file.  Any line that appears to
197 begin with a hexadecimal digit is fed to
198 @comment TROFF INPUT: .B unihexgen.
199 @b{unihexgen.}