version 1.79, 2010/07/22 23:03:15 |
version 1.84, 2010/08/24 13:07:01 |
|
|
attribute is forgotten when entering or exiting a macro block. |
attribute is forgotten when entering or exiting a macro block. |
.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 free-form lines, whitespace is preserved within a line; unescaped |
trailing spaces are stripped from input (unless in a literal context). |
trailing spaces are stripped from input (unless in a literal context). |
Blank free-form lines, which may include spaces, are permitted and |
Blank free-form lines, which may include spaces, are permitted and |
rendered as an empty line. |
rendered as an empty line. |
Line 190 this differs from |
|
Line 190 this differs from |
|
which, if a unit is not provided, will instead interpret the string as |
which, if a unit is not provided, will instead interpret the string as |
literal text. |
literal text. |
.Ss Sentence Spacing |
.Ss Sentence Spacing |
When composing a manual, make sure that your sentences end at the end of |
When composing a manual, make sure that sentences end at the end of |
a line. |
a line. |
By doing so, front-ends 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 . |
.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 |
Line 291 Implementation-specific notes should be kept here. |
|
Line 293 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 . |
Line 303 Documents files used. |
|
Line 302 Documents files used. |
|
It's helpful to document both the file name 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 314 a practise that is now discouraged. |
|
Line 311 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 341 If not adhering to any standards, the |
|
Line 338 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 email address. |
Authors should generally be noted by both name and email address. |
.It Em CAVEATS |
.It Em CAVEATS |
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 |
Known bugs, limitations and work-arounds should be described |
Known bugs, limitations, and work-arounds should be described |
in this section. |
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. |
Line 445 These macros should not be used for portable |
|
Line 440 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). |
|
|
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 627 Begin an indented paragraph with the following syntax: |
|
Line 622 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 |
|
|
.Pp |
.Pp |
.Bl -dash -compact |
.Bl -dash -compact |
.It |
.It |
The \es (font size), \em (font colour), and \eM (font filling colour) |
|
font decoration escapes are all discarded in mandoc. |
|
.It |
|
In quoted literals, GNU troff allowed pair-wise double-quotes to produce |
In quoted literals, GNU troff allowed pair-wise double-quotes to produce |
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 , |
|
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 mandoc 1 , |
.Xr mandoc 1 , |
Line 954 It was later rewritten by James Clark as a macro packa |
|
Line 967 It was later rewritten by James Clark as a macro packa |
|
The stand-alone implementation that is part of the |
The stand-alone implementation that is part of the |
.Xr mandoc 1 |
.Xr mandoc 1 |
utility written by Kristaps Dzonsons appeared in |
utility written by Kristaps Dzonsons appeared in |
.Ox 4.6. |
.Ox 4.6 . |
.Sh AUTHORS |
.Sh AUTHORS |
This |
This |
.Nm |
.Nm |