troff(1) -- Linux man page
NAME
troff - the troff processor of the groff text formatting system
SYNOPSIS
troff
[ -abcivzCERU ]
[ -d cs ]
[ -f fam ]
[ -F dir ]
[ -m name ]
[ -M dir ]
[ -n num ]
[ -o list ]
[ -r cn ]
[ -T name ]
[ -w name ]
[ -W name ]
[ files... ]
It is possible to have whitespace between a command line option and
its parameter.
DESCRIPTION
This manual page describes the GNU version of
troff.
It is part of the groff document formatting system.
It is functionally compatible with UNIX troff, but has many extensions,
see
groff_diff(7).
Usually it should be invoked using the
groff(1)
command which will also run preprocessors 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 message.
This backtrace should help track down the cause of the error.
The line numbers given in the backtrace may not always be correct, for
troff's
idea of line numbers gets confused by
as
or
am
requests.
- -c
-
Disable color output (always disabled in compatibility mode).
- -C
-
Enable compatibility mode.
- -dcs
-
-
-dname=s
- Define
c
or
name
to be a string
s;
c
must be a one letter name.
- -E
-
Inhibit all error messages of
troff.
Note that this doesn't affect messages output to standard error by macro
packages using the
tm
or
tm1
requests.
- -ffam
-
Use
fam
as the default font family.
- -Fdir
-
Search in directory (or directory path)
dir
for subdirectories
devname
(name
is the name of the device) and there for the
DESC
file and font files.
dir
is scanned before all other font directories.
- -i
-
Read the standard input after all the named input files have been
processed.
- -mname
-
Read in the file
name.tmac.
If it isn't found, try
tmac.name
instead.
It will be first searched for in directories given with the
-M
command line option, then in directories given in the
GROFF_TMAC_PATH
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.18.1.1/tmac.
- -Mdir
-
Search directory (or directory path)
dir
for macro files.
This is scanned before all other macro directories.
- -nnum
-
Number the first page
num.
- -olist
-
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.
troff
will exit after printing the last page in the list.
- -rcn
-
-
-rname=n
- Set number register
c
or
name
to
n;
c
must be a one character name;
n
can be any troff numeric expression.
- -R
-
Don't load
troffrc
and
troffrc-end.
- -Tname
-
Prepare output for device
name,
rather than the default
ps.
- -U
-
Unsafe mode.
This will enable the following requests:
open,
opena,
pso,
sy,
and
pi.
For security reasons, these potentially dangerous requests are disabled
otherwise.
It will also add the current directory to the macro search path.
- -v
-
Print the version number.
- -wname
-
Enable warning
name.
Available warnings are described in the section
WARNINGS
below.
For example, to enable all warnings, use
-w
all.
Multiple
-w
options are allowed.
- -Wname
-
Inhibit warning
name.
Multiple
-W
options are allowed.
- -z
-
Suppress formatted output.
WARNINGS
The warnings that can be given by
troff
are divided into the following categories.
The name associated with each warning is used by the
-w
and
-W
options; the number is used by the
warn
request, and by the
.warn
register; it is always a power of 2 to allow bitwise composition.
| Bit | Code | Warning | Bit | Code | Warning
|
|
|
|
|
|