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

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

version 1.1, 2014/03/20 15:07:56 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 89  or, if the input file suffix is
Line 102  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
   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
   .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 .
   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
   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 98  is not specified and the suffix for
Line 256  is not specified and the suffix for
 .Ar file  .Ar file
 is  is
 .Li .pm ,  .Li .pm ,
 infer a manual section of 3p, not 3.  .Nm
 .Sh SEE ALSO  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
   If
   .Nm
   encounters an
   .Li =item
   without the necessary
   .Li =over ,
   it will pretend that a prior
   .Li =over
   was invoked.
   However, it will do so silently and not, as
 .Xr pod2man 1  .Xr pod2man 1
   does, append a POD ERRORS section in the output manpage saying so.
   .Sh SEE ALSO
   .Xr perlpod 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 translates poorly to  By way of being a presentational language, POD is not well-represented
   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
 does not currently support the following:  only supports the named
 .Bl -enum  .Li E<xxx>
 .It  escapes.
 any sort of link  HTML names and numbers are silently discarded.
 .It  .Pp
 escapes that are htmlnames or numbers  Although most white-space requests in character encodings are properly
 .It  carried to output, adjacent character escapes with the specific
 escape codes with alternative delimiters  whitespace sequence
 .It  .Qq Li "B<2>B< 3>"
 probably many other things  will cause the second space to be lost.
 .El  .Pp
   The
   .Li S<>
   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.1  
changed lines
  Added in v.1.18
CVSweb