version 1.7, 2014/04/02 14:50:09 |
version 1.13, 2014/04/07 11:46:03 |
Line 101 Specifically, within each paragraph of the SYNOPSIS se |
|
Line 101 Specifically, within each paragraph of the SYNOPSIS se |
|
following occur: |
following occur: |
.Bl -bullet |
.Bl -bullet |
.It |
.It |
|
If any number of |
|
.Li #include <foo.h> |
|
lines are found at the start of a verbatim paragraph, they're rendered |
|
with |
|
.Sq \&In . |
|
.It |
An initial |
An initial |
.Li B<> |
.Li B<> |
format code is rendered as |
format code is rendered as |
Line 141 is rendered as follows: |
|
Line 147 is rendered as follows: |
|
\&.Oc |
\&.Oc |
.Ed |
.Ed |
.Pp |
.Pp |
In the NAME section, an |
In the NAME section, |
.Sq \&Nm |
.Sq \&Nm |
and |
and |
.Sq \&Nd |
.Sq \&Nd |
macro are inferred from text leading and trailing the last hyphen |
macros are inferred from text leading and trailing the last hyphen |
followed by a space (there may be any number of hyphens preceding the |
followed by a space (there may be any number of hyphens preceding the |
space). |
space). |
The space may occur on either side of the hyphen. |
The space may occur on either side of the hyphen. |
Line 156 will be rendered as follows: |
|
Line 162 will be rendered as follows: |
|
\&.Nm foo |
\&.Nm foo |
\&.Nd bar |
\&.Nd bar |
.Ed |
.Ed |
|
.Pp |
|
Multiple names separated by a comma are properly handled. |
|
.Pp |
|
In any section, the |
|
.Li L<> |
|
format code is considered a |
|
.Sq \&Lk |
|
link if beginning with |
|
.Li http: , |
|
.Li https: , |
|
.Li ftp: , |
|
.Li sftp: , |
|
.Li smb: , |
|
or |
|
.Li afs: . |
|
If beginning with |
|
.Li mailto: , |
|
it is considered a |
|
.Sq \&Mt |
|
link. |
|
Otherwise, it is considered a |
|
.Sq \&Xr |
|
manpage in section 3P if containing double-colons or section 1 |
|
otherwise. |
|
The section may be overriden as |
|
.Li L<foo(5)> . |
|
If only a section appears, such as in |
|
.Li </section> , |
|
the link is rendered with |
|
.Sq \&Sx . |
.Sh EXIT STATUS |
.Sh EXIT STATUS |
.Ex -std |
.Ex -std |
.Sh EXAMPLES |
.Sh EXAMPLES |
|
|
By way of being a presentational language, POD is not well-represented |
By way of being a presentational language, POD is not well-represented |
by |
by |
.Xr mdoc 7 . |
.Xr mdoc 7 . |
Semantic content will be necessarily lost. |
Semantic content must be inferred and may be wrong. |
.Pp |
.Pp |
.Nm |
.Nm |
only supports the named |
only supports the named |
|
|
.Li S<> |
.Li S<> |
escape is discarded. |
escape is discarded. |
.Pp |
.Pp |
Lastly, only the |
Unless solely a section link, the text and section parts of |
.Li L<Perl::Manpage> |
.Li L<text|link/section> |
and |
are discarded. |
.Li L<manpage(1)> |
|
links are understood and properly rendered as |
|
.Sq \&Xr . |
|