version 1.1, 2008/11/22 14:53:29 |
version 1.5, 2008/11/27 13:29:44 |
|
|
.\" The following requests are required for all man pages. |
.\" The following requests are required for all man pages. |
.\" |
.\" |
.\" Remove `\&' from the line below. |
.\" Remove `\&' from the line below. |
.Dd $\&Mdocdate$ |
.Dd $Mdocdate$ |
.Dt NAME SECTION# |
.Dt mdocml 1 |
.Os |
.Os |
|
.\" |
|
.Op foo |
.Sh NAME |
.Sh NAME |
.Nm program |
.Nm mdocml |
.Nd one line about what it does |
.Nd compile manpage source into mark-up language |
|
.\" |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.\" For a program: program [-abc] file ... |
.Nm mdocml |
.Nm program |
.Op Fl o Ar outfile |
.Op Fl abc |
.Op Ar infile |
.Ar |
.\" |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
The |
The |
.Nm |
.Nm |
utility processes files ... |
utility compiles manpage source into a mark-up language. Its arguments |
something |
are as follows: |
something. |
.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. |
.\" The following requests should be uncommented and used where appropriate. |
.\" This next request is for sections 2, 3, and 9 function return values only. |
.\" This next request is for sections 2, 3, and 9 function return values only. |
.\" .Sh RETURN VALUES |
.\" .Sh RETURN VALUES |
|
|
.\" .Sh DIAGNOSTICS |
.\" .Sh DIAGNOSTICS |
.\" The next request is for sections 2, 3, and 9 error and signal handling only. |
.\" The next request is for sections 2, 3, and 9 error and signal handling only. |
.\" .Sh ERRORS |
.\" .Sh ERRORS |
.\" .Sh SEE ALSO |
.Sh SEE ALSO |
.\" .Xr foobar 1 |
.Xr groff 1 , |
|
.Xr mdoc.samples 7 , |
|
.Xr mdoc 7 |
.\" .Sh STANDARDS |
.\" .Sh STANDARDS |
.\" .Sh HISTORY |
.\" .Sh HISTORY |
.\" .Sh AUTHORS |
.Sh AUTHORS |
.\" .Sh CAVEATS |
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 |
.\" .Sh BUGS |