blob: 6e4ebc0256c72e2bb4185ac96c18285642801e69 (
plain) (
tree)
|
|
.\" $OpenBSD: mdoc.template,v 1.10 2007/05/31 22:10:19 jmc Exp $
.\"
.\" The following requests are required for all man pages.
.\"
.\" Remove `\&' from the line below.
.Dd $Mdocdate$
.Dt mdocml 1
.Os
.\"
.Op foo
.Sh NAME
.Nm mdocml
.Nd compile manpage source into mark-up language
.\"
.Sh SYNOPSIS
.Nm mdocml
.Op Fl o Ar outfile
.Op Ar infile
.\"
.Sh DESCRIPTION
The
.Nm
utility compiles manpage source into a mark-up language. Its arguments
are as follows:
.Bl -tag -width "-o outfile"
.It Fl o Ar outfile
Place output in
.Ar outfile ,
which may be
.Qq -
for standard output. The default is standard output.
.It Ar infile
Read input from
.Ar infile ,
which may be
.Qq -
for standard input. The default is standard input.
.El
.\" The following requests should be uncommented and used where appropriate.
.\" This next request is for sections 2, 3, and 9 function return values only.
.\" .Sh RETURN VALUES
.\" This next request is for sections 1, 6, 7 & 8 only.
.\" .Sh ENVIRONMENT
.\" .Sh FILES
.\" .Sh EXAMPLES
.\" This next request is for sections 1, 4, 6, and 8 only.
.\" .Sh DIAGNOSTICS
.\" The next request is for sections 2, 3, and 9 error and signal handling only.
.\" .Sh ERRORS
.Sh SEE ALSO
.Xr groff 1 ,
.Xr mdoc.samples 7 ,
.Xr mdoc 7
.\" .Sh STANDARDS
.\" .Sh HISTORY
.Sh AUTHORS
The
.Nm
utility was written by
.An Kristaps Dzonsons Aq kristaps@kth.se .
.\"
.Sh CAVEATS
The
.Nm
engine doesn't understand
.Sq \&Xo
and
.Sq \&Xc
troff macros.
.Pp
.Em All
macro arguments may be quoted, instead of only some.
.\" .Sh BUGS
|
