01.12.2012 Views

by Trent A. Fisher and Werner Lemberg - The GNU Operating System

by Trent A. Fisher and Werner Lemberg - The GNU Operating System

by Trent A. Fisher and Werner Lemberg - The GNU Operating System

SHOW MORE
SHOW LESS

Create successful ePaper yourself

Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.

24 <strong>The</strong> <strong>GNU</strong> Troff Manual<br />

otherwise. For nroff, this value should always be an integer<br />

multiple of unit ‘n’ to get consistent indentation.<br />

-rLL=length<br />

Set line length to length. If not specified, the line length is set<br />

to respect any value set <strong>by</strong> a prior ‘ll’ request (which must be<br />

in effect when the ‘TH’ macro is invoked), if this differs from the<br />

built-in default for the formatter; otherwise it defaults to 78 n<br />

in nroff mode (this is 78 characters per line) <strong>and</strong> 6.5 i in troff<br />

mode. 1<br />

-rLT=length<br />

Set title length to length. If not specified, the title length defaults<br />

to the line length.<br />

-rPnnn Page numbering starts with nnn rather than with 1.<br />

-rSxx Use xx (which can be 10, 11, or 12 pt) as the base document<br />

font size instead of the default value of 10 pt.<br />

-rSN=length<br />

Set the indentation for sub-subheadings to length. If not specified,<br />

the indentation defaults to 3 n.<br />

-rXnnn After page nnn, number pages as nnna, nnnb, nnnc, etc. For<br />

example, the option ‘-rX2’ produces the following page numbers:<br />

1, 2, 2a, 2b, 2c, etc.<br />

4.1.2 Usage<br />

This section describes the available macros for manual pages. For further<br />

customization, put additional macros <strong>and</strong> requests into the file ‘man.local’<br />

which is loaded immediately after the ‘man’ package.<br />

.TH title section [extra1 [extra2 [extra3]]]<br />

[Macro]<br />

Set the title of the man page to title <strong>and</strong> the section to section, which<br />

must have a value between 1 <strong>and</strong> 8. <strong>The</strong> value of section may also have<br />

a string appended, e.g. ‘.pm’, to indicate a specific subsection of the man<br />

pages.<br />

Both title <strong>and</strong> section are positioned at the left <strong>and</strong> right in the header<br />

line (with section in parentheses immediately appended to title. extra1<br />

1 Note that the use of a ‘.ll length’ request to initialize the line length, prior to use<br />

of the ‘TH’ macro, is supported for backward compatibility with some versions of the<br />

man program. Always use the ‘-rLL=length’ option, or an equivalent ‘.nr LL length’<br />

request, in preference to such a ‘.ll length’ request. In particular, note that in nroff<br />

mode, the request ‘.ll 65n’, (with any length expression which evaluates equal to 65 n,<br />

i.e., the formatter’s default line length in nroff mode), does not set the line length to<br />

65 n (it is adjusted to the man macro package’s default setting of 78 n), whereas the<br />

use of the ‘-rLL=65n’ option, or the ‘.nr LL 65n’ request does establish a line length<br />

of 65 n.

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!