[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Groff-commit] groff ChangeLog doc/groff.texinfo
|
From: |
Werner LEMBERG |
|
Subject: |
[Groff-commit] groff ChangeLog doc/groff.texinfo |
|
Date: |
Sat, 29 Jan 2011 16:25:43 +0000 |
CVSROOT: /cvsroot/groff
Module name: groff
Changes by: Werner LEMBERG <wl> 11/01/29 16:25:43
Modified files:
. : ChangeLog
doc : groff.texinfo
Log message:
* doc/groff.texinfo: Complete documentation on output devices.
CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/groff/ChangeLog?cvsroot=groff&r1=1.1286&r2=1.1287
http://cvs.savannah.gnu.org/viewcvs/groff/doc/groff.texinfo?cvsroot=groff&r1=1.301&r2=1.302
Patches:
Index: ChangeLog
===================================================================
RCS file: /cvsroot/groff/groff/ChangeLog,v
retrieving revision 1.1286
retrieving revision 1.1287
diff -u -b -r1.1286 -r1.1287
--- ChangeLog 28 Jan 2011 10:26:33 -0000 1.1286
+++ ChangeLog 29 Jan 2011 16:25:42 -0000 1.1287
@@ -1,3 +1,7 @@
+2011-01-29 Krzysztof Żelechowski <address@hidden>
+
+ * doc/groff.texinfo: Complete documentation on output devices.
+
2011-01-28 Werner LEMBERG <address@hidden>
Handle `refer*.tmac'.
@@ -403,7 +407,7 @@
data consists of spaces only and thus reduces to nothing, set `sz'
to 0.
-2010-11-02 Ulrich Spörlein <address@hidden>
+2010-11-02 Ulrich Spörlein <address@hidden>
[mdoc]: Complete previous patch and document OpenBSD releases.
@@ -418,7 +422,7 @@
* tmac/groff_mdoc.man: Document OpenBSD releases.
Add DragonFly release 2.8.
-2010-11-02 Ulrich Spörlein <address@hidden>
+2010-11-02 Ulrich Spörlein <address@hidden>
[mdoc]: Improve man page.
@@ -683,7 +687,7 @@
* tmac/doc-common (Dx): Define register.
-2009-10-26 Jörg Sonnenberger <address@hidden>
+2009-10-26 Jörg Sonnenberger <address@hidden>
Implement `%U' in mdoc for URL references.
@@ -878,5 +882,5 @@
Local Variables:
version-control: never
-coding: latin-1
+coding: utf-8
End:
Index: doc/groff.texinfo
===================================================================
RCS file: /cvsroot/groff/groff/doc/groff.texinfo,v
retrieving revision 1.301
retrieving revision 1.302
diff -u -b -r1.301 -r1.302
--- doc/groff.texinfo 22 Jan 2011 15:45:02 -0000 1.301
+++ doc/groff.texinfo 29 Jan 2011 16:25:42 -0000 1.302
@@ -6054,13 +6054,13 @@
@result{} :k == 15000
@endExample
-If you process this with the PostScript device (@code{-Tps}), there
-will be a line break eventually after @code{ggg} in both input lines.
-However, after processing the space after @code{ggg}, the partially
-collected line is not overfull yet, so @code{troff} continues to
-collect input until it sees the space (or in this case, the newline)
-after @code{hhh}. At this point, the line is longer than the line
-length, and the line gets broken.
+If you process this with the @sc{PostScript} device (@code{-Tps}),
+there will be a line break eventually after @code{ggg} in both input
+lines. However, after processing the space after @code{ggg}, the
+partially collected line is not overfull yet, so @code{troff}
+continues to collect input until it sees the space (or in this case,
+the newline) after @code{hhh}. At this point, the line is longer
+than the line length, and the line gets broken.
In the first input line, since the @code{\R} escape leaves no traces,
the check for the overfull line hasn't been done yet at the point where
@@ -13919,7 +13919,7 @@
@DefregListEnd {ury}
@cindex PostScript, bounding box
@cindex bounding box
-Retrieve the bounding box of the PostScript image found in
+Retrieve the bounding box of the @sc{PostScript} image found in
@var{filename}. The file must conform to Adobe's @dfn{Document
Structuring Conventions} (DSC); the command searches for a
@code{%%BoundingBox} comment and extracts the bounding box values into
@@ -14912,7 +14912,9 @@
@section @code{grotty}
@cindex @code{grotty}, the program
address@hidden XXX
+The postprocessor @code{grotty} translates the output from GNU
address@hidden into a form suitable for typewriter-like devices. It is
+fully documented on its manual page, @cite{grotty(1)}.
@menu
* Invoking grotty::
@@ -14925,25 +14927,71 @@
@cindex invoking @code{grotty}
@cindex @code{grotty}, invoking
address@hidden XXX
+The postprocessor @command{grotty} accepts the following command-line
+options:
+
address@hidden @option
address@hidden -b
+Do not overstrike bold glyphs. Ignored if @option{-c} isn't used.
+
address@hidden -B
+Do not underline bold-italic glyphs. Ignored if @option{-c} isn't
+used.
+
address@hidden -c
+Use overprint and disable colours for printing on legacy Teletype
+printers (see below).
+
address@hidden -d
+Do not render lines (this is, ignore all @code{\D} escapes).
+
address@hidden -f
+Use form feed control characters in the output.
+
address@hidden address@hidden
+Put the directory @address@hidden/address@hidden in front of the
+search path for the font and device description files, given the
+target device @var{name}.
+
address@hidden -h
+Use horizontal tabs for sequences of 8 space characters.
+
address@hidden -i
+Request italic glyphs from the terminal. Ignored if @option{-c} is
+active.
+
address@hidden -o
+Do not overstrike.
+
address@hidden -r
+Highlight italic glyphs. Ignored if @option{-c} is active.
+
address@hidden -u
+Do not underline italic glyphs. Ignored if @option{-c} isn't used.
address@hidden The following is no longer true; fix and extend it.
address@hidden -U
+Do not overstrike bold-italic glyphs. Ignored if @option{-c} isn't
+used.
address@hidden @pindex less
address@hidden @cindex Teletype
address@hidden @cindex ISO 6249 SGR
address@hidden @cindex terminal control sequences
address@hidden @cindex control sequences, for terminals
address@hidden For TTY output devices, underlining is done by emitting
sequences of
address@hidden @samp{_} and @samp{\b} (the backspace character) before the
actual
address@hidden character. Literally, this is printing an underline character,
then
address@hidden moving back one character position, and printing the actual
character
address@hidden at the same position as the underline character (similar to a
address@hidden typewriter). Usually, a modern terminal can't interpret this
(and
address@hidden the original Teletype machines for which this sequence was
address@hidden appropriate are no longer in use). You need a pager program like
address@hidden @code{less} which translates this into ISO 6429 SGR sequences to
address@hidden control terminals.
address@hidden -v
+Print the version number.
address@hidden table
+
address@hidden less
address@hidden Teletype
address@hidden ISO 6249 SGR
address@hidden terminal control sequences
address@hidden control sequences, for terminals
+The @option{-c} mode for TTY output devices means that underlining is
+done by emitting sequences of @samp{_} and @samp{^H} (the backspace
+character) before the actual character. Literally, this is printing
+an underline character, then moving the caret back one character
+position, and printing the actual character at the same position as
+the underline character (similar to a typewriter). Usually, a modern
+terminal can't interpret this (and the original Teletype machines for
+which this sequence was appropriate are no longer in use). You need
+a pager program like @code{less} which translates this into
address@hidden SGR sequences to control terminals.
@c =====================================================================
@@ -14952,7 +15000,10 @@
@section @code{grops}
@cindex @code{grops}, the program
address@hidden XXX
+The postprocessor @command{grops} translates the output from GNU
address@hidden into a form suitable for Adobe @sc{PostScript}
+devices. It is fully documented on its manual page, @cite{grops(1)}.
+
@menu
* Invoking grops::
@@ -14966,7 +15017,56 @@
@cindex invoking @code{grops}
@cindex @code{grops}, invoking
address@hidden XXX
+The postprocessor @code{grops} accepts the following command-line
+options:
+
address@hidden @option
address@hidden address@hidden
+Use backward compatibility settings given by @var{flags} as
+documented in the @cite{grops(1)} manual page. Overrides the command
address@hidden in the @file{DESC} file.
+
address@hidden address@hidden
+Print @var{n} copies of each page.
+
address@hidden address@hidden
+Put the directory @address@hidden/address@hidden in front of the
+search path for the font, prologue and device description files,
+given the target device @var{name}, usually @strong{ps}.
+
address@hidden -g
+Tell the printer to guess the page length. Useful for printing
+vertically centered pages when the paper dimensions are determined at
+print time.
+
address@hidden address@hidden @dots{}
+Consider the directory @address@hidden for searching included files
+specified with relative paths. The current directory is searched as
+fallback.
+
address@hidden -l
+Use landscape orientation.
+
address@hidden -m
+Use manual feed.
+
address@hidden address@hidden
+Set the page dimensions. Overrides the commands @option{papersize},
address@hidden, and @option{paperwidth} in the @file{DESC}
+file. See the @cite{groff_font(5)} manual page for details.
+
address@hidden address@hidden
+Use the @var{prologue} in the font path as the prologue instead of
+the default @file{prologue}. Overrides the environment variable
address@hidden
+
address@hidden address@hidden
+Set the line thickness to @var{n}/address@hidden Overrides the
+default value @var{n} = 40.
+
address@hidden -v
+Print the version number.
address@hidden table
@c ---------------------------------------------------------------------
@@ -14975,7 +15075,23 @@
@cindex embedding PostScript
@cindex PostScript, embedding
address@hidden XXX
+The escape sequence
+
address@hidden'ps: import @var{file} @var{llx} @var{lly} @var{urx} @var{ury}
+ @var{width} address@hidden'}
+
address@hidden
+places a rectangle of the specified @var{width} containing the
address@hidden drawing from file @var{file} bound by the box from
address@hidden @var{lly} to @var{urx} @var{ury} (in @sc{PostScript}
+coordinates) at the insertion point. If @var{height} is not
+specified, the embedded drawing is scaled proportionally.
+
address@hidden, 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(5)} manual page).
@c =====================================================================
@@ -14984,7 +15100,10 @@
@section @code{grodvi}
@cindex @code{grodvi}, the program
address@hidden XXX
+The postprocessor @command{grodvi} translates the output from GNU
address@hidden into the @strong{DVI} output format compatible with
+the @address@hidden document preparation system. It is fully
+documented on its manual page, @cite{grodvi(1)}.
@menu
* Invoking grodvi::
@@ -14997,7 +15116,33 @@
@cindex invoking @code{grodvi}
@cindex @code{grodvi}, invoking
address@hidden XXX
+The postprocessor @code{grodvi} accepts the following command-line
+options:
+
address@hidden @option
address@hidden -d
+Do not use @strong{tpic} specials to implement drawing commands.
+
address@hidden address@hidden
+Put the directory @address@hidden/address@hidden in front of the
+search path for the font and device description files, given the
+target device @var{name}, usually @strong{dvi}.
+
address@hidden -l
+Use landscape orientation.
+
address@hidden address@hidden
+Set the page dimensions. Overrides the commands @option{papersize},
address@hidden, and @option{paperwidth} in the @file{DESC}
+file. See @cite{groff_font(5)} manual page for details.
+
address@hidden -v
+Print the version number.
+
address@hidden address@hidden
+Set the line thickness to @var{n}/address@hidden Overrides the
+default value @var{n} = 40.
address@hidden table
@c =====================================================================
@@ -15006,7 +15151,10 @@
@section @code{grolj4}
@cindex @code{grolj4}, the program
address@hidden XXX
+The postprocessor @command{grolj4} translates the output from GNU
address@hidden into the @strong{PCL5} output format suitable for
+printing on a @strong{HP address@hidden printer. It is fully
+documented on its manual page, @cite{grolj4(1)}.
@menu
* Invoking grolj4::
@@ -15019,7 +15167,37 @@
@cindex invoking @code{grolj4}
@cindex @code{grolj4}, invoking
address@hidden XXX
+The postprocessor @code{grolj4} accepts the following command-line
+options:
+
address@hidden @option
address@hidden address@hidden
+Print @var{n} copies of each page.
+
address@hidden address@hidden
+Put the directory @address@hidden/address@hidden in front of the
+search path for the font and device description files, given the
+target device @var{name}, usually @strong{lj4}.
+
address@hidden -l
+Use landscape orientation.
+
address@hidden address@hidden
+Set the page dimensions. Valid values for @var{size} are:
address@hidden, @code{legal}, @code{executive}, @code{a4},
address@hidden, @code{monarch}, @code{c5}, @code{b5}, @code{d1}.
+
address@hidden -v
+Print the version number.
+
address@hidden address@hidden
+Set the line thickness to @var{n}/address@hidden Overrides the
+default value @var{n} = 40.
address@hidden table
+
+The special drawing command @code{\D'R @var{dh} @var{dv}'} draws a
+horizontal rectangle from the current position to the position at
+offset (@var{dh},@var{dv}).
@c =====================================================================
@@ -15028,7 +15206,10 @@
@section @code{grolbp}
@cindex @code{grolbp}, the program
address@hidden XXX
+The postprocessor @command{grolbp} translates the output from GNU
address@hidden into the @strong{LBP} output format suitable for
+printing on @strong{Canon CAPSL} printers. It is fully documented on
+its manual page, @cite{grolpb(1)}.
@menu
* Invoking grolbp::
@@ -15041,7 +15222,39 @@
@cindex invoking @code{grolbp}
@cindex @code{grolbp}, invoking
address@hidden XXX
+The postprocessor @code{grolbp} accepts the following command-line
+options:
+
address@hidden @option
address@hidden address@hidden
+Print @var{n} copies of each page.
+
address@hidden address@hidden
+Put the directory @address@hidden/address@hidden in front of the
+search path for the font, prologue and device description files,
+given the target device @var{name}, usually @strong{lbp}.
+
address@hidden -l
+Use landscape orientation.
+
address@hidden address@hidden
+Use the @var{orientation} specified: @code{portrait} or
address@hidden
+
address@hidden address@hidden
+Set the page dimensions. See @cite{groff_font(5)} manual page for
+details.
+
address@hidden address@hidden
+Set the line thickness to @var{n}/address@hidden Overrides the
+default value @var{n} = 40.
+
address@hidden -v
+Print the version number.
+
address@hidden -h
+Print command-line help.
address@hidden table
@c =====================================================================
@@ -15058,7 +15271,7 @@
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.
+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
@@ -15073,6 +15286,8 @@
equation, in which case glyphs for these characters must be defined for
the @code{ps} device as well.
+It is fully documented on its manual page, @cite{grohtml(1)}.
+
@menu
* Invoking grohtml::
* grohtml specific registers and strings::
@@ -15085,7 +15300,82 @@
@cindex invoking @code{grohtml}
@cindex @code{grohtml}, invoking
address@hidden XXX
+The postprocessor @code{grohtml} accepts the following command-line
+options:
+
address@hidden @option
address@hidden address@hidden
+Use this number of @var{bits} (= 1, 2 or 4) for text antialiasing.
+Default: @var{bits} = 4.
+
address@hidden -a0
+Do not use text antialiasing.
+
address@hidden -b
+Use white background.
+
address@hidden address@hidden
+Store rendered images in the directory @address@hidden
+
address@hidden address@hidden
+Put the directory @address@hidden/address@hidden in front of the
+search path for the font, prologue and device description files,
+given the target device @var{name}, usually @strong{html}.
+
address@hidden address@hidden
+Use this number of @var{bits} (= 1, 2 or 4) for antialiasing of
+drawings. Default: @var{bits} = 4.
+
address@hidden -g0
+Do not use antialiasing for drawings.
+
address@hidden -h
+Use the @code{B} element for section headings.
+
address@hidden address@hidden
+Use the @var{resolution} for rendered images. Default:
address@hidden = address@hidden
+
address@hidden address@hidden
+Set the images' @var{stem name}. Default: @var{stem} =
address@hidden@var{XXX}} (@var{XXX} is the process ID).
+
address@hidden address@hidden
+Place each section in a separate file called
address@hidden@address@hidden
+
address@hidden -l
+Do not generate the table of contents.
+
address@hidden -n
+Generate simple fragment identifiers.
+
address@hidden address@hidden
+Use vertical paddding @var{offset} for images.
+
address@hidden -p
+Display the page rendering progress to @code{stderr}.
+
address@hidden -r
+Do not use horizontal rules to separate headers and footers.
+
address@hidden address@hidden
+Set the base font size, to be modified using the elements @code{BIG}
+and @code{SMALL}.
+
address@hidden address@hidden
+Generate separate files for sections at level @var{level}.
+
address@hidden -v
+Print the version number.
+
address@hidden -V
+Generate a validator button at the bottom.
+
address@hidden -y
+Generate a signature of groff after the validator button, if any.
address@hidden table
+
@c ---------------------------------------------------------------------
@@ -15121,7 +15411,7 @@
@endExample
@cindex MathML
-The PostScript device is used to create all the image files (for
+The @sc{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,
@@ -15893,7 +16183,7 @@
@noindent
This output can be fed into @code{grops} to get its representation as a
-PostScript file.
address@hidden file.
@item Low-resolution device @code{latin1}
@@ -15996,14 +16286,14 @@
@item
The old hardware was very different from what we use today. So the
address@hidden devices are also fundamentally different from the ones in
address@hidden&T} @code{troff}. For example, the @acronym{AT&T} PostScript
-device is called @code{post} and has a resolution of only 720 units per
-inch, suitable for printers 20 years ago, while @code{groff}'s @code{ps}
-device has a resolution of 72000 units per inch. Maybe, by implementing
-some rescaling mechanism similar to the classical quasi device
-independence, @code{groff} could emulate @acronym{AT&T}'s @code{post}
-device.
address@hidden devices are also fundamentally different from the ones
+in @acronym{AT&T} @code{troff}. For example, the @acronym{AT&T}
address@hidden device is called @code{post} and has a resolution of
+only 720 units per inch, suitable for printers 20 years ago, while
address@hidden's @code{ps} device has a resolution of 72000 units per
+inch. Maybe, by implementing some rescaling mechanism similar to the
+classical quasi device independence, @code{groff} could emulate
address@hidden&T}'s @code{post} device.
@item
The B-spline command @samp{D~} is correctly handled by the intermediate
@@ -16111,9 +16401,9 @@
@cindex PostScript, PNG image generation
@cindex PNG image generation from PostScript
Needed for @code{grohtml} only. It specifies the program to generate
-PNG images from PostScript input. Under GNU/Linux this is usually
address@hidden but under other systems (notably cygwin) it might be set to
-another name.
+PNG images from @sc{PostScript} input. Under GNU/Linux this is
+usually @code{gs} but under other systems (notably cygwin) it might
+be set to another name.
@item paperlength @var{n}
@kindex paperlength