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

Diff for /mandoc/Attic/mdocml.1 between version 1.12 and 1.32

version 1.12, 2008/12/01 09:25:18 version 1.32, 2009/02/21 14:56:57
Line 2 
Line 2 
 .Dd $Mdocdate$  .Dd $Mdocdate$
 .Dt mdocml 1  .Dt mdocml 1
 .Os  .Os
 .\"  .\" SECTION
 .Sh NAME  .Sh NAME
 .Nm mdocml  .Nm mdocml
 .Nd compile manpage source into mark-up language  .Nd mdoc macro compiler
 .\"  .\" SECTION
 .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
 .\"  .\" SECTION
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
 .Nm  .Nm
 utility parses  utility interfaces the
 .Xr mdoc  .Xr mdoc 3
 formatted manual source and passes results into an output filter.  The  library to scan, parse and validate mdoc-macro documents.  Arguments
 only current output filter is  follow:
 .Ar xml ,  .Bl -tag -width "\-Werr... "
 the default.  The arguments are as follows:  .\" ITEM
 .Bl -tag -width "\-o outfile"  .It Fl W Ns Ar err...
 .It Fl f Ar filter  Print warning messages.  May be set to
 The output filter name.  .Fl W Ns Ar all
 .It Fl o Ar outfile  for all warnings,
 Write output to  .Ar compat
 .Ar outfile ,  for groff/troff-compatibility warnings, or
 which may be  .Ar syntax
 .Qq \-  for syntax warnings.  If
 for stdout.  .Fl W Ns Ar error
 .It Fl W  is specified, warnings are considered errors and cause utility
 Print warnings to stderr.  termination.  Multiple
   .Fl W
   arguments may be comma-separated, such as
   .Fl W Ns Ar error,all .
   .\" ITEM
   .It Fl v
   Print verbose parsing output.
   .\" ITEM
 .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
   .\" PARAGRAPH
 .Pp  .Pp
   Parsing and validation rules are drawn entirely from the
   .Xr mdoc 7
   and
   .Xr mdoc.samples 7
   manuals.
   .\" PARAGRAPH
   .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.
 .Ss XML Filter  .\" PARAGRAPH
 The XML filter, specified by  .Pp
 .Fl f Ar xml ,  .Ex -std mdocml
 is the default filter.  It creates an XML document where element names are  .\" PARAGRAPH
 their respective roff macro names.  Each element name has an associated  .Pp
 namespace, which is one of  .Nm
 .Qq block  is
 or  .Ud
 .Qq inline ,  .\" SECTION
 corresponding to the display mode of a node.  The document root is  .Sh EXAMPLES
 always the  To validate this manual page:
 .Qq mdoc  .\" PARAGRAPH
 element, in the default namespace.  .Pp
 .\" This next request is for sections 1, 6, 7 & 8 only.  .D1 % mdocml \-Wall,error mdocml.1
 .\" .Sh ENVIRONMENT  .\" SECTION
 .\"  
 .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 ,
 .\" .Sh STANDARDS  .Xr mdoc 3
 .\" .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 .
 .\"  .\" SECTION
 .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 \&Ns ,  
 .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  
 .\" .Sh BUGS  
Legend:
Removed from v.1.12  
changed lines
  Added in v.1.32
CVSweb