version 1.5, 2009/03/22 19:01:11 |
version 1.7, 2009/03/22 21:19:34 |
Line 72 to see the specific section manual (section 1, in this |
|
Line 72 to see the specific section manual (section 1, in this |
|
.\" DISPLAY |
.\" DISPLAY |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
% apropos myname |
% apropos myname |
myname (1) - some description here |
myname (1) - utility description |
|
myname (3) - library description |
% man \-s 1 myname |
% man \-s 1 myname |
.Ed |
.Ed |
.\" SUBSECTION |
.\" SUBSECTION |
Line 229 publications, please use the |
|
Line 230 publications, please use the |
|
block macros. |
block macros. |
.\" SUBSECTION |
.\" SUBSECTION |
.Ss Formatting |
.Ss Formatting |
Let the front-ends worry about formatting for you, but if you must think |
.Em Don't style your manual. |
about formatting (at times necessary, especially for tagged and columnar |
Give it meaningful content. The front-end will worry about formatting |
lists), assume that your output device is a fixed-width terminal window: |
and style. |
.Bd -literal -offset indent |
|
\&.Bl \-tag \-width "-o outfile" |
|
\&.It \&Fl \&Ar outfile |
|
.Ed |
|
.Pp |
|
You may assume that the width calculated by the string literal |
|
.Qq Fl o Ar outfile |
|
will be covered by the \-width argument. |
|
.\" SECTION |
.\" SECTION |
.Sh MAINTENANCE |
.Sh MAINTENANCE |
As your component changes and bugs are fixed, your manual may become out |
As your component changes and bugs are fixed, your manual may become out |
of date. You may be tempted to use automation tools like Doxygen to |
of date. You may be tempted to use automation tools like Doxygen to |
smooth the development of your manuals. Don't. Source documentation is |
smooth the development of your manuals. Don't. Source documentation is |
different from a component manual. |
different from a component manual. |