View Source: groff(1) - Waikato Linux Users Group

Edit PageHistory Diff Info LikePages
GROFF
!!!GROFF
NAME
SYNOPSIS
DESCRIPTION
OPTIONS
ENVIRONMENT
FILES
EXAMPLE
AUTHOR
BUGS
COPYRIGHT
AVAILABILITY
SEE ALSO
----
!!NAME


groff - front end for the groff document formatting system
!!SYNOPSIS


__groff__ [[ __-abeghilpstvzCEGNRSUVXZ__ ] [[
__-w__''name'' ] [[ __-W__''name'' ] [[
__-m__''name'' ] [[ __-F__''dir'' ] [[
__-I__''dir'' ] [[ __-T__''dev'' ] [[
__-f__''fam'' ] [[ __-M__''dir'' ] [[
__-d__''cs'' ] [[ __-r__''cn'' ] [[
__-n__''num'' ] [[ __-o__''list'' ] [[
__-P__''arg'' ] [[ __-L__''arg'' ] [[
''files...'' ]


It is possible to have whitespace between a command line
option and its parameter.
!!DESCRIPTION


__groff__ is a front-end to the groff document formatting
system. Normally it runs the __troff__ program and a
postprocessor appropriate for the selected device. Available
devices are:


__ps__


For !PostScript printers and previewers


__dvi__


For TeX dvi format.


__X75__


For a 75dpi X11 previewer.


__X100__


For a 100dpi X11 previewer.


__ascii__


For typewriter-like devices.


__ascii8__


For typewriter-like devices. Unlike __ascii__, this
device is 8 bit clean. This device is intended to be used
for codesets other than ASCII and ISO-8859-1.


__latin1__


For typewriter-like devices using the ISO Latin-1 (ISO
8859-1) character set.


__utf8__


For typewriter-like devices using the Unicode (ISO 10646)
character set with UTF-8 encoding.


__cp1047__


For typewriter-like devices which use the EBCDIC code page
IBM cp1047 (e.g. OS/390 Unix).


__nippon__


For typewriter-like devices using the Japanese-EUC character
set.


__lj4__


For an HP LaserJet4-compatible (or other PCL5-compatible)
printer.


__lbp__


For Canon CAPSL printers (LBP-4 and LBP-8 series laser
printers).


__html__


To produce HTML output.


The postprocessor to be used for a device is specified by
the __postpro__ command in the device description file.
This can be overridden with the __-X__
option.


The default device is __ps__. It can optionally
preprocess with any of __pic__, __eqn__, __grn__,
__grap__, __tbl__, __refer__, or
__soelim.__


Options without an argument can be grouped behind a single
__-__. A filename of __-__ denotes the standard
input.


The __grog__ command can be used to guess the correct
groff command to use to format a file.
!!OPTIONS


__-h__


Print a help message.


__-e__


Preprocess with eqn.


__-t__


Preprocess with tbl.


__-g__


Preprocess with grn.


__-G__


Preprocess with grap.


__-p__


Preprocess with pic.


__-s__


Preprocess with soelim.


__-I__''dir''


This option is as described in soelim(1). This option
implies the __-s__ option.


__-R__


Preprocess with refer. No mechanism is provided for passing
arguments to __refer__ because most refer options have
equivalent commands which can be included in the file. See
refer(1) for more details.


__-v__


Make programs run by __groff__ print out their version
number.


__-V__


Print the pipeline on stdout instead of executing
it.


__-z__


Suppress output from __troff__. Only error messages will
be printed.


__-Z__


Do not postprocess the output of __troff__. Normally
__groff__ will automatically run the appropriate
postprocessor.


__-P__''arg''


Pass ''arg'' to the postprocessor. Each argument should
be passed with a separate __-P__ option. Note that
__groff__ does not prepend __-__ to ''arg'' before
passing it to the postprocessor.


__-l__


Send the output to a spooler for printing. The command used
for this is specified by the __print__ command in the
device description file (if not present, __-l__ has no
effect).


__-L__''arg''


Pass ''arg'' to the spooler. Each argument should be
passed with a separate __-L__ option. Note that
__groff__ does not prepend __-__ to ''arg'' before
passing it to the postprocessor. If there is no __print__
command in the device description file, __-L__ is
ignored.


__-T__''dev''


Prepare output for device ''dev''. The default device is
__ps__.


__-X__


Preview with __gxditview__ instead of using the usual
postprocessor. __Groff__ passes __gxditview__ a
__-printCommand__ option which will make the __Print__
action do what __groff__ would have done if the __-l__
option had been given. This is unlikely to produce good
results except with __-Tps__.


__-N__


Don't allow newlines with eqn delimiters. This is the same
as the __-N__ option in __eqn__.


__-S__


Safer mode. Pass the __-S__ option to __pic__ and
disable the following __troff__ requests: __.open__,
__.opena__, __.pso__, __.sy__, and __.pi__. For
security reasons, safer mode is enabled by
default.


__-U__


Unsafe mode. Reverts to the old unsafe
behaviour.


__-a__


__-b__


__-i__


__-C__


__-E__


__-w__''name''


__-W__''name''


__-m__''name''


__-o__''list''


__-d__''cs''


__-r__''cn''


__-F__''dir''


__-M__''dir''


__-f__''fam''


__-n__''num''


These are as described in
troff(1)__.__
!!ENVIRONMENT


__GROFF_COMMAND_PREFIX__


If this is set ''X'', then __groff__ will run
''X''__troff__ instead of __troff__. This also
applies to __tbl__, __pic__, __eqn__, __grn__,
__refer__, and __soelim__. It does not apply to
__grap__, __grops__, __grodvi__, __grotty__,
__grolj4__, __grohtml__, and
__gxditview__.


__GROFF_TMAC_PATH__


A colon separated list of directories in which to search for
macro files in addition to the default directories. See
troff(1) for more details.


__GROFF_TYPESETTER__


Default device.


__GROFF_FONT_PATH__


A colon separated list of directories in which to search for
the __dev__''name'' directory in addition to the
default one. See troff(1) for more
details.


__GROFF_BIN_PATH__


This search path, followed by __PATH__, will be used for
commands executed by __groff__. If not set, `/usr/bin' is
prepended to __PATH__.


__GROFF_TMPDIR__


The directory in which temporary files will be created. If
this is not set and __TMPDIR__ is set,
temporary files will be created in that directory. Otherwise
temporary files will be created in __/tmp__. The
grops(1) and refer(1) commands can create
temporary files.
!!FILES


__/usr/share/groff/1.17.2/font/dev__''name''__/DESC__


Device description file for device ''name''.


__/usr/share/groff/1.17.2/font/dev__''name''__/__''F''


Font file for font ''F'' of device
''name''.


Note that on EBCDIC hosts, output devices __ascii__,
__latin1__, and __utf8__ aren't available. Similarly,
__cp1047__ is not available on ASCII based operating
systems.
!!EXAMPLE


To print the man page __foo.1__ to the standard output
using the latin-1 output device and __less__ as the
pager, the following command can be used:


__groff -mandoc -Tlatin1 foo.1 | less__


Alternatively, you can say


__groff -m mandoc -Tlatin1 foo.1 | less__
!!AUTHOR


James Clark
!!BUGS


Report bugs to bug-groff@gnu.org. Include a complete,
self-contained example that will allow the bug to be
reproduced, and say which version of groff you are
using.
!!COPYRIGHT


Copyright 1989-2000 Free Software Foundation,
Inc.


groff is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version
2, or (at your option) any later version.


groff is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.


You should have received a copy of the GNU General Public
License along with groff; see the file COPYING. If not,
write to the Free Software Foundation, 59 Temple Place -
Suite 330, Boston, MA 02111-1307, USA.
!!AVAILABILITY


The most recent released version of groff is always
available for anonymous ftp from ftp.gnu.org in the
directory gnu/groff.


__groff__ only supports the freely available __grap__
implementation written by Ted Faber
__


http://www.lunabase.org/~faber/Vault/software/grap/
!!SEE ALSO


grog(1), troff(1), tbl(1),
pic(1), eqn(1), grn(1), grap(1),
soelim(1), refer(1), grops(1),
grodvi(1), grotty(1), grolj4(1),
grolbp(1), grohtml(1), gxditview(1),
groff_font(5), __groff_out__(5),
groff_man(7), __groff_ms__(7), __groff_me__(7),
groff_char(7)
----
36 pages link to groff(1):
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.
Last edited on Tuesday, June 4, 2002 12:22:07 am by "perry"
Edit PageHistory Diff Info LikePages