usr/src/man/man1/nroff.1

   1 '\" te
   2 .\"  Copyright (c) 2007, Sun Microsystems, Inc.) All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH NROFF 1 "Nov 1, 2007"
   7 .SH NAME
   8 nroff \- format documents for display or line-printer
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBnroff\fR [\fB-ehiq\fR] [\fB-m\fR\fIname\fR] [\fB-n\fR\fIN\fR] [\fB-o\fR\fIpagelist\fR] [\fB-r\fR\fIaN\fR] [\fB-s\fR\fIN\fR]
  13      [\fB-T\fR\fIname\fR] [\fB-u\fR\fIN\fR] [\fIfilename...\fR]
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 The \fBnroff\fR utility formats text in the named \fIfilename\fR for
  20 typewriter-like devices. See also \fBtroff\fR(1).
  21 .sp
  22 .LP
  23 If no \fIfilename\fR argument is present, \fBnroff\fR reads the standard input.
  24 An argument consisting of a `\fB\(mi\fR\&' is taken to be a file name
  25 corresponding to the standard input.
  26 .SH OPTIONS
  27 .sp
  28 .LP
  29 The following options are supported. Options can appear in any order so long as
  30 they appear \fIbefore\fR the files.
  31 .sp
  32 .ne 2
  33 .na
  34 \fB\fB-e\fR\fR
  35 .ad
  36 .RS 14n
  37 Produces equally-spaced words in adjusted lines, using full terminal
  38 resolution.
  39 .RE
  40
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fB-h\fR\fR
  45 .ad
  46 .RS 14n
  47 Uses output \fITAB\fR characters during horizontal spacing to speed output and
  48 reduces output character count. \fITAB\fR settings are assumed to be every 8
  49 nominal character widths.
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fB-i\fR\fR
  56 .ad
  57 .RS 14n
  58 Reads the standard input after the input files are exhausted.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fB-q\fR\fR
  65 .ad
  66 .RS 14n
  67 Does not print output that was read from an \fB\&.rd\fR request.
  68 .RE
  69
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fB-m\fR\fIname\fR\fR
  74 .ad
  75 .RS 14n
  76 Prepends the macro file \fB/usr/share/lib/tmac/\fIname\fR\fR to the input
  77 files.
  78 .RE
  79
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fB-n\fR\fIN\fR\fR
  84 .ad
  85 .RS 14n
  86 Numbers first generated page \fIN\fR.
  87 .RE
  88
  89 .sp
  90 .ne 2
  91 .na
  92 \fB\fB-o\fR\fIpagelist\fR\fR
  93 .ad
  94 .RS 14n
  95 Prints only pages whose page numbers appear in the comma-separated \fIlist\fR
  96 of numbers and ranges. A range \fIN\fR\fB-\fR\fIM\fR means pages \fIN\fR
  97 through \fIM\fR; an initial \fB-N\fR means from the beginning to page \fIN\fR;
  98 and a final \fIN\fR\(mi means from \fIN\fR to the end.
  99 .RE
 100
 101 .sp
 102 .ne 2
 103 .na
 104 \fB\fB-r\fR\fIaN\fR\fR
 105 .ad
 106 .RS 14n
 107 Sets register \fIa\fR (one-character) to \fIN\fR.
 108 .RE
 109
 110 .sp
 111 .ne 2
 112 .na
 113 \fB\fB-s\fR\fIN\fR\fR
 114 .ad
 115 .RS 14n
 116 Stops every \fIN\fR pages. \fBnroff\fR halts prior to every \fIN\fR pages
 117 (default \fIN\fR=1) to allow paper loading or changing, and resumes upon
 118 receipt of a \fINEWLINE\fR.
 119 .RE
 120
 121 .sp
 122 .ne 2
 123 .na
 124 \fB\fB-T\fR\fIname\fR\fR
 125 .ad
 126 .RS 14n
 127 Prepares output for a device of the specified \fIname\fR. Known \fIname\fRs
 128 are:
 129 .sp
 130 .ne 2
 131 .na
 132 \fB\fB37\fR\fR
 133 .ad
 134 .RS 14n
 135 Teletype Corporation Model 37 terminal \(em this is the default.
 136 .RE
 137
 138 .sp
 139 .ne 2
 140 .na
 141 \fB\fBlp\fR | \fBtn300\fR\fR
 142 .ad
 143 .RS 14n
 144 \fBGE\fR \(em any line printer or terminal without half-line capability.
 145 .RE
 146
 147 .sp
 148 .ne 2
 149 .na
 150 \fB\fB300\fR\fR
 151 .ad
 152 .RS 14n
 153 \fBDASI\fR-300.
 154 .RE
 155
 156 .sp
 157 .ne 2
 158 .na
 159 \fB\fB300-12\fR\fR
 160 .ad
 161 .RS 14n
 162 \fBDASI\fR-300 \(em 12-pitch.
 163 .RE
 164
 165 .sp
 166 .ne 2
 167 .na
 168 \fB\fB300S\fR\fR
 169 .ad
 170 .RS 14n
 171 \fBDASI\fR-300S.
 172 .RE
 173
 174 .sp
 175 .ne 2
 176 .na
 177 \fB\fB300S-12\fR\fR
 178 .ad
 179 .RS 14n
 180 \fBDASI\fR-300S.
 181 .RE
 182
 183 .sp
 184 .ne 2
 185 .na
 186 \fB\fB382\fR\fR
 187 .ad
 188 .RS 14n
 189 \fBDASI\fR-382 (fancy \fBDTC\fR 382).
 190 .RE
 191
 192 .sp
 193 .ne 2
 194 .na
 195 \fB\fB450\fR\fR
 196 .ad
 197 .RS 14n
 198 \fBDASI\fR-450 (Diablo Hyterm).
 199 .RE
 200
 201 .sp
 202 .ne 2
 203 .na
 204 \fB\fB450-12\fR\fR
 205 .ad
 206 .RS 14n
 207 \fBDASI\fR-450 (Diablo Hyterm) \(em 12-pitch.
 208 .RE
 209
 210 .sp
 211 .ne 2
 212 .na
 213 \fB\fB832\fR\fR
 214 .ad
 215 .RS 14n
 216 \fBAJ\fR 832.
 217 .RE
 218
 219 .RE
 220
 221 .sp
 222 .ne 2
 223 .na
 224 \fB\fB-u\fR\fIN\fR\fR
 225 .ad
 226 .RS 14n
 227 Set the emboldening factor for the font mounted in position \fB3\fR to \fIN\fR.
 228 If \fIN\fR is missing, then set the emboldening factor to \fB0\fR.
 229 .RE
 230
 231 .SH OPERANDS
 232 .sp
 233 .LP
 234 The following operand is supported:
 235 .sp
 236 .ne 2
 237 .na
 238 \fB\fIfilename\fR\fR
 239 .ad
 240 .RS 12n
 241 The file containing text to be processed by \fBnroff\fR.
 242 .RE
 243
 244 .SH EXAMPLES
 245 .LP
 246 \fBExample 1 \fRFormatting with a macro package
 247 .sp
 248 .LP
 249 The following command formats \fBusers.guide\fR using the \fB-me\fR macro
 250 package, and stopping every 4 pages:
 251
 252 .sp
 253 .in +2
 254 .nf
 255 example% \fBnroff \(mis4 \(mime users.guide\fR
 256 .fi
 257 .in -2
 258 .sp
 259
 260 .SH ENVIRONMENT VARIABLES
 261 .sp
 262 .LP
 263 See \fBenviron\fR(5) for descriptions of the following environment variables
 264 that affect the execution of \fBnroff\fR: \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR,
 265 and \fBNLSPATH\fR.
 266 .SH FILES
 267 .sp
 268 .ne 2
 269 .na
 270 \fB\fB/usr/tmp/trtmp*\fR\fR
 271 .ad
 272 .sp .6
 273 .RS 4n
 274 temporary file (see NOTES)
 275 .RE
 276
 277 .sp
 278 .ne 2
 279 .na
 280 \fB\fB/usr/share/lib/tmac/tmac.*\fR\fR
 281 .ad
 282 .sp .6
 283 .RS 4n
 284 standard macro files
 285 .RE
 286
 287 .sp
 288 .ne 2
 289 .na
 290 \fB\fB/usr/share/lib/nterm/*\fR\fR
 291 .ad
 292 .sp .6
 293 .RS 4n
 294 terminal driving tables for \fBnroff\fR
 295 .RE
 296
 297 .sp
 298 .ne 2
 299 .na
 300 \fB\fB/usr/share/lib/nterm/README\fR\fR
 301 .ad
 302 .sp .6
 303 .RS 4n
 304 index to terminal description files
 305 .RE
 306
 307 .SH ATTRIBUTES
 308 .sp
 309 .LP
 310 See \fBattributes\fR(5) for descriptions of the following attributes:
 311 .sp
 312
 313 .sp
 314 .TS
 315 box;
 316 c | c
 317 l | l .
 318 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 319 _
 320 CSI     Enabled
 321 .TE
 322
 323 .SH SEE ALSO
 324 .sp
 325 .LP
 326 \fBchecknr\fR(1), \fBcol\fR(1), \fBeqn\fR(1), \fBman\fR(1), \fBtbl\fR(1),
 327 \fBtroff\fR(1), \fBattributes\fR(5), \fBenviron\fR(5), \fBme\fR(5),
 328 \fBms\fR(5), \fBterm\fR(5)
 329 .SH NOTES
 330 .sp
 331 .LP
 332 \fB/usr/tmp\fR is currently a symbolic link to \fB/var/tmp\fR.
 333 .sp
 334 .LP
 335 Previous documentation incorrectly described the numeric register \fByr\fR as
 336 being the \fBLast two digits of current year\fR. \fByr\fR is in actuality the
 337 number of years since 1900. To correctly obtain the last two digits of the
 338 current year through the year 2099, the definition given below of string
 339 register \fByy\fR can be included in a document and subsequently used to
 340 display a two-digit year. Notice that any other available one- or two-character
 341 register name can be substituted for \fByy\fR.
 342 .sp
 343 .in +2
 344 .nf
 345 \&.\e" definition of new string register yy--last two digits of year
 346 \&.\e" use yr (# of years since 1900) if it is < 100
 347 \&.ie \en(yr<100 .ds yy \en(yr
 348 \&.el \e{             .\e" else, subtract 100 from yr, store in ny
 349 \&.nr ny \en(yr-100
 350 \&.ie \en(ny>9 \e{     .\e" use ny if it is two digits
 351 \&.ds yy \en(ny
 352 \&.\e" remove temporary number register ny
 353 \&.rr ny \e}
 354 \&.el \e{.ds yy 0
 355 \&.\e" if ny is one digit, append it to 0
 356 \&.as yy \en(ny
 357 \&.rr ny \e} \e}
 358 .fi
 359 .in -2
 360