pod2mdoc/pod2mdoc.1 - diff

Return to pod2mdoc.1 CVS log

Up to [cvsweb.bsd.lv] / pod2mdoc

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

-version 1.6, 2014/03/24 01:43:42
+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

CVSweb