Linux Blog

GROFF

Section: User Commands (1)
Updated: 3 July 2005
Index Return to Main Contents
 

NAME

groff - front-end for the groff document formatting system  

SYNOPSIS

nopsis groff  

ortOpt[] abcegilpstzCEGNRSUVXZ

 

ortOpt[] d cs

 

ortOpt[] f fam

 

ortOpt[] F dir

 

ortOpt[] I dir

 

ortOpt[] L arg

 

ortOpt[] m name

 

ortOpt[] M dir

 

ortOpt[] n num

 

ortOpt[] o list

 

ortOpt[] P arg

 

ortOpt[] r cn

 

ortOpt[] T dev

 

ortOpt[] w name

 

ortOpt[] W name

[file dSynopsis nopsis groff  

ortOpt h

| dSynopsis nopsis groff  

ortOpt v

| [option dSynopsis The command line is parsed according to the usual GNU convention. The whitespace between a command line option and its argument is optional. Options can be grouped behind a single  

ortOpt

(minus character). A filename of  

ortOpt

(minus character) denotes the standard input.  

DESCRIPTION

This document describes the groff program, the main front-end for the groff document formatting system. The groff program and macro suite is the implementation of a roff(7) system within the free software collection The groff system has all features of the classical roff, but adds many extensions. The groff program allows to control the whole groff system by command line options. This is a great simplification in comparison to the classical case (which uses pipes only).  

OPTIONS

As groff is a wrapper program for troff both programs share a set of options. But the groff program has some additional, native options and gives a new meaning to some troff options. On the other hand, not all troff options can be fed into groff.  

Native groff Options

The following options either do not exist for troff or are differently interpreted by groff. [tDef e] Preprocess with eqn. [tDef g] Preprocess with grn. [tDef G] Preprocess with grap. [tDef h help] Print a help message. [tDef I dir] This option may be used to specify a directory to search for files (both those on the command line and those named in .psbb and .so requests, and \X'ps: import' and \X'ps: file' escapes). The current directory is always searched first. This option may be specified more than once; the directories will be searched in the order specified. No directory search is performed for files specified using an absolute path. This option implies the  

ortOpt s

option. [tDef l] Send the output to a spooler program for printing. The command that should be used for this is specified by the