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

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

version 1.4, 2014/03/23 23:23:38 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 89  or, if the input file suffix is
Line 89  or, if the input file suffix is
 uses  uses
 .Ar 3p .  .Ar 3p .
 .El  .El
   .Ss Smarts
   Since
   .Xr mdoc 7
   is semantic and
   .Xr perlpod 1
   is not,
   .Nm
   tries to figure out semantic context for some terms.
   Specifically, within each paragraph of the SYNOPSIS section, the
   following occur:
   .Bl -bullet
   .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
   .Li B<>
   format code is rendered as
   .Sq \&Nm .
   .It
   Subsequent
   .Li B<>
   format codes are rendered as
   .Sq \&Ar .
   However, if the leading character of a
   .Li B<>
   format code is
   .Sq - ,
   it is rendered as
   .Sq \&Fl .
   Subsequent space-separated terms without leading hyphens, e.g.,
   .Li B<-foo bar> ,
   are rendered as
   .Sq \&Ar .
   .It
   Matching
   .Li \&[
   and
   .Li \&]
   pairs are rendered as
   .Sq \&Oo
   and
   .Sq \&Oc .
   .El
   .Pp
   Thus, the input
   .Li B<foo> [B<-bar baz>]
   is rendered as follows:
   .Bd -literal
   \&.Nm foo
   \&.Oo
   \&.Fl bar Ar baz
   \&.Oc
   .Ed
   .Pp
   In the NAME section,
   .Sq \&Nm
   and
   .Sq \&Nd
   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.
   Thus,
   .Li B<foo> - bar
   will be rendered as follows:
   .Bd -literal
   \&.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<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
   To pipe a POD document
   .Pa foo.pod
   through
   .Xr mandoc 1
   and a pager:
   .Pp
   .Dl % pod2mdoc foo.pod | mandoc | more
 .Sh COMPATIBILITY  .Sh COMPATIBILITY
 If  If
 .Fl s  .Fl s
Line 99  is not specified and the suffix for
Line 215  is not specified and the suffix for
 is  is
 .Li .pm ,  .Li .pm ,
 .Nm  .Nm
 infers a manual section of 3p, not 3, as stipulated in  infers a manual section of 3p, not 3 as stipulated in
 .Xr perlpod 1 .  .Xr perlpod 1 .
   Furthermore, all links in the format of
   .Li L<Foo::Bar>
   are assumed to be in section 3p.
 .Pp  .Pp
 If  If
 .Nm  .Nm
Line 116  However, it will do so silently and not, as
Line 235  However, it will do so silently and not, as
 does, append a POD ERRORS section in the output manpage saying so.  does, append a POD ERRORS section in the output manpage saying so.
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr perlpod 1 ,  .Xr perlpod 1 ,
 .Xr pod2man 1  .Xr pod2man 1 ,
   .Xr mdoc 7
 .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 136  HTML names and numbers are silently discarded.
Line 255  HTML names and numbers are silently discarded.
 .Pp  .Pp
 Although most white-space requests in character encodings are properly  Although most white-space requests in character encodings are properly
 carried to output, adjacent character escapes with the specific  carried to output, adjacent character escapes with the specific
 whitespace sequence  whitespace sequence
 .Qq Li "B<2>B< 3>"  .Qq Li "B<2>B< 3>"
 will cause the second space to be lost.  will cause the second space to be lost.
 .Pp  .Pp
 The  The
 .Li S<>  .Li S<>
 escape is discarded.  escape is discarded.
   .Pp
   Unless solely a section link, the text and section parts of
   .Li L<text|link/section>
   are discarded.
Legend:
Removed from v.1.4  
changed lines
  Added in v.1.14
CVSweb