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

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

version 1.10, 2008/11/30 21:41:35 version 1.33, 2009/02/21 15:34:46
Line 1 
Line 1 
 .\"     $OpenBSD$  
 .\"  .\"
 .\" The following requests are required for all man pages.  
 .\"  
 .\" Remove `\&' from the line below.  
 .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 f Ns Ar filter
 .Op Fl f Ar filter  .Op Fl v
 .Op Fl o Ar outfile  .Op Fl W Ns Ar err...
 .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 the output filter  library to scan, parse, validate and output mdoc-macro documents.
 dictated by  Arguments follow:
 .Fl f Ar filter .  .Bl -tag -width "\-Werr... "
 The only current output filter is  .\" ITEM
 .Ar xml ,  .It Fl f Ns Ar filter
 the default.  The arguments are as follows:  Pipe the parsed syntax tree into an output filter.  May be either
 .Bl -tag -width "\-o outfile"  .Ar tree
 .It Fl f Ar filter  for the parse tree or
 The output filter name, which defaults to  .Ar term
 .Ar xml .  for a terminal-encoded, formatted manual page.
 .It Fl o Ar outfile  .\" ITEM
 Place output in  .It Fl v
 .Ar outfile ,  Print verbose parsing output.
 which may be  .\" ITEM
 .Qq \-  .It Fl W Ns Ar err...
 for stdout.  The default is stdout.  Print warning messages.  May be set to
 .It Fl W  .Fl W Ns Ar all
 Print compiler warnings to stderr.  for all warnings,
   .Ar compat
   for groff/troff-compatibility warnings, or
   .Ar syntax
   for syntax warnings.  If
   .Fl W Ns Ar error
   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 .
   .\" 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.  The default is stdin.  for stdin.
 .El  .El
 .Ss XML Filter  .\" PARAGRAPH
 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  .Pp
 Sample output follows:  Parsing and validation rules are drawn entirely from the
 .Bd -literal  .Xr mdoc 7
 <?xml version="1.0" encoding="UTF-8"?>  and
 <block:mdoc>  .Xr mdoc.samples 7
   <block:Sh>  manuals.
     <inline:Sh>NAME</inline:Sh> <inline:Nm>example</inline:Nm>  .\" PARAGRAPH
     <inline:Nd>example text</inline:Nd>  .Pp
   </block:Sh>  By default,
 </block:mdoc>  .Nm
 .Ed  reads from stdin and only validates its input.
 .\" The following requests should be uncommented and used where appropriate.  .\" PARAGRAPH
 .\" This next request is for sections 2, 3, and 9 function return values only.  .Pp
 .\" .Sh RETURN VALUES  .Ex -std mdocml
 .\" This next request is for sections 1, 6, 7 & 8 only.  .\" PARAGRAPH
 .\" .Sh ENVIRONMENT  .Pp
 .\" .Sh FILES  .Nm
 .\" .Sh EXAMPLES  is
 .\" This next request is for sections 1, 4, 6, and 8 only.  .Ud
 .\" .Sh DIAGNOSTICS  .\" SECTION
 .\" The next request is for sections 2, 3, and 9 error and signal handling only.  .Sh EXAMPLES
 .\" .Sh ERRORS  To validate this manual page:
   .\" PARAGRAPH
   .Pp
   .D1 % mdocml \-Wall,error mdocml.1
   .\" 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  
 .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  
Legend:
Removed from v.1.10  
changed lines
  Added in v.1.33
CVSweb