contrib/ppmtoansi/ppmtoansi.man

   1 .TH PPMTOANSI 1 "January 12, 1997"
   2 .SH NAME
   3 ppmtoansi \- Graphics Conversion Program For Extended ANSI Escape Codes
   4 .SH SYNOPSIS
   5 .B ppmtoansi
   6 [
   7 .SM \-b
   8 r/g/b ] [
   9 .SM \-t
  10 r/g/b:idx] [
  11 .SM \-x
  12 <xoffset> ] [
  13 .SM \-y
  14 <yoffset> ] [
  15 <filename> ]
  16 .SH DESCRIPTION
  17 .I ppmtoansi
  18 converts input files in
  19 .IR ppm (5)
  20 format to escape sequences that are understood by
  21 .IR etherboot .
  22 This allows for displaying icons and logos on the BOOT-Prom's splash
  23 screen.
  24 .PP
  25 If no input file is specified, data is read from
  26 .IR standard
  27 .IR input .
  28 All output is send to
  29 .IR standard
  30 .IR output ,
  31 error messages go to
  32 .IR standard
  33 .IR error .
  34 .I ppmtoansi
  35 tries to do some compression and minimizes the output filesize.
  36 .SH OPTIONS
  37 .TP
  38 .B \-b
  39 Specifies the
  40 .IR red ,
  41 .IR green , and
  42 .IR blue
  43 intensities for the background color. This information is
  44 used for providing a shape mask. All values are in the range from 0 to
  45 255.
  46 .TP
  47 .B \-t
  48 Allows for explicitly providing a translation between color values and
  49 color indices. The indices are in the range 0 to 7 and conform to the
  50 standard
  51 .IR ANSI
  52 .IR colorcodes .
  53 .RS
  54 .PP
  55 0 black       4 blue
  56 .PP
  57 1 red         5 magenta
  58 .PP
  59 2 green       6 cyan
  60 .PP
  61 3 yellow      7 white
  62 .PP
  63 If no translations apply,
  64 .IR ppmtoansi
  65 will automatically select the color that is closest.
  66 .RE
  67 .TP
  68 .B \-x
  69 Specify an X offset relative to the current text cursor position.
  70 .TP
  71 .B \-y
  72 Specify an Y offset relative to the current text cursor position.
  73 .SH FILE FORMAT
  74 .IR ppmtoansi
  75 uses these extensions to the standard
  76 .B ANSI escape
  77 .BR codes .
  78 .TP
  79 .B <esc>[a;b;c;d+<data>
  80 Draw pixel data.  Use one byte per pixel.  Colors are encoded as shown
  81 above.  In text mode, graphics is approximated by outputting suitable
  82 characters.  Parameters differ depending on the number of parameters
  83 passed:
  84 .RS
  85 .TP
  86 .B cnt
  87 .IR cnt
  88 data bytes follow. They will be drawn to the right of the last
  89 graphics position.
  90 .TP
  91 .B rle;col
  92 The next
  93 .IR rle
  94 pixels have the value
  95 .IR col .
  96 They will be drawn to the right of the last graphics position. No data
  97 bytes follow.
  98 .TP
  99 .B x;y;cnt
 100 .IR cnt
 101 data bytes follow. They will be drawn relative to the top left corner
 102 of the text cursor with an offset of
 103 .RI ( x / y ).
 104 .TP
 105 .B x;y;rle;col
 106 the next
 107 .IR rle
 108 pixels have the value
 109 .IR col .
 110 They will be drawn relative to the top left corner of the text cursor
 111 with an offset of
 112 .RI ( x / y ).
 113 No data bytes follow.
 114 .RE
 115 .TP
 116 .B <esc>[a;b;c;d\-<data>
 117 same as above, but pack pixels into three bits. The first pixel is
 118 stored in the three most significant bits of the first data byte.
 119 .SH "SEE ALSO"
 120 ppm(5), mknbi-linux(8), mknbi-dos(8).