unifont-7.0.06.tar.gz
[unifont.git] / doc / unifontpic.texi
1 @comment TROFF INPUT: .TH UNIFONTPIC 1 "2013 Sep 07"
2
3 @node unifontpic
4 @section unifontpic
5 @c DEBUG: print_menu("@section")
6
7 @menu
8 * unifontpic NAME::
9 * unifontpic SYNOPSIS::
10 * unifontpic DESCRIPTION::
11 * unifontpic OPTIONS::
12 * unifontpic EXAMPLES::
13 * unifontpic FILES::
14 * unifontpic SEE ALSO::
15 * unifontpic AUTHOR::
16 * unifontpic LICENSE::
17 * unifontpic BUGS::
18
19 @end menu
20
21
22 @comment TROFF INPUT: .SH NAME
23
24 @node unifontpic NAME
25 @subsection unifontpic NAME
26 @c DEBUG: print_menu("unifontpic NAME")
27
28 unifontpic @minus{} Convert GNU Unifont .hex input to a bitmap image of the whole font
29 @comment TROFF INPUT: .SH SYNOPSIS
30
31 @node unifontpic SYNOPSIS
32 @subsection unifontpic SYNOPSIS
33 @c DEBUG: print_menu("unifontpic SYNOPSIS")
34
35 @comment TROFF INPUT: .br
36 @comment .br
37 @comment TROFF INPUT: .B unifontpic
38 @b{unifontpic}
39 [-dnnn][-l][-t] <
40 @comment TROFF INPUT: .I input-font.hex
41 @i{input-font.hex}
42 >
43 @comment TROFF INPUT: .I output-font.bmp
44 @i{output-font.bmp}
45 @comment TROFF INPUT: .SH DESCRIPTION
46
47 @node unifontpic DESCRIPTION
48 @subsection unifontpic DESCRIPTION
49 @c DEBUG: print_menu("unifontpic DESCRIPTION")
50
51 @comment TROFF INPUT: .B unifontpic
52 @b{unifontpic}
53 reads a GNU Unifont .hex file from STDIN and writes a two dimensional
54 rendering for each glyph to STDOUT.
55 The output displays the entire Unicode Basic Multilingual Plane (BMP)
56 as one large graphic image, showing a grid of 256 glyphs by 256 glyphs
57 as the default, or (at your option) 16 glyphs across by 4,096 glyphs down.
58 @comment TROFF INPUT: .PP
59
60 Input can be one or more files in Unifont .hex format.  They don't
61 have to be sorted, as
62 @comment TROFF INPUT: .B unifontpic
63 @b{unifontpic}
64 will populate the entire glyph array of 65,536 code points before
65 writing its output.  The input glyph code points should all be
66 unique, as feeding in duplicate code points will produce unpredictable
67 results.  Use
68 @comment TROFF INPUT: .B unidup (1)
69 @b{unidup (1)}
70 on a sorted input of .hex files to guarantee no code point
71 duplication.
72 @comment TROFF INPUT: .SH OPTIONS
73
74 @node unifontpic OPTIONS
75 @subsection unifontpic OPTIONS
76 @c DEBUG: print_menu("unifontpic OPTIONS")
77
78 @comment TROFF INPUT: .TP 12
79
80 @c ---------------------------------------------------------------------
81 @table @code
82 @item -dnnn
83 Specify a Dots per Inch (DPI) resolution of
84 @comment TROFF INPUT: .I nnn.
85 @i{nnn.}
86 For example, specifying -d120 will encode the bitmap graphics file
87 output as having a resolution of 120 DPI.
88 @comment TROFF INPUT: .TP
89
90 @item -l
91 Produce a long chart, 16 glyphs wide by 4,096 glyphs tall.
92 The default is a wide chart, 256 glyphs wide by 256 glyphs tall.
93 @comment TROFF INPUT: .TP
94
95 @item -t
96 Use tiny numbers for the row and column code point labels.  Tiny
97 numbers are on a 4 by 5 pixel grid.  Only tiny code point labels
98 appear on the long chart variant; this option only has effect
99 for wide charts (the default, of 256 by 256 glyphs).  If this option
100 is not specified for the default 256-by-256 grid, row and column
101 code point labels are taken from Unifont's glyphs for `0' to `9'
102 and `A' to `F'.
103 @comment TROFF INPUT: .SH EXAMPLES
104
105 @end table
106
107 @c ---------------------------------------------------------------------
108
109 @node unifontpic EXAMPLES
110 @subsection unifontpic EXAMPLES
111 @c DEBUG: print_menu("unifontpic EXAMPLES")
112
113 Sample usage:
114 @comment TROFF INPUT: .PP
115
116 @comment TROFF INPUT: .RS
117
118 @c ---------------------------------------------------------------------
119 @quotation
120 cat *.hex | unifontpic -d120 > unifontpic.bmp
121 @comment TROFF INPUT: .RE
122
123 @end quotation
124
125 @c ---------------------------------------------------------------------
126 @comment TROFF INPUT: .PP
127
128 To generate a bitmap that shows combining circles, from the
129 @comment TROFF INPUT: .B font/
130 @b{font/}
131 subdirectory:
132 @comment TROFF INPUT: .PP
133
134 @comment TROFF INPUT: .RS
135
136 @c ---------------------------------------------------------------------
137 @quotation
138 sort plane00/*.hex | unigencircles ttfsrc/combining.txt |
139 unifontpic -d120 >unifontpic.bmp
140 @comment TROFF INPUT: .RE
141
142 @end quotation
143
144 @c ---------------------------------------------------------------------
145 @comment TROFF INPUT: .SH FILES
146
147 @node unifontpic FILES
148 @subsection unifontpic FILES
149 @c DEBUG: print_menu("unifontpic FILES")
150
151 *.hex GNU Unifont font files
152 @comment TROFF INPUT: .SH SEE ALSO
153
154 @node unifontpic SEE ALSO
155 @subsection unifontpic SEE ALSO
156 @c DEBUG: print_menu("unifontpic SEE ALSO")
157
158 @comment TROFF INPUT: .BR bdfimplode(1),
159 @b{bdfimplode(1),}
160 @comment TROFF INPUT: .BR hex2bdf(1),
161 @b{hex2bdf(1),}
162 @comment TROFF INPUT: .BR hex2sfd(1),
163 @b{hex2sfd(1),}
164 @comment TROFF INPUT: .BR hexbraille(1),
165 @b{hexbraille(1),}
166 @comment TROFF INPUT: .BR hexdraw(1),
167 @b{hexdraw(1),}
168 @comment TROFF INPUT: .BR hexkinya(1),
169 @b{hexkinya(1),}
170 @comment TROFF INPUT: .BR hexmerge(1),
171 @b{hexmerge(1),}
172 @comment TROFF INPUT: .BR johab2ucs2(1),
173 @b{johab2ucs2(1),}
174 @comment TROFF INPUT: .BR unibdf2hex(1),
175 @b{unibdf2hex(1),}
176 @comment TROFF INPUT: .BR unibmp2hex(1),
177 @b{unibmp2hex(1),}
178 @comment TROFF INPUT: .BR unicoverage(1),
179 @b{unicoverage(1),}
180 @comment TROFF INPUT: .BR unidup(1),
181 @b{unidup(1),}
182 @comment TROFF INPUT: .BR unifont(5),
183 @b{unifont(5),}
184 @comment TROFF INPUT: .BR unifont-viewer(1),
185 @b{unifont-viewer(1),}
186 @comment TROFF INPUT: .BR unifontchojung(1),
187 @b{unifontchojung(1),}
188 @comment TROFF INPUT: .BR unifontksx(1),
189 @b{unifontksx(1),}
190 @comment TROFF INPUT: .BR unigencircles(1),
191 @b{unigencircles(1),}
192 @comment TROFF INPUT: .BR unigenwidth(1),
193 @b{unigenwidth(1),}
194 @comment TROFF INPUT: .BR unihex2bmp(1),
195 @b{unihex2bmp(1),}
196 @comment TROFF INPUT: .BR unihex2png(1),
197 @b{unihex2png(1),}
198 @comment TROFF INPUT: .BR unihexfill(1),
199 @b{unihexfill(1),}
200 @comment TROFF INPUT: .BR unihexgen(1),
201 @b{unihexgen(1),}
202 @comment TROFF INPUT: .BR unipagecount(1),
203 @b{unipagecount(1),}
204 @comment TROFF INPUT: .BR unipng2hex(1)
205 @b{unipng2hex(1)}
206 @comment TROFF INPUT: .SH AUTHOR
207
208 @node unifontpic AUTHOR
209 @subsection unifontpic AUTHOR
210 @c DEBUG: print_menu("unifontpic AUTHOR")
211
212 @comment TROFF INPUT: .B unifontpic
213 @b{unifontpic}
214 was written by Paul Hardy.
215 @comment TROFF INPUT: .SH LICENSE
216
217 @node unifontpic LICENSE
218 @subsection unifontpic LICENSE
219 @c DEBUG: print_menu("unifontpic LICENSE")
220
221 @comment TROFF INPUT: .B unifontpic
222 @b{unifontpic}
223 is Copyright @copyright{} 2013 Paul Hardy.
224 @comment TROFF INPUT: .PP
225
226 This program is free software; you can redistribute it and/or modify
227 it under the terms of the GNU General Public License as published by
228 the Free Software Foundation; either version 2 of the License, or
229 (at your option) any later version.
230 @comment TROFF INPUT: .SH BUGS
231
232 @node unifontpic BUGS
233 @subsection unifontpic BUGS
234 @c DEBUG: print_menu("unifontpic BUGS")
235
236 No known bugs exist.