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