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

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

version 1.1, 2008/11/22 14:53:29 version 1.28, 2009/01/16 15:58:50
Line 1 
Line 1 
 .\"     $OpenBSD$  
 .\"  .\"
 .\" The following requests are required for all man pages.  .Dd $Mdocdate$
 .\"  .Dt mdocml 1
 .\" Remove `\&' from the line below.  
 .Dd $\&Mdocdate$  
 .Dt NAME SECTION#  
 .Os  .Os
   .\"
 .Sh NAME  .Sh NAME
 .Nm program  .Nm mdocml
 .Nd one line about what it does  .Nd mdoc macro compiler
   .\"
 .Sh SYNOPSIS  .Sh SYNOPSIS
 .\" For a program:  program [-abc] file ...  .Nm mdocml
 .Nm program  .Op Fl v
 .Op Fl abc  .Op Fl W Ns Ar err...
 .Ar  .Op Ar infile
   .\"
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
 .Nm  .Nm
 utility processes files ...  utility interfaces the
 something  .Xr mdoc 3
 something.  library to validate and parse mdoc-macro documents.  Arguments follow:
 .\" The following requests should be uncommented and used where appropriate.  .Bl -tag -width "\-Werr... "
 .\" This next request is for sections 2, 3, and 9 function return values only.  .It Fl W Ns Ar err...
 .\" .Sh RETURN VALUES  Print warning messages.  May be set to
 .\" This next request is for sections 1, 6, 7 & 8 only.  .Fl W Ns Ar all
 .\" .Sh ENVIRONMENT  for all warnings,
 .\" .Sh FILES  .Ar compat
 .\" .Sh EXAMPLES  for groff/troff-compatibility warnings, or
 .\" This next request is for sections 1, 4, 6, and 8 only.  .Ar syntax
 .\" .Sh DIAGNOSTICS  for syntax warnings.  If
 .\" The next request is for sections 2, 3, and 9 error and signal handling only.  .Fl W Ns Ar error
 .\" .Sh ERRORS  is specified, warnings are considered errors and cause utility
 .\" .Sh SEE ALSO  termination.  Multiple
 .\" .Xr foobar 1  .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
   Read input from
   .Ar infile ,
   which may be
   .Dq \-
   for stdin.
   .El
   .Pp
   Parsing and validation rules are drawn entirely from the
   .Xr mdoc 7
   and
   .Xr mdoc.samples 7
   manuals.
   .Pp
   By default,
   .Nm
   reads from stdin, writes messages to stdout, and writes errors and
   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
   .Xr groff 1 ,
   .Xr mdoc.samples 7 ,
   .Xr mdoc 7 ,
   .Xr mdoc 3
 .\" .Sh STANDARDS  .\" .Sh STANDARDS
 .\" .Sh HISTORY  .\" .Sh HISTORY
 .\" .Sh AUTHORS  .Sh AUTHORS
 .\" .Sh CAVEATS  The
   .Nm
   utility was written by
   .An Kristaps Dzonsons Aq kristaps@kth.se .
   .\"
   .Sh CAVEATS
   The most glaring short-coming of
   .Nm
   is that it doesn't yet support the
   .Sq \&Xc
   and
   .Sq \&Xo
   macros when used to extend the line arguments to
   .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.1  
changed lines
  Added in v.1.28
CVSweb