Return to index.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/index.7, Revision 1.4

1.1       kristaps    1: .\"
                      2: .Dd $Mdocdate$
                      3: .Dt index 7
                      4: .Os LOCAL
                      5: .\"
                      6: .Sh NAME
                      7: .Nm mdocml
                      8: .Nd compile manpage source into mark-up language
                      9: .\"
                     10: .Sh DESCRIPTION
                     11: The
                     12: .Nm
                     13: utility compiles
                     14: .Xr mdoc 7
                     15: macros, such as those inheriting from
                     16: .Xr mdoc.samples 7 ,
                     17: into XML or HTML documents.  Unlike other similar utilities such as
                     18: .Xr rman 1
                     19: and
                     20: .Xr man2html 1 ,
                     21: .Nm
                     22: acts directly on source documents, validating its input and producing a
                     23: variety of outputs.
1.2       kristaps   24: .\"
                     25: .Ss Validation
                     26: In order to operate sanely,
1.1       kristaps   27: .Nm
                     28: fully validates its input.  This includes, but is not limited to, the
                     29: following checks:
                     30: .Pp
                     31: .Bl -enum -compact
                     32: .It
                     33: special characters (such as
                     34: .Sq \en
                     35: and
                     36: .Sq \et ) ,
                     37: .It
                     38: macro scope (such as
                     39: .Sq \&.Sh
                     40: macros clobbering a pending
                     41: .Sq \&.Bl
                     42: scope),
                     43: .It
1.4     ! kristaps   44: predefined characters (such as \\*(>= and \\*q),
1.1       kristaps   45: .It
                     46: correctly-ordered document prelude,
1.2       kristaps   47: .It
                     48: sane argument values (such as those for
1.3       kristaps   49: .Sq \&.Dt
1.2       kristaps   50: or
1.3       kristaps   51: .Sq \&.Sm ) ,
1.2       kristaps   52: .It
                     53: and so on.
1.1       kristaps   54: .El
1.2       kristaps   55: .Pp
1.1       kristaps   56: .\"
                     57: .Sh ENVIRONMENT
                     58: The
                     59: .Nm
                     60: utility has been tested under Linux and OpenBSD.
                     61: .\"
                     62: .Sh EXAMPLES
                     63: This page was produced as follows:
                     64: .Pp
                     65: .D1 % mdocml -fhtml -o index.html index.7
                     66: .\"
                     67: .Sh SEE ALSO
                     68: TODO.
                     69: .\"
                     70: .Sh AUTHORS
                     71: The
                     72: .Nm
                     73: utility was written by
                     74: .An Em Kristaps Dzonsons Aq kristaps@kth.se .