nroff(1)
๐ NAME
nroff โ format documents with groff for terminal (โTTYโ) devices.
This is nroff(1) from the General Commands Manual, bestie โ and she is so good at making groff docs play nice with your terminal. ๐
โจ SYNOPSIS
Hereโs the exact shape of the command, no cap:
nroff [-abcCEhikpRStUVzZ] [-d ctext] [-d string=text] [-D fallback-input-encoding] [-I inclusion-directory] [-K input-encoding] [-m macro-package] [-M macro-directory] [-n page-number] [-o page-list] [-P postprocessor-argument] [-r cnumeric-expression] [-r register=numeric-expression] [-T output-device] [-w warning-category] [-W warning-category] [file ...]
nroff --help
nroff -v [other-nroff-option ...]
nroff --version [other-nroff-option ...]
๐ฆ DESCRIPTION
Okay so nroff formats documents written in the groff(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 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 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, nroff assumes -T ascii.
Now the option lore, because we are not skipping a single flag:
-a,-b,-c,-C,-d,-E,-i,-I,-m,-M,-n,-o,-r,-U,-w,-W, and-zโ these have the effects described introff(1).-cand-himply-P -cand-P -h, respectively;-cis also meaningful totroffitself. Further, GNUnroffignores the AT&Tnroffoptions-e,-q, and-s.-D,-k,-K,-p,-P,-R,-t,-S, and-Zโgroff(1)documents these, so thatโs your lore source.-Vโ causesnroffto display the constructedgroffcommand on the standard output stream, but does not execute it.-vand--versionโ show version information aboutnroffand the programs it runs.--helpdisplays a usage message; all exit afterward. ๐
๐ EXIT STATUS
2โ if there was a problem parsing its arguments.0โ if any of the options-V,-v,--version, or--helpwere specified.- 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โ locategroffcommands in these directories, followed by those inPATH. If not set, the installation directory of GNU roff executables,/usr/bin, is searched beforePATH.GROFF_TYPESETTERโ specifies the default output device forgroff.LC_ALL,LC_CTYPE,LANG,LESSCHARSETโ are pattern-matched in this order for contents matching standard character encodings supported bygroffin the event no-Toption is given andGROFF_TYPESETTERis 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 oftty.tmacin favor of communicating semantic information.nroffloads it automatically.
๐ซถ NOTES
Pager programs like more(1) and less(1) may require command-line options to correctly handle some output sequences; see grotty(1).
๐ SEE ALSO
groff(1), troff(1), grotty(1), locale(1), roff(7)
๐ cute sign-off: this iconic page is from groff 1.24.2, dated 2026-10-01, and itโs the nroff(1) manual. Periodt. ๐โจ
๐ฆ where this page comes from
- alpine 3.24: groff-doc 1.24.2-r0 ยท GPL-3.0-or-later
- Copyright 1989-2023 Free Software Foundation, Inc
- ๐ girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms