GROFF

NAME
SYNOPSIS
DESCRIPTION
OPTIONS
ENVIRONMENT
FILES
SEE ALSO

NAME

groff - front end for the groff document formatting system

SYNOPSIS

groff [ -tpeszaivhblCENRVZ ] [ -wname ] [ -Wname ] [ -Hfile ] [ -mname ] [ -Fdir ] [ -Tdev ] [ -ffam ] [ -Mdir ] [ -dcs ] [ -rcn ] [ -nnum ] [ -olist ] [ -Parg ] [ files... ]

DESCRIPTION

groff is a front-end to the groff document formatting systems. Normally it runs the gtroff 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 75 dpi X11 previewer
	X100		For a 100dpi X11 previewer
	Xps		For X11 previewer used with intermediate output for ps device.
	ascii		For typewriter-like devices

latin1

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

The default device is ps. It can optionally preprocess with any of gpic, geqn, gtbl, grefer, or gsoelim. It will also load any macros and eqn definitions required for a particular device. It can also spool the resulting output.

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

OPTIONS

	-h		Print a help message.
	-e		Preprocess with geqn.
	-t		Preprocess with gtbl.
	-p		Preprocess with gpic.
	-s		Preprocess with gsoelim.
	-R		Preprocess with grefer. No mechanism is provided for passing arguments to grefer because most grefer options have equivalent commands which can be included in the file. See grefer(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 gtroff. Only error messages will be printed.
	-Z		Do not postprocess the output of gtroff. Normally groff will automatically run the appropriate postprocessor.
	-Parg		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		Spool the output.
	-Larg		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.
	-Tdev		Prepare output for device dev. The default device is ps.
	-N		Don’t allow newlines with eqn delimiters. This is the same as the -N option in geqn.
	-a
	-b
	-i
	-C
	-E

-wname
-Wname
-mname
-olist

	-dcs
	-rcn
	-Fdir
	-Mdir

-Hfile

	-ffam
	-nnum		These are as described in gtroff(1).

ENVIRONMENT

GROFF_TMAC_PATH

A colon separated list of directories in which to search for macro files.

GROFF_TYPESETTER

Default device.

GROFF_FONT_PATH

A colon separated list of directories in which to search for the devname directory.

GROFF_HYPHEN

File containing hyphenation patterns.

PATH

The search path for commands executed by groff.

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 grefer(1) commands can create temporary files.

FILES

	/usr/local/lib/groff/hyphen		Hyphenation patterns
	/usr/local/lib/groff/tmac/tmac.name		Macro file used by -mname.
	/usr/local/lib/groff/font/devname/DESC		Device description file for device name.
	/usr/local/lib/groff/font/devname/F		Font file for font F of device name.
	/usr/local/lib/groff/font/devname/eqnchar		geqn definitions for device name.