nroff, troff
PURPOSE
Formats text for printing devices.
SYNOPSIS
nroff [ options ] [ files ]
DESCRIPTION
A complete list of nroff and troff requests, escape
sequences and number registers begins on page 659. See
Text Formatting Guide for a complete list of the naming
conventions for the non-ASCII special characters and for
information on writing text suitable for processing by
troff or nroff.
nroff, troff
The nroff command reads files (standard input by
default), formats the text in its input for printing, and
writes to standard output. nroff formats text for line
printers and other printing devices, excluding
phototypesetters. An input file name of - (minus) indi-
cates standard input.
troff
The troff command formats text in the input files (or
standard input by default) for a phototypesetter, and
writes its output to standard output. It is similar to
the nroff command. An input file name of - (minus)
indicates standard input.
NROFF AND TROFF FLAGS:
-i Reads standard input after the input files.
-mname Adds /usr/lib/tmac/tmac.name to the beginning of
the list of input file names.
-nnum Numbers the first printed page num. Do not use
this flag with -olist.
-olist Prints only pages with page numbers appearing in
list which consist of a comma-separated list of
page numbers and ranges. A range of A-B means
print pages A through B; an initial -A means
print from the beginning to page A; and a final
A- means print from page A to the end.
Note: When this flag is used in a pipeline (for
example, with cw, eqn, or tbl) it may cause a
broken pipe diagnostic if the last page in the
document is not specified in list.
-q Invokes the simultaneous input/output mode of the
.rd request. nroff echoes the .rd prompt, but
does not echo your input. When you enter two
consecutive new-line characters, normal output is
resumed.
-raN Sets register a to N. a must have a one-
character name. This is useful for automatic
numbering of sections, paragraphs, lines, and so
forth.
-snum Stops every num pages (the default is 1). nroff
or troff will halt every num pages to allow paper
loading or changing and will resume upon receipt
of a line-feed or new-line character. This flag
does not work in pipelines. When nroff halts
between pages, an ASCII BEL character is sent to
the printing device.
-z Suppresses the formatted output. Prints only
messages generated by .tm (work station message)
requests.
NROFF FLAGS:
-e Produces equally spaced words in adjusted lines,
using the full resolution of the printing device.
-h Uses tab characters during horizontal spacing.
Tab settings are assumed to be every eight
spaces.
-Tname Prepares the output for the specified printing
device. Known names are:
37 TELETYPE Model 37 work station (default)
tn300 GE TermiNet 300 or any work station
without half-line capability
300s DASI 300s
300 DASI 300
450 DASI 450
lp Any ASCII line printer
382 DCT-382
4000A Trendata 4000A
832 Anderson Jacobson 832
X any EBCDIC printer
2631 Hewlett Packard 2631 line printer. Use a
name of 2631-c to get compressed print.
Use 2631-e to get expanded print.
-u[num] Sets the number of character overstrikes for
boldface to num or to zero if num is not speci-
fied.
TROFF FLAGS:
-a Sends a printable ASCII approximation of the
output to standard output.
-b Reports whether the phototypesetter is busy or
available. No text processing is done.
-f Does not feed out paper and stop the
phototypesetter at the end of the run.
-pnum Prints all characters in the point size specified
by num. Smaller point sizes may reduce the
printing time.
-t Directs output without modification to standard
output instead of the phototypesetter.
-w Waits until phototypesetter is available if it is
currently busy.
NROFF AND TROFF REQUESTS
+------------+--------------------------------------------------------------+
| Request For| Function -- Font and Character Size Control |
+------------+--------------------------------------------------------------+
| .ps # N | Change point size by N points. Also, for troff only, \s #N. |
+------------+--------------------------------------------------------------+
| .ss N | Space-character size set to N/36 em (troff) only. |
+------------+--------------------------------------------------------------+
| .cs F N M | Constant character space (width) mode (fontF) (troff only). |
+------------+--------------------------------------------------------------+
| .bd F N | Embolden font F by N units (troff only). |
+------------+--------------------------------------------------------------+
+------------+--------------------------------------------------------------+
| Request For| Function -- Font and Character Size Control |
+------------+--------------------------------------------------------------+
| .bd S F N | Embolden Special Font when current font is F (troff only). |
+------------+--------------------------------------------------------------+
| .ft F | Change to font F. |
+------------+--------------------------------------------------------------+
| .fp N F | Mount font F on position N (1-4). |
+------------+--------------------------------------------------------------+
+------------+--------------------------------------------------------------+
| Request For| Function -- Page Control |
+------------+--------------------------------------------------------------+
| .pl # N | Change page length byN. |
+------------+--------------------------------------------------------------+
| .bp # N | Eject current page, next page number is N. |
+------------+--------------------------------------------------------------+
| .pn N | Next page number is N. |
+------------+--------------------------------------------------------------+
| .po #N | Page offset = N. |
+------------+--------------------------------------------------------------+
| .ne N | Need N vertical space. |
+------------+--------------------------------------------------------------+
| .mk R | Mark current vertical place in register R. |
+------------+--------------------------------------------------------------+
| .rt #N | Return (upward only) to marked vertical place. |
+------------+--------------------------------------------------------------+
+------------+--------------------------------------------------------------+
| Request For| Function -- Text Filling, Adjusting, and Centering |
+------------+--------------------------------------------------------------+
| .br | Break. |
+------------+--------------------------------------------------------------+
| .fi | Fill subsequent output lines. |
+------------+--------------------------------------------------------------+
| .nf | No filling or adjusting of output lines. |
+------------+--------------------------------------------------------------+
| .ad [c] | Adjust output lines with mode c. |
+------------+--------------------------------------------------------------+
| .na | Do not adjust output lines. |
+------------+--------------------------------------------------------------+
| .ce N | Center the following N lines. |
+------------+--------------------------------------------------------------+
+------------+--------------------------------------------------------------+
| Request For| Function -- Vertical Spacing |
+------------+--------------------------------------------------------------+
| .vs N | Set vertical base-line spacing to N. |
+------------+--------------------------------------------------------------+
| .ls N | Output N-1 base-line spaces after each text output line. |
+------------+--------------------------------------------------------------+
+------------+--------------------------------------------------------------+
| Request For| Function -- Vertical Spacing |
+------------+--------------------------------------------------------------+
| .sp N | Space vertical distance N in either direction. |
+------------+--------------------------------------------------------------+
| .sv N | Save vertical distance N. |
+------------+--------------------------------------------------------------+
| .os | Output saved vertical space. |
+------------+--------------------------------------------------------------+
| .ns | Turn no-space mode on. |
+------------+--------------------------------------------------------------+
| .rs | Restore spacing, turn no-space mode off. |
+------------+--------------------------------------------------------------+
+------------+--------------------------------------------------------------+
| Request For| Function -- Line Length and Indenting |
+------------+--------------------------------------------------------------+
| .li #N | Change line length by N. |
+------------+--------------------------------------------------------------+
| .in #N | Change indenting by N. |
+------------+--------------------------------------------------------------+
| .ti #N | Change the indent on the next line by N. |
+------------+--------------------------------------------------------------+
+------------+--------------------------------------------------------------+
| Request For| Function -- Macros, Strings, Diversion, and Position Traps |
+------------+--------------------------------------------------------------+
| .de xx yy | Define or redefine macro xx; end at call of yy. |
+------------+--------------------------------------------------------------+
| .am xx yy | Append to a macro. |
+------------+--------------------------------------------------------------+
| .ds xx | Define a string xx containing string. |
| string | |
+------------+--------------------------------------------------------------+
| .as xx | Append string to string xx. |
| string | |
+------------+--------------------------------------------------------------+
| .rm xx | Remove request, macro, or string named xx. |
+------------+--------------------------------------------------------------+
| .rn xx yy | Rename request, macro, or string xx to yy. |
+------------+--------------------------------------------------------------+
| .di xx | Divert output to macro xx. |
+------------+--------------------------------------------------------------+
| .da xx | Divert and append to xx. |
+------------+--------------------------------------------------------------+
| .wh N xx | Set location trap; negative is with respect to the end of |
| | the page. |
+------------+--------------------------------------------------------------+
| .ch xx N | Change trap location. |
+------------+--------------------------------------------------------------+
| .dt N xx | Set a diversion trap. |
+------------+--------------------------------------------------------------+
| .it N xx | Set an input line trap. |
+------------+--------------------------------------------------------------+
+------------+--------------------------------------------------------------+
| Request For| Function -- Macros, Strings, Diversion, and Position Traps |
+------------+--------------------------------------------------------------+
| .em xx | End macro is xx. |
+------------+--------------------------------------------------------------+
+------------+--------------------------------------------------------------+
| Request For| Function -- Number Registers |
+------------+--------------------------------------------------------------+
| .nr R #N M | Define and set number register R;auto-increment by M. |
+------------+--------------------------------------------------------------+
| .af R c | Assign format to register R (c=1, i, I, a, A). |
+------------+--------------------------------------------------------------+
| .rr R | Remove register R. |
+------------+--------------------------------------------------------------+
+------------+--------------------------------------------------------------+
| Request For| Function -- Tabs, Leaders, and Fields |
+------------+--------------------------------------------------------------+
| .ta Nt . . | Tab settings; left type, unless t=R (right) or C (centered). |
| . | |
+------------+--------------------------------------------------------------+
| .tc c | Tab repetition character. |
+------------+--------------------------------------------------------------+
| .lc c | Leader repetition character. |
+------------+--------------------------------------------------------------+
| .fc a b | Set field delimiter a and pad character b. |
+------------+--------------------------------------------------------------+
+------------+--------------------------------------------------------------+
| Request For| Function -- Input/Output Conventions |
| | and Character Translations |
+------------+--------------------------------------------------------------+
| .ec c | Set escape character. |
+------------+--------------------------------------------------------------+
| .eo | Turn off escape character mechanism. |
+------------+--------------------------------------------------------------+
| .lg N | Ligature on if N>0. |
+------------+--------------------------------------------------------------+
| .ul N | Underline in nroff or italicize in troff the next N input |
| | lines. |
+------------+--------------------------------------------------------------+
| .cu N | Continuous underline in nroff. Acts like .ul in troff. |
+------------+--------------------------------------------------------------+
| .uf F | Underline font set to F (to be switched to by .ul). |
+------------+--------------------------------------------------------------+
| .cc c | Set control character to c. |
+------------+--------------------------------------------------------------+
| .c2 c | Set no-break control character to c. |
+------------+--------------------------------------------------------------+
| .tr abcd . | Translates a to b, and so on, on output. |
| . . | |
+------------+--------------------------------------------------------------+
+------------+--------------------------------------------------------------+
| Request For| Function -- Hyphenation |
+------------+--------------------------------------------------------------+
| .nh | No hyphenation. |
+------------+--------------------------------------------------------------+
| .hy H | Hyphenate; N = mode. |
+------------+--------------------------------------------------------------+
| .hc c | Hyphenation indicator character c |
+------------+--------------------------------------------------------------+
| .wc word . | Exception words. |
| . . | |
+------------+--------------------------------------------------------------+
+---------------+-----------------------------------------------------------+
| Request Form | Function -- Three Part Titles |
+---------------+-----------------------------------------------------------+
| .tl | Three part title. |
| 'left'center'r|ght' |
+---------------+-----------------------------------------------------------+
| .pc c | Page number character. |
+---------------+-----------------------------------------------------------+
| .lt #N | Length of title. |
+---------------+-----------------------------------------------------------+
+---------------+-----------------------------------------------------------+
| Request Form | Function -- Output Line Numbering |
+---------------+-----------------------------------------------------------+
| .nm #N M S I | Number mode on or off, set parameters. |
+---------------+-----------------------------------------------------------+
| .nm N | Do not number next N lines. |
+---------------+-----------------------------------------------------------+
+----------------------+----------------------------------------------------+
| Request Form | Function -- Conditional Acceptance of Input |
+----------------------+----------------------------------------------------+
| .if c.anything | If condition c is true, accept anything as input. |
| | For multiple lines, use \{anything\}. |
+----------------------+----------------------------------------------------+
| .if !c anything | If condition c is false, accept anything as input. |
+----------------------+----------------------------------------------------+
| .if N anything | If expression N>0, accept anything as input. |
+----------------------+----------------------------------------------------+
| .if ! N anything | If expression N<0, accept anything as input. |
+----------------------+----------------------------------------------------+
| .if" | If string1 is identical to string2, accept any- |
| '"string1"'"string2"'| thing as input. |
| anything | |
+----------------------+----------------------------------------------------+
| .if | If string1 is not identical to string2, accept |
| !'string1'string2.' | anything as input. |
| anything | |
+----------------------+----------------------------------------------------+
+----------------------+----------------------------------------------------+
| Request Form | Function -- Conditional Acceptance of Input |
+----------------------+----------------------------------------------------+
| .ie c anything | If part of if-else; can take all forms of if |
| | above. |
+----------------------+----------------------------------------------------+
| .el anything | Else part of if-else. |
+----------------------+----------------------------------------------------+
+------------+--------------------------------------------------------------+
| Request For| Function -- Environment Switching |
+------------+--------------------------------------------------------------+
| .ev N | Environment switched (push down). |
+------------+--------------------------------------------------------------+
+------------+--------------------------------------------------------------+
| Request For| Function -- Insertions from Standard Input |
+------------+--------------------------------------------------------------+
| .rd prompt | Read insertion. |
+------------+--------------------------------------------------------------+
| .ex | Exit from nroff or troff. |
+------------+--------------------------------------------------------------+
+------------+--------------------------------------------------------------+
| Request For| Function -- Input/Output File Switching |
+------------+--------------------------------------------------------------+
| .so file | Switch source file (push down). |
+------------+--------------------------------------------------------------+
| .nx file | Next file. |
+------------+--------------------------------------------------------------+
| .pi | Pipe output to program (nroff only). |
| program | |
+------------+--------------------------------------------------------------+
+------------+--------------------------------------------------------------+
| Request For| Function -- Miscellaneous |
+------------+--------------------------------------------------------------+
| .mc c N | Set margin character c and separation N. |
+------------+--------------------------------------------------------------+
| .tm string | Print string on standard error output. |
+------------+--------------------------------------------------------------+
| .ig yy | Ignore untill call of yy. |
+------------+--------------------------------------------------------------+
| .pm t | Print macro names and sizes; if t is present, print only the |
| | total of sizes. |
+------------+--------------------------------------------------------------+
| .fl | Flush output buffer. |
+------------+--------------------------------------------------------------+
| .ab [text] | Prints text on standard error output and stops output. |
| | "User abort" is printed if no text is included. |
+------------+--------------------------------------------------------------+
+------------+--------------------------------------------------------------+
| Request For| Function -- Miscellaneous |
+------------+--------------------------------------------------------------+
| ! cmd | Runs the AIX command cmd and interpolates at that point. |
| parms | The standard input for cmd is closed. |
+------------+--------------------------------------------------------------+
Escape Sequences for Characters, Indicators, and Functions
+------------+--------------------------------------------------------------+
| Escape | |
| Sequence | Meaning |
+------------+--------------------------------------------------------------+
| \\ | Prevents or delays interpretation of \. |
+------------+--------------------------------------------------------------+
| \e | Printable version of the current escape character. |
+------------+--------------------------------------------------------------+
| \]. | Acute accent; equivalent to \(aa. |
+------------+--------------------------------------------------------------+
| \`. | Grave accent; equivalent to \(ga. |
+------------+--------------------------------------------------------------+
| \- | Minus sign in the current font. |
+------------+--------------------------------------------------------------+
| \. | Dot. |
+------------+--------------------------------------------------------------+
| \(space) | Unpaddable space-size character. |
+------------+--------------------------------------------------------------+
| \0 | Digit width space. |
+------------+--------------------------------------------------------------+
| \| | 1/6 em narrow space character (zero width in nroff). |
+------------+--------------------------------------------------------------+
| \^ | 1/12 em half-narrow space character (zero width in nroff). |
+------------+--------------------------------------------------------------+
| \& | Non-printing, zero-width character. |
+------------+--------------------------------------------------------------+
| \! | Transparent line indicator. |
+------------+--------------------------------------------------------------+
| \$N | Interpolate argument 1<N<9. |
+------------+--------------------------------------------------------------+
| \% | Default optional hyphenation character. |
+------------+--------------------------------------------------------------+
| \(xx | Character named xx. |
+------------+--------------------------------------------------------------+
| \\*x, | Interpolate string x or xx. |
| \*(xx | |
+------------+--------------------------------------------------------------+
| \a | Non-interpreted leader character. |
+------------+--------------------------------------------------------------+
| \b'abc . . | Bracket building function. |
| . ' | |
+------------+--------------------------------------------------------------+
| \c | Interrupt text processing (continue word across input line |
| | break). |
+------------+--------------------------------------------------------------+
+------------+--------------------------------------------------------------+
| Escape | |
| Sequence | Meaning |
+------------+--------------------------------------------------------------+
| \d | Forward (down) 1/2 em vertical motion (1/2 line in nroff). |
+------------+--------------------------------------------------------------+
| \fx, | Change to font N named x or xx, or font position N. |
| \f(xx, \fN | |
+------------+--------------------------------------------------------------+
| \gx, \g(xx | Return the format of register x or xx. Return nothing if |
| | the register has not yet been referenced. |
+------------+--------------------------------------------------------------+
| \h'N' | Local horizontal motion; move right N (negative left). |
+------------+--------------------------------------------------------------+
| \jx, \jxx | Mark in register x or xx the current horizontal position on |
| | the output line. |
+------------+--------------------------------------------------------------+
| \kx | Mark horizontal input place in register x. |
+------------+--------------------------------------------------------------+
| \l'N[c]' | Horizontal line drawing function. |
+------------+--------------------------------------------------------------+
| \L'N[c]' | Vertical line drawing function. |
+------------+--------------------------------------------------------------+
| \nx, \(xx | Interpolate number register x or xx. |
+------------+--------------------------------------------------------------+
| \o'abc . . | Overstrike characters a, b, c, . . . . |
| . ' | |
+------------+--------------------------------------------------------------+
| \p | Break and spread output line. |
+------------+--------------------------------------------------------------+
| \r | Reverse 1 em vertical motion (reverse line in nroff). |
+------------+--------------------------------------------------------------+
| \sN, \s#N | Point-size change function. |
+------------+--------------------------------------------------------------+
| \t | Non-interpreted horizontal tab. |
+------------+--------------------------------------------------------------+
| \u | Reverse (up) 1/2 em vertical motion (1/2 line in nroff). |
+------------+--------------------------------------------------------------+
| \v'N' | Local vertical motion ; move down N (negative up). |
+------------+--------------------------------------------------------------+
| \w'string' | Interpolate width of string. |
+------------+--------------------------------------------------------------+
| \x'N' | Extra line-space function (negative before, positive after). |
+------------+--------------------------------------------------------------+
| \zc | Print c with zero width without spacing. |
+------------+--------------------------------------------------------------+
| \{ | Begin conditional input. |
+------------+--------------------------------------------------------------+
| \} | End conditional input. |
+------------+--------------------------------------------------------------+
| \(new | Concealed new line. |
| line) | |
+------------+--------------------------------------------------------------+
| \X | X, any character not listed above. |
+------------+--------------------------------------------------------------+
Predefined General Number Registers
+------------+--------------------------------------------------------------+
| Register | |
| Name | Description |
+------------+--------------------------------------------------------------+
| % | Current page number. |
+------------+--------------------------------------------------------------+
| ct | Character width type (set by width function). |
+------------+--------------------------------------------------------------+
| dl | Maximum width of last completed diversion. |
+------------+--------------------------------------------------------------+
| dn | Height (vertical size) of last completed diversion. |
+------------+--------------------------------------------------------------+
| dw | Current day of the week (1=Sunday . . . 7=Saturday). |
+------------+--------------------------------------------------------------+
| dy | Current day of the month (1-31). |
+------------+--------------------------------------------------------------+
| hp | Current horizontal place on the input line. |
+------------+--------------------------------------------------------------+
| ln | Output line number. |
+------------+--------------------------------------------------------------+
| mo | Current month (1-12). |
+------------+--------------------------------------------------------------+
| nl | Vertical position of last printed text base-line. |
+------------+--------------------------------------------------------------+
| sb | Depth of string below base line (generated by width func- |
| | tion). |
+------------+--------------------------------------------------------------+
| st | Height of string above base line (generated by width func- |
| | tion). |
+------------+--------------------------------------------------------------+
| yr | Last two digits of current year. |
+------------+--------------------------------------------------------------+
Predefined Read-Only Number Registers
+------------+--------------------------------------------------------------+
| Register | |
| Name | Meaning |
+------------+--------------------------------------------------------------+
| $ | Number of arguments available at the current macro level. |
+------------+--------------------------------------------------------------+
| .A | Set to 1 in troff if the -a flag is used; always 1 in nroff. |
+------------+--------------------------------------------------------------+
| .F | The name of the current input file. |
+------------+--------------------------------------------------------------+
| .H | Available horizontal resolution in basic units. |
+------------+--------------------------------------------------------------+
| .L | Contains the current line spacing parameter. |
+------------+--------------------------------------------------------------+
| .P | Contains the value 1 if the current page is being printed, 0 |
| | otherwise. |
+------------+--------------------------------------------------------------+
| .R | The number of columns available. |
+------------+--------------------------------------------------------------+
| .T | Set to 1 in nroff, it the -T flag is used; always 0 in |
| | troff. |
+------------+--------------------------------------------------------------+
| .V | Available vertical resolution in basic units. |
+------------+--------------------------------------------------------------+
| .a | Post-line extra line-space most recently utilized using |
| | \s'N'. |
+------------+--------------------------------------------------------------+
| .b | Emboldening factor of the current font. |
+------------+--------------------------------------------------------------+
| .c | Number of lines read from current input file, including .so |
| | files. |
+------------+--------------------------------------------------------------+
| .d | Current vertical place in current diversion; equal to nl if |
| | no diversion. |
+------------+--------------------------------------------------------------+
| .f | Current font as physical quadrant. |
+------------+--------------------------------------------------------------+
| .h | Text base-line high-water mark on current page or diversion. |
+------------+--------------------------------------------------------------+
| .i | Current indent. |
+------------+--------------------------------------------------------------+
| .j | Current adjustment mode and type. |
+------------+--------------------------------------------------------------+
| .k | Contains the horizontal size of the text portion of the |
| | current, partially-collected output line, if any, in the |
| | current environment. |
+------------+--------------------------------------------------------------+
| .l | Current line length. |
+------------+--------------------------------------------------------------+
| .n | Length of text portion on previous output line. |
+------------+--------------------------------------------------------------+
| .o | Current page offset. |
+------------+--------------------------------------------------------------+
| .p | Current page length. |
+------------+--------------------------------------------------------------+
+------------+--------------------------------------------------------------+
| Register | |
| Name | Meaning |
+------------+--------------------------------------------------------------+
| .s | Current point size. |
+------------+--------------------------------------------------------------+
| .t | Distance to the next trap. |
+------------+--------------------------------------------------------------+
| .u | Equal to 1 in fill mode; equal to 0 in no-fill mode. |
+------------+--------------------------------------------------------------+
| .v | Current vertical line spacing. |
+------------+--------------------------------------------------------------+
| .w | Width of previous character. |
+------------+--------------------------------------------------------------+
| .x | Reserved version-dependent register. |
+------------+--------------------------------------------------------------+
| .y | Reserved version-dependent register. |
+------------+--------------------------------------------------------------+
| .z | Name of current diversion. |
+------------+--------------------------------------------------------------+
FILES
/usr/lib/suftab Suffix hyphenation tables.
/tmp/ta$# Temporary file.
/usr/lib/tmac/tmac.*
Standard macro files.
/usr/lib/macros/* Standard macro files.
/usr/lib/font/* Font width tables for troff.
/usr/lib/term/* Work station driving tables for
nroff.
RELATED INFORMATION
The following commands: "col," "cw, checkcw," "eqn,
neqn, checkeq," "mm, checkmm," "mmt, checkmm," "greek,"
"tbl," and "tc."
The mm miscellaneous facility in AIX Operating System
Technical Reference.
The discussion of nroff and troff in Text Formatting
Guide.