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