pod2mdoc/pod2mdoc.1 - diff

Return to pod2mdoc.1 CVS log

Up to [cvsweb.bsd.lv] / pod2mdoc

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

-version 1.1, 2014/03/20 15:07:56
+version 1.7, 2014/04/02 14:50:09
 Line 89  or, if the input file suffix is
 Line 89  or, if the input file suffix is
 Line 89  or, if the input file suffix is
  uses
  .Ar 3p .
  .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
+ 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, an
+ .Sq \&Nm
+ and
+ .Sq \&Nd
+ macro 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
  .Sh EXIT STATUS
  .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
  If
  .Fl s
-Line 98  is not specified and the suffix for
+Line 173  is not specified and the suffix for
 Line 98  is not specified and the suffix for
 Line 173  is not specified and the suffix for
  .Ar file
  is
  .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
+ 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
  .Nm
  was written by
  .Ar Kristaps Dzonsons ,
  .Mt kristaps@bsd.lv .
  .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 .
  Semantic content will be necessarily lost.
  .Pp
  .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
+ Lastly, only the
+ .Li L<Perl::Manpage>
+ and
+ .Li L<manpage(1)>
+ links are understood and properly rendered as
+ .Sq \&Xr .

CVSweb