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

Diff for /pod2mdoc/pod2mdoc.1 between version 1.8 and 1.14

version 1.8, 2014/04/02 20:32:41 version 1.14, 2015/02/13 00:44:16
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 64  uses the file modification date or the current date if
Line 64  uses the file modification date or the current date if
 standard input.  standard input.
 .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 77  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 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 135  Thus, the input
Line 141  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 158  will be rendered as follows:
Line 164  will be rendered as follows:
 .Ed  .Ed
 .Pp  .Pp
 Multiple names separated by a comma are properly handled.  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 .
   .Pp
   Words followed by
   .Qq Pq
   that match function names listed in the SYNOPSIS section are marked up with
   .Sq \&Fn .
 .Sh EXIT STATUS  .Sh EXIT STATUS
 .Ex -std  .Ex -std
 .Sh EXAMPLES  .Sh EXAMPLES
Line 201  does, append a POD ERRORS section in the output manpag
Line 240  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
Line 225  The
Line 263  The
 .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 .  
Legend:
Removed from v.1.8  
changed lines
  Added in v.1.14
CVSweb