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.7 and 1.31

-version 1.7, 2008/11/28 11:21:12
+version 1.31, 2009/02/20 23:35:36
 Line 1
 Line 1
 Line 1
- .\"     $OpenBSD$
  .\"
- .\" The following requests are required for all man pages.
- .\"
- .\" Remove `\&' from the line below.
  .Dd $Mdocdate$
  .Dt mdocml 1
  .Os
- .\"
+ .\" SECTION
  .Sh NAME
  .Nm mdocml
- .Nd compile manpage source into mark-up language
+ .Nd mdoc macro compiler
- .\"
+ .\" SECTION
  .Sh SYNOPSIS
  .Nm mdocml
- .Op Fl vW
+ .Op Fl v
- .Op Fl f Ar filter
+ .Op Fl W Ns Ar err...
- .Op Fl o Ar outfile
  .Op Ar infile
- .\"
+ .\" SECTION
  .Sh DESCRIPTION
  The
  .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 and validate mdoc-macro documents.  Arguments
- dictated by
+ follow:
- .Fl f Ar filter .
+ .Bl -tag -width "\-Werr... "
- The only current output filter is
+ .It Fl W Ns Ar err...
- .Ar validate ,
+ Print warning messages.  May be set to
- the default.  The arguments are as follows:
+ .Fl W Ns Ar all
- .Bl -tag -width "\-o outfile"
+ for all warnings,
- .It Fl o Ar outfile
+ .Ar compat
- Place output in
+ for groff/troff-compatibility warnings, or
- .Ar outfile ,
+ .Ar syntax
- which may be
+ for syntax warnings.  If
- .Qq \-
+ .Fl W Ns Ar error
- for standard output.  The default is standard output.
+ 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
  Read input from
  .Ar infile ,
  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
- .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
- .\" The following requests should be uncommented and used where appropriate.
+ manuals.
- .\" This next request is for sections 2, 3, and 9 function return values only.
+ .\" PARAGRAPH
- .\" .Sh RETURN VALUES
+ .Pp
- .\" This next request is for sections 1, 6, 7 & 8 only.
+ By default,
- .\" .Sh ENVIRONMENT
+ .Nm
- .\" .Sh FILES
+ reads from stdin, writes messages to stdout, and writes errors and
- .\" .Sh EXAMPLES
+ warnings to stderr.
- .\" 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.
+ .Ex -std mdocml
- .\" .Sh ERRORS
+ .\" 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 7 ,
- .\" .Sh STANDARDS
+ .Xr mdoc 3
- .\" .Sh HISTORY
+ .\"
  .Sh AUTHORS
  The
  .Nm
  utility was written by
  .An Kristaps Dzonsons Aq kristaps@kth.se .
- .\"
+ .\" SECTION
  .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

CVSweb