nroff(1) — Linux manual page

Name | Synopsis | Description | Environment | Notes | See Also | COLOPHON

nroff(1)                   General Commands Manual                  nroff(1)

Name         top

       nroff - use groff to format documents for TTY (terminal) devices

Synopsis         top

       nroff [-cChipStUV] [-dcs] [-mname] [-Mdir] [-nnum] [-olist] [-Ppost-
             proc-option] [-rcn] [-Tname] [-wwarning] [-Wwarning] [file ...]

       nroff --help

       nroff -v
       nroff --version

Description         top

       nroff formats documents written in the roff(7) language for
       typewriter-like devices such as terminal emulators.

       GNU nroff emulates the AT&T nroff command using groff(1).  nroff
       generates output via grotty(1), groff's TTY output device, which
       needs to know the character encoding scheme used by the terminal.
       Consequently, acceptable arguments to the -T option are ascii,
       latin1, utf8, and cp1047; any others are ignored.  If neither the
       GROFF_TYPESETTER environment variable nor the -T command-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 locale(1) program, then checks several
       locale-related environment variables; see section “Environment”,
       below.  If all of the foregoing fail, -Tascii is implied.

       Whitespace is not permitted between an option and its argument.  The
       -C, -d, -i, -m, -M, -n, -o, -P, -r, -w, and -W options have the
       effect described in troff(1).  -c and -h are equivalent to “-P-c” and
       “-P-h”, respectively.  In addition, this implementation ignores the
       traditional Unix nroff options -e, -q, and -s (which are not
       implemented in groff).  The options -p (pic), -t (tbl), -S (safer),
       and -U (unsafe) are passed to groff.  -V causes nroff to display the
       constructed groff command on the standard output, but does not
       execute it.  -v and --version show version information, while --help
       displays a usage message; all exit afterward.

Environment         top

              is a colon-separated list of directories in which to search
              for the groff executable before searching in PATH.  If unset,
              /usr/local/bin is used.

              specifies the default output device for groff.

              are pattern-matched in this order for standard character
              encodings supported by groff in the event no -T option is
              given and GROFF_TYPESETTER is unset.

Notes         top

       Pager programs like more(1) and less(1) may require command-line
       options to correctly handle some output sequences; see grotty(1).

       Character definitions in the file /usr/local/share/groff/1.22.4/tmac/
       tty-char.tmac are loaded to replace unrepresentable glyphs.

See Also         top

       groff(1), troff(1), grotty(1), locale(1), roff(7)

COLOPHON         top

       This page is part of the groff (GNU troff) project.  Information
       about the project can be found at 
       ⟨⟩.  If you have a bug report for
       this manual page, see ⟨⟩.  This
       page was obtained from the project's upstream Git repository
       ⟨⟩ on 2020-09-18.  (At that
       time, the date of the most recent commit that was found in the repos‐
       itory was 2020-09-19.)  If you discover any rendering problems in
       this HTML version of the page, or you believe there is a better or
       more up-to-date source for the page, or you have corrections or
       improvements to the information in this COLOPHON (which is not part
       of the original manual page), send a mail to

groff         18 September 2020                     nroff(1)

Pages that refer to this page: col(1)colcrt(1)gdiffmk(1)groff(1)man(1)ul(1)write(1)zsoelim(1)roff(7)