aboutsummaryrefslogtreecommitdiffstats
path: root/troff/troff.d/troff.1.in
blob: 65655d27ee04c6c6ff8c0dec3e53c9da50cbcecf (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
.\"
.\" Sccsid @(#)troff.1b	1.22 (gritter) 9/4/06
.\" Derived from troff(1), Unix 7th edition:
.\" Copyright(C) Caldera International Inc. 2001-2002. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\"   Redistributions of source code and documentation must retain the
.\"    above copyright notice, this list of conditions and the following
.\"    disclaimer.
.\"   Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"   All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"      This product includes software developed or owned by Caldera
.\"      International, Inc.
.\"   Neither the name of Caldera International, Inc. nor the names of
.\"    other contributors may be used to endorse or promote products
.\"    derived from this software without specific prior written permission.
.\"
.\" USE OF THE SOFTWARE PROVIDED FOR UNDER THIS LICENSE BY CALDERA
.\" INTERNATIONAL, INC. AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL CALDERA INTERNATIONAL, INC. BE
.\" LIABLE FOR ANY DIRECT, INDIRECT INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
.\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
.\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.TH TROFF 1 "9/4/06" "Heirloom Documentation Tools" "BSD System Compatibility"
.SH NAME
troff \- typeset or format documents
.SH SYNOPSIS
.HP
.ad l
.nh
\fBtroff\fR
[\fB\-af\&izV\fR]
[\fB\-d\fIaS\fR]
[\fB\-d\fIa\fB=\fIS\fR]
[\fB\-F\fIfontdir\fR]
[\fB\-m\fIname\fR]
[\fB\-n\fIN\fR]
[\fB\-o\fIlist\fR]
[\fB\-r\fIaN\fR]
[\fB\-r\fIa\fB=\fIN\fR]
[\fB\-s\fIN\fR]
[\fB\-T\fIdevice\fR]
[\fB\-u\fIN\fR]
[\fB\-x\fIN\fR]
.br
.hy 1
.ad b
.SH DESCRIPTION
.I troff
formats text in the named
.I files
for printing on phototypesetter devices.
Its capabilities are described in the
.I Nroff/Troff user's manual.
.PP
.I troff
generates output in an intermediate ASCII format
which must be passed through a device-dependent post-processor
before it can be printed;
see the description of the
.I \-T
option
and the example
below.
.PP
If no
.I file
argument is present, the standard input is read.
An argument consisting of a single minus
.RB ( \- )
is taken to be
a file name corresponding to the standard input.
The options, which may appear in any order so long as they appear
before the files, are:
.TP "\w'\f3\-F\f1fontdir 'u"
.BI \-o list
Print only pages whose page numbers appear in
the comma-separated
.I list
of numbers and ranges.
A range
.IB N \- M
means pages
.I N
through
.IR M ;
an initial
.I \-N
means
from the beginning to page
.IR N ;
and a final
.IR N \-
means
from
.I N
to the end.
.TP
.BI \-n N
Number first generated page
.IR N .
.TP
.BI \-s N
Stop every
.I N
pages.
.I Troff
will stop the phototypesetter every
.I N
pages,
produce a trailer to allow changing cassettes,
and resume when the typesetter's start button is pressed.
.TP
.BI \-m name
Prepend the macro file
.BI /usr/ucblib/doctools/tmac/tmac. name
to the input
.IR files .
.TP
.BI \-r aN
Set register
.I a
(one-character) to
.IR N .
.TP
.BI \-r a = N
Set register
.I a
(may be more than one character) to
.IR N .
.TP
.BI \-d aS
Define string
.I a
(one-character) to
.IR S .
.TP
.BI \-d a = S
Define string
.I a
(may be more than one character) to
.IR S .
.TP
.B \-i
Read standard input after the input files are exhausted.
.TP
.B \-z
Check syntax only;
do not generate any output
except for error messages.
.TP
.BI \-F fontdir
Use the directory
.I fontdir
to locate font files.
.TP
.B \-u N
Set the emboldening amount,
i.e. the number of times a character is printed
to simulate bold output,
to
.IR N .
.TP
.BI \-T device
Prepare output for the specified device.
Available
.I devices
are:
.RS
.TP 8n
.PD 0
.B ps
for PostScript output with 72,000\ dpi
and AFM fonts (default),
with
.I dpost
as post-processor
.TP
.B psmed
for PostScript output with 3,600\ dpi
and AFM fonts,
with
.I dpost
as post-processor
.TP
.B pslow
for PostScript output with 432\ dpi
and AFM fonts,
with
.I dpost
as post-processor
.TP
.B post
for PostScript output with 720\ dpi
and
.I ditroff
fonts,
with
.I dpost
as post-processor
.TP
.B html
for HTML output,
with
.I dhtml
as post-processor
.ig \" aps is not installed any longer
.TP
.B aps
for the Autologic APS-5,
with
.I daps
as post-processor
..
.PD
.RE
.TP
.B \-f
Refrain from feeding out paper and stopping
phototypesetter at the end of the run.
.TP
.B \-a
Send a printable text-only approximation
of the results to the standard output.
.TP
.BI \-x N
Enable extensions to previous versions of
.I troff
at level
.IR N .
Level 0 disables any extensions;
level 1 enables all extensions
except for long requests and request arguments;
level 2 enables these in addition
but executes short requests which are prefixes of undefined long requests;
level 3 ignores undefined long requests.
.TP
.B \-V
Print troff version.
.SH "ENVIRONMENT VARIABLES"
.TP
.BR LANG ", " LC_ALL
See
.IR locale (7).
.TP
.B LC_CTYPE
Determines the mapping
of bytes to characters.
.TP
.B TYPESETTER
Specifies a device name as with the
.I \-T
option.
.TP
.B TROFFONTS
A colon-separated list of directory names
to search for PostScript fonts
before the device font directory.
.TP
.B TROFFMACS
Specifies the location to search for macro files with the
.I \-m
option.
This string forms a prefix to which the macro package name
is immediately appended.
Thus to make `\-mname' work with a file `/path/to/tmac.name',
use `TROFFMACS=/path/to/tmac.'
.SH FILES
.ta \w'/usr/ucblib/doctools/tmac/*  'u
/tmp/ta*	temporary file
.br
/usr/ucblib/doctools/tmac/*	standard macro files
.br
/usr/ucblib/doctools/font/*	font width tables
.SH EXAMPLES
To generate a PostScript file
from input that contains equations and tables, use
.RS
.nf
.sp
<input tbl | eqn | troff | dpost >output.ps
.sp
.fi
.RE
The resulting file can then be sent to a printer,
displayed by a previewer,
or passed to further post-processing utilities,
such as a PDF distiller.
.SH "SEE ALSO"
J. F. Ossanna,
.I Nroff/Troff user's manual
.br
B. W. Kernighan,
.I
A TROFF Tutorial
.br
eqn(1), tbl(1)