=================================================================== RCS file: /cvs/pod2mdoc/pod2mdoc.1,v retrieving revision 1.13 retrieving revision 1.18 diff -u -p -r1.13 -r1.18 --- pod2mdoc/pod2mdoc.1 2014/04/07 11:46:03 1.13 +++ pod2mdoc/pod2mdoc.1 2015/05/19 20:10:40 1.18 @@ -1,4 +1,4 @@ -.\" $Id: pod2mdoc.1,v 1.13 2014/04/07 11:46:03 kristaps Exp $ +.\" $Id: pod2mdoc.1,v 1.18 2015/05/19 20:10:40 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 7 2014 $ +.Dd $Mdocdate: May 19 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, @@ -107,6 +120,17 @@ lines are found at the start of a verbatim paragraph, with .Sq \&In . .It +Other lines starting with +.Sq # +are rendered with +.Sq \&Fd . +.It +Function declarations are rendered with +.Sq \&Ft , +.Sq \&Fo , +and +.Sq \&Fa . +.It An initial .Li B<> format code is rendered as @@ -141,7 +165,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 @@ -192,6 +216,29 @@ 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 . +If they don't match, they are marked up with +.Sq \&Xr . +Words not followed by +.Qq Pq +that match preprocessor macros #define'd in the SYNOPSIS section +are marked up with +.Sq \&Dv . +.Pp +If the contents of a +.Li B<> +or +.Li I<> +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 @@ -235,8 +282,7 @@ 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