doc/man/lbximg.1

   1 .Dd January 4, 2008
   2 .Os liblbx
   3 .Dt LBXIMG \&1 "2ooM Reference Manual"
   4 .Sh NAME
   5 .Nm lbximg
   6 .Nd inspect and decode LBX images
   7 .Sh SYNOPSIS
   8 .Nm
   9 .Op Fl i Ns | Ns Fl d
  10 .Op Fl v
  11 .Op Fl p Ar palette_file
  12 .Op Fl O Ar override_file
  13 .Op Fl f Ar path
  14 .Op Ar frameno ...
  15 .Sh DESCRIPTION
  16 .Nm
  17 identifies and decodes LBX image files, using
  18 .Em liblbx .
  19 LBX images are multi-frame, 256-colour paletted images with transparency.
  20 .Nm
  21 can be used to convert some or all of the frames of an LBX image to PNG.
  22 .Sh OPTIONS
  23 .Bl -tag -width indent
  24 .It Fl i , -ident
  25 Sets the operating mode to identify the image format.
  26 .It Fl d , -decode
  27 Sets the operating mode to decode frames to PNG.
  28 .It Fl v , -verbose
  29 Output additional information on standard output.
  30 .It Fl f , -file Ar path
  31 Read from the specified
  32 .Ar path
  33 instead of standard input.  If
  34 .Ar path
  35 is -,
  36 .Nm
  37 will read from standard input anyway.
  38 .It Fl p , -palette Ar palette_file
  39 Read the base palette from
  40 .Ar palette_file .
  41 In Moo2, these files are found in
  42 .Pa fonts.lbx .
  43 Without this option, the base palette is filled with a nice hot pink.  Colours
  44 in the base palette are superseded by those in the embedded palette and the
  45 override palette.
  46 .It Fl O , -override Ar override_file
  47 Use the embedded palette of an LBX image specified by
  48 .Ar override_file
  49 as the override palette.  In Moo2, this is notably used to select the player
  50 colour for ship images.  Colours in the override palette supersede those in
  51 both the base palette and the embedded palette.
  52 .It Fl V , -version
  53 Print a version message and exit.
  54 .It Fl -usage
  55 Print a short usage message and exit.
  56 .It Fl -help
  57 Print a help message and exit
  58 .It Ar frameno ...
  59 Specifies the frames to decode as a sequence of intervals, with frames indexing
  60 from zero.  By default, all frames are decoded.  Multiplicity is ignored, as is
  61 the order in which frames are specified.  For example:
  62 .Bl -tag -width
  63 .It Nm Li -d 3 6
  64 Decode frames 3 and 6.
  65 .It Nm Li -d 4-9
  66 Decode frames 4 through 9, inclusive
  67 .It Nm Li -d 6-9 1-4
  68 Decode frames 1 through 9, except for frame 5.
  69 .It Nm Li -d 3-
  70 Decode all frames except the first 3.
  71 .El
  72 .El
  73 .Sh EXAMPLES
  74 After extracting fonts.lbx, mainmenu.lbx, logo.lbx and ships.lbx with
  75 .Xr lbxtool 1 :
  76 .Bl -tag -width indent
  77 .It Nm Li -ivf logo.lbx.000
  78 Print some information about the Simtex logo image.
  79 .It Nm Li -dvf mainmenu.lbx.000 -p fonts.lbx.006
  80 Decodes all the frames of the main menu panel into a series of PNGs.
  81 .It Nm Li -dvf logo.lbx.001
  82 Decodes all the frames of the Microprose logo into a series of PNGs.
  83 .It Nm Li -dvf ships.lbx.042 -p fonts.lbx.012 -O ships.lbx.049
  84 Decodes an image of a red star fortress.
  85 .El
  86 .Sh SEE ALSO
  87 .Xr lbxtool 1