=================================================================== RCS file: /cvs/pod2mdoc/pod2mdoc.1,v retrieving revision 1.7 retrieving revision 1.13 diff -u -p -r1.7 -r1.13 --- pod2mdoc/pod2mdoc.1 2014/04/02 14:50:09 1.7 +++ pod2mdoc/pod2mdoc.1 2014/04/07 11:46:03 1.13 @@ -1,4 +1,4 @@ -.\" $Id: pod2mdoc.1,v 1.7 2014/04/02 14:50:09 kristaps Exp $ +.\" $Id: pod2mdoc.1,v 1.13 2014/04/07 11:46:03 kristaps Exp $ .\" .\" Copyright (c) 2014 Kristaps Dzonsons .\" @@ -14,7 +14,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: April 2 2014 $ +.Dd $Mdocdate: April 7 2014 $ .Dt POD2MDOC 1 .Os .Sh NAME @@ -101,6 +101,12 @@ Specifically, within each paragraph of the SYNOPSIS se following occur: .Bl -bullet .It +If any number of +.Li #include +lines are found at the start of a verbatim paragraph, they're rendered +with +.Sq \&In . +.It An initial .Li B<> format code is rendered as @@ -141,11 +147,11 @@ is rendered as follows: \&.Oc .Ed .Pp -In the NAME section, an +In the NAME section, .Sq \&Nm and .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 space). The space may occur on either side of the hyphen. @@ -156,6 +162,36 @@ will be rendered as follows: \&.Nm foo \&.Nd bar .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 . +If only a section appears, such as in +.Li , +the link is rendered with +.Sq \&Sx . .Sh EXIT STATUS .Ex -std .Sh EXAMPLES @@ -205,7 +241,7 @@ was written by By way of being a presentational language, POD is not well-represented by .Xr mdoc 7 . -Semantic content will be necessarily lost. +Semantic content must be inferred and may be wrong. .Pp .Nm only supports the named @@ -223,9 +259,6 @@ The .Li S<> escape is discarded. .Pp -Lastly, only the -.Li L -and -.Li L -links are understood and properly rendered as -.Sq \&Xr . +Unless solely a section link, the text and section parts of +.Li L +are discarded.