|
Name | Synopsis | Description | Options | Details | Example | Authors | See also | COLOPHON |
|
|
|
grog(1) General Commands Manual grog(1)
grog - “groff guess”—infer a document's groff command
grog [-C] [-T device] [--run] [--warnings] [--ligatures] [groff-
option ...] [--] [file ...]
grog -h
grog --help
grog -v
grog --version
grog reads the input (file names or standard input) and guesses
which of the groff(1) options are needed to perform the input
with the groff program.
If no operands are given, or if file is “-”, chem reads the
standard input stream.
A suitable device is now always written as -Tdevice including the
groff default of -T ps.
The corresponding groff command is usually displayed in standard
output. With the option --run, the generated line is output into
standard error and the generated groff command is run on the
standard output.
-h and --help display a usage message, whereas -v and --version
display version information; all exit afterward.
-C this option means enabling the groff compatibility mode,
which is also transfered to the generated groff command
line.
--ligatures
this option forces to include the arguments -P-y -PU
within the generated groff command line.
--run with this option, the command line is output at standard
error and then run on the computer.
--warnings
with this option, some more warnings are output to
standard error.
All other specified short options (words starting with one minus
character -) are interpreted as groff options or option clusters
with or without argument. No space is allowed between options
and their argument. Except from the -marg options, all options
will be passed on, i.e. they are included unchanged in the
command for the output without effecting the work of grog.
grog reads all file parameters as a whole. It tries to guess
which of the following groff options are required for running the
input under groff: -e, -g, -G, -j, -p, -R, -s, -t
(preprocessors); and -man, -mdoc, -mdoc-old, -me, -mm, -mom, and
-ms (macro packages).
The guessed groff command including those options and the found
file parameters is put on the standard output.
It is possible to specify arbitrary groff options on the command
line. These are passed on the output without change, except for
the -marg options.
The groff program has trouble when the wrong -marg option or
several of these options are specified. In these cases, grog
will print an error message and exit with an error code. It is
better to specify no -marg option. Because such an option is
only accepted and passed when grog does not find any of these
options or the same option is found.
If several different -marg options are found by grog an error
message is produced and the program is terminated with an error
code. But the output is written with the wrong options
nevertheless.
Remember that it is not necessary to determine a macro package.
A roff file can also be written in the groff language without any
macro package. grog will produce an output without an -marg
option.
As groff also works with pure text files without any roff
requests, grog cannot be used to identify a file to be a roff
file.
Calling
grog meintro.me
results in
groff -me meintro.me
So grog recognized that the file meintro.me is written with the
-me macro package.
On the other hand,
grog pic.ms
outputs
groff -p -t -e -ms pic.ms
Besides determining the macro package -ms, grog recognized that
the file pic.ms additionally needs -pte, the combination of -p
for pic, -t for tbl, and -e for eqn.
If both of the former example files are combined by the command
grog meintro.me pic.ms
an error message is sent to standard error because groff cannot
work with two different macro packages:
grog: error: there are several macro packages: -me -ms
Additionally the corresponding output with the wrong options is
printed to standard output:
groff -pte -me -ms meintro.me pic.ms
But the program is terminated with an error code. The call of
grog -ksS -Tdvi grnexmpl.g
contains several groff options that are just passed on the output
without any interface to grog. These are the option cluster -ksS
consisting of -k, -s, and -S; and the option -T with argument
dvi. The output is
groff -k -s -S -Tdvi grnexmpl.g
so no additional option was added by grog. As no option -marg
was found by grog this file does not use a macro package.
grog was originally written by James Clark. The current Perl
implementation was written by Bernd Warken ⟨groff-bernd
.warken-72@web.de⟩ with contributions from Ralph Corderoy.
groff(1)
This page is part of the groff (GNU troff) project. Information
about the project can be found at
⟨http://www.gnu.org/software/groff/⟩. If you have a bug report
for this manual page, see ⟨http://www.gnu.org/software/groff/⟩.
This page was obtained from the project's upstream Git repository
⟨https://git.savannah.gnu.org/git/groff.git⟩ on 2020-12-18. (At
that time, the date of the most recent commit that was found in
the repository was 2020-12-09.) If you discover any rendering
problems in this HTML version of the page, or you believe there
is a better or more up-to-date source for the page, or you have
corrections or improvements to the information in this COLOPHON
(which is not part of the original manual page), send a mail to
man-pages@man7.org
groff 1.23.0.rc1.56-5346-dirt1y3 November 2020 grog(1)
Pages that refer to this page: gperl(1), gpinyin(1), groff(1), groffer(1), roff(7)
|
HTML rendering created 2020-12-21 by Michael Kerrisk, author of The Linux Programming Interface, maintainer of the Linux man-pages project. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH. |
|