Return to index.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/index.7, Revision 1.5

1.1       kristaps    1: .\"
                      2: .Dd $Mdocdate$
                      3: .Dt index 7
                      4: .Os LOCAL
                      5: .\"
                      6: .Sh NAME
                      7: .Nm mdocml
1.5     ! kristaps    8: .Nd compile mdoc macros into mark-up language
1.1       kristaps    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.5     ! kristaps   55: .Ss Filtering
        !            56: When a block of source has been verified, it's passed to the front-end
        !            57: fitlers, which format and display data.  The
        !            58: .Nm
        !            59: utility is invoked with a filter by the
        !            60: .Fl f
        !            61: flag.  The HTML filter has the following features:
        !            62: .Bl -enum -compact
        !            63: .It
        !            64: HTML-4.01 strict compliance.
        !            65: .It
        !            66: Proper render of values in UTF-8, such as
        !            67: .Dq quotes
        !            68: and \*(>= predefined values.
        !            69: .It
        !            70: URI-appearing http://bsd.lv strings are correctly enclosed in link tags.
        !            71: .It
        !            72: CSS-dictated style with meaningful non-CSS defaults.
        !            73: .El
1.1       kristaps   74: .\"
                     75: .Sh ENVIRONMENT
                     76: The
                     77: .Nm
1.5     ! kristaps   78: utility has been tested under Linux and
        !            79: .Ox ,
        !            80: specifically on
        !            81: .Ox
        !            82: manual source.
1.1       kristaps   83: .\"
                     84: .Sh EXAMPLES
                     85: This page was produced as follows:
                     86: .Pp
1.5     ! kristaps   87: .D1 % mdocml -fhtml -W -e -o index.html index.7
1.1       kristaps   88: .\"
                     89: .Sh SEE ALSO
1.5     ! kristaps   90: .Bl -ohang
        !            91: .It Xr rman Ns : http://polyglotman.sourceforge.net/rman.html
        !            92: Accepts either formatted roff output or source and produces HTML output.
        !            93: .It Xr man2html Ns : http://www.nongnu.org/man2html/
        !            94: Accepts formatted
        !            95: .Xr nroff 1
        !            96: text and produces HTML output.
        !            97: .It Xr man.cgi Ns : http://www.freebsd.org/cgi/man.cgi/source
        !            98: .Fx
        !            99: and
        !           100: .Ox
        !           101: project CGI for producing HTML from nroff source.
        !           102: .El
1.1       kristaps  103: .\"
                    104: .Sh AUTHORS
                    105: The
                    106: .Nm
                    107: utility was written by
1.5     ! kristaps  108: .An Kristaps Dzonsons Aq kristaps@kth.se .