lbximg: Add support for Netpbm output.

[liblbx.git] / doc / man / lbximg.1

diff --git a/doc/man/lbximg.1 b/doc/man/lbximg.1
index 87bd3ee8f524a2726e0374fa79b90cc70be910db..f3ecece9de0d1dd5f16c6d72dc02a9a6166f1d65 100644 (file)
--- a/doc/man/lbximg.1
+++ b/doc/man/lbximg.1
@@ -1,9 +1,4 @@
-.\" Copyright (C) 2008-2010 Nick Bowler
-.\" Copying and distribution of this file, with or without modification,
-.\" are permitted in any medium without royalty provided the copyright
-.\" notice and this notice are preserved.  This file is offered as-is,
-.\" without any warranty.
-.Dd February 9, 2010
+.Dd June 14, 2013
 .Os liblbx
 .Dt LBXIMG \&1 "2ooM Reference Manual"
 .Sh NAME
@@ -14,6 +9,7 @@
 .Op Fl i Ns | Ns Fl d
 .Op Fl v
 .Op Fl n
+.Op Fl F Ar format
 .Op Fl p Ar palette_file
 .Op Fl O Ar override_file
 .Op Fl f Ar path
@@ -24,7 +20,8 @@ identifies and decodes LBX image files, using
 .Em liblbx .
 LBX images are multi-frame, 256-colour paletted images with transparency.
 .Nm
-can be used to convert some or all of the frames of an LBX image to PNG.
+can be used to convert some or all of the frames of an LBX image to other image
+formats.
 .Sh OPTIONS
 .Bl -tag -width indent
 .It Fl i , -ident
@@ -33,14 +30,44 @@ Sets the operating mode to identify the image format.
 Sets the operating mode to decode frames to PNG.
 .It Fl v , -verbose
 Output additional information on standard output.
+.It Fl F , -format Ar format
+Select the desired output format.  Some formats may not be available depending
+on the compile-time settings of
+.Nm .
+If this option is not specified, the default is the first in the following list
+which is enabled at build time.
+.Bl -column -offset indent ".Em Format"
+.It Em Format Ta Em Description
+.It png Ta
+Output images in Portable Network Graphics (PNG) format.  This is is a
+compressed format which is well-supported by other tools.  All features of
+.Nm
+are supported with this format.
+.It pam Ta
+Output images in Netpbm PAM format.  This is a simple uncompressed binary image
+format supporting RGB and alpha channels.  All features of
+.Nm
+are supported with this format.
+.It ppm Ta
+Output image colour data in Netpbm "plain" PPM format.  This is a simple
+7-bit clean uncompressed RGB format.  It does not support transparency, so
+images will have transparent pixels replaced with black.  This format is
+rather inefficient and provided mainly for testing.
+.It pbm Ta
+Output image mask data in Netpbm "plain" PBM format.  This is a simple 7-bit
+clean uncompressed bitmap format.  It does not support colour data; instead,
+bitmap values represent whether or not a pixel is transparent.  Black (1)
+pixels are transparent, white (0) pixels are opaque.  This format is extremely
+inefficient and provided mainly for testing.
+.El
 .It Fl f , -file Ar path
 Read from the specified
 .Ar path
 instead of standard input.
 .It Fl n , -no-palette
-Instead of looking up colour indices in the palette, use the index itself for
-each of the red, green and blue components of the output.  This is mainly
-useful for debugging
+Instead of looking up colour indices in the palette, emit a grayscale image
+where the intensity value of a pixel is equal to the palette index itself.
+This is mainly useful for debugging the image decoder in
 .Em liblbx .
 .It Fl p , -palette Ar palette_file
 Read the base palette from
@@ -90,6 +117,13 @@ Decodes all the frames of the Microprose logo into a series of PNGs.
 .It Nm Li -dvf ships.lbx.042 -p fonts.lbx.012 -O ships.lbx.049
 Decodes an image of a red star fortress.
 .El
+.Sh AUTHORS
+Nick Bowler <nbowler@draconx.ca>
+.Sh COPYRIGHT
+Copyright \(co 2008\(en2010, 2013 Nick Bowler
+.Pp
+Permission is granted to copy, distribute and/or modify this manual under the
+terms of the Do What The Fuck You Want To Public License, version 2.
 .Sh SEE ALSO
 .Xr lbxtool 1 ,
 .Xr lbxgui 1