| blob | c5c390da7e8293008c6e5e693a4ec72e2525ef04 |
1 .ig \"-*- nroff -*-
2 Copyright (C) 1989-2000 Free Software Foundation, Inc.
4 Permission is granted to make and distribute verbatim copies of
5 this manual provided the copyright notice and this permission notice
6 are preserved on all copies.
8 Permission is granted to copy and distribute modified versions of this
9 manual under the conditions for verbatim copying, provided that the
10 entire resulting derived work is distributed under the terms of a
11 permission notice identical to this one.
13 Permission is granted to copy and distribute translations of this
14 manual into another language, under the above conditions for modified
15 versions, except that this permission notice may be included in
16 translations approved by the Free Software Foundation instead of in
17 the original English.
18 ..
19 .de TQ
20 .br
21 .ns
22 .TP \\$1
23 ..
24 .\" Like TP, but if specified indent is more than half
25 .\" the current line-length - indent, use the default indent.
26 .de Tp
27 .ie \\n(.$=0:((0\\$1)*2u>(\\n(.lu-\\n(.iu)) .TP
28 .el .TP "\\$1"
29 ..
30 .TH GROFF @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
31 .SH NAME
32 groff \- front end for the groff document formatting system
33 .SH SYNOPSIS
34 .nr a \n(.j
35 .ad l
36 .nr i \n(.i
37 .in +\w'\fBgroff 'u
38 .ti \niu
39 .B groff
40 .de OP
41 .ie \\n(.$-1 .RI "[\ \fB\\$1\fP" "\\$2" "\ ]"
42 .el .RB "[\ " "\\$1" "\ ]"
43 ..
44 .OP \-abeghilpstvzCENRSUVXZ
45 .OP \-w name
46 .OP \-W name
47 .OP \-m name
48 .OP \-F dir
49 .OP \-I dir
50 .OP \-T dev
51 .OP \-f fam
52 .OP \-M dir
53 .OP \-d cs
54 .OP \-r cn
55 .OP \-n num
56 .OP \-o list
57 .OP \-P arg
58 .OP \-L arg
59 .RI "[\ " files\|.\|.\|. "\ ]"
60 .br
61 .ad \na
62 .PP
63 It is possible to have whitespace between a command line option and its
64 parameter.
65 .SH DESCRIPTION
66 .B groff
67 is a front-end to the groff document formatting system.
68 Normally it runs the
69 .B @g@troff
70 program and a postprocessor appropriate for the selected
71 device.
72 Available devices are:
73 .TP
74 .B ps
75 For PostScript printers and previewers
76 .TP
77 .B dvi
78 For TeX dvi format.
79 .TP
80 .B X75
81 For a 75 dpi X11 previewer.
82 .TP
83 .B X100
84 For a 100dpi X11 previewer.
85 .TP
86 .B ascii
87 For typewriter-like devices.
88 .TP
89 .B latin1
90 For typewriter-like devices using the ISO Latin-1 (ISO 8859-1) character set.
91 .TP
92 .B utf8
93 For typewriter-like devices using the Unicode (ISO 10646) character set with
94 UTF-8 encoding.
95 .TP
96 .B lj4
97 For an HP LaserJet4-compatible (or other PCL5-compatible) printer.
98 .TP
99 .B lbp
100 For Canon CAPSL printers (LBP-4 and LBP-8 series laser printers).
101 .TP
102 .B html
103 To produce HTML output.
104 .LP
105 The postprocessor to be used for a device is specified by the
106 .B postpro
107 command in the device description file.
108 This can be overridden with the
109 .B \-X
110 option.
111 .LP
112 The default device is
113 .BR @DEVICE@ .
114 It can optionally preprocess with any of
115 .BR @g@pic ,
116 .BR @g@eqn ,
117 .BR @g@tbl ,
118 .BR @g@refer ,
119 or
120 .B @g@soelim.
121 .LP
122 Options without an argument can be grouped behind a single
123 .BR \- .
124 A filename of
125 .B \-
126 denotes the standard input.
127 .LP
128 The
129 .B grog
130 command can be used to guess the correct groff command to use to
131 format a file.
132 .SH OPTIONS
133 .TP
134 .B \-h
135 Print a help message.
136 .TP
137 .B \-e
138 Preprocess with @g@eqn.
139 .TP
140 .B \-t
141 Preprocess with @g@tbl.
142 .TP
143 .B \-g
144 Preprocess with @g@grn.
145 .TP
146 .B \-p
147 Preprocess with @g@pic.
148 .TP
149 .B \-s
150 Preprocess with @g@soelim.
151 .TP
152 .BI \-I dir
153 This option is as described in
154 .BR @g@soelim (@MAN1EXT@).
155 This option implies the
156 .B \-s
157 option.
158 .TP
159 .B \-R
160 Preprocess with @g@refer.
161 No mechanism is provided for passing arguments to
162 .B @g@refer
163 because most @g@refer options have equivalent commands
164 which can be included in the file.
165 See
166 .BR @g@refer (@MAN1EXT@)
167 for more details.
168 .TP
169 .B \-v
170 Make programs run by
171 .B groff
172 print out their version number.
173 .TP
174 .B \-V
175 Print the pipeline on stdout instead of executing it.
176 .TP
177 .B \-z
178 Suppress output from
179 .BR @g@troff .
180 Only error messages will be printed.
181 .TP
182 .B \-Z
183 Do not postprocess the output of
184 .BR @g@troff .
185 Normally
186 .B groff
187 will automatically run the appropriate postprocessor.
188 .TP
189 .BI \-P arg
190 Pass
191 .I arg
192 to the postprocessor.
193 Each argument should be passed with a separate
194 .B \-P
195 option.
196 Note that
197 .B groff
198 does not prepend
199 .B \-
200 to
201 .I arg
202 before passing it to the postprocessor.
203 .TP
204 .B \-l
205 Send the output to a printer.
206 The command used for this is specified by the
207 .B print
208 command in the device description file.
209 .TP
210 .BI \-L arg
211 Pass
212 .I arg
213 to the spooler.
214 Each argument should be passed with a separate
215 .B \-L
216 option.
217 Note that
218 .B groff
219 does not prepend
220 .B \-
221 to
222 .I arg
223 before passing it to the postprocessor.
224 .TP
225 .BI \-T dev
226 Prepare output for device
227 .IR dev .
228 The default device is
229 .BR @DEVICE@ .
230 .TP
231 .B \-X
232 Preview with
233 .B gxditview
234 instead of using the usual postprocessor.
235 .B Groff
236 passes
237 .B gxditview
238 a
239 .B -printCommand
240 option which will make the
241 .B Print
242 action do what
243 .B groff
244 would have done if the
245 .B -l
246 option had been given.
247 This is unlikely to produce good results except with
248 .BR \-Tps .
249 .TP
250 .B \-N
251 Don't allow newlines with eqn delimiters.
252 This is the same as the
253 .B \-N
254 option in
255 .BR @g@eqn .
256 .TP
257 .B \-S
258 Safer mode. Pass the
259 .B \-S
260 option to
261 .B @g@pic
262 and use the
263 .B \%\-msafer
264 macros with
265 .B @g@troff
266 (enabled by default).
267 .TP
268 .B \-U
269 Unsafe mode. Reverts to the old unsafe behaviour.
270 .TP
271 .B \-a
272 .TQ
273 .B \-b
274 .TQ
275 .B \-i
276 .TQ
277 .B \-C
278 .TQ
279 .B \-E
280 .TQ
281 .BI \-w name
282 .TQ
283 .BI \-W name
284 .TQ
285 .BI \-m name
286 .TQ
287 .BI \-o list
288 .TQ
289 .BI \-d cs
290 .TQ
291 .BI \-r cn
292 .TQ
293 .BI \-F dir
294 .TQ
295 .BI \-M dir
296 .TQ
297 .BI \-f fam
298 .TQ
299 .BI \-n num
300 These are as described in
301 .BR @g@troff (@MAN1EXT@) .
302 .SH ENVIRONMENT
303 .TP
304 .SM
305 .B GROFF_COMMAND_PREFIX
306 If this is set
307 .IR X ,
308 then
309 .B groff
310 will run
311 .IB X troff
312 instead of
313 .BR @g@troff .
314 This also applies to
315 .BR tbl ,
316 .BR pic ,
317 .BR eqn ,
318 .BR grn ,
319 .BR refer ,
320 and
321 .BR soelim .
322 It does not apply to
323 .BR grops ,
324 .BR grodvi ,
325 .BR grotty ,
326 .BR grolj4 ,
327 .BR grohtml ,
328 and
329 .BR gxditview .
330 .TP
331 .SM
332 .B GROFF_TMAC_PATH
333 A colon separated list of directories in which to search for
334 macro files.
335 .TP
336 .SM
337 .B GROFF_TYPESETTER
338 Default device.
339 .TP
340 .SM
341 .B GROFF_FONT_PATH
342 A colon separated list of directories in which to search for the
343 .BI dev name
344 directory.
345 .TP
346 .SM
347 .B PATH
348 The search path for commands executed by
349 .BR groff .
350 .TP
351 .SM
352 .B GROFF_TMPDIR
353 The directory in which temporary files will be created.
354 If this is not set and
355 .B
356 .SM TMPDIR
357 is set, temporary files will be created in that directory.
358 Otherwise temporary files will be created in
359 .BR /tmp .
360 The
361 .BR grops (@MAN1EXT@)
362 and
363 .BR @g@refer (@MAN1EXT@)
364 commands can create temporary files.
365 .SH FILES
366 .Tp \w'\fB@FONTDIR@/dev\fIname\fB/DESC'u+3n
367 .BI @FONTDIR@/dev name /DESC
368 Device description file for device
369 .IR name .
370 .TP
371 .BI @FONTDIR@/dev name / F
372 Font file for font
373 .I F
374 of device
375 .IR name .
376 .SH EXAMPLE
377 To print the man page
378 .B foo.1
379 to the standard output using the latin-1 output device and
380 .B less
381 as the pager, the following command can be used:
382 .IP
383 .B groff -mandoc -Tlatin1 foo.1 | less
384 .PP
385 Alternatively, you can say
386 .IP
387 .B groff -m mandoc -Tlatin1 foo.1 | less
388 .SH AUTHOR
389 James Clark <jjc@jclark.com>
390 .SH BUGS
391 Report bugs to bug-groff@gnu.org.
392 Include a complete, self-contained example
393 that will allow the bug to be reproduced,
394 and say which version of groff you are using.
395 .SH COPYRIGHT
396 Copyright \(co 1989-2000 Free Software Foundation, Inc.
397 .LP
398 groff is free software; you can redistribute it and/or modify it under
399 the terms of the GNU General Public License as published by the Free
400 Software Foundation; either version 2, or (at your option) any later
401 version.
402 .LP
403 groff is distributed in the hope that it will be useful, but WITHOUT ANY
404 WARRANTY; without even the implied warranty of MERCHANTABILITY or
405 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
406 for more details.
407 .LP
408 You should have received a copy of the GNU General Public License along
409 with groff; see the file COPYING. If not, write to the Free Software
410 Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
411 .SH AVAILABILITY
412 The most recent released version of groff is always available for
413 anonymous ftp from ftp.gnu.org in the directory gnu/groff.
414 .SH "SEE ALSO"
415 .BR grog (@MAN1EXT@),
416 .BR @g@troff (@MAN1EXT@),
417 .BR @g@tbl (@MAN1EXT@),
418 .BR @g@pic (@MAN1EXT@),
419 .BR @g@eqn (@MAN1EXT@),
420 .BR @g@grn (@MAN1EXT@),
421 .BR @g@soelim (@MAN1EXT@) ,
422 .BR @g@refer (@MAN1EXT@),
423 .BR grops (@MAN1EXT@),
424 .BR grodvi (@MAN1EXT@),
425 .BR grotty (@MAN1EXT@),
426 .BR grolj4 (@MAN1EXT@),
427 .BR grolbp (@MAN1EXT@),
428 .BR grohtml (@MAN1EXT@),
429 .BR gxditview (@MAN1EXT@),
430 .BR groff_font (@MAN5EXT@),
431 .BR groff_out (@MAN5EXT@),
432 .BR groff_man (@MAN7EXT@),
433 .BR groff_ms (@MAN7EXT@),
434 .BR groff_me (@MAN7EXT@),
435 .BR groff_char (@MAN7EXT@),
436 .BR groff_msafer (@MAN7EXT@)