09682bb301de78238a13e8a3d27ea04868fbb272
[unifont.git] / doc / unigencircles.texi
1 @comment TROFF INPUT: .TH UNIGENCIRCLES 1 "2013 Sep 28"
2
3 @node unigencircles
4 @section unigencircles
5 @c DEBUG: print_menu("@section")
6
7 @menu
8 * unigencircles NAME::
9 * unigencircles SYNOPSIS::
10 * unigencircles DESCRIPTION::
11 * unigencircles EXAMPLE::
12 * unigencircles FILES::
13 * unigencircles SEE ALSO::
14 * unigencircles AUTHOR::
15 * unigencircles LICENSE::
16 * unigencircles BUGS::
17
18 @end menu
19
20
21 @comment TROFF INPUT: .SH NAME
22
23 @node unigencircles NAME
24 @subsection unigencircles NAME
25 @c DEBUG: print_menu("unigencircles NAME")
26
27 unigencircles @minus{} Add dashed combining circles to a unifont.hex file
28 @comment TROFF INPUT: .SH SYNOPSIS
29
30 @node unigencircles SYNOPSIS
31 @subsection unigencircles SYNOPSIS
32 @c DEBUG: print_menu("unigencircles SYNOPSIS")
33
34 @comment TROFF INPUT: .br
35 @comment .br
36 @comment TROFF INPUT: .B unigencircles
37 @b{unigencircles}
38 @comment TROFF INPUT: .I combining.txt nonprinting.hex
39 @i{combining.txt nonprinting.hex}
40 <
41 @comment TROFF INPUT: .I unifont.hex
42 @i{unifont.hex}
43 >
44 @comment TROFF INPUT: .I unifont-circles.hex
45 @i{unifont-circles.hex}
46 @comment TROFF INPUT: .SH DESCRIPTION
47
48 @node unigencircles DESCRIPTION
49 @subsection unigencircles DESCRIPTION
50 @c DEBUG: print_menu("unigencircles DESCRIPTION")
51
52 @comment TROFF INPUT: .B unigencircles
53 @b{unigencircles}
54 reads a unifont.hex file from STDIN, adds dashed combining
55 circles to the hex strings for code points listed in "combining.txt"
56 but not listed in "nonprinting.hex", and writes the revised set of glyphs
57 in unifont.hex format to STDOUT.  The resulting combining character glyphs
58 show the dashed combining circles that appear in The Unicode Standard
59 code charts.
60 @comment TROFF INPUT: .PP
61
62 For each code point listed in the "combining.txt" file but not listed
63 in the "nonprinting.hex" file,
64 @comment TROFF INPUT: .B unigencircles
65 @b{unigencircles}
66 will superimpose a single-width dashed circle in glyphs that are
67 single-width (i.e., their hex glyph strings are 32 characters long)
68 and will superimpose a double-width dashed circle in glyphs that
69 are double-width (i.e., their hex glyph strings are 64 characters long).
70 @comment TROFF INPUT: .SH EXAMPLE
71
72 @node unigencircles EXAMPLE
73 @subsection unigencircles EXAMPLE
74 @c DEBUG: print_menu("unigencircles EXAMPLE")
75
76 @comment TROFF INPUT: .PP
77
78 @comment TROFF INPUT: .RS
79
80 @c ---------------------------------------------------------------------
81 @quotation
82 unigencircles combining.txt nonprinting.hex < unifont.hex > unifont-circles.hex
83 @comment TROFF INPUT: .RE
84
85 @end quotation
86
87 @c ---------------------------------------------------------------------
88 @comment TROFF INPUT: .SH FILES
89
90 @node unigencircles FILES
91 @subsection unigencircles FILES
92 @c DEBUG: print_menu("unigencircles FILES")
93
94 *.hex files for Unifont glyph data
95 @comment TROFF INPUT: .PP
96
97 @comment TROFF INPUT: .B font/ttfsrc/combining.txt
98 @b{font/ttfsrc/combining.txt}
99 for combining code points
100 @comment TROFF INPUT: .PP
101
102 @comment TROFF INPUT: .B font/hexsrc/nonprinting.hex
103 @b{font/hexsrc/nonprinting.hex}
104 for non-printing code points
105 @comment TROFF INPUT: .SH SEE ALSO
106
107 @node unigencircles SEE ALSO
108 @subsection unigencircles SEE ALSO
109 @c DEBUG: print_menu("unigencircles SEE ALSO")
110
111 @comment TROFF INPUT: .BR bdfimplode(1),
112 @b{bdfimplode(1),}
113 @comment TROFF INPUT: .BR hex2bdf(1),
114 @b{hex2bdf(1),}
115 @comment TROFF INPUT: .BR hex2sfd(1),
116 @b{hex2sfd(1),}
117 @comment TROFF INPUT: .BR hexbraille(1),
118 @b{hexbraille(1),}
119 @comment TROFF INPUT: .BR hexdraw(1),
120 @b{hexdraw(1),}
121 @comment TROFF INPUT: .BR hexkinya(1),
122 @b{hexkinya(1),}
123 @comment TROFF INPUT: .BR hexmerge(1),
124 @b{hexmerge(1),}
125 @comment TROFF INPUT: .BR johab2ucs2(1),
126 @b{johab2ucs2(1),}
127 @comment TROFF INPUT: .BR unibdf2hex(1),
128 @b{unibdf2hex(1),}
129 @comment TROFF INPUT: .BR unibmp2hex(1),
130 @b{unibmp2hex(1),}
131 @comment TROFF INPUT: .BR unicoverage(1),
132 @b{unicoverage(1),}
133 @comment TROFF INPUT: .BR unidup(1),
134 @b{unidup(1),}
135 @comment TROFF INPUT: .BR unifont(5),
136 @b{unifont(5),}
137 @comment TROFF INPUT: .BR unifontchojung(1),
138 @b{unifontchojung(1),}
139 @comment TROFF INPUT: .BR unifontksx(1),
140 @b{unifontksx(1),}
141 @comment TROFF INPUT: .BR unifontpic(1),
142 @b{unifontpic(1),}
143 @comment TROFF INPUT: .BR unigenwidth(1),
144 @b{unigenwidth(1),}
145 @comment TROFF INPUT: .BR unihex2bmp(1),
146 @b{unihex2bmp(1),}
147 @comment TROFF INPUT: .BR unihex2png(1),
148 @b{unihex2png(1),}
149 @comment TROFF INPUT: .BR unihexgen(1),
150 @b{unihexgen(1),}
151 @comment TROFF INPUT: .BR unipagecount(1),
152 @b{unipagecount(1),}
153 @comment TROFF INPUT: .BR unipng2hex(1)
154 @b{unipng2hex(1)}
155 @comment TROFF INPUT: .SH AUTHOR
156
157 @node unigencircles AUTHOR
158 @subsection unigencircles AUTHOR
159 @c DEBUG: print_menu("unigencircles AUTHOR")
160
161 @comment TROFF INPUT: .B unigencircles
162 @b{unigencircles}
163 was written by Paul Hardy.
164 @comment TROFF INPUT: .SH LICENSE
165
166 @node unigencircles LICENSE
167 @subsection unigencircles LICENSE
168 @c DEBUG: print_menu("unigencircles LICENSE")
169
170 @comment TROFF INPUT: .B unigencircles
171 @b{unigencircles}
172 is Copyright @copyright{} 2013 Paul Hardy.
173 @comment TROFF INPUT: .PP
174
175 This program is free software; you can redistribute it and/or modify
176 it under the terms of the GNU General Public License as published by
177 the Free Software Foundation; either version 2 of the License, or
178 (at your option) any later version.
179 @comment TROFF INPUT: .SH BUGS
180
181 @node unigencircles BUGS
182 @subsection unigencircles BUGS
183 @c DEBUG: print_menu("unigencircles BUGS")
184
185 No known real bugs exist, except that this software does not perform
186 extensive error checking on its input files.