]> git.cameronkatri.com Git - mandoc.git/blob - mdocml.1
Putting md_run and friends into libmdocml (needs work to be useful).
[mandoc.git] / 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 22 2008 $
7 .Dt mdocml 1
8 .Os
9 .Sh NAME
10 .Nm mdocml
11 .Nd compile manpage source into mark-up language
12 .Sh SYNOPSIS
13 .Nm mdocml
14 .Op Fl o Ar outfile
15 .Op Ar infile
16 .Sh DESCRIPTION
17 The
18 .Nm
19 utility compiles manpage source into a mark-up language. Its arguments
20 are as follows:
21 .Bl -tag -width "-o outfile"
22 .It Fl o Ar outfile
23 Place output in
24 .Ar outfile ,
25 which may be
26 .Qq -
27 for standard output. The default is standard output.
28 .It Ar infile
29 Read input from
30 .Ar infile ,
31 which may be
32 .Qq -
33 for standard input. The default is standard input.
34 .El
35 .\" The following requests should be uncommented and used where appropriate.
36 .\" This next request is for sections 2, 3, and 9 function return values only.
37 .\" .Sh RETURN VALUES
38 .\" This next request is for sections 1, 6, 7 & 8 only.
39 .\" .Sh ENVIRONMENT
40 .\" .Sh FILES
41 .\" .Sh EXAMPLES
42 .\" This next request is for sections 1, 4, 6, and 8 only.
43 .\" .Sh DIAGNOSTICS
44 .\" The next request is for sections 2, 3, and 9 error and signal handling only.
45 .\" .Sh ERRORS
46 .\" .Sh SEE ALSO
47 .\" .Xr foobar 1
48 .\" .Sh STANDARDS
49 .\" .Sh HISTORY
50 .\" .Sh AUTHORS
51 .\" .Sh CAVEATS
52 .\" .Sh BUGS