a46733c48043a2876a533ca66fbae80b62266e90
[unifont.git] / doc / unihex2bmp.texi
1 @comment TROFF INPUT: .TH UNIHEX2BMP 1 "2007 Dec 31"
2
3 @node unihex2bmp
4 @section unihex2bmp
5 @c DEBUG: print_menu("@section")
6
7 @menu
8 * unihex2bmp NAME::
9 * unihex2bmp SYNOPSIS::
10 * unihex2bmp DESCRIPTION::
11 * unihex2bmp OPTIONS::
12 * unihex2bmp FILES::
13 * unihex2bmp SEE ALSO::
14 * unihex2bmp AUTHOR::
15 * unihex2bmp LICENSE::
16 * unihex2bmp BUGS::
17
18 @end menu
19
20
21 @comment TROFF INPUT: .SH NAME
22
23 @node unihex2bmp NAME
24 @subsection unihex2bmp NAME
25 @c DEBUG: print_menu("unihex2bmp NAME")
26
27 unihex2bmp @minus{} GNU Unifont .hex file to bitmap graphics file converter
28 @comment TROFF INPUT: .SH SYNOPSIS
29
30 @node unihex2bmp SYNOPSIS
31 @subsection unihex2bmp SYNOPSIS
32 @c DEBUG: print_menu("unihex2bmp SYNOPSIS")
33
34 @comment TROFF INPUT: .br
35 @comment .br
36 @comment TROFF INPUT: .B unihex2bmp
37 @b{unihex2bmp}
38 [-phexpage] [-iinput@t{_}file.hex] [-ooutput@t{_}file.bmp] [-f] [-w]
39 @comment TROFF INPUT: .SH DESCRIPTION
40
41 @node unihex2bmp DESCRIPTION
42 @subsection unihex2bmp DESCRIPTION
43 @c DEBUG: print_menu("unihex2bmp DESCRIPTION")
44
45 @comment TROFF INPUT: .B unihex2bmp
46 @b{unihex2bmp}
47 reads a GNU Unifont .hex file Unicode page of 256 code points
48 and converts the page into a Microsoft Windows Bitmap (.bmp) or
49 Wireless Bitmap (.wbmp) file.  The bitmap file displays the glyphs
50 of a Unicode block of 256 code points in a 32 by 32 pixel grid.
51 The glyphs themselves must be 16 rows high, and either 8 columns or
52 16 columns wide. The default page is 0; that is, the range
53 U+0000 through U+00FF.
54 @comment TROFF INPUT: .PP
55
56 The bitmap can be printed.  It can also be edited with a bitmap editor.
57 An edited bitmap can then be re-converted into a GNU Unifont .hex file
58 with the
59 @comment TROFF INPUT: .B unibmp2hex
60 @b{unibmp2hex}
61 command.
62 @comment TROFF INPUT: .PP
63
64 @comment TROFF INPUT: .SH OPTIONS
65
66 @node unihex2bmp OPTIONS
67 @subsection unihex2bmp OPTIONS
68 @c DEBUG: print_menu("unihex2bmp OPTIONS")
69
70 @comment TROFF INPUT: .TP 12
71
72 @c ---------------------------------------------------------------------
73 @table @code
74 @item -ppagenum
75 Extract page
76 @comment TROFF INPUT: .I pagenum
77 @i{pagenum}
78 from the .hex file.  The default is Page 0 (Unicode range
79 U+0000 through U+00FF).  Note that "page" is not a standard
80 Unicode term.  It refers to an output bitmap graphics page of
81 16 by 16 code points.
82 @comment TROFF INPUT: .TP
83
84 @item -i
85 Specify the input file. The default is STDIN.
86 @comment TROFF INPUT: .TP
87
88 @item -o
89 Specify the output file. The default is STDOUT.
90 @comment TROFF INPUT: .TP
91
92 @item -f
93 "Flip" (transpose) the grid so it matches the Unicode standard order.
94 @comment TROFF INPUT: .TP
95
96 @item -w
97 Produce a Wireless Bitmap format file instead of a Microsoft Windows
98 Bitmap file.
99 @comment TROFF INPUT: .PP
100
101 Sample usage:
102 @comment TROFF INPUT: .PP
103
104 @comment TROFF INPUT: .RS
105
106 @c ---------------------------------------------------------------------
107 @quotation
108 unihex2bmp -imy@t{_}input@t{_}file.hex -omy@t{_}output@t{_}file.bmp
109 @comment TROFF INPUT: .RE
110
111 @end quotation
112
113 @c ---------------------------------------------------------------------
114 @comment TROFF INPUT: .SH FILES
115
116 @end table
117
118 @c ---------------------------------------------------------------------
119
120 @node unihex2bmp FILES
121 @subsection unihex2bmp FILES
122 @c DEBUG: print_menu("unihex2bmp FILES")
123
124 *.hex GNU Unifont font files
125 @comment TROFF INPUT: .SH SEE ALSO
126
127 @node unihex2bmp SEE ALSO
128 @subsection unihex2bmp SEE ALSO
129 @c DEBUG: print_menu("unihex2bmp SEE ALSO")
130
131 @comment TROFF INPUT: .BR bdfimplode(1),
132 @b{bdfimplode(1),}
133 @comment TROFF INPUT: .BR hex2bdf(1),
134 @b{hex2bdf(1),}
135 @comment TROFF INPUT: .BR hex2sfd(1),
136 @b{hex2sfd(1),}
137 @comment TROFF INPUT: .BR hexbraille(1),
138 @b{hexbraille(1),}
139 @comment TROFF INPUT: .BR hexdraw(1),
140 @b{hexdraw(1),}
141 @comment TROFF INPUT: .BR hexmerge(1),
142 @b{hexmerge(1),}
143 @comment TROFF INPUT: .BR johab2ucs2(1),
144 @b{johab2ucs2(1),}
145 @comment TROFF INPUT: .BR unibdf2hex(1),
146 @b{unibdf2hex(1),}
147 @comment TROFF INPUT: .BR unibmp2hex(1),
148 @b{unibmp2hex(1),}
149 @comment TROFF INPUT: .BR unicoverage(1),
150 @b{unicoverage(1),}
151 @comment TROFF INPUT: .BR unidup(1),
152 @b{unidup(1),}
153 @comment TROFF INPUT: .BR unifont(5),
154 @b{unifont(5),}
155 @comment TROFF INPUT: .BR unifontchojung(1),
156 @b{unifontchojung(1),}
157 @comment TROFF INPUT: .BR unifontksx(1),
158 @b{unifontksx(1),}
159 @comment TROFF INPUT: .BR unifontpic(1),
160 @b{unifontpic(1),}
161 @comment TROFF INPUT: .BR unigencircles(1),
162 @b{unigencircles(1),}
163 @comment TROFF INPUT: .BR unigenwidth(1),
164 @b{unigenwidth(1),}
165 @comment TROFF INPUT: .BR unihex2png(1),
166 @b{unihex2png(1),}
167 @comment TROFF INPUT: .BR unihexgen(1),
168 @b{unihexgen(1),}
169 @comment TROFF INPUT: .BR unipagecount(1),
170 @b{unipagecount(1),}
171 @comment TROFF INPUT: .BR unipng2hex(1)
172 @b{unipng2hex(1)}
173 @comment TROFF INPUT: .SH AUTHOR
174
175 @node unihex2bmp AUTHOR
176 @subsection unihex2bmp AUTHOR
177 @c DEBUG: print_menu("unihex2bmp AUTHOR")
178
179 @comment TROFF INPUT: .B unihex2bmp
180 @b{unihex2bmp}
181 was written by Paul Hardy.
182 @comment TROFF INPUT: .SH LICENSE
183
184 @node unihex2bmp LICENSE
185 @subsection unihex2bmp LICENSE
186 @c DEBUG: print_menu("unihex2bmp LICENSE")
187
188 @comment TROFF INPUT: .B unihex2bmp
189 @b{unihex2bmp}
190 is Copyright @copyright{} 2007 Paul Hardy.
191 @comment TROFF INPUT: .PP
192
193 This program is free software; you can redistribute it and/or modify
194 it under the terms of the GNU General Public License as published by
195 the Free Software Foundation; either version 2 of the License, or
196 (at your option) any later version.
197 @comment TROFF INPUT: .SH BUGS
198
199 @node unihex2bmp BUGS
200 @subsection unihex2bmp BUGS
201 @c DEBUG: print_menu("unihex2bmp BUGS")
202
203 No known real bugs exist, except that this software does not perform
204 extensive error checking on its input files.  If they're not in the
205 format of the original GNU Unifont .hex file, all bets are off.
206 Lines can be terminated either with line feed, or
207 carriage return plus line feed.