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

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

version 1.8, 2008/11/30 12:41:45 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 vW  .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 validate ,  .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 Sq Fl o Ar outfile ,  for the parse tree or
 Place output in  .Ar term
 .Ar outfile ,  for a terminal-encoded, formatted manual page.
 which may be  .\" ITEM
 .Qq \-  .It Fl v
 for standard output.  The default is standard output.  Print verbose parsing output.
   .\" ITEM
   .It Fl W Ns Ar err...
   Print warning messages.  May be set to
   .Fl W Ns Ar all
   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 standard input.  The default is standard input.  for stdin.
 .It Fl v  
 Print messages (output depends on filter).  
 .It Fl W  
 Print warnings (output depends on filter).  
 .El  .El
 .Ss Validate Filter  .\" PARAGRAPH
 The validate filter, specified by  .Pp
 .Fl f Ar validate ,  Parsing and validation rules are drawn entirely from the
 is the default filter.  It produces no output, so specifying  .Xr mdoc 7
 .Fl o Ar outfile  and
 results in an empty file.  .Xr mdoc.samples 7
 .Qq Op Op Fl a ) , Fl b ,  manuals.
 .Bf Em  .\" PARAGRAPH
 .Qq Op Op Fl a ) , Fl b ,  .Pp
 .Ef  By default,
 .\" The following requests should be uncommented and used where appropriate.  .Nm
 .\" This next request is for sections 2, 3, and 9 function return values only.  reads from stdin and only validates its input.
 .\" .Sh RETURN VALUES  .\" PARAGRAPH
 .\" This next request is for sections 1, 6, 7 & 8 only.  .Pp
 .\" .Sh ENVIRONMENT  .Ex -std mdocml
 .\" .Sh FILES  .\" PARAGRAPH
 .\" .Sh EXAMPLES  .Pp
 .\" This next request is for sections 1, 4, 6, and 8 only.  .Nm
 .\" .Sh DIAGNOSTICS  is
 .\" The next request is for sections 2, 3, and 9 error and signal handling only.  .Ud
 .\" .Sh ERRORS  .\" SECTION
   .Sh EXAMPLES
   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 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  
 Non-ascii characters may cause issues.  
 .El  
 .\" .Sh BUGS  
Legend:
Removed from v.1.8  
changed lines
  Added in v.1.33
CVSweb