unifont-7.0.06.tar.gz
[unifont.git] / doc / unigenwidth.texi
1 @comment TROFF INPUT: .TH UNIGENWIDTH 1 "2013 Sep 10"
2
3 @node unigenwidth
4 @section unigenwidth
5 @c DEBUG: print_menu("@section")
6
7 @menu
8 * unigenwidth NAME::
9 * unigenwidth SYNOPSIS::
10 * unigenwidth DESCRIPTION::
11 * unigenwidth EXAMPLE::
12 * unigenwidth FILES::
13 * unigenwidth SEE ALSO::
14 * unigenwidth AUTHOR::
15 * unigenwidth LICENSE::
16 * unigenwidth BUGS::
17
18 @end menu
19
20
21 @comment TROFF INPUT: .SH NAME
22
23 @node unigenwidth NAME
24 @subsection unigenwidth NAME
25 @c DEBUG: print_menu("unigenwidth NAME")
26
27 unigenwidth @minus{} Generate C code for POSIX wcwidth and wcswidth functions
28 @comment TROFF INPUT: .SH SYNOPSIS
29
30 @node unigenwidth SYNOPSIS
31 @subsection unigenwidth SYNOPSIS
32 @c DEBUG: print_menu("unigenwidth SYNOPSIS")
33
34 @comment TROFF INPUT: .br
35 @comment .br
36 @comment TROFF INPUT: .B unigenwidth
37 @b{unigenwidth}
38 @comment TROFF INPUT: .I unifont.hex combining.txt
39 @i{unifont.hex combining.txt}
40 @comment TROFF INPUT: .SH DESCRIPTION
41
42 @node unigenwidth DESCRIPTION
43 @subsection unigenwidth DESCRIPTION
44 @c DEBUG: print_menu("unigenwidth DESCRIPTION")
45
46 @comment TROFF INPUT: .B unigenwidth
47 @b{unigenwidth}
48 reads a collection of glyphs in Unifont's .hex format,
49 then reads a list of combining characters as a hexadecimal list.
50 From these two files, it produces C code to implement the POSIX
51 @comment TROFF INPUT: .BR wcwidth(3)
52 @b{wcwidth(3)}
53 and
54 @comment TROFF INPUT: .BR wcswidth(3)
55 @b{wcswidth(3)}
56 functions.  The format of these definitions is based upon
57 POSIX 1003.1-2008 System Interfaces, pages 2251 and 2241, respectively.
58 @comment TROFF INPUT: .SH EXAMPLE
59
60 @node unigenwidth EXAMPLE
61 @subsection unigenwidth EXAMPLE
62 @c DEBUG: print_menu("unigenwidth EXAMPLE")
63
64 @comment TROFF INPUT: .PP
65
66 Sample usage:
67 @comment TROFF INPUT: .PP
68
69 @comment TROFF INPUT: .RS
70
71 @c ---------------------------------------------------------------------
72 @quotation
73 unigenwidth unifont.hex combining.txt > wccode.c
74 @comment TROFF INPUT: .RE
75
76 @end quotation
77
78 @c ---------------------------------------------------------------------
79 @comment TROFF INPUT: .SH FILES
80
81 @node unigenwidth FILES
82 @subsection unigenwidth FILES
83 @c DEBUG: print_menu("unigenwidth FILES")
84
85 *.hex files for Unifont glyph data; combining.txt for combining code points.
86 @comment TROFF INPUT: .SH SEE ALSO
87
88 @node unigenwidth SEE ALSO
89 @subsection unigenwidth SEE ALSO
90 @c DEBUG: print_menu("unigenwidth SEE ALSO")
91
92 @comment TROFF INPUT: .BR bdfimplode(1),
93 @b{bdfimplode(1),}
94 @comment TROFF INPUT: .BR hex2bdf(1),
95 @b{hex2bdf(1),}
96 @comment TROFF INPUT: .BR hex2sfd(1),
97 @b{hex2sfd(1),}
98 @comment TROFF INPUT: .BR hexbraille(1),
99 @b{hexbraille(1),}
100 @comment TROFF INPUT: .BR hexdraw(1),
101 @b{hexdraw(1),}
102 @comment TROFF INPUT: .BR hexkinya(1),
103 @b{hexkinya(1),}
104 @comment TROFF INPUT: .BR hexmerge(1),
105 @b{hexmerge(1),}
106 @comment TROFF INPUT: .BR johab2ucs2(1),
107 @b{johab2ucs2(1),}
108 @comment TROFF INPUT: .BR unibdf2hex(1),
109 @b{unibdf2hex(1),}
110 @comment TROFF INPUT: .BR unibmp2hex(1),
111 @b{unibmp2hex(1),}
112 @comment TROFF INPUT: .BR unicoverage(1),
113 @b{unicoverage(1),}
114 @comment TROFF INPUT: .BR unidup(1),
115 @b{unidup(1),}
116 @comment TROFF INPUT: .BR unifont(5),
117 @b{unifont(5),}
118 @comment TROFF INPUT: .BR unifont-viewer(1),
119 @b{unifont-viewer(1),}
120 @comment TROFF INPUT: .BR unifontchojung(1),
121 @b{unifontchojung(1),}
122 @comment TROFF INPUT: .BR unifontksx(1),
123 @b{unifontksx(1),}
124 @comment TROFF INPUT: .BR unifontpic(1),
125 @b{unifontpic(1),}
126 @comment TROFF INPUT: .BR unigencircles(1),
127 @b{unigencircles(1),}
128 @comment TROFF INPUT: .BR unihex2bmp(1),
129 @b{unihex2bmp(1),}
130 @comment TROFF INPUT: .BR unihex2png(1),
131 @b{unihex2png(1),}
132 @comment TROFF INPUT: .BR unihexfill(1),
133 @b{unihexfill(1),}
134 @comment TROFF INPUT: .BR unihexgen(1),
135 @b{unihexgen(1),}
136 @comment TROFF INPUT: .BR unipagecount(1),
137 @b{unipagecount(1),}
138 @comment TROFF INPUT: .BR unipng2hex(1)
139 @b{unipng2hex(1)}
140 @comment TROFF INPUT: .SH AUTHOR
141
142 @node unigenwidth AUTHOR
143 @subsection unigenwidth AUTHOR
144 @c DEBUG: print_menu("unigenwidth AUTHOR")
145
146 @comment TROFF INPUT: .B unigenwidth
147 @b{unigenwidth}
148 was written by Paul Hardy.
149 @comment TROFF INPUT: .SH LICENSE
150
151 @node unigenwidth LICENSE
152 @subsection unigenwidth LICENSE
153 @c DEBUG: print_menu("unigenwidth LICENSE")
154
155 @comment TROFF INPUT: .B unigenwidth
156 @b{unigenwidth}
157 is Copyright @copyright{} 2013 Paul Hardy.
158 @comment TROFF INPUT: .PP
159
160 This program is free software; you can redistribute it and/or modify
161 it under the terms of the GNU General Public License as published by
162 the Free Software Foundation; either version 2 of the License, or
163 (at your option) any later version.
164 @comment TROFF INPUT: .SH BUGS
165
166 @node unigenwidth BUGS
167 @subsection unigenwidth BUGS
168 @c DEBUG: print_menu("unigenwidth BUGS")
169
170 No known real bugs exist, except that this software does not perform
171 extensive error checking on its input files.