| blob | a09a71e99c50fa2c682c6ccb31734490bfa4f3ba |
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 cp1047
97 For typewriter-like devices which use the EBCDIC code page IBM cp1047
98 (e.g. OS/390 Unix).
99 .TP
100 .B lj4
101 For an HP LaserJet4-compatible (or other PCL5-compatible) printer.
102 .TP
103 .B lbp
104 For Canon CAPSL printers (LBP-4 and LBP-8 series laser printers).
105 .TP
106 .B html
107 To produce HTML output.
108 .LP
109 The postprocessor to be used for a device is specified by the
110 .B postpro
111 command in the device description file.
112 This can be overridden with the
113 .B \-X
114 option.
115 .LP
116 The default device is
117 .BR @DEVICE@ .
118 It can optionally preprocess with any of
119 .BR @g@pic ,
120 .BR @g@eqn ,
121 .BR @g@tbl ,
122 .BR @g@refer ,
123 or
124 .B @g@soelim.
125 .LP
126 Options without an argument can be grouped behind a single
127 .BR \- .
128 A filename of
129 .B \-
130 denotes the standard input.
131 .LP
132 The
133 .B grog
134 command can be used to guess the correct groff command to use to
135 format a file.
136 .SH OPTIONS
137 .TP
138 .B \-h
139 Print a help message.
140 .TP
141 .B \-e
142 Preprocess with @g@eqn.
143 .TP
144 .B \-t
145 Preprocess with @g@tbl.
146 .TP
147 .B \-g
148 Preprocess with @g@grn.
149 .TP
150 .B \-p
151 Preprocess with @g@pic.
152 .TP
153 .B \-s
154 Preprocess with @g@soelim.
155 .TP
156 .BI \-I dir
157 This option is as described in
158 .BR @g@soelim (@MAN1EXT@).
159 This option implies the
160 .B \-s
161 option.
162 .TP
163 .B \-R
164 Preprocess with @g@refer.
165 No mechanism is provided for passing arguments to
166 .B @g@refer
167 because most @g@refer options have equivalent commands
168 which can be included in the file.
169 See
170 .BR @g@refer (@MAN1EXT@)
171 for more details.
172 .TP
173 .B \-v
174 Make programs run by
175 .B groff
176 print out their version number.
177 .TP
178 .B \-V
179 Print the pipeline on stdout instead of executing it.
180 .TP
181 .B \-z
182 Suppress output from
183 .BR @g@troff .
184 Only error messages will be printed.
185 .TP
186 .B \-Z
187 Do not postprocess the output of
188 .BR @g@troff .
189 Normally
190 .B groff
191 will automatically run the appropriate postprocessor.
192 .TP
193 .BI \-P arg
194 Pass
195 .I arg
196 to the postprocessor.
197 Each argument should be passed with a separate
198 .B \-P
199 option.
200 Note that
201 .B groff
202 does not prepend
203 .B \-
204 to
205 .I arg
206 before passing it to the postprocessor.
207 .TP
208 .B \-l
209 Send the output to a printer.
210 The command used for this is specified by the
211 .B print
212 command in the device description file.
213 .TP
214 .BI \-L arg
215 Pass
216 .I arg
217 to the spooler.
218 Each argument should be passed with a separate
219 .B \-L
220 option.
221 Note that
222 .B groff
223 does not prepend
224 .B \-
225 to
226 .I arg
227 before passing it to the postprocessor.
228 .TP
229 .BI \-T dev
230 Prepare output for device
231 .IR dev .
232 The default device is
233 .BR @DEVICE@ .
234 .TP
235 .B \-X
236 Preview with
237 .B gxditview
238 instead of using the usual postprocessor.
239 .B Groff
240 passes
241 .B gxditview
242 a
243 .B -printCommand
244 option which will make the
245 .B Print
246 action do what
247 .B groff
248 would have done if the
249 .B -l
250 option had been given.
251 This is unlikely to produce good results except with
252 .BR \-Tps .
253 .TP
254 .B \-N
255 Don't allow newlines with eqn delimiters.
256 This is the same as the
257 .B \-N
258 option in
259 .BR @g@eqn .
260 .TP
261 .B \-S
262 Safer mode. Pass the
263 .B \-S
264 option to
265 .B @g@pic
266 and use the
267 .B \%\-msafer
268 macros with
269 .B @g@troff
270 (enabled by default).
271 .TP
272 .B \-U
273 Unsafe mode. Reverts to the old unsafe behaviour.
274 .TP
275 .B \-a
276 .TQ
277 .B \-b
278 .TQ
279 .B \-i
280 .TQ
281 .B \-C
282 .TQ
283 .B \-E
284 .TQ
285 .BI \-w name
286 .TQ
287 .BI \-W name
288 .TQ
289 .BI \-m name
290 .TQ
291 .BI \-o list
292 .TQ
293 .BI \-d cs
294 .TQ
295 .BI \-r cn
296 .TQ
297 .BI \-F dir
298 .TQ
299 .BI \-M dir
300 .TQ
301 .BI \-f fam
302 .TQ
303 .BI \-n num
304 These are as described in
305 .BR @g@troff (@MAN1EXT@) .
306 .SH ENVIRONMENT
307 .TP
308 .SM
309 .B GROFF_COMMAND_PREFIX
310 If this is set
311 .IR X ,
312 then
313 .B groff
314 will run
315 .IB X troff
316 instead of
317 .BR @g@troff .
318 This also applies to
319 .BR tbl ,
320 .BR pic ,
321 .BR eqn ,
322 .BR grn ,
323 .BR refer ,
324 and
325 .BR soelim .
326 It does not apply to
327 .BR grops ,
328 .BR grodvi ,
329 .BR grotty ,
330 .BR grolj4 ,
331 .BR grohtml ,
332 and
333 .BR gxditview .
334 .TP
335 .SM
336 .B GROFF_TMAC_PATH
337 A colon separated list of directories in which to search for
338 macro files.
339 .TP
340 .SM
341 .B GROFF_TYPESETTER
342 Default device.
343 .TP
344 .SM
345 .B GROFF_FONT_PATH
346 A colon separated list of directories in which to search for the
347 .BI dev name
348 directory.
349 .TP
350 .SM
351 .B PATH
352 The search path for commands executed by
353 .BR groff .
354 .TP
355 .SM
356 .B GROFF_TMPDIR
357 The directory in which temporary files will be created.
358 If this is not set and
359 .B
360 .SM TMPDIR
361 is set, temporary files will be created in that directory.
362 Otherwise temporary files will be created in
363 .BR /tmp .
364 The
365 .BR grops (@MAN1EXT@)
366 and
367 .BR @g@refer (@MAN1EXT@)
368 commands can create temporary files.
369 .SH FILES
370 .Tp \w'\fB@FONTDIR@/dev\fIname\fB/DESC'u+3n
371 .BI @FONTDIR@/dev name /DESC
372 Device description file for device
373 .IR name .
374 .TP
375 .BI @FONTDIR@/dev name / F
376 Font file for font
377 .I F
378 of device
379 .IR name .
380 .LP
381 Note that on EBCDIC hosts, output devices
382 .BR ascii ,
383 .BR latin1 ,
384 and
385 .B utf8
386 aren't available.
387 Similarly,
388 .B cp1047
389 is not available on ASCII based operating systems.
390 .SH EXAMPLE
391 To print the man page
392 .B foo.1
393 to the standard output using the latin-1 output device and
394 .B less
395 as the pager, the following command can be used:
396 .IP
397 .B groff -mandoc -Tlatin1 foo.1 | less
398 .PP
399 Alternatively, you can say
400 .IP
401 .B groff -m mandoc -Tlatin1 foo.1 | less
402 .SH AUTHOR
403 James Clark <jjc@jclark.com>
404 .SH BUGS
405 Report bugs to bug-groff@gnu.org.
406 Include a complete, self-contained example
407 that will allow the bug to be reproduced,
408 and say which version of groff you are using.
409 .SH COPYRIGHT
410 Copyright \(co 1989-2000 Free Software Foundation, Inc.
411 .LP
412 groff is free software; you can redistribute it and/or modify it under
413 the terms of the GNU General Public License as published by the Free
414 Software Foundation; either version 2, or (at your option) any later
415 version.
416 .LP
417 groff is distributed in the hope that it will be useful, but WITHOUT ANY
418 WARRANTY; without even the implied warranty of MERCHANTABILITY or
419 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
420 for more details.
421 .LP
422 You should have received a copy of the GNU General Public License along
423 with groff; see the file COPYING. If not, write to the Free Software
424 Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
425 .SH AVAILABILITY
426 The most recent released version of groff is always available for
427 anonymous ftp from ftp.gnu.org in the directory gnu/groff.
428 .SH "SEE ALSO"
429 .BR grog (@MAN1EXT@),
430 .BR @g@troff (@MAN1EXT@),
431 .BR @g@tbl (@MAN1EXT@),
432 .BR @g@pic (@MAN1EXT@),
433 .BR @g@eqn (@MAN1EXT@),
434 .BR @g@grn (@MAN1EXT@),
435 .BR @g@soelim (@MAN1EXT@) ,
436 .BR @g@refer (@MAN1EXT@),
437 .BR grops (@MAN1EXT@),
438 .BR grodvi (@MAN1EXT@),
439 .BR grotty (@MAN1EXT@),
440 .BR grolj4 (@MAN1EXT@),
441 .BR grolbp (@MAN1EXT@),
442 .BR grohtml (@MAN1EXT@),
443 .BR gxditview (@MAN1EXT@),
444 .BR groff_font (@MAN5EXT@),
445 .BR groff_out (@MAN5EXT@),
446 .BR groff_man (@MAN7EXT@),
447 .BR groff_ms (@MAN7EXT@),
448 .BR groff_me (@MAN7EXT@),
449 .BR groff_char (@MAN7EXT@),
450 .BR groff_msafer (@MAN7EXT@)