The following groff options set registers (with -r
) and strings
(with -d
) recognized and used by the man macro package.
-dAD=
adjustment-mode
Set line adjustment to adjustment-mode, which is typically
'b
' for adjustment to both margins (the default), or 'l
'
for left alignment (ragged right margin). Any valid
argument to groff's '.ad' request may be used. See
groff(7) for less-common choices.
-rcR=1
Continuous rendering. Do not paginate the output; produce
one (potentially very long) output page. This is the
default for terminal and HTML devices. Use -rcR=0
to
disable it.
-rC1
Number output pages continuously. If multiple man pages
are processed, number the output pages in strictly
increasing sequence, rather than resetting the page number
to 1 at each new man document.
-rCS=1
Capitalize section headings. Set section headings (the
argument(s) to .SH
) in full capitals. This transformation
is off by default because it discards case distinction
information.
-rCT=1
Capitalize titles. Set the man page title (the first
argument to .TH
) in full capitals in headers and footers.
This transformation is off by default because it discards
case distinction information.
-rD1
Enable double-sided layout. Format footers for even and
odd pages differently; see the description of .TH
in
subsection 'Document structure macros' above.
-rFT=
footer-distance
Set distance of the footer, relative to the bottom of the
page if negative or top if positive, to footer-distance.
At twice this distance, the page text is broken before
writing the footer. Ignored if continuous rendering is
enabled. The default is -0.5i.
-dHF=
heading-font
See the font used for section and subsection headings; the
default is 'B
' (bold). Any valid argument to groff's
'.ft' request may be used. See groff(7).
-rHY=
hyphenation-mode
Set hyphenation mode, as documented in section
'Hyphenation' of groff(7). Use -rHY=0
to disable
hyphenation. The default is 4 if continuous rendering is
enabled (-rcR=1
above), and 6 otherwise. Any valid
argument to groff's '.hy' request may be used.
-rIN=
standard-indent
Set the amount of indentation used for ordinary paragraphs
(.P
and its synonyms) and the default indentation amount
used by .IP
, .RS
, .TP
, and the deprecated .HP
. See
subsection 'Horizontal and vertical spacing' above for the
default. For terminal devices, standard-indent should
always be an integer multiple of unit 'n' to get
consistent indentation.
-rLL=
line-length
Set line length; the default is 78n for terminal devices
and 6.5i for typesetter devices.
-rLT=
title-length
Set the line length for titles. ('Titles' is the roff
term for headers and footers.) By default, the line
length (see -rLL
above) is used for the title length.
-rP
n Start enumeration of pages at n rather than 1.
-rS
point-size
Use point-size as the base point size; acceptable values
are 10, 11, or 12. See subsection 'Font style macros'
above for the default.
-rSN=
subsection-indent
Set indentation of subsection headings to subsection-
indent. See subsection 'Horizontal and vertical spacing'
above for the default.
-rX
p After page p, number pages as pa, pb, pc, and so forth.
The register tracking the suffixed page letter uses format
'a' (see the '.af' request in groff(7)). For example, the
option -rX2
produces the following page numbers: 1, 2, 2a,
2b, ..., 2aa, 2ab, and so on.