mdocml.1

   1 .\"     $OpenBSD: mdoc.template,v 1.10 2007/05/31 22:10:19 jmc Exp $
   2 .\"
   3 .\" The following requests are required for all man pages.
   4 .\"
   5 .\" Remove `\&' from the line below.
   6 .Dd $Mdocdate: November 27 2008 $
   7 .Dt mdocml 1
   8 .Os
   9 .\"
  10 .Op foo
  11 .Sh NAME
  12 .Nm mdocml
  13 .Nd compile manpage source into mark-up language
  14 .\"
  15 .Sh SYNOPSIS
  16 .Nm mdocml
  17 .Op Fl W
  18 .Op Fl o Ar outfile
  19 .Op Ar infile
  20 .\"
  21 .Sh DESCRIPTION
  22 The
  23 .Nm
  24 utility compiles manpage source into a mark-up language.  Its arguments
  25 are as follows:
  26 .Bl -tag -width "\-o outfile"
  27 .It Fl o Ar outfile
  28 Place output in
  29 .Ar outfile ,
  30 which may be
  31 .Qq \-
  32 for standard output.  The default is standard output.
  33 .It Ar infile
  34 Read input from
  35 .Ar infile ,
  36 which may be
  37 .Qq \-
  38 for standard input.  The default is standard input.
  39 .It Fl W
  40 Print warnings.
  41 .El
  42 .\" The following requests should be uncommented and used where appropriate.
  43 .\" This next request is for sections 2, 3, and 9 function return values only.
  44 .\" .Sh RETURN VALUES
  45 .\" This next request is for sections 1, 6, 7 & 8 only.
  46 .\" .Sh ENVIRONMENT
  47 .\" .Sh FILES
  48 .\" .Sh EXAMPLES
  49 .\" This next request is for sections 1, 4, 6, and 8 only.
  50 .\" .Sh DIAGNOSTICS
  51 .\" The next request is for sections 2, 3, and 9 error and signal handling only.
  52 .\" .Sh ERRORS
  53 .Sh SEE ALSO
  54 .Xr groff 1 ,
  55 .Xr mdoc.samples 7 ,
  56 .Xr mdoc 7
  57 .\" .Sh STANDARDS
  58 .\" .Sh HISTORY
  59 .Sh AUTHORS
  60 The
  61 .Nm
  62 utility was written by
  63 .An Kristaps Dzonsons Aq kristaps@kth.se .
  64 .\"
  65 .Sh CAVEATS
  66 The
  67 .Nm
  68 engine doesn't understand
  69 .Sq \&Xo
  70 and
  71 .Sq \&Xc
  72 troff macros.
  73 .Pp
  74 .Em All
  75 macro arguments may be quoted, instead of only some.
  76 .\" .Sh BUGS