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

Diff for /mandoc/Attic/mdocml.1 between version 1.14 and 1.30

version 1.14, 2008/12/02 00:10:37 version 1.30, 2009/01/20 15:05:01
Line 5 
Line 5 
 .\"  .\"
 .Sh NAME  .Sh NAME
 .Nm mdocml  .Nm mdocml
 .Nd compile manpage source into mark-up language  .Nd mdoc macro compiler
 .\"  .\"
 .Sh SYNOPSIS  .Sh SYNOPSIS
 .Nm mdocml  .Nm mdocml
 .Op Fl W  .Op Fl v
 .Op Fl f Ar filter  .Op Fl W Ns Ar err...
 .Op Fl o Ar outfile  
 .Op Ar infile  .Op Ar infile
 .\"  .\"
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
 .Nm  .Nm
 utility parses mdoc formatted manual source and passes results into an  utility interfaces the
 output filter.  The only current output filter is  .Xr mdoc 3
 .Ar xml ,  library to scan, parse and validate mdoc-macro documents.  Arguments
 the default.  The arguments are as follows:  follow:
 .Bl -tag -width "\-o outfile"  .Bl -tag -width "\-Werr... "
 .It Fl f Ar filter  .It Fl W Ns Ar err...
 The output filter name.  Print warning messages.  May be set to
 .It Fl o Ar outfile  .Fl W Ns Ar all
 Write output to  for all warnings,
 .Ar outfile ,  .Ar compat
 which may be  for groff/troff-compatibility warnings, or
 .Qq \-  .Ar syntax
 for stdout.  for syntax warnings.  If
 .It Fl W  .Fl W Ns Ar error
 Print warnings to stderr.  is specified, warnings are considered errors and cause utility
   termination.  Multiple
   .Fl W
   arguments may be comma-separated, such as
   .Fl W Ns Ar error,all .
   .It Fl v
   Print verbose parsing output.
 .It Ar infile  .It Ar infile
 Read input from  Read input from
 .Ar infile ,  .Ar infile ,
 which may be  which may be
 .Qq \-  .Dq \-
 for stdin.  for stdin.
 .El  .El
 .Pp  .Pp
   Parsing and validation rules are drawn entirely from the
   .Xr mdoc 7
   and
   .Xr mdoc.samples 7
   manuals.
   .Pp
 By default,  By default,
 .Nm  .Nm
 reads from stdin and writes to stdout using the xml filter.  reads from stdin, writes messages to stdout, and writes errors and
   warnings to stderr.
   .Pp
   .Ex -std mdocml
   .Pp
   .Nm
   is
   .Ud
   .\"
   .Sh EXAMPLES
   To validate this manual page:
   .Pp
   .D1 % mdocml \-Wall,error mdocml.1
 .\"  .\"
 .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  
 or  
 .Qq inline ,  
 corresponding to the display mode of a node.  The document root is  
 always the  
 .Qq mdoc  
 element, in the default namespace.  
 .\" This next request is for sections 1, 6, 7 & 8 only.  
 .\" .Sh ENVIRONMENT  
 .\"  
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr groff 1 ,  .Xr groff 1 ,
 .Xr mdoc.samples 7 ,  .Xr mdoc.samples 7 ,
 .Xr mdoc 7  .Xr mdoc 7 ,
   .Xr mdoc 3
 .\" .Sh STANDARDS  .\" .Sh STANDARDS
 .\" .Sh HISTORY  .\" .Sh HISTORY
 .Sh AUTHORS  .Sh AUTHORS
 The  The
 .Nm  .Nm
 utility was written by  utility was written by
 .An Em Kristaps Dzonsons Aq kristaps@kth.se .  .An Kristaps Dzonsons Aq kristaps@kth.se .
 .\"  .\"
 .Sh CAVEATS  .Sh CAVEATS
 Most caveats of  See
 .Nm  .Xr mdoc 3
 stem from ambiguities in  for a list of bugs, caveats, and incomplete macros.
 .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 the  
 .Sq \&Xo ,  
 .Sq \&Xc ,  
 .Sq \&No ,  
 .Sq \&Db ,  
 .Sq \&Sm ,  
 .Sq \&Xc ,  
 and  
 .Sq \&Xo  
 mdoc macros.  
 .It  
 All macro arguments may be quoted, instead of only some.  
 .It  
 Blank lines raise errors.  
 .It  
 If terminating punctuation is found, then  
 .Em all  
 remaining tokens are flushed after line scope is closed, not just the  
 last one.  
 .El  
 .Pp  
 The roff engine in  
 .Nm  
 produces text in-line; thus, output may already be partially written by  
 the time an error is encountered.  
 .\" .Sh BUGS  .\" .Sh BUGS
Legend:
Removed from v.1.14  
changed lines
  Added in v.1.30
CVSweb