BSD 4_4 development
[unix-history] / usr / share / man / cat1 / groff.0
GROFF(1) BSD Reference Manual GROFF(1)
N\bNA\bAM\bME\bE
groff - front end for the groff document formatting system
S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
g\bgr\bro\bof\bff\bf [ -\b-t\btp\bpe\bes\bsz\bza\bai\biv\bvh\bhb\bbl\blC\bCE\bEN\bNR\bRV\bVX\bXZ\bZ ] [ -\b-w\bw_\bn_\ba_\bm_\be ] [ -\b-W\bW_\bn_\ba_\bm_\be ] [
-\b-m\bm_\bn_\ba_\bm_\be ] [ -\b-F\bF_\bd_\bi_\br ] [ -\b-T\bT_\bd_\be_\bv ] [ -\b-f\bf_\bf_\ba_\bm ] [ -\b-M\bM_\bd_\bi_\br ] [ -\b-d\bd_\bc_\bs ]
[ -\b-r\br_\bc_\bn ] [ -\b-n\bn_\bn_\bu_\bm ] [ -\b-o\bo_\bl_\bi_\bs_\bt ] [ -\b-P\bP_\ba_\br_\bg ] [ _\bf_\bi_\bl_\be_\bs... ]
D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
g\bgr\bro\bof\bff\bf is a front-end to the groff document formatting sys-
tem. Normally it runs the t\btr\bro\bof\bff\bf program and a postproces-
sor appropriate for the selected device. Available
devices are:
p\bps\bs For PostScript printers and previewers
d\bdv\bvi\bi For TeX dvi format
X\bX7\b75\b5 For a 75 dpi X11 previewer
X\bX1\b10\b00\b0 For a 100dpi X11 previewer
a\bas\bsc\bci\bii\bi For typewriter-like devices
l\bla\bat\bti\bin\bn1\b1 For typewriter-like devices using the ISO Latin-1
character set.
The postprocessor to be used for a device is specified by
the p\bpo\bos\bst\btp\bpr\bro\bo command in the device description file. This
can be overridden with the -\b-X\bX option.
The default device is p\bps\bs. It can optionally preprocess
with any of p\bpi\bic\bc, e\beq\bqn\bn, t\btb\bbl\bl, r\bre\bef\bfe\ber\br, or s\bso\boe\bel\bli\bim\bm.\b.
Options without an argument can be grouped behind a single
-\b-. A filename of -\b- denotes the standard input.
The g\bgr\bro\bog\bg command can be used to guess the correct groff
command to use to format a file.
O\bOP\bPT\bTI\bIO\bON\bNS\bS
-\b-h\bh Print a help message.
-\b-e\be Preprocess with eqn.
-\b-t\bt Preprocess with tbl.
-\b-p\bp Preprocess with pic.
-\b-s\bs Preprocess with soelim.
Groff Version 1.08 29 October 1992 1
GROFF(1) BSD Reference Manual GROFF(1)
-\b-R\bR Preprocess with refer. No mechanism is provided
for passing arguments to r\bre\bef\bfe\ber\br because most refer
options have equivalent commands which can be
included in the file. See r\bre\bef\bfe\ber\br(1) for more
details.
-\b-v\bv Make programs run by g\bgr\bro\bof\bff\bf print out their version
number.
-\b-V\bV Print the pipeline on stdout instead of executing
it.
-\b-z\bz Suppress output from t\btr\bro\bof\bff\bf. Only error messages
will be printed.
-\b-Z\bZ Do not postprocess the output of t\btr\bro\bof\bff\bf. Normally
g\bgr\bro\bof\bff\bf will automatically run the appropriate post-
processor.
-\b-P\bP_\ba_\br_\bg Pass _\ba_\br_\bg to the postprocessor. Each argument
should be passed with a separate -\b-P\bP option. Note
that g\bgr\bro\bof\bff\bf does not prepend -\b- to _\ba_\br_\bg before passing
it to the postprocessor.
-\b-l\bl Send the output to a printer. The command used for
this is specified by the p\bpr\bri\bin\bnt\bt command in the
device description file.
-\b-L\bL_\ba_\br_\bg Pass _\ba_\br_\bg to the spooler. Each argument should be
passed with a separate -\b-L\bL option. Note that g\bgr\bro\bof\bff\bf
does not prepend -\b- to _\ba_\br_\bg before passing it to the
postprocessor.
-\b-T\bT_\bd_\be_\bv Prepare output for device _\bd_\be_\bv. The default device
is p\bps\bs.
-\b-X\bX Preview with g\bgx\bxd\bdi\bit\btv\bvi\bie\bew\bw instead of using the usual
postprocessor. This is unlikely to produce good
results except with -\b-T\bTp\bps\bs.
-\b-N\bN Don't allow newlines with eqn delimiters. This is
the same as the -\b-N\bN option in e\beq\bqn\bn.
-\b-a\ba
-\b-b\bb
-\b-i\bi
-\b-C\bC
-\b-E\bE
-\b-w\bw_\bn_\ba_\bm_\be
-\b-W\bW_\bn_\ba_\bm_\be
-\b-m\bm_\bn_\ba_\bm_\be
Groff Version 1.08 29 October 1992 2
GROFF(1) BSD Reference Manual GROFF(1)
-\b-o\bo_\bl_\bi_\bs_\bt
-\b-d\bd_\bc_\bs
-\b-r\br_\bc_\bn
-\b-F\bF_\bd_\bi_\br
-\b-M\bM_\bd_\bi_\br
-\b-f\bf_\bf_\ba_\bm
-\b-n\bn_\bn_\bu_\bm These are as described in t\btr\bro\bof\bff\bf(1).\b.
E\bEN\bNV\bVI\bIR\bRO\bON\bNM\bME\bEN\bNT\bT
G\bGR\bRO\bOF\bFF\bF_\b_C\bCO\bOM\bMM\bMA\bAN\bND\bD_\b_P\bPR\bRE\bEF\bFI\bIX\bX
If this is set _\bX, then g\bgr\bro\bof\bff\bf will run _\bXt\btr\bro\bof\bff\bf
instead of t\btr\bro\bof\bff\bf. This also applies to t\btb\bbl\bl, p\bpi\bic\bc,
e\beq\bqn\bn, r\bre\bef\bfe\ber\br and s\bso\boe\bel\bli\bim\bm. It does not apply to g\bgr\bro\bop\bps\bs,
g\bgr\bro\bod\bdv\bvi\bi, g\bgr\bro\bot\btt\bty\by and g\bgx\bxd\bdi\bit\btv\bvi\bie\bew\bw.
G\bGR\bRO\bOF\bFF\bF_\b_T\bTM\bMA\bAC\bC_\b_P\bPA\bAT\bTH\bH
A colon separated list of directories in which to
search for macro files.
G\bGR\bRO\bOF\bFF\bF_\b_T\bTY\bYP\bPE\bES\bSE\bET\bTT\bTE\bER\bR
Default device.
G\bGR\bRO\bOF\bFF\bF_\b_F\bFO\bON\bNT\bT_\b_P\bPA\bAT\bTH\bH
A colon separated list of directories in which to
search for the d\bde\bev\bv_\bn_\ba_\bm_\be directory.
P\bPA\bAT\bTH\bH The search path for commands executed by g\bgr\bro\bof\bff\bf.
G\bGR\bRO\bOF\bFF\bF_\b_T\bTM\bMP\bPD\bDI\bIR\bR
The directory in which temporary files will be cre-
ated. If this is not set and T\bTM\bMP\bPD\bDI\bIR\bR is set, tempo-
rary files will be created in that directory. Oth-
erwise temporary files will be created in /\b/t\btm\bmp\bp.
The g\bgr\bro\bop\bps\bs(1) and r\bre\bef\bfe\ber\br(1) commands can create tem-
porary files.
F\bFI\bIL\bLE\bES\bS
/\b/u\bus\bsr\br/\b/s\bsh\bha\bar\bre\be/\b/g\bgr\bro\bof\bff\bf_\b_f\bfo\bon\bnt\bt/\b/d\bde\bev\bv_\bn_\ba_\bm_\be/\b/D\bDE\bES\bSC\bC
Device description file for device _\bn_\ba_\bm_\be.
/\b/u\bus\bsr\br/\b/s\bsh\bha\bar\bre\be/\b/g\bgr\bro\bof\bff\bf_\b_f\bfo\bon\bnt\bt/\b/d\bde\bev\bv_\bn_\ba_\bm_\be/\b/_\bF
Font file for font _\bF of device _\bn_\ba_\bm_\be.
A\bAU\bUT\bTH\bHO\bOR\bR
James Clark <jjc@jclark.com>
B\bBU\bUG\bGS\bS
Report bugs to bug-groff@prep.ai.mit.edu. Include a com-
plete, self-contained example that will allow the bug to
be reproduced, and say which version of groff you are
using.
Groff Version 1.08 29 October 1992 3
GROFF(1) BSD Reference Manual GROFF(1)
C\bCO\bOP\bPY\bYR\bRI\bIG\bGH\bHT\bT
Copyright (C) 1989, 1990, 1991, 1992 Free Software Founda-
tion, 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 war-
ranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PUR-
POSE. 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, 675 Mass Ave, Cam-
bridge, MA 02139, USA.
A\bAV\bVA\bAI\bIL\bLA\bAB\bBI\bIL\bLI\bIT\bTY\bY
The most recent released version of groff is always avail-
able for anonymous ftp from prep.ai.mit.edu (18.71.0.38)
in the directory pub/gnu.
S\bSE\bEE\bE A\bAL\bLS\bSO\bO
g\bgr\bro\bog\bg(1), t\btr\bro\bof\bff\bf(1), t\btb\bbl\bl(1), p\bpi\bic\bc(1), e\beq\bqn\bn(1), s\bso\boe\bel\bli\bim\bm(1),\b,
r\bre\bef\bfe\ber\br(1), g\bgr\bro\bop\bps\bs(1), g\bgr\bro\bod\bdv\bvi\bi(1), g\bgr\bro\bot\btt\bty\by(1), g\bgx\bxd\bdi\bit\btv\bvi\bie\bew\bw(1),
g\bgr\bro\bof\bff\bf_\b_f\bfo\bon\bnt\bt(5), g\bgr\bro\bof\bff\bf_\b_o\bou\but\bt(5), g\bgr\bro\bof\bff\bf_\b_m\bms\bs(7), g\bgr\bro\bof\bff\bf_\b_m\bme\be(7),
g\bgr\bro\bof\bff\bf_\b_c\bch\bha\bar\br(7)
Groff Version 1.08 29 October 1992 4