[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.27

version 1.10, 2008/11/30 21:41:35 version 1.27, 2009/01/16 14:04:26
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
 .\"  .\"
 .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  utility interfaces the
 .Xr mdoc  .Xr mdoc 3
 formatted manual source and passes results into the output filter  library to validate and parse mdoc-macro documents.  Arguments follow:
 dictated by  .Bl -tag -width "\-Werr... "
 .Fl f Ar filter .  .It Fl W Ns Ar err...
 The only current output filter is  Print warning messages.  May be set to
 .Ar xml ,  .Fl W Ns Ar all
 the default.  The arguments are as follows:  for all warnings,
 .Bl -tag -width "\-o outfile"  .Ar compat
 .It Fl f Ar filter  for groff/troff-compatibility warnings, or
 The output filter name, which defaults to  .Ar syntax
 .Ar xml .  for syntax warnings.  If
 .It Fl o Ar outfile  .Fl W Ns Ar error
 Place output in  is specified, warnings are considered errors and cause utility
 .Ar outfile ,  termination.  Multiple
 which may be  .Fl W
 .Qq \-  arguments may be comma-separated, such as
 for stdout.  The default is stdout.  .Fl W Ns Ar error,all .
 .It Fl W  .It Fl v
 Print compiler warnings to stderr.  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.  The default is stdin.  for stdin.
 .El  .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  .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>  .Pp
     <inline:Nd>example text</inline:Nd>  By default,
   </block:Sh>  .Nm
 </block:mdoc>  reads from stdin, writes messages to stdout, and writes errors and
 .Ed  warnings to stderr.
 .\" The following requests should be uncommented and used where appropriate.  .Pp
 .\" This next request is for sections 2, 3, and 9 function return values only.  .Ex -std mdocml
 .\" .Sh RETURN VALUES  .\"
 .\" This next request is for sections 1, 6, 7 & 8 only.  .Sh EXAMPLES
 .\" .Sh ENVIRONMENT  To validate this manual page:
 .\" .Sh FILES  .Pp
 .\" .Sh EXAMPLES  .D1 % mdocml \-Wall,error mdocml.1
 .\" This next request is for sections 1, 4, 6, and 8 only.  .\"
 .\" .Sh DIAGNOSTICS  
 .\" The next request is for sections 2, 3, and 9 error and signal handling only.  
 .\" .Sh ERRORS  
 .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  The most glaring short-coming of
 .Nm  .Nm
 stem from ambiguities in  is that it doesn't yet support the
 .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  .Sq \&Xc
 troff macros.  and
 .It  .Sq \&Xo
 All macro arguments may be quoted, instead of only some.  macros when used to extend the line arguments to
 .It  .Sq \&It ;
 Blank lines raise warnings.  in effect, trampling the body section.  We note that this is explicitly
 .It  discouraged in
 If terminating punctuation is found, then  .Xr mdoc.samples 7 ,
 .Em all  but in practice used quite often.
 remaining tokens are flushed after line scope is closed, not just the  
 last one.  
 .El  
 .\" .Sh BUGS  .\" .Sh BUGS
Legend:
Removed from v.1.10  
changed lines
  Added in v.1.27
CVSweb