groff/groff.man

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