Penguin
Recent Changes
Annotated edit history of groff(1) version 4, including all changes. View license author blame.
Rev Author # Line
1 perry 1 GROFF
2 !!!GROFF
3 NAME
4 SYNOPSIS
5 DESCRIPTION
6 OPTIONS
7 ENVIRONMENT
8 FILES
9 EXAMPLE
10 AUTHOR
11 BUGS
12 COPYRIGHT
13 AVAILABILITY
14 SEE ALSO
15 ----
16 !!NAME
17
18
19 groff - front end for the groff document formatting system
20 !!SYNOPSIS
21
22
23 __groff__ [[ __-abeghilpstvzCEGNRSUVXZ__ ] [[
24 __-w__''name'' ] [[ __-W__''name'' ] [[
25 __-m__''name'' ] [[ __-F__''dir'' ] [[
26 __-I__''dir'' ] [[ __-T__''dev'' ] [[
27 __-f__''fam'' ] [[ __-M__''dir'' ] [[
28 __-d__''cs'' ] [[ __-r__''cn'' ] [[
29 __-n__''num'' ] [[ __-o__''list'' ] [[
30 __-P__''arg'' ] [[ __-L__''arg'' ] [[
31 ''files...'' ]
32
33
34 It is possible to have whitespace between a command line
35 option and its parameter.
36 !!DESCRIPTION
37
38
39 __groff__ is a front-end to the groff document formatting
40 system. Normally it runs the __troff__ program and a
41 postprocessor appropriate for the selected device. Available
42 devices are:
43
44
45 __ps__
46
47
3 perry 48 For !PostScript printers and previewers
1 perry 49
50
51 __dvi__
52
53
54 For TeX dvi format.
55
56
57 __X75__
58
59
60 For a 75dpi X11 previewer.
61
62
63 __X100__
64
65
66 For a 100dpi X11 previewer.
67
68
69 __ascii__
70
71
72 For typewriter-like devices.
73
74
75 __ascii8__
76
77
78 For typewriter-like devices. Unlike __ascii__, this
79 device is 8 bit clean. This device is intended to be used
80 for codesets other than ASCII and ISO-8859-1.
81
82
83 __latin1__
84
85
86 For typewriter-like devices using the ISO Latin-1 (ISO
87 8859-1) character set.
88
89
90 __utf8__
91
92
93 For typewriter-like devices using the Unicode (ISO 10646)
94 character set with UTF-8 encoding.
95
96
97 __cp1047__
98
99
100 For typewriter-like devices which use the EBCDIC code page
101 IBM cp1047 (e.g. OS/390 Unix).
102
103
104 __nippon__
105
106
107 For typewriter-like devices using the Japanese-EUC character
108 set.
109
110
111 __lj4__
112
113
114 For an HP LaserJet4-compatible (or other PCL5-compatible)
115 printer.
116
117
118 __lbp__
119
120
121 For Canon CAPSL printers (LBP-4 and LBP-8 series laser
122 printers).
123
124
125 __html__
126
127
128 To produce HTML output.
129
130
131 The postprocessor to be used for a device is specified by
132 the __postpro__ command in the device description file.
133 This can be overridden with the __-X__
134 option.
135
136
137 The default device is __ps__. It can optionally
138 preprocess with any of __pic__, __eqn__, __grn__,
139 __grap__, __tbl__, __refer__, or
140 __soelim.__
141
142
143 Options without an argument can be grouped behind a single
144 __-__. A filename of __-__ denotes the standard
145 input.
146
147
148 The __grog__ command can be used to guess the correct
149 groff command to use to format a file.
150 !!OPTIONS
151
152
153 __-h__
154
155
156 Print a help message.
157
158
159 __-e__
160
161
162 Preprocess with eqn.
163
164
165 __-t__
166
167
168 Preprocess with tbl.
169
170
171 __-g__
172
173
174 Preprocess with grn.
175
176
177 __-G__
178
179
180 Preprocess with grap.
181
182
183 __-p__
184
185
186 Preprocess with pic.
187
188
189 __-s__
190
191
192 Preprocess with soelim.
193
194
195 __-I__''dir''
196
197
198 This option is as described in soelim(1). This option
199 implies the __-s__ option.
200
201
202 __-R__
203
204
205 Preprocess with refer. No mechanism is provided for passing
206 arguments to __refer__ because most refer options have
207 equivalent commands which can be included in the file. See
208 refer(1) for more details.
209
210
211 __-v__
212
213
214 Make programs run by __groff__ print out their version
215 number.
216
217
218 __-V__
219
220
221 Print the pipeline on stdout instead of executing
222 it.
223
224
225 __-z__
226
227
228 Suppress output from __troff__. Only error messages will
229 be printed.
230
231
232 __-Z__
233
234
235 Do not postprocess the output of __troff__. Normally
236 __groff__ will automatically run the appropriate
237 postprocessor.
238
239
240 __-P__''arg''
241
242
243 Pass ''arg'' to the postprocessor. Each argument should
244 be passed with a separate __-P__ option. Note that
245 __groff__ does not prepend __-__ to ''arg'' before
246 passing it to the postprocessor.
247
248
249 __-l__
250
251
252 Send the output to a spooler for printing. The command used
253 for this is specified by the __print__ command in the
254 device description file (if not present, __-l__ has no
255 effect).
256
257
258 __-L__''arg''
259
260
261 Pass ''arg'' to the spooler. Each argument should be
262 passed with a separate __-L__ option. Note that
263 __groff__ does not prepend __-__ to ''arg'' before
264 passing it to the postprocessor. If there is no __print__
265 command in the device description file, __-L__ is
266 ignored.
267
268
269 __-T__''dev''
270
271
272 Prepare output for device ''dev''. The default device is
273 __ps__.
274
275
276 __-X__
277
278
279 Preview with __gxditview__ instead of using the usual
280 postprocessor. __Groff__ passes __gxditview__ a
281 __-printCommand__ option which will make the __Print__
282 action do what __groff__ would have done if the __-l__
283 option had been given. This is unlikely to produce good
284 results except with __-Tps__.
285
286
287 __-N__
288
289
290 Don't allow newlines with eqn delimiters. This is the same
291 as the __-N__ option in __eqn__.
292
293
294 __-S__
295
296
297 Safer mode. Pass the __-S__ option to __pic__ and
298 disable the following __troff__ requests: __.open__,
299 __.opena__, __.pso__, __.sy__, and __.pi__. For
300 security reasons, safer mode is enabled by
301 default.
302
303
304 __-U__
305
306
307 Unsafe mode. Reverts to the old unsafe
308 behaviour.
309
310
311 __-a__
312
313
314 __-b__
315
316
317 __-i__
318
319
320 __-C__
321
322
323 __-E__
324
325
326 __-w__''name''
327
328
329 __-W__''name''
330
331
332 __-m__''name''
333
334
335 __-o__''list''
336
337
338 __-d__''cs''
339
340
341 __-r__''cn''
342
343
344 __-F__''dir''
345
346
347 __-M__''dir''
348
349
350 __-f__''fam''
351
352
353 __-n__''num''
354
355
356 These are as described in
357 troff(1)__.__
358 !!ENVIRONMENT
359
360
361 __GROFF_COMMAND_PREFIX__
362
363
364 If this is set ''X'', then __groff__ will run
365 ''X''__troff__ instead of __troff__. This also
366 applies to __tbl__, __pic__, __eqn__, __grn__,
367 __refer__, and __soelim__. It does not apply to
368 __grap__, __grops__, __grodvi__, __grotty__,
369 __grolj4__, __grohtml__, and
370 __gxditview__.
371
372
373 __GROFF_TMAC_PATH__
374
375
376 A colon separated list of directories in which to search for
377 macro files in addition to the default directories. See
378 troff(1) for more details.
379
380
381 __GROFF_TYPESETTER__
382
383
384 Default device.
385
386
387 __GROFF_FONT_PATH__
388
389
390 A colon separated list of directories in which to search for
391 the __dev__''name'' directory in addition to the
392 default one. See troff(1) for more
393 details.
394
395
396 __GROFF_BIN_PATH__
397
398
399 This search path, followed by __PATH__, will be used for
400 commands executed by __groff__. If not set, `/usr/bin' is
401 prepended to __PATH__.
402
403
404 __GROFF_TMPDIR__
405
406
407 The directory in which temporary files will be created. If
408 this is not set and __TMPDIR__ is set,
409 temporary files will be created in that directory. Otherwise
410 temporary files will be created in __/tmp__. The
411 grops(1) and refer(1) commands can create
412 temporary files.
413 !!FILES
414
415
416 __/usr/share/groff/1.17.2/font/dev__''name''__/DESC__
417
418
419 Device description file for device ''name''.
420
421
422 __/usr/share/groff/1.17.2/font/dev__''name''__/__''F''
423
424
425 Font file for font ''F'' of device
426 ''name''.
427
428
429 Note that on EBCDIC hosts, output devices __ascii__,
430 __latin1__, and __utf8__ aren't available. Similarly,
431 __cp1047__ is not available on ASCII based operating
432 systems.
433 !!EXAMPLE
434
435
436 To print the man page __foo.1__ to the standard output
437 using the latin-1 output device and __less__ as the
438 pager, the following command can be used:
439
440
441 __groff -mandoc -Tlatin1 foo.1 | less__
442
443
444 Alternatively, you can say
445
446
447 __groff -m mandoc -Tlatin1 foo.1 | less__
448 !!AUTHOR
449
450
451 James Clark
452 !!BUGS
453
454
455 Report bugs to bug-groff@gnu.org. Include a complete,
456 self-contained example that will allow the bug to be
457 reproduced, and say which version of groff you are
458 using.
459 !!COPYRIGHT
460
461
462 Copyright 1989-2000 Free Software Foundation,
463 Inc.
464
465
466 groff is free software; you can redistribute it and/or
467 modify it under the terms of the GNU General Public License
468 as published by the Free Software Foundation; either version
469 2, or (at your option) any later version.
470
471
472 groff is distributed in the hope that it will be useful, but
473 WITHOUT ANY WARRANTY; without even the implied warranty of
474 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
475 GNU General Public License for more details.
476
477
478 You should have received a copy of the GNU General Public
479 License along with groff; see the file COPYING. If not,
480 write to the Free Software Foundation, 59 Temple Place -
481 Suite 330, Boston, MA 02111-1307, USA.
482 !!AVAILABILITY
483
484
485 The most recent released version of groff is always
486 available for anonymous ftp from ftp.gnu.org in the
487 directory gnu/groff.
488
489
490 __groff__ only supports the freely available __grap__
491 implementation written by Ted Faber
492 __
493
494
495 http://www.lunabase.org/~faber/Vault/software/grap/
496 !!SEE ALSO
497
498
499 grog(1), troff(1), tbl(1),
500 pic(1), eqn(1), grn(1), grap(1),
501 soelim(1), refer(1), grops(1),
4 perry 502 grodvi(1), grotty(1), grolj4(1),
1 perry 503 grolbp(1), grohtml(1), gxditview(1),
4 perry 504 groff_font(5), __groff_out__(5),
505 groff_man(7), __groff_ms__(7), __groff_me__(7),
506 groff_char(7)
1 perry 507 ----
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.