mandoc/index.7 - diff

Return to index.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/Attic/index.7 between version 1.3 and 1.6

-version 1.3, 2008/12/04 19:31:57
+version 1.6, 2008/12/07 23:08:23
 Line 5
 Line 5
 Line 5
  .\"
  .Sh NAME
  .Nm mdocml
- .Nd compile manpage source into mark-up language
+ .Nd compile mdoc macros into mark-up language
  .\"
  .Sh DESCRIPTION
  The
 Line 41  macros clobbering a pending
 Line 41  macros clobbering a pending
 Line 41  macros clobbering a pending
  .Sq \&.Bl
  scope),
  .It
- predefined characters (such as \\*(>= and \\*q, rendering as \*(>= and \*q,
+ predefined characters (such as \\*(>= and \\*q),
- respectively),
  .It
  correctly-ordered document prelude,
  .It
-Line 54  or
+Line 53  or
 Line 54  or
 Line 53  or
  and so on.
  .El
  .Pp
- .\"
- .Sh ENVIRONMENT
  The
  .Nm
- utility has been tested under Linux and OpenBSD.
+ utility has been tested under Linux and
+ .Ox ,
+ specifically on
+ .Ox
+ manual source.
+ .Nm
+ is
+ .Ud
+ .\"
+ .Ss Filtering
+ When a block of source has been verified, it's passed to the front-end
+ fitlers, which format and display data.  The
+ .Nm
+ utility is invoked with a filter by the
+ .Fl f
+ flag.  The HTML filter has the following features:
+ .Pp
+ .Bl -enum -compact
+ .It
+ HTML-4.01 strict compliance.
+ .It
+ Proper render of values in UTF-8, such as
+ .Dq quotes
+ and \*(>= predefined values.
+ .It
+ URI-appearing http://bsd.lv/ strings are correctly enclosed in link tags.
+ .It
+ CSS-dictated style with meaningful non-CSS defaults.
+ .El
+ .Pp
+ The XML filter creates a correct XML tree with
+ .Dq block ,
+ .Dq head ,
+ .Dq body ,
+ and
+ .Dq inline
+ namespaces corresponding to macro categories.  Namespace identifiers
+ correspond to their definitions.
  .\"
+ .Sh DOWNLOADS
+ Download
+ .Nm
+ at http://mdocml.bsd.lv/mdocml.tgz
+ .Ns .
+ .\" - UPDATE ME WITH EVERY RELEASE. ----------------------------------
+ The current version is 1.0.0, dated 08/12/2008.
+ .\" ------------------------------------------------------------------
+ .\"
+ .Sh DOCUMENTS
+ The manual for
+ .Nm
+ is available at http://mdocml.bsd.lv/mdocml.html
+ .Ns .
+ .\"
  .Sh EXAMPLES
  This page was produced as follows:
  .Pp
- .D1 % mdocml -fhtml -o index.html index.7
+ .D1 % mdocml -fhtml -W -e -o index.html index.7
  .\"
  .Sh SEE ALSO
- TODO.
+ .Bl -ohang
+ .It Xr rman Ns : http://polyglotman.sourceforge.net/rman.html
+ Accepts either formatted roff output or source and produces HTML output.
+ .It Xr man2html Ns : http://www.nongnu.org/man2html/
+ Accepts formatted
+ .Xr nroff 1
+ text and produces HTML output.
+ .It Xr man.cgi Ns : http://www.freebsd.org/cgi/man.cgi/source
+ .Fx
+ and
+ .Ox
+ project CGI for producing HTML from nroff source.
+ .El
  .\"
  .Sh AUTHORS
  The
  .Nm
  utility was written by
- .An Em Kristaps Dzonsons Aq kristaps@kth.se .
+ .An Kristaps Dzonsons Aq kristaps@kth.se .

CVSweb