[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
This chapter documents the main macro packages that come with
groff
.
4.1 `man' 4.2 `mdoc' 4.3 `ms' 4.4 `me' 4.5 `mm'
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
This is the most popular and probably the most important macro package
of groff
. It is easy to use, and a vast majority of manual pages
are based on it.
4.1.1 Options 4.1.2 Usage 4.1.3 Macros to set fonts 4.1.4 Miscellaneous
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
The command line format for using the `man' macros with
groff
is:
groff -m man [ -rC1 ] [ -rD1 ] [ -rPnnn ] [ -rSxx ] [ -rXnnn ] [ files... ] |
It is possible to use `-man' instead of `-m man'.
-rC1
-rD1
-rPnnn
-rSxx
-rXnnn
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
This section describes the available macros for manual pages. For further customization, put additional macros and requests into the file `man.local' which will be loaded immediately after `tmac.an'.
Both title and section are positioned at the left and right in the header line (with section in parentheses immediately appended to title. extra1 will be positioned in the middle of the footer line. extra2 will be positioned at the left in the footer line (resp. at the left on even pages and at the right on odd pages if double-sided printing is active). extra3 is centered in the header line.
For HTML output, headers and footers are completely suppressed.
Additionally, this macro starts a new page; the new line number is 1
again (except if the `-rC1' option is given on the command line)
-- this feature is intended only for formatting multiple man pages; a
single man page should contain exactly one TH
macro at the
beginning of the file.
SH
up to the end of the line (resp.
the text in the next line if there is no argument to SH
) in bold
face, one size larger than the base document size. Additionally, the
left margin for the following text is reset to its default value.
SS
up to the end of the line (resp. the text in the
next line if there is no argument to SS
) in bold face, at the
same size as the base document size. Additionally, the left margin for
the following text is reset to its default value.
The first line of text following this macro is interpreted as a string to be printed flush-left, as it is appropriate for a label. It is not interpreted as part of a paragraph, so there is no attempt to fill the first line with text from the following input lines. Nevertheless, if the label is not as wide as the indentation, then the paragraph starts at the same line (but indented), continuing on the following lines. If the label is wider than the indentation, then the descriptive part of the paragraph begins on the line following the label, entirely indented. Note that neither font shape nor font size of the label is set to a default value; on the other hand, the rest of the text will have default font settings.
PD
macro. The font size and shape are reset to
the default value (10pt resp. Roman). Finally, the current left
margin is restored.
IP
.
For example, to start a paragraph with bullets as the designator and 4en indentation, write
.IP \(bu 4 |
RS
macro can be nested.
RS
yet) has number 1, and each call to RS
increases
the level by 1.
To summarize, the following macros cause a line break with the insertion
of vertical space (which amount can be changed with the PD
macro): SH
, SS
, TP
, LP
(PP
,
P
), IP
, and HP
.
The macros RS
and RE
also cause a break but do not insert
vertical space.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
The standard font is Roman; the default text size is 10 point.
.BI this "word and" that |
would cause "this" and "that" to appear in bold face, while "word and" appears in italics.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
The default indentation is 7.2n for all output devices except for
grohtml
which uses 1.2i instead.
TH
request, it makes sense to call it only if the tab
positions have been changed.
This affects the macros SH
, SS
, TP
, LP
(resp. PP
and P
), IP
, and HP
.
The following strings are defined:
\(lq
and \(rq
, respectively.
If a preprocessor like gtbl
or geqn
is needed, it has
become common usage to make the first line of the man page look like
this:
.\" word |
Note the single space character after the double quote. word
consists of letters for the needed preprocessors: `e' for
geqn
, `r' for grefer
, `t' for gtbl
.
Modern implementations of the man
program read this first line
and automatically call the right preprocessor(s).
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
[ << ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |