GTROFF(1)                 User Commands                 GTROFF(1)



NAME
     gtroff - format documents

SYNOPSIS
     gtroff [ -abivzCER ] [ -w_n_a_m_e ] [ -W_n_a_m_e ] [ -d_c_s ] [ -
            f_f_a_m ] [ -m_n_a_m_e ] [ -n_n_u_m ] [ -o_l_i_s_t ] [ -r_c_n ] [ -
            T_n_a_m_e ] [ -F_d_i_r ] [ -M_d_i_r ] [ _f_i_l_e_s... ]

DESCRIPTION
     This manual page describes the GNU version of  troff,  which
     is  part  of  the  groff  document formatting system.  It is
     highly compatible with Unix troff.   Usually  it  should  be
     invoked using the groff command, which will also run prepro-
     cessors and postprocessors in the appropriate order and with
     the appropriate options.

OPTIONS
     -a         Generate an ASCII approximation  of  the  typeset
               output.

     -b         Print a backtrace with each warning or error mes-
               sage.   This  backtrace should help track down the
               cause of the error.  The line numbers given in the
               backtrace  may not always correct: troff's idea of
               line numbers gets confused by as or am requests.

     -i         Read the standard input after all the named input
               files have been processed.

     -v         Print the version number.

     -w_n_a_m_e     Enable  warning  _n_a_m_e.   Available  warnings  are
               described  in the Warnings subsection below.  Mul-
               tiple -w options are allowed.

     -W_n_a_m_e     Inhibit warning _n_a_m_e.  Multiple - W  options  are
               allowed.

     -E         Inhibit all error messages.

     -z         Suppress formatted output.

     -C         Enable compatibility mode.

     -d_c_s
     -d_n_a_m_e=_s   Define _c or _n_a_m_e to be a string _s; _c  must  be  a
               one letter name.

     -f_f_a_m      Use _f_a_m as the default font family.

     -m_n_a_m_e     Read in the file tmac._n_a_m_e.  Normally  this  will
               be searched for in /usr/local/share/groff/tmac.



Groff Version 1.11  Last change: 26 June 1995                   1






GTROFF(1)                 User Commands                 GTROFF(1)



     -R         Don't load troffrc.

     -n_n_u_m      Number the first page _n_u_m.

     -o_l_i_s_t     Output only pages in  _l_i_s_t,  which  is  a  comma-
               separated  list of page ranges; _n means print page
               _n, _m-_n means print every page between _m and _n, - _n
               means  print  every  page  up to _n, _n- means print
               every page from _n.  Troff will exit after printing
               the last page in the list.

     -r_c_n
     -r_n_a_m_e=_n   Set number register _c or _n_a_m_e to _n; _c must  be  a
               one  character  name;  _n  can be any troff numeric
               expression.

     -T_n_a_m_e     Prepare output for device _n_a_m_e, rather  than  the
               default ps.

     -F_d_i_r      Search _d_i_r for subdirectories  dev_n_a_m_e  (_n_a_m_e  is
               the name of the device) for the DESC file and font
               files          before          the          normal
               /usr/local/share/groff/font.

     -M_d_i_r      Search directory _d_i_r for macro files  before  the
               normal /usr/local/share/groff/tmac.

USAGE
     Only the features not in Unix troff are described here.

  Long names
     The     names     of      number      registers,      fonts,
     strings/macros/diversions,  special characters can be of any
     length. In escape sequences, where you can use (_x_x for a two
     character  name,  you  can use [_x_x_x] for a name of arbitrary
     length:

     \[_x_x_x]
          Print the special character called _x_x_x.

     \f[_x_x_x]
          Set font _x_x_x.

     \*[_x_x_x]
          Interpolate string _x_x_x.

     \n[_x_x_x]
          Interpolate number register _x_x_x.

  Fractional pointsizes
     A _s_c_a_l_e_d _p_o_i_n_t is equal to 1/sizescale points, where  sizes-
     cale is specified in the DESC file (1 by default.)  There is



Groff Version 1.11  Last change: 26 June 1995                   2






GTROFF(1)                 User Commands                 GTROFF(1)



     a new scale indicator z which has the effect of  multiplying
     by sizescale.  Requests and escape sequences in troff inter-
     pret arguments that represent a pointsize as being in  units
     of scaled points, but they evaluate each such argument using
     a default scale indicator of z.  Arguments treated  in  this
     way  are  the argument to the ps request, the third argument
     to the cs request, the second and fourth  arguments  to  the
     tkf  request,  the  argument  to the \H escape sequence, and
     those variants of the \s escape sequence that take a numeric
     expression as their argument.

     For example, suppose sizescale is 1000; then a scaled  point
     will be equivalent to a millipoint; the request .ps 10.25 is
     equivalent to .ps 10.25z and so sets the pointsize to  10250
     scaled points, which is equal to 10.25 points.

     The number register \n(.s returns the pointsize in points as
     decimal  fraction.   There  is  also  a  new number register
     \n[.ps] that returns the pointsize in scaled points.

     It would make no sense to use the z  scale  indicator  in  a
     numeric expression whose default scale indicator was neither
     u nor z, and so troff disallows this.   Similarly  it  would
     make  no  sense to use a scaling indicator other than z or u
     in a numeric expression whose default scale indicator was z,
     and so troff disallows this as well.

     There is also new scale indicator s which multiplies by  the
     number  of  units  in  a  scaled  point.   So,  for example,
     \n[.ps]s is equal to 1m.  Be sure not to confuse the s and z
     scale indicators.

  Numeric expressions
     Spaces  are  permitted  in  a   number   expression   within
     parentheses.

     M indicates a scale of 100ths of an em.

     _e_1>?_e_2
          The maximum of _e_1 and _e_2.

     _e_1