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

Diff for /mandoc/Attic/mdocml.1 between version 1.1 and 1.10

version 1.1, 2008/11/22 14:53:29 version 1.10, 2008/11/30 21:41:35
Line 3 
Line 3 
 .\" The following requests are required for all man pages.  .\" The following requests are required for all man pages.
 .\"  .\"
 .\" Remove `\&' from the line below.  .\" Remove `\&' from the line below.
 .Dd $\&Mdocdate$  .Dd $Mdocdate$
 .Dt NAME SECTION#  .Dt mdocml 1
 .Os  .Os
   .\"
 .Sh NAME  .Sh NAME
 .Nm program  .Nm mdocml
 .Nd one line about what it does  .Nd compile manpage source into mark-up language
   .\"
 .Sh SYNOPSIS  .Sh SYNOPSIS
 .\" For a program:  program [-abc] file ...  .Nm mdocml
 .Nm program  .Op Fl W
 .Op Fl abc  .Op Fl f Ar filter
 .Ar  .Op Fl o Ar outfile
   .Op Ar infile
   .\"
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
 .Nm  .Nm
 utility processes files ...  utility parses
 something  .Xr mdoc
 something.  formatted manual source and passes results into the output filter
   dictated by
   .Fl f Ar filter .
   The only current output filter is
   .Ar xml ,
   the default.  The arguments are as follows:
   .Bl -tag -width "\-o outfile"
   .It Fl f Ar filter
   The output filter name, which defaults to
   .Ar xml .
   .It Fl o Ar outfile
   Place output in
   .Ar outfile ,
   which may be
   .Qq \-
   for stdout.  The default is stdout.
   .It Fl W
   Print compiler warnings to stderr.
   .It Ar infile
   Read input from
   .Ar infile ,
   which may be
   .Qq \-
   for stdin.  The default is stdin.
   .El
   .Ss XML Filter
   The XML filter, specified by
   .Fl f Ar xml ,
   is the default filter.  It creates an XML document where element names are
   their respective roff macro names.  Each element name has an associated
   namespace, which is one of
   .Qq block ,
   .Qq inline ,
   or
   .Qq special ,
   corresponding to the display mode of a node.
   .Pp
   Sample output follows:
   .Bd -literal
   <?xml version="1.0" encoding="UTF-8"?>
   <block:mdoc>
     <block:Sh>
       <inline:Sh>NAME</inline:Sh> <inline:Nm>example</inline:Nm>
       <inline:Nd>example text</inline:Nd>
     </block:Sh>
   </block:mdoc>
   .Ed
 .\" The following requests should be uncommented and used where appropriate.  .\" The following requests should be uncommented and used where appropriate.
 .\" This next request is for sections 2, 3, and 9 function return values only.  .\" This next request is for sections 2, 3, and 9 function return values only.
 .\" .Sh RETURN VALUES  .\" .Sh RETURN VALUES
Line 31  something.
Line 81  something.
 .\" .Sh DIAGNOSTICS  .\" .Sh DIAGNOSTICS
 .\" The next request is for sections 2, 3, and 9 error and signal handling only.  .\" The next request is for sections 2, 3, and 9 error and signal handling only.
 .\" .Sh ERRORS  .\" .Sh ERRORS
 .\" .Sh SEE ALSO  .Sh SEE ALSO
 .\" .Xr foobar 1  .Xr groff 1 ,
   .Xr mdoc.samples 7 ,
   .Xr mdoc 7
 .\" .Sh STANDARDS  .\" .Sh STANDARDS
 .\" .Sh HISTORY  .\" .Sh HISTORY
 .\" .Sh AUTHORS  .Sh AUTHORS
 .\" .Sh CAVEATS  The
   .Nm
   utility was written by
   .An Em Kristaps Dzonsons Aq kristaps@kth.se .
   .\"
   .Sh CAVEATS
   Most caveats of
   .Nm
   stem from ambiguities in
   .Xr mdoc 7
   or the necessary limitations of converting an ad hoc language into
   structured ones:
   .Bl -enum -compact -offset indent
   .It
   The engine doesn't understand
   .Sq \&Xo
   and
   .Sq \&Xc
   troff macros.
   .It
   All macro arguments may be quoted, instead of only some.
   .It
   Blank lines raise warnings.
   .It
   If terminating punctuation is found, then
   .Em all
   remaining tokens are flushed after line scope is closed, not just the
   last one.
   .El
 .\" .Sh BUGS  .\" .Sh BUGS
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.10
CVSweb