groff normally runs the
gtroff program and a
postprocessor appropriate for the selected device. The default device
is ‘ps’ (but it can be changed when
groff is configured and
built). It can optionally preprocess with any of
This section only documents options to the
groff front end. Many
of the arguments to
groff are passed on to
therefore those are also included. Arguments to pre- or postprocessors
can be found in Invoking gpic, Invoking geqn, Invoking gtbl, Invoking ggrn, Invoking grefer, Invoking gchem,
Invoking gsoelim, Invoking preconv, Invoking grotty,
Invoking grops, Invoking gropdf, Invoking grohtml,
Invoking grodvi, Invoking grolj4, Invoking grolbp, and
The command line format for
groff [ -abceghijklpstvzCEGNRSUVXZ ] [ -dcs ] [ -Darg ] [ -ffam ] [ -Fdir ] [ -Idir ] [ -Karg ] [ -Larg ] [ -mname ] [ -Mdir ] [ -nnum ] [ -olist ] [ -Parg ] [ -rcn ] [ -Tdef ] [ -wname ] [ -Wname ] [ files... ]
The command line format for
gtroff is as follows.
gtroff [ -abcivzCERU ] [ -dcs ] [ -ffam ] [ -Fdir ] [ -mname ] [ -Mdir ] [ -nnum ] [ -olist ] [ -rcn ] [ -Tname ] [ -wname ] [ -Wname ] [ files... ]
Obviously, many of the options to
groff are actually passed on to
Options without an argument can be grouped behind a single -. A filename of - denotes the standard input. It is possible to have whitespace between an option and its parameter.
grog command can be used to guess the correct
command to format a file.
Here's the description of the command-line options:
.Ais then set to 1. See Built-in Registers. A typical example is
groff -a -man -Tdvi troff.man | less
which shows how lines are broken for the DVI device. Note that this
option is rather useless today since graphic output devices are
available virtually everywhere.
gtroffcan get confused by
amrequests while counting line numbers.
preconvto arg. Implies -k.
grap. Implies -p.
gsoelim(see gsoelim for more details); it also implies
groff's -s option.
gtroff; it is used to search files named in the
grops; it is used to search files named in the
The current directory is always searched first. This option may be
specified more than once; the directories are searched in the order
specified. No directory search is performed for files specified using
an absolute path.
gchem. Implies -p.
preconv. This is run before any other preprocessor. Please refer to
preconv's manual page for its behaviour if no -K (or -D) option is specified.
groffdoes not prepend a ‘-’ to arg before passing it to the postprocessor. If the
groffsearches for this in its macro directories. If it isn't found, it tries tmac.name (searching in the same directories).
eqndelimiters. This is the same as the -N option in
gtroffexits after printing the last page in the list. All the ranges are inclusive on both ends.
gtroff, this information can be extracted with the
‘.P’ register. See Built-in Registers.
If your document restarts page numbering at the beginning of each
gtroff prints the specified page range for each
groffdoes not prepend ‘-’ to arg before passing it to the postprocessor.
gtroffnumeric expression. All register assignments happen before loading any macro file (including the start-up file).
grefer. No mechanism is provided for passing arguments to
greferoptions have equivalent commands which can be included in the file. See grefer, for more details.
gtroff also accepts a -R option, which is not
groff. This option prevents the loading of the
troffrc and troffrc-end files.
gpicand disable the
pirequests. For security reasons, this is enabled by default.
groffwas configured and built. The following are the output devices currently available:
pre-grohtml) and a postprocessor (
gtroff string register
.T contains the
current output device; the read-only number register
.T is set
to 1 if this option is used (which is always true if
is used to call
gtroff). See Built-in Registers.
The postprocessor to be used for a device is specified by the
postpro command in the device description file. (See Font Files, for more info.) This can be overridden with the -X
groffprint out their version number.
stdoutinstead of executing it. If specified more than once, print the pipeline on
stderrand execute it.
gxditviewinstead of using the usual postprocessor. This is unlikely to produce good results except with -Tps.
Note that this is not the same as using -TX75 or
-TX100 to view a document with
gxditview: The former
uses the metrics of the specified device, whereas the latter uses
X-specific fonts and metrics.
gtroff. Only error messages are printed.
groffautomatically runs the appropriate postprocessor.