doc/man/lbximg.1

   1 .\" Copyright (C) 2008-2010 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 February 9, 2010
   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 n
  17 .Op Fl p Ar palette_file
  18 .Op Fl O Ar override_file
  19 .Op Fl f Ar path
  20 .Op Ar frameno ...
  21 .Sh DESCRIPTION
  22 .Nm
  23 identifies and decodes LBX image files, using
  24 .Em liblbx .
  25 LBX images are multi-frame, 256-colour paletted images with transparency.
  26 .Nm
  27 can be used to convert some or all of the frames of an LBX image to PNG.
  28 .Sh OPTIONS
  29 .Bl -tag -width indent
  30 .It Fl i , -ident
  31 Sets the operating mode to identify the image format.
  32 .It Fl d , -decode
  33 Sets the operating mode to decode frames to PNG.
  34 .It Fl v , -verbose
  35 Output additional information on standard output.
  36 .It Fl f , -file Ar path
  37 Read from the specified
  38 .Ar path
  39 instead of standard input.
  40 .It Fl n , -no-palette
  41 Instead of looking up colour indices in the palette, use the index itself for
  42 each of the red, green and blue components of the output.  This is mainly
  43 useful for debugging
  44 .Em liblbx .
  45 .It Fl p , -palette Ar palette_file
  46 Read the base palette from
  47 .Ar palette_file .
  48 In Moo2, these files are found in
  49 .Pa fonts.lbx .
  50 Without this option, the base palette is filled with a nice hot pink.  Colours
  51 in the base palette are superseded by those in the embedded palette and the
  52 override palette.
  53 .It Fl O , -override Ar override_file
  54 Use the embedded palette of an LBX image specified by
  55 .Ar override_file
  56 as the override palette.  One example of where this is used is for selecting
  57 the player colour for ship images.  Colours in the override palette supersede
  58 those in both the base palette and the embedded palette.
  59 .It Fl V , -version
  60 Print a version message and exit.
  61 .It Fl -usage
  62 Print a short usage message and exit.
  63 .It Fl -help
  64 Print a help message and exit
  65 .It Ar frameno ...
  66 Specifies the frames to decode as a sequence of intervals, with frames indexing
  67 from zero.  By default, all frames are decoded.  Multiplicity is ignored, as is
  68 the order in which frames are specified.  For example:
  69 .Bl -tag -width
  70 .It Nm Li -d 3 6
  71 Decode frames 3 and 6.
  72 .It Nm Li -d 4-9
  73 Decode frames 4 through 9, inclusive
  74 .It Nm Li -d 6-9 1-4
  75 Decode frames 1 through 9, except for frame 5.
  76 .It Nm Li -d 3-
  77 Decode all frames except the first 3.
  78 .El
  79 .El
  80 .Sh EXAMPLES
  81 After extracting fonts.lbx, mainmenu.lbx, logo.lbx and ships.lbx with
  82 .Xr lbxtool 1 :
  83 .Bl -tag -width indent
  84 .It Nm Li -ivf logo.lbx.000
  85 Print some information about the Simtex logo image.
  86 .It Nm Li -dvf mainmenu.lbx.000 -p fonts.lbx.006
  87 Decodes all the frames of the main menu panel into a series of PNGs.
  88 .It Nm Li -dvf logo.lbx.001
  89 Decodes all the frames of the Microprose logo into a series of PNGs.
  90 .It Nm Li -dvf ships.lbx.042 -p fonts.lbx.012 -O ships.lbx.049
  91 Decodes an image of a red star fortress.
  92 .El
  93 .Sh SEE ALSO
  94 .Xr lbxtool 1 ,
  95 .Xr lbxgui 1