doc/man/lbximg.1

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