home *** CD-ROM | disk | FTP | other *** search
/ Online Praxis 1996 April / OP4_96.ISO / surfen / astro / earthv / ppmlabel.doc < prev    next >
Text File  |  1996-08-19  |  5KB  |  121 lines
  1. ppmlabel(1)              USER COMMANDS                ppmlabel(1)
  2.  
  3. NAME
  4.      ppmlabel - add text to a portable pixmap
  5.  
  6. SYNOPSIS
  7.      ppmlabel [-angle angle] [-background transparent | colour]
  8.               [-colour colour] [-file filename] [-size textsize]
  9.               [-text 'text string'] [-x column] [-y row] ...
  10.               [ppmfile]
  11.  
  12. DESCRIPTION
  13.      ppmlabel uses the text drawing facilities of ppmdraw to  add
  14.      text to a portable pixmap.  The location, size, baseline an-
  15.      gle, colour of the text and background colour (if  any)  are
  16.      controlled  by  command  line  arguments.   The  text can be
  17.      specified on the command  line  or  read  from  files.   Any
  18.      number  of separate text strings can be added by one invoca-
  19.      tion of ppmlabel, limited only by the maximum length of  the
  20.      command line.
  21.  
  22.      If no ppmfile is specified, ppmdraw reads its  input  pixmap
  23.      from standard input.
  24.  
  25. OPTIONS
  26.      The arguments on the ppmlabel command line are  not  options
  27.      in  the  strict  sense;  they are commands which control the
  28.      placement and appearance of the text being added to the  in-
  29.      put pixmap.  They are executed left to right, and any number
  30.      of arguments may appear.
  31.  
  32.      All flags can be abbreviated to their shortest  unique  pre-
  33.      fix.
  34.  
  35.      -angle angle
  36.                Sets the angle of the baseline of subsequent text.
  37.                angle  is  specified  as an integral number of de-
  38.                grees, measured counterclockwise from the row axis
  39.                of the pixmap.
  40.  
  41.      -background transparent | colour
  42.                If the argument is ``transparent'', text is  drawn
  43.                over  the  existing  pixels  in  the pixmap.  If a
  44.                colour is given (see the -colour switch below  for
  45.                information on how to specify colours), rectangles
  46.                enclosing subsequent text  are  filled  with  that
  47.                colour.
  48.  
  49.      -colour colour
  50.                Sets the colour for subsequent text.   The  colour
  51.                can be specified in five ways:
  52.  
  53.                +    A name, assuming that a pointer  to  an  X11-
  54.                     style colour names file was compiled in.
  55.  
  56.                +    An    X11-style    hexadecimal     specifier:
  57.                     rgb:r/g/b,  where r g and b are each 1- to 4-
  58.                     digit hexadecimal numbers.
  59.  
  60.                +    An X11-style decimal  specifier:  rgbi:r/g/b,
  61.                     where  r  g  and b are floating point numbers
  62.                     between 0 and 1.
  63.  
  64.                +    For backwards compatibility, an old-X11-style
  65.                     hexadecimal     number:     #rgb,    #rrggbb,
  66.                     #rrrgggbbb, or #rrrrggggbbbb.
  67.  
  68.                +    For backwards  compatibility,  a  triplet  of
  69.                     numbers separated by commas: r,g,b, where r g
  70.                     and b are floating point  numbers  between  0
  71.                     and 1.  (This style was added before MIT came
  72.                     up with the similar rgbi style.)
  73.  
  74.      -file filename
  75.                Reads text from the file filename and draws it  on
  76.                successive lines.
  77.  
  78.      -size textsize
  79.                Sets the height of the  tallest  characters  above
  80.                the baseline to textsize pixels.
  81.  
  82.      -text 'text string'
  83.                Draws the given text string (which must be  quoted
  84.                if  it  contains spaces).  The location for subse-
  85.                quent text is advanced by 1.75 times  the  current
  86.                textsize,  which  allows drawing multiple lines of
  87.                text in a reasonable manner without specifying the
  88.                position of each line.
  89.  
  90.      -x column Sets the column at which subsequent text  will  be
  91.                left  justified.   Depending  on  the shape of the
  92.                first character, the actual text may begin  a  few
  93.                pixels to the right of this point.
  94.  
  95.      -y row    Sets the row which will form the baseline of  sub-
  96.                sequent text.  Characters with descenders, such as
  97.                ``y'', will extend below this line.
  98.  
  99. BUGS
  100.      Text strings are restricted to 7 bit ASCII.  The  text  font
  101.      used  by  ppmdraw  doesn't include definitions for 8 bit ISO
  102.      8859/1 characters.
  103.  
  104.      When drawing multiple lines of text with  a  non-transparent
  105.      background,  it  should  probably fill the space between the
  106.      lines with the background colour.  This  is  tricky  to  get
  107.      right when the text is rotated to a non-orthogonal angle.
  108.  
  109. SEE ALSO
  110.      ppmmake(1), ppm(5)
  111.  
  112. AUTHOR
  113.        Copyright (C) 1995 by John Walker (kelvin@fourmilab.ch)
  114.                WWW home page: http://www.fourmilab.ch/
  115.  
  116.      Permission  to  use,  copy,  modify,  and  distribute   this
  117.      software  and  its documentation for any purpose and without
  118.      fee is hereby granted, without any  conditions  or  restric-
  119.      tions.   This software is provided ``as is'' without express
  120.      or implied warranty.
  121.