Annotation of mandoc/mdocml.1, Revision 1.5
1.1 kristaps 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.
1.2 kristaps 6: .Dd $Mdocdate$
7: .Dt mdocml 1
1.1 kristaps 8: .Os
1.3 kristaps 9: .\"
1.4 kristaps 10: .Op foo
1.1 kristaps 11: .Sh NAME
1.2 kristaps 12: .Nm mdocml
13: .Nd compile manpage source into mark-up language
1.3 kristaps 14: .\"
1.1 kristaps 15: .Sh SYNOPSIS
1.2 kristaps 16: .Nm mdocml
17: .Op Fl o Ar outfile
18: .Op Ar infile
1.3 kristaps 19: .\"
1.1 kristaps 20: .Sh DESCRIPTION
21: The
22: .Nm
1.2 kristaps 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
1.1 kristaps 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
1.3 kristaps 50: .Sh SEE ALSO
51: .Xr groff 1 ,
52: .Xr mdoc.samples 7 ,
53: .Xr mdoc 7
1.1 kristaps 54: .\" .Sh STANDARDS
55: .\" .Sh HISTORY
1.3 kristaps 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.
1.5 ! kristaps 70: .Pp
! 71: .Em All
! 72: macro arguments may be quoted, instead of only some.
1.1 kristaps 73: .\" .Sh BUGS
CVSweb