doc/unibmp2hex.texi

   1 @comment TROFF INPUT: .TH UNIBMP2HEX 1 "2007 Dec 31"
   2
   3 @node unibmp2hex
   4 @section unibmp2hex
   5 @c DEBUG: print_menu("@section")
   6
   7 @menu
   8 * unibmp2hex NAME::
   9 * unibmp2hex SYNOPSIS::
  10 * unibmp2hex DESCRIPTION::
  11 * unibmp2hex OPTIONS::
  12 * unibmp2hex FILES::
  13 * unibmp2hex SEE ALSO::
  14 * unibmp2hex AUTHOR::
  15 * unibmp2hex LICENSE::
  16 * unibmp2hex BUGS::
  17
  18 @end menu
  19
  20
  21 @comment TROFF INPUT: .SH NAME
  22
  23 @node unibmp2hex NAME
  24 @subsection unibmp2hex NAME
  25 @c DEBUG: print_menu("unibmp2hex NAME")
  26
  27 unibmp2hex @minus{} Bitmap graphics file to GNU Unifont .hex file converter
  28 @comment TROFF INPUT: .SH SYNOPSIS
  29
  30 @node unibmp2hex SYNOPSIS
  31 @subsection unibmp2hex SYNOPSIS
  32 @c DEBUG: print_menu("unibmp2hex SYNOPSIS")
  33
  34 @comment TROFF INPUT: .br
  35 @comment .br
  36 @comment TROFF INPUT: .B unibmp2hex
  37 @b{unibmp2hex}
  38 [-phexpage] [-iinput@t{_}file.bmp] [-ooutput@t{_}file.hex] [-w]
  39 @comment TROFF INPUT: .SH DESCRIPTION
  40
  41 @node unibmp2hex DESCRIPTION
  42 @subsection unibmp2hex DESCRIPTION
  43 @c DEBUG: print_menu("unibmp2hex DESCRIPTION")
  44
  45 @comment TROFF INPUT: .B unibmp2hex
  46 @b{unibmp2hex}
  47 reads a bitmap produced by
  48 @comment TROFF INPUT: .B unihex2bmp
  49 @b{unihex2bmp}
  50 before or after editing, and converts it back into a Unifont .hex format
  51 file.  The graphics file contains a block of 256 Unicode code points
  52 arranged in a 16 by 16 grid.  Each code point appears in a 32 by 32
  53 pixel grid.  Characters are either 16 rows high by 8 columns, or 16 rows by
  54 16 columns.
  55 @comment TROFF INPUT: .PP
  56
  57 @comment TROFF INPUT: .SH OPTIONS
  58
  59 @node unibmp2hex OPTIONS
  60 @subsection unibmp2hex OPTIONS
  61 @c DEBUG: print_menu("unibmp2hex OPTIONS")
  62
  63 @comment TROFF INPUT: .TP 12
  64
  65 @c ---------------------------------------------------------------------
  66 @table @code
  67 @item -ppagenum
  68 Specify that the code points will be assigned to the 256 block space
  69 @comment TROFF INPUT: .I pagenum
  70 @i{pagenum}
  71 in the .hex file.  If not specified,
  72 @comment TROFF INPUT: .B unibmp2hex
  73 @b{unibmp2hex}
  74 will determine the appropriate block by reading the row and column
  75 headers.  Note that "page" is not a standard
  76 Unicode term.  It refers to an output bitmap graphics page of
  77 16 by 16 code points.
  78 If
  79 @comment TROFF INPUT: .I pagenum
  80 @i{pagenum}
  81 is greater than FF, the block resides above the Unicode Basic
  82 Multilingual Plane. In that event, the .hex file will contain
  83 eight digit hexadecimal code points rather than the Unifont
  84 standard of four hexadecimal code points.
  85 @comment TROFF INPUT: .TP
  86
  87 @item -i
  88 Specify the input file. The default is STDIN.
  89 @comment TROFF INPUT: .TP
  90
  91 @item -o
  92 Specify the output file. The default is STDOUT.
  93 @comment TROFF INPUT: .TP
  94
  95 @item -w
  96 Force all output .hex glyphs to be 16 pixels wide rather than dual
  97 width (8 or 16 pixels).
  98 @comment TROFF INPUT: .PP
  99
 100 Sample usage:
 101 @comment TROFF INPUT: .PP
 102
 103 @comment TROFF INPUT: .RS
 104
 105 @c ---------------------------------------------------------------------
 106 @quotation
 107 unibmp2hex -imy@t{_}input@t{_}file.bmp -omy@t{_}output@t{_}file.hex
 108 @comment TROFF INPUT: .RE
 109
 110 @end quotation
 111
 112 @c ---------------------------------------------------------------------
 113 @comment TROFF INPUT: .SH FILES
 114
 115 @end table
 116
 117 @c ---------------------------------------------------------------------
 118
 119 @node unibmp2hex FILES
 120 @subsection unibmp2hex FILES
 121 @c DEBUG: print_menu("unibmp2hex FILES")
 122
 123 *.bmp or *.wbmp graphics files
 124 @comment TROFF INPUT: .SH SEE ALSO
 125
 126 @node unibmp2hex SEE ALSO
 127 @subsection unibmp2hex SEE ALSO
 128 @c DEBUG: print_menu("unibmp2hex SEE ALSO")
 129
 130 @comment TROFF INPUT: .BR bdfimplode(1),
 131 @b{bdfimplode(1),}
 132 @comment TROFF INPUT: .BR hex2bdf(1),
 133 @b{hex2bdf(1),}
 134 @comment TROFF INPUT: .BR hex2sfd(1),
 135 @b{hex2sfd(1),}
 136 @comment TROFF INPUT: .BR hexbraille(1),
 137 @b{hexbraille(1),}
 138 @comment TROFF INPUT: .BR hexdraw(1),
 139 @b{hexdraw(1),}
 140 @comment TROFF INPUT: .BR hexkinya(1),
 141 @b{hexkinya(1),}
 142 @comment TROFF INPUT: .BR hexmerge(1),
 143 @b{hexmerge(1),}
 144 @comment TROFF INPUT: .BR johab2ucs2(1),
 145 @b{johab2ucs2(1),}
 146 @comment TROFF INPUT: .BR unibdf2hex(1),
 147 @b{unibdf2hex(1),}
 148 @comment TROFF INPUT: .BR unicoverage(1),
 149 @b{unicoverage(1),}
 150 @comment TROFF INPUT: .BR unidup(1),
 151 @b{unidup(1),}
 152 @comment TROFF INPUT: .BR unifont(5),
 153 @b{unifont(5),}
 154 @comment TROFF INPUT: .BR unifont-viewer(1),
 155 @b{unifont-viewer(1),}
 156 @comment TROFF INPUT: .BR unifontchojung(1),
 157 @b{unifontchojung(1),}
 158 @comment TROFF INPUT: .BR unifontksx(1),
 159 @b{unifontksx(1),}
 160 @comment TROFF INPUT: .BR unifontpic(1),
 161 @b{unifontpic(1),}
 162 @comment TROFF INPUT: .BR unigencircles(1),
 163 @b{unigencircles(1),}
 164 @comment TROFF INPUT: .BR unigenwidth(1),
 165 @b{unigenwidth(1),}
 166 @comment TROFF INPUT: .BR unihex2bmp(1),
 167 @b{unihex2bmp(1),}
 168 @comment TROFF INPUT: .BR unihex2png(1),
 169 @b{unihex2png(1),}
 170 @comment TROFF INPUT: .BR unihexfill(1),
 171 @b{unihexfill(1),}
 172 @comment TROFF INPUT: .BR unihexgen(1),
 173 @b{unihexgen(1),}
 174 @comment TROFF INPUT: .BR unipagecount(1),
 175 @b{unipagecount(1),}
 176 @comment TROFF INPUT: .BR unipng2hex(1)
 177 @b{unipng2hex(1)}
 178 @comment TROFF INPUT: .SH AUTHOR
 179
 180 @node unibmp2hex AUTHOR
 181 @subsection unibmp2hex AUTHOR
 182 @c DEBUG: print_menu("unibmp2hex AUTHOR")
 183
 184 @comment TROFF INPUT: .B unibmp2hex
 185 @b{unibmp2hex}
 186 was written by Paul Hardy.
 187 @comment TROFF INPUT: .SH LICENSE
 188
 189 @node unibmp2hex LICENSE
 190 @subsection unibmp2hex LICENSE
 191 @c DEBUG: print_menu("unibmp2hex LICENSE")
 192
 193 @comment TROFF INPUT: .B unibmp2hex
 194 @b{unibmp2hex}
 195 is Copyright @copyright{} 2007, 2008 Paul Hardy.
 196 @comment TROFF INPUT: .PP
 197
 198 This program is free software; you can redistribute it and/or modify
 199 it under the terms of the GNU General Public License as published by
 200 the Free Software Foundation; either version 2 of the License, or
 201 (at your option) any later version.
 202 @comment TROFF INPUT: .SH BUGS
 203
 204 @node unibmp2hex BUGS
 205 @subsection unibmp2hex BUGS
 206 @c DEBUG: print_menu("unibmp2hex BUGS")
 207
 208 No known real bugs exist, except that this software does not perform
 209 extensive error checking on its input files.  If they're not in the
 210 format of the original bitmapped output from
 211 @comment TROFF INPUT: .B unihex2bmp,
 212 @b{unihex2bmp,}
 213 all bets are off.
 214 @comment TROFF INPUT: .PP
 215
 216 If the output file is for a "page" containing space code points and the
 217 bitmap file squares for those code points are not empty,
 218 @comment TROFF INPUT: .B unibmp2hex
 219 @b{unibmp2hex}
 220 preserves the graphics as they are drawn.