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