~ubuntu-branches/ubuntu/hardy/ghostscript/hardy

« back to all changes in this revision

Viewing changes to doc/README

  • Committer: Bazaar Package Importer
  • Author(s): Till Kamppeter
  • Date: 2007-11-22 12:17:43 UTC
  • mfrom: (1.1.7 upstream)
  • Revision ID: james.westby@ubuntu.com-20071122121743-cd70s3ypq0r243mp
Tags: 8.61.dfsg.1-0ubtuntu1
* New upstream release
  o Final 8.61 release
* debian/patches/09_ijs_krgb_support.dpatch: Adapted to upstream changes.
* debian/rules: Updated CUPS-related variables for "make install" calls.
* debian/rules: Remove /usr/include/ghostscript from the ghostscript
  package, they go into lings-dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
                            Overview of Ghostscript
 
2
 
 
3
   This document is a roadmap to the Ghostscript documentation. After
 
4
   looking through it, if you want to install Ghostscript and not only use
 
5
   it, we recommend you read how to install Ghostscript, and how to
 
6
   compile Ghostscript from source code (which is necessary before
 
7
   installing it on Unix and VMS systems).
 
8
     __________________________________________________________________
 
9
 
 
10
Table of contents
 
11
 
 
12
     * Document roadmap by theme
 
13
          + What should I read if I'm a new user?
 
14
          + GPL Ghostscript and commerical Ghostscript
 
15
          + Before building Ghostscript
 
16
          + What should I read if I'm not a new user?
 
17
          + What if I'm a developer?
 
18
          + What if I'm writing documentation?
 
19
     * Presence on the World Wide Web
 
20
          + Ghostscript's home pages
 
21
          + Adobe PostScript, Encapsulated PostScript, and PDF reference
 
22
            documentation
 
23
          + Other material on the WWW
 
24
     * Which document contains what?
 
25
          + Primarily for users:
 
26
 
 
27
     Deprecated.htm
 
28
     Devices.htm
 
29
                       Helpers.htm
 
30
                       Humor.htm
 
31
                       Ps2epsi.htm
 
32
                                      Ps2pdf.htm
 
33
                                      Ps2ps2.htm
 
34
                                      Readme.htm
 
35
                                      Unix-lpr.htm
 
36
                                      Use.htm
 
37
 
 
38
          + For both users and developers:
 
39
 
 
40
     Changes.htm
 
41
     Commprod.htm
 
42
     Fonts.htm
 
43
     Hershey.htm
 
44
                     History*.htm
 
45
                     Install.htm
 
46
                     Language.htm
 
47
                     Make.htm
 
48
                                     News.htm
 
49
                                     Psfiles.htm
 
50
                                     COPYING
 
51
 
 
52
          + Primarily for developers:
 
53
 
 
54
     API.htm
 
55
     C-style.htm
 
56
     DLL.htm
 
57
     Develop.htm
 
58
     Drivers.htm
 
59
                    Htmstyle.htm
 
60
                    Issues.htm
 
61
                    Lib.htm
 
62
                    Projects.htm
 
63
                                    Ps-style.htm
 
64
                                    Release.htm
 
65
                                    Source.htm
 
66
                                    Testing.htm
 
67
                                    Xfonts.htm
 
68
     __________________________________________________________________
 
69
 
 
70
Document roadmap by theme
 
71
 
 
72
  What should I read if I'm a new user?
 
73
 
 
74
     * how to use Ghostscript. This includes both a quickstart
 
75
       introduction to the commandline version and more extensive
 
76
       reference material.
 
77
     * detailed information about specific devices that Ghostscript can
 
78
       use for output
 
79
     * more detailed information about how to use Ghostscript under Unix
 
80
       with lpr as a filter for printing
 
81
     * for information about known problems or to report a new one, please
 
82
       visit bugs.ghostscript.com but remember that free versions of
 
83
       Ghostscript come with with NO WARRANTY and NO SUPPORT
 
84
 
 
85
  GPL and commercial Ghostscript
 
86
 
 
87
   GPL Ghostscript, Artifex Ghostscript and AFPL Ghostscript are different
 
88
   releases.
 
89
     * additional information about GPL Ghostscript releases that is not
 
90
       relevant to commercial versions.
 
91
 
 
92
   If you run into any questions, or if you are going to be using
 
93
   Ghostscript extensively, you should at least skim, and probably
 
94
   eventually read:
 
95
     * about the fonts distributed with Ghostscript, including how to add
 
96
       or replace fonts
 
97
     * a description of the Ghostscript language, and its differences from
 
98
       the documented PostScript language
 
99
     * about the postscript files distributed with Ghostscript (other than
 
100
       fonts)
 
101
 
 
102
  Before building Ghostscript
 
103
 
 
104
   If you are going to compile Ghostscript from source, rather than just
 
105
   use an executable you got from somewhere, you may want to read:
 
106
     * how to build Ghostscript and install it
 
107
     __________________________________________________________________
 
108
 
 
109
What should I read if I'm not a new user?
 
110
 
 
111
   If you have already used Ghostscript, when you receive a new release
 
112
   you should begin by reading this file, then
 
113
     * News.htm, for incompatible changes and new features in the current
 
114
       release;
 
115
     * if you wish, Changes.htm, for a detailed list of changes in the
 
116
       current release;
 
117
     * if you wish, History#.htm (currently History8.htm), for changes in
 
118
       other releases.
 
119
     __________________________________________________________________
 
120
 
 
121
What if I'm a developer?
 
122
 
 
123
   If you are going to do any development on or with Ghostscript at all,
 
124
   you should at least look at
 
125
     * the roadmap documentation for Ghostscript's source files and
 
126
       architecture
 
127
 
 
128
   If you are going to write a new driver for Ghostscript, you should read
 
129
     * the guide to the Ghostscript source code
 
130
     * the interface between Ghostscript and device drivers
 
131
     * about the external font interface between Ghostscript and
 
132
       platform-supplied fonts
 
133
 
 
134
   If you are considering distributing GPL Ghostscript in conjunction with
 
135
   a commercial product, you should read the license carefully, and you
 
136
   should also read
 
137
     * additional clarification of the circumstances under which
 
138
       Ghostscript can be distributed with a commercial product
 
139
 
 
140
   If you intend to use Ghostscript in the form of a dynamic link library
 
141
   (DLL) under OS/2 or Microsoft Windows or in the form of shared object
 
142
   under Linux, read
 
143
     * documentation on Ghostscript Interpreter API
 
144
 
 
145
   If you want to use Ghostscript as part of another program--as a
 
146
   callable PostScript language interpreter--and not as a DLL or as a
 
147
   self-contained executable application, you should begin by reading
 
148
     * the source file imain.h, the documented API for Ghostscript not as
 
149
       a DLL
 
150
 
 
151
   or if you are going to use only the Ghostscript graphics library,
 
152
     * about the structure of the Ghostscript library and its interfaces
 
153
     __________________________________________________________________
 
154
 
 
155
What if I'm writing documentation?
 
156
 
 
157
   If you are editing or adding to Ghostscript's existing documentation in
 
158
   HTML format, or writing a new document, you should read
 
159
     * the coding and style guidelines for Ghostscript's HTML-based
 
160
       documentation.
 
161
     __________________________________________________________________
 
162
 
 
163
Presence on the World Wide Web
 
164
 
 
165
  Ghostscript's home page
 
166
 
 
167
   Ghostscript has a home page on the World Wide Web with helpful
 
168
   information such as the FAQ (Frequently Asked Questions) and a list of
 
169
   known problems and workarounds for the current GPL Ghostscript release
 
170
   (in the "Obtaining" file for that release):
 
171
 
 
172
     http://www.cs.wisc.edu/~ghost/
 
173
 
 
174
   More material about Ghostscript can be found at
 
175
 
 
176
     http://www.ghostscript.com/
 
177
 
 
178
  Adobe PostScript, Encapsulated PostScript, and PDF reference documentation
 
179
 
 
180
   Adobe makes a wealth of technical documentation available over the Web,
 
181
   including the PostScript Language Reference Manual (Third Edition); the
 
182
   Encapsulated PostScript (EPS) Format Specification version 3, including
 
183
   Encapsulated PostScript Interchange (EPSI) format; the PDF Reference
 
184
   manuals. The Acrobat SDK contains pdfmark and Acrobat Distiller
 
185
   parameters documentation. Some of these documents are also available at
 
186
   Adobe's ftp site, but not necessarily under the same filenames.
 
187
 
 
188
  Other material on the WWW
 
189
 
 
190
   Much other material about Ghostscript is available on the World Wide
 
191
   Web, both as web pages and as archived Usenet and mailing list
 
192
   discussions. Use the well-known search engines to find such material.
 
193
 
 
194
   There is a translation of the Ghostscript 'man' pages into Czech at:
 
195
 
 
196
     http://www.volny.cz/rebus/ghostscript/
 
197
     __________________________________________________________________
 
198
 
 
199
Which document contains what?
 
200
 
 
201
   Here is the list in alphabetic order of Ghostscript documentation, with
 
202
   explanations of the contents.
 
203
 
 
204
   API.htm
 
205
          On MS-Windows and OS/2, Ghostscript is compiled as a dynamic
 
206
          link library (DLL). On Linux, Ghostscript can be compiled as a
 
207
          shared object. This describes how to use it. For developers.
 
208
 
 
209
   C-style.htm
 
210
          Guidelines and style for C coding, which you should follow if,
 
211
          for example, you write a new driver or add or change something
 
212
          in Ghostscript. For developers.
 
213
 
 
214
   Changes.htm
 
215
          A detailed list of all code changes in the current release or
 
216
          pre-release, generated mechanically from the CVS logs. For
 
217
          developers.
 
218
 
 
219
   Commprod.htm
 
220
          The conditions under which Ghostscript may be distributed in a
 
221
          commercial context. See also the GNU General Public License.
 
222
 
 
223
   DLL.htm
 
224
          On OS/2, MS Windows-16 and MS Windows-32 platforms, Ghostscript
 
225
          is compiled as a dynamic link library (DLL). This describes how
 
226
          to use it. For developers. This DLL interface is obsolete. Use
 
227
          API.htm instead.
 
228
 
 
229
   Develop.htm
 
230
          Code orientation for developers. Contains a detailed breakdown
 
231
          of the source files by functional group, and overviews of the
 
232
          major architectural features and services.
 
233
 
 
234
   Deprecated.htm
 
235
          Documention for deprecated devices and features. Features
 
236
          described here will be removed in future versions of
 
237
          Ghostscript.
 
238
 
 
239
   Devices.htm
 
240
          Detailed information about some specific devices for which
 
241
          Ghostscript can produce output. Run "gs -h" to see which devices
 
242
          a particular version of Ghostscript is built to use.
 
243
 
 
244
   Drivers.htm
 
245
          Describes the interface between Ghostscript and device drivers.
 
246
          If you do this, you should also read and use the C style and
 
247
          coding guidelines. Necessary to develop a new driver. For
 
248
          developers.
 
249
 
 
250
   Fonts.htm
 
251
          All about fonts freely available for Ghostscript, and how to add
 
252
          and use new fonts. Also describes how to use Ghostscript fonts
 
253
          as X Windows fonts. For both users and developers.
 
254
 
 
255
   Helpers.htm
 
256
          A note of thanks to people who have helped in the development of
 
257
          Ghostscript.
 
258
 
 
259
   Hershey.htm
 
260
          Part 1 of the five-part original Usenet distribution of the free
 
261
          Hershey fonts, giving the terms of use and describing their
 
262
          encoding.
 
263
 
 
264
   History*.htm
 
265
          The history of changes in all Ghostscript releases:
 
266
 
 
267
     History8.htm for Ghostscript versions 8.n
 
268
     History7.htm for Ghostscript versions 7.n
 
269
     History6.htm for Ghostscript versions 6.n
 
270
     History5.htm for Ghostscript versions 5.n
 
271
     History4.htm for Ghostscript versions 4.n
 
272
     History3.htm for Ghostscript versions 3.n
 
273
     History2.htm for Ghostscript versions 2.n
 
274
     History1.htm for Ghostscript versions 1.n
 
275
 
 
276
   Htmstyle.htm
 
277
          The guidelines and style for HTML coding of Ghostscript's
 
278
          documentation, which you should follow if, for example, you
 
279
          change existing HTML documentation or write new documents. For
 
280
          writers and editors.
 
281
 
 
282
   Humor.htm
 
283
          Another Ghostscript interpreter.
 
284
 
 
285
   Install.htm
 
286
          How to install Ghostscript. See also how to build it.
 
287
 
 
288
   Issues.htm
 
289
          A list of outstanding open issues in Ghostscript. These include
 
290
          known limitations, minor bugs, performance issues, differences
 
291
          from Adobe implementations, and others.
 
292
 
 
293
   Language.htm
 
294
          The relationship between the Ghostscript interpreter and the
 
295
          PostScript language as defined by Adobe.
 
296
 
 
297
   Lib.htm
 
298
          A description of the Ghostscript library, a set of procedures to
 
299
          implement the graphics and filtering capabilities that are
 
300
          primitive operations in the PostScript language and in Adobe
 
301
          Portable Document Format (PDF). For developers.
 
302
 
 
303
   Make.htm
 
304
          How to build Ghostscript executables from the source code. See
 
305
          also how to install it. It's not necessary to be a highly
 
306
          experienced developer to build or install Ghostscript, but some
 
307
          experience is needed.
 
308
 
 
309
   News.htm
 
310
          A brief description of the latest release or pre-release of
 
311
          Ghostscript, and a list of any incompatible changes in it.
 
312
          Changes in older releases are described in the history files
 
313
          "History*.htm", which are usually installed in the documentation
 
314
          directory. Run "gs -h" to see where that is.
 
315
 
 
316
   Projects.htm
 
317
          A list of Ghostscript development projects with which we would
 
318
          like help.
 
319
 
 
320
   Ps-style.htm
 
321
          The guidelines and style for postscript coding in Ghostscript.
 
322
          Some of Ghostscript is implemented in the postscript language
 
323
          itself, and various utilities and examples are distributed with
 
324
          it. You should follow these guidelines if you're extending or
 
325
          modifying those files. For developers.
 
326
 
 
327
   Ps2epsi.htm
 
328
          Detailed information on how to use Ghostscript through ps2epsi
 
329
          to convert PostScript to Adobe Encapsulated PostScript
 
330
          Interchange (EPSI) format.
 
331
 
 
332
   Ps2pdf.htm
 
333
          Detailed information on how to use Ghostscript through ps2pdf to
 
334
          convert PostScript to Adobe Portable Document Format (PDF).
 
335
 
 
336
   Ps2ps2.htm
 
337
          Detailed information on how to use Ghostscript through ps2ps2 to
 
338
          convert Adobe Portable Document Format (PDF) or Adobe Postscript
 
339
          Level 3 into Adobe Postscript Level 2.
 
340
 
 
341
   Psfiles.htm
 
342
          A description of the PostScript files (other than font files)
 
343
          distributed with Ghostscript, including initialization routines,
 
344
          utility programs, and sample printable files.
 
345
 
 
346
   COPYING
 
347
          The GNU General Public License, which states the conditions for
 
348
          using and redistributing GPL Ghostscript.
 
349
 
 
350
   Readme.htm
 
351
          This document.
 
352
 
 
353
   Release.htm
 
354
          A description of how to prepare and test a Ghostscript release.
 
355
          Of interest only to developers who want to create new
 
356
          Ghostscript versions for distribution.
 
357
 
 
358
   Source.htm
 
359
          A guide to the Ghostscript source code, for development and
 
360
          debugging.
 
361
 
 
362
   Testing.htm
 
363
          Documentation for using the test scripts located in the
 
364
          toolbin/tests directory, and conventions for writing new testing
 
365
          scripts.
 
366
 
 
367
   Unix-lpr.htm
 
368
          How to set up Ghostscript as a Unix lpr filter.
 
369
 
 
370
   Use.htm
 
371
          Detailed instructions on how to use Ghostscript, including such
 
372
          matters as designating an output device; choosing a default
 
373
          paper size; how Ghostscript finds files, including font files;
 
374
          how it uses environment variables; notes on specific platforms,
 
375
          including the X Window System; and command-line options.
 
376
 
 
377
   Xfonts.htm
 
378
          Ghostscript's external font interface to a host platform's
 
379
          font-rendering mechanism, for developers.
 
380
     __________________________________________________________________
 
381
 
 
382
   Copyright � 2000-2006 Artifex Software, Inc. All rights reserved.
 
383
 
 
384
   This software is provided AS-IS with no warranty, either express or
 
385
   implied. This software is distributed under license and may not be
 
386
   copied, modified or distributed except as expressly authorized under
 
387
   the terms of that license. Refer to licensing information at
 
388
   http://www.artifex.com/ or contact Artifex Software, Inc., 7 Mt. Lassen
 
389
   Drive - Suite A-134, San Rafael, CA 94903, U.S.A., +1(415)492-9861, for
 
390
   further information.
 
391
 
 
392
   Ghostscript version 8.61, 21 November 2007