Add man pages for lbxtool and lbximg

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

diff --git a/doc/man/lbxtool.1 b/doc/man/lbxtool.1
new file mode 100644 (file)
index 0000000..a5ac319
--- /dev/null
+++ b/doc/man/lbxtool.1
@@ -0,0 +1,41 @@
+.Dd January 4, 2008
+.Os liblbx
+.Dt LBXTOOL \&1 "2ooM Reference Manual"
+.Sh NAME
+.Nm lbxtool
+.Nd manipulate LBX archives
+.Sh SYNOPSIS
+.Nm
+.Op Fl l Ns | Ns Fl x
+.Op Fl v
+.Op Fl f Ar path
+.Op Ar
+.Sh DESCRIPTION
+.Nm
+lists and extracts files from LBX archives (the format used by Moo2),
+using
+.Em liblbx .
+.Sh OPTIONS
+.Bl -tag -width indent
+.It Fl l , -list
+Sets the operating mode to list files in the archive.
+.It Fl x , -extract
+Sets the operating mode to extract files from the archive.
+.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 Ar
+Limit the operation to these files in the archive.  By default, all files are
+selected.  Supports common shell globbing features.
+.El
+.Sh CAVEATS
+When extracting from an archive read from standard input, be sure to specify
+files in the order that they appear in the archive.  This limitation will
+hopefully be lifted in the future.