version 1.71, 2010/05/15 07:01:51 |
version 1.106, 2011/08/19 13:07:22 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" |
.\" |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" purpose with or without fee is hereby granted, provided that the above |
.\" purpose with or without fee is hereby granted, provided that the above |
|
|
.Xr mdoc 7 |
.Xr mdoc 7 |
language, instead. |
language, instead. |
.Pp |
.Pp |
An |
A |
.Nm |
.Nm |
document follows simple rules: lines beginning with the control |
document follows simple rules: lines beginning with the control |
character |
character |
.Sq \&. |
.Sq \&. |
are parsed for macros. |
are parsed for macros. |
Other lines are interpreted within the scope of |
Lines not beginning with the control character are |
prior macros: |
interpreted within the scope of prior macros: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.SH Macro lines change control state. |
\&.SH Macro lines change control state. |
Other lines are interpreted within the current state. |
Text lines are interpreted within the current state. |
.Ed |
.Ed |
.Sh INPUT ENCODING |
.Sh LANGUAGE SYNTAX |
.Nm |
.Nm |
documents may contain only graphable 7-bit ASCII characters, the |
documents may contain only graphable 7-bit ASCII characters, the |
space character, and the tabs character. |
space character, and the tab character. |
All manuals must have |
The back-space character |
.Ux |
.Sq \e |
line termination. |
indicates the start of an escape sequence for |
.Pp |
.Sx Comments , |
Blank lines are acceptable; where found, the output will assert a |
.Sx Predefined Strings , |
vertical space. |
and |
|
.Sx Special Characters . |
.Ss Comments |
.Ss Comments |
Text following a |
Text following an escaped double-quote |
.Sq \e\*" , |
.Sq \e\(dq , |
whether in a macro or free-form text line, is ignored to the end of |
whether in a macro or text line, is ignored to the end of |
line. |
line. |
A macro line with only a control character and comment escape, |
A macro line beginning with a control character and comment escape |
.Sq \&.\e" , |
.Sq \&.\e\(dq |
is also ignored. |
is also ignored. |
Macro lines with only a control character and optionally whitespace are |
Furthermore, |
|
macro lines with only a control character and optional trailing |
|
whitespace are |
stripped from input. |
stripped from input. |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent -compact |
|
\&.\e\(dq This is a comment line. |
|
\&.\e\(dq The next line is ignored: |
|
\&. |
|
\&.Em Emphasis \e\(dq This is also a comment. |
|
.Ed |
.Ss Special Characters |
.Ss Special Characters |
Special characters may occur in both macro and free-form lines. |
Special characters are used to encode special glyphs and are rendered |
|
differently across output media. |
|
They may occur in both macro and text lines. |
Sequences begin with the escape character |
Sequences begin with the escape character |
.Sq \e |
.Sq \e |
followed by either an open-parenthesis |
followed by either an open-parenthesis |
Line 79 for two-character sequences; an open-bracket |
|
Line 92 for two-character sequences; an open-bracket |
|
.Sq \&[ |
.Sq \&[ |
for n-character sequences (terminated at a close-bracket |
for n-character sequences (terminated at a close-bracket |
.Sq \&] ) ; |
.Sq \&] ) ; |
or a single one-character sequence. |
or a single one character sequence. |
|
.Pp |
|
Examples: |
|
.Bl -tag -width Ds -offset indent -compact |
|
.It Li \e(em |
|
Two-letter em dash escape. |
|
.It Li \ee |
|
One-letter backslash escape. |
|
.El |
|
.Pp |
See |
See |
.Xr mandoc_char 7 |
.Xr mandoc_char 7 |
for a complete list. |
for a complete list. |
Examples include |
|
.Sq \e(em |
|
.Pq em-dash |
|
and |
|
.Sq \ee |
|
.Pq back-slash . |
|
.Ss Text Decoration |
.Ss Text Decoration |
Terms may be text-decorated using the |
Terms may be text-decorated using the |
.Sq \ef |
.Sq \ef |
escape followed by an indicator: B (bold), I, (italic), R (Roman), or P |
escape followed by an indicator: B (bold), I (italic), R (regular), or P |
(revert to previous mode): |
(revert to previous mode). |
.Pp |
A numerical representation 3, 2, or 1 (bold, italic, and regular, |
.D1 \efBbold\efR \efIitalic\efP |
|
.Pp |
|
A numerical representation 3, 2, or 1 (bold, italic, and Roman, |
|
respectively) may be used instead. |
respectively) may be used instead. |
A text decoration is only valid, if specified in free-form text, until |
A text decoration is only valid, if specified in free-form text, until |
the next macro invocation; if specified within a macro, it's only valid |
the next macro invocation; if specified within a macro, it's only valid |
Line 106 Note that macros like |
|
Line 119 Note that macros like |
|
.Sx \&BR |
.Sx \&BR |
open and close a font scope with each argument. |
open and close a font scope with each argument. |
.Pp |
.Pp |
Text may also be sized with the |
The |
.Sq \es |
.Sq \ef |
escape, whose syntax is one of |
attribute is forgotten when entering or exiting a macro block. |
.Sq \es+-n |
|
for one-digit numerals; |
|
.Sq \es(+-nn |
|
or |
|
.Sq \es+-(nn |
|
for two-digit numerals; and |
|
.Sq \es[+-N] , |
|
.Sq \es+-[N] , |
|
.Sq \es'+-N' , |
|
or |
|
.Sq \es+-'N' |
|
for arbitrary-digit numerals: |
|
.Pp |
.Pp |
.D1 \es+1bigger\es-1 |
Examples: |
.D1 \es[+10]much bigger\es[-10] |
.Bl -tag -width Ds -offset indent -compact |
.D1 \es+(10much bigger\es-(10 |
.It Li \efBbold\efR |
.D1 \es+'100'much much bigger\es-'100' |
Write in bold, then switch to regular font mode. |
|
.It Li \efIitalic\efP |
|
Write in italic, then return to previous font mode. |
|
.El |
|
.Ss Predefined Strings |
|
Predefined strings, like |
|
.Sx Special Characters , |
|
mark special output glyphs. |
|
Predefined strings are escaped with the slash-asterisk, |
|
.Sq \e* : |
|
single-character |
|
.Sq \e*X , |
|
two-character |
|
.Sq \e*(XX , |
|
and N-character |
|
.Sq \e*[N] . |
.Pp |
.Pp |
Both |
Examples: |
.Sq \es |
.Bl -tag -width Ds -offset indent -compact |
and |
.It Li \e*(Am |
.Sq \ef |
Two-letter ampersand predefined string. |
attributes are forgotten when entering or exiting a macro block. |
.It Li \e*q |
|
One-letter double-quote predefined string. |
|
.El |
|
.Pp |
|
These strings are set using |
|
.Xr roff 7 , |
|
although |
|
.Nm |
|
consists of several pre-set escapes listed in |
|
.Xr mandoc_char 7 . |
.Ss Whitespace |
.Ss Whitespace |
Whitespace consists of the space character. |
Whitespace consists of the space character. |
In free-form lines, whitespace is preserved within a line; un-escaped |
In text lines, whitespace is preserved within a line. |
trailing spaces are stripped from input (unless in a literal context). |
|
Blank free-form lines, which may include spaces, are permitted and |
|
rendered as an empty line. |
|
.Pp |
|
In macro lines, whitespace delimits arguments and is discarded. |
In macro lines, whitespace delimits arguments and is discarded. |
If arguments are quoted, whitespace within the quotes is retained. |
|
.Ss Dates |
|
The |
|
.Sx \&TH |
|
macro is the only |
|
.Nm |
|
macro that requires a date. |
|
The form for this date is the ISO-8601 |
|
standard |
|
.Cm YYYY-MM-DD . |
|
.Ss Scaling Widths |
|
Many macros support scaled widths for their arguments, such as |
|
stipulating a two-inch paragraph indentation with the following: |
|
.Bd -literal -offset indent |
|
\&.HP 2i |
|
.Ed |
|
.Pp |
.Pp |
The syntax for scaled widths is |
Unescaped trailing spaces are stripped from text line input unless in a |
.Sq Li [+-]?[0-9]*.[0-9]*[:unit:]? , |
literal context. |
|
In general, trailing whitespace on any input line is discouraged for |
|
reasons of portability. |
|
In the rare case that a blank character is needed at the end of an |
|
input line, it may be forced by |
|
.Sq \e\ \e& . |
|
.Pp |
|
In general, space characters can be rendered as literal |
|
characters by using non-breaking space escapes or |
|
.Sx Quotation . |
|
If the first character of a text line is a space, that line is printed |
|
with a leading newline. |
|
.Ss Quotation |
|
Macro arguments may be quoted with double-quotes to so that the |
|
enclosed text is one literal term. |
|
Quoted text, even if whitespace or if it would cause a macro invocation |
|
when unquoted, is considered literal text. |
|
.Pp |
|
A quoted argument begins with a double-quote preceded by whitespace. |
|
The next double-quote not pairwise adjacent to another double-quote |
|
terminates the literal, regardless of surrounding whitespace. |
|
.Pp |
|
Examples: |
|
.Bl -tag -width Ds -offset indent -compact |
|
.It Li .BR a \(dqb c\(dq d |
|
Group arguments |
|
.Qq b c |
|
into one un-bolded argument. |
|
If unspecified, |
|
.Qq a |
|
and |
|
.Qq c |
|
will be in bold, |
|
.Qq b |
|
and |
|
.Qq d |
|
in regular font mode. |
|
Furthermore, will be preserved between |
|
.Qq b |
|
and |
|
.Qq c . |
|
.El |
|
.Ss Scaling Widths |
|
Many macros support scaled widths for their arguments. |
|
The syntax for a scaled width is |
|
.Sq Li [+-]?[0-9]*.[0-9]*[:unit:] , |
where a decimal must be preceded or proceeded by at least one digit. |
where a decimal must be preceded or proceeded by at least one digit. |
Negative numbers, while accepted, are truncated to zero. |
Negative numbers, while accepted, are truncated to zero. |
|
.Pp |
The following scaling units are accepted: |
The following scaling units are accepted: |
.Pp |
.Pp |
.Bl -tag -width Ds -offset indent -compact |
.Bl -tag -width Ds -offset indent -compact |
Line 200 Using anything other than |
|
Line 251 Using anything other than |
|
or |
or |
.Sq v |
.Sq v |
is necessarily non-portable across output media. |
is necessarily non-portable across output media. |
|
See |
|
.Sx COMPATIBILITY . |
.Pp |
.Pp |
If a scaling unit is not provided, the numerical value is interpreted |
If a scaling unit is not provided, the numerical value is interpreted |
under the default rules of |
under the default rules of |
Line 207 under the default rules of |
|
Line 260 under the default rules of |
|
for vertical spaces and |
for vertical spaces and |
.Sq u |
.Sq u |
for horizontal ones. |
for horizontal ones. |
.Em Note : |
.Pp |
this differs from |
Examples: |
.Xr mdoc 7 , |
.Bl -tag -width Ds -offset indent -compact |
which, if a unit is not provided, will instead interpret the string as |
.It \&.HP 2i |
literal text. |
two-inch tagged list indentation |
|
.Pq see Sx \&HP |
|
.It \&.sp 2v |
|
two vertical spaces |
|
.Pq see Sx \&sp |
|
.El |
.Ss Sentence Spacing |
.Ss Sentence Spacing |
When composing a manual, make sure that your sentences end at the end of |
Sentences should terminate at the end of an input line. |
a line. |
By doing this, a formatter will be able to apply the proper amount of |
By doing so, front-ends will be able to apply the proper amount of |
|
spacing after the end of sentence (unescaped) period, exclamation mark, |
spacing after the end of sentence (unescaped) period, exclamation mark, |
or question mark followed by zero or more non-sentence closing |
or question mark followed by zero or more non-sentence closing |
delimiters ( |
delimiters |
.Ns Sq \&) , |
.Po |
|
.Sq \&) , |
.Sq \&] , |
.Sq \&] , |
.Sq \&' , |
.Sq \&' , |
.Sq \&" ) . |
.Sq \&" |
|
.Pc . |
|
.Pp |
|
Examples: |
|
.Bd -literal -offset indent -compact |
|
Do not end sentences mid-line like this. Instead, |
|
end a sentence like this. |
|
A new sentence gets a new line. |
|
.Ed |
.Sh MANUAL STRUCTURE |
.Sh MANUAL STRUCTURE |
Each |
Each |
.Nm |
.Nm |
document must contain contains at least the |
document must contain the |
.Sx \&TH |
.Sx \&TH |
macro describing the document's section and title. |
macro describing the document's section and title. |
It may occur anywhere in the document, although conventionally, it |
It may occur anywhere in the document, although conventionally it |
appears as the first macro. |
appears as the first macro. |
.Pp |
.Pp |
Beyond |
Beyond |
.Sx \&TH , |
.Sx \&TH , |
at least one macro or text node must appear in the document. |
at least one macro or text node must appear in the document. |
Documents are generally structured as follows: |
.Pp |
|
The following is a well-formed skeleton |
|
.Nm |
|
file for a utility |
|
.Qq progname : |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.TH FOO 1 2009-10-10 |
\&.TH PROGNAME 1 2009-10-10 |
\&. |
|
\&.SH NAME |
\&.SH NAME |
\efBfoo\efR \e(en a description goes here |
\efBprogname\efR \e(en a description goes here |
\&.\e\*q The next is for sections 2 & 3 only. |
\&.\e\(dq .SH LIBRARY |
\&.\e\*q .SH LIBRARY |
\&.\e\(dq For sections 2 & 3 only. |
\&. |
\&.\e\(dq Not used in OpenBSD. |
\&.SH SYNOPSIS |
\&.SH SYNOPSIS |
\efBfoo\efR [\efB\e-options\efR] arguments... |
\efBprogname\efR [\efB\e-options\efR] arguments... |
\&. |
|
\&.SH DESCRIPTION |
\&.SH DESCRIPTION |
The \efBfoo\efR utility processes files... |
The \efBfoo\efR utility processes files... |
\&. |
\&.\e\(dq .SH IMPLEMENTATION NOTES |
\&.\e\*q .SH IMPLEMENTATION NOTES |
\&.\e\(dq Not used in OpenBSD. |
\&.\e\*q The next is for sections 2, 3, & 9 only. |
\&.\e\(dq .SH RETURN VALUES |
\&.\e\*q .SH RETURN VALUES |
\&.\e\(dq For sections 2, 3, & 9 only. |
\&.\e\*q The next is for sections 1, 6, 7, & 8 only. |
\&.\e\(dq .SH ENVIRONMENT |
\&.\e\*q .SH ENVIRONMENT |
\&.\e\(dq For sections 1, 6, 7, & 8 only. |
\&.\e\*q .SH FILES |
\&.\e\(dq .SH FILES |
\&.\e\*q The next is for sections 1 & 8 only. |
\&.\e\(dq .SH EXIT STATUS |
\&.\e\*q .SH EXIT STATUS |
\&.\e\(dq For sections 1, 6, & 8 only. |
\&.\e\*q .SH EXAMPLES |
\&.\e\(dq .SH EXAMPLES |
\&.\e\*q The next is for sections 1, 4, 6, 7, & 8 only. |
\&.\e\(dq .SH DIAGNOSTICS |
\&.\e\*q .SH DIAGNOSTICS |
\&.\e\(dq For sections 1, 4, 6, 7, & 8 only. |
\&.\e\*q The next is for sections 2, 3, & 9 only. |
\&.\e\(dq .SH ERRORS |
\&.\e\*q .SH ERRORS |
\&.\e\(dq For sections 2, 3, & 9 only. |
\&.\e\*q .SH SEE ALSO |
\&.\e\(dq .SH SEE ALSO |
\&.\e\*q .BR foo ( 1 ) |
\&.\e\(dq .BR foo ( 1 ) |
\&.\e\*q .SH STANDARDS |
\&.\e\(dq .SH STANDARDS |
\&.\e\*q .SH HISTORY |
\&.\e\(dq .SH HISTORY |
\&.\e\*q .SH AUTHORS |
\&.\e\(dq .SH AUTHORS |
\&.\e\*q .SH CAVEATS |
\&.\e\(dq .SH CAVEATS |
\&.\e\*q .SH BUGS |
\&.\e\(dq .SH BUGS |
\&.\e\*q .SH SECURITY CONSIDERATIONS |
\&.\e\(dq .SH SECURITY CONSIDERATIONS |
|
\&.\e\(dq Not used in OpenBSD. |
.Ed |
.Ed |
.Pp |
.Pp |
The sections in a |
The sections in a |
Line 318 Implementation-specific notes should be kept here. |
|
Line 387 Implementation-specific notes should be kept here. |
|
This is useful when implementing standard functions that may have side |
This is useful when implementing standard functions that may have side |
effects or notable algorithmic implications. |
effects or notable algorithmic implications. |
.It Em RETURN VALUES |
.It Em RETURN VALUES |
This section is the dual of |
This section documents the return values of functions in sections 2, 3, and 9. |
.Em EXIT STATUS , |
|
which is used for commands. |
|
It documents the return values of functions in sections 2, 3, and 9. |
|
.It Em ENVIRONMENT |
.It Em ENVIRONMENT |
Documents any usages of environment variables, e.g., |
Documents any usages of environment variables, e.g., |
.Xr environ 7 . |
.Xr environ 7 . |
.It Em FILES |
.It Em FILES |
Documents files used. |
Documents files used. |
It's helpful to document both the file and a short description of how |
It's helpful to document both the file name and a short description of how |
the file is used (created, modified, etc.). |
the file is used (created, modified, etc.). |
.It Em EXIT STATUS |
.It Em EXIT STATUS |
Command exit status for section 1, 6, and 8 manuals. |
This section documents the command exit status for |
This section is the dual of |
section 1, 6, and 8 utilities. |
.Em RETURN VALUES , |
|
which is used for functions. |
|
Historically, this information was described in |
Historically, this information was described in |
.Em DIAGNOSTICS , |
.Em DIAGNOSTICS , |
a practise that is now discouraged. |
a practise that is now discouraged. |
Line 341 a practise that is now discouraged. |
|
Line 405 a practise that is now discouraged. |
|
Example usages. |
Example usages. |
This often contains snippets of well-formed, |
This often contains snippets of well-formed, |
well-tested invocations. |
well-tested invocations. |
Make doubly sure that your examples work properly! |
Make sure that examples work properly! |
.It Em DIAGNOSTICS |
.It Em DIAGNOSTICS |
Documents error conditions. |
Documents error conditions. |
This is most useful in section 4 manuals. |
This is most useful in section 4 manuals. |
Line 368 If not adhering to any standards, the |
|
Line 432 If not adhering to any standards, the |
|
.Em HISTORY |
.Em HISTORY |
section should be used. |
section should be used. |
.It Em HISTORY |
.It Em HISTORY |
The history of any manual without a |
A brief history of the subject, including where support first appeared. |
.Em STANDARDS |
|
section should be described in this section. |
|
.It Em AUTHORS |
.It Em AUTHORS |
Credits to authors, if applicable, should appear in this section. |
Credits to the person or persons who wrote the code and/or documentation. |
Authors should generally be noted by both name and an e-mail address. |
Authors should generally be noted by both name and email address. |
.It Em CAVEATS |
.It Em CAVEATS |
Explanations of common misuses and misunderstandings should be explained |
Common misuses and misunderstandings should be explained |
in this section. |
in this section. |
.It Em BUGS |
.It Em BUGS |
Extant bugs should be described in this section. |
Known bugs, limitations, and work-arounds should be described |
|
in this section. |
.It Em SECURITY CONSIDERATIONS |
.It Em SECURITY CONSIDERATIONS |
Documents any security precautions that operators should consider. |
Documents any security precautions that operators should consider. |
.El |
.El |
.Sh MACRO SYNTAX |
.Sh MACRO SYNTAX |
Macros are one to three three characters in length and begin with a |
Macros are one to three characters in length and begin with a |
control character , |
control character, |
.Sq \&. , |
.Sq \&. , |
at the beginning of the line. |
at the beginning of the line. |
The |
The |
Line 398 Thus, the following are equivalent: |
|
Line 461 Thus, the following are equivalent: |
|
\&.\ \ \ PP |
\&.\ \ \ PP |
.Ed |
.Ed |
.Pp |
.Pp |
|
To include space characters in macro arguments, arguments may be quoted; |
|
see the |
|
.Sq MACRO SYNTAX |
|
section in the |
|
.Xr roff 7 |
|
manual for details. |
|
.Pp |
The |
The |
.Nm |
.Nm |
macros are classified by scope: line scope or block scope. |
macros are classified by scope: line scope or block scope. |
Line 420 is equivalent to |
|
Line 490 is equivalent to |
|
.Sq \&.I foo . |
.Sq \&.I foo . |
If next-line macros are invoked consecutively, only the last is used. |
If next-line macros are invoked consecutively, only the last is used. |
If a next-line macro is followed by a non-next-line macro, an error is |
If a next-line macro is followed by a non-next-line macro, an error is |
raised (unless in the case of |
raised, except for |
.Sx \&br , |
.Sx \&br , |
.Sx \&sp , |
.Sx \&sp , |
or |
and |
.Sx \&na ) . |
.Sx \&na . |
.Pp |
.Pp |
The syntax is as follows: |
The syntax is as follows: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
Line 434 The syntax is as follows: |
|
Line 504 The syntax is as follows: |
|
.Pp |
.Pp |
.Bl -column -compact -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX" "CompatX" |
.Bl -column -compact -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX" "CompatX" |
.It Em Macro Ta Em Arguments Ta Em Scope Ta Em Notes |
.It Em Macro Ta Em Arguments Ta Em Scope Ta Em Notes |
|
.It Sx \&AT Ta <=1 Ta current Ta \& |
.It Sx \&B Ta n Ta next-line Ta \& |
.It Sx \&B Ta n Ta next-line Ta \& |
.It Sx \&BI Ta n Ta current Ta \& |
.It Sx \&BI Ta n Ta current Ta \& |
.It Sx \&BR Ta n Ta current Ta \& |
.It Sx \&BR Ta n Ta current Ta \& |
Line 441 The syntax is as follows: |
|
Line 512 The syntax is as follows: |
|
.It Sx \&I Ta n Ta next-line Ta \& |
.It Sx \&I Ta n Ta next-line Ta \& |
.It Sx \&IB Ta n Ta current Ta \& |
.It Sx \&IB Ta n Ta current Ta \& |
.It Sx \&IR Ta n Ta current Ta \& |
.It Sx \&IR Ta n Ta current Ta \& |
.\" .It Sx \&PD Ta n Ta current Ta compat |
|
.It Sx \&R Ta n Ta next-line Ta \& |
.It Sx \&R Ta n Ta next-line Ta \& |
.It Sx \&RB Ta n Ta current Ta \& |
.It Sx \&RB Ta n Ta current Ta \& |
.It Sx \&RI Ta n Ta current Ta \& |
.It Sx \&RI Ta n Ta current Ta \& |
.It Sx \&SB Ta n Ta next-line Ta \& |
.It Sx \&SB Ta n Ta next-line Ta \& |
.It Sx \&SM Ta n Ta next-line Ta \& |
.It Sx \&SM Ta n Ta next-line Ta \& |
.It Sx \&TH Ta >1, <6 Ta current Ta \& |
.It Sx \&TH Ta >1, <6 Ta current Ta \& |
.\" .It Sx \&UC Ta n Ta current Ta compat |
.It Sx \&UC Ta <=1 Ta current Ta \& |
.It Sx \&br Ta 0 Ta current Ta compat |
.It Sx \&br Ta 0 Ta current Ta compat |
.It Sx \&fi Ta 0 Ta current Ta compat |
.It Sx \&fi Ta 0 Ta current Ta compat |
.It Sx \&i Ta n Ta current Ta compat |
.It Sx \&ft Ta 1 Ta current Ta compat |
|
.It Sx \&in Ta 1 Ta current Ta compat |
.It Sx \&na Ta 0 Ta current Ta compat |
.It Sx \&na Ta 0 Ta current Ta compat |
.It Sx \&nf Ta 0 Ta current Ta compat |
.It Sx \&nf Ta 0 Ta current Ta compat |
.It Sx \&r Ta 0 Ta current Ta compat |
|
.It Sx \&sp Ta 1 Ta current Ta compat |
.It Sx \&sp Ta 1 Ta current Ta compat |
.\" .It Sx \&Sp Ta <1 Ta current Ta compat |
|
.\" .It Sx \&Vb Ta <1 Ta current Ta compat |
|
.\" .It Sx \&Ve Ta 0 Ta current Ta compat |
|
.El |
.El |
.Pp |
.Pp |
Macros marked as |
Macros marked as |
Line 469 These macros should not be used for portable |
|
Line 536 These macros should not be used for portable |
|
.Nm |
.Nm |
manuals. |
manuals. |
.Ss Block Macros |
.Ss Block Macros |
Block macros are comprised of a head and body. |
Block macros comprise a head and body. |
Like for in-line macros, the head is scoped to the current line and, in |
As with in-line macros, the head is scoped to the current line and, in |
one circumstance, the next line (the next-line stipulations as in |
one circumstance, the next line (the next-line stipulations as in |
.Sx Line Macros |
.Sx Line Macros |
apply here as well). |
apply here as well). |
Line 529 This section is a canonical reference to all macros, a |
|
Line 596 This section is a canonical reference to all macros, a |
|
alphabetically. |
alphabetically. |
For the scoping of individual macros, see |
For the scoping of individual macros, see |
.Sx MACRO SYNTAX . |
.Sx MACRO SYNTAX . |
|
.Ss \&AT |
|
Sets the volume for the footer for compatibility with man pages from |
|
.Tn AT&T UNIX |
|
releases. |
|
The optional arguments specify which release it is from. |
.Ss \&B |
.Ss \&B |
Text is rendered in bold face. |
Text is rendered in bold face. |
.Pp |
.Pp |
See also |
See also |
.Sx \&I , |
.Sx \&I |
.Sx \&R , |
|
.Sx \&b , |
|
.Sx \&i , |
|
and |
and |
.Sx \&r . |
.Sx \&R . |
.Ss \&BI |
.Ss \&BI |
Text is rendered alternately in bold face and italic. |
Text is rendered alternately in bold face and italic. |
Thus, |
Thus, |
Line 556 Whitespace between arguments is omitted in output. |
|
Line 625 Whitespace between arguments is omitted in output. |
|
.Pp |
.Pp |
Examples: |
Examples: |
.Pp |
.Pp |
.D1 \&.BI bold italic bold italic |
.Dl \&.BI bold italic bold italic |
.Pp |
.Pp |
The output of this example will be emboldened |
The output of this example will be emboldened |
.Dq bold |
.Dq bold |
|
|
Text is rendered in italics. |
Text is rendered in italics. |
.Pp |
.Pp |
See also |
See also |
.Sx \&B , |
.Sx \&B |
.Sx \&R , |
|
.Sx \&b , |
|
.Sx \&i , |
|
and |
and |
.Sx \&r . |
.Sx \&R . |
.Ss \&IB |
.Ss \&IB |
Text is rendered alternately in italics and bold face. Whitespace |
Text is rendered alternately in italics and bold face. |
between arguments is omitted in output. |
Whitespace between arguments is omitted in output. |
.Pp |
.Pp |
See |
See |
.Sx \&BI |
.Sx \&BI |
Line 646 Begin an indented paragraph with the following syntax: |
|
Line 712 Begin an indented paragraph with the following syntax: |
|
The |
The |
.Cm width |
.Cm width |
argument defines the width of the left margin and is defined by |
argument defines the width of the left margin and is defined by |
.Sx Scaling Widths , |
.Sx Scaling Widths . |
It's saved for later paragraph left-margins; if unspecified, the saved or |
It's saved for later paragraph left-margins; if unspecified, the saved or |
default width is used. |
default width is used. |
.Pp |
.Pp |
|
|
Begin an undecorated paragraph. |
Begin an undecorated paragraph. |
The scope of a paragraph is closed by a subsequent paragraph, |
The scope of a paragraph is closed by a subsequent paragraph, |
sub-section, section, or end of file. |
sub-section, section, or end of file. |
The saved paragraph left-margin width is re-set to the default. |
The saved paragraph left-margin width is reset to the default. |
.Pp |
.Pp |
See also |
See also |
.Sx \&HP , |
.Sx \&HP , |
|
|
Text is rendered in roman (the default font). |
Text is rendered in roman (the default font). |
.Pp |
.Pp |
See also |
See also |
.Sx \&I , |
.Sx \&I |
.Sx \&B , |
|
.Sx \&b , |
|
.Sx \&i , |
|
and |
and |
.Sx \&r . |
.Sx \&B . |
.Ss \&RB |
.Ss \&RB |
Text is rendered alternately in roman (the default font) and bold face. |
Text is rendered alternately in roman (the default font) and bold face. |
Whitespace between arguments is omitted in output. |
Whitespace between arguments is omitted in output. |
|
|
.Ss \&RE |
.Ss \&RE |
Explicitly close out the scope of a prior |
Explicitly close out the scope of a prior |
.Sx \&RS . |
.Sx \&RS . |
|
The default left margin is restored to the state of the original |
|
.Sx \&RS |
|
invocation. |
.Ss \&RI |
.Ss \&RI |
Text is rendered alternately in roman (the default font) and italics. |
Text is rendered alternately in roman (the default font) and italics. |
Whitespace between arguments is omitted in output. |
Whitespace between arguments is omitted in output. |
|
|
and |
and |
.Sx \&IR . |
.Sx \&IR . |
.Ss \&RS |
.Ss \&RS |
Begin a part setting the left margin. |
Temporarily reset the default left margin. |
The left margin controls the offset, following an initial indentation, |
|
to un-indented text such as that of |
|
.Sx \&PP . |
|
This has the following syntax: |
This has the following syntax: |
.Bd -filled -offset indent |
.Bd -filled -offset indent |
.Pf \. Sx \&Rs |
.Pf \. Sx \&RS |
.Op Cm width |
.Op Cm width |
.Ed |
.Ed |
.Pp |
.Pp |
|
|
argument must conform to |
argument must conform to |
.Sx Scaling Widths . |
.Sx Scaling Widths . |
If not specified, the saved or default width is used. |
If not specified, the saved or default width is used. |
|
.Pp |
|
See also |
|
.Sx \&RE . |
.Ss \&SB |
.Ss \&SB |
Text is rendered in small size (one point smaller than the default font) |
Text is rendered in small size (one point smaller than the default font) |
bold face. |
bold face. |
|
|
Begin a section. |
Begin a section. |
The scope of a section is only closed by another section or the end of |
The scope of a section is only closed by another section or the end of |
file. |
file. |
The paragraph left-margin width is re-set to the default. |
The paragraph left-margin width is reset to the default. |
.Ss \&SM |
.Ss \&SM |
Text is rendered in small size (one point smaller than the default |
Text is rendered in small size (one point smaller than the default |
font). |
font). |
|
|
Begin a sub-section. |
Begin a sub-section. |
The scope of a sub-section is closed by a subsequent sub-section, |
The scope of a sub-section is closed by a subsequent sub-section, |
section, or end of file. |
section, or end of file. |
The paragraph left-margin width is re-set to the default. |
The paragraph left-margin width is reset to the default. |
.Ss \&TH |
.Ss \&TH |
Sets the title of the manual page with the following syntax: |
Sets the title of the manual page with the following syntax: |
.Bd -filled -offset indent |
.Bd -filled -offset indent |
.Pf \. Sx \&TH |
.Pf \. Sx \&TH |
.Cm title section |
.Ar title section date |
.Op Cm date Op Cm source Op Cm volume |
.Op Ar source Op Ar volume |
.Ed |
.Ed |
.Pp |
.Pp |
At least the upper-case document title |
Conventionally, the document |
.Cm title |
.Ar title |
and numeric manual section |
is given in all caps. |
.Cm section |
The recommended |
arguments must be provided. |
.Ar date |
The |
format is |
.Cm date |
.Sy YYYY-MM-DD |
argument should be formatted as described in |
as specified in the ISO-8601 standard; |
.Sx Dates : |
if the argument does not conform, it is printed verbatim. |
if it does not conform, the current date is used instead. |
If the |
The |
.Ar date |
.Cm source |
is empty or not specified, the current date is used. |
|
The optional |
|
.Ar source |
string specifies the organisation providing the utility. |
string specifies the organisation providing the utility. |
The |
The |
.Cm volume |
.Ar volume |
string replaces the default rendered volume, which is dictated by the |
string replaces the default rendered volume, which is dictated by the |
manual section. |
manual section. |
.Pp |
.Pp |
Examples: |
Examples: |
.Pp |
.Pp |
.D1 \&.TH CVS 5 "1992-02-12" GNU |
.Dl \&.TH CVS 5 "1992-02-12" GNU |
.Ss \&TP |
.Ss \&TP |
Begin a paragraph where the head, if exceeding the indentation width, is |
Begin a paragraph where the head, if exceeding the indentation width, is |
followed by a newline; if not, the body follows on the same line after a |
followed by a newline; if not, the body follows on the same line after a |
|
|
.Sx \&P , |
.Sx \&P , |
and |
and |
.Sx \&PP . |
.Sx \&PP . |
.\" . |
.Ss \&UC |
.\" . |
Sets the volume for the footer for compatibility with man pages from |
.\" .Ss \&PD |
BSD releases. |
.\" Has no effect. Included for compatibility. |
The optional first argument specifies which release it is from. |
.\" . |
|
.\" . |
|
.\" .Ss \&UC |
|
.\" Has no effect. Included for compatibility. |
|
.Ss \&br |
.Ss \&br |
Breaks the current line. |
Breaks the current line. |
Consecutive invocations have no further effect. |
Consecutive invocations have no further effect. |
|
|
.Ss \&fi |
.Ss \&fi |
End literal mode begun by |
End literal mode begun by |
.Sx \&nf . |
.Sx \&nf . |
.Ss \&i |
.Ss \&ft |
Italicise arguments. |
Change the current font mode. |
Synonym for |
See |
.Sx \&I . |
.Sx Text Decoration |
|
for a listing of available font modes. |
|
.Ss \&in |
|
Indent relative to the current indentation: |
.Pp |
.Pp |
See also |
.D1 Pf \. Sx \&in Op Cm width |
.Sx \&B , |
.Pp |
.Sx \&I , |
If |
.Sx \&R . |
.Cm width |
.Sx \&b , |
is signed, the new offset is relative. |
and |
Otherwise, it is absolute. |
.Sx \&r . |
This value is reset upon the next paragraph, section, or sub-section. |
.Ss \&na |
.Ss \&na |
Don't align to the right margin. |
Don't align to the right margin. |
.Ss \&nf |
.Ss \&nf |
Line 877 Begin literal mode: all subsequent free-form lines hav |
|
Line 944 Begin literal mode: all subsequent free-form lines hav |
|
line boundaries preserved. |
line boundaries preserved. |
May be ended by |
May be ended by |
.Sx \&fi . |
.Sx \&fi . |
.Ss \&r |
Literal mode is implicitly ended by |
Fonts and styles (bold face, italics) reset to roman (default font). |
.Sx \&SH |
.Pp |
or |
See also |
.Sx \&SS . |
.Sx \&B , |
|
.Sx \&I , |
|
.Sx \&R , |
|
.Sx \&b , |
|
and |
|
.Sx \&i . |
|
.Ss \&sp |
.Ss \&sp |
Insert vertical spaces into output with the following syntax: |
Insert vertical spaces into output with the following syntax: |
.Bd -filled -offset indent |
.Bd -filled -offset indent |
Line 905 Defaults to 1, if unspecified. |
|
Line 966 Defaults to 1, if unspecified. |
|
.Pp |
.Pp |
See also |
See also |
.Sx \&br . |
.Sx \&br . |
.\" .Ss \&Sp |
|
.\" A synonym for |
|
.\" .Sx \&sp |
|
.\" .Cm 0.5v . |
|
.\" . |
|
.\" .Ss \&Vb |
|
.\" A synonym for |
|
.\" .Sx \&nf . |
|
.\" Accepts an argument (the height of the formatted space) which is |
|
.\" disregarded. |
|
.\" . |
|
.\" .Ss \&Ve |
|
.\" A synonym for |
|
.\" .Sx \&fi . |
|
.\" . |
|
.Sh COMPATIBILITY |
.Sh COMPATIBILITY |
This section documents areas of questionable portability between |
This section documents areas of questionable portability between |
implementations of the |
implementations of the |
Line 932 In quoted literals, GNU troff allowed pair-wise double |
|
Line 978 In quoted literals, GNU troff allowed pair-wise double |
|
a standalone double-quote in formatted output. |
a standalone double-quote in formatted output. |
It is not known whether this behaviour is exhibited by other formatters. |
It is not known whether this behaviour is exhibited by other formatters. |
.It |
.It |
|
troff suppresses a newline before |
|
.Sq \(aq |
|
macro output; in mandoc, it is an alias for the standard |
|
.Sq \&. |
|
control character. |
|
.It |
The |
The |
|
.Sq \eh |
|
.Pq horizontal position , |
|
.Sq \ev |
|
.Pq vertical position , |
|
.Sq \em |
|
.Pq text colour , |
|
.Sq \eM |
|
.Pq text filling colour , |
|
.Sq \ez |
|
.Pq zero-length character , |
|
.Sq \ew |
|
.Pq string length , |
|
.Sq \ek |
|
.Pq horizontal position marker , |
|
.Sq \eo |
|
.Pq text overstrike , |
|
and |
|
.Sq \es |
|
.Pq text size |
|
escape sequences are all discarded in mandoc. |
|
.It |
|
The |
|
.Sq \ef |
|
scaling unit is accepted by mandoc, but rendered as the default unit. |
|
.It |
|
The |
.Sx \&sp |
.Sx \&sp |
macro does not accept negative values in mandoc. |
macro does not accept negative values in mandoc. |
In GNU troff, this would result in strange behaviour. |
In GNU troff, this would result in strange behaviour. |
.It |
|
The |
|
.Sq \(aq |
|
macro control character, in GNU troff (and prior troffs) suppresses a |
|
newline before macro output; in mandoc, it is an alias for the standard |
|
.Sq \&. |
|
control character. |
|
.El |
.El |
.Sh SEE ALSO |
.Sh SEE ALSO |
|
.Xr man 1 , |
.Xr mandoc 1 , |
.Xr mandoc 1 , |
.Xr mandoc_char 7 |
.Xr eqn 7 , |
.Sh AUTHORS |
.Xr mandoc_char 7 , |
|
.Xr mdoc 7 , |
|
.Xr roff 7 , |
|
.Xr tbl 7 |
|
.Sh HISTORY |
The |
The |
.Nm |
.Nm |
|
language first appeared as a macro package for the roff typesetting |
|
system in |
|
.At v7 . |
|
It was later rewritten by James Clark as a macro package for groff. |
|
The stand-alone implementation that is part of the |
|
.Xr mandoc 1 |
|
utility written by Kristaps Dzonsons appeared in |
|
.Ox 4.6 . |
|
.Sh AUTHORS |
|
This |
|
.Nm |
reference was written by |
reference was written by |
.An Kristaps Dzonsons Aq kristaps@bsd.lv . |
.An Kristaps Dzonsons , |
|
.Mt kristaps@bsd.lv . |
.Sh CAVEATS |
.Sh CAVEATS |
Do not use this language. |
Do not use this language. |
Use |
Use |