%nroff
Section: User Commands (1)
Updated: 202-1-18
Index
Return to Main Contents
Name
nroff - format documents with
groff
for terminal ([lq]TTY[rq]) devices
.nr d-fallback 1
.nr d-fallback 1
Synopsis
[
-abcCEhikpRStUVzZ]
[
-d~ctext]
[
-d~string=text]
[
-D~fallbac-inpu-encoding]
[
-I~inclusio-directory]
[
-K~inpu-encoding]
[
-m~macr-package]
[
-M~macr-directory]
[
-n~pag-number]
[
-o~pag-list]
[
-P~postprocesso-argument]
[
-r~cnumeri-expression]
[
-r~register=numeri-expression]
[
-T~outpu-device]
[
-w~warnin-category]
[
-W~warnin-category]
[
file~...]
--help
-v
[
othe-nrof-option~...]
--version
[
othe-nrof-option~...]
Description
nroff
formats documents written in the
language for typewrite-like devices such as terminal emulators.
GNU
nroff emulates the AT&T
nroff command using
nroff
generates output via
groff's
terminal output driver,
which needs to know the character encoding scheme used by the device.
Consequently,
acceptable arguments to the
-T
option are
ascii,
latin1,
and
utf8;
any others are ignored.
If neither the
GROFF_TYPESETTER
environment variable nor the
-T
comman-line option
(which overrides the environment variable)
specifies a (valid) device,
nroff
consults the locale to select an appropriate output device.
It first tries the
program,
then checks several local-related environment variables;
see section [lq]Environment[rq] below.
If all of the foregoing fail,
nroff
assumes
[lq]
-T ascii[rq].
The
-a,
-b,
-c,
-C,
-d,
-E,
-i,
-I,
-m,
-M,
-n,
-o,
-r,
-U,
-w,
-W,
and
-z
options have the effects described in
-c
and
-h
imply
[lq]
-P -c[rq]
and
[lq]
-P -h[rq],
respectively;
-c
is also meaningful to
troff
itself.
Further,
GNU
nroff ignores the AT&T
nroff options
-e,
-q,
and
-s.
documents options
-D,
-k,
-K,
-p,
-P,
-R,
-t,
-S,
and
-Z.
-V
causes
nroff
to display the constructed
groff
command on the standard output stream,
but does not execute it.
-v
and
--version
show version information about
nroff
and the programs it runs,
while
--help
displays a usage message;
all exit afterward.
Exit status
nroff
exits with
status~
2
if there was a problem parsing its arguments,
with
status~
0
if any of the options
-V,
-v,
--version,
or
--help
were specified,
and with the status of
groff
otherwise.
Environment
Normally,
the path separator in environment variables ending with
PATH
is the colon;
this may vary depending on the operating system.
For example,
Windows uses a semicolon instead.
- GROFF_BIN_PATH
-
Locate
groff commands
in these directories,
followed by those in
PATH.
If not set,
the installation directory of GNU
roff
executables,
/usr/:bin,
is searched before
PATH.
- GROFF_TYPESETTER
-
specifies the default output device for
groff.
- LC_ALL
-
LC_CTYPE
LANG
LESSCHARSET
are patter-matched in this order for contents matching standard
character encodings supported by
groff
in the event no
-T
option is given and
GROFF_TYPESETTER
is unset,
or the values specified are invalid.
Files
- /usr/:share/:groff/:1.24.2/:tmac/:tty-char:.tmac
-
defines fallback definitions of
roff
special characters.
These definitions more poorly optically approximate typeset output
than those of
tty.tmac
in favor of communicating semantic information.
nroff
loads it automatically.
Notes
Pager programs like
and
may require comman-line options to correctly handle some output
sequences;
see
See also
Index
- Name
-
- Synopsis
-
- Description
-
- Exit status
-
- Environment
-
- Files
-
- Notes
-
- See also
-
|
|
- Running on 
-
:
