version 1.64, 2010/05/08 08:36:44 |
version 1.67, 2010/05/12 08:41:17 |
|
|
.Sq \ef |
.Sq \ef |
attributes are forgotten when entering or exiting a macro block. |
attributes are forgotten when entering or exiting a macro block. |
.Ss Whitespace |
.Ss Whitespace |
|
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; un-escaped |
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 |
Line 231 are generally structured as follows: |
|
Line 232 are generally structured as follows: |
|
The \efBfoo\efR utility processes files... |
The \efBfoo\efR utility processes files... |
\&. |
\&. |
\&.\e\*q .SH IMPLEMENTATION NOTES |
\&.\e\*q .SH IMPLEMENTATION NOTES |
\&.\e\*q The next is for sections 1 & 8 only. |
|
\&.\e\*q .SH EXIT STATUS |
|
\&.\e\*q The next is for sections 2, 3, & 9 only. |
\&.\e\*q The next is for sections 2, 3, & 9 only. |
\&.\e\*q .SH RETURN VALUES |
\&.\e\*q .SH RETURN VALUES |
\&.\e\*q The next is for sections 1, 6, 7, & 8 only. |
\&.\e\*q The next is for sections 1, 6, 7, & 8 only. |
\&.\e\*q .SH ENVIRONMENT |
\&.\e\*q .SH ENVIRONMENT |
\&.\e\*q .SH FILES |
\&.\e\*q .SH FILES |
|
\&.\e\*q The next is for sections 1 & 8 only. |
|
\&.\e\*q .SH EXIT STATUS |
\&.\e\*q .SH EXAMPLES |
\&.\e\*q .SH EXAMPLES |
\&.\e\*q The next is for sections 1, 4, 6, 7, & 8 only. |
\&.\e\*q The next is for sections 1, 4, 6, 7, & 8 only. |
\&.\e\*q .SH DIAGNOSTICS |
\&.\e\*q .SH DIAGNOSTICS |
|
|
Implementation-specific notes should be kept here. This is useful when |
Implementation-specific notes should be kept here. This is useful when |
implementing standard functions that may have side effects or notable |
implementing standard functions that may have side effects or notable |
algorithmic implications. |
algorithmic implications. |
.It Em EXIT STATUS |
|
Command exit status for section 1, 6, and 8 manuals. This section is |
|
the dual of |
|
.Em RETURN VALUES , |
|
which is used for functions. Historically, this information was |
|
described in |
|
.Em DIAGNOSTICS , |
|
a practise that is now discouraged. |
|
.It Em RETURN VALUES |
.It Em RETURN VALUES |
This section is the dual of |
This section is the dual of |
.Em EXIT STATUS , |
.Em EXIT STATUS , |
Line 316 Documents any usages of environment variables, e.g., |
|
Line 309 Documents any usages of environment variables, e.g., |
|
.It Em FILES |
.It Em FILES |
Documents files used. It's helpful to document both the file and a |
Documents files used. It's helpful to document both the file and a |
short description of how the file is used (created, modified, etc.). |
short description of how the file is used (created, modified, etc.). |
|
.It Em EXIT STATUS |
|
Command exit status for section 1, 6, and 8 manuals. This section is |
|
the dual of |
|
.Em RETURN VALUES , |
|
which is used for functions. Historically, this information was |
|
described in |
|
.Em DIAGNOSTICS , |
|
a practise that is now discouraged. |
.It Em EXAMPLES |
.It Em EXAMPLES |
Example usages. This often contains snippets of well-formed, |
Example usages. This often contains snippets of well-formed, |
well-tested invocations. Make doubly sure that your examples work |
well-tested invocations. Make doubly sure that your examples work |