BSD 4_4_Lite2 development

[unix-history] / usr / share / man / cat5 / groff_out.0

GROFF_OUT(@MAN5EXT@)   BSD Reference Manual  GROFF_OUT(@MAN5EXT@)


N\bNA\bAM\bME\bE
       groff_out - groff intermediate output format

D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
       This manual page describes the format output by GNU troff.
       The output format used by GNU troff  is  very  similar  to
       that  used by Unix device-independent troff. Only the dif-
       ferences are documented here.

       The argument to the s\bs command is in scaled  points  (units
       of _\bp_\bo_\bi_\bn_\bt_\bs_\b/n_\b, where _\bn is the argument to the s\bsi\biz\bze\bes\bsc\bca\bal\ble\be com-
       mand  in the DESC file.)  The  argument  to  the  x\bx H\bHe\bei\big\bgh\bht\bt
       command is also in scaled points.

       The first three output commands are guaranteed to be:

              x\bx T\bT _\bd_\be_\bv_\bi_\bc_\be
              x\bx r\bre\bes\bs _\bn _\bh _\bv
              x\bx i\bin\bni\bit\bt

       If  the  t\btc\bco\bom\bmm\bma\ban\bnd\bd  line is present in the DESC file, troff
       will use the following two commands

       t\bt_\bx_\bx_\bx   _\bx_\bx_\bx is any sequence of characters terminated  by  a
              space  or  a newline; the first character should be
              printed at the current position,  the  the  current
              horizontal  position  should  be  increased  by the
              width of the first character, and so  on  for  each
              character.   The  width  of  the  character is that
              given in the font file,  appropriately  scaled  for
              the current point size, and rounded so that it is a
              multiple of  the  horizontal  resolution.   Special
              characters cannot be printed using this command.

       u\bu_\bn _\bx_\bx_\bx This  is  same  as  the t\bt command except that after
              printing each  character,  the  current  horizontal
              position  is  increased  by the sum of the width of
              that character and _\bn.

       Note that single characters can have the eighth  bit  set,
       as can the names of fonts and special characters.

       The  names  of  characters  and  fonts  an be of arbitrary
       length; drivers should not assume that they will  be  only
       two characters long.

       When  a  character  is  to be printed, that character will
       always be in the current font.  Unlike  device-independent
       troff,  it  is not necessary for drivers to search special
       fonts to find a character.




Groff Version @VERSION@      @MDATE@                            1








GROFF_OUT(@MAN5EXT@)   BSD Reference Manual  GROFF_OUT(@MAN5EXT@)


       The D\bD drawing command has been extended.  These extensions
       will only be used by GNU pic if the -\b-x\bx option is given.

       D\bDf\bf _\bn\n Set  the shade of gray to be used for filling solid
              objects to _\bn; _\bn must be an integer  between  0  and
              1000,  where  0 corresponds solid white and 1000 to
              solid black, and values in  between  correspond  to
              intermediate  shades of gray.  This applies only to
              solid circles, solid ellipses and  solid  polygons.
              By default, a level of 1000 will be used.  Whatever
              color a solid  object  has,  it  should  completely
              obscure  everything  beneath  it.   A value greater
              than 1000 or less than 0 can  also  be  used:  this
              means fill with the shade of gray that is currently
              being used for lines and text.  Normally this  will
              be  black,  but  some  drivers may provide a way of
              changing this.

       D\bDC\bC _\bd\n Draw a solid circle with a diameter of _\bd  with  the
              leftmost point at the current position.

       D\bDE\bE _\bd_\bx _\bd_\by\n
              Draw  a solid ellipse with a horizontal diameter of
              _\bd_\bx and a vertical diameter of _\bd_\by with the  leftmost
              point at the current position.  delim $$

       D\bDp\bp  $dx  sub 1$ $dy sub 1$ $dx sub 2$ $dy sub 2$ $...$ $dx
              sub n$ $dy sub n$\n
              Draw  a polygon with, for $i = 1 ,..., n+1$, the _\bi-
              th vertex at the current position $+ sum  from  j=1
              to  i-1  (  dx sub j , dy sub j )$.  At the moment,
              GNU pic only uses this command to  generate  trian-
              gles and rectangles.

       D\bDP\bP  $dx  sub 1$ $dy sub 1$ $dx sub 2$ $dy sub 2$ $...$ $dx
              sub n$ $dy sub n$\n
              Like D\bDp\bp but draw a solid rather than outlined poly-
              gon.

       D\bDt\bt _\bn\n Set the current line thickness to _\bn machine  units.
              Traditionally  Unix troff drivers use a line thick-
              ness  proportional  to  the  current  point   size;
              drivers should continue to do this if no D\bDt\bt command
              has been given, or if a D\bDt\bt command has  been  given
              with  a  negative  value  of  _\bn.  A zero value of _\bn
              selects the smallest available line thickness.

       A difficulty arises in how the current position should  be
       changed  after  the  execution of these commands.  This is
       not of great importance since the code  generated  by  GNU
       pic  does  not depend on this.  Given a drawing command of



Groff Version @VERSION@      @MDATE@                            2








GROFF_OUT(@MAN5EXT@)   BSD Reference Manual  GROFF_OUT(@MAN5EXT@)


       the form

              \\b\D\bD'\b'_\bc $x sub 1$ $y sub 1$ $x sub 2$ $y sub 2$  $...$
              $x sub n$ $y sub n$'

       where  _\bc  is  not  one of c\bc, e\be, l\bl, a\ba or ~\b~, Unix troff will
       treat each of the $x sub i$ as a horizontal quantity,  and
       each  of  the  $y  sub  i$ as a vertical quantity and will
       assume that the width of the drawn object is $sum from i=1
       to n x sub i$, and that the height is $sum from i=1 to n y
       sub i$.  (The assumption about the height can be  seen  by
       examining  the  s\bst\bt  and  s\bsb\bb registers after using such a D\bD
       command in a \w escape sequence.)  This  rule  also  holds
       for  all  the original drawing commands with the exception
       of D\bDe\be.  For the sake of compatibility GNU troff also  fol-
       lows  this rule, even though it produces an ugly result in
       the case of the D\bDf\bf, D\bDt\bt, and, to a lesser extent,  D\bDE\bE  com-
       mands.  Thus after executing a D\bD command of the form

              D\bD_\bc $x sub 1$ $y sub 1$ $x sub 2$ $y sub 2$ $...$ $x
              sub n$ $y sub n$\n

       the current position should be increased by  $(  sum  from
       i=1 to n x sub i , sum from i=1 to n y sub i )$.

       There is a continuation convention which permits the argu-
       ment to the x\bx X\bX command to  contain  newlines:  when  out-
       putting  the  argument  to the x\bx X\bX command, GNU troff will
       follow each newline in the argument with a +\b+ character (as
       usual,  it  will terminate the entire argument with a new-
       line); thus if the line after the line containing the  x\bx X\bX
       command  starts  with  +\b+, then the newline ending the line
       containing the x\bx X\bX command should be treated  as  part  of
       the  argument to the x\bx X\bX command, the +\b+ should be ignored,
       and the part of the line following the +\b+ should be treated
       like the part of the line following the x\bx X\bX command.

S\bSE\bEE\bE A\bAL\bLS\bSO\bO
       g\bgr\bro\bof\bff\bf_\b_f\bfo\bon\bnt\bt(@MAN5EXT@)















Groff Version @VERSION@      @MDATE@                            3