index.7

   1 .\"
   2 .Dd $Mdocdate: December 4 2008 $
   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 .\"
  25 .Ss Validation
  26 In order to operate sanely,
  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
  44 predefined characters (such as \\*(>= and \\*q, rendering as \*(>= and \*q,
  45 respectively),
  46 .It
  47 correctly-ordered document prelude,
  48 .It
  49 sane argument values (such as those for
  50 .Sq \&.Dt
  51 or
  52 .Sq \&.Sm ) ,
  53 .It
  54 and so on.
  55 .El
  56 .Pp
  57 .\"
  58 .Sh ENVIRONMENT
  59 The
  60 .Nm
  61 utility has been tested under Linux and OpenBSD.
  62 .\"
  63 .Sh EXAMPLES
  64 This page was produced as follows:
  65 .Pp
  66 .D1 % mdocml -fhtml -o index.html index.7
  67 .\"
  68 .Sh SEE ALSO
  69 TODO.
  70 .\"
  71 .Sh AUTHORS
  72 The
  73 .Nm
  74 utility was written by
  75 .An Em Kristaps Dzonsons Aq kristaps@kth.se .