summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorwl <wl>2010-11-11 12:11:06 +0000
committerwl <wl>2010-11-11 12:11:06 +0000
commit780293087ed2076c123b432b0c06ca66be4fa803 (patch)
treed09dce82f2c03382827d4a63329b0d424fb044a6 /doc
parent1f2403275563c96b0ddf929c5f1991c3796719e5 (diff)
downloadgroff-780293087ed2076c123b432b0c06ca66be4fa803.tar.gz
[grohtml]: Improve texinfo documentation.
* doc/groff.texinfo (grohtml): Insert man page description, slightly extended.
Diffstat (limited to 'doc')
-rw-r--r--doc/groff.texinfo23
1 files changed, 22 insertions, 1 deletions
diff --git a/doc/groff.texinfo b/doc/groff.texinfo
index ae2ac6ea..8d2e5c68 100644
--- a/doc/groff.texinfo
+++ b/doc/groff.texinfo
@@ -14922,7 +14922,28 @@ is available as an extra package from the following address:
@section @code{grohtml}
@cindex @code{grohtml}, the program
-@c XXX
+The @code{grohtml} front end (which consists of a preprocessor,
+@code{pre-grohtml}, and a device driver, @code{post-grohtml}) translates
+the output of GNU @code{troff} to @acronym{HTML}. Users should always
+invoke @code{grohtml} via the @code{groff} command with a @code{\-Thtml}
+option. If no files are given, @code{grohtml} will read the standard
+input. A filename of @code{-} will also cause @code{grohtml} to read
+the standard input. @acronym{HTML} output is written to the standard
+output. When @code{grohtml} is run by @code{groff}, options can be
+passed to @code{grohtml} using @code{groff}'s @code{-P} option.
+
+@code{grohtml} invokes @code{groff} twice. In the first pass, pictures,
+equations, and tables are rendered using the @code{ps} device, and in
+the second pass @acronym{HTML} output is generated by the @code{html}
+device.
+
+@code{grohtml} always writes output in @code{UTF-8} encoding and has
+built-in entities for all non-composite unicode characters. In spite of
+this, @code{groff} may issue warnings about unknown special characters
+if they can't be found during the first pass. Such warnings can be
+safely ignored unless the special characters appear inside a table or
+equation, in which case glyphs for these characters must be defined for
+the @code{ps} device as well.
@menu
* Invoking grohtml::