groff-commit
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[groff] 17/39: doc/groff.texi: Drop stub-heavy chapters.


From: G. Branden Robinson
Subject: [groff] 17/39: doc/groff.texi: Drop stub-heavy chapters.
Date: Tue, 31 May 2022 20:32:24 -0400 (EDT)

gbranden pushed a commit to branch master
in repository groff.

commit 2c652e943affb8b665ff225eb56dcbb34162957c
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Mon May 30 11:48:26 2022 -0500

    doc/groff.texi: Drop stub-heavy chapters.
    
    The "Preprocessors" and "Output Devices" chapters were mostly stubs for
    content to be added later, and have been for years.  What content was
    already present duplicated existing groff man pages (except for a
    reference to Ted Faber's "grap" implementation, which is also documented
    in the "MORE.STUFF" file).
    
    Drop this material to reduce reader frustration with incomplete
    sections.  Replace internal Texinfo @*ref commands with "@cite"s of man
    pages where necessary.
    
    Partially addresses <https://savannah.gnu.org/bugs/?60061>.
---
 doc/groff.texi | 941 +--------------------------------------------------------
 1 file changed, 13 insertions(+), 928 deletions(-)

diff --git a/doc/groff.texi b/doc/groff.texi
index 4d587d9d..492a8497 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -491,8 +491,6 @@ developing GNU and promoting software freedom.''
 * Tutorial for Macro Users::
 * Major Macro Packages::
 * gtroff Reference::
-* Preprocessors::
-* Output Devices::
 * File Formats::
 * Copying This Manual::
 * Request Index::
@@ -1007,13 +1005,13 @@ built).  It can optionally preprocess with any of 
@code{gpic},
 
 This section only documents options to the @code{groff} front end.  Many
 of the arguments to @code{groff} are passed on to @code{gtroff},
-therefore those are also included.  Arguments to pre- or postprocessors
-can be found in @ref{Invoking gpic}, @ref{Invoking geqn}, @ref{Invoking
-gtbl}, @ref{Invoking ggrn}, @ref{Invoking grefer}, @ref{Invoking gchem},
-@ref{Invoking gsoelim}, @ref{Invoking preconv}, @ref{Invoking grotty},
-@ref{Invoking grops}, @ref{Invoking gropdf}, @ref{Invoking grohtml},
-@ref{Invoking grodvi}, @ref{Invoking grolj4}, @ref{Invoking grolbp}, and
-@ref{Invoking gxditview}.
+therefore those are also included.  Arguments to preprocessors and
+output drivers can be found in the man pages @cite{gpic@r{(1)}},
+@cite{geqn@r{(1)}}, @cite{gtbl@r{(1)}}, @cite{ggrn@r{(1)}},
+@cite{grefer@r{(1)}}, @cite{gchem@r{(1)}}, @cite{gsoelim@r{(1)}},
+@cite{preconv@r{(1)}}, @cite{grotty@r{(1)}}, @cite{grops@r{(1)}},
+@cite{gropdf@r{(1)}}, @cite{grohtml@r{(1)}}, @cite{grodvi@r{(1)}},
+@cite{grolj4@r{(1)}}, @cite{grolbp@r{(1)}}, and @cite{gxditview@r{(1)}}.
 
 The command-line format for @code{groff} is:
 
@@ -1143,7 +1141,7 @@ Search @var{dir} for files named in several contexts; 
implies
 @itemize
 @item
 @code{gsoelim} replaces @code{so} requests with the contents of their
-file name arguments (@pxref{gsoelim} for more details).
+file name arguments.
 
 @item
 @code{gtroff} searches for files named as operands in its command line
@@ -1244,8 +1242,7 @@ startup file).
 @item -R
 Preprocess with @code{grefer}.  No mechanism is provided for passing
 arguments to @code{grefer} because most @code{grefer} options have
-equivalent commands that can be included in the file.  @xref{grefer},
-for more details.
+equivalent commands that can be included in the file.
 
 @pindex troffrc
 @pindex troffrc-end
@@ -4686,7 +4683,7 @@ Names containing only uppercase letters and digits.
 @c =====================================================================
 @c =====================================================================
 
-@node gtroff Reference, Preprocessors, Major Macro Packages, Top
+@node gtroff Reference, File Formats, Major Macro Packages, Top
 @chapter @code{gtroff} Reference
 @cindex reference, @code{gtroff}
 @cindex @code{gtroff}, reference
@@ -10704,8 +10701,6 @@ The request @code{rfschar} removes glyph definitions 
defined with
 @code{fschar} for font@tie{}@var{f}.
 @endDefreq
 
-@xref{Special Characters}.
-
 @c ---------------------------------------------------------------------
 
 @node Character Classes, Special Fonts, Using Symbols, Fonts and Symbols
@@ -13528,7 +13523,7 @@ on the page.  Used in combination with the page motion 
commands
 (@pxref{Page Motions}), a wide variety of figures can be drawn.
 However, for complex drawings these operations can be quite cumbersome,
 and it may be wise to use graphic preprocessors like @code{gpic} or
-@code{ggrn}.  @xref{gpic}, and @ref{ggrn}.
+@code{ggrn}.
 
 All drawing is done via escape sequences.
 
@@ -15476,7 +15471,7 @@ exercising device-specific capabilities that the 
@code{groff} language
 does not abstract or generalize; examples include the embedding of
 hyperlinks and image files.  Device-specific functions are documented in
 each output driver's man page, such as @cite{gropdf@r{(1)}},
-@cite{grops@r{(1)}}, or @cite{grotty@r{(1)}}.  @xref{Output Devices}.
+@cite{grops@r{(1)}}, or @cite{grotty@r{(1)}}.
 
 @DefreqList {device, xxx @r{@dots{}}}
 @DefescListEndx {\\X, @code{'}, xxx @r{@dots{}}, @code{'}}
@@ -16653,921 +16648,11 @@ partially collected line at the end of input; GNU 
@code{troff} will not.
 @codequoteundirected off
 
 
-@c =====================================================================
-@c =====================================================================
-
-@node Preprocessors, Output Devices, gtroff Reference, Top
-@chapter Preprocessors
-@cindex preprocessors
-
-This chapter describes all preprocessors that come with @code{groff} or
-which are freely available.
-
-@menu
-* geqn::
-* gtbl::
-* gpic::
-* ggrn::
-* grap::
-* gchem::
-* grefer::
-* gsoelim::
-* preconv::
-@end menu
-
-
-@c =====================================================================
-
-@node geqn, gtbl, Preprocessors, Preprocessors
-@section @code{geqn}
-@cindex @code{eqn}, the program
-@cindex @code{geqn}, the program
-
-@c XXX
-
-@menu
-* Invoking geqn::
-@end menu
-
-@c ---------------------------------------------------------------------
-
-@node Invoking geqn,  , geqn, geqn
-@subsection Invoking @code{geqn}
-@cindex invoking @code{geqn}
-@cindex @code{geqn}, invoking
-
-@c XXX
-
-
-@c =====================================================================
-
-@node gtbl, gpic, geqn, Preprocessors
-@section @code{gtbl}
-@cindex @code{tbl}, the program
-@cindex @code{gtbl}, the program
-
-@c XXX
-
-@menu
-* Invoking gtbl::
-@end menu
-
-@c ---------------------------------------------------------------------
-
-@node Invoking gtbl,  , gtbl, gtbl
-@subsection Invoking @code{gtbl}
-@cindex invoking @code{gtbl}
-@cindex @code{gtbl}, invoking
-
-@c XXX
-
-
-@c =====================================================================
-
-@node gpic, ggrn, gtbl, Preprocessors
-@section @code{gpic}
-@cindex @code{pic}, the program
-@cindex @code{gpic}, the program
-
-@c XXX
-
-@menu
-* Invoking gpic::
-@end menu
-
-@c ---------------------------------------------------------------------
-
-@node Invoking gpic,  , gpic, gpic
-@subsection Invoking @code{gpic}
-@cindex invoking @code{gpic}
-@cindex @code{gpic}, invoking
-
-@c XXX
-
-
-@c =====================================================================
-
-@node ggrn, grap, gpic, Preprocessors
-@section @code{ggrn}
-@cindex @code{grn}, the program
-@cindex @code{ggrn}, the program
-
-@c XXX
-
-@menu
-* Invoking ggrn::
-@end menu
-
-@c ---------------------------------------------------------------------
-
-@node Invoking ggrn,  , ggrn, ggrn
-@subsection Invoking @code{ggrn}
-@cindex invoking @code{ggrn}
-@cindex @code{ggrn}, invoking
-
-@c XXX
-
-
-@c =====================================================================
-
-@node grap, gchem, ggrn, Preprocessors
-@section @code{grap}
-@cindex @code{grap}, the program
-
-A free implementation of @code{grap}, written by Ted Faber,
-is available as an extra package from the following address:
-
-@display
-@uref{http://www.lunabase.org/~faber/Vault/software/grap/}
-@end display
-
-
-@c =====================================================================
-
-@node gchem, grefer, grap, Preprocessors
-@section @code{gchem}
-@cindex @code{chem}, the program
-@cindex @code{gchem}, the program
-
-@c XXX
-
-@menu
-* Invoking gchem::
-@end menu
-
-@c ---------------------------------------------------------------------
-
-@node Invoking gchem,  , gchem, gchem
-@subsection Invoking @code{gchem}
-@cindex invoking @code{gchem}
-@cindex @code{gchem}, invoking
-
-@c XXX
-
-
-@c =====================================================================
-
-@node grefer, gsoelim, gchem, Preprocessors
-@section @code{grefer}
-@cindex @code{refer}, the program
-@cindex @code{grefer}, the program
-
-@c XXX
-
-@menu
-* Invoking grefer::
-@end menu
-
-@c ---------------------------------------------------------------------
-
-@node Invoking grefer,  , grefer, grefer
-@subsection Invoking @code{grefer}
-@cindex invoking @code{grefer}
-@cindex @code{grefer}, invoking
-
-@c XXX
-
-
-@c =====================================================================
-
-@node gsoelim, preconv, grefer, Preprocessors
-@section @code{gsoelim}
-@cindex @code{soelim}, the program
-@cindex @code{gsoelim}, the program
-
-@c XXX
-
-@menu
-* Invoking gsoelim::
-@end menu
-
-@c ---------------------------------------------------------------------
-
-@node Invoking gsoelim,  , gsoelim, gsoelim
-@subsection Invoking @code{gsoelim}
-@cindex invoking @code{gsoelim}
-@cindex @code{gsoelim}, invoking
-
-@c XXX
-
-
-@c =====================================================================
-
-@node preconv,  , gsoelim, Preprocessors
-@section @code{preconv}
-@cindex @code{preconv}, the program
-
-@c XXX
-
-@menu
-* Invoking preconv::
-@end menu
-
-@c ---------------------------------------------------------------------
-
-@node Invoking preconv,  , preconv, preconv
-@subsection Invoking @code{preconv}
-@cindex invoking @code{preconv}
-@cindex @code{preconv}, invoking
-
-@c XXX
-
-
-@c =====================================================================
-@c =====================================================================
-
-@node Output Devices, File Formats, Preprocessors, Top
-@chapter Output Devices
-@cindex output devices
-@cindex devices for output
-
-@c XXX
-
-@menu
-* Special Characters::
-* grotty::
-* grops::
-* gropdf::
-* grodvi::
-* grolj4::
-* grolbp::
-* grohtml::
-* gxditview::
-@end menu
-
-
-@c =====================================================================
-
-@node Special Characters, grotty, Output Devices, Output Devices
-@section Special Characters
-@cindex special characters
-@cindex characters, special
-
-@c XXX
-
-@xref{Device and Font Description Files}.
-
-
-@c =====================================================================
-
-@node grotty, grops, Special Characters, Output Devices
-@section @code{grotty}
-@cindex @code{grotty}, the program
-
-The postprocessor @code{grotty} translates the output from GNU
-@code{troff} into a form suitable for typewriter-like devices.  It is
-fully documented on its man page, @cite{grotty@r{(1)}}.
-
-@menu
-* Invoking grotty::
-@end menu
-
-@c ---------------------------------------------------------------------
-
-@node Invoking grotty,  , grotty, grotty
-@subsection Invoking @code{grotty}
-@cindex invoking @code{grotty}
-@cindex @code{grotty}, invoking
-
-The postprocessor @command{grotty} accepts the following command-line
-options:
-
-@table @option
-@item -b
-Do not overstrike bold glyphs.  Ignored if @option{-c} isn't used.
-
-@item -B
-Do not underline bold-italic glyphs.  Ignored if @option{-c} isn't
-used.
-
-@item -c
-Use overprint and disable colours for printing on legacy Teletype
-printers (see below).
-
-@item -d
-Do not render lines (that is, ignore all @code{\D} escape sequences).
-
-@item -f
-Use form feed control characters in the output.
-
-@item -F@var{dir}
-Put the directory @file{@var{dir}/dev@var{name}} in front of the
-search path for the font and device description files, given the
-target device @var{name}.
-
-@item -h
-Use horizontal tabs for sequences of 8 space characters.
-
-@item -i
-Request italic glyphs from the terminal.  Ignored if @option{-c} is
-active.
-
-@item -o
-Do not overstrike.
-
-@item -r
-Highlight italic glyphs.  Ignored if @option{-c} is active.
-
-@item -u
-Do not underline italic glyphs.  Ignored if @option{-c} isn't used.
-
-@item -U
-Do not overstrike bold-italic glyphs.  Ignored if @option{-c} isn't
-used.
-
-@item -v
-Print the version number.
-@end table
-
-@pindex col
-@pindex less
-@pindex more
-@pindex ul
-@cindex Teletype
-@cindex ISO 6429 SGR
-@cindex terminal control sequences
-@cindex control sequences, for terminals
-The @option{-c} option tells @code{grotty} to use an output format
-compatible with paper terminals, like the Teletype machines for which
-@code{roff} and @code{nroff} were first developed but which are no
-longer in wide use.  SGR escape sequences (from ISO@tie{}6429) are not
-emitted.  Instead, @code{grotty} overstrikes, representing a bold
-character @var{c} with the sequence @samp{@var{c} BACKSPACE @var{c}} and
-an italic character @var{c} with the sequence @samp{_ BACKSPACE
-@var{c}}.  Furthermore, color output is disabled.  The same effect can
-be achieved either by setting the @env{GROFF_NO_SGR} environment
-variable or by using a @code{groff} escape sequence within the document;
-see the subsection ``Device control commands'' of the
-@cite{grotty@r{(1)}} man page for details.
-
-The legacy output format can be rendered on a video terminal (or
-emulator) by piping @code{grotty}'s output through @code{ul},
-@c from bsdmainutils 11.1.2+b1 (on Debian Buster)
-which may render bold italics as reverse video.
-@c 'more' from util-linux 2.33.1 (on Debian Buster) neither renders
-@c double-struck characters as bold nor supports -b, but does render
-@c SGR sequences (including color) with no flags required.
-Some implementations of @code{more} are also able to display these
-sequences; you may wish to experiment with that command's @option{-b}
-option.
-@c Version 487 of...
-@code{less} renders legacy bold and italics without requiring options.
-In contrast to the teletype output drivers of some other @code{roff}
-implementations, @code{grotty} never outputs reverse line feeds.  There
-is therefore no need to filter its output through @code{col}.
-
-
-@c =====================================================================
-
-@node grops, gropdf, grotty, Output Devices
-@section @code{grops}
-@cindex @code{grops}, the program
-
-The postprocessor @command{grops} translates the output from GNU
-@command{troff} into a form suitable for Adobe PostScript devices.  It
-is fully documented on its man page, @cite{grops@r{(1)}}.
-
-
-@menu
-* Invoking grops::
-* Embedding PostScript::
-@end menu
-
-@c ---------------------------------------------------------------------
-
-@node Invoking grops, Embedding PostScript, grops, grops
-@subsection Invoking @code{grops}
-@cindex invoking @code{grops}
-@cindex @code{grops}, invoking
-
-The postprocessor @code{grops} accepts the following command-line
-options:
-
-@table @option
-@item -b@var{flags}
-Use backward compatibility settings given by @var{flags} as
-documented in the @cite{grops@r{(1)}} man page.  Overrides the
-command @option{broken} in the @file{DESC} file.
-
-@item -c@var{n}
-Print @var{n} copies of each page.
-
-@item -F@var{dir}
-Put the directory @file{@var{dir}/dev@var{name}} in front of the
-search path for the font, prologue and device description files,
-given the target device @var{name}, usually @strong{ps}.
-
-@item -g
-Tell the printer to guess the page length.  Useful for printing
-vertically centered pages when the paper dimensions are determined at
-print time.
-
-@item -I@var{path} @dots{}
-Consider the directory @file{@var{path}} for searching included files
-specified with relative paths.  The current directory is searched as
-fallback.
-
-@item -l
-Use landscape orientation.
-
-@item -m
-Use manual feed.
-
-@item -p@var{papersize}
-Set the page dimensions.  Overrides the commands @option{papersize},
-@option{paperlength}, and @option{paperwidth} in the @file{DESC}
-file.  See the @cite{groff_font@r{(5)}} man page for details.
-
-@item -P@var{prologue}
-Use the @var{prologue} in the font path as the prologue instead of
-the default @file{prologue}.  Overrides the environment variable
-@env{GROPS_PROLOGUE}.
-
-@item -w@var{n}
-Set the line thickness to @var{n}/1000@dmn{em}.  Overrides the
-default value @var{n} = 40.
-
-@item -v
-Print the version number.
-@end table
-
-@c ---------------------------------------------------------------------
-
-@node Embedding PostScript,  , Invoking grops, grops
-@subsection Embedding PostScript
-@cindex embedding PostScript
-@cindex PostScript, embedding
-
-The escape sequence
-
-@samp{\X'ps: import @var{file} @var{llx} @var{lly} @var{urx} @var{ury}
-  @var{width} [@var{height}]'}
-
-@noindent
-places a rectangle of the specified @var{width} containing the
-PostScript drawing from file @var{file} bound by the box from @var{llx}
-@var{lly} to @var{urx} @var{ury} (in PostScript coordinates) at the
-insertion point.  If @var{height} is not specified, the embedded drawing
-is scaled proportionally.
-
-@xref{Miscellaneous}, for the @code{psbb} request, which automatically
-generates the bounding box.
-
-This escape sequence is used internally by the macro @code{PSPIC}
-(see the @cite{groff_tmac@r{(5)}} man page).
-
-
-@c =====================================================================
-
-@node gropdf, grodvi, grops, Output Devices
-@section @code{gropdf}
-@cindex @code{gropdf}, the program
-
-The postprocessor @command{gropdf} translates the output from GNU
-@command{troff} into a form suitable for Adobe @acronym{PDF} devices.
-It is fully documented on its man page, @cite{gropdf@r{(1)}}.
-
-@menu
-* Invoking gropdf::
-* Embedding PDF::
-@end menu
-
-@c ---------------------------------------------------------------------
-
-@node Invoking gropdf, Embedding PDF, gropdf, gropdf
-@subsection Invoking @code{gropdf}
-@cindex invoking @code{gropdf}
-@cindex @code{gropdf}, invoking
-
-The postprocessor @code{gropdf} accepts the following command-line
-options:
-
-@table @option
-@item -d
-Produce uncompressed PDFs that include debugging comments.
-
-@item -e
-This forces @code{gropdf} to embed all used fonts in the @acronym{PDF},
-even if they are one of the 14 base Adobe fonts.
-
-@item -F@var{dir}
-Put the directory @file{@var{dir}/dev@var{name}} in front of the
-search path for the font, prologue and device description files,
-given the target device @var{name}, usually @strong{pdf}.
-
-@item -y@var{foundry}
-This forces the use of a different font foundry.
-
-@item -l
-Use landscape orientation.
-
-@item -p@var{papersize}
-Set the page dimensions.  Overrides the commands @option{papersize},
-@option{paperlength}, and @option{paperwidth} in the @file{DESC}
-file.  See the @cite{groff_font@r{(5)}} man page for details.
-
-@item -v
-Print the version number.
-
-@item -s
-Append a comment line to end of @acronym{PDF} showing statistics, i.e.
-number of pages in document.  Ghostscript's @cite{ps2pdf@r{(1)}}
-complains about this line if it is included, but works anyway.
-
-@item -u@var{filename}
-@code{gropdf} normally includes a ToUnicode CMap with any font created
-using @file{text.enc} as the encoding file, this makes it easier to
-search for words that contain ligatures.  You can include your own CMap
-by specifying a @var{filename} or have no CMap at all by omitting the
-@var{filename}.
-@end table
-
-@c ---------------------------------------------------------------------
-
-@node Embedding PDF,  , Invoking gropdf, gropdf
-@subsection Embedding PDF
-@cindex embedding PDF
-@cindex PDF, embedding
-
-The escape sequence
-
-@samp{\X'pdf: pdfpic @var{file} @var{alignment} @var{width} [@var{height}]
-  [@var{linelength}]'}
-
-@noindent
-places a rectangle of the specified @var{width} containing the
-@acronym{PDF} drawing from file @var{file} of desired @var{width} and
-@var{height} (if @var{height} is missing or zero then it is scaled
-proportionally).  If @var{alignment} is @code{-L} the drawing is left
-aligned.  If it is @code{-C} or @code{-R} a @var{linelength} greater
-than the width of the drawing is required as well.  If @var{width} is
-specified as zero then the width is scaled in proportion to the height.
-
-
-@c =====================================================================
-
-@node grodvi, grolj4, gropdf, Output Devices
-@section @command{grodvi}
-@pindex grodvi
-@pindex dvips
-@pindex dvipdf
-@cindex @command{grodvi}, the program
-@cindex DVI output driver
-
-The postprocessor @command{grodvi} translates the output from GNU
-@code{troff} into the DVI format produced by the @TeX{} document
-preparation system.  This enables the use of programs that process the
-DVI format, like @command{dvips} and @command{dvipdf}, with GNU
-@code{troff} output.  @command{grodvi} is fully documented in its man
-page, @cite{grodvi@r{(1)}}.
-
-@menu
-* Invoking grodvi::
-@end menu
-
-@c ---------------------------------------------------------------------
-
-@node Invoking grodvi,  , grodvi, grodvi
-@subsection Invoking @command{grodvi}
-@cindex invoking @command{grodvi}
-@cindex @command{grodvi}, invoking
-
-The postprocessor @command{grodvi} accepts the following command-line
-options:
-
-@table @option
-@item -d
-Do not use @strong{tpic} specials to implement drawing commands.
-
-@item -F@var{dir}
-Put the directory @file{@var{dir}/dev@var{name}} in front of the
-search path for the font and device description files, given the
-target device @var{name}, usually @strong{dvi}.
-
-@item -l
-Use landscape orientation.
-
-@item -p@var{papersize}
-Set the page dimensions.  Overrides the commands @option{papersize},
-@option{paperlength}, and @option{paperwidth} in the @file{DESC}
-file.  See the @cite{groff_font@r{(5)}} man page for details.
-
-@item -v
-Print the version number.
-
-@item -w@var{n}
-Set the line thickness to @var{n}/1000@dmn{em}.  Overrides the
-default value @var{n} = 40.
-@end table
-
-
-@c =====================================================================
-
-@node grolj4, grolbp, grodvi, Output Devices
-@section @code{grolj4}
-@cindex @code{grolj4}, the program
-
-The postprocessor @command{grolj4} translates the output from GNU
-@command{troff} into the @strong{PCL5} output format suitable for
-printing on a @strong{HP LaserJet@tie{}4} printer.  It is fully
-documented on its man page, @cite{grolj4@r{(1)}}.
-
-@menu
-* Invoking grolj4::
-@end menu
-
-@c ---------------------------------------------------------------------
-
-@node Invoking grolj4,  , grolj4, grolj4
-@subsection Invoking @code{grolj4}
-@cindex invoking @code{grolj4}
-@cindex @code{grolj4}, invoking
-
-The postprocessor @code{grolj4} accepts the following command-line
-options:
-
-@table @option
-@item -c@var{n}
-Print @var{n} copies of each page.
-
-@item -F@var{dir}
-Put the directory @file{@var{dir}/dev@var{name}} in front of the
-search path for the font and device description files, given the
-target device @var{name}, usually @strong{lj4}.
-
-@item -l
-Use landscape orientation.
-
-@item -p@var{size}
-Set the page dimensions.  Valid values for @var{size} are:
-@code{letter}, @code{legal}, @code{executive}, @code{a4},
-@code{com10}, @code{monarch}, @code{c5}, @code{b5}, @code{d1}.
-
-@item -v
-Print the version number.
-
-@item -w@var{n}
-Set the line thickness to @var{n}/1000@dmn{em}.  Overrides the
-default value @var{n} = 40.
-@end table
-
-The special drawing command @samp{\D'R @var{dh} @var{dv}'} draws a
-horizontal rectangle from the current position to the position at
-offset (@var{dh},@var{dv}).
-
-
-@c =====================================================================
-
-@node grolbp, grohtml, grolj4, Output Devices
-@section @code{grolbp}
-@cindex @code{grolbp}, the program
-
-The postprocessor @command{grolbp} translates the output from GNU
-@command{troff} into the @strong{LBP} output format suitable for
-printing on Canon @acronym{CaPSL} printers.  It is fully documented in
-its man page, @cite{grolbp@r{(1)}}.
-
-@menu
-* Invoking grolbp::
-@end menu
-
-@c ---------------------------------------------------------------------
-
-@node Invoking grolbp,  , grolbp, grolbp
-@subsection Invoking @code{grolbp}
-@cindex invoking @code{grolbp}
-@cindex @code{grolbp}, invoking
-
-The postprocessor @code{grolbp} accepts the following command-line
-options:
-
-@table @option
-@item -c@var{n}
-Print @var{n} copies of each page.
-
-@item -F@var{dir}
-Put the directory @file{@var{dir}/dev@var{name}} in front of the
-search path for the font, prologue and device description files,
-given the target device @var{name}, usually @strong{lbp}.
-
-@item -l
-Use landscape orientation.
-
-@item -o@var{orientation}
-Use the @var{orientation} specified: @code{portrait} or
-@code{landscape}.
-
-@item -p@var{papersize}
-Set the page dimensions.  See @cite{groff_font@r{(5)}} man page for
-details.
-
-@item -w@var{n}
-Set the line thickness to @var{n}/1000@dmn{em}.  Overrides the
-default value @var{n} = 40.
-
-@item -v
-Print the version number.
-
-@item -h
-Print command-line help.
-@end table
-
-
-@c =====================================================================
-
-@node grohtml, gxditview, grolbp, Output Devices
-@section @code{grohtml}
-@cindex @code{grohtml}, the program
-
-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 @option{-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.
-
-This output device is fully documented on its man page,
-@cite{grohtml@r{(1)}}.
-
-@menu
-* Invoking grohtml::
-* grohtml specific registers and strings::
-@end menu
-
-@c ---------------------------------------------------------------------
-
-@node Invoking grohtml, grohtml specific registers and strings, grohtml, 
grohtml
-@subsection Invoking @code{grohtml}
-@cindex invoking @code{grohtml}
-@cindex @code{grohtml}, invoking
-
-The postprocessor @code{grohtml} accepts the following command-line
-options:
-
-@table @option
-@item -a@var{bits}
-Use this number of @var{bits} (= 1, 2 or 4) for text antialiasing.
-Default: @var{bits} = 4.
-
-@item -a0
-Do not use text antialiasing.
-
-@item -b
-Use white background.
-
-@item -D@var{dir}
-Store rendered images in the directory @file{@var{dir}}.
-
-@item -F@var{dir}
-Put the directory @file{@var{dir}/dev@var{name}} in front of the
-search path for the font, prologue and device description files,
-given the target device @var{name}, usually @strong{html}.
-
-@item -g@var{bits}
-Use this number of @var{bits} (= 1, 2 or 4) for antialiasing of
-drawings.  Default: @var{bits} = 4.
-
-@item -g0
-Do not use antialiasing for drawings.
-
-@item -h
-Use the @code{B} element for section headings.
-
-@item -i@var{resolution}
-Use the @var{resolution} for rendered images.  Default:
-@var{resolution} = 100@dmn{dpi}.
-
-@item -I@var{stem}
-Set the images' @var{stem name}.  Default: @var{stem} =
-@file{grohtml-@var{XXX}} (@var{XXX} is the process ID).
-
-@item -j@var{stem}
-Place each section in a separate file called
-@file{@var{stem}-@var{n}.html} (where @var{n} is a generated section
-number).
-
-@item -l
-Do not generate the table of contents.
-
-@item -n
-Generate simple fragment identifiers.
-
-@item -o@var{offset}
-Use vertical padding @var{offset} for images.
-
-@item -p
-Display the page rendering progress to @code{stderr}.
-
-@item -r
-Do not use horizontal rules to separate headers and footers.
-
-@item -s@var{size}
-Set the base font size, to be modified using the elements @code{BIG}
-and @code{SMALL}.
-
-@item -S@var{level}
-Generate separate files for sections at level @var{level}.
-
-@item -v
-Print the version number.
-
-@item -V
-Generate a validator button at the bottom.
-
-@item -y
-Generate a signature of @code{groff} after the validator button, if any.
-@end table
-
-
-@c ---------------------------------------------------------------------
-
-@node grohtml specific registers and strings,  , Invoking grohtml, grohtml
-@subsection @code{grohtml} specific registers and strings
-@cindex registers specific to @code{grohtml}
-@cindex strings specific to @code{grohtml}
-@cindex @code{grohtml}, registers and strings
-
-@DefmpregList {ps4html, grohtml}
-@DefmpstrListEndx {www-image-template, grohtml}
-The registers @code{ps4html} and @code{www-image-template} are defined
-by the @code{pre-grohtml} preprocessor.  @code{pre-grohtml} reads in the
-@code{troff} input, marks up the inline equations and passes the result
-firstly to
-
-@Example
-troff -Tps -rps4html=1 -dwww-image-template=@var{template}
-@endExample
-
-@noindent
-and secondly to
-
-@Example
-troff -Thtml
-@endExample
-
-@noindent
-or
-
-@Example
-troff -Txhtml
-@endExample
-
-@cindex MathML
-The PostScript device is used to create all the image files (for
-@option{-Thtml}; if @option{-Txhtml} is used, all equations are passed
-to @code{geqn} to produce @acronym{MathML}, and the register
-@code{ps4html} enables the macro sets to ignore floating keeps, footers,
-and headings.
-
-The register @code{www-image-template} is set to the user specified
-template name or the default name.
-@endDefmpreg
-
-
-@c =====================================================================
-
-@node gxditview,  , grohtml, Output Devices
-@section @code{gxditview}
-@cindex @code{gxditview}, the program
-
-@c XXX
-
-@menu
-* Invoking gxditview::
-@end menu
-
-@c ---------------------------------------------------------------------
-
-@node Invoking gxditview,  , gxditview, gxditview
-@subsection Invoking @code{gxditview}
-@cindex invoking @code{gxditview}
-@cindex @code{gxditview}, invoking
-
-@c XXX
-@c X11's xditview
-
-
 
 @c =====================================================================
 @c =====================================================================
 
-@node File Formats, Copying This Manual, Output Devices, Top
+@node File Formats, Copying This Manual, gtroff Reference, Top
 @chapter File Formats
 @cindex file formats
 @cindex formats, file



reply via email to

[Prev in Thread] Current Thread [Next in Thread]