1 .TH GROG @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
3 grog \(em guess options for a following groff command
4 .\" The .SH was moved to this place in order to appease `apropos'.
6 .\" grog.man -> grog.1 - man page for grog (section 1)
7 .\" Source file position: <groff_source_top>/src/roff/grog/grog.man
8 .\" Installed position: <prefix>/share/man/man1/grog.1
10 .\" --------------------------------------------------------------------
12 .\" --------------------------------------------------------------------
15 Copyright \[co] 1989-2014 Free Software Foundation, Inc.
17 This file is part of grog, which is part of groff, a free software
18 project. You can redistribute it and/or modify it under the terms of
19 the GNU General Public License version 2 (GPL2) as published by the
20 Free Software Foundation.
22 groff is distributed in the hope that it will be useful, but WITHOUT
23 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
24 FITNESS FOR A PARTICULAR PURPOSE.
26 The text for GPL2 is available in the internet at
27 .UR http://\:www.gnu.org/\:licenses/\:gpl-2.0.txt
33 Written by James Clark.
40 Rewritten and put under GPL by
41 .MT groff-bernd.warken-72@web.de
46 .\" --------------------------------------------------------------------
48 .\" --------------------------------------------------------------------
51 .ie t .ds EL \fS\N'188'\fP
52 .el .ds EL \&.\|.\|.\&\
58 .\" used in `.IP \*(BU 2m' (former .Topic)
61 .\" --------------------------------------------------------------------
63 .\" --------------------------------------------------------------------
70 .OP \& "\%groff\-option \*(EL"
72 .OP \& "\%filespec \*(EL"
75 .BR "grog \-h " | " \-\-help"
77 .BR "grog \-v " | " \-\-version"
80 .\" --------------------------------------------------------------------
82 .\" --------------------------------------------------------------------
85 reads the input (file names or standard input) and guesses which of
88 options are needed to perform the input with the
97 command is usually displayed in standard output.
101 the generated line is output into standard error and the generated
103 command is run on the
104 .IR "standard output" .
108 .\" --------------------------------------------------------------------
110 .\" --------------------------------------------------------------------
116 prints information on the version number.
122 prints usage information.
124 Both of these options automatically end the
128 Other options are thenignored, and no
130 command line is generated.
133 The following 3 options are the only
139 this option means enabling the
141 compatibility mode, which is also transfered to the generated
147 this option forces to include the arguments
155 with this option, the command line is output at standard error and
156 then run on the computer.
160 with this option, some more warnings are output to standard error.
164 All other specified short options (words starting with one minus
169 options or option clusters with or without argument.
171 No space is allowed between options and their argument.
175 options, all options will be passed on, i.e.\& they are included
176 unchanged in the command for the output without effecting the work of
183 argument can either be the name of an existing file or a single minus
185 to mean standard input.
189 is specified standard input is read automatically.
192 .\" --------------------------------------------------------------------
194 .\" --------------------------------------------------------------------
199 parameters as a whole.
201 It tries to guess which of the following
203 options are required for running the input under
227 command including those options and the found
229 parameters is put on the standard output.
233 It is possible to specify arbitrary
235 options on the command line.
237 These are passed on the output without change, except for the
245 program has trouble when the wrong
247 option or several of these options are specified.
251 will print an error message and exit with an error code.
253 It is better to specify no
257 Because such an option is only accepted and passed when
259 does not find any of these options or the same option is found.
267 an error message is produced and the program is terminated with an
270 But the output is written with the wrong options nevertheless.
274 Remember that it is not necessary to determine a macro package.
278 file can also be written in the
280 language without any macro package.
283 will produce an output without an
291 also works with pure text files without any
295 cannot be used to identify a file to be a
302 .BR groffer (@MAN1EXT@)
303 program heavily depends on a working
310 source contains two files written in different programming languages:
321 is a shell script using
325 it is determined whether the system contains a suitable version of
340 .\" --------------------------------------------------------------------
342 .\" --------------------------------------------------------------------
357 groff \-me meintro.me
364 recognized that the file
387 groff \-p \-t \-e \-ms pic.ms
392 Besides determining the macro package
395 recognized that the file
414 If both of the former example files are combined by the command
419 grog meintro.me pic.ms
424 an error message is sent to standard error because
426 cannot work with two different macro packages:
431 grog: error: there are several macro packages: \-me \-ms
436 Additionally the corresponding output with the wrong options is printed
442 groff \-pte \-me \-ms meintro.me pic.ms
447 But the program is terminated with an error code.
456 grog \-ksS \-Tdvi grnexmpl.g
463 options that are just passed on the output without any interface to
465 These are the option cluster
481 groff \-k \-s \-S \-Tdvi grnexmpl.g
486 so no additional option was added by
492 this file does not use a macro package.
495 .\" --------------------------------------------------------------------
497 .\" --------------------------------------------------------------------
501 .BR groff (@MAN1EXT@),
502 .BR groffer (@MAN1EXT@)
503 .BR @g@troff (@MAN1EXT@),
504 .BR @g@tbl (@MAN1EXT@),
505 .BR @g@pic (@MAN1EXT@),
506 .BR @g@chem (@MAN1EXT@),
507 .BR @g@eqn (@MAN1EXT@),
508 .BR @g@refer (@MAN1EXT@),
509 .BR @g@grn (@MAN1EXT@),
511 .BR @g@soelim (@MAN1EXT@)
514 Man-pages of section 1 can be viewed with either
524 for graphical mode (default is PDF mode).
529 .BR groff_me (@MAN7EXT@),
530 .BR groff_ms (@MAN7EXT@),
531 .BR groff_mm (@MAN7EXT@),
532 .BR groff_mom (@MAN7EXT@),
533 .BR groff_man (@MAN7EXT@)
536 Man-pages of section 7 can be viewed with either with
544 .BI "groffer 7 " name
546 for graphical mode (default is PDF mode).
550 .\" --------------------------------------------------------------------
552 .\" --------------------------------------------------------------------
554 .\" --------------------------------------------------------------------
556 .\" --------------------------------------------------------------------
560 .\" --------------------------------------------------------------------
562 .\" --------------------------------------------------------------------