xref: /plan9/sys/src/cmd/gs/doc/gs-vms.hlp (revision 593dc095aefb2a85c828727bbfa9da139a49bdf4)
17dd7cddfSDavid du Colombier1 gs
23ff48bf5SDavid du Colombier gs - AFPL Ghostscript interpreter/previewer
3*593dc095SDavid du Colombier! $Id: gs-vms.hlp,v 1.37 2005/10/20 19:46:23 ray Exp $
4*593dc095SDavid du Colombier! Ghostscript version 8.53, 20 October 2005
57dd7cddfSDavid du Colombier  Usage:
67dd7cddfSDavid du Colombier   $ gs [options] [file ...]
77dd7cddfSDavid du Colombier
87dd7cddfSDavid du Colombier Ghostscript is an implementation of Adobe Systems' PostScript (tm)
97dd7cddfSDavid du Colombier and Portable Document Format (PDF) languages. Gs reads files in sequence
107dd7cddfSDavid du Colombier and executes them as Ghostscript programs. After doing this, it reads
117dd7cddfSDavid du Colombier further input from the standard input stream (normally the keyboard).
127dd7cddfSDavid du Colombier Each line is interpreted separately. To exit from the interpreter,
137dd7cddfSDavid du Colombier enter the `quit' command. The interpreter also exits gracefully if it
147dd7cddfSDavid du Colombier encounters end-of-file. Typing the interrupt character (e.g. Control-C)
157dd7cddfSDavid du Colombier is also safe.
167dd7cddfSDavid du Colombier
177dd7cddfSDavid du Colombier2 Description
187dd7cddfSDavid du Colombier The interpreter recognizes several switches described below, which
197dd7cddfSDavid du Colombier may appear anywhere in the command line and apply to all files
207dd7cddfSDavid du Colombier thereafter.
217dd7cddfSDavid du Colombier
227dd7cddfSDavid du Colombier You can get a help message by invoking Ghostscript with the -h
237dd7cddfSDavid du Colombier or -? option. This message also lists the available devices.
247dd7cddfSDavid du Colombier
257dd7cddfSDavid du Colombier Ghostscript may be built with multiple output devices. Ghostscript
267dd7cddfSDavid du Colombier normally opens the first one and directs output to it. To use
277dd7cddfSDavid du Colombier device xyz as the initial output device, include the switch
287dd7cddfSDavid du Colombier     "-sDEVICE=xyz"
297dd7cddfSDavid du Colombier in the command line.  Note that this switch must precede the first
307dd7cddfSDavid du Colombier .ps file, and only its first invocation has any effect. For example,
317dd7cddfSDavid du Colombier for printer output in a normal configuration that includes an Epson
327dd7cddfSDavid du Colombier printer driver, you might use the command
337dd7cddfSDavid du Colombier      gs "-sDEVICE=epson" myfile.ps
347dd7cddfSDavid du Colombier instead of just
357dd7cddfSDavid du Colombier      gs myfile.ps
367dd7cddfSDavid du Colombier Alternatively, you can type
377dd7cddfSDavid du Colombier      (epson) selectdevice
387dd7cddfSDavid du Colombier      (myfile.ps) run
397dd7cddfSDavid du Colombier All output then goes to the printer instead of the display until
407dd7cddfSDavid du Colombier further notice. You can switch devices at any time by using the
417dd7cddfSDavid du Colombier selectdevice procedure, e.g.,
427dd7cddfSDavid du Colombier      (vga) selectdevice
437dd7cddfSDavid du Colombier or
447dd7cddfSDavid du Colombier      (epson) selectdevice
457dd7cddfSDavid du Colombier As yet a third alternative, you can define a logical name GS_DEVICE
467dd7cddfSDavid du Colombier as the desired default device name.  The order of precedence for these
477dd7cddfSDavid du Colombier alternatives, highest to lowest, is:
487dd7cddfSDavid du Colombier      selectdevice
497dd7cddfSDavid du Colombier      (command line)
507dd7cddfSDavid du Colombier      GS_DEVICE
517dd7cddfSDavid du Colombier      (first device in build list)
527dd7cddfSDavid du Colombier
537dd7cddfSDavid du Colombier To select the density on a printer, use
547dd7cddfSDavid du Colombier      gs "-sDEVICE=<device>" -r<xres>x<yres>
557dd7cddfSDavid du Colombier For example, on a 9-pin Epson-compatible printer, you can get the
567dd7cddfSDavid du Colombier lowest-density (fastest) mode with
577dd7cddfSDavid du Colombier      gs "-sDEVICE=epson" -r60x72
587dd7cddfSDavid du Colombier and the highest-density mode with
597dd7cddfSDavid du Colombier      gs "-sDEVICE=epson" -r240x72.
607dd7cddfSDavid du Colombier
617dd7cddfSDavid du Colombier If you select a printer as the output device, Ghostscript also
627dd7cddfSDavid du Colombier allows you to control where the device sends its output.  Normally,
637dd7cddfSDavid du Colombier output goes directly to a scratch file on Unix and VMS systems. To
647dd7cddfSDavid du Colombier send the output to a series of files foo1.xyz, foo2.xyz, ..., use
657dd7cddfSDavid du Colombier the switch
667dd7cddfSDavid du Colombier      "-sOutputFile=foo%d.xyz"
677dd7cddfSDavid du Colombier The %d is a printf format specification; you can use other formats
687dd7cddfSDavid du Colombier like %02d.  Each file will receive one page of output. Alternatively,
697dd7cddfSDavid du Colombier to send the output to a single file foo.xyz, with all the pages con-
707dd7cddfSDavid du Colombier catenated, use the switch
717dd7cddfSDavid du Colombier      "-sOutputFile=foo.xyz"
727dd7cddfSDavid du Colombier
737dd7cddfSDavid du Colombier To find out what devices are available, type
747dd7cddfSDavid du Colombier      devicenames ==
757dd7cddfSDavid du Colombier after starting up Ghostscript. Alternatively, you can use the -h or -?
767dd7cddfSDavid du Colombier switch in the command line; the help message also lists the available
777dd7cddfSDavid du Colombier devices.
787dd7cddfSDavid du Colombier
797dd7cddfSDavid du Colombier To select a different paper size, use the command line switch
807dd7cddfSDavid du Colombier      "-sPAPERSIZE=a_known_paper_size"
817dd7cddfSDavid du Colombier e.g.,
827dd7cddfSDavid du Colombier      "-sPAPERSIZE=a4"
837dd7cddfSDavid du Colombier or
847dd7cddfSDavid du Colombier      "-sPAPERSIZE=legal"
857dd7cddfSDavid du Colombier
867dd7cddfSDavid du Colombier  As of this printing, the known paper sizes, defined in gs_statd.ps, are:
877dd7cddfSDavid du Colombier
887dd7cddfSDavid du Colombier  PAPERSIZE    X"         Y"         X cm      Y cm
897dd7cddfSDavid du Colombier  ____________________________________________________
907dd7cddfSDavid du Colombier  11x17        11"        17"        27.94     43.18
917dd7cddfSDavid du Colombier  a0           33.0556"   46.7778"   83.9611   118.816
927dd7cddfSDavid du Colombier  a10          1.02778"   1.45833"   2.61056   3.70417
937dd7cddfSDavid du Colombier  a1           23.3889"   33.0556"   59.4078   83.9611
947dd7cddfSDavid du Colombier  a2           16.5278"   23.3889"   41.9806   59.4078
957dd7cddfSDavid du Colombier  a3           11.6944"   16.5278"   29.7039   41.9806
967dd7cddfSDavid du Colombier  a4           8.26389"   11.6944"   20.9903   29.7039
977dd7cddfSDavid du Colombier  a5           5.84722"   8.26389"   14.8519   20.9903
987dd7cddfSDavid du Colombier  a6           4.125"     5.84722"   10.4775   14.8519
997dd7cddfSDavid du Colombier  a7           2.91667"   4.125"     7.40833   10.4775
1007dd7cddfSDavid du Colombier  a8           2.05556"   2.91667"   5.22111   7.40833
1017dd7cddfSDavid du Colombier  a9           1.45833"   2.05556"   3.70417   5.22111
1027dd7cddfSDavid du Colombier  archA        9"         12"        22.86     30.48
1037dd7cddfSDavid du Colombier  archB        12"        18"        30.48     45.72
1047dd7cddfSDavid du Colombier  archC        18"        24"        45.72     60.96
1057dd7cddfSDavid du Colombier  archD        24"        36"        60.96     91.44
1067dd7cddfSDavid du Colombier  archE        36"        48"        91.44     121.92
1077dd7cddfSDavid du Colombier  b0           39.3889"   55.6667"   100.048   141.393
1087dd7cddfSDavid du Colombier  b1           27.8333"   39.3889"   70.6967   100.048
1097dd7cddfSDavid du Colombier  b2           19.6944"   27.8333"   50.0239   70.6967
1107dd7cddfSDavid du Colombier  b3           13.9167"   19.6944"   35.3483   50.0239
1117dd7cddfSDavid du Colombier  b4           9.84722"   13.9167"   25.0119   35.3483
1127dd7cddfSDavid du Colombier  b5           6.95833"   9.84722"   17.6742   25.0119
1137dd7cddfSDavid du Colombier  flsa         8.5"       13"        21.59     33.02
1147dd7cddfSDavid du Colombier  flse         8.5"       13"        21.59     33.02
1157dd7cddfSDavid du Colombier  halfletter   5.5"       8.5"       13.97     21.59
1167dd7cddfSDavid du Colombier  ledger       17"        11"        43.18     27.94
1177dd7cddfSDavid du Colombier  legal        8.5"       14"        21.59     35.56
1187dd7cddfSDavid du Colombier  letter       8.5"       11"        21.59     27.94
1197dd7cddfSDavid du Colombier  note         7.5"       10"        19.05     25.4
1207dd7cddfSDavid du Colombier
1217dd7cddfSDavid du Colombier  Note that the B paper sizes are ISO sizes: for information about using
1227dd7cddfSDavid du Colombier  JIS B sizes, see `Use.htm'.
1237dd7cddfSDavid du Colombier
1247dd7cddfSDavid du Colombier2 Initialization_files
1257dd7cddfSDavid du Colombier When looking for the initialization files (gs_*.ps), the files related
1267dd7cddfSDavid du Colombier to fonts, or the file for the `run' operator, Ghostscript first tries
1277dd7cddfSDavid du Colombier opening the file with the name as given (i.e., using the current
1287dd7cddfSDavid du Colombier working directory if none is specified).  If this fails, and the file
1297dd7cddfSDavid du Colombier name doesn't specify an explicit directory or drive, Ghostscript will
1307dd7cddfSDavid du Colombier try directories in the following order:
1317dd7cddfSDavid du Colombier
1327dd7cddfSDavid du Colombier 1. The directory/ies specified by the -I switch(es) in the command
1337dd7cddfSDavid du Colombier    line (see below), if any;
1347dd7cddfSDavid du Colombier 2. The directory/ies specified by the GS_LIB logical, if any;
1357dd7cddfSDavid du Colombier 3. The directory/ies specified by the GS_LIB_DEFAULT macro in the
1367dd7cddfSDavid du Colombier    Ghostscript makefile.
1377dd7cddfSDavid du Colombier
1387dd7cddfSDavid du Colombier Each of these (GS_LIB_DEFAULT, GS_LIB, and -I parameter) may be either
1397dd7cddfSDavid du Colombier a single directory, or a list of directories separated by a `:'.
1407dd7cddfSDavid du Colombier
1417dd7cddfSDavid du Colombier2 X_resources
1427dd7cddfSDavid du Colombier Ghostscript looks for the following resources under the program name
1437dd7cddfSDavid du Colombier `Ghostscript':
1447dd7cddfSDavid du Colombier
1457dd7cddfSDavid du Colombier borderWidth
1467dd7cddfSDavid du Colombier  The border width in pixels (default = 1).
1477dd7cddfSDavid du Colombier
1487dd7cddfSDavid du Colombier borderColor
1497dd7cddfSDavid du Colombier  The name of the border color (default = black).
1507dd7cddfSDavid du Colombier
1517dd7cddfSDavid du Colombier geometry
1527dd7cddfSDavid du Colombier  The window size and placement, WxH+X+Y (default is NULL).
1537dd7cddfSDavid du Colombier
1547dd7cddfSDavid du Colombier xResolution
1557dd7cddfSDavid du Colombier  The number of x pixels per inch (default is computed from
1567dd7cddfSDavid du Colombier  WidthOfScreen and WidthMMOfScreen).
1577dd7cddfSDavid du Colombier
1587dd7cddfSDavid du Colombier yResolution
1597dd7cddfSDavid du Colombier  The number of y pixels per inch (default is computed from
1607dd7cddfSDavid du Colombier  HeightOfScreen and HeightMMOfScreen).
1617dd7cddfSDavid du Colombier
1627dd7cddfSDavid du Colombier useBackingPixmap
1637dd7cddfSDavid du Colombier  Determines whether backing store is to be used for saving display
1647dd7cddfSDavid du Colombier  window (default = true).
1657dd7cddfSDavid du Colombier
1667dd7cddfSDavid du Colombier See the file `Use.htm' for a more complete list of resources.
1677dd7cddfSDavid du Colombier
1687dd7cddfSDavid du Colombier To set these resources, put them in a file (such as
1697dd7cddfSDavid du Colombier SYS$Login:ghostscript.dat) in the following form:
1707dd7cddfSDavid du Colombier
1717dd7cddfSDavid du Colombier      Ghostscript*geometry:    612x792-0+0
1727dd7cddfSDavid du Colombier      Ghostscript*xResolution: 72
1737dd7cddfSDavid du Colombier      Ghostscript*yResolution: 72
1747dd7cddfSDavid du Colombier
1757dd7cddfSDavid du Colombier2 Options
1767dd7cddfSDavid du Colombier Note that VMS will convert all command line arguments to lower case
1777dd7cddfSDavid du Colombier if they are not within quotes. Therefore, if a certain command does
1787dd7cddfSDavid du Colombier not work, try again but with quotes around it.
1797dd7cddfSDavid du Colombier
1807dd7cddfSDavid du Colombier  --  filename arg1 ...
1817dd7cddfSDavid du Colombier Takes the next argument as a file name as usual, but takes all
1827dd7cddfSDavid du Colombier remaining arguments (even if they have the syntactic form of switches)
1837dd7cddfSDavid du Colombier and defines the name ARGUMENTS in userdict (not systemdict) as an
1847dd7cddfSDavid du Colombier array of those strings, before running the file.  When Ghostscript
1857dd7cddfSDavid du Colombier finishes executing the file, it exits.
1867dd7cddfSDavid du Colombier
1877dd7cddfSDavid du Colombier  -Dname=token
1887dd7cddfSDavid du Colombier  -dname=token
1897dd7cddfSDavid du Colombier Define a name in systemdict with the given definition.  The token must
1907dd7cddfSDavid du Colombier be exactly one token (as defined by the `token' operator) and must not
1917dd7cddfSDavid du Colombier contain any whitespace.
1927dd7cddfSDavid du Colombier
1937dd7cddfSDavid du Colombier  -Dname
1947dd7cddfSDavid du Colombier  -dname
1957dd7cddfSDavid du Colombier Define a name in systemdict with value=null.
1967dd7cddfSDavid du Colombier
1977dd7cddfSDavid du Colombier  -Sname=string
1987dd7cddfSDavid du Colombier  -sname=string
1997dd7cddfSDavid du Colombier Define a name in systemdict with a given string as value.  This is
2007dd7cddfSDavid du Colombier different from -d.  For example, -dname=35 is equivalent to the
2017dd7cddfSDavid du Colombier program fragment
2027dd7cddfSDavid du Colombier      /name 35 def
2037dd7cddfSDavid du Colombier whereas -sname=35 is equivalent to
2047dd7cddfSDavid du Colombier      /name (35) def
2057dd7cddfSDavid du Colombier
2067dd7cddfSDavid du Colombier  -q
2077dd7cddfSDavid du Colombier Quiet startup - suppress normal startup messages, and also do the
2087dd7cddfSDavid du Colombier equivalent of -dQUIET.
2097dd7cddfSDavid du Colombier
2107dd7cddfSDavid du Colombier  -gnumber1Xnumber2
2117dd7cddfSDavid du Colombier Equivalent to -dDEVICEWIDTH=number1 and -dDEVICEHEIGHT=number2. This is
2127dd7cddfSDavid du Colombier for the benefit of devices (such as X11 windows) that require (or allow)
2137dd7cddfSDavid du Colombier width and height to be specified.
2147dd7cddfSDavid du Colombier
2157dd7cddfSDavid du Colombier  -rnumber
2167dd7cddfSDavid du Colombier  -rnumber1Xnumber2
2177dd7cddfSDavid du Colombier Equivalent to -dDEVICEXRESOLUTION=number1 and -dDEVICEYRESOLUTION=number2
2187dd7cddfSDavid du Colombier This is for the benefit of devices (such as printers) that support
2197dd7cddfSDavid du Colombier multiple X and Y resolutions. (If only one number is given, it is used
2207dd7cddfSDavid du Colombier for both X and Y resolutions.)
2217dd7cddfSDavid du Colombier
2227dd7cddfSDavid du Colombier  -Idirectories
2237dd7cddfSDavid du Colombier Adds the designated list of directories at the head of the search path
2247dd7cddfSDavid du Colombier for library files.
2257dd7cddfSDavid du Colombier
2267dd7cddfSDavid du Colombier Note that gs_init.ps makes systemdict read-only, so the values of names
2277dd7cddfSDavid du Colombier defined with -D/d/S/s cannot be changed (although, of course, they can
2287dd7cddfSDavid du Colombier be superseded by definitions in userdict or other dictionaries.)
2297dd7cddfSDavid du Colombier
2307dd7cddfSDavid du Colombier2 Special_names
2317dd7cddfSDavid du Colombier
2327dd7cddfSDavid du Colombier  -dDISKFONTS
2337dd7cddfSDavid du Colombier Causes individual character outlines to be loaded from the disk the
2347dd7cddfSDavid du Colombier first time they are encountered.  (Normally Ghostscript loads all the
2357dd7cddfSDavid du Colombier character outlines when it loads a font.)  This may allow loading more
2367dd7cddfSDavid du Colombier fonts into RAM, at the expense of slower rendering.
2377dd7cddfSDavid du Colombier
2387dd7cddfSDavid du Colombier  -dNOCACHE
2397dd7cddfSDavid du Colombier Disables character caching.  Only useful for debugging.
2407dd7cddfSDavid du Colombier
2417dd7cddfSDavid du Colombier  -dNOBIND
2427dd7cddfSDavid du Colombier Disables the `bind' operator.  Only useful for debugging.
2437dd7cddfSDavid du Colombier
2447dd7cddfSDavid du Colombier  -dNODISPLAY
2457dd7cddfSDavid du Colombier Suppresses the normal initialization of the output device. This may be
2467dd7cddfSDavid du Colombier useful when debugging.
2477dd7cddfSDavid du Colombier
2487dd7cddfSDavid du Colombier  -dNOPAUSE
2497dd7cddfSDavid du Colombier Disables the prompt and pause at the end of each page. This may be
2507dd7cddfSDavid du Colombier desirable for applications where another program is `driving'
2517dd7cddfSDavid du Colombier Ghostscript.
2527dd7cddfSDavid du Colombier
2537dd7cddfSDavid du Colombier  -dNOPLATFONTS
2547dd7cddfSDavid du Colombier Disables the use of fonts supplied by the underlying platform (e.g.
2557dd7cddfSDavid du Colombier X Windows).  This may be needed if the platform fonts look undesirably
2567dd7cddfSDavid du Colombier different from the scalable fonts.
2577dd7cddfSDavid du Colombier
2587dd7cddfSDavid du Colombier  -dSAFER
2597dd7cddfSDavid du Colombier Disables the deletefile and renamefile operators, and the ability to
2607dd7cddfSDavid du Colombier open files in any mode other than read-only.  This may be desirable
2617dd7cddfSDavid du Colombier for spoolers or other sensitive environments.
2627dd7cddfSDavid du Colombier
2637dd7cddfSDavid du Colombier  -dWRITESYSTEMDICT
2647dd7cddfSDavid du Colombier Leaves systemdict writable.  This is necessary when running special
2657dd7cddfSDavid du Colombier utility programs such as font2c and pcharstr, which must bypass normal
2667dd7cddfSDavid du Colombier PostScript access protection.
2677dd7cddfSDavid du Colombier
2687dd7cddfSDavid du Colombier  -sDEVICE=device
2697dd7cddfSDavid du Colombier Selects an alternate initial output device, as described above.
2707dd7cddfSDavid du Colombier
2717dd7cddfSDavid du Colombier  -sOutputFile=filename
2727dd7cddfSDavid du Colombier Selects an alternate output file for the initial output device, as
2737dd7cddfSDavid du Colombier described above.
2747dd7cddfSDavid du Colombier
2757dd7cddfSDavid du Colombier2 Files
2767dd7cddfSDavid du Colombier!!! Change
2777dd7cddfSDavid du Colombier GS_Root:[Ghostscript.gs4_0]
2787dd7cddfSDavid du Colombier Startup-files, utilities, and basic font definitions.
2797dd7cddfSDavid du Colombier
2807dd7cddfSDavid du Colombier GS_Root:[Ghostscript.Fonts4_0]
2817dd7cddfSDavid du Colombier Additional font definitions.
2827dd7cddfSDavid du Colombier
2837dd7cddfSDavid du Colombier GS_Root:[Ghostscript.gs4_0.Examples]
2847dd7cddfSDavid du Colombier Demo Ghostscript files.
2857dd7cddfSDavid du Colombier
2867dd7cddfSDavid du Colombier GS_Root:[Ghostscript.gs4_0.Doc]
2877dd7cddfSDavid du Colombier Assorted document files.
2887dd7cddfSDavid du Colombier!!! Change
2897dd7cddfSDavid du Colombier2 See_also
2907dd7cddfSDavid du Colombier The various Ghostscript document files (above).
2917dd7cddfSDavid du Colombier
2927dd7cddfSDavid du Colombier2 Bugs
2937dd7cddfSDavid du Colombier See the network news group comp.lang.postscript.
294