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

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

version 1.3, 2008/11/25 12:14:02 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 o Ar outfile  .Op Fl f Ns Ar filter
   .Op Fl v
   .Op Fl W Ns Ar err...
 .Op Ar infile  .Op Ar infile
 .\"  .\" SECTION
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
 .Nm  .Nm
 utility compiles manpage source into a mark-up language.  Its arguments  utility interfaces the
 are as follows:  .Xr mdoc 3
 .Bl -tag -width "-o outfile"  library to scan, parse, validate and output mdoc-macro documents.
 .It Fl o Ar outfile  Arguments follow:
 Place output in  .Bl -tag -width "\-Werr... "
 .Ar outfile ,  .\" ITEM
 which may be  .It Fl f Ns Ar filter
 .Qq -  Pipe the parsed syntax tree into an output filter.  May be either
 for standard output.  The default is standard output.  .Ar tree
   for the parse tree or
   .Ar term
   for a terminal-encoded, formatted manual page.
   .\" ITEM
   .It Fl v
   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.
 .El  .El
 .\" 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  Parsing and validation rules are drawn entirely from the
 .\" This next request is for sections 1, 6, 7 & 8 only.  .Xr mdoc 7
 .\" .Sh ENVIRONMENT  and
 .\" .Sh FILES  .Xr mdoc.samples 7
 .\" .Sh EXAMPLES  manuals.
 .\" This next request is for sections 1, 4, 6, and 8 only.  .\" PARAGRAPH
 .\" .Sh DIAGNOSTICS  .Pp
 .\" The next request is for sections 2, 3, and 9 error and signal handling only.  By default,
 .\" .Sh ERRORS  .Nm
   reads from stdin and only validates its input.
   .\" PARAGRAPH
   .Pp
   .Ex -std mdocml
   .\" PARAGRAPH
   .Pp
   .Nm
   is
   .Ud
   .\" 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
 The  See
 .Nm  .Xr mdoc 3
 engine doesn't understand  for a list of bugs, caveats, and incomplete macros.
 .Sq \&Xo  
 and  
 .Sq \&Xc  
 troff macros.  
 .\" .Sh BUGS  
Legend:
Removed from v.1.3  
changed lines
  Added in v.1.33
CVSweb