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 25 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 o Ar outfile
  18 .Op Ar infile
  19 .\"
  20 .Sh DESCRIPTION
  21 The
  22 .Nm
  23 utility compiles manpage source into a mark-up language.  Its arguments
  24 are as follows:
  25 .Bl -tag -width "-o outfile"
  26 .It Fl o Ar outfile
  27 Place output in
  28 .Ar outfile ,
  29 which may be
  30 .Qq -
  31 for standard output.  The default is standard output.
  32 .It Ar infile
  33 Read input from
  34 .Ar infile ,
  35 which may be
  36 .Qq -
  37 for standard input.  The default is standard input.
  38 .El
  39 .\" The following requests should be uncommented and used where appropriate.
  40 .\" This next request is for sections 2, 3, and 9 function return values only.
  41 .\" .Sh RETURN VALUES
  42 .\" This next request is for sections 1, 6, 7 & 8 only.
  43 .\" .Sh ENVIRONMENT
  44 .\" .Sh FILES
  45 .\" .Sh EXAMPLES
  46 .\" This next request is for sections 1, 4, 6, and 8 only.
  47 .\" .Sh DIAGNOSTICS
  48 .\" The next request is for sections 2, 3, and 9 error and signal handling only.
  49 .\" .Sh ERRORS
  50 .Sh SEE ALSO
  51 .Xr groff 1 ,
  52 .Xr mdoc.samples 7 ,
  53 .Xr mdoc 7
  54 .\" .Sh STANDARDS
  55 .\" .Sh HISTORY
  56 .Sh AUTHORS
  57 The
  58 .Nm
  59 utility was written by
  60 .An Kristaps Dzonsons Aq kristaps@kth.se .
  61 .\"
  62 .Sh CAVEATS
  63 The
  64 .Nm
  65 engine doesn't understand
  66 .Sq \&Xo
  67 and
  68 .Sq \&Xc
  69 troff macros.
  70 .\" .Sh BUGS