doc: Update man pages to reflect reality.

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

diff --git a/doc/man/lbximg.1 b/doc/man/lbximg.1
index cebcef74fcda32e3a86cc07141a8aba641f435b6..87bd3ee8f524a2726e0374fa79b90cc70be910db 100644 (file)
--- a/doc/man/lbximg.1
+++ b/doc/man/lbximg.1
@@ -1,4 +1,9 @@
-.Dd January 4, 2008
+.\" 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
 .Os liblbx
 .Dt LBXIMG \&1 "2ooM Reference Manual"
 .Sh NAME
@@ -8,6 +13,7 @@
 .Nm
 .Op Fl i Ns | Ns Fl d
 .Op Fl v
+.Op Fl n
 .Op Fl p Ar palette_file
 .Op Fl O Ar override_file
 .Op Fl f Ar path
@@ -30,11 +36,12 @@ Output additional information on standard output.
 .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, use the index itself for
+each of the red, green and blue components of the output.  This is mainly
+useful for debugging
+.Em liblbx .
 .It Fl p , -palette Ar palette_file
 Read the base palette from
 .Ar palette_file .
@@ -46,9 +53,15 @@ 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
+Print a short usage message and exit.
+.It Fl -help
+Print a help message and exit
 .It Ar frameno ...
 Specifies the frames to decode as a sequence of intervals, with frames indexing
 from zero.  By default, all frames are decoded.  Multiplicity is ignored, as is
@@ -64,3 +77,19 @@ Decode frames 1 through 9, except for frame 5.
 Decode all frames except the first 3.
 .El
 .El
+.Sh EXAMPLES
+After extracting fonts.lbx, mainmenu.lbx, logo.lbx and ships.lbx with
+.Xr lbxtool 1 :
+.Bl -tag -width indent
+.It Nm Li -ivf logo.lbx.000
+Print some information about the Simtex logo image.
+.It Nm Li -dvf mainmenu.lbx.000 -p fonts.lbx.006
+Decodes all the frames of the main menu panel into a series of PNGs.
+.It Nm Li -dvf logo.lbx.001
+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 SEE ALSO
+.Xr lbxtool 1 ,
+.Xr lbxgui 1