Return to mdocml.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/mdocml.1, Revision 1.3

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.1       kristaps   10: .Sh NAME
1.2       kristaps   11: .Nm mdocml
                     12: .Nd compile manpage source into mark-up language
1.3     ! kristaps   13: .\"
1.1       kristaps   14: .Sh SYNOPSIS
1.2       kristaps   15: .Nm mdocml
                     16: .Op Fl o Ar outfile
                     17: .Op Ar infile
1.3     ! kristaps   18: .\"
1.1       kristaps   19: .Sh DESCRIPTION
                     20: The
                     21: .Nm
1.2       kristaps   22: utility compiles manpage source into a mark-up language.  Its arguments
                     23: are as follows:
                     24: .Bl -tag -width "-o outfile"
                     25: .It Fl o Ar outfile
                     26: Place output in
                     27: .Ar outfile ,
                     28: which may be
                     29: .Qq -
                     30: for standard output.  The default is standard output.
                     31: .It Ar infile
                     32: Read input from
                     33: .Ar infile ,
                     34: which may be
                     35: .Qq -
                     36: for standard input.  The default is standard input.
                     37: .El
1.1       kristaps   38: .\" The following requests should be uncommented and used where appropriate.
                     39: .\" This next request is for sections 2, 3, and 9 function return values only.
                     40: .\" .Sh RETURN VALUES
                     41: .\" This next request is for sections 1, 6, 7 & 8 only.
                     42: .\" .Sh ENVIRONMENT
                     43: .\" .Sh FILES
                     44: .\" .Sh EXAMPLES
                     45: .\" This next request is for sections 1, 4, 6, and 8 only.
                     46: .\" .Sh DIAGNOSTICS
                     47: .\" The next request is for sections 2, 3, and 9 error and signal handling only.
                     48: .\" .Sh ERRORS
1.3     ! kristaps   49: .Sh SEE ALSO
        !            50: .Xr groff 1 ,
        !            51: .Xr mdoc.samples 7 ,
        !            52: .Xr mdoc 7
1.1       kristaps   53: .\" .Sh STANDARDS
                     54: .\" .Sh HISTORY
1.3     ! kristaps   55: .Sh AUTHORS
        !            56: The
        !            57: .Nm
        !            58: utility was written by
        !            59: .An Kristaps Dzonsons Aq kristaps@kth.se .
        !            60: .\"
        !            61: .Sh CAVEATS
        !            62: The
        !            63: .Nm
        !            64: engine doesn't understand
        !            65: .Sq \&Xo
        !            66: and
        !            67: .Sq \&Xc
        !            68: troff macros.
1.1       kristaps   69: .\" .Sh BUGS