NAME
troff - the troff processor of the groff text formatting system
SYNOPSIS
ttrrooffff [ -aabbcciivvzzCCEERRUU ] [ -ddcs ] [ -fffam ] [ -FFdir ] [ -IIdir ] [ -mmname ]
[ -MMdir ] [ -nnnum ] [ -oolist ] [ -rrcn ] [ -TTname ] [ -wwname ]
[ -WWname ] [ files... ]
It is possible to have whitespace between a command line option and its
parameter.
DESCRIPTION
This manual page describes the GNU version of ttrrooffff. It is part of the
groff document formatting system. It is functionally compatible with
UNIX troff, but has many extensions, see ggrrooffffddiiffff(7). Usually it
should be invoked using the ggrrooffff(1) command which will also run pre-
processors and postprocessors in the appropriate order and with the
appropriate options.
OOPPTTIIOONNSS
-aa Generate an ASCII approximation of the typeset output.
-bb Print a backtrace with each warning or error message. This
backtrace should help track down the cause of the error. The
line numbers given in the backtrace may not always be cor-
rect, for ttrrooffff's idea of line numbers gets confused by aass or
aamm requests.
-cc Disable color output (always disabled in compatibility mode).
-CC Enable compatibility mode.
-ddcs
-ddname==s Define c or name to be a string s; c must be a one letter
name.
-EE Inhibit all error messages of ttrrooffff. Note that this doesn't
affect messages output to standard error by macro packages
using the ttmm or ttmm11 requests.
-fffam Use fam as the default font family.
-FFdir Search in directory (or directory path) dir for subdirecto-
ries ddeevvname (name is the name of the device) and there for
the DDEESSCC file and font files. dir is scanned before all
other font directories.
-ii Read the standard input after all the named input files have
been processed.
-IIdir This option may be used to specify a directory to search for
files (both those on the command line and those named in
..ppssbbbb requests). The current directory is always searched
first. This option may be specified more than once; the
directories will be searched in the order specified. No
directory search is performed for files specified using an
absolute path.
-mmname Read in the file name..ttmmaacc. If it isn't found, try ttmmaacc..name
instead. It will be first searched for in directories given
with the -MM command line option, then in directories given in
the GGRROOFFFFTTMMAACCPPAATTHH environment variable, then in the current
directory (only if in unsafe mode), the home directory,
/usr/lib/groff/site-tmac, /usr/share/groff/site-tmac, and
/usr/share/groff/1.19.1/tmac.
-MMdir Search directory (or directory path) dir for macro files.
This is scanned before all other macro directories.
-nnnum Number the first page num.
-oolist Output only pages in list, 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. ttrrooffff will exit after printing the
last page in the list.
-rrcn
-rrname==n Set number register c or name to n; c must be a one character
name; n can be any troff numeric expression.
-RR Don't load ttrrooffffrrcc and ttrrooffffrrcc-eenndd.
-TTname Prepare output for device name, rather than the default ppss;
see ggrrooffff(1) for a more detailed description.
-UU Unsafe mode. This will enable the following requests: ooppeenn,
ooppeennaa, ppssoo, ssyy, and ppii. For security reasons, these poten-
tially dangerous requests are disabled otherwise. It will
also add the current directory to the macro search path.
-vv Print the version number.
-wwname Enable warning name. Available warnings are described in the
section WARNINGS below. For example, to enable all warnings,
use -ww aallll. Multiple -ww options are allowed.
-WWname Inhibit warning name. Multiple -WW options are allowed.
-zz Suppress formatted output.
WWAARRNNIINNGGSS
The warnings that can be given by ttrrooffff are divided into the following
categories. The name associated with each warning is used by the -ww
and -WW options; the number is used by the wwaarrnn request, and by the
..wwaarrnn register; it is always a power of 2 to allow bitwise composition.
+-----------+--------------+
|Bit Code Warning | Bit Code Warning |
+-----------+--------------+
| 0 1 cchhaarr | 10 1024 rreegg |
| 1 2 nnuummbbeerr | 11 2048 ttaabb |
| 2 4 bbrreeaakk | 12 4096 rriigghhtt-bbrraaccee |
| 3 8 ddeelliimm | 13 8192 mmiissssiinngg |
| 4 16 eell | 14 16384 iinnppuutt |
| 5 32 ssccaallee | 15 32768 eessccaappee |
| 6 64 rraannggee | 16 65536 ssppaaccee |
| 7 128 ssyynnttaaxx | 17 131072 ffoonntt |
| 8 256 ddii | 18 262144 iigg |
| 9 512 mmaacc | 19 524288 ccoolloorr |
+-----------+--------------+
bbrreeaakk 4 In fill mode, lines which could not be broken so
that their length was less than the line length.
This is enabled by default.
cchhaarr 1 Non-existent characters. This is enabled by
default.
ccoolloorr 524288 Color related warnings.
ddeelliimm 8 Missing or mismatched closing delimiters.
ddii 256 Use of ddii or ddaa without an argument when there is
no current diversion.
eell 16 Use of the eell request with no matching iiee request.
eessccaappee 32768 Unrecognized escape sequences. When an unrecog-
nized escape sequence is encountered, the escape
character is ignored.
ffoonntt 131072 Non-existent fonts. This is enabled by default.
iigg 262144 Invalid escapes in text ignored with the iigg
request. These are conditions that are errors when
they do not occur in ignored text.
iinnppuutt 16384 Invalid input characters.
mmaacc 512 Use of undefined strings, macros and diversions.
When an undefined string, macro or diversion is
used, that string is automatically defined as
empty. So, in most cases, at most one warning will
be given for each name.
mmiissssiinngg 8192 Requests that are missing non-optional arguments.
nnuummbbeerr 2 Invalid numeric expressions. This is enabled by
default.
rraannggee 64 Out of range arguments.
rreegg 1024 Use of undefined number registers. When an unde-
fined number register is used, that register is
automatically defined to have a value of 0. So, in
most cases, at most one warning will be given for
use of a particular name.
rriigghhtt-bbrraaccee 4096 Use of \\}} where a number was expected.
ssccaallee 32 Meaningless scaling indicators.
ssppaaccee 65536 Missing space between a request or macro and its
argument. This warning will be given when an unde-
fined name longer than two characters is encoun-
tered, and the first two characters of the name
make a defined name. The request or macro will not
be invoked. When this warning is given, no macro
is automatically defined. This is enabled by
default. This warning will never occur in compati-
bility mode.
ssyynnttaaxx 128 Dubious syntax in numeric expressions.
ttaabb 2048 Inappropriate use of a tab character. Either use
of a tab character where a number was expected, or
use of tab character in an unquoted macro argument.
There are also names that can be used to refer to groups of warnings:
aallll All warnings except ddii, mmaacc, and rreegg. It is intended that this
covers all warnings that are useful with traditional macro pack-
ages.
ww All warnings.
ENVIRONMENT GGRROOFFFFTTMMAACCPPAATTHH
A colon separated list of directories in which to search for
macro files. ttrrooffff will scan directories given in the -MM option
before these, and in standard directories (current directory if
in unsafe mode, home directory, //uussrr//lliibb//ggrrooffff//ssiittee-ttmmaacc,
//uussrr//sshhaarree//ggrrooffff//ssiittee-ttmmaacc, //uussrr//sshhaarree//ggrrooffff//11..1199..11//ttmmaacc) after
these.
GGRROOFFFFTTYYPPEESSEETTTTEERR
Default device.
GGRROOFFFFFFOONNTTPPAATTHH
A colon separated list of directories in which to search for the
ddeevvname directory. ttrrooffff will scan directories given in the -FF
option before these, and in standard directories
(//uussrr//sshhaarree//ggrrooffff//ssiittee-ffoonntt, //uussrr//sshhaarree//ggrrooffff//11..1199..11//ffoonntt,
//uussrr//lliibb//ffoonntt) after these.
FILES //uussrr//sshhaarree//ggrrooffff//11..1199..11//ttmmaacc//ttrrooffffrrcc
Initialization file (called before any other macro package).
//uussrr//sshhaarree//ggrrooffff//11..1199..11//ttmmaacc//ttrrooffffrrcc-eenndd
Initialization file (called after any other macro package).
//uussrr//sshhaarree//ggrrooffff//11..1199..11//ttmmaacc//name..ttmmaacc
//uussrr//sshhaarree//ggrrooffff//11..1199..11//ttmmaacc//ttmmaacc..name
Macro files
//uussrr//sshhaarree//ggrrooffff//11..1199..11//ffoonntt//ddeevvname//DDEESSCC
Device description file for device name.
//uussrr//sshhaarree//ggrrooffff//11..1199..11//ffoonntt//ddeevvname//F
Font file for font F of device name.
Note that ttrrooffffrrcc and ttrrooffffrrcc-eenndd are neither searched in the current
nor in the home directory by default for security reasons (even if the
-UU option is given). Use the -MM command line option or the
GGRROOFFFFTTMMAACCPPAATTHH environment variable to add these directories to the
search path if necessary.
AUTHOR Copyright (C) 1989, 2001, 2002, 2003 Free Software Foundation, Inc.
This document is distributed under the terms of the FDL (GNU Free Docu-
mentation License) version 1.1 or later. You should have received a
copy of the FDL on your system, it is also available on-line at the GGNNUU
ccooppyylleefftt ssiittee . This document
was written by James Clark, with modifications from
WWeerrnneerr LLeemmbbeerrgg and
BBeerrnndd WWaarrkkeenn
This document is part of groff, the GNU roff distribution.
SEE ALSO
ggrrooffff(1)
The main program of the groff system, a wrapper around troff.
ggrrooffff(7)
A description of the groff language, including a short but com-
plete reference of all predefined requests, registers, and
escapes of plain groff. From the command line, this is called
by
mmaann 77 ggrrooffff
ggrrooffffddiiffff(7)
The differences of the groff language and the classical troff
language. Currently, this is the most actual document of the
groff system.
rrooffff(7)
An overview over groff and other roff systems, including point-
ers to further related documentation.
The groff info file, cf. iinnffoo(1), presents all groff documentation
within a single document.
Groff Version 1.19.1 13 October 2003 TROFF(1)