=================================================================== RCS file: /cvs/pod2mdoc/pod2mdoc.1,v retrieving revision 1.8 retrieving revision 1.17 diff -u -p -r1.8 -r1.17 --- pod2mdoc/pod2mdoc.1 2014/04/02 20:32:41 1.8 +++ pod2mdoc/pod2mdoc.1 2015/02/14 15:34:39 1.17 @@ -1,4 +1,4 @@ -.\" $Id: pod2mdoc.1,v 1.8 2014/04/02 20:32:41 kristaps Exp $ +.\" $Id: pod2mdoc.1,v 1.17 2015/02/14 15:34:39 schwarze 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: February 14 2015 $ .Dt POD2MDOC 1 .Os .Sh NAME @@ -50,7 +50,7 @@ For compatibility with Ignored. .It Fl d Ar date Set the document date -.Pq Sq Dd +.Pq Sq \&Dd to .Ar date .Po @@ -58,13 +58,26 @@ preferrably in .Qq Month Day, Year format .Pc . -If unspecified, +If unspecified or if +.Ar date +is the literal string +.Cm Mdocdate , .Nm uses the file modification date or the current date if reading from standard input. +If +.Ar date +is the literal string +.Cm Mdocdate , +.Nm +prepends +.Qq $Mdocdate: +to the date and appends a dollar sign, producing the format used by +.Ox +.Xr cvs 1 . .It Fl n Ar title Set the document title -.Pq Sq Dt +.Pq Sq \&Dt to .Ar title . If unspecified, @@ -77,7 +90,7 @@ if reading from standard input .Pq you probably don't want that . .It Fl s Ar section Set the document section -.Pq Sq Dt +.Pq Sq \&Dt to .Ar section . If unspecified, @@ -101,6 +114,17 @@ 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 +Other lines starting with +.Sq # +are rendered with +.Sq \&Fd . +.It An initial .Li B<> format code is rendered as @@ -135,7 +159,7 @@ Thus, the input .Li B [B<-bar baz>] is rendered as follows: .Bd -literal -\&.Nm foo +\&.Nm foo \&.Oo \&.Fl bar Ar baz \&.Oc @@ -158,6 +182,48 @@ will be rendered as follows: .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 . +.Pp +Words followed by +.Qq Pq +that match function names listed in the SYNOPSIS section are marked up with +.Sq \&Fn . +.Pp +If the contents of a +.Li B<> +format code matches a type name mentioned in the SYNOPSIS section, +it is rendered as +.Sq \&Vt . +If it matches a function argument name mentioned there, +it is rendered as +.Sq \&Fa . .Sh EXIT STATUS .Ex -std .Sh EXAMPLES @@ -201,13 +267,12 @@ does, append a POD ERRORS section in the output manpag .Sh AUTHORS .Nm was written by -.Ar Kristaps Dzonsons , -.Mt kristaps@bsd.lv . +.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv . .Sh CAVEATS 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 @@ -225,9 +290,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.