nroff(1) - osol9

1nroff(1)                         User Commands                        nroff(1)
2
3
4

NAME

6       nroff - format documents for display or line-printer
7

SYNOPSIS

9       nroff [-ehiq] [-mname] [-nN] [-opagelist] [-raN] [-sN]
10            [-Tname] [-uN] [filename...]
11
12

DESCRIPTION

14       The  nroff  utility  formats text in the named filename for typewriter-
15       like devices. See also troff(1).
16
17
18       If no filename argument is present, nroff reads the standard input.  An
19       argument  consisting  of a `−' is taken to be a file name corresponding
20       to the standard input.
21

OPTIONS

23       The following options are supported. Options can appear in any order so
24       long as they appear before the files.
25
26       -e            Produces  equally-spaced  words  in adjusted lines, using
27                     full terminal resolution.
28
29
30       -h            Uses output TAB characters during horizontal  spacing  to
31                     speed output and reduces output character count. TAB set‐
32                     tings are assumed to be every 8 nominal character widths.
33
34
35       -i            Reads the  standard  input  after  the  input  files  are
36                     exhausted.
37
38
39       -q            Does not print output that was read from an .rd request.
40
41
42       -mname        Prepends  the  macro file /usr/share/lib/tmac/name to the
43                     input files.
44
45
46       -nN           Numbers first generated page N.
47
48
49       -opagelist    Prints only pages whose page numbers appear in the comma-
50                     separated  list  of numbers and ranges. A range N-M means
51                     pages N through M; an initial -N means from the beginning
52                     to page N; and a final N− means from N to the end.
53
54
55       -raN          Sets register a (one-character) to N.
56
57
58       -sN           Stops  every  N pages. nroff halts prior to every N pages
59                     (default N=1) to allow paper  loading  or  changing,  and
60                     resumes upon receipt of a NEWLINE.
61
62
63       -Tname        Prepares output for a device of the specified name. Known
64                     names are:
65
66                     37            Teletype Corporation Model  37  terminal  —
67                                   this is the default.
68
69
70                     lp | tn300    GE  —  any line printer or terminal without
71                                   half-line capability.
72
73
74                     300           DASI-300.
75
76
77                     300-12        DASI-300 — 12-pitch.
78
79
80                     300S          DASI-300S.
81
82
83                     300S-12       DASI-300S.
84
85
86                     382           DASI-382 (fancy DTC 382).
87
88
89                     450           DASI-450 (Diablo Hyterm).
90
91
92                     450-12        DASI-450 (Diablo Hyterm) — 12-pitch.
93
94
95                     832           AJ 832.
96
97
98
99       -uN           Set the emboldening factor for the font mounted in  posi‐
100                     tion  3  to  N. If N is missing, then set the emboldening
101                     factor to 0.
102
103

OPERANDS

105       The following operand is supported:
106
107       filename    The file containing text to be processed by nroff.
108
109

EXAMPLES

111       Example 1 Formatting with a macro package
112
113
114       The following command formats users.guide using the -me macro  package,
115       and stopping every 4 pages:
116
117
118         example% nroff −s4 −me users.guide
119
120
121

ENVIRONMENT VARIABLES

123       See  environ(5) for descriptions of the following environment variables
124       that affect the execution of nroff: LC_CTYPE, LC_MESSAGES, and NLSPATH.
125

FILES

127       /usr/tmp/trtmp*
128
129           temporary file (see NOTES)
130
131
132       /usr/share/lib/tmac/tmac.*
133
134           standard macro files
135
136
137       /usr/share/lib/nterm/*
138
139           terminal driving tables for nroff
140
141
142       /usr/share/lib/nterm/README
143
144           index to terminal description files
145
146

ATTRIBUTES

148       See attributes(5) for descriptions of the following attributes:
149
150
151
152
153       ┌─────────────────────────────┬─────────────────────────────┐
154       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
155       ├─────────────────────────────┼─────────────────────────────┤
156       │Availability                 │SUNWdoc                      │
157       ├─────────────────────────────┼─────────────────────────────┤
158       │CSI                          │Enabled                      │
159       └─────────────────────────────┴─────────────────────────────┘
160

NOTES

166       /usr/tmp is currently a symbolic link to /var/tmp.
167
168
169       Previous documentation incorrectly described the numeric register yr as
170       being the Last two digits of current year. yr is in actuality the  num‐
171       ber of years since 1900. To correctly obtain the last two digits of the
172       current year through the year  2099,  the  definition  given  below  of
173       string  register yy can be included in a document and subsequently used
174       to display a two-digit year. Notice that any other  available  one-  or
175       two-character register name can be substituted for yy.
176
177         .\" definition of new string register yy--last two digits of year
178         .\" use yr (# of years since 1900) if it is < 100
179         .ie \n(yr<100 .ds yy \n(yr
180         .el \{             .\" else, subtract 100 from yr, store in ny
181         .nr ny \n(yr-100
182         .ie \n(ny>9 \{     .\" use ny if it is two digits
183         .ds yy \n(ny
184         .\" remove temporary number register ny
185         .rr ny \}
186         .el \{.ds yy 0
187         .\" if ny is one digit, append it to 0
188         .as yy \n(ny
189         .rr ny \} \}
190
191
192
193
194SunOS 5.11                        1 Nov 2007                          nroff(1)