[Groff-commit] groff ChangeLog doc/groff.texinfo

[Werner LEMBERG]

CVSROOT:        /cvsroot/groff
Module name:    groff
Changes by:     Werner LEMBERG <wl>     10/11/11 12:11:08

Modified files:
        .              : ChangeLog 
        doc            : groff.texinfo 

Log message:
        [grohtml]: Improve texinfo documentation.
        
        * doc/groff.texinfo (grohtml): Insert man page description, slightly
        extended.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/groff/ChangeLog?cvsroot=groff&r1=1.1248&r2=1.1249
http://cvs.savannah.gnu.org/viewcvs/groff/doc/groff.texinfo?cvsroot=groff&r1=1.292&r2=1.293

Patches:
Index: ChangeLog
===================================================================
RCS file: /cvsroot/groff/groff/ChangeLog,v
retrieving revision 1.1248
retrieving revision 1.1249
diff -u -b -r1.1248 -r1.1249
--- ChangeLog   11 Nov 2010 12:10:28 -0000      1.1248
+++ ChangeLog   11 Nov 2010 12:11:06 -0000      1.1249
@@ -1,3 +1,10 @@
+2010-11-11  Anton Shepelev  <address@hidden>
+
+       [grohtml]: Improve texinfo documentation.
+
+       * doc/groff.texinfo (grohtml): Insert man page description, slightly
+       extended.
+
 2010-11-11  Werner LEMBERG  <address@hidden>
 
        Fix crash in tbl with option `nospaces'.

Index: doc/groff.texinfo
===================================================================
RCS file: /cvsroot/groff/groff/doc/groff.texinfo,v
retrieving revision 1.292
retrieving revision 1.293
diff -u -b -r1.292 -r1.293
--- doc/groff.texinfo   28 Jul 2010 16:53:34 -0000      1.292
+++ doc/groff.texinfo   11 Nov 2010 12:11:07 -0000      1.293
@@ -14922,7 +14922,28 @@
 @section @code{grohtml}
 @cindex @code{grohtml}, the program
 
address@hidden XXX
+The @code{grohtml} front end (which consists of a preprocessor,
address@hidden, 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.
+
address@hidden 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.
+
address@hidden 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::