mandoc/mdocml.1 - diff

Return to mdocml.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

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

-version 1.1, 2008/11/22 14:53:29
+version 1.33, 2009/02/21 15:34:46
 Line 1
 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
+ .\" SECTION
  .Sh NAME
- .Nm program
+ .Nm mdocml
- .Nd one line about what it does
+ .Nd mdoc macro compiler
+ .\" SECTION
  .Sh SYNOPSIS
- .\" For a program:  program [-abc] file ...
+ .Nm mdocml
- .Nm program
+ .Op Fl f Ns Ar filter
- .Op Fl abc
+ .Op Fl v
- .Ar
+ .Op Fl W Ns Ar err...
+ .Op Ar infile
+ .\" SECTION
  .Sh DESCRIPTION
  The
  .Nm
- utility processes files ...
+ utility interfaces the
- something
+ .Xr mdoc 3
- something.
+ library to scan, parse, validate and output mdoc-macro documents.
- .\" The following requests should be uncommented and used where appropriate.
+ Arguments follow:
- .\" This next request is for sections 2, 3, and 9 function return values only.
+ .Bl -tag -width "\-Werr... "
- .\" .Sh RETURN VALUES
+ .\" ITEM
- .\" This next request is for sections 1, 6, 7 & 8 only.
+ .It Fl f Ns Ar filter
- .\" .Sh ENVIRONMENT
+ Pipe the parsed syntax tree into an output filter.  May be either
- .\" .Sh FILES
+ .Ar tree
- .\" .Sh EXAMPLES
+ for the parse tree or
- .\" This next request is for sections 1, 4, 6, and 8 only.
+ .Ar term
- .\" .Sh DIAGNOSTICS
+ for a terminal-encoded, formatted manual page.
- .\" The next request is for sections 2, 3, and 9 error and signal handling only.
+ .\" ITEM
- .\" .Sh ERRORS
+ .It Fl v
- .\" .Sh SEE ALSO
+ Print verbose parsing output.
- .\" .Xr foobar 1
+ .\" ITEM
- .\" .Sh STANDARDS
+ .It Fl W Ns Ar err...
- .\" .Sh HISTORY
+ Print warning messages.  May be set to
- .\" .Sh AUTHORS
+ .Fl W Ns Ar all
- .\" .Sh CAVEATS
+ for all warnings,
- .\" .Sh BUGS
+ .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
+ Read input from
+ .Ar infile ,
+ which may be
+ .Dq \-
+ for stdin.
+ .El
+ .\" PARAGRAPH
+ .Pp
+ Parsing and validation rules are drawn entirely from the
+ .Xr mdoc 7
+ and
+ .Xr mdoc.samples 7
+ manuals.
+ .\" PARAGRAPH
+ .Pp
+ By default,
+ .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
+ .Xr groff 1 ,
+ .Xr mdoc.samples 7 ,
+ .Xr mdoc 7 ,
+ .Xr mdoc 3
+ .\"
+ .Sh AUTHORS
+ The
+ .Nm
+ utility was written by
+ .An Kristaps Dzonsons Aq kristaps@kth.se .
+ .\" SECTION
+ .Sh CAVEATS
+ See
+ .Xr mdoc 3
+ for a list of bugs, caveats, and incomplete macros.

CVSweb