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

Diff for /mandoc/Attic/mdocml.1 between version 1.6 and 1.28

version 1.6, 2008/11/27 17:27:50 version 1.28, 2009/01/16 15:58:50
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
 .\"  .\"
 .Op foo  
 .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 o Ar outfile  .Op Fl W Ns Ar err...
 .Op Ar infile  .Op Ar infile
 .\"  .\"
 .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 validate and parse mdoc-macro documents.  Arguments follow:
 .It Fl o Ar outfile  .Bl -tag -width "\-Werr... "
 Place output in  .It Fl W Ns Ar err...
 .Ar outfile ,  Print warning messages.  May be set to
 which may be  .Fl W Ns Ar all
 .Qq \-  for all warnings,
 for standard output.  The default is standard output.  .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 .
   .It Fl v
   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 standard input.  The default is standard input.  for stdin.
 .It Fl W  
 Print warnings.  
 .El  .El
 .\" 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.  Parsing and validation rules are drawn entirely from the
 .\" .Sh RETURN VALUES  .Xr mdoc 7
 .\" This next request is for sections 1, 6, 7 & 8 only.  and
 .\" .Sh ENVIRONMENT  .Xr mdoc.samples 7
 .\" .Sh FILES  manuals.
 .\" .Sh EXAMPLES  .Pp
 .\" This next request is for sections 1, 4, 6, and 8 only.  By default,
 .\" .Sh DIAGNOSTICS  .Nm
 .\" The next request is for sections 2, 3, and 9 error and signal handling only.  reads from stdin, writes messages to stdout, and writes errors and
 .\" .Sh ERRORS  warnings to stderr.
   .Pp
   .Ex -std mdocml
   .Pp
   .Nm
   is
   .Ud
   .\"
   .Sh EXAMPLES
   To validate this manual page:
   .Pp
   .D1 % mdocml \-Wall,error mdocml.1
   .\"
 .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
Line 63  utility was written by 
Line 80  utility was written by 
 .An Kristaps Dzonsons Aq kristaps@kth.se .  .An Kristaps Dzonsons Aq kristaps@kth.se .
 .\"  .\"
 .Sh CAVEATS  .Sh CAVEATS
 The  The most glaring short-coming of
 .Nm  .Nm
 engine doesn't understand  is that it doesn't yet support the
 .Sq \&Xo  
 and  
 .Sq \&Xc  .Sq \&Xc
 troff macros.  and
 .Pp  .Sq \&Xo
 .Em All  macros when used to extend the line arguments to
 macro arguments may be quoted, instead of only some.  .Sq \&It ;
   in effect, trampling the body section.  We note that this is explicitly
   discouraged in
   .Xr mdoc.samples 7 ,
   but in practice used quite often.
 .\" .Sh BUGS  .\" .Sh BUGS
Legend:
Removed from v.1.6  
changed lines
  Added in v.1.28
CVSweb