[BACK]Return to pod2mdoc.1 CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / pod2mdoc

Diff for /pod2mdoc/pod2mdoc.1 between version 1.10 and 1.18

version 1.10, 2014/04/03 11:34:30 version 1.18, 2015/05/19 20:10:40
Line 50  For compatibility with
Line 50  For compatibility with
 Ignored.  Ignored.
 .It Fl d Ar date  .It Fl d Ar date
 Set the document date  Set the document date
 .Pq Sq Dd  .Pq Sq \&Dd
 to  to
 .Ar date  .Ar date
 .Po  .Po
Line 58  preferrably in
Line 58  preferrably in
 .Qq Month Day, Year  .Qq Month Day, Year
 format  format
 .Pc .  .Pc .
 If unspecified,  If unspecified or if
   .Ar date
   is the literal string
   .Cm Mdocdate ,
 .Nm  .Nm
 uses the file modification date or the current date if reading from  uses the file modification date or the current date if reading from
 standard input.  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  .It Fl n Ar title
 Set the document title  Set the document title
 .Pq Sq Dt  .Pq Sq \&Dt
 to  to
 .Ar title .  .Ar title .
 If unspecified,  If unspecified,
Line 77  if reading from standard input
Line 90  if reading from standard input
 .Pq you probably don't want that .  .Pq you probably don't want that .
 .It Fl s Ar section  .It Fl s Ar section
 Set the document section  Set the document section
 .Pq Sq Dt  .Pq Sq \&Dt
 to  to
 .Ar section .  .Ar section .
 If unspecified,  If unspecified,
Line 101  Specifically, within each paragraph of the SYNOPSIS se
Line 114  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
   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  An initial
 .Li B<>  .Li B<>
 format code is rendered as  format code is rendered as
Line 135  Thus, the input
Line 165  Thus, the input
 .Li B<foo> [B<-bar baz>]  .Li B<foo> [B<-bar baz>]
 is rendered as follows:  is rendered as follows:
 .Bd -literal  .Bd -literal
 \&.Nm foo  \&.Nm foo
 \&.Oo  \&.Oo
 \&.Fl bar Ar baz  \&.Fl bar Ar baz
 \&.Oc  \&.Oc
Line 186  If only a section appears, such as in
Line 216  If only a section appears, such as in
 .Li </section> ,  .Li </section> ,
 the link is rendered with  the link is rendered with
 .Sq \&Sx .  .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  .Sh EXIT STATUS
 .Ex -std  .Ex -std
 .Sh EXAMPLES  .Sh EXAMPLES
Line 229  does, append a POD ERRORS section in the output manpag
Line 282  does, append a POD ERRORS section in the output manpag
 .Sh AUTHORS  .Sh AUTHORS
 .Nm  .Nm
 was written by  was written by
 .Ar Kristaps Dzonsons ,  .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
 .Mt kristaps@bsd.lv .  
 .Sh CAVEATS  .Sh CAVEATS
 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
Legend:
Removed from v.1.10  
changed lines
  Added in v.1.18
CVSweb