share/doc/usd/21.troff/m0

   1 .\" Hey, Emacs, edit this file in -*- nroff-fill -*- mode!
   2 .\" Copyright (C) Caldera International Inc. 2001-2002.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions are
   6 .\" met:
   7 .\"
   8 .\" Redistributions of source code and documentation must retain the above
   9 .\" copyright notice, this list of conditions and the following
  10 .\" disclaimer.
  11 .\"
  12 .\" Redistributions in binary form must reproduce the above copyright
  13 .\" notice, this list of conditions and the following disclaimer in the
  14 .\" documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" All advertising materials mentioning features or use of this software
  17 .\" must display the following acknowledgement:
  18 .\"
  19 .\" This product includes software developed or owned by Caldera
  20 .\" International, Inc.  Neither the name of Caldera International, Inc.
  21 .\" nor the names of other contributors may be used to endorse or promote
  22 .\" products derived from this software without specific prior written
  23 .\" permission.
  24 .\"
  25 .\" USE OF THE SOFTWARE PROVIDED FOR UNDER THIS LICENSE BY CALDERA
  26 .\" INTERNATIONAL, INC.  AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR
  27 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  28 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  29 .\" DISCLAIMED.  IN NO EVENT SHALL CALDERA INTERNATIONAL, INC. BE LIABLE
  30 .\" FOR ANY DIRECT, INDIRECT INCIDENTAL, SPECIAL, EXEMPLARY, OR
  31 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  32 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  33 .\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  34 .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  35 .\" OR OTHERWISE) RISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
  36 .\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  37 .\"
  38 .\"     @(#)m0  8.1 (Berkeley) 8/14/93
  39 .\"
  40 .\" $FreeBSD$
  41 .br
  42 .rs
  43 .sp |1.0i
  44 .ce 1000
  45 .ps 12
  46 .ft B
  47 \*(Nr\(sl\*(Tr User's Manual
  48 .sp .2i
  49 .ft I
  50 .ps 10
  51 Joseph F. Ossanna
  52 (updated for 4.3BSD by Mark Seiden)
  53 .ft R
  54 .sp
  55 Bell Laboratories
  56 Murray Hill, New Jersey 07974
  57 .ce 0
  58 .sp 2
  59 .ps \n(PS
  60 .fi
  61 .ft B
  62 .ps +1
  63 NOTE: This document in its current form describes the \fItroff\fP\| program
  64 supplied with 4.4BSD.  The \fIgroff\fP\| program supplied with FreeBSD has a
  65 number of additional features and a couple of small incompatibilities.  See
  66 \fIgroff(1)\fP\| for more details.
  67 .ps
  68 .sp 1
  69 Introduction
  70 .pg
  71 \*(NR and \*(TR are text processors under
  72 the \s-1UNIX\s+1 Time-Sharing System
  73 that format text for typewriter-like terminals and
  74 for a \%Graphic Systems phototypesetter, respectively.
  75 (Device-independent \*(TR, part of the Documenter's Workbench,
  76 supports additional output devices.)
  77 They accept lines of text interspersed with lines of
  78 format control information and
  79 format the text into a printable, paginated document
  80 having a user-designed style.
  81 \*(NR and \*(TR offer
  82 unusual freedom in document styling,
  83 including:
  84 arbitrary style headers and footers;
  85 arbitrary style footnotes;
  86 multiple automatic sequence numbering for paragraphs, sections, etc;
  87 multiple column output;
  88 dynamic font and point-size control;
  89 arbitrary horizontal and vertical local motions at any point;
  90 and
  91 a family of automatic overstriking, bracket construction, and
  92 line drawing functions.
  93 .pg
  94 \*(NR and \*(TR are highly compatible with each other and it is almost always
  95 possible to prepare input acceptable to both.
  96 Conditional input is provided that enables
  97 the user to embed input expressly destined for either program.
  98 \*(NR can prepare output directly for a variety of terminal types and
  99 is capable of utilizing the full resolution of each terminal.
 100 .pg
 101 .ft B
 102 Usage
 103 .pg
 104 The general form of invoking \*(NR (or \*(TR) at \s-1UNIX\s+1 command level is
 105 .x1
 106 \fBnroff  \fIoptions  files\fR\
 107 \h'|2i'(or  \fBtroff  \fIoptions  files\fR)
 108 .x2
 109 where \fIoptions\fR represents any of a number of option arguments
 110 and \fIfiles\fR represents the list of files containing the document
 111 to be formatted.
 112 An argument consisting of a single minus (\fB\-\fR) is taken to be
 113 a file name corresponding to the standard input.
 114 If no file names are given input is taken from the standard input.
 115 The options, which may appear in any order so long as they appear
 116 before the files, are:
 117 .sp
 118 .ta .2i 1.0i
 119 .ft I
 120 .bd I 3
 121         Option  Effect
 122 .br
 123 .bd I
 124 .ft R
 125 .ta .3i 1.0i
 126 .in 1.0i
 127 .ll -.3i
 128 .bt
 129         \fB\-i\fP       Read standard input after the input files are exhausted.
 130 .bt
 131         \fB\-m\fIname\fR        Prepends the macro file
 132 \fB\(slusr\(sllib\(sltmac.\fIname\fR
 133 to the input \fIfiles\fR.
 134 .bt
 135         \fB\-n\fIN\fR   Number first generated page \fIN\fR.
 136 .bt
 137         \fB\-o\fIlist\fR        \
 138 Print only pages whose page numbers appear in \fIlist\fR,
 139 which consists of comma-separated numbers and number ranges.
 140 A number range has the form \fIN\-M\fR
 141 and means pages \fIN\fR through \fIM;\fR
 142 a initial \fI\-N\fR means
 143 from the beginning to page \fIN;\fR and a final \fIN\-\fR means
 144 from \fIN\fR to the end.
 145 .bt
 146         \fB\-q\fR       \
 147 Invoke the simultaneous input-output mode of the \fBrd\fR request.
 148 .bt
 149         \fB\-r\fIaN\fR  Number register \fIa\fR (one-character) is set to \fIN\fR.
 150 .bt
 151         \fB\-s\fIN\fR   Stop every \fIN\fR pages.
 152 \*(NR will halt prior to every \fIN\fR pages (default \fIN\fR=1)
 153 to allow paper loading or
 154 changing, and will resume upon receipt of a newline.
 155 \*(TR will stop the phototypesetter every \fIN\fR pages,
 156 produce a trailer to allow changing cassettes,
 157 and will resume after the phototypesetter \s-1START\s+1 button is pressed.
 158 .bt
 159         \fB\-z\fR       Efficiently suppress formatted output.
 160 Only produce output to standard error (from \fBtm\fP requests or
 161 diagnostics).
 162 .sp
 163 .ne 5
 164 .ft I
 165 .bd I 3
 166                 \*(NR Only
 167 .br
 168 .bd I
 169 .ft
 170 .bt
 171         \fB\-T\fIname\fR        Specifies
 172 the name of the output terminal type.
 173 Currently defined names are \fB37\fR for the (default) Model 37 Teletype\(rg,
 174 \fBtn300\fR for the GE TermiNet\ 300 (or any terminal without half-line
 175 capabilities),
 176 \fB300S\fR for the \s-1DASI\s+1-300S,
 177 \fB300\fR for the \s-1DASI\s+1-300,
 178 and
 179 \fB450\fR for the \s-1DASI\s+1-450 (Diablo Hyterm).
 180 .bt
 181         \fB\-e\fR       \
 182 Produce equally-spaced words in adjusted
 183 lines, using full terminal resolution.
 184 .bt
 185         \fB\-h\fR       \
 186 On output, use tabs during horizontal spacing to increase speed.
 187 Device tabs setting are assumed to be (and input tabs are initially
 188 set to) every 8 character widths.
 189 .sp
 190 .ne 3
 191 .ft I
 192 .bd I 3
 193                 \*(TR Only
 194 .br
 195 .bd I
 196 .ft
 197 .bt
 198         \fB\-a\fP       Send a printable \s-1(ASCII)\s+1 approximation
 199 of the results to the standard output.
 200 .bt
 201         \fB\-b\fR       \*(TR will report whether the phototypesetter
 202 is busy or available.
 203 No text processing is done.
 204 .bt
 205         \fB\-f\fP       Refrain from feeding out paper and stopping
 206 phototypesetter at the end of the run.
 207 .bt
 208         \fB\-t\fP       Direct output to the standard output instead
 209 of the phototypesetter.
 210 .bt
 211         \fB\-w\fP       Wait until phototypesetter is available, if
 212 currently busy.
 213 .ll
 214 .in 0
 215 .xx
 216 .pg
 217 Each option is invoked as a separate argument;
 218 for example,
 219 .x1
 220 \fBnroff  \-o\fI4,8\-10  \fB\-T\fI300S  \fB\-m\fIabc  file1  file2\fR
 221 .x2
 222 requests formatting of pages 4, 8, 9, and 10 of a document contained in the files
 223 named \fIfile1\fR and \fIfile2\fR,
 224 specifies the output terminal as a \s-1DASI\s+1-300S,
 225 and invokes the macro package \fIabc\fR.
 226 .pg
 227 Various pre- and post-processors are available for use with \*(NR and \*(TR.
 228 These include the equation preprocessors \s-1NEQN\s+1 and \s-1EQN\s+1\*u1\*d
 229 (for \*(NR and \*(TR respectively),
 230 and the table-construction preprocessor \s-1TBL\s+1\*u2\*d.
 231 A reverse-line postprocessor \s-1COL\s+1\*u3\*d
 232 is available for multiple-column \*(NR output on terminals without reverse-line ability;
 233 \s-1COL\s+1 expects the Model 37 Teletype
 234 escape sequences that \*(NR produces by default.
 235 \s-1TK\s+1\*u3\*d
 236 is a 37 Teletype simulator postprocessor for printing \*(NR output on a Tektronix 4014.
 237 \s-1TC\s+1\*u5\*d
 238 is a phototypesetter-simulator postprocessor
 239 for \*(TR that produces an approximation of phototypesetter output
 240 on a Tektronix 4014.
 241 For example, in
 242 .x1
 243 \fBtbl  \fIfiles  \fB|  eqn  |  troff  \-t \fIoptions  \fB|  tc\fR
 244 .x2
 245 the first \|\fB|\fR\| indicates the piping of \s-1TBL\s+1's output to \s-1EQN\s+1's input;
 246 the second the piping of \s-1EQN\s+1's output to \*(TR's input;
 247 and the third indicates the piping of \*(TR's output to \s-1TC\s+1.
 248 .br
 249 .pg
 250 The remainder of this manual consists of:
 251 a Summary and outline;
 252 a Reference Manual keyed to the outline;
 253 and
 254 a set of Tutorial Examples.
 255 Another tutorial is [5].
 256 .sp .4
 257 .ps -1
 258 .vs -1p
 259 .pg
 260 .ft B
 261 References
 262 .pg
 263 .ta .3i
 264 .in .3i
 265 .ti 0
 266 [1]     B. W. Kernighan, L. L. Cherry,
 267 .ul
 268 Typesetting Mathematics \(em User's Guide (Second Edition),
 269 Bell Laboratories.
 270 .sp .4
 271 .ti 0
 272 [2]     M. E. Lesk,
 273 .ul
 274 Tbl \(em A Program to Format Tables,
 275 Bell Laboratories internal memorandum.
 276 .sp .4
 277 .ti 0
 278 [3]     Internal on-line documentation (\fIman\fP pages) on \s-1UNIX\s+1.
 279 .sp .4
 280 .ti 0
 281 [4]     B. W. Kernighan, \fIA TROFF Tutorial\fR,
 282 Bell Laboratories.
 283 .sp .4
 284 .ti 0
 285 [5]     Your site may have similar programs for more modern displays.
 286 .in 0
 287 .ps 10
 288 .vs 12
 289 .ft R
 290 .bp