X-Git-Url: https://git.draconx.ca/gitweb/liblbx.git/blobdiff_plain/30a5cc51eaad9d592b8016d81c74bbde4ca9022b..af13a143c8bfcd713216b1382448174e21b9f278:/doc/man/lbximg.1

diff --git a/doc/man/lbximg.1 b/doc/man/lbximg.1
index 245826a..f3ecece 100644
--- a/doc/man/lbximg.1
+++ b/doc/man/lbximg.1
@@ -1,9 +1,4 @@
-.\" Copyright (C) 2009 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 January 4, 2008
+.Dd June 14, 2013
 .Os liblbx
 .Dt LBXIMG \&1 "2ooM Reference Manual"
 .Sh NAME
@@ -13,6 +8,8 @@
 .Nm
 .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
@@ -23,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
@@ -32,14 +30,45 @@ 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.  If
-.Ar path
-is -,
-.Nm
-will read from standard input anyway.
+instead of standard input.
+.It Fl n , -no-palette
+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
 .Ar palette_file .
@@ -51,9 +80,9 @@ override palette.
 .It Fl O , -override Ar override_file
 Use the embedded palette of an LBX image specified by
 .Ar override_file
-as the override palette.  In Moo2, this is notably used to select the player
-colour for ship images.  Colours in the override palette supersede those in
-both the base palette and the embedded palette.
+as the override palette.  One example of where this is used is for selecting
+the player colour for ship images.  Colours in the override palette supersede
+those in both the base palette and the embedded palette.
 .It Fl V , -version
 Print a version message and exit.
 .It Fl -usage
@@ -88,5 +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 lbxtool 1 ,
+.Xr lbxgui 1