unifont-6.3.20131215.tar.gz

[unifont.git] / man / unipng2hex.1

diff --git a/man/unipng2hex.1 b/man/unipng2hex.1
new file mode 100644 (file)
index 0000000..90cb376
--- /dev/null
+++ b/man/unipng2hex.1
@@ -0,0 +1,106 @@
+.TH UNIPNG2HEX 1 "2013 Nov 09"
+.SH NAME
+unipng2hex \- Portable Network Graphics to GNU Unifont .hex file converter
+.SH SYNOPSIS
+.br
+.B unipng2hex
+-i
+.I input_file.png
+[-o
+.I output_file.hex
+] [-w
+.I width
+]
+.SH DESCRIPTION
+.B unipng2hex
+reads a PNG file produced by
+.B unihex2png
+before or after editing, and converts it back into a Unifont .hex format
+file.  The PNG file contains a block of 256 Unicode code points
+arranged in a 16 by 16 grid.  Each code point appears in a 32 by 32 or a 40
+by 40 pixel grid.  Characters are either 16, 24 or 32 pixel rows high,
+depending on the "-r" parameter specified by
+.B unihex2png.
+They can be 8, 16, 24, or 32 pixel columns wide (widths of 32 are only
+supported for 32 pixel row tall characters).
+.PP
+.SH OPTIONS
+.TP 12
+-i
+Specify the input file.
+.TP
+-o
+Specify the output file.  If omitted, a file in the Unifont .hex format
+is written to STDOUT.
+.TP
+-w width
+Specify the minimum width of the output glyphs.  Valid values are 16, 24,
+ and 32.  The default is no minimum width.
+.TP
+-h 
+Print a help message of options and exit.
+.SH EXAMPLE
+Sample usage:
+.PP
+.RS
+unipng2hex -i my_input_file.png -o my_output_file.hex
+.RE
+.SH FILES
+*.png graphics files
+.SH SEE ALSO
+.BR bdfimplode(1),
+.BR hex2bdf(1),
+.BR hex2sfd(1),
+.BR hexbraille(1),
+.BR hexdraw(1),
+.BR hexmerge(1),
+.BR johab2ucs2(1),
+.BR unibdf2hex(1),
+.BR unibmp2hex(1),
+.BR unicoverage(1),
+.BR unidup(1),
+.BR unifont(5),
+.BR unifontchojung(1),
+.BR unifontksx(1),
+.BR unifontpic(1),
+.BR unigencircles(1),
+.BR unigenwidth(1),
+.BR unihex2bmp(1),
+.BR unihex2png(1),
+.BR unihexgen(1),
+.BR unipagecount(1)
+.SH AUTHOR
+.B unipng2hex
+was written by Andrew Miller, starting by converting Paul Hardy's
+.B unibmp2hex
+C program to Perl.
+.SH LICENSE
+.B unipng2hex
+is Copyright \(co 2007, 2008 Paul Hardy, \(co 2013 Andrew Miller.
+.PP
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+.SH BUGS
+No known real bugs exist, but the optional pixel rows parameter is not
+yet supported by all other Unifont utilities.  Use of glyphs taller than
+the default of 16 pixels is considered experimental.  Currently
+.B unihex2png, unipng2hex, hexdraw,
+and
+.B hex2bdf
+tentatively support glyphs that are 16, 24, and 32 pixels tall.
+.PP
+Also, this software does not perform extensive error checking on its
+input files.  If they're not in the format of the original PNG output from
+.B unihex2png,
+all bets are off.
+.PP
+If the output file is for a "page" containing space code points and the
+PNG file squares for those code points are not empty,
+.B unipng2hex
+preserves the graphics as they are drawn.
+.PP
+.B unipng2hex
+is designed to work with black and white pixels; do not use other
+colors.