groff/groff.man

   1 .\" -*- nroff -*-
   2 .de TQ
   3 .br
   4 .ns
   5 .TP \\$1
   6 ..
   7 .\" Like TP, but if specified indent is more than half
   8 .\" the current line-length - indent, use the default indent.
   9 .de Tp
  10 .ie \\n(.$=0:((0\\$1)*2u>(\\n(.lu-\\n(.iu)) .TP
  11 .el .TP "\\$1"
  12 ..
  13 .TH GROFF @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
  14 .SH NAME
  15 groff \- front end for the groff document formatting system
  16 .SH SYNOPSIS
  17 .B groff
  18 [
  19 .B \-tpeszaivhblCENRVXZ
  20 ]
  21 [
  22 .BI \-w name
  23 ]
  24 [
  25 .BI \-W name
  26 ]
  27 [
  28 .BI \-H file
  29 ]
  30 [
  31 .BI \-m name
  32 ]
  33 [
  34 .BI \-F dir
  35 ]
  36 [
  37 .BI \-T dev
  38 ]
  39 [
  40 .BI \-f fam
  41 ]
  42 [
  43 .BI \-M dir
  44 ]
  45 [
  46 .BI \-d cs
  47 ]
  48 [
  49 .BI \-r cn
  50 ]
  51 [
  52 .BI \-n num
  53 ]
  54 [
  55 .BI \-o list
  56 ]
  57 [
  58 .BI \-P arg
  59 ]
  60 [
  61 .IR files \|.\|.\|.\|
  62 ]
  63 .SH DESCRIPTION
  64 .B groff
  65 is a front-end to the groff document formatting system.
  66 Normally it runs the
  67 .B @g@troff
  68 program and a postprocessor appropriate for the selected
  69 device.
  70 Available devices are:
  71 .TP
  72 .B ps
  73 For PostScript printers and previewers
  74 .TP
  75 .B dvi
  76 For TeX dvi format
  77 .TP
  78 .B X75
  79 For a 75 dpi X11 previewer
  80 .TP
  81 .B X100
  82 For a 100dpi X11 previewer
  83 .TP
  84 .B ascii
  85 For typewriter-like devices
  86 .TP
  87 .B latin1
  88 For typewriter-like devices using the ISO Latin-1 character set.
  89 .LP
  90 The postprocessor to be used for a device is specified by the
  91 .B postpro
  92 command in the device description file.
  93 This can be overridden with the
  94 .B \-X
  95 option.
  96 .LP
  97 The default device is
  98 .BR @DEVICE@ .
  99 It can optionally preprocess with any of
 100 .BR @g@pic ,
 101 .BR @g@eqn ,
 102 .BR @g@tbl ,
 103 .BR @g@refer ,
 104 or
 105 .B @g@soelim.
 106 .LP
 107 Options without an argument can be grouped behind a single
 108 .BR \- .
 109 A filename of
 110 .B \-
 111 denotes the standard input.
 112 .SH OPTIONS
 113 .TP
 114 .B \-h
 115 Print a help message.
 116 .TP
 117 .B \-e
 118 Preprocess with @g@eqn.
 119 .TP
 120 .B \-t
 121 Preprocess with @g@tbl.
 122 .TP
 123 .B \-p
 124 Preprocess with @g@pic.
 125 .TP
 126 .B \-s
 127 Preprocess with @g@soelim.
 128 .TP
 129 .B \-R
 130 Preprocess with @g@refer.
 131 No mechanism is provided for passing arguments to
 132 .B @g@refer
 133 because most @g@refer options have equivalent commands
 134 which can be included in the file.
 135 See
 136 .BR @g@refer (@MAN1EXT@)
 137 for more details.
 138 .TP
 139 .B \-v
 140 Make programs run by
 141 .B groff
 142 print out their version number.
 143 .TP
 144 .B \-V
 145 Print the pipeline on stdout instead of executing it.
 146 .TP
 147 .B \-z
 148 Suppress output from
 149 .BR @g@troff .
 150 Only error messages will be printed.
 151 .TP
 152 .B \-Z
 153 Do not postprocess the output of
 154 .BR @g@troff .
 155 Normally
 156 .B groff
 157 will automatically run the appropriate postprocessor.
 158 .TP
 159 .BI \-P arg
 160 Pass
 161 .I arg
 162 to the postprocessor.
 163 Each argument should be passed with a separate
 164 .B \-P
 165 option.
 166 Note that
 167 .B groff
 168 does not prepend
 169 .B \-
 170 to
 171 .I arg
 172 before passing it to the postprocessor.
 173 .TP
 174 .B \-l
 175 Send the output to a printer.
 176 The command used for this is specified by the
 177 .B print
 178 command in the device description file.
 179 .TP
 180 .BI \-L arg
 181 Pass
 182 .I arg
 183 to the spooler.
 184 Each argument should be passed with a separate
 185 .B \-L
 186 option.
 187 Note that
 188 .B groff
 189 does not prepend
 190 .B \-
 191 to
 192 .I arg
 193 before passing it to the postprocessor.
 194 .TP
 195 .BI \-T dev
 196 Prepare output for device
 197 .IR dev .
 198 The default device is
 199 .BR @DEVICE@ .
 200 .TP
 201 .B \-X
 202 Preview with
 203 .B gxditview
 204 instead of using the usual postprocessor.
 205 This is unlikely to produce good results except with
 206 .BR \-Tps .
 207 .TP
 208 .B \-N
 209 Don't allow newlines with eqn delimiters.
 210 This is the same as the
 211 .B \-N
 212 option in
 213 .BR @g@eqn .
 214 .TP
 215 .B \-a
 216 .TQ
 217 .B \-b
 218 .TQ
 219 .B \-i
 220 .TQ
 221 .B \-C
 222 .TQ
 223 .B \-E
 224 .TQ
 225 .BI \-w name
 226 .TQ
 227 .BI \-W name
 228 .TQ
 229 .BI \-m name
 230 .TQ
 231 .BI \-o list
 232 .TQ
 233 .BI \-d cs
 234 .TQ
 235 .BI \-r cn
 236 .TQ
 237 .BI \-F dir
 238 .TQ
 239 .BI \-M dir
 240 .TQ
 241 .BI \-H file
 242 .TQ
 243 .BI \-f fam
 244 .TQ
 245 .BI \-n num
 246 These are as described in
 247 .BR @g@troff (@MAN1EXT@) .
 248 .SH ENVIRONMENT
 249 .TP
 250 .SM
 251 .B GROFF_TMAC_PATH
 252 A colon separated list of directories in which to search for
 253 macro files.
 254 .TP
 255 .SM
 256 .B GROFF_TYPESETTER
 257 Default device.
 258 .TP
 259 .SM
 260 .B GROFF_FONT_PATH
 261 A colon separated list of directories in which to search for the
 262 .BI dev name
 263 directory.
 264 .TP
 265 .SM
 266 .B GROFF_HYPHEN
 267 File containing hyphenation patterns.
 268 .TP
 269 .SM
 270 .B PATH
 271 The search path for commands executed by
 272 .BR groff .
 273 .TP
 274 .SM
 275 .B GROFF_TMPDIR
 276 The directory in which temporary files will be created.
 277 If this is not set and
 278 .B
 279 .SM TMPDIR
 280 is set, temporary files will be created in that directory.
 281 Otherwise temporary files will be created in
 282 .BR /tmp .
 283 The
 284 .BR grops (@MAN1EXT@)
 285 and
 286 .BR @g@refer (@MAN1EXT@)
 287 commands can create temporary files.
 288 .SH FILES
 289 .Tp \w'\fB@FONTDIR@/dev\fIname\fB/DESC'u+3n
 290 .B @HYPHENFILE@
 291 Hyphenation patterns
 292 .TP
 293 .BI @FONTDIR@/dev name /DESC
 294 Device description file for device
 295 .IR name .
 296 .TP
 297 .BI @FONTDIR@/dev name / F
 298 Font file for font
 299 .I F
 300 of device
 301 .IR name .
 302 .SH AUTHOR
 303 James Clark <jjc@jclark.com>
 304 .SH BUGS
 305 Report bugs to bug-groff@prep.ai.mit.edu.
 306 Include a complete, self-contained example
 307 that will allow the bug to be reproduced,
 308 and say which version of groff you are using.
 309 .SH COPYRIGHT
 310 Copyright \(co 1989, 1990, 1991, 1992 Free Software Foundation, Inc.
 311 .LP
 312 groff is free software; you can redistribute it and/or modify it under
 313 the terms of the GNU General Public License as published by the Free
 314 Software Foundation; either version 2, or (at your option) any later
 315 version.
 316 .LP
 317 groff is distributed in the hope that it will be useful, but WITHOUT ANY
 318 WARRANTY; without even the implied warranty of MERCHANTABILITY or
 319 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 320 for more details.
 321 .LP
 322 You should have received a copy of the GNU General Public License along
 323 with groff; see the file COPYING.  If not, write to the Free Software
 324 Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
 325 .SH AVAILABILITY
 326 The most recent released version of groff is always available for
 327 anonymous ftp from prep.ai.mit.edu (18.71.0.38) in the directory
 328 pub/gnu.
 329 .SH "SEE ALSO"
 330 .BR grog (@MAN1EXT@),
 331 .BR @g@troff (@MAN1EXT@),
 332 .BR @g@tbl (@MAN1EXT@),
 333 .BR @g@pic (@MAN1EXT@),
 334 .BR @g@eqn (@MAN1EXT@),
 335 .BR @g@soelim (@MAN1EXT@) ,
 336 .BR @g@refer (@MAN1EXT@),
 337 .BR grops (@MAN1EXT@),
 338 .BR grodvi (@MAN1EXT@),
 339 .BR grotty (@MAN1EXT@),
 340 .BR gxditview (@MAN1EXT@),
 341 .BR groff_font (@MAN5EXT@),
 342 .BR groff_out (@MAN5EXT@),
 343 .BR groff_ms (@MAN7EXT@),
 344 .BR groff_me (@MAN7EXT@),
 345 .BR groff_char (@MAN7EXT@)