Annotation of mandoc/mdocml.1, Revision 1.12
1.1 kristaps 1: .\"
1.2 kristaps 2: .Dd $Mdocdate$
3: .Dt mdocml 1
1.1 kristaps 4: .Os
1.3 kristaps 5: .\"
1.1 kristaps 6: .Sh NAME
1.2 kristaps 7: .Nm mdocml
8: .Nd compile manpage source into mark-up language
1.3 kristaps 9: .\"
1.1 kristaps 10: .Sh SYNOPSIS
1.2 kristaps 11: .Nm mdocml
1.10 kristaps 12: .Op Fl W
1.7 kristaps 13: .Op Fl f Ar filter
1.2 kristaps 14: .Op Fl o Ar outfile
15: .Op Ar infile
1.3 kristaps 16: .\"
1.1 kristaps 17: .Sh DESCRIPTION
18: The
19: .Nm
1.7 kristaps 20: utility parses
21: .Xr mdoc
1.12 ! kristaps 22: formatted manual source and passes results into an output filter. The
! 23: only current output filter is
1.10 kristaps 24: .Ar xml ,
1.7 kristaps 25: the default. The arguments are as follows:
1.10 kristaps 26: .Bl -tag -width "\-o outfile"
27: .It Fl f Ar filter
1.12 ! kristaps 28: The output filter name.
1.10 kristaps 29: .It Fl o Ar outfile
1.12 ! kristaps 30: Write output to
1.2 kristaps 31: .Ar outfile ,
32: which may be
1.6 kristaps 33: .Qq \-
1.12 ! kristaps 34: for stdout.
1.10 kristaps 35: .It Fl W
1.12 ! kristaps 36: Print warnings to stderr.
1.2 kristaps 37: .It Ar infile
38: Read input from
39: .Ar infile ,
40: which may be
1.6 kristaps 41: .Qq \-
1.12 ! kristaps 42: for stdin.
1.2 kristaps 43: .El
1.12 ! kristaps 44: .Pp
! 45: By default,
! 46: .Nm
! 47: reads from stdin and writes to stdout using the xml filter.
! 48: .\"
1.10 kristaps 49: .Ss XML Filter
50: The XML filter, specified by
51: .Fl f Ar xml ,
52: is the default filter. It creates an XML document where element names are
53: their respective roff macro names. Each element name has an associated
54: namespace, which is one of
1.12 ! kristaps 55: .Qq block
! 56: or
1.10 kristaps 57: .Qq inline ,
1.12 ! kristaps 58: corresponding to the display mode of a node. The document root is
! 59: always the
! 60: .Qq mdoc
! 61: element, in the default namespace.
1.1 kristaps 62: .\" This next request is for sections 1, 6, 7 & 8 only.
63: .\" .Sh ENVIRONMENT
1.12 ! kristaps 64: .\"
1.3 kristaps 65: .Sh SEE ALSO
66: .Xr groff 1 ,
67: .Xr mdoc.samples 7 ,
68: .Xr mdoc 7
1.1 kristaps 69: .\" .Sh STANDARDS
70: .\" .Sh HISTORY
1.3 kristaps 71: .Sh AUTHORS
72: The
73: .Nm
74: utility was written by
1.9 kristaps 75: .An Em Kristaps Dzonsons Aq kristaps@kth.se .
1.3 kristaps 76: .\"
77: .Sh CAVEATS
1.7 kristaps 78: Most caveats of
1.3 kristaps 79: .Nm
1.7 kristaps 80: stem from ambiguities in
81: .Xr mdoc 7
82: or the necessary limitations of converting an ad hoc language into
83: structured ones:
84: .Bl -enum -compact -offset indent
85: .It
1.12 ! kristaps 86: The engine doesn't understand the
! 87: .Sq \&Xo ,
! 88: .Sq \&Xc ,
! 89: .Sq \&Ns ,
! 90: .Sq \&No ,
! 91: .Sq \&Db ,
! 92: .Sq \&Sm ,
! 93: .Sq \&Xc ,
! 94: and
1.3 kristaps 95: .Sq \&Xo
1.12 ! kristaps 96: mdoc macros.
1.7 kristaps 97: .It
98: All macro arguments may be quoted, instead of only some.
99: .It
1.12 ! kristaps 100: Blank lines raise errors.
1.7 kristaps 101: .It
1.9 kristaps 102: If terminating punctuation is found, then
103: .Em all
104: remaining tokens are flushed after line scope is closed, not just the
105: last one.
1.7 kristaps 106: .El
1.1 kristaps 107: .\" .Sh BUGS
CVSweb