Annotation of mandoc/index.7, Revision 1.1
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.
! 24: .Ss Features
! 25: In order to operate properly,
! 26: .Nm
! 27: fully validates its input. This includes, but is not limited to, the
! 28: following checks:
! 29: .Pp
! 30: .Bl -enum -compact
! 31: .It
! 32: special characters (such as
! 33: .Sq \en
! 34: and
! 35: .Sq \et ) ,
! 36: .It
! 37: macro scope (such as
! 38: .Sq \&.Sh
! 39: macros clobbering a pending
! 40: .Sq \&.Bl
! 41: scope),
! 42: .It
! 43: predefined characters (such as \\*(>= and \\*q),
! 44: .It
! 45: correctly-ordered document prelude,
! 46: .El
! 47: .\"
! 48: .Sh ENVIRONMENT
! 49: The
! 50: .Nm
! 51: utility has been tested under Linux and OpenBSD.
! 52: .\"
! 53: .Sh EXAMPLES
! 54: This page was produced as follows:
! 55: .Pp
! 56: .D1 % mdocml -fhtml -o index.html index.7
! 57: .\"
! 58: .Sh SEE ALSO
! 59: TODO.
! 60: .\"
! 61: .Sh AUTHORS
! 62: The
! 63: .Nm
! 64: utility was written by
! 65: .An Em Kristaps Dzonsons Aq kristaps@kth.se .
CVSweb