[gs-cvs] gs/doc

Ralph Giles giles at casper.ghostscript.com
Mon Oct 21 13:54:03 PDT 2002


Update of /cvs/ghostscript/gs/doc
In directory casper:/tmp/cvs-serv19370

Modified Files:
	Deprecated.htm Devices.htm Use.htm 
Log Message:
Updates the usage documentation. The first section is re-written to be easier and quicker for new
users. The rest has been re-arranged for clarity. Moves the bbox documentation to Devices.htm.
Adds descriptions of the *AlphaBits driver parameters. Removes mention of some obsolete options
(-sOUTPUTFILE, -_, -sOutputFile=|) from the introduction; they're still documented elsewhere.


Index: Deprecated.htm
===================================================================
RCS file: /cvs/ghostscript/gs/doc/Deprecated.htm,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- Deprecated.htm	17 Oct 2002 06:37:28 -0000	1.2
+++ Deprecated.htm	21 Oct 2002 20:54:01 -0000	1.3
@@ -3,7 +3,6 @@
 <head>
 <title>Deprecated Ghostscript features</title>
 <!-- $Id$ -->
-<!-- Originally: devices.txt -->
 <link rel="stylesheet" type="text/css" href="gs.css" title="Ghostscript Style">
 </head>
 
@@ -12,7 +11,7 @@
 
 <!-- [1.1 begin headline] ================================================== -->
 
-<h1>Deprecated Ghostscript output devices</h1>
+<h1>Deprecated Ghostscript options and output devices</h1>
 
 <!-- [1.1 end headline] ==================================================== -->
 
@@ -21,6 +20,7 @@
 <h2>Table of contents</h2>
 
 <blockquote><ul>
+<li><a href="#Options">Deprecated Options</a>
 <li><a href="#HP8_color_inkjet">H-P 8xx, 1100, and 1600 color inkjet printers</a>
 <ul>
 <li><a href="#HP8_gdevcd8">Drivers contained in <b><tt>gdevcd8.c</tt></b></a>
@@ -136,6 +136,14 @@
 <!-- [1.0 end visible header] ============================================== -->
 
 <!-- [2.0 begin contents] ================================================== -->
+
+<h2><a name="Options"></a>Deprecated options</h2>
+
+<p>
+For compatibility with older versions of Ghostscript, <tt>-sOUTPUTFILE</tt> 
+is a synonym for <tt>-sOutputFile</tt>. It should not be used in new code.
+
+<hr>
 
 <h2><a name="HP8_color_inkjet"></a>H-P 8xx, 1100, and 1600 color inkjet printers</h2>
 

Index: Devices.htm
===================================================================
RCS file: /cvs/ghostscript/gs/doc/Devices.htm,v
retrieving revision 1.53
retrieving revision 1.54
diff -u -d -r1.53 -r1.54
--- Devices.htm	17 Oct 2002 06:37:28 -0000	1.53
+++ Devices.htm	21 Oct 2002 20:54:01 -0000	1.54
@@ -1037,12 +1037,58 @@
 
 <hr>
 
-<h2><a name="Test"></a>Test devices</h2>
+<h2><a name="Test"></a>Special and Test devices</h2>
 
 <p>
 The devices in this section are intended primarily for testing. They may
 be interesting as code examples, as well.
 
+<h3>Raw 'bit' devices</h3>
+
+<p>There are a collection of 'bit' devices that don't do any special formatting
+but output 'raw' binary data for the page images. These are used for benchmarking
+but can also be useful when you want to directly access the raster data.</p>
+
+<p>
+The raw devices are <tt>bit bitrgb bitcmyk</tt>.
+
+<h3><a name="Bounding_box_output"></a>Bounding box output</h3>
+
+<p>
+There is a special <b><tt>bbox</tt></b> "device" that just prints the
+bounding box of each page.  You select it in the usual way:
+
+<blockquote><b><tt>
+gs -dSAFER -dNOPAUSE -dBATCH -sDEVICE=bbox
+</tt></b></blockquote>
+
+<p>
+It prints the output in a format like this:
+
+<blockquote>
+<pre><b><tt>%%BoundingBox: 14 37 570 719
+%%HiResBoundingBox: 14.308066 37.547999 569.495061 718.319158
+</tt></b></pre></blockquote>
+</p>
+
+<p>
+Currently, it always prints the bounding box on <b><tt>stderr</tt></b>;
+eventually, it should also recognize <b><tt>-sOutputFile=</tt></b>.
+
+<p>
+Note that this device, like other devices, has a resolution and a (maximum)
+page size.  As for other devices, the product (resolution x page size) is
+limited to approximately 500K pixels.  By default, the resolution is 4000
+DPI and the maximum page size is approximately 125", or approximately 9000
+default (1/72") user coordinate units.  If you need to measure larger pages
+than this, you must reset <em>both</em> the resolution and the page size in
+pixels, e.g.,
+
+<blockquote><b><tt>
+gs -dNOPAUSE -dBATCH -sDEVICE=bbox -r100 -g500000x500000
+</tt></b></blockquote>
+
+
 <h3><a name="Permute"></a>Permutation (DeviceN color model)</h3>
 
 <p>
@@ -1073,15 +1119,7 @@
 that any file which sets halftones explicitly will fail a consistency
 check.
 
-<h3>Raw 'bit' devices</h3>
-
-<p>There are a collection of 'bit' devices that don't do any special formatting
-but output 'raw' binary data for the page images. These are used for benchmarking
-but can also be useful when you want to directly access the raster data.</p>
 
-<p>
-The raw devices are <tt>bit bitrgb bitcmyk</tt>.
-</p>
 
 <!-- [2.0 end contents] ==================================================== -->
 

Index: Use.htm
===================================================================
RCS file: /cvs/ghostscript/gs/doc/Use.htm,v
retrieving revision 1.59
retrieving revision 1.60
diff -u -d -r1.59 -r1.60
--- Use.htm	17 Oct 2002 07:37:32 -0000	1.59
+++ Use.htm	21 Oct 2002 20:54:01 -0000	1.60
@@ -26,20 +26,24 @@
 <ul>
 <li><a href="#Help_command">Help at the command line: <b><tt>gs -h</tt></b></a>
 </ul>
-<li><a href="#Pipe_input">Input from a pipe</a>
 <li><a href="#Output_device">Selecting an output device</a>
 <ul>
-<li><a href="#Printer_resolution">Printer resolution</a>
+<li><a href="#Output_resolution">Output resolution</a>
 <li><a href="#File_output">Output to files</a>
 <ul>
 <li><a href="#One_page_per_file">One page per file</a>
[...1017 lines suppressed...]
+<dl>
+<dt><a href="#Temp_files"><b><tt>TEMP</tt></b>, <b><tt>TMPDIR</tt></b></a>
+<dd>Defines a directory name for temporary files.  If both
+<b><tt>TEMP</tt></b> and <b><tt>TMPDIR</tt></b> are defined,
+<b><tt>TMPDIR</tt></b> takes precedence.
+</dl>
+
 <hr>
 
 <h2><a name="Debugging"></a>Debugging</h2>
@@ -3148,8 +3006,7 @@
 <hr>
 
 <p>
-<small>Copyright &copy; 1996, 2000 Aladdin Enterprises.  All rights
-reserved.</small>
+<small>Copyright &copy; 1996-2002 artofcode LLC. All rights reserved.</small>
 
 <p>
 This software is provided AS-IS with no warranty, either express or




More information about the gs-cvs mailing list