Add man pages for lbxtool and lbximg

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

diff --git a/doc/man/lbximg.1 b/doc/man/lbximg.1
new file mode 100644 (file)
index 0000000..cebcef7
--- /dev/null
+++ b/doc/man/lbximg.1
@@ -0,0 +1,66 @@
+.Dd January 4, 2008
+.Os liblbx
+.Dt LBXIMG \&1 "2ooM Reference Manual"
+.Sh NAME
+.Nm lbximg
+.Nd inspect and decode LBX images
+.Sh SYNOPSIS
+.Nm
+.Op Fl i Ns | Ns Fl d
+.Op Fl v
+.Op Fl p Ar palette_file
+.Op Fl O Ar override_file
+.Op Fl f Ar path
+.Op Ar frameno ...
+.Sh DESCRIPTION
+.Nm
+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.
+.Sh OPTIONS
+.Bl -tag -width indent
+.It Fl i , -ident
+Sets the operating mode to identify the image format.
+.It Fl d , -decode
+Sets the operating mode to decode frames to PNG.
+.It Fl v , -verbose
+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.
+.It Fl p , -palette Ar palette_file
+Read the base palette from
+.Ar palette_file .
+In Moo2, these files are found in
+.Pa fonts.lbx .
+Without this option, the base palette is filled with a nice hot pink.  Colours
+in the base palette are superseded by those in the embedded palette and the
+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.
+.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
+the order in which frames are specified.  For example:
+.Bl -tag -width
+.It Nm Li -d 3 6
+Decode frames 3 and 6.
+.It Nm Li -d 4-9
+Decode frames 4 through 9, inclusive
+.It Nm Li -d 6-9 1-4
+Decode frames 1 through 9, except for frame 5.
+.It Nm Li -d 3-
+Decode all frames except the first 3.
+.El
+.El