Debian Codegraph @

README

raw
1
2 Foomatic 4.0.13
3 ===============
4
5
6 foomatic-db-engine
7 ------------------
8
9 Foomatic's database engine generates PPD files from the data in
10 Foomatic's XML database. It also contains scripts to directly generate
11 print queues and handle jobs.
12
13
14 Till Kamppeter <[email protected]>
15 Lars Uebernickel <[email protected]>
16
17 http://www.openprinting.org/
18
19 This README contains mainly info for developers. See the file USAGE if
20 you want to know how to use Foomatic.
21
22
23 Copying
24 -------
25
26 This package and also the other Foomatic packages needed to run this
27 are under the GPL. See http://www.gnu.org/.
28
29
30 Bugs
31 ----
32
33 If you spot a data error or any other bug, please report it on the
34 OpenPrinting bug tracking system:
35
36 http://bugs.linux-foundation.org/
37
38 Choose "OpenPrinting" as the product and "foomatic-db-engine" as the
39 component.
40
41
42 Intro
43 -----
44
45 This is the stable version of Foomatic. This version is also the base
46 of our database web interface on
47
48 http://www.openprinting.org/
49
50
51 New features for Foomatic 4.0.x
52 -------------------------------
53
54 Added in 4.0.0:
55
56 - Support for the PDF-based printing workflow. foomatic-rip now
57 understands both PostScript and PDF as input. PPDs are generated
58 with two "*cupsFilter" lines now, so that CUPS knows that also PDF
59 can get fed in. By the cost factors PDF is made the preferred input
60 format.
61
62 - foomatic-rip is rewritten in C, so that libraries can be used
63 without needing Perl bindings.
64
65 - Support for CUPS custom options. If a printer/driver combo has
66 numerical, string, or password options, appropriate keywords are
67 added to the PPD so that these options are also recognized as CUPS
68 custom options (see
69 http://www.cups.org/documentation.php/doc-1.4/spec-ppd.html for the
70 CUPS PPD extension for custom options).
71
72 - PJL/JCL options in PPD files are now generated in the standard way
73 as defined by the PPD specs. Foomatic keywords are only used if
74 really necessary.
75
76 - Generated PPDs have now an additional "*cupsFilter:" line to tell
77 CUPS that foomatic-rip understands PDF input (output of the
78 "pdftopdf" CUPS filter).
79
80 - Driver XML files can now have a new "<prototype_pdf>" tag in the
81 "<execution>" section, to supply a different command line prototype
82 for PDF input. If left out, the same command line prototype is used
83 for both PDF and PostScript input.
84
85 - Margins in generated PPDs now default to safer values and not to
86 zero if no margins are specified in the XML files.
87
88 - CUPS page accounting can be suppressed on a per-driver basis now,
89 via the tag "<nopageaccounting>" and the PPD keyword
90 "*FoomaticRIPNoPageAccounting: True".
91
92 - Added new "foomatic-ppd-to-xml" utility to generate Foomatic XML
93 files corresponding to a given PPD file.
94
95 - Printer/driver relations now can be defined by the "<printers>"
96 section in the driver XML file or by the "<drivers>" section in the
97 printer XML file. Before, only the former was possible.
98
99 - Added find_printer() method, to search for printers in the
100 database. This method is especially used by the web query API for
101 automatic driver/PPD downloads from the OpenPrinting web site. It
102 can also be used in a local installation with the new
103 "foomatic-searchprinter" utility.
104
105 - Added support for more detailed driver information, like license,
106 whether it is free, whether it comes from the printer's
107 manufacturer, support contacts, short description, by-task
108 ratings. This gives more information to decide on downloading and
109 installing a driver for both driver auto download and browsing the
110 OpenPrinting web site. The information can also be used by printer
111 setup tools using a locally installed Foomatic database. The
112 information is available in the driver XML files (there one enters
113 it), the PPD files, and also in the device ID strings, defined in
114 the PPDs (so that the information goes into the output of "lpinfo
115 -l -m" of CUPS).
116
117
118 New features for Foomatic 3.0.x
119 -------------------------------
120
121 Added after 3.0.2:
122
123 - Support for on-the-fly PPD generation by CUPS 1.2. Now all Foomatic
124 PPDs appear in the model lists of the CUPS web interface without
125 needing to pre-compile the PPDs. The PPDs get actually generated if
126 one selects them for the new print queue to be set up.
127
128 Added in 3.0.2:
129
130 - Some fixes to make foomatic-rip more robust against weird input via
131 the command line or environment variables are done. This solves the
132 problem of an attacker being able to run arbitrary commands as "lp"
133 (or however the spooler's special user is named) on the print
134 server (Security Advisory CAN-2004-0801).
135
136 - Workaround for PostScript generation bug in all OpenOffice.org
137 1.1.x versions.
138
139 - Let the PPD generator use the manufacturer as defined in the
140 Foomatic database and not the one from the IEEE-1284 auto-detection
141 ID string for the "*Manufacturer: ..." tag of the PPD files, as in
142 the IDs the manufacturer names often do not comply with the Adobe
143 specs (as "Hewlett-Packard", "HP" has to be used).
144
145 Added in 3.0.1:
146
147 - CUPS raster drivers can now be used with any spooler. This makes a
148 lot of newer commercial or manufacturer-supplied printer drivers
149 available for non-CUPS environments. To use a CUPS raster driver
150 with a spooler other than CUPS, you need to install Ghostscript
151 (preferrably ESP Ghostscript) with CUPS raster support, the
152 appropriate CUPS raster driver. You do not need to install the
153 complete CUPS package, the CUPS libraries are enough (libcups and
154 libcupsimage, usually in the "libcups" package of your
155 distribution) and to compile CUPS raster drivers you need also the
156 header files of the CUPS library (libcups-devel, cupsys-dev, or
157 similar package of your distro). Then you can set up a print queue
158 with the PPD file of the CUPS driver the same way as if you had a
159 native PostScript printer.
160
161 - If a printer/driver combo has Foomatic-defined JCL options and the
162 driver already generates a JCL header, the JCL options are merged
163 into the header produced by the driver.
164
165 - Workaround for newly introduced PostScript generation bug of
166 OpenOffice.org 1.1.0 (OOo puts settings for whole document into
167 "%%PageSetup" section of first page).
168
169 - Added "use strict;" to the most important Perl scripts, clean-up of
170 the scripts (Thanks to Patrick Powell from LPRng)
171
172 - Improved LPRng support (Thanks to Patrick Powell from LPRng)
173
174 - Printer listing options and auto-selection of recommended driver
175 for the PPD generator foomatic-ppdfile (Thanks to Patrick Powell
176 from LPRng).
177
178 - Support for string options and additional operation modes for
179 foomatic-addpjloptions (Thanks to Patrick Powell from LPRng).
180
181 - Additional checks in the configure scripts (Thanks to Patrick
182 Powell from LPRng).
183
184 - Composite options can be nested now (normal and forced composite
185 options can be mixed).
186
187 - Several modifications to make the PPD files compatible with the
188 PostScript drivers for Windows: 100 instead of 999 choices for the
189 "Copies" options, no "," and "+" in the "*NickName" and
190 "*ShortNickName" entries, optional cutting of the long names of the
191 options and choices (translation strings in the PPDs) to 39
192 characters for compatibility with the Microsoft PostScript driver
193 and the original PostScript driver for Windows of CUPS. All this is
194 not required by the Adobe specification for PPD files.
195
196 - Compatibility fixes for IRIX and the *BSD operating systems.
197
198 - Script to update the "gutenprint" driver entry in the database
199 using the src/foomatic/foomatic-printermap file of the source
200 tarball of Gutenprint 5.0.x.
201
202 - perltoxml() Perl function in DB.pm to generate XML database entries
203 from PPD files (thanks to Tim Waugh from Red Hat).
204
205 - Let foomatic-ppdfile (which can be also called under the name
206 "foomatic-datafile", for compatibility with frontends) accept and
207 ignore the "-t" option for backwards compatibility. Now the KDE
208 Printing Manager works correctly again.
209
210 - Fixed PPD file generation so that the files pass the "cupstestppd"
211 of CUPS 1.1.20.
212
213 Added in 3.0.0:
214
215 - For all supported spoolers (CUPS, LPRng, LPD, GNUlpr, PPR, PDQ,
216 CPS, no spooler) the same PostScript-to-printer's-native-language
217 filter (RIP, Raster Image Processor), foomatic-rip is
218 used. foomatic-rip detects automatically from which spooler it is
219 called.
220
221 - foomatic-rip gets the info about the printer's capabilities and the
222 driver options and default settings always from PPD files,
223 independent which spooler is used. It is possible to use
224 Foomatic-generated PPD files (usually for non-PostScript printers)
225 or manufacturer- supplied PPD files of PostScript printers. So
226
227 o PPD files of PostScript printers can be used with every spooler,
228 not only with CUPS and PPR and on all spoolers all options will
229 be available. So PostScript printers work always "Perfectly".
230
231 o With the PPD file one has one configuration file for every place
232 where information about the printer and its options is needed:
233 The print queue itself, PPD-aware applications (as Star Office,
234 OpenOffice.org, GIMP, ...), and clients (Windows, Mac, Unix with
235 arbitrary spooler). The PPD format is a standard format used by
236 every modern operating system.
237
238 - PPD building and PostScript processing is done according to the
239 Adobe specifications DSC (Document Structuring Conventions) and PPD
240 (PostScript Printer Description) as published on
241
242 http://partners.adobe.com/public/developer/ps/index_specs.html
243
244 - foomatic-rip inserts all default settings from the PPD file (so you
245 can edit the "*Default..." lines in the PPD files to set the
246 defaults), reads option settings from the user's command line, and
247 from the PostScript data stream. Settings in the PostScript data
248 stream have the highest priority to assure that what one sets in an
249 application is used. Depending on the option type the settings are
250 applied to the renderer's (usually Ghostscript's) command line, to
251 the JCL header, or stuffed in at the right place of the PostScript
252 data stream.
253
254 - Support for option settings only acting on a certain page selection
255 (example: First page on letterhead paper from tray 1, rest on plain
256 paper from tray 2). Settings must be put into the
257 "%%BeginPageSetup"/ "%%EndPageSetup" sections (or at least right
258 after the "%%Page:" comments) of the appropriate pages in the
259 PostScript input file. They can also be specified on the command
260 line by specifying a page range before the option name (ex: "lpr -o
261 1,5-8:ColorMode=CMYK file.ps"). If necessary, the renderer (usually
262 Ghostscript) is stopped and restarted in the middle of the job,
263 when certain pages need a different command line for the
264 renderer. The bug of Star Office/OpenOffice.org inserting the
265 "%%BeginSetup...%%EndSetup" section after the first "%%Page:"
266 comment is taken care of.
267
268 - foomatic-rip does neither use temporary files on the disk, nor does
269 it need to load huge documents completely into memory. All is done
270 in data streams where not more data than necessary is buffered. To
271 make this possible foomatic-rip forks into up to six sub-processes.
272
273 - The installation is very easy, one needs only foomatic-rip
274 (absolutely monolithic, no Perl modules needed), a PPD file, and
275 optionally foomatic-gswrapper. No different files for different
276 spoolers.
277
278 - Custom page size support with all spoolers when the PPD file has
279 Adobe-compliant definitions for usage of custom page sizes.
280
281 - The spooler-less printing mode of foomatic-rip can be used for
282 testing and debugging PPD files in arbitrary directories, one
283 simply specifies them with the new "--ppd" option.
284
285 - With PDQ one can print arbitrary file types now, and even set up
286 raw printers. The PDQ driver files are generated by foomatic-rip,
287 so the user does not need to download more files than with other
288 spoolers.
289
290 - Under PPR 1.50 and newer foomatic-rip runs as a PPR RIP, under
291 older versions, as before, as a PPR interface.
292
293 - foomatic-configure sets up printer queues based on Foomatic
294 database entries, arbitrary third-party PPDs (as shipped with
295 PostScript printers), or raw queues.
296
297 - foomatic-configure is much faster when copying or modifying print
298 queues now, as it does not rebuild the PPD from the Foomatic
299 database all the time (as long as one does not force a rebuild with
300 "-f").
301
302 - foomatic-addpjloptions works also in regular installations now, not
303 only in "inplace" installations.
304
305 - foomatic-compiledb generates only PPD and XML files now.
306
307 - foomatic-datafile is renamed to foomatic-ppdfile, a compatibility
308 link named foomatic-datafile is set. foomatic-ppdfile generates
309 only PPDs, the options "-t" and "-f" are ignored.
310
311 - foomatic-configure, foomatic-printjob, and all the other scripts
312 have the same command lines as in Foomatic 2.0. Exceptions: In
313 foomatic-configure "--oldppd" was dropped, "--ppd" (for setting up
314 a queue with a third-party PPD file) added, and the meaning of "-f"
315 (force rebuild of PPD) changed.
316
317 - Option groups: Options can be put into groups and subgroups in the
318 PPD files, so that GUIs can present them in a structured way (in
319 tabs or in a tree structure). It is nearly completely functional,
320 the only thing missing is translation support ("long names" for the
321 groups, as "Adjustments and Corrections" for "Adjustment", or
322 translations to other languages). Now the PPD generator makes
323 trivial translations ("ThisIsAGroup" -> "This Is A Group")
324 automatically.
325
326 - Composite options: This is a new option type to make it easier for
327 users to choose the best settings for a certain printing task,
328 especially if the driver has very many options. The idea is to have
329 an enumerated choice option which does not directly modify
330 something in the driver's command line but sets several of the
331 other options.
332
333 We will have a "Printout Mode" option for all printers with the
334 following choices:
335
336 Draft
337 Normal
338 High Quality
339 Very High Quality
340 Photo
341
342 For an Epson Stylus Color 680 with Gutenprint it sets the options
343 resolution, dithering, and image type as follows:
344
345 Choice Resolution Dither ImageType
346 ------------------------------------------------------------------
347 Draft 180x180 dpi Very Fast LineArt
348 Normal 360x360 dpi Adaptive Hybrid Photographs
349 High Quality 720x720 dpi Adaptive Hybrid Photographs
350 Very High Qual. 1440x720 dpi Adaptive Hybrid Photographs
351 Photo 2880x720 dpi Even Tone Photographs
352
353 The mentioned settings set all the color mode to "Color", there are
354 also choices with a ".Gray" modifier (ex: "Normal.Gray" which set
355 the color mode to "Grayscale", but the other mentioned options as
356 the standard variants ("Normal").
357
358 The member options of the composite option all get one choice
359 called "FromPrintoutMode"/"Controlled by 'Printout Mode'" added,
360 which gets their default setting. If this choice is selected, the
361 option is set by the composite option according to the table. If
362 the user wants to modify one of the individual member options, he
363 simply chooses a value other than "FromPrintoutMode" for this
364 particular option. In addition the member options will be put into
365 a group (named "Printout Mode"). and the composite option goes into
366 the same group as "PageSize", "InputSlot", ... So the user sees the
367 composite option on the "Front page" of the GUI and can quickly set
368 up print jobs without getting confused. The user with more special
369 demands goes to the tab with the member options and makes detailed
370 choices.
371
372 - Forced composite options: These are special composite options where
373 the user cannot set the individual member options, but only the
374 composite option (the user is forced to use the composite
375 option). This allows options acting at two or more places, for
376 example a "PageSize" option for a driver which is a filter
377 translating Ghostscript bitmap output to the printer's
378 language. One lets one member option be an option inserting
379 PostScript code for the page size into the PostScript input data
380 stream for Ghostscript, and another member option insert the
381 correct bitmap size into the filter's command line. The user sees
382 only the composite option and sets the paper size with it as usual.
383
384 - String and password options: These options allow the user to supply
385 nearly arbitrary strings (a length limit and restrictions be a list
386 of allowed characters or a Perl regular expression can be set) to
387 the printer driver, for example names of color calibration files,
388 fax numbers, passwords for confidential jobs, ... Frequently needed
389 strings can be added as enumerated choices, so a frontend can show
390 the option as a combo-box. The enumerated choices are also used for
391 frontends which only support options as defined by the PPD spec.
392
393 - New handling of numerical options in the PPD files:
394 "*Default<option>: ..." now always contains one of the enumerated
395 choices to be Adobe-compliant, the exact default value for
396 Foomatic-aware applications is stored with the new
397 "*FoomaticRIPDefault<option>: ..." keywords now.
398
399 - URIs (Unified Resource Identifiers, the descriptions for the
400 printer connection type used with the "-c" option of
401 foomatic-configure) are exactly the same as under CUPS now. The
402 only difference was that before for local printers always URIs
403 beginning with "file:" were used, now "parallel:", "usb:", or
404 "serial:" is used. The old form with "file:" is still accepted for
405 compatibility.
406
407 - For USB printers CUPS 1.1.17 and newer supports URIs which refer to
408 manufacturer, model, and serial number and not to the device file
409 (/dev/usb/lp*) any more. This way the queues still work when the
410 printers are plugged in or turned on in another order in a later
411 session (the printers can get different device files
412 then). Foomatic now automatically converts the conventional USB
413 URIs to the new ones when an appropriate versions of CUPS is used.
414 When copying a queue to another spooler the URI is converted back
415 in the copied queue.
416
417 - Support for the MTink daemon from the MTink package
418 (http://xwtools.automatix.de/). MTink allows monitoring the ink
419 levels of Epson inkjets also while printing.
420
421 - Non-printable margins: Both printer and driver XML database entries
422 should get a new section for unprintable margins, so that the
423 "*ImageableArea" entries in the PPD files can be correctly set.
424 Entries should be possible for printers (printer XML file), for
425 drivers (main part of driver XML file), for printer/driver combos
426 (in printer list of driver XML file), and they can contain general
427 margins (valid for all paper sizes) and paper-size-specific
428 margins. If for one "*ImageableArea" entry in a PPD file more than
429 one of the above mentioned possible margin entries applies, the
430 "worst case" (individually determined for each page border) is
431 inserted. If the unprintable margins of a printer depend on options
432 settings, the "worst case" is chosen, too.
433
434 - Facility to make a package consisting of all possible Foomatic PPD
435 files, foomatic-rip, and foomatic-configure, see
436 README.build-foomatic-filters-ppds for how to proceed.
437
438 - Support for inserting arbitrary constant entries (as a default
439 resolution if there is no "Resolution" option) into the PPD
440 file. The entries can be printer-specific, driver-specific, or
441 printer/driver-combo-specific.
442
443 - Extended structure for auto-detection info in printer XML files:
444 General section for entries valid for both USB and parallel port
445 connection, possibility to insert the constant part of the original
446 IEEE-1284 ID string. The ID string will also be inserted into the
447 PPD file.
448
449 - Added a facility to chnage all the cryptic numerical printer IDs
450 from the old PostGreSQL time to clear-text printer IDs. With a
451 translation function it is assured that one can still use the old
452 IDs, for example to not break links to the old linuxprinting.org
453 web site.
454
455 - The Foomatic database uses clear-text printer IDs for all printers
456 now.
457
458 Ideas for future releases:
459
460 - (Soon) Add support for all PPD extensions for the Commom Printing
461 Dialog:
462 http://www.linuxfoundation.org/en/OpenPrinting/CommonPrintingDialog,
463 http://www.linuxfoundation.org/en/OpenPrinting/PPDExtensions
464
465 - Option conflicts: PPDs allow to define conflicts between option
466 settings, so that one cannot set up things which the printer cannot
467 do or which dont make sense (Duplex on transparencies, printing
468 from tray 4 when only 2 trays are installed, ...).
469
470 - Printer and driver classes: The class XML files should look like
471 printer or driver entries, with the same fields and with an
472 additional member list. If one marks an option or an option choice
473 as being valid for a class, it is valid for all member printers and
474 classes, If a printer or driver is a member of a class, all fields
475 which are left blank in this entry, are filled in with the value
476 defined in the appropriate field of the class. If the class
477 contains a comment text, it is shown in addition to the printer's
478 or driver's own text. This saves from a lot of duplicate entering
479 of data when adding printers, drivers, options, choice, option
480 groups, or option conflicts to the database.
481
482
483 General features
484 ----------------
485
486 - The XML database is fully internationalizable, For all
487 human-readable strings translations into different languages can be
488 added and the web query API allows localized requests with answers
489 in the requested language. The OpenPrinting web site appears only
490 in English currently. Not only translations can be done but there
491 can be also different entries for the same printer driver for
492 different regions, so that localized driver packages can get
493 offered for automatic download.
494
495 - There is code to manipulate the XML files of the database. You can
496 load them and get Perl data structures out of them. You can
497 generate a printer overview list which shows all printers and for
498 each printer which drivers make this model work and you can also
499 generate an XML file with all information needed to use a certain
500 printer with a certain driver, which is the basis for the PPD files
501 which are used to configure printer queues under a spooler. These
502 XML files can also be transformed into a Perl data structure.
503
504 - All XML handling is done by two C programs, one makes use of libxml
505 to do a DOM parsing of all types of XML files appearing in the
506 Foomatic system to get Perl data structures out of them, because
507 Foomatic does all printer configuration, job manipulation,
508 printing, and filtering with Perl scripts. The other one does
509 XML-to-XML operations: the generation of the printer overview list,
510 and the generation of the printer/driver combo files. These
511 operations involve reading hundreds of files, cutting them apart
512 and assembling them together in another way. To make this as fast
513 as possible and also less memory-consuming, we do not use libxml,
514 but did the parsing "manually" to keep data moving operations low.
515
516 - All configuration work, especially the generation of the PPD files
517 is done by Perl code, because it is much easier to implemnent text
518 manipulation operations in Perl.
519
520 - A program foomatic-configure is provided which implements complete
521 printer configuration for the common spoolers. It is designed to
522 support CUPS, PPR, PDQ, LPRng, LPD, GNUlpr, and direct spooler-less
523 printing and it is designed to make it easy to write GUI or
524 automagic printer configuration tools. It also transfers queues
525 between different spoolers and generates Perl data structures or
526 XML files so that frontends can build menues.
527
528 - The program foomatic-searchprinter finds printers in the local
529 database, based on manufacturer/model search terms or the printer's
530 device ID. This allows to make scripts which find the printer ID
531 and suitable drivers automatically.
532
533 - Printing and managing print jobs is done by foomatic-printjob, you
534 supply exactly the same command line options for doing the same
535 tasks on every supported spooler.
536
537 - PJL (Printing Job Language) options can be read from the printer
538 and added into the local Foomatic database. This allows access to
539 many functions of the printer which are not supported by the
540 driver, as paper tray selection, toner saving, toner density,
541 ... This is done with foomatic-getpjloptions and
542 foomatic-addpjloptions. Usually, PJL is only supported by PCL or
543 PostScript laser printers.
544
545 - The PPD files serve also for PPD-aware applications as Open Office,
546 the GIMP (Gutenprint plug-in and printers not directly supported by
547 Gutenprint), GPR, Windows/Mac clients using their PostScript driver
548 (and the Linux/Unix server using the Linux driver for the
549 printer). They give access to all the driver's options in the
550 printing dialogs of said applications. This works for all spoolers.
551
552
553 The upshot of all this is that you can now make changes easily and run
554 the scripts to calculate out whatever your printer/spooler needs
555 directly.
556
557
558 Programs and important files from this package
559 ----------------------------------------------
560
561 Note: The scripts appear as ".in" files in the source tree and BZR
562 repository, because the path for the Perl interpreter/the bourne shell
563 is inserted by the "configure" script.
564
565 configure.ac
566
567 The source from which GNU autoconf generates the "configure" script
568
569 acinclude.m4
570
571 Additional macros for the "configure" script
572
573 make_configure
574
575 Calls aclocal and autoconf to generate "configure" from "configure.ac"
576 and "acinclude.m4"
577
578 Makefile.in
579
580 The template from which "configure" generates the Makefile
581
582 install-sh
583
584 Helper script for "configure"
585
586 foomatic-ppdfile
587
588 This program will compute the spooler-independent Foomatic PPD file
589 for any valid printer/driver combo available in the Foomatic
590 database, both for printing with foomatic-rip and for
591 applications/clients being able to access the printer's
592 options. This script serves also as on-the-fly PPD generator for
593 CUPS 1.2.x and newer. "make install" creates a symlink named
594 /usr/lib/cups/driver/foomatic to this script and so CUPS makes all
595 PPDs of the local database available without the PPDs needing to
596 exist physically. CUPS automatically calls foomatic-ppdfile if one
597 of the PPDs is requested. This way in most printer setup tools (all
598 which fully support CUPS 1.2.x and newer) all Foomatic PPDs are
599 available, without explicit Foomatic support by the printer setup
600 tool.
601
602 foomatic-configure
603
604 See USAGE for more info.
605
606 This is the great-grandady of printer configuration programs.
607
608 You can invoke this to configure a printer under any spooler with any
609 sort of printer connection.
610
611 The printer can be either one in the Foomatic database, it can be
612 one for which you have a PPD file (for example a PostScript printer
613 with the PPD from the Windows driver) or a printer which you want to
614 use without driver/filter (raw queue).
615
616 It also includes methods to summarize the current configurations, to add
617 new queues, reconfigure existing queues, enumerate the printers known to
618 the world, and return xml data objects describing individual printers and
619 drivers.
620
621 It should be very straightforward to write interactive printer
622 configuration tools around this script:
623
624 1. foomatic-configure -O prints the XML db overview on stdout
625 2. foomatic-configure -Q prints an XML summary of printer queues
626 3. foomatic-configure -X prints the XML for a database object
627 4. foomatic-configure with various options does the actual setup
628 5. foomatic-configure -P prints Perl structures for frontends
629 6. foomatic-configure -C copies queues, also to other spoolers
630 7. foomatic-configure -D sets a queue as the default queue
631 8. foomatic-configure -R removes a queue
632
633 foomatic-configure supports CUPS, PPR, PDQ, LPD, LPRng, GNUlpr, and
634 direct spooler-less printing nearly completely. The program is
635 structured with a dispatch table; for the cost of a few Perl
636 functions it can support even more spoolers. If not told, it attempts
637 to guess which spooler to use, or asks.
638
639 Regarding item (2), the summary of current config. It shows each
640 queue, giving attributes for spooler, and various settings. Queues
641 with the foomatic attribute set to zero are neither queues set up with
642 the help of the Foomatic database nor set up with a PPD file (and
643 foomatic-rip in case of LPRng, LPD, GNUlpr, PDQ, or no spooler). These
644 queues cannot be modified by foomatic-configure. Trying to modify them
645 would turn them into raw queues. The summary shows also which is the
646 default queue, if a default queue is defined for the current spooler.
647 The $PRINTER environment variable is not taken into account here.
648
649 For all spoolers, foomatic-configure fully groks the configuration
650 format. It rewrites the whole thing, preserving ordering, comments,
651 etc, and regularizing the syntax on each rewrite. So it can change
652 entries that are clearly foomatic-rip/PPD ones, and leave others
653 alone. Also changes of the option default settings done manually (or
654 with GUI tools) are preserved when modifying a queue.
655
656 It is wrong to store configuration in a weird place just because foomatic
657 is used: the user should be able to edit the config by hand the
658 old-fashioned way...
659
660 When configuring printers, the PPD file is put into
661 /etc/foomatic/<spooler>/ (and if needed symlinked to from elsewhere).
662 The PPD files are Adobe-compliant and can also be symlinked/used by
663 applications or clients. They get a basename taken from the queue name.
664
665 For printer configuration frontends it is necessary to get all info
666 about the queue configuration, the options, possible settings, and
667 default settings. This info can be retrieved as a Perl data
668 structure. The structure produced by
669
670 foomatic-configure -q -P > testfile.pl
671
672 can be read by the following Perl script example.pl
673
674 #!/usr/bin/perl
675 my @QUEUES;
676
677 eval (join('',(<STDIN>)));
678
679 my $i;
680 my $N = $#QUEUES + 1;
681 print "$N Queues\n";
682 for ($i = 0; $i < $N; $i++) {
683 my $n = $i + 1;
684 print "$n : $QUEUES[$i]->{'queuedata'}{'queue'}\n";
685 }
686
687 with
688
689 cat testfile.pl | ./example.pl
690
691 Queue copying especially allows to switch between spoolers overtaking
692 ones queues with all settings and adjustments.
693
694 foomatic-searchprinter
695
696 With this tool it is easy to find the desired printer in the
697 database. You do not need to know the exact manufacturer and model
698 name and how it is written in the database. foomatic-searchprinter
699 matches what is closest to your search term. You can even use the
700 IEEE-1284 device ID read from your printer as search term. This
701 tool together with foomatic-configure allows to write printer setup
702 tools for fully automatic print queue setup. Results are shown
703 sorted by relevance and the threshold for accepting results and the
704 amount of results to be shown is adjustable. See
705 "foomatic-searchprinter -h" for available options.
706
707 foomatic-getpjloptions
708
709 Reads the PJL options from local (parallel, USB. serial, ...) or
710 remote (only socket, LPD is not bi-directional) printers to standard
711 output. They can be piped into foomatic-addpjloptions to add them to
712 the database. Call the program without arguments for help.
713
714 foomatic-addpjloptions
715
716 Add the PJL options listed by a printer to the Foomatic
717 database. The option list is read from a file or from standard
718 input. The ID of the printer for which the options are has to be
719 provided (option -p). You can add all PJL options or only the most
720 important ones (-i). When you are adding the options from a file,
721 you are asked whether the printer ID is correct, but you can turn
722 this off if you want (-f). Call the program with the -h option to
723 get help.
724
725 Note: The program needs the three files foomatic-templates/pjl*.xml
726
727 Example for making available the PJL options of the networked HP
728 LaserJet 4050 (Foomatic ID: HP-LaserJet_4050), hostname printer6,
729 port 9100:
730
731 # Remove the "native" PJL options from the database
732 rm -f `grep -li "pjl" db/source/opt/*.xml`
733 # Remove the options from a former PJL option poll on the same printer
734 rm -f foomatic-db/opt/pjl-HP-LaserJet_4050-*
735 # Get the PJL options from the printer
736 foomatic-getpjloptions printer6 9100 | foomatic-addpjloptions -p HP-LaserJet_4050
737 # Move the XML files into the database
738 foomatic-kitload -k foomatic-db/
739 # Set up printer queue
740 foomatic-configure -n LaserJet4050 -c socket://printer6:9100/ \
741 -d pxlmono -p HP-LaserJet_4050
742
743 Instead of using "foomatic-configure" you can also generate the PPD
744 file:
745
746 ./foomatic-ppdfile -d pxlmono -p HP-LaserJet_4050 > lj4050.ppd
747
748 and set up the queue manually as described on
749 http://www.openprinting.org/
750
751 For CUPS you can for example do:
752
753 lpadmin -p LaserJet4050 -E -v socket://printer6:9100/ -P lj4050.ppd
754
755 foomatic-kitload
756
757 This program installs a foomatic data kit into the local data
758 library. It takes a -k <dirname> option, where <dirname> is the
759 toplevel directory of a foomatic driver "kit". A "kit" is a
760 selection of XML source files arranged exactly as in the source/
761 section of the master database (ie, opt/ driver/ printer/ subdirs).
762 Gutenprint foomatic-generator produces exactly such a kit.
763
764 Foomatic-kitload is moderately paranoid about kits: the kit must
765 contain at least one of printer/ driver/ and opt/; the kit must
766 contain only files ending in .xml, the kit cannot be the local
767 library itself, etc. But it does not inspect the contents of the
768 kit files in any way.
769
770 foomatic-printjob
771
772 See USAGE for more info.
773
774 This program implements all the logic for controlling the dynamic
775 elements of queues. In other words, jobs. It'll submit them, provide
776 status on them, cancel them, etc. This provides an easy way for
777 application authors to print in a spooler and driver neutral way.
778
779 foomatic-compiledb
780
781 This program will run around and generate combo data for all valid
782 printer/driver combinations (or for selected drivers). The data is put
783 into one directory and it is generated in a format specified by the user
784 (PPD files or printer/driver combo XML files).
785
786 compile_db takes a -j# flag: it will run that many compute processes
787 in parallel. You should run compile_db with a -j flag to specify how
788 many processes to run concurrently (Gratuitous feature: you can add
789 more processes in the middle without conflict! Just run another with
790 -f until they all finish).
791
792 Generally, compile_db should just not be necessary except for people
793 who want to distribute sets of configuration files. foomatic-ppdfile and
794 especially foomatic-configure will automagically compute just what they
795 need at runtime.
796
797 foomatic-combo-xml
798
799 The Foomatic accelaration engine written in C, it computes
800 printer/driver combo XML files or the printer overview XML file in
801 less then two seconds (on a crappy 128MB/350MHz
802 machine). foomatic-compiledb needs less than three minutes for its
803 job on a two-processor 1GB/1GHz machine. The printer/driver combo
804 XML files are computed around 600 times faster than with the pure
805 Perl programs of the beginning of the XML Foomatic. In addition,
806 foomatic-combo-xml does not need more than 10 MB of memory.
807
808 The program is called by the Foomatic Perl library, but can also be
809 called stand-alone, call the program without command line options to
810 know how to use it.
811
812 foomatic-combo-xml does not need any XML parsing libraries, to make
813 it faster and less memory-consuming, the XML files are somehow
814 "manually" parsed.
815
816 foomatic-perl-data
817
818 The XML-to-Perl translator, also written in C. This program reads
819 the XML files of the Foomatic database and translates them into Perl
820 data structures, so that the Perl scripts can access the data.
821
822 The intention of this program is to not need the many non-standard
823 Perl XML libraries which would make the installation of Foomatic
824 very awkward. Now only the libxml C library is needed, a library
825 which ships with most distributions of free operating systems. One
826 can use either libxml 1.x (1.8.17 and newer) or 2.x, but 2.x is
827 recommended.
828
829 Without any C helper programs the following problems appeared:
830
831 - The thing was *at least* an order of magnitude slower than life
832 under Postgres and Perl was. It took hours to run compile_db, and
833 up to some minutes (at least a few seconds) to compile one combo.
834 The first one took more time as the option cache loaded.
835
836 - Memory: compiledb compute processes peaked at about 150MB RAM.
837 You could turn down the number of computations per process, but it
838 never got much below 130MB.
839
840 - Due to the slowness of the Perl XML handling an on-disk cache was
841 used. This lead to old files from the cache being used when one
842 changed something in the database and forgot to delete the cache.
843
844 - Many non-standard Perl libraries were needed which made the
845 installation of Foomatic rather difficult. Now only the libxml C
846 library is needed. This library ships with every modern distro of
847 GNU/Linux.
848
849 foomatic-fix-xml
850
851 Run this program if you have compiled foomatic-perl-data against
852 libxml 1.x and you have old database entries with a leading blank
853 line. libxml 1.x chokes on leading blank lines.
854
855 foomatic-cleanupdrivers
856
857 Removes all driver entries with empty driver command lines. This way
858 frontends do not show printer/driver combos which do not work.
859
860 foomatic-preferred-driver
861
862 Sets a recommended driver for every printer which has no recommended
863 driver entry or has one pointing to a driver which does not exist in
864 the local Foomatic database (for example when you have removed a
865 driver entry from the database which belongs to a driver which is
866 not built into your Ghostscript).
867
868 foomatic-nonumericalids
869
870 This script changes all old cryptic numerical printer IDs from the
871 old PostGreSQL time to clear-text printer IDs in the installed
872 Foomatic database. The current "foomatic-db" has no numerical IDs
873 any more (this script has been applied to it), but if you use and
874 older Foomatic database (for example to match the of your distro)
875 you can change the IDs with this script. With a translation table it
876 is assured that one can still use the old IDs.
877
878 foomatic-replaceoldprinterids
879
880 Replaces references to old numerical or otherwise obsolete printer
881 IDs in arbitrary files. By default it uses the db/oldprinterids file
882 of the current Foomatic database as translation table, but you can
883 use arbitrary translation tables. You can also give regular
884 expressions (Perl) for the text surrounding the IDs. Do
885 "foomatic-replaceoldprinterids -h" to know how to use it.
886
887 foomatic-ppd-to-xml
888
889 Generates a printer XML file from a given PPD file. This is for
890 example used to make database entries for printers for which there
891 is a manufacturer-supplied PPD file.
892
893 foomatic-printermap-to-gutenprint-xml
894
895 Updates the driver XML file for the Gutenprint driver to the state of
896 the foomatic-printermap file in the Gutenprint source tree. Used to
897 update the driver XML file for Gutenprint in the OpenPrinting database.
898
899 foomatic-ppd-options
900
901 Lists the options in a PPD file one the screen.
902
903
904 Filters
905 -------
906
907 To be able to print with the PPD files and queues made with the stuff
908 in this package, you need only the foomatic-rip filter provided by the
909 "foomatic-filters" package.
910
911 foomatic-rip
912
913 See the documentation of the "foomatic-filters" package for more info.
914
915 This is a universal print filter which works with all printer
916 spoolers auto-detecting the spooler from which it is called. Its job
917 is to translate the incoming data (PostScript or PDF in most cases)
918 to the printer's native language taking into account all option
919 settings, either defaults or job-specific ones. It reads the PPD
920 file assigned to the print queue, either a Foomatic-generated one or
921 a manufacturer-supplied PPD file of a PostScript printer, uses the
922 information to find the default option settings and to build the
923 renderer's (usually Ghostscript, "cat" for PostScript printers)
924 command line, and applies the user-supplied options. Then it builds
925 the renderer's command line and passes the data through it. If the
926 data is not PostScript or PDF, a pre-filter ("a2ps", "enscript",
927 "mpage", ...) is added.
928
929
930
931 About the database
932 ------------------
933
934 The database is provided by the "foomatic-db" package, additional
935 database entries are in "foomatic-db-nonfree", drivers can also supply
936 Foomatic XML files. "foomatic-db" is required for using the programs
937 provided by this package.
938
939 There is a $libdir, somewhere (usually
940 /usr/share/foomatic/). Underneath $libdir there are (Install
941 "foomatic-db" at first and then this package. Then the $libdir will be
942 auto-detected):
943
944 db/ - the database
945 db/oldprinterids - translation table for old numerical
946 printer IDs and for printer IDs which
947 go changed
948 db/kitload.log - list of third-party "kit" files, logged
949 by foomatic-kitload
950 db/source/ - "source" data, provided by humans, etc
951 db/source/printer/<poid>.xml - printer-specific data, one per printer id
952 db/source/driver/<driver>.xml - driver-specific data, one per driver name
953 db/source/opt/<idx>.xml - option data, one file per option
954 db/source/PPD/ - Ready-made PPD files, usually supplied by
955 printer manufacturers for their PostScript
956 printers.
957
958 You can edit the files whenever you want and regenerate the affected
959 printer queues with foomatic-configure, there is no on-disk cache, the
960 data is always directly derived from the source files. So your changes
961 will be taken into account without any special steps.
962
963
964 Foomatic::DB API
965 ----------------
966
967 This API isn't required, now that the data is an an easy-to-process
968 format (nevermind the foomatic-configure language independent "API")
969 for heathen users of non-Perl languages, but even for such dogs it's
970 instructive to poke at how certain things are done:
971
972 get_driverlist
973 get_printerlist
974 get_printers_for_driver
975 get_drivers_for_printer
976
977 These all return lists of printer id's or driver names. The
978 get_foo_for_bar methods accept a printer id or driver name as
979 appropriate; the frst two just return all and take no arguments.
980
981 get_overview
982 get_overview_xml
983
984 This returns an overview listing of all printers, with ids, makes,
985 models, functionaliy, drivers, etc. The various flavors return a
986 Perl data structure or XML.
987
988 get_makes
989 get_models_by_make
990
991 These return makes and models lists.
992
993 get_javascript2
994
995 This returns a JavaScript function that accepts two widget element
996 names. If the first one is set to a value that euqals a known make,
997 then the second one's choices are replaced with a set of models
998 valued with printer IDs. We use this to make a "nested menu" out of
999 two menu controls on a web page.
1000
1001 get_printer_from_make_model
1002
1003 This returns a printer id from a make and model
1004
1005 normalize
1006 normalizename
1007
1008 These are used for sorts to sort printer model names properly and
1009 also to do searches for printer models/IDs. normalize makes the
1010 input string all lower-case, turns a '+' tp 'plus', and removes all
1011 non-alphanumeric characters. normalizename turns all groups of
1012 digits to a zero-padded fixed-length number, so that printers with
1013 the same product line name (like "LaserJet") and different model
1014 numbers appear in correct numerical order. In addition,
1015 normalizename also applies normalize.
1016
1017 get_combo_data_xml
1018
1019 This returns the combined printer/driver data for a particular
1020 combination. Arguments are driver and printer id.
1021
1022 The "combo" operation is less trival than it looks; be careful when
1023 messing with it. It took us hours to get right... Currently, it is
1024 implemented in the foomatic-combo-xml.c C accelerator.
1025
1026 get_printer_xml
1027 get_printer
1028 get_driver_xml
1029 get_driver
1030
1031 These return the information in the printer info or driver info
1032 database files. The *_xml functions produce XML, the others Perl
1033 data structures.
1034
1035 find_printer
1036
1037 This function returns Foomatic printer IDs to match a given search
1038 term. The search term can be manufacturer and model, separated by a
1039 space or a '|', an IEEE-1284 device ID of a printer, manufacturer,
1040 model, Foomatic printer ID, or parts of any of the mentioned items.
1041
1042 getdat
1043
1044 This returns a Perl data structure of all the data for a given
1045 printer/driver combo. It contains a description of printer
1046 capabilities, all options, choices, and ranges valid for this
1047 particular combo. It is used to build the PPD files, but can also
1048 be used by Perl frontends. It takes driver and printer ID arguments;
1049 just like get_combo_data_xml
1050
1051 getppd
1052
1053 This returns the spooler-independent PPD file for foomatic-rip and for
1054 applications and clients. It takes no arguments; instead you must call
1055 getdat first, and they'll then magically find that result.
1056
1057 getdocs
1058 getexecdocs
1059 get_summarydocs
1060
1061 For some reason there are three functions which return documentation
1062 about job options for particular printer/driver pairs. There's also a
1063 fourth one inside foomatic-rip (invoked by the "docs" option).
1064
1065 These work the same way as getppd; you call getdat first.
1066
1067 Once, these worked if you called getdat with only a driver; in that
1068 case it sort of documented it for all printers at once. This is
1069 sort of incomplete, especially what with PJL arguments in the world.
1070 Grant also probably broke it in the xml rewrite. Till has
1071 rewritten getexecdocs to produce documentation for a given printer
1072 driver pair, it provides the data presented on the "Execution Details"
1073 pages of OpenPrinting.
1074
1075 get_libdir
1076
1077 Returns the library directory.
1078
1079
1080 Dependencies
1081 ------------
1082
1083 Besides Perl and a C compiler with its standard libraries you will
1084 need the libxml C library for XML handling and one of the tools
1085 "wget"/"curl".
1086
1087 In addition, you need the Foomatic database ("foomatic-db") and the
1088 Foomatic filters ("foomatic-filters") packages. It is recommended to
1089 install these packages before you install this package. Then the paths
1090 to their components get auto-detected during the build of this
1091 package.
1092
1093 "wget" (from www.gnu.org) is really a standard tool which nearly every
1094 distribution includes.
1095
1096 Because libxml is also used by GNOME, it is probably also part of
1097 every distribution of GNU/Linux or *BSD and one can also easily build
1098 it on any Unix-like operating system. If you distribution does not
1099 provide libxml you can get libxml from
1100
1101 http://www.xmlsoft.org/
1102
1103 If your distribution contains libxml, note that besides the "libxml"
1104 or "libxml2" package you must install also a package with a name
1105 "libxml-devel" or "libxml2-devel" to be able to compile programs which
1106 use libxml. This additional package contains the needed header files
1107 and "xml(2)-config", which tells the C compiler where it finds the
1108 header files. If "xml(2)-config" or some header files in the packages
1109 of your distribution are missing, compile libxml from source.
1110
1111 The versions 1.8.17 and 2.4.19 of libxml are tested, both work, but
1112 1.8.17 requires that the XML files do not have leading blank
1113 lines. Use foomatic-fix-xml if you have such XML files (old or
1114 third-party files).
1115
1116 Using libxml 2.x is highly recommended.
1117
1118 You need libxml 2.x, aclocal (in the "automake" package in some
1119 distros), and autoconf when you want to compile Foomatic from the BZR
1120 repository.
1121
1122 See the USAGE file for compilation details.
1123
1124
1125 Data
1126 ----
1127
1128 There are three main source datafiles (printers, drivers, and options;
1129 annotated examples:
1130
1131
1132 printer/HP-LaserJet_4000.xml
1133 ============================
1134
1135 # The printer file contains information specific to a particular
1136 # printer.
1137
1138 <printer id="printer/HP-LaserJet_4000">
1139
1140 # Make and model are not internationalized. There will eventually be
1141 # an "alias" mechanism, but the need is different.
1142
1143 <make>HP</make>
1144 <model>LaserJet 4000</model>
1145
1146 # According to the Adobe specifications for PPD files every PPD file
1147 # must contain a unique DOS-compatible file name (the "*PCFileName"),
1148 # a file name with an up to 8 characters log base name and an up to 3
1149 # characters long extension, and upper and lower case letters being
1150 # considered as equal. As every PPD file is for a printer/driver
1151 # combo, we let the first 6 characters being provided by the printer
1152 # entry:
1153
1154 <pcmodel>HPLJ4K</pcmodel>
1155
1156 # The first two characters should be the manufacturer prefix as listed
1157 # in Appendix D of Adobe's "PostScript Printer Description (PPD) File
1158 # Format Specification Version 4.3", available on
1159
1160 # http://partners.adobe.com/public/developer/en/ps/5003.PPD_Spec_v4.3.pdf
1161
1162 # Various stuff about the machine
1163
1164 <mechanism>
1165
1166 # Printer types can be <laser />, <led />, <inkjet />, <dotmatrix />,
1167 # <impact />, <sublimation />, <transfer />, <thermal />. Other types
1168 # we have to add to the CGI script on OpenPrinting to make the web
1169 # interface displaying them properly.
1170
1171 <laser />
1172
1173 # At some point we can make color be less of a boolean flag and more
1174 # of a section full of goodies.
1175
1176 <!--not "color"-->
1177 <resolution>
1178
1179 # In theory this is a list. In practice We've only got one per
1180 # printer which is the maximum resolution the manufacturer claims for
1181 # this printer. Do not put empty tags (like "<x></x>" or "<x />" here
1182 # if the resolution is not known. Leave out the tags (or the whole
1183 # <resolution> section).
1184
1185 <dpi>
1186 <x>1200</x>
1187 <y>1200</y>
1188 </dpi>
1189 </resolution>
1190
1191 <consumables>
1192
1193 # Information about ink, drums, etc.
1194 # The comments are supposed to be qualitative ("Separate drum and
1195 # toner cartridges")
1196
1197 <comments>
1198 <en>toner</en>
1199 </comments>
1200
1201 # There can be <partno>12A1975</partno> elements with manufacturer
1202 # part numbers for the various carts, etc it takes. Unfortunately,
1203 # this is not made use of, one could make a consumable database with
1204 # this for example.
1205
1206 <!--one or more "partno" elements.-->
1207 </consumables>
1208 </mechanism>
1209
1210 <url>http://www.pandi.hp.com/pandi-db/prod_info.show?model=C4118A&amp;name=LaserJet4000</url>
1211
1212 # The lang section. In practice this will be only minimally useful;
1213 #
1214 # - Backends can pstops the ps down a level if needed
1215 # - Backends know if pjl options apply
1216 # - Backends can know if direct text printing will work
1217 #
1218 # Commonly used language tags: <pcl level="x" />, <escp2 />, <proprietary />
1219
1220 <lang>
1221 <postscript level="2" />
1222 <pjl />
1223 <text>
1224 <charset>us-ascii</charset>
1225 </text>
1226 </lang>
1227
1228 # The autodetection stuff
1229
1230 <autodetect>
1231
1232 # There are three ways to auto-detect a printer, via the parallel port
1233 # (<parallel>...</parallel>), the USB (<usb>...</usb>), or SNMP
1234 # (TCP/Socket-connected printer, <snmp>...</snmp>). Through these
1235 # interfaces the printers report back an IEEE-1284-complient ID string
1236 # from which the fields "MFG" (<manufacturer>...</manufacturer>),
1237 # "MDL" (<model>...</model>), "DES" (<description>...</description>),
1238 # and "CMD" (<commandset>...</commandset>) are used. The string itself
1239 # can be put between <ieee1284>...</ieee1284> tags, but all items
1240 # which are not constant for all printers of this model, as the serial
1241 # number ("SERN:...;") and the device status ("VSTATUS:...;") have to
1242 # be removed here. As the ID string is usually the same for all
1243 # detection methods, one can put the entries between
1244 # <general>...</general> tags, then the <parallel>...</parallel>,
1245 # <usb>...</usb>, and <snmp>...</snmp> are only used for
1246 # differences to the data between the <general>...</general> tags. A
1247 # complete entry could look like:
1248 #
1249 # <autodetect>
1250 # <general>
1251 # <ieee1284>MFG:HEWLETT-PACKARD;MDL:DESKJET 600;CMD:MLC,PCL,PML;CLASS:PRINTER;DESCRIPTION:Hewlett-Packard DeskJet 600;</ieee1284>
1252 # <commandset>MLC,PCL,PML</commandset>
1253 # <description>Hewlett-Packard DeskJet 600</description>
1254 # <manufacturer>HEWLETT-PACKARD</manufacturer>
1255 # <model>DESKJET 600</model>
1256 # </general>
1257 # </autodetect>
1258 #
1259
1260 # If you use CUPS, you get the device IDs of all locally connected
1261 # (USB, parallel) printers and of printers in the local network by
1262 # running:
1263
1264 lpinfo -l -m
1265
1266 # On Linux you find this info for the parallel ports (/dev/lp<N>, <N>
1267 # = 0, 1, 2, ...) in the files
1268 #
1269 # /proc/sys/dev/parport/parport<N>/autoprobe*
1270 #
1271 # for the USB under Linux it is more complicated, easiest is to use a little
1272 # Perl script, called "getusbprinterid.pl":
1273 # You need to find the IOCTL call value to pass to the perl ioctl function.
1274 # Here is a little C program that does this. This is easier than trying to
1275 # use p2h and convert the *.h files to perl.
1276
1277 # --------------------------------------------------------------------------
1278 # /*
1279 # print the IOCTL call value for printer information
1280 # */
1281 # #include <stdio.h>
1282 # #include <sys/ioctl.h>
1283 # /* From the /usr/src/linux<version>/drivers/usb/printer.c */
1284 # #define DRIVER_VERSION "v0.11"
1285 # #define DRIVER_AUTHOR "Michael Gee, Pavel Machek, Vojtech Pavlik, Randy Dunlap, Pete Zaitcev, David Paschal"
1286 # #define DRIVER_DESC "USB Printer Device Class driver"
1287 #
1288 # #define USBLP_BUF_SIZE 8192
1289 # #define DEVICE_ID_SIZE 1024
1290 #
1291 # /* ioctls: */
1292 # #define LPGETSTATUS 0x060b /* same as in drivers/char/lp.c */
1293 # #define IOCNR_GET_DEVICE_ID 1
1294 # #define IOCNR_GET_PROTOCOLS 2
1295 # #define IOCNR_SET_PROTOCOL 3
1296 # #define IOCNR_HP_SET_CHANNEL 4
1297 # #define IOCNR_GET_BUS_ADDRESS 5
1298 # #define IOCNR_GET_VID_PID 6
1299 # /* Get device_id string: */
1300 # #define LPIOC_GET_DEVICE_ID(len) _IOC(_IOC_READ, 'P', IOCNR_GET_DEVICE_ID, len)
1301 # /* The following ioctls were added for http://hpoj.sourceforge.net */
1302 # /* (HPOJ is replaced by HPLIP, http://hplipopensource.com/): */
1303 # /* Get two-int array:
1304 # * [0]=current protocol (1=7/1/1, 2=7/1/2, 3=7/1/3),
1305 # * [1]=supported protocol mask (mask&(1<<n)!=0 means 7/1/n supported): */
1306 # #define LPIOC_GET_PROTOCOLS(len) _IOC(_IOC_READ, 'P', IOCNR_GET_PROTOCOLS, len)
1307 # /* Set protocol (arg: 1=7/1/1, 2=7/1/2, 3=7/1/3): */
1308 # #define LPIOC_SET_PROTOCOL _IOC(_IOC_WRITE, 'P', IOCNR_SET_PROTOCOL, 0)
1309 # /* Set channel number (HP Vendor-specific command): */
1310 # #define LPIOC_HP_SET_CHANNEL _IOC(_IOC_WRITE, 'P', IOCNR_HP_SET_CHANNEL, 0)
1311 # /* Get two-int array: [0]=bus number, [1]=device address: */
1312 # #define LPIOC_GET_BUS_ADDRESS(len) _IOC(_IOC_READ, 'P', IOCNR_GET_BUS_ADDRESS, len)
1313 # /* Get two-int array: [0]=vendor ID, [1]=product ID: */
1314 # #define LPIOC_GET_VID_PID(len) _IOC(_IOC_READ, 'P', IOCNR_GET_VID_PID, len)
1315 #
1316 #
1317 # int main( int argc, char *argv, char *envp[] )
1318 # {
1319 # int len = 1024;
1320 # int v;
1321 # /* _IOC(), _IOC_READ as defined in /usr/include/asm/ioctl.h
1322 # LPIOC_GET_DEVICE_ID(len) = _IOC(_IOC_READ, 'P', IOCNR_GET_DEVICE_ID, len)
1323 # */
1324 # v = LPIOC_GET_DEVICE_ID(len); printf("$LPIOC_GET_DEVICE_ID = 0x%08x;\n", v );
1325 # v = LPIOC_GET_BUS_ADDRESS(len); printf("$LPIOC_GET_BUS_ADDRESS = 0x%08x;\n", v );
1326 # v = LPIOC_GET_VID_PID(len); printf("$LPIOC_GET_VID_PID = 0x%08x;\n", v );
1327 # return(0);
1328 # }
1329 #
1330 #
1331 # save this to a file, say getv.c, compile and run it, and you get an output
1332 $ like this:
1333 # $LPIOC_GET_DEVICE_ID = 0x84005001;
1334 # $LPIOC_GET_BUS_ADDRESS = 0x84005005;
1335 # $LPIOC_GET_VID_PID = 0x84005006;
1336
1337
1338
1339 # Here is the getusbprinterid.pl PERL program to get the usb information
1340 #
1341 # !/usr/bin/perl
1342 # open FILE, "$ARGV[0]" or die "cannot open $ARGV[0]";
1343 # my $result;
1344 # # len = 1024
1345 # # LPIOC_GET_DEVICE_ID(len) = _IOC(_IOC_READ, 'P', IOCNR_GET_DEVICE_ID, len)
1346 # # _IOC(), _IOC_READ as defined in /usr/include/asm/ioctl.h
1347 # $LPIOC_GET_DEVICE_ID = 0x84005001;
1348 # $LPIOC_GET_BUS_ADDRESS = 0x84005005;
1349 # $LPIOC_GET_VID_PID = 0x84005006;
1350 #
1351 # ioctl(FILE, $LPIOC_GET_DEVICE_ID , $result) or die;
1352 # # Cut resulting string to its real length
1353 # my $length = ord(substr($result, 1, 1)) + (ord(substr($result, 0, 1)) << 8);
1354 # $result = substr($result, 2, $length-2);
1355 # # Remove non-printable characters
1356 # $result =~ tr/[\x0-\x1f]/\./;
1357 # print "DeviceID $result\n";
1358 #
1359 # $result = pack("LL",0);
1360 # ioctl(FILE, $LPIOC_GET_BUS_ADDRESS , $result) or die;
1361 # my( $v1, $v2 ) = unpack("LL", $result );
1362 # print "Bus '$v1', Device '$v2'\n";
1363 #
1364 # $result = pack("LL",0);
1365 # ioctl(FILE, $LPIOC_GET_VID_PID, $result) or die;
1366 # my( $v1, $v2 ) = unpack("LL", $result );
1367 # print "Vendor '$v1', Product '$v2'\n";
1368 #
1369 # close FILE;
1370 #
1371 #
1372 # --------------------------------------------------------------------------
1373
1374 # Running the program with "perl getusbprinterid.pl /dev/usb/lp0" returns the
1375 # ID string of the device on /dev/usb/lp0.
1376 # For example: perl getusbprinter.pl /dev/usb/lp0
1377 # DeviceID MFG:Hewlett-Packard;CMD:PJL,MLC,PCL,PCLXL,POSTSCRIPT;MDL:\
1378 # HP LaserJet 2200;CLS:PRINTER;DES:Hewlett-Packard LaserJet 2200;\
1379 # MEM:8MB;OPTRAY:250Sheets
1380 # Bus '2', Device '2'
1381 # Vendor '1008', Product '535'
1382 #
1383 # (lines broken for clarity)
1384
1385
1386 <!--no known parport probe information-->
1387 </autodetect>
1388
1389 # Our grading system. It's US-style letter grades A, B, D, and F,
1390 # which the website shows as "Perfectly", "Mostly", "Partially" and
1391 # "Paperweight" .
1392 # THERE IS NO `C'!!!
1393
1394 <functionality>A</functionality>
1395
1396 # Arguably, the scores should live with the printer/driver association
1397 # and not on the printer, but then it's a big hassle to figure out if
1398 # a printer works... So the score is the one reached with the driver
1399 # working best, the "recommended" driver.
1400
1401 # There's a spot for this "recommended" driver, usually the driver
1402 # which gives the maximum output quality. It is for user information
1403 # on the web site, but newbie-friendly printer setup GUIs should use
1404 # it, too. system-config-printer, printer setup tool of Fedora/Red
1405 # Hat, Ubuntu, and Mandriva Linux makes use of it, also the former
1406 # printerdrake of Mandriva Linux.
1407
1408 <driver>Postscript-HP</driver>
1409
1410 # The following optional section describes with which drivers this
1411 # printer works. A valid printer/driver pair can be defined by either
1412 # adding the printer to the driver's printer list (the way how it
1413 # worked all the time) but also by adding the driver to the printer's
1414 # driver list. This way a printer can get associated with a driver for
1415 # which there is no driver XML file and a driver can list a supported
1416 # printer which is not in the printer XML database. For providing a
1417 # PPD file both printer and driver XML files must exist, but it is not
1418 # important in which of the two the printer/driver relationship is
1419 # defined.
1420
1421 # The driver list in the printer XML files was introduced for once
1422 # defining links to ready-made PPD files (relative paths without "/",
1423 # "http:", "https:", or "ftp:" in the beginning are relative to
1424 # $libdir/db/source/, absolute links can point to external sites, as
1425 # for example the site of a printer manufacturer, but they must always
1426 # provide the non-interactive download of the PPD file, for example
1427 # via "wget") and second, listing the supported drivers for
1428 # visitor-contributed printer entries (from web input form). The
1429 # comments section is for adding comments specific to the
1430 # printer/driver combo. As it is human-readable it is
1431 # internationalized. Each driver entry here must have a driver ID. PPD
1432 # file link and comment are optional.
1433
1434 <drivers>
1435 <driver>
1436 <id>Postscript-HP</id>
1437 <ppd>PPD/HP/HP_LaserJet_4000_Series.ppd</ppd>
1438 <comments><en>...</en></comments>
1439 </driver>
1440 </drivers>
1441
1442
1443 # The <unverified /> tag marks entries which are entered by visitors
1444 # via the printer input form on the OpenPrinting web site. It does not
1445 # appear in approved entries (= all entries in the BZR repository of
1446 # the foomatic-db package).
1447
1448 <!--not "unverified"-->
1449
1450 # If there is a web site with additional interesting info about this
1451 # printer, it can be mentioned in the entry by putting it between
1452 # <contrib_url>...</contrib_url> tags,
1453
1454 <!--no "contrib_url"-->
1455
1456 # The regular notes section. The allowed tags are: <p>, <a
1457 # href="foobar"> </a> and many other simple tags (<b>, <i>, <tt>,
1458 # ...). Note that to distinguish what is XML and what is the embedded
1459 # HTML, the following replacements have to be made:
1460 #
1461 # < --> &lt;
1462 # > --> &gt;
1463 # " --> &quot;
1464 # ' --> &apos;
1465 # & --> &amp;
1466 #
1467
1468 <comments>
1469 <en>
1470 I don&apos;t believe this:&lt;p&gt;
1471
1472 &lt;i&gt;1200x1200 dpi only possible with Windows drivers,
1473 600x600 can be reached w/o particular software.
1474 The difference is visible, but only slightly, so
1475 the Functionality got &quot;Mostly&quot;&lt;p&gt;&lt;/i&gt;&lt;p&gt;
1476
1477 Do the following:&lt;p&gt;
1478
1479 Set the resolution on the front panel to &quot;Prores 1200&quot;, not
1480 to &quot;Fastres 1200&quot;. When you use CUPS with HPs PPD file, turn
1481 off &quot;Fastres 1200&quot; in the printer configuration
1482 options.&lt;p&gt;
1483
1484 Try the generic PostScript PPD file which comes with KUPS 1.0 or newer.
1485 </en>
1486 </comments>
1487 </printer>
1488
1489
1490 driver/md2k.xml
1491 ===============
1492
1493 The driver files contain information about drivers. There are a few
1494 things, but the two biggies are the prototype and the printers list
1495
1496 <driver id="driver/md2k">
1497 <name>md2k</name>
1498
1499 # According to the Adobe specifications for PPD files every PPD file
1500 # must contain a unique DOS-compatible file name (the "*PCFileName"),
1501 # a file name with an up to 8 characters log base name and an up to 3
1502 # characters long extension, and upper and lower case letters being
1503 # considered as equal. As every PPD file is for a printer/driver combo,
1504 # we let the last 2 characters being provided by the driver entry:
1505
1506 <pcdriver>M2</pcdriver>
1507
1508 # The drivers listed by the OpenPrinting database are usually not
1509 # developed by OpenPrinting. Most free software printer drivers come
1510 # from independent projects, initiated by peopke who want to get their
1511 # printers to work under Linux, some other drivers come from the
1512 # printer manufacturers. So even if OpenPrinting hosts a downloadable
1513 # package of the driver the development of the driver is not part of
1514 # OpenPrinting. Therefore every driver entry has to contain a
1515 # reference to the developers of the driver, where the driver can be
1516 # actually downloaded. The appropriate link goes into the <url> tag:
1517
1518 <url>http://plaza26.mbn.or.jp/~higamasa/gdevmd2k/</url>
1519
1520 # The driver XML files can contain the following tags to describe the
1521 # driver's properties, so that a user can easily find the driver which
1522 # is most suitable for him. The properties are shown in the gray
1523 # driver info boxes on the OpenPrinting web site and they are also
1524 # supposed to be shown by printer setup tools when they offer to
1525 # download a driver from OpenPrinting. It is especially important to
1526 # supply them if a downloadable driver package or PPD files are
1527 # supplied.
1528
1529 # Supplier's name, internationalization (with <en>...</en><de>...</de>...)
1530 # optional
1531
1532 # <supplier>SpliX project</supplier>
1533
1534 # Does the driver come from the printer's manufacturer or from a third
1535 # party. The third form tells also the manufacturer names of the
1536 # printers which are from the manufacturer which developed the
1537 # driver. If there are also printers from other manufacturers
1538 # supported (like for the PCL driver HPIJS) then the OpenPrinting web
1539 # site does not show this driver as manufacturer-supplied on the pages
1540 # of the printers of other manufacturers.
1541
1542 # <thirdpartysupplied /> OR <manufacturersupplied /> OR
1543 # <manufacturersupplied>HP|Apollo</manufacturersupplied>
1544
1545 # License name. Here should be put the common short name or
1546 # abbreviation if the license is one of the common free software
1547 # licenses. Otherwise it should contain something short and
1548 # descriptive, for non-free drivers simply "Commercial". The license
1549 # name can be internationalized with language tags
1550 # (<en>...</en><de>...</de>...).
1551
1552 # <license>GPL</license>
1553
1554 # The license text does not need to be supplied for common free
1555 # software licenses. It should be supplied if:
1556 #
1557 # - The license is not free (<nonfreesoftware /> tag set)
1558 # - The driver has patent issues (<patents /> tag set, describe the
1559 # patent issues here in that case)
1560 # - The license of the driver is free but none of the common licenses
1561 # (<nonfreesoftware /> tag not set)
1562
1563 # <licensetext>
1564 # <en>
1565 # ...
1566 # </en>
1567 # </licensetext>
1568
1569 # License texts can also be linked from external sites:
1570
1571 # <licensetext>
1572 # <en url="http://www.laserstar.com/licenses/en/gl-series-eula.txt" />
1573 # <de url="http://www.laserstar.com/licenses/de/gl-series-eula.txt" />
1574 # ...
1575 # </licensetext>
1576
1577 # License texts have to be given always as plain text, UTF-8-encoded.
1578
1579 # Mark with this tag whether the driver is non-free software
1580
1581 # <nonfreesoftware />
1582
1583 # All driver entries without this tag are considered to be free
1584 # software.
1585
1586 # This tag tells whether there are any patent issues with the driver
1587
1588 # <patents />
1589
1590 # The absence of the tag tells that the driver is free of patent
1591 # issues.
1592
1593 # If a driver entry provides a <licensetext> and is <nonfreesoftware
1594 # /> or with <patents /> printer setup tools which download this
1595 # driver are supposed to present the license text and ask the user
1596 # whether he agrees with it.
1597
1598 # Printer manufacturers could want to package their drivers for
1599 # different market regions (Europe, Asia/Pacific, Americas, ...) as
1600 # the markets demand different capabilities of printer drivers and
1601 # different user-settable options (CJK-language-related stufff for
1602 # example). So there could even be two different driver flavors for
1603 # the same printer but adapted to different regions. To express these
1604 # driver properties there are special tags.
1605
1606 # For each flavor of the driver a separate driver entry (driver XML
1607 # file) has to be supplied. There is no requirement of certain
1608 # properties of the driver flavors to be equal or not. Especially the
1609 # printer lists can contain printers which are not in all flavors, for
1610 # example if printers are only sold in certain regions. To mark which
1611 # entries are belonging together one adds a group tag to each XML
1612 # file, with the same group name, but the name must be different to
1613 # the names of all already existing groups. A locales tag contains all
1614 # language/country codes for which the driver flavor is intended:
1615
1616 # <group>epson-inkjet</group>
1617 # <locales>de en_UK en_IE fr_FR es_ES</locales>
1618
1619 # The codes in the locales tags should be different for the group
1620 # members, to allow to automatically select the most suitable flavor
1621 # if the detected printer is supported by more than one flavor.
1622
1623 # For downloadable drivers support contacts should be given, so that
1624 # users get informed before they do the download and do not complain
1625 # at their OS distribution vendor if the driver downloaded from
1626 # OpenPrinting does not work. The human-readable string for the
1627 # support contact can be internationalized with language tags
1628 # (<en>...</en><de>...</de>...).
1629
1630 # <supportcontacts>
1631 # <supportcontact level="voluntary" url="http://sourceforge.net/forum/?group_id=175815">SpliX forum at SourceForge</supportcontact>
1632 # <supportcontact level="commercial" url="http://www.laserstar.com/support/">LaserStar Support</supportcontact>
1633 # </supportcontacts>
1634
1635 # This is an internationalized short description of the driver,
1636 # typically one line, to be used in the gray driver info boxes, in the
1637 # driver overview list, and also by printer setup tools. If a driver
1638 # entry is for a development version of a driver, tell it here, as the
1639 # long description is not shown everywhere.
1640
1641 # <shortdescription>
1642 # <en>
1643 # Driver for Samsung SPL2 (ML-1710, ...) and SPLc (CLP-500, ...) laser
1644 # printers
1645 # </en>
1646 # </shortdescription>
1647
1648 # If there are downloadable packages for this driver entry on the
1649 # OpenPrinting web site, a <packages> section has to be supplied. This
1650 # tag tells which package files on the OpenPrinting web server belong
1651 # to this driver or on which external server to find packages for this
1652 # driver. It also allows assigning files or locations to different
1653 # components of this driver and to assign scopes to them. Scopes can
1654 # be: "general", "gui", "printer", "scanner", "fax", ... Uses the
1655 # "general" scope if packages are not split. Wild cards are the same
1656 # as used for file masks in the shell (NOT regular expressions). They
1657 # must match both Debian and RPM package file names. Note that between
1658 # file name and version number is a "-" for RPMs and a "_" for Debian
1659 # packages.
1660
1661 # <packages>
1662 # <package scope="general">*splix[_-]1.[0-9].[0-9]*</package>
1663 # </packages>
1664
1665 # It is possible to give absolute paths which can point to external
1666 # sites, as for example the site of a printer manufacturer, so that
1667 # the package can be hosted there but auto-downloaded via
1668 # OpenPrinting. Important is that these packages are auto-downloadable
1669 # LSB packages and that a non-interactive download is provided (should
1670 # also work with utilities like "wget"). Licenses which the users have
1671 # to agree on have to get supplied in the driver XML file. Printer
1672 # setup tools are supposed to ask the user for agreeing if the driver
1673 # is marked as non-free or with patent issues.
1674
1675 # Example for packages provided by an external site:
1676
1677 # <packages>
1678 # <package scope="general" fingerprint="http://download.example.com/printerdrivers/gpg/key-fingerprint.txt">http://download.example.com/printerdrivers/RPMS/i486/*laserstar*;http://download.example.com/printerdrivers/RPMS/x86_64/*laserstar*;http://download.example.com/printerdrivers/debian/dists/lsb3.2/main/binary-i386/*laserstar*;http://download.example.com/printerdrivers/debian/dists/lsb3.2/main/binary-amd64/*laserstar*</package>
1679 # </packages>
1680
1681 # Note that more than one mask can be supplied separating them with
1682 # semicolons (";").
1683
1684 # The masks with absolute paths must match all package files, of all
1685 # architectures (usually i386/i486 and amd64/x86_64) and all package
1686 # systems (RPM and Debian). Use more than one mask if needed. On your
1687 # server each directory with package files inside must be browsable,
1688 # so that a client can expand the wildcards. In addition the packages
1689 # itself need to be readable for everyone so that they can get
1690 # downloaded.
1691
1692 # Note also that the packages on the external server must be in
1693 # regular package repositories, so that automatic updates with the
1694 # package manager tools provided by the user's Linux distribution
1695 # (currently apt, yum, and zypper) can be performed. The configuration
1696 # data for the local tools is derived from the actual file locations,
1697 # which get determined by the masks.
1698
1699 # Important is also that with paths (absolute starting with "http://",
1700 # "https://", or "ftp://" and relative simply having at least a slash
1701 # somewhere) wildcards can only be used after the last slash ("/"). So
1702 # wildcards are only allowed for the file name and not for the
1703 # directory names.
1704
1705 # If the packages are signed, all packages of the same <package> entry
1706 # should be signed with the same key and the key should be registered
1707 # on the key server network. The key fingerprint should be made
1708 # available as a text file on the web site of the driver issuer and
1709 # the site should be with an SSL certificate which has been signed by
1710 # an official registrar. The "fingerprint=..." parameter should then
1711 # provide the link to the file with the key fingerprint. The link must
1712 # be an "https://..." URL and point to a file on a server of the
1713 # driver issuer. Packages must be signed for fully automatic upload by
1714 # default on Linux distributions. See also
1715
1716 # https://www.linuxfoundation.org/collaborate/workgroups/openprinting/writingandpackagingprinterdrivers
1717
1718 # The <functionality> section should make it easier for a user to
1719 # compare different drivers by giving some technical properties and
1720 # ratings (0...100) for common document types, system load, and
1721 # execution speed. The higher the number, the better the driver
1722 # performs here. It is not required to supply all items. Items can be
1723 # left out or can stay empty. <functionality> sections of the same
1724 # format can also be used in the <printer> entries in the <printers>
1725 # list, to describe exceptions for particular printers. If an item is
1726 # left out or empty there, the appropriate item in the general
1727 # <functionality> section is used, so only the items which are
1728 # different for the given printer need to be listed.
1729
1730 # <functionality>
1731 # <maxresx>1200</maxresx>
1732 # <maxresy>1200</maxresy>
1733 # <color /> OR <monochrome />
1734 # <text>100</text>
1735 # <lineart>100</lineart>
1736 # <graphics>100</graphics>
1737 # <photo>80</photo>
1738 # <load>50</load>
1739 # <speed>90</speed>
1740 # </functionality>
1741
1742 # Not all tags are required here, if the valur for a tag is not known,
1743 # the tag has to be left out. Do not put empty tags (like
1744 # "<text></text>" or "<text />" here.
1745
1746 # The <execution> section describes everything needed to execute the
1747 # driver.
1748
1749 <execution>
1750
1751 # Sometimes it is possible that a driver depends on another driver,
1752 # for example a manufacturer publishes a core driver which is
1753 # completely free software and supports most of their printer. In
1754 # addition, he publishes closed-source plugins for the core driver to
1755 # support additional printers where they cannot open the driver code
1756 # for IP reasons. He wants to link in all his driver packages for
1757 # automatic download with the <packages> tags. To make everything work
1758 # correctly he creates one driver entry for the core driver and one
1759 # for each plugin. The printers which do not need the plugin get
1760 # listed as supported by the core driver, the printers needing a
1761 # plugin are listed as supported by the plugin. To avoid that then
1762 # only a plugin gets automatically downloaded one adds a <requires>
1763 # tag to each entry of a plugin, to the beginning of the <execution>
1764 # section:
1765
1766 # <requires version="&gt;= 5.0.1">gutenprint</requires>
1767 # <requires version="&gt;= 2.7.10">hpijs</requires>
1768
1769 # The version attribute is optional, without, every version is
1770 # accepted. Optional relationships (>=, <=, =, <, >) allow to not only
1771 # accept the given version. The '>´ and '<' have to be replaced by the
1772 # appropriate XML entities, as described earlier here for other text
1773 # in the XML files. More than one <requires> tag is allowed.
1774
1775 # Driver types are
1776 #
1777 # <ghostscript /> : The driver code is compiled into Ghostscript
1778 #
1779 # <ijs /> : IJS plug-in. These are raster drivers which connect
1780 # to the IJS interface of the renderer, usually of
1781 # Ghostscript but also of pdftoijs or others. The
1782 # interface is based on pipes and is bi-directional.
1783 # It makes the driver independent of the renderer.
1784 #
1785 # <cups /> : CUPS Raster driver. The raster driver standard
1786 # introduced by CUPS. The renderer generates the CUPS
1787 # Raster format, a bitmap format optimized for printing,
1788 # and it gets piped into the driver.
1789 #
1790 # <opvp /> : OpenPrinting Vector driver. DLL and IPC interface for
1791 # plugging printer drivers into the renderer. This is
1792 # the only solution of mudular printer drivers for high-
1793 # level graphics (vector) PDLs.
1794 #
1795 # <uniprint /> : A uniprint driver, consisting of one or more .upp
1796 # files for Ghostscript.
1797 #
1798 # <filter /> : The driver code is a separate executable and the
1799 # driver does not fit into the groups listed above,
1800 # usually either a filter which converts generic
1801 # bitmap output of Ghostscript to the printer's
1802 # language, or a wrapper around Ghostscript.
1803 #
1804 # <postscript /> : A driver which has PostScript as output (for
1805 # PostScript printers). It usually does not call
1806 # Ghostscript but only applies the user's option
1807 # settings to the data stream. But Ghostscript can
1808 # be called here, too, as for downgrading to a lower
1809 # PostScript level or for handling PDF input.
1810 #
1811 # The driver type only provides information for the web pages (or
1812 # driver auto-download facilities of printer setup tools), it is not
1813 # used when generating PPD files.
1814
1815 <ghostscript />
1816
1817 # The driver's <execution> section can also contain a
1818 #
1819 # <nopjl />
1820 #
1821 # which suppresses the usage of PJL options (options which send PJL
1822 # commands to the printer). This is done with drivers where the driver
1823 # itself already produces a PJL header and where the PJL options
1824 # defined for the supported printers would badly interfere. In most
1825 # cases this is not needed, as foomatic-rip merges the PJL headers of
1826 # the driver and of the PJL options.
1827
1828 # And the driver's <execution> section can also contain a
1829 #
1830 # <nopageaccounting />
1831 #
1832 # This suppresses the inserting of page accounting code (for CUPS)
1833 # into the PostScript data stream. Some drivers lead to unexpected
1834 # behavior with that. Especially for the generic PostScript drivers
1835 # (which do not use Ghostscript in most cases) the accounting code
1836 # should not be inserted.
1837
1838 # The prototype defines what command the backends run to drive this
1839 # printer. It must take at least PostScript, preferably both PDF and
1840 # PostScript on stdin and generate the printer's native language on
1841 # stdout. Various %A, %B, etc substitution "spots" are specified; this
1842 # is where substition options will be placed.
1843
1844 <prototype>gs -q -dBATCH -dSAFER -dQUIET -dNOPAUSE -sDEVICE=md2k%A%Z -sOutputFile=- -</prototype>
1845 </execution>
1846 <comments>
1847 <en>
1848 Part of the gdevmd2k-0.2a package by Shinya Umino. The web page and
1849 documentation are in Japanese.
1850 &lt;a href="/clippings/MD5000-translation.txt"&gt;Here&lt;/a&gt;
1851 is an English translation of the driver's web page, and &lt;a
1852 href="/clippings/alpsmd.txt"&gt;here&lt;/a&gt; is the README from the
1853 driver package.
1854 </en>
1855 </comments>
1856
1857 # if there is only a <prototype> and not a <prototype_pdf> entry,
1858 # foomatic-rip will feed both PostScript and PDF into the command line
1859 # defined with <prototype>, otherwise for PostScript input the
1860 # <prototype> command line is used and for PDF input the
1861 # <prototype_pdf> command line. Both are defined the same way and the
1862 # same command line snippets are inserted from the option settings.
1863
1864 # If there is only a <prototype> defined, PDF will only be fed in if
1865 # the command line begins with "gs " (this means Ghostscript is called
1866 # and Ghostscript understands both PostScript and PDF) and there are
1867 # no options based on inserting active PostScript code into the input
1868 # data stream. Otherwise foomatic-rip converts PDF input to PostScript
1869 # at first and feeds the PostScript through the command line.
1870
1871 # The printer list is a simple list of printers that this driver works
1872 # with. Alternatively, one can tell that a given printer works with a
1873 # given driver also by a <drivers> list in the printer's XML file (see
1874 # above).
1875
1876 <printers>
1877 <printer>
1878 <id>printer/Alps-MD-1000</id><!-- Alps MD-1000 -->
1879 </printer>
1880 <printer>
1881 <id>printer/Alps-MD-1300</id><!-- Alps MD-1300 -->
1882 </printer>
1883 <printer>
1884 <id>printer/Alps-MD-2000</id><!-- Alps MD-2000 -->
1885 </printer>
1886 <printer>
1887 <id>printer/Alps-MD-4000</id><!-- Alps MD-4000 -->
1888 </printer>
1889 </printers>
1890 </driver>
1891
1892 # In the printer list it is also possible to place comments or
1893 # exceptions in the driver's functionality (see above) specific to a
1894 # certain printer/driver pair:
1895
1896 # <printer>
1897 # <id>printer/HP-LaserJet_4050</id><!-- HP LaserJet 4050 -->
1898 # <comments>
1899 # <en>to 1200dpi</en>
1900 # </comments>
1901 # <functionality>
1902 # <monochrome />
1903 # </functionality>
1904 # </printer>
1905
1906 # Note that printer/driver relationships can also be expressed by
1907 # adding the driver to the <drivers> lists of the appropriate printer
1908 # XML files.
1909
1910
1911 source/opt/2.xml
1912 ================
1913
1914 # Every option exists independently from printers or drivers, because
1915 # they might apply to arbitrary combinations of printers and/or
1916 # drivers. In practice, some drivers have wholly unique options
1917 # (gutenprint for example), while others (lots of generic basic
1918 # Ghostscript drivers, for example) share some options.
1919
1920 <option type="enum" id="opt/2">
1921
1922 # Options are of a type "enum", "bool", "int", "float", "string", or
1923 # "password", options have an ID. The id is also the filename.
1924
1925 # The shortname is a spaceless short name for the thing. It must not
1926 # contain / or : (otherwise it will not be handled correctly in PPD
1927 # files). It should be one of the standard Adobe PPD option names if
1928 # apropriate
1929
1930 <arg_shortname>
1931
1932 # Various things here, and all <comments>, are internationalized.
1933 # They take the usual posix locale codes in the form xx[_YY], where xx
1934 # is a two-letter iso language code, and YY is two-letter country code
1935 # to distinguish differing national dialects.
1936 #
1937 # Generally the national dialects won't be very common or necessary
1938 # here. The backends currently require that <en> content be provided.
1939
1940 <en>PageSize</en><!-- backends only know <en> shortnames! -->
1941 </arg_shortname>
1942
1943 # The longname is a short phrase describing the thing in more detail
1944 # GUI tools usually show longnames
1945
1946 <arg_longname>
1947 <en>Page Size</en>
1948 </arg_longname>
1949
1950 # The <comments> are used to form documentation. In theory these can
1951 # become man pages or the like. Example:
1952
1953 # <comments>
1954 # <en>
1955 # This option allows the user to get a lighter or darker printout, but
1956 # keeping totally black areas black and not making white areas gray.
1957 # </en>
1958 # </comments>
1959
1960 <!-- A multilingual <comments> block can appear here, too;
1961 it should be treated as documentation for the user. -->
1962
1963 # The execution section describe how the backend should execute this
1964 # option. The order and spot apply to the *driver*'s prototype for
1965 # <arg_substitution /> (once called commandline) style options, or
1966 # just the order applies for <arg_postscript /> and <arg_pjl />
1967 # options. The order and the <arg_section> go into the "*OrderDependency"
1968 # line of the appropriate option entry in the PPD file, for this example
1969 # one would get
1970
1971 # *OrderDependency: 100 DocumentSetup *PageSize
1972
1973 # When no <arg_section> is given, "AnySetup" is used as a default.
1974
1975 # For <arg_substitution /> options the <arg_proto> is inserted into
1976 # the driver's command line, at the spot (e. g. "%A") whose letter is
1977 # given between the <arg_spot>...</arg_spot> tags, the <arg_proto> of
1978 # an <arg_postscript /> option is a snippet of PostScript code which
1979 # is inserted into the PostScript data stream of the job, for
1980 # DSC-conforming PostScript into the section specified with
1981 # <arg_section>, otherwise in the beginning. The <arg_proto> lines of
1982 # <arg_pjl /> options are PJL commands which are sent to the printer
1983 # before the output of the driver's command line is sent. Because this
1984 # only works reliably when the driver output does not have its own PJL
1985 # command header, these options are ignored when the driver's XML file
1986 # is marked with a <nopjl /> tag in its <execution> section. Drivers
1987 # which produce their own PJL and therefore are marked with <nopjl />
1988 # are for example "hpijs" and "hl1250". There is also the
1989 # <arg_composite /> execution style for composite options, see the
1990 # "Composite Options" section below. The user's value gets put into
1991 # the <arg_proto>'s %s location.
1992
1993 # The <arg_group>...</arg_group> tags put the option into the PPD
1994 # option group named here. In many PPD-based GUIs ("kprinter", "xpp",
1995 # OpenOffice.org, ...) every group is shown as a tab or a tree branch
1996 # containing the member options of this group. You can also specify
1997 # subgroups. Then you have to use a "group path" similar to directory
1998 # paths, with the group and subgroup names separated by slashes
1999 # (<arg_group>General/Paper</arg_group> is the "Paper" subgroup in the
2000 # "General" group). Subgroups are not recommended as there is no GUI
2001 # supporting them. If an option is member of a composite option (See
2002 # "Composite Options" section below), the <arg_group>...</arg_group>
2003 # tags will be ignored.
2004
2005 <arg_execution>
2006 <arg_group>General</arg_group>
2007 <arg_order>100</arg_order>
2008 <arg_section>DocumentSetup</arg_section>
2009 <arg_spot>Z</arg_spot>
2010 <arg_postscript />
2011 <arg_proto>&lt;&lt;/PageSize[%s]/ImagingBBox null&gt;&gt;setpagedevice</arg_proto>
2012 </arg_execution>
2013
2014 # The constraints define what printer/driver combinations this option
2015 # applies to. The *most specific* constraint rules the day; it's
2016 # "sense" says whether or not the option is "in". The winning
2017 # constraint also provides the default value used when this option
2018 # applies to that printer and driver.
2019
2020 # Constraint elements are: driver, make, model. The driver is the
2021 # driver name, or not present to apply to any driver. The make is the
2022 # printer make, or not present to apply to any printer make. The
2023 # model is the driver model, or not present to apply to any printer.
2024 # Instead of make/model, you can also specify <printer>id</printer>.
2025
2026 # IMPORTANT: The make and model must match the one in the printer xml
2027 # definition, and everywhere else in the other options. One needs to
2028 # write a utility to change printer names sensibly.
2029
2030 # It is illegal to have a model with no make.
2031
2032 # It is illegal to have none of make/model/driver.
2033
2034 # It is illegal to have *no* constraints, or at least such options are
2035 # never used.
2036
2037 # For enum options, the defval is the id of the enum_val that is the
2038 # default. For other option types, it is the actual default value
2039 # (ie, a number, or 1 or 0 for boolean, etc).
2040
2041 <constraints>
2042 <constraint sense="true">
2043 <driver>sj48</driver>
2044 <arg_defval>ev/1</arg_defval>
2045 </constraint>
2046 <constraint sense="true">
2047 <driver>r4081</driver>
2048 <arg_defval>ev/1</arg_defval>
2049 </constraint>
2050 # A gajillion constraints deleted
2051 </constraints>
2052 <enum_vals>
2053 <enum_val id="ev/1">
2054 <ev_longname>
2055 <en>US Letter</en>
2056 </ev_longname>
2057 <!-- A multilingual <comments> block can appear here, too;
2058 it should be treated as documentation for the user. -->
2059 <ev_shortname>
2060 <en>Letter</en>
2061 <!-- Until someone tells me how to learn the user locale in
2062 backends, the shortname must be monolingual in <en>! -->
2063 </ev_shortname>
2064
2065 # If present, the driverval is what gets substituted in for the %s in
2066 # the option's prototype. This way the user-visible stuff can be
2067 # anything.
2068
2069 <ev_driverval>612 792</ev_driverval>
2070
2071 # This enum_val has no constraints. It *is* OK for enum_vals to
2072 # have no constraints; they are assumed to apply unless
2073 # constrained otherwise.
2074
2075 </enum_val>
2076 <enum_val id="ev/115">
2077 <ev_longname>
2078 <en>A3</en>
2079 </ev_longname>
2080 <!-- A multilingual <comments> block can appear here, too;
2081 it should be treated as documentation for the user. -->
2082 <ev_shortname>
2083 <en>A3</en>
2084 <!-- Until someone tells me how to learn the user locale in
2085 backends, the shortname must be monolingual in <en>! -->
2086 </ev_shortname>
2087 <ev_driverval>842 1191</ev_driverval>
2088
2089 # Here are some example constraints for an enum_val. The A3 size
2090 # paper doesn't fit on lots of printers, so there are various
2091 # constraints to make the right thing happen.
2092
2093 <constraints>
2094 <constraint sense="true">
2095 <driver>ml85p</driver>
2096 <arg_defval>na</arg_defval>
2097 </constraint>
2098 <constraint sense="true">
2099 <make>HP</make>
2100 <model>DeskJet 1000C</model>
2101 <driver>pnm2ppa</driver>
2102 <arg_defval>na</arg_defval>
2103 </constraint>
2104 <constraint sense="false">
2105 <make>HP</make>
2106 <model>DeskJet 820C</model>
2107 <driver>pnm2ppa</driver>
2108 <arg_defval>na</arg_defval>
2109 </constraint>
2110
2111 # lots more...
2112
2113 </constraints>
2114 </enum_val>
2115 </enum_vals>
2116 </option>
2117
2118 # To allow custom page sizes to be used one has add a choice with the
2119 # "<ev_shortname>" being "Custom" to the "PageSize" option (example
2120 # below). This choice will be treated as the custom page size. When
2121 # the user selects this choice, he has to provide the width and the
2122 # height of the page in addition. These values are converted into
2123 # PostScript points (1/72 inches) and inserted into placeholders in
2124 # the "<ev_driverval>" of this choice. The "<ev_driverval>" should
2125 # contain a placeholder "%0" for the page width and "%1" for the page
2126 # height. Alternatively the "<ev_driverval>" can contain two zeros
2127 # ("0") from which the first will be replaced by the page width and
2128 # the second by the page height. Then one gets Adobe-compliant entries
2129 # for the custom page size in the PPD files and one can set a custom
2130 # page size with the following commands:
2131
2132 # CUPS: lpr -P huge -o PageSize=Custom.500x750cm bigposter.ps
2133 # LPRng: lpr -P huge -Z PageSize=Custom.500x750cm bigposter.ps
2134 # GNUlpr: lpr -P huge -o PageSize=Custom.500x750cm bigposter.ps
2135 # LPD: lpr -P huge -JPageSize=Custom.500x750cm bigposter.ps
2136 # PPR (RIP): ppr -P huge -F "*PageSize Custom" --ripopts 500x750cm
2137 # bigposter.ps
2138 # PPR (Int.): ppr -P huge -F "*PageSize Custom" -i 500x750cm bigposter.ps
2139 # PDQ: pdq -P huge -oPageSize_Custom -aPageWidth=500
2140 # -aPageHeight=750 -oPageSizeUnit_cm bigposter.ps
2141 # No spooler: foomatic-rip -P huge -o PageSize=Custom.500x750cm
2142 # bigposter.ps
2143
2144 # Here is an example for a custom page size setting:
2145
2146 # <enum_val id="ev/PageSize-Custom">
2147 # <ev_longname>
2148 # <en>Custom size</en>
2149 # </ev_longname>
2150 # <!-- A multilingual <comments> block can appear here, too;
2151 # it should be treated as documentation for the user. -->
2152 # <ev_shortname>
2153 # <en>Custom</en>
2154 # <!-- Until someone tells me how to learn the user locale in
2155 # backends, the shortname must be monolingual in <en>! -->
2156 # </ev_shortname>
2157 # <ev_driverval>%0 %1</ev_driverval>
2158 # </enum_val>
2159
2160 # The entry
2161
2162 # <ev_driverval>0 0</ev_driverval>
2163
2164 # would have the same effect as the <ev_driverval> of the example.
2165
2166 # For numerical (int, float) and bool options there is no <enum_vals>
2167 # section. Instead of this section numerical options have tags to
2168 # specify minimum and maximum value:
2169
2170 # <arg_max>10.0</arg_max>
2171 # <arg_min>0.0</arg_min>
2172
2173 # For the %s in the <arg_proto> a number, either the user's choice
2174 # when he has specified this option or the default value is
2175 # inserted. Only numbers between the minimum and the maximum and in
2176 # case of int options only integer numbers are allowed.
2177
2178 # Bool options can be set or not be set. There <arg_proto> will be
2179 # inserted if they are set, nothing if they are not set. A %s in the
2180 # <arg_proto> is not allowed, there is nothing to insert for it. As
2181 # <arg_defval> in the option's constraints one can use 0 for not
2182 # setting the option by default or 1 for setting it by default.
2183
2184 # Bool options need the specification of a name for the case when they
2185 # are not set. This will be used by GUIs and in PPD files:
2186
2187 # <arg_shortname_false>
2188 # <en>CorrectBlack</en><!-- Backends only know <en> shortnames! -->
2189 # </arg_shortname_false>
2190
2191 # This name should not contain spaces, ":", or "/".
2192
2193 # See below for string, password, and composite options.
2194
2195
2196 Composite Options
2197 -----------------
2198
2199 This is an option type to make it easier for users to choose the best
2200 settings for a certain printing task, even if the driver has very many
2201 options. The idea is to have an enumerated choice option which does
2202 not directly modify something in the driver's command line but sets
2203 several of the other options.
2204
2205 One example is the "PrintoutMode" option which will be made available
2206 for all printer/driver combos which have at least one option regarding
2207 the printout quality or document type.
2208
2209 The possible choices should be the same for every printer and driver,
2210 so that users (especially newbies) can bring their printers in the
2211 right mode by choosing one easy to understand item from a menu instead
2212 of having to switch several cryptic driver options. For now the
2213 choices are the following:
2214
2215 Command line GUI Intention
2216 -----------------------------------------------------------------------
2217 Draft Draft Very fast, ink/toner-saving printout
2218 Normal Normal Quick standard quality printout
2219 High High Quality High quality for plain paper
2220 VeryHigh Very High Quality Highest quality for plain/inkjet paper
2221 Photo Photo Highest quality for photo paper
2222
2223 These choices can also have one of the following modifiers:
2224
2225 Modifier Intention
2226 -----------------------------------------------------------------------
2227 .Gray Grayscale printing on a color printer
2228 .Mono Monochrome printing (no grayscales, black or white)
2229
2230 Examples:
2231
2232 Command line GUI Comment
2233 ---------------------------------------------------------------------
2234 High.Gray High Quality Grayscale
2235 Photo Photo Color photos on color printer
2236 VeryHigh.Mono Very High Quality Monochrome Really black text in
2237 highest quality on inkjet
2238 printer, not suitable for
2239 halftone images.
2240 Normal Normal Standard color in 300/360 dpi
2241 on normal paper, grayscale
2242 on black-and-white printers
2243
2244 Not all choices/combinations of basic choices and modifiers must be
2245 present. Often modes are simply not available on certain
2246 printer/driver combos, as "Photo" on most lasers. It is highly
2247 recommended to have "Normal" available, though (and having this the
2248 default).
2249
2250 The GUI names can have additional remarks in parantheses, for example
2251 when manual intervention (other cartridge, photo paper) is needed.
2252
2253 To add such an option to the database, one only needs to add an option
2254 XML file like the one below into the db/source/opt directory of the
2255 database. The file db/source/opt/pcl3-PrintoutMode.xml could look
2256 like this:
2257
2258 --------------------------------------------------------------------------
2259 <option type="enum" id="opt/pcl3-PrintoutMode">
2260 <!-- A multilingual <comments> block can appear here, too;
2261 it should be treated as documentation for the user. -->
2262 <arg_longname>
2263 <en>Printout Mode</en>
2264 </arg_longname>
2265 <arg_shortname>
2266 <en>PrintoutMode</en><!-- backends only know <en> shortnames! -->
2267 </arg_shortname>
2268 <arg_execution>
2269 <arg_order>10</arg_order>
2270 <arg_section>AnySetup</arg_section>
2271 <arg_spot>A</arg_spot>
2272 <arg_composite />
2273 <!-- <arg_proto></arg_proto> -->
2274 </arg_execution>
2275 <constraints>
2276 <constraint sense="true">
2277 <driver>pcl3</driver>
2278 <arg_defval>ev/pcl3-PrintoutMode-Normal</arg_defval>
2279 </constraint>
2280 </constraints>
2281 <enum_vals>
2282 <enum_val id="ev/pcl3-PrintoutMode-Draft">
2283 <ev_longname>
2284 <en>Draft</en>
2285 </ev_longname>
2286 <!-- A multilingual <comments> block can appear here, too;
2287 it should be treated as documentation for the user. -->
2288 <ev_shortname>
2289 <en>Draft</en>
2290 <!-- Until someone tells me how to learn the user locale in
2291 backends, the shortname must be monolingual in <en>! -->
2292 </ev_shortname>
2293 <ev_driverval>MediaType=Plain Resolution=150 Quality=Draft IntensityRendering=Halftones Passes=1</ev_driverval>
2294 </enum_val>
2295 <enum_val id="ev/pcl3-PrintoutMode-Normal">
2296 <ev_longname>
2297 <en>Normal</en>
2298 </ev_longname>
2299 <!-- A multilingual <comments> block can appear here, too;
2300 it should be treated as documentation for the user. -->
2301 <ev_shortname>
2302 <en>Normal</en>
2303 <!-- Until someone tells me how to learn the user locale in
2304 backends, the shortname must be monolingual in <en>! -->
2305 </ev_shortname>
2306 <ev_driverval>MediaType=Plain Resolution=300 Quality=Normal IntensityRendering=Halftones Passes=1</ev_driverval>
2307 </enum_val>
2308 <enum_val id="ev/pcl3-PrintoutMode-High">
2309 <ev_longname>
2310 <en>High</en>
2311 </ev_longname>
2312 <!-- A multilingual <comments> block can appear here, too;
2313 it should be treated as documentation for the user. -->
2314 <ev_shortname>
2315 <en>High</en>
2316 <!-- Until someone tells me how to learn the user locale in
2317 backends, the shortname must be monolingual in <en>! -->
2318 </ev_shortname>
2319 <ev_driverval>MediaType=Plain Resolution=600 Quality=Presentation IntensityRendering=FloydSteinberg Passes=4</ev_driverval>
2320 </enum_val>
2321 <enum_val id="ev/pcl3-PrintoutMode-Photo">
2322 <ev_longname>
2323 <en>Photo (on photo paper)</en>
2324 </ev_longname>
2325 <!-- A multilingual <comments> block can appear here, too;
2326 it should be treated as documentation for the user. -->
2327 <ev_shortname>
2328 <en>Photo</en>
2329 <!-- Until someone tells me how to learn the user locale in
2330 backends, the shortname must be monolingual in <en>! -->
2331 </ev_shortname>
2332 <ev_driverval>MediaType=Premium Resolution=600 Quality=Presentation IntensityRendering=FloydSteinberg Passes=4</ev_driverval>
2333 </enum_val>
2334 </enum_vals>
2335 </option>
2336 --------------------------------------------------------------------------
2337
2338 The shown option is only an example, it is neither in the BZR
2339 repository nore will it work with all printers which use the "pcl3"
2340 driver. You can paste it into a file (make the <ev_driverval>s being
2341 one line, the items separated by spaces) and copy it to db/source/opt/
2342 to try it out.
2343
2344 The "<arg_composite />" tag for the execution style specifies it as a
2345 composite option. The <arg_spot> and <arg_proto> are meaningless in a
2346 composite option and the "<ev_driverval>"s contain a space-separated
2347 list of all settings of which the pre-made configuration represented
2348 by this choice consists. Every choice of the composite option must set
2349 EXACTLY THE SAME individual options. In no choice it is allowed to
2350 leave out one of them. These individual options are the member options
2351 of the composite option. Not all options of a driver/printer combo
2352 need to be member options of the composite option. It is not allowed
2353 to have one option being member of more than one composite option. The
2354 composite option must be an enumerated choice option, the member
2355 options must be enumerated choice or boolean options. Member options
2356 can even be composite options, so composite options can be nested.
2357
2358 It is enough to add a composite option as shown. The PPD generator
2359 (getppd() in lib/Foomatic/DB.pm, package "foomatic-db-engine") will
2360 take care of the rest. It will
2361
2362 - Order all member options into a group (PPD group, see "Option
2363 Grouping" below) named after the composite option.
2364
2365 - Add to every member option the choice "Controlled by '<name of
2366 the composite option>'" and make this choice the default. If this
2367 is chosen, the composite option will set the value for this
2368 member, depending on what value is chosen for the composite
2369 option. If the user chooses something else than "Controlled by
2370 '<name of the composite option>'" the member option does not obey
2371 the setting given by the composite option. So the advanced user
2372 can also set the member options individually.
2373
2374 - If necessary the <arg_order> and <arg_section> of the composite
2375 option is replaced by other values in the PPD file, so that the
2376 composite option will be stuffed into the PostScript data stream
2377 always before all its member options. Do not give "0" as the
2378 order number to any of the member options.
2379
2380 A composite option can also span only one (but not zero) member
2381 option. This is for example done with the "PrintoutMode" option of the
2382 HPIJS driver ("foomatic-db-hpijs" package). This driver has only one
2383 option for setting resolution and quality, but this option has
2384 sometimes many choices with rather cryptic names. The "PrintoutMode"
2385 maps to the most important choices with the above-mentioned names, and
2386 in addition, these names are the same as of the "PrintoutMode" options
2387 of other drivers, so the user finds the important printing modes more
2388 easily.
2389
2390 The facility of composite options can also be used for other things
2391 than for a "PrintoutMode" option, for example a finisher could be
2392 controlled by a composite option (to have the most common finishing
2393 tasks as "Bound booklet", "Stapled booklet", "Letter in envelope",
2394 ...).
2395
2396
2397 Forced Composite Options
2398 ------------------------
2399
2400 Forced composite options are very similar to composite options, but the
2401 user cannot set the individual member options, but only the composite
2402 option (the user is forced to use the composite option). This allows
2403 options acting at two or more places.
2404
2405 Example: A printer driver is a filter which converts a generic bitmap
2406 produced by Ghostscript to the printer's native format. The command
2407 line for converting PostScript to the printer's language could look like this
2408
2409 gs -q -dBATCH -dSAFER -dNOPAUSE -sDEVICE=bitcmyk -r600 -sOutputFile=-
2410 - | filter -size=<width>x<height>
2411
2412 where <width> and <height> is the page size in points (1/72
2413 inches). In addition, Ghostscript needs to know the page size. For
2414 this one usually puts the following PostScript code into the
2415 PostScript input file:
2416
2417 <</PageSize[<width> <height>]/ImagingBBox null>>setpagedevice
2418
2419 where <width> and <height> is again the page size in points. So we
2420 need two options for setting the page size, one PostScript option to
2421 set the page size for Ghostscript and one command line option to set
2422 the page size for the filter. The user would have to change both when
2423 he wants to print on another paper size, and it does not make sense to
2424 have different settings for the two. So one could make the "PageSize"
2425 option a composite option of the two, but then the GUI exposes an ugly
2426 "PageSize" group with the two individual options. To avoid this, one
2427 uses a forced composite option ("Forced" because the user is forced to
2428 use the composite option, the individual member options are not
2429 accessible).
2430
2431 Assuming that the name of the PostScript option for the page size is
2432 "GSPageSize", the name of the page size option for the filter is
2433 "filterPageSize" and both have the choices "A4", "Letter", and
2434 "Legal", the forced composite option named "PageSize" would look as
2435 follows:
2436
2437 --------------------------------------------------------------------------
2438 <option type="enum" id="opt/filter-PageSize">
2439 <!-- A multilingual <comments> block can appear here, too;
2440 it should be treated as documentation for the user. -->
2441 <arg_longname>
2442 <en>Page Size</en>
2443 </arg_longname>
2444 <arg_shortname>
2445 <en>PageSize</en><!-- backends only know <en> shortnames! -->
2446 </arg_shortname>
2447 <arg_execution>
2448 <arg_order>10</arg_order>
2449 <arg_section>AnySetup</arg_section>
2450 <arg_spot>A</arg_spot>
2451 <arg_forced_composite />
2452 </arg_execution>
2453 <constraints>
2454 <constraint sense="true">
2455 <driver>filter</driver>
2456 <arg_defval>ev/filter-PageSize-Letter</arg_defval>
2457 </constraint>
2458 </constraints>
2459 <enum_vals>
2460 <enum_val id="ev/filter-PageSize-Letter">
2461 <ev_longname>
2462 <en>Letter</en>
2463 </ev_longname>
2464 <!-- A multilingual <comments> block can appear here, too;
2465 it should be treated as documentation for the user. -->
2466 <ev_shortname>
2467 <en>Letter</en>
2468 <!-- Until someone tells me how to learn the user locale in
2469 backends, the shortname must be monolingual in <en>! -->
2470 </ev_shortname>
2471 <ev_driverval>GSPageSize=Letter filterPageSize=Letter</ev_driverval>
2472 </enum_val>
2473 <enum_val id="ev/filter-PageSize-Legal">
2474 <ev_longname>
2475 <en>Legal</en>
2476 </ev_longname>
2477 <!-- A multilingual <comments> block can appear here, too;
2478 it should be treated as documentation for the user. -->
2479 <ev_shortname>
2480 <en>Legal</en>
2481 <!-- Until someone tells me how to learn the user locale in
2482 backends, the shortname must be monolingual in <en>! -->
2483 </ev_shortname>
2484 <ev_driverval>GSPageSize=Legal filterPageSize=Legal</ev_driverval>
2485 </enum_val>
2486 <enum_val id="ev/filter-PageSize-A4">
2487 <ev_longname>
2488 <en>A4</en>
2489 </ev_longname>
2490 <!-- A multilingual <comments> block can appear here, too;
2491 it should be treated as documentation for the user. -->
2492 <ev_shortname>
2493 <en>A4</en>
2494 <!-- Until someone tells me how to learn the user locale in
2495 backends, the shortname must be monolingual in <en>! -->
2496 </ev_shortname>
2497 <ev_driverval>GSPageSize=A4 filterPageSize=A4</ev_driverval>
2498 </enum_val>
2499 </enum_vals>
2500 </option>
2501 --------------------------------------------------------------------------
2502
2503 This looks exactly like a usual composite option and works also the
2504 same way. The only difference is that instead of an "<arg_composite
2505 />" tag "<arg_forced_composite />" is used. If the PPD generator finds
2506 such an option, it hides the member options by only using
2507 "*Foomatic..." keywords to describe them, not any standard PPD
2508 keywords as "*OpenUI...", "*OrderDependency...", ... This way
2509 PPD-aware graphical frontends do not see the member options but
2510 foomatic-rip has all information from them to run the driver
2511 correctly.
2512
2513
2514 String and Password Options
2515 ---------------------------
2516
2517 These options allow the user to supply nearly arbitrary strings
2518 (within limits of length, characters and structure) to the printer
2519 driver, for example names of color calibration files, fax numbers,
2520 passwords for confidential jobs, ... Frequently needed strings can be
2521 added as enumerated choices, so a frontend can show the option as a
2522 combo-box. The enumerated choices are also used for frontends which
2523 only support options as defined by the PPD spec. So having enumerated
2524 choices is highly recommended for most of these options.
2525
2526 In the XML database string and password options look similar to
2527 enumerated choice options. The differences are the option types
2528 "string" or "password" and the additional tags to restrict the
2529 possible strings.
2530
2531 The "<arg_maxlength>" tags give a length limit, it should once not
2532 allow strings longer than around 100 characters, as otherwise
2533 foomatic-configure could generate a line longer than the allowed 255
2534 characters in the PPD file when setting the default value, and second,
2535 which is very important, it should not allow strings which are too
2536 long for the printer filter or driver so that buffer overflows cannot
2537 occur. Not using the "<arg_maxlength>" tags makes arbitrary long
2538 strings to be accepted, this is not recommended.
2539
2540 With "<arg_allowedchars>" the accepted strings can be restricted to
2541 contain only the characters given in the list. This restrictions does
2542 not only avoid that the filter chokes on a wrong option, it serves
2543 mainly for security reasons, for example to avoid a string like "|| rm
2544 -rf * ||" for a command line option. So if the option prototype does
2545 not quote the string, command delimiter characters, I/O re-directors,
2546 and shell special characters (";", "|", "&", "<", ">", "*", "?", "[",
2547 "]", "{", "}", "(", ")", "$", "\", "'", """) should not be allowed. If
2548 the string is quoted by the option prototype, the closing quote
2549 character and the backslash should not be allowed, so that one cannot
2550 escape from the quoting. The allowed characters are checked by a
2551 "/^[...]*$/" expression in the Perl scripts, so ranges with "-", a
2552 list of forbidden characters with a leading "^", or special characters
2553 as "\w", "\d", "\x07", ... are allowed. To allow a backslash, one has
2554 to escape it by using two backslashes ("\\"). To allow a "-" it must
2555 be in the end of the list to not make it defining a range and for a
2556 "^" must be placed at any other place than the beginning of the string
2557 if it should be explicitly allowed.
2558
2559 "<arg_allowedregexp>" allows also to restrict the structure of the
2560 string, as it defines an arbitrary Perl regular expression (see "man
2561 perlre") which has to be matched by the string. This serves also for
2562 having only strings which are usable by the filter and which do not
2563 destroy the command line structure. With this one can for example
2564 forbid a backslash as the last character to avoid escaping the closing
2565 quote of the option prototype. Regular expressions are applied via a
2566 '/.../' expression in the Perl scripts. To apply the pattern matching
2567 modifiers "i", "m", "s", or "x" (as "/.../i" for case-insensitive
2568 matching) begin the regular expression with "(?<modifiers>)" (as
2569 "(?i)..." for case-insensitive matching).
2570
2571 It is highly recommended to use at least one of "<arg_allowedchars>"
2572 and "<arg_allowedregexp>", as otherwise all characters are allowed in
2573 the user-supplied string and so a malicious user can execute arbitrary
2574 shell or PostScript commands. If both tags are used, both conditions
2575 have to be fulfilled.
2576
2577 Note that for the character lists and regular expressions in the XML
2578 files the following character substitutions have to be done:
2579
2580 < --> &lt;
2581 > --> &gt;
2582 " --> &quot;
2583 ' --> &apos;
2584 & --> &amp;
2585
2586 Here is an example for an option to supply the file name for an ICC
2587 profile for the "foo2zjs" driver (this option is neither in the CVS
2588 for the Foomatic database nor tested with this driver):
2589
2590 --------------------------------------------------------------------------
2591 <option type="string" id="opt/foo2zjs-ICM">
2592 <comments>
2593 <en>
2594 This option controls which .ICM file to use for color correction.
2595 ICM files are stored in the directory /usr/share/foo2zjs/icm/.
2596 </en>
2597 </comments>
2598 <arg_longname> <en>ICM Color Profile</en> </arg_longname>
2599 <arg_shortname> <en>ICM</en> </arg_shortname>
2600 <arg_execution>
2601 <arg_group>Adjustment</arg_group>
2602 <arg_order>300</arg_order>
2603 <arg_spot>A</arg_spot>
2604 <arg_required />
2605 <arg_substitution />
2606 <arg_proto>-G%s </arg_proto>
2607 </arg_execution>
2608 <arg_maxlength>127</arg_maxlength>
2609 <arg_allowedchars>A-Za-z0-9\._/-</arg_allowedchars>
2610 <arg_allowedregexp>(?&lt;!\/)$</arg_allowedregexp>
2611 <constraints>
2612 <constraint sense="true">
2613 <driver>foo2zjs</driver>
2614 <arg_defval>ev/foo2zjs-ICM-none</arg_defval>
2615 </constraint>
2616 <constraint sense="true">
2617 <make>Minolta</make>
2618 <model>magicolor 2300 DL</model>
2619 <driver>foo2zjs</driver>
2620 <arg_defval>ev/foo2zjs-ICM-DL2312</arg_defval>
2621 </constraint>
2622 <constraint sense="true">
2623 <make>Minolta</make>
2624 <model>magicolor 2200 DL</model>
2625 <driver>foo2zjs</driver>
2626 <arg_defval>ev/foo2zjs-ICM-DL2200RGB</arg_defval>
2627 </constraint>
2628 </constraints>
2629 <enum_vals>
2630 <enum_val id="ev/foo2zjs-ICM-none">
2631 <ev_longname> <en>No ICM color correction</en> </ev_longname>
2632 <ev_shortname> <en>None</en> </ev_shortname>
2633 <ev_driverval></ev_driverval>
2634 </enum_val>
2635 <enum_val id="ev/foo2zjs-ICM-DL2312">
2636 <ev_longname> <en>File DL2312.icm</en> </ev_longname>
2637 <ev_shortname> <en>DL2312</en> </ev_shortname>
2638 <ev_driverval>DL2312.icm</ev_driverval>
2639 <constraints>
2640 <constraint sense="false">
2641 <make>HP</make> <model>LaserJet 1000</model>
2642 </constraint>
2643 </constraints>
2644 </enum_val>
2645 <enum_val id="ev/foo2zjs-ICM-DL2324">
2646 <ev_longname> <en>File DL2324.icm</en> </ev_longname>
2647 <ev_shortname> <en>DL2324</en> </ev_shortname>
2648 <ev_driverval>DL2324.icm</ev_driverval>
2649 <constraints>
2650 <constraint sense="false">
2651 <make>HP</make> <model>LaserJet 1000</model>
2652 </constraint>
2653 </constraints>
2654 </enum_val>
2655
2656 ...
2657
2658 </enum_vals>
2659 </option>
2660 --------------------------------------------------------------------------
2661
2662 This option allows to choose either one of the given file names,
2663 either by using the "<ev_shortname>"s or the "<ev_driverval>"s, or one
2664 can give every arbitrary other file name with a maximum length of 127
2665 characters, only containing letters, digits, periods, underscores,
2666 dashes, and slashes, and not having a slash in the end (no
2667 directories). Note that in Perl the period must be escaped by a
2668 backslash to be taken literally, otherwise it stands for an arbitrary
2669 character. The regular expression for blocking out strings ending with
2670 a slash is "(?<!\/)$" (see "man perlre", search for "(?"). Here the
2671 slash is quoted by a backslash. In the XML file the "<" is replaced by
2672 "&lt;" so that the XML structure does not get broken. foomatic-rip
2673 translates this back before applying the regular expression.
2674
2675 To be able to offer strings as an enumerated choice which are not
2676 allowed as an option name in a PPD file, the "<ev_shortname>" may
2677 differ from the "<ev_driverval>", the string inserted at the "%s"
2678 place holder in the "<arg_proto>" is always the "<ev_driverval>",
2679 independent whether the user supplies the "<ev_driverval>" directly or
2680 the "<ev_shortname>". In this example both
2681
2682 lpr -o ICM= file.ps
2683
2684 and
2685
2686 lpr -o ICM=None file.ps
2687
2688 supply an empty string as the value of the ICM option.
2689
2690 For the default value there must be an enumerated choice, if there is
2691 none, the PPD generator will create one. So this entry is allowed
2692 (this option is only an example, it is not in the CVS of the Foomatic
2693 database):
2694
2695 --------------------------------------------------------------------------
2696 <option type="password" id="opt/Password">
2697 <!-- A multilingual <comments> block can appear here, too;
2698 it should be treated as documentation for the user. -->
2699 <arg_longname>
2700 <en>Password (for confidential jobs)</en>
2701 </arg_longname>
2702 <arg_shortname>
2703 <en>Password</en><!-- backends only know <en> shortnames! -->
2704 </arg_shortname>
2705 <arg_execution>
2706 <arg_group>General</arg_group>
2707 <arg_order>100</arg_order>
2708 <arg_spot>B</arg_spot>
2709 <arg_substitution />
2710 <arg_proto> --pass=%s</arg_proto>
2711 </arg_execution>
2712 <arg_maxlength>30</arg_maxlength>
2713 <arg_allowedchars>A-Za-z0-9\.,_\+\=\:-/</arg_allowedchars>
2714 <constraints>
2715 <constraint sense='true'>
2716 <driver>mydriver</driver>
2717 <arg_defval></arg_defval>
2718 </constraint>
2719 </constraints>
2720 </option>
2721 --------------------------------------------------------------------------
2722
2723 The default value is an empty string here. So the PPD generator will
2724 add a choice for the empty string.
2725
2726 Normally, automatically added choices get the same "<ev_shortname>" as
2727 the string itself, but if the string is not allowed as an option name
2728 in a PPD file, the "<ev_shortname>" will be modified. For an empty
2729 string (as in the example above) "None" will be used and all
2730 characters except numbers, letters, and underscores ("_") will be
2731 replaced by underscores.
2732
2733 The option types "string" and "password" are treated exactly the same
2734 way by the PPD generator and by foomatic-rip, the different names
2735 are only for frontends to know whether the input field should display
2736 the typed characters or asterisks on the screen.
2737
2738
2739 CUPS Custom Options
2740 -------------------
2741
2742 CUPS defines several extensions to the PPD specifications to support
2743 the functionality of modern printers:
2744
2745 http://www.cups.org/documentation.php/doc-1.4/spec-ppd.html
2746
2747 There are extensions for so-called "Custom Options" where instead of
2748 given enumerated choices freely choosable custom values can be
2749 supplied. As Foomatic's numerical, string, and password options can be
2750 implemented as CUPS custom options in the PPDs as well, the PPD
2751 generator does both implementations in the PPDs. There are the
2752 "*Foomatic..." keywords generated, as before, but also the CUPS PPD
2753 extension, consisting of the keywords "*Custom<option>" and
2754 "*ParamCustom<option>" keywords. This way GUIs which are aware of
2755 CUPS' custom options give full access to Foomatic's numerical, string,
2756 and password options.
2757
2758 foomatic-rip understands also PPD files now which describe custom
2759 options only by the CUPS extension and not with "*Foomatic..."
2760 keywords.
2761
2762 Allowed characters and regular expressions for string and password
2763 options cannot be described by CUPS PPD extensions. So CUPS-aware GUIs
2764 will allow input of strings which do not match these restrictions, but
2765 foomatic-rip will let the option fall back to the default value in
2766 such a case. This way the security is assured.
2767
2768
2769 Option Grouping
2770 ---------------
2771
2772 All options should be put in groups (with the tags
2773 "<arg_group>...</arg_group>" in the "<arg_execution>" section of the
2774 option XML files, see above). This way many GUIs sort the options into
2775 tabs or tree branches according to the groups. This way one gets only
2776 the most important options on the first tab and not so often needed
2777 ones on additional tabs. This also overrides the automatic option
2778 grouping of CUPS (Groups "General" and "Extra").
2779
2780 It is recommended to have the options in groups as follows (plus
2781 perhaps special groups, but not one group for every option):
2782
2783 General
2784
2785 Here go options which are most used on a job-by-job basis, as the
2786 options for paper type, size, and tray, ink type, duplex, ... and
2787 all options affecting the printout quality, as resolution,
2788 dithering, ... and especially "PrintoutMode". If a "PrintoutMode"
2789 option is present, all quality-related options covered by the
2790 "PrintoutMode" option go into the automatically created
2791 "PrintoutMode" group (see above). And this is intended, these
2792 options are now usually controlled by "PrintoutMode" and so they are
2793 not the most important options for the first tab any more.
2794
2795 Do not put color/brightness/gamma, ... options here, they go to
2796 "Adjustment".
2797
2798 Options typically to go here are:
2799
2800 o PageSize
2801 o InputSlot
2802 o MediaType
2803 o InkType
2804 o Duplex
2805 o PrintoutMode
2806 o Resolution
2807 o REt
2808 o Dither
2809 o FastRes
2810 o Economode
2811 o ...
2812
2813 All options mentioned after "PrintoutMode" will usually be used as
2814 member options for "PrintoutMode", they are only in this group when
2815 there is no "PrintoutMode" option.
2816
2817 PrintoutMode
2818
2819 This group only exists if there is a "PrintoutMode" option, because
2820 it is generated by this option. It contains the member options of
2821 "PrintoutMode". Typical candidates are
2822
2823 o Resolution
2824 o REt
2825 o Dither
2826 o FastRes
2827 o Economode
2828 o ...
2829
2830 They do not need an "<arg_group>PrintoutMode</arg_group>" line, they
2831 are put into this group automatically. You should better put an
2832 "<arg_group>General</arg_group>" line into these options, so that
2833 they go into the "General" group when there is a printer/driver
2834 combo for which no "PrintoutMode" option applies.
2835
2836 Adjustment
2837
2838 Options for correcting the appearance of colors, contrast, ..., for
2839 head alignment, ... etc. Here most numerical options will go, but
2840 also things like "Density", also if it is an enumerated choice
2841 option. Typical candidates are:
2842
2843 o Gamma
2844 o Brightness
2845 o Contrast
2846 o Density
2847 o Saturation
2848 o Cyan
2849 o Magenta
2850 o Yellow
2851 o ...
2852
2853 Finishing
2854
2855 If a printer has a stapler, folder, cutter, envelope packer, or
2856 similar devices to do additional processing on the ready printout,
2857 the options to control this stuff go into this group. Examples:
2858
2859 o Stapling
2860 o Binding
2861 o Cutting
2862 o Booklet
2863 o ...
2864
2865 Miscellaneous
2866
2867 Options which do not fit into the mentioned groups and for which it
2868 is not worth to make a special group.
2869
2870
2871 Unprintable margins
2872 -------------------
2873
2874 On most printers you cannot print arbitrarily close to the borders of
2875 the paper. You usually will have margins of certain width on which you
2876 cannot print. For filters and application programs to know about these
2877 margins PPD files have "*ImageableArea" lines which define the
2878 positions of the lower, the upper, the left, and the right borders of
2879 the area on which the printer can print. There is one line for each
2880 paper size listed in the "*PageSize" option.
2881
2882 To conveniently generate these lines one can use the following XML
2883 structure in the Foomatic database entries:
2884
2885 --------------------------------------------------------------------------
2886 <margins>
2887 <general>
2888 <!-- The margins here are valid for every paper size for -->
2889 <!-- which there is no "exception" section -->
2890 <!-- ---------- -->
2891 <!-- possible units: -->
2892 <!-- pt, in, mm, cm,
2893 <!-- dotsNNNdpi (NNN: resolution in which dots are counted) -->
2894 <!-- if "unit" not present, default unit is pt -->
2895 <!-- ---------- -->
2896 <!-- if a margin is not present, default width is used -->
2897 <!-- ---------- -->
2898 <!-- a missing "general" section assumes the default borders as the -->
2899 <!-- general borders and "pt" as the default unit for -->
2900 <!-- "exceptions". -->
2901 <!-- ---------- -->
2902 <!-- Default margin widths: 1/4 inch left/right, 1/2 inch top/bottom -->
2903 <unit>pt</unit>
2904 <top>9</top>
2905 <bottom>36</bottom>
2906 <left>18</left>
2907 <right>18</right>
2908 </general>
2909 <exception PageSize="Photo4x6TearoffTab">
2910 <!-- if one or more of "unit", "top", "bottom", "left", -->
2911 <!-- "right" is missing, the appropriate item of the "general" -->
2912 <!-- section is used -->
2913 <top>0</top>
2914 <left>0</left>
2915 <right>0</right>
2916 </exception>
2917 <exception PageSize="A4">
2918 <!-- It is also possible to give absolute values in PostScript -->
2919 <!-- coordinates where the origin is the lower left corner. To -->
2920 <!-- do so, the <absolute /> tag has to be added, otherwise -->
2921 <!-- the values are the widths of the unprintable margins -->
2922 <absolute />
2923 <left>10</left>
2924 <right>585</right>
2925 </exception>
2926 <exception PageSize="...">
2927 ...
2928 </exception>
2929 ...
2930 <margins>
2931 --------------------------------------------------------------------------
2932
2933 This structure is allowed in printer entries in the "<mechanism>"
2934 section and in driver entries in the "<execution>" section or inside a
2935 "<printer>" entry of the driver's printer list. In the "<execution>"
2936 section of a driver entry the margins are valid for all printers used
2937 with this driver, in a "<printer>" entry they apply only to the given
2938 printer/driver combo.
2939
2940 The shown example could be for the HP PhotoSmart 7150/7350, which does
2941 full-bleed only on HP's special photo paper with an 0.5 inch wide
2942 tear-off tab on the lower border (and some other paper sizes used in the
2943 photo tray). On all other paper sizes the printer leaves white borders
2944 of half an inch at the top and at the bottom and a quarter of an inch on
2945 the left and right hand side (1 inch are 72 pt). In addition, the page
2946 size "A4" allows to print up to 10 points to the left and the right borders.
2947
2948 At first we give the general borders ("<general>" section) where we
2949 choose the unit "pt" (PostScript points) for the numbers. These borders
2950 are valid for all paper sizes which are not explicitly mentioned with an
2951 "<exception ...>" section. For our printers one of the exceptions is the
2952 4x6 photo paper with the tear-off tab (including the tab the paper is
2953 4x6.5 inches large). here the printer prints up to the left, right, and
2954 top borders. Therefore we have margins of zero here. At the lower border
2955 the printer still leaves half an inch white (therefore probably HP
2956 introduced the tear-off tab), so we keep the 36 pt of the "<general>"
2957 section by not mentioning a new lower border. For A4 we redefine the
2958 left and the right border. This is also possible in absolute PostScript
2959 coordinates measured from the lower left corner, as we do here. We
2960 indicate this with the "<absolute />" tag. The left border is at 10 pt
2961 from the left, and as A4 paper is 595 pt wide, the right border is at
2962 585 points from the left.
2963
2964 One hint for the choice of the units: Float numbers as border widths are
2965 allowed, but it is recommended for having exact info to choose a unit
2966 which gives integer numbers for the widths (which is always possible
2967 with the "dotsNNNdpi" unit with NNN being the maximum resolution of the
2968 printer).
2969
2970 A "<margins>" section in a printer entry should represent the printer's
2971 hardware capabilities. Such a section in a driver entry should represent
2972 how the driver's limitations are. If there are margins defined in both
2973 the printer and the driver entry of the desired printer/driver combo,
2974 the more restrictive (wider) borders count. If there are no border
2975 definitions in both the printer and the driver entry, the borders are
2976 assumed to be of the default widths.
2977
2978
2979 Adding arbitrary extra entries to the PPD file
2980 ----------------------------------------------
2981
2982 The "<ppdentry>" tags allow to add extra lines to the PPD file. The
2983 tags can be put into the top level ("<printer>") of a printer XML entry,
2984 into the "<execution>" section of a driver XML entry, or into the
2985 "<printer>" entries of the printer list in a driver XML file. They serve
2986 mainly to put a default resolution into PPD files for drivers without
2987 "Resolution" option. Examples:
2988
2989 "hpijs" driver, default resolution for HP DeskJet 350. For this driver
2990 the default resolution depends on the printer class. Therefore the
2991 appropriate "<ppdentry>"s have to be in the printer entries of the
2992 printer list:
2993
2994 --------------------------------------------------------------------------
2995 <driver id="driver/hpijs">
2996 <name>hpijs</name>
2997 ...
2998 <printers>
2999 <printer>
3000 <id>printer/HP-DeskJet_350C</id><!-- HP DeskJet 350C -->
3001 <ppdentry>
3002 *DefaultResolution: 600dpi
3003 </ppdentry>
3004 <margins>
3005 <general>
3006 <unit>in</unit>
3007 <relative />
3008 <left>0.25</left>
3009 <right>0.25</right>
3010 <top>0.125</top>
3011 <bottom>0.67</bottom>
3012 </general>
3013 <exception PageSize="A4">
3014 <left>0.135</left>
3015 <right>0.135</right>
3016 </exception>
3017 </margins>
3018 </printer>
3019 ...
3020 </printers>
3021 </driver>
3022 --------------------------------------------------------------------------
3023
3024 "pnm2ppa" driver: This driver has no "Resolution" option, and all
3025 printers print in 600 dpi with it. So we put the "<ppdentry>" into the
3026 "<execution>" section:
3027
3028 --------------------------------------------------------------------------
3029 <driver id="driver/pnm2ppa">
3030 <name>pnm2ppa</name>
3031 <url>http://sourceforge.net/projects/pnm2ppa/</url>
3032 <execution>
3033 <filter />
3034 <prototype>gs -q -dNOPAUSE -dPARANOIDSAFER -dBATCH -r600%A%Z
3035 -sOutputFile=- - | pnm2ppa%C%B -i - -o -</prototype>
3036 <ppdentry>
3037 *DefaultResolution: 600dpi
3038 </ppdentry>
3039 </execution>
3040 ...
3041 </driver>
3042 --------------------------------------------------------------------------
3043
3044 Note that leading spaces are removed from the lines between the
3045 "<ppdentry>" tags before they get inserted into the PPD file.
3046
3047 The lines are added at the end of the PPD file header, right after the
3048 lines for the basic hardware capabilities of the printer.
3049
3050
3051 Example for a Foomatic-generated PPD file
3052 -----------------------------------------
3053
3054 Below is an example PPD file, the PPD file for the HP Color LaserJet 4550
3055 used with the "pxlcolor" driver. It was generated with the command line
3056
3057 ./foomatic-ppdfile -p HP-Color_LaserJet_4550 -d pxlcolor
3058
3059 The structure is completely Adobe-compliant and no relevant
3060 information is in comments. Besides the usual keywords which one finds
3061 in PPDs there are some special ones beginning with
3062 "*Foomatic...". These keywords are read by foomatic-rip and contain
3063 all information to build the renderer's command line. See explanations
3064 for these keywords below the example file.
3065
3066 If a printer has auto-detection information in the Foomatic database,
3067 the manufacturer and model names from there are inserted in the
3068 "*Manufacturer:" and "*Product:" fields and the IEEE-1284 ID string is
3069 put into the "*1284DeviceID:" field.
3070
3071 Independent whether there is auto-detection information, there is an
3072 additional "DRV:" field in the "*1284DeviceID:" which contains driver
3073 properties. These properties are put here, so that they appear in
3074 CUPS' PPD/driver overview listings ("lpinfo -l -m"). This way a
3075 printer setup tool can show the driver properties in a driver overview
3076 without needing to generate and read the PPD files. The following
3077 properties are available (comma-separated):
3078
3079 D: Driver name
3080 R: Driver Recommended for this printer (0, 1)?
3081 M: Driver supplied by the Manufacturer (0, 1)?
3082 O: Driver marked Obsolete in the OpenPrinting database (0, 1)?
3083 F: Driver is Free software (0, 1)?
3084 P: Driver has Patent issues (0, 1)?
3085 S: Support contacts (c: commercial, v: voluntary, u: unknown, more than
3086 one possible)
3087 T: Driver Type: G: Ghostscript built-in, C: CUPS-Raster, I: IJS,
3088 O: OpenPrinting Vector, F: Filter, U: Ghostscript Uniprint,
3089 P: PostScript
3090 X: Maximum X resolution of the driver in dpi
3091 Y: Maximum Y resolution of the driver in dpi
3092 C: Does the driver support Color printing (0, 1)?
3093 t: Rating for Text document printing with this driver (0 ... 100)
3094 l: Rating for Line art document printing with this driver (0 ... 100)
3095 g: Rating for Graphics document printing with this driver (0 ... 100)
3096 p: Rating for Photo document printing with this driver (0 ... 100)
3097 d: Rating for system loaD caused when printing with this driver (0 ... 100)
3098 s: Rating for processing Speed of this driver (0 ... 100)
3099
3100 The "DRV:" field in a device ID looks like this:
3101
3102 *1284DeviceID: "MFG:Hewlett-Packard;MDL:HP LaserJet 4050 Series;CMD:PJL,MLC,PCL,
3103 PCLXL,POSTSCRIPT;DES:Hewlett-Packard LaserJet 4050 Series;DRV:Dljet4,R0,M0,F1,Sv,TG,X600,Y600,C0,t90,l90,g60,p30,s90;"
3104
3105 If there is no device ID for a printer, the "*1284DeviceID" will
3106 contain only the "DRV:" field.
3107
3108 The PPDs contain the driver properties also in clear text, like this:
3109
3110 *driverName ljet4/ljet4 - Built-in Ghostscript driver for PCL 5e laser printers: ""
3111 *driverType G/Ghostscript built-in: ""
3112 *driverUrl: "http://www.ghostscript.com/"
3113 *driverObsolete: False
3114 *driverRecommendedReplacement: hpijs (only if driver is obsolete)
3115 *driverSupplier: "GPL Ghostscript"
3116 *driverManufacturerSupplied: False
3117 *driverLicense: "GPL"
3118 *driverFreeSoftware: True
3119 *driverSupportContactVoluntary: "http://forums.openprinting.org/ OpenPrinting forums"
3120 *driverSupportContactCommercial: "http://... ..."
3121 *driverSupportContactUnknown: "http://... ..."
3122 *driverMaxResolution: 600 600
3123 *driverColor: False
3124 *driverTextSupport: 90
3125 *driverLineartSupport: 90
3126 *driverGraphicsSupport: 60
3127 *driverPhotoSupport: 30
3128 *driverSystemmLoad: 90
3129 *driverRenderingSpeed: 90
3130
3131 ----------------------------------------------------------------------------
3132 *PPD-Adobe: "4.3"
3133 *%
3134 *% For information on using this, and to obtain the required backend
3135 *% script, consult http://www.openprinting.org/
3136 *%
3137 *% This file is published under the GNU General Public License
3138 *%
3139 *% PPD-O-MATIC (4.0.0 or newer) generated this PPD file. It is for use with
3140 *% all programs and environments which use PPD files for dealing with
3141 *% printer capability information. The printer must be configured with the
3142 *% "foomatic-rip" backend filter script of Foomatic 4.0.0 or newer. This
3143 *% file and "foomatic-rip" work together to support PPD-controlled printer
3144 *% driver option access with all supported printer drivers and printing
3145 *% spoolers.
3146 *%
3147 *% To save this file on your disk, wait until the download has completed
3148 *% (the animation of the browser logo must stop) and then use the
3149 *% "Save as..." command in the "File" menu of your browser or in the
3150 *% pop-up manu when you click on this document with the right mouse button.
3151 *% DO NOT cut and paste this file into an editor with your mouse. This can
3152 *% introduce additional line breaks which lead to unexpected results.
3153 *%
3154 *% You may save this file as 'HP-Color_LaserJet_4550-pxlcolor.ppd'
3155 *%
3156 *%
3157 *FormatVersion: "4.3"
3158 *FileVersion: "1.1"
3159 *LanguageVersion: English
3160 *LanguageEncoding: ISOLatin1
3161 *PCFileName: "PXLCOLOR.PPD"
3162 *Manufacturer: "HP"
3163 *Product: "(HP Color LaserJet 4550)"
3164 *cupsVersion: 1.0
3165 *cupsManualCopies: True
3166 *cupsModelNumber: 2
3167 *cupsFilter: "application/vnd.cups-postscript 100 foomatic-rip"
3168 *cupsFilter: "application/vnd.cups-pdf 0 foomatic-rip"
3169 *%pprRIP: foomatic-rip other
3170 *ModelName: "HP Color LaserJet 4550"
3171 *ShortNickName: "HP Color LaserJet 4550 pxlcolor"
3172 *NickName: "HP Color LaserJet 4550 Foomatic/pxlcolor"
3173 *PSVersion: "(3010.000) 550"
3174 *PSVersion: "(3010.000) 651"
3175 *PSVersion: "(3010.000) 652"
3176 *PSVersion: "(3010.000) 653"
3177 *PSVersion: "(3010.000) 704"
3178 *PSVersion: "(3010.000) 705"
3179 *PSVersion: "(3010.000) 800"
3180 *PSVersion: "(3010.000) 815"
3181 *PSVersion: "(3010.000) 850"
3182 *PSVersion: "(3010.000) 860"
3183 *PSVersion: "(3010.000) 861"
3184 *PSVersion: "(3010.000) 862"
3185 *PSVersion: "(3010.000) 863"
3186 *LanguageLevel: "3"
3187 *ColorDevice: True
3188 *DefaultColorSpace: RGB
3189 *FileSystem: False
3190 *Throughput: "1"
3191 *LandscapeOrientation: Plus90
3192 *TTRasterizer: Type42
3193 *1284DeviceID: "MFG:Hewlett-Packard;MDL:HP Color LaserJet 4550;CMD:PJL,MLC,PCL,POSTSCRIPT,PCLXL,PJL;DES:Hewlett-Packard Color LaserJet 4550;DRV:Dpxlcolor,R0,M0,TG;"
3194
3195 *driverName pxlcolor/pxlcolor: ""
3196 *driverType G/Ghostscript built-in: ""
3197 *driverUrl: "http://www.ghostscript.com/"
3198 *driverObsolete: False
3199
3200 *DefaultResolution: 1200dpi
3201
3202
3203
3204 *VariablePaperSize: False
3205
3206 *FoomaticIDs: HP-Color_LaserJet_4550 pxlcolor
3207 *FoomaticRIPCommandLine: "gs -q -dBATCH -dPARANOIDSAFER -dNOPAUSE%B%A%&&
3208 Z -sOutputFile=- - | perl -p -e &apos;if (! $did) { s/\xc0.\xf8\x26/\x&&
3209 c0%E\xf8\x26/ &amp;&amp; $did++; }&apos;"
3210 *End
3211
3212 *OpenGroup: General/General
3213
3214 *OpenUI *PrintoutMode/Printout Mode: PickOne
3215 *FoomaticRIPOption PrintoutMode: enum Composite A
3216 *OrderDependency: 10 AnySetup *PrintoutMode
3217 *DefaultPrintoutMode: Normal
3218 *PrintoutMode Draft/Draft: "%% FoomaticRIPOptionSetting: PrintoutMode=Draft"
3219 *FoomaticRIPOptionSetting PrintoutMode=Draft: "PrinterResolution=300x3&&
3220 00dpi ColorModel=Color Economode=On FastRes=Off"
3221 *End
3222 *PrintoutMode Draft.Gray/Draft Grayscale: "%% FoomaticRIPOptionSetting: PrintoutMode=Draft.Gray"
3223 *FoomaticRIPOptionSetting PrintoutMode=Draft.Gray: "PrinterResolution=&&
3224 300x300dpi ColorModel=Grayscale Economode=On FastRes=Off"
3225 *End
3226 *PrintoutMode Normal/Normal: "%% FoomaticRIPOptionSetting: PrintoutMode=Normal"
3227 *FoomaticRIPOptionSetting PrintoutMode=Normal: "PrinterResolution=600x&&
3228 600dpi ColorModel=Color Economode=Off FastRes=On"
3229 *End
3230 *PrintoutMode Normal.Gray/Normal Grayscale: "%% FoomaticRIPOptionSetting: PrintoutMode=Normal.Gray"
3231 *FoomaticRIPOptionSetting PrintoutMode=Normal.Gray: "PrinterResolution&&
3232 =600x600dpi ColorModel=Grayscale Economode=Off FastRes=On"
3233 *End
3234 *PrintoutMode High/High Quality: "%% FoomaticRIPOptionSetting: PrintoutMode=High"
3235 *FoomaticRIPOptionSetting PrintoutMode=High: "PrinterResolution=1200x1&&
3236 200dpi ColorModel=Color Economode=Off FastRes=Off"
3237 *End
3238 *PrintoutMode High.Gray/High Quality Grayscale: "%% FoomaticRIPOptionSetting: PrintoutMode=High.Gray"
3239 *FoomaticRIPOptionSetting PrintoutMode=High.Gray: "PrinterResolution=1&&
3240 200x1200dpi ColorModel=Grayscale Economode=Off FastRes=Off"
3241 *End
3242 *CloseUI: *PrintoutMode
3243
3244 *OpenUI *PageSize/Page Size: PickOne
3245 *FoomaticRIPOption PageSize: enum CmdLine A
3246 *OrderDependency: 100 AnySetup *PageSize
3247 *DefaultPageSize: Letter
3248 *PageSize Letter/US Letter: "%% FoomaticRIPOptionSetting: PageSize=Letter"
3249 *FoomaticRIPOptionSetting PageSize=Letter: " -dDEVICEWIDTHPOINTS=612 -&&
3250 dDEVICEHEIGHTPOINTS=792"
3251 *End
3252 *PageSize A4/A4: "%% FoomaticRIPOptionSetting: PageSize=A4"
3253 *FoomaticRIPOptionSetting PageSize=A4: " -dDEVICEWIDTHPOINTS=595 -dDEV&&
3254 ICEHEIGHTPOINTS=842"
3255 *End
3256 *PageSize 11x17/11x17: "%% FoomaticRIPOptionSetting: PageSize=11x17"
3257 *FoomaticRIPOptionSetting PageSize=11x17: " -dDEVICEWIDTHPOINTS=792 -d&&
3258 DEVICEHEIGHTPOINTS=1224"
3259 *End
3260 *PageSize A3/A3: "%% FoomaticRIPOptionSetting: PageSize=A3"
3261 *FoomaticRIPOptionSetting PageSize=A3: " -dDEVICEWIDTHPOINTS=842 -dDEV&&
3262 ICEHEIGHTPOINTS=1191"
3263 *End
3264 *PageSize A5/A5: "%% FoomaticRIPOptionSetting: PageSize=A5"
3265 *FoomaticRIPOptionSetting PageSize=A5: " -dDEVICEWIDTHPOINTS=421 -dDEV&&
3266 ICEHEIGHTPOINTS=595"
3267 *End
3268 *PageSize B5/B5 (JIS): "%% FoomaticRIPOptionSetting: PageSize=B5"
3269 *FoomaticRIPOptionSetting PageSize=B5: " -dDEVICEWIDTHPOINTS=516 -dDEV&&
3270 ICEHEIGHTPOINTS=729"
3271 *End
3272 *PageSize Env10/Envelope #10: "%% FoomaticRIPOptionSetting: PageSize=Env10"
3273 *FoomaticRIPOptionSetting PageSize=Env10: " -dDEVICEWIDTHPOINTS=297 -d&&
3274 DEVICEHEIGHTPOINTS=684"
3275 *End
3276 *PageSize EnvC5/Envelope C5: "%% FoomaticRIPOptionSetting: PageSize=EnvC5"
3277 *FoomaticRIPOptionSetting PageSize=EnvC5: " -dDEVICEWIDTHPOINTS=459 -d&&
3278 DEVICEHEIGHTPOINTS=649"
3279 *End
3280 *PageSize EnvDL/Envelope DL: "%% FoomaticRIPOptionSetting: PageSize=EnvDL"
3281 *FoomaticRIPOptionSetting PageSize=EnvDL: " -dDEVICEWIDTHPOINTS=312 -d&&
3282 DEVICEHEIGHTPOINTS=624"
3283 *End
3284 *PageSize EnvISOB5/Envelope B5: "%% FoomaticRIPOptionSetting: PageSize=EnvISOB5"
3285 *FoomaticRIPOptionSetting PageSize=EnvISOB5: " -dDEVICEWIDTHPOINTS=499&&
3286 -dDEVICEHEIGHTPOINTS=709"
3287 *End
3288 *PageSize EnvMonarch/Envelope Monarch: "%% FoomaticRIPOptionSetting: PageSize=EnvMonarch"
3289 *FoomaticRIPOptionSetting PageSize=EnvMonarch: " -dDEVICEWIDTHPOINTS=2&&
3290 79 -dDEVICEHEIGHTPOINTS=540"
3291 *End
3292 *PageSize Executive/Executive: "%% FoomaticRIPOptionSetting: PageSize=Executive"
3293 *FoomaticRIPOptionSetting PageSize=Executive: " -dDEVICEWIDTHPOINTS=52&&
3294 2 -dDEVICEHEIGHTPOINTS=756"
3295 *End
3296 *PageSize Legal/US Legal: "%% FoomaticRIPOptionSetting: PageSize=Legal"
3297 *FoomaticRIPOptionSetting PageSize=Legal: " -dDEVICEWIDTHPOINTS=612 -d&&
3298 DEVICEHEIGHTPOINTS=1008"
3299 *End
3300 *CloseUI: *PageSize
3301
3302 *OpenUI *PageRegion: PickOne
3303 *OrderDependency: 100 AnySetup *PageRegion
3304 *DefaultPageRegion: Letter
3305 *PageRegion Letter/US Letter: "%% FoomaticRIPOptionSetting: PageSize=Letter"
3306 *PageRegion A4/A4: "%% FoomaticRIPOptionSetting: PageSize=A4"
3307 *PageRegion 11x17/11x17: "%% FoomaticRIPOptionSetting: PageSize=11x17"
3308 *PageRegion A3/A3: "%% FoomaticRIPOptionSetting: PageSize=A3"
3309 *PageRegion A5/A5: "%% FoomaticRIPOptionSetting: PageSize=A5"
3310 *PageRegion B5/B5 (JIS): "%% FoomaticRIPOptionSetting: PageSize=B5"
3311 *PageRegion Env10/Envelope #10: "%% FoomaticRIPOptionSetting: PageSize=Env10"
3312 *PageRegion EnvC5/Envelope C5: "%% FoomaticRIPOptionSetting: PageSize=EnvC5"
3313 *PageRegion EnvDL/Envelope DL: "%% FoomaticRIPOptionSetting: PageSize=EnvDL"
3314 *PageRegion EnvISOB5/Envelope B5: "%% FoomaticRIPOptionSetting: PageSize=EnvISOB5"
3315 *PageRegion EnvMonarch/Envelope Monarch: "%% FoomaticRIPOptionSetting: PageSize=EnvMonarch"
3316 *PageRegion Executive/Executive: "%% FoomaticRIPOptionSetting: PageSize=Executive"
3317 *PageRegion Legal/US Legal: "%% FoomaticRIPOptionSetting: PageSize=Legal"
3318 *CloseUI: *PageRegion
3319
3320 *DefaultImageableArea: Letter
3321 *ImageableArea Letter/US Letter: "18 36 594 756"
3322 *ImageableArea A4/A4: "18 36 577 806"
3323 *ImageableArea 11x17/11x17: "18 36 774 1188"
3324 *ImageableArea A3/A3: "18 36 824 1155"
3325 *ImageableArea A5/A5: "18 36 403 559"
3326 *ImageableArea B5/B5 (JIS): "18 36 498 693"
3327 *ImageableArea Env10/Envelope #10: "18 36 279 648"
3328 *ImageableArea EnvC5/Envelope C5: "18 36 441 613"
3329 *ImageableArea EnvDL/Envelope DL: "18 36 294 588"
3330 *ImageableArea EnvISOB5/Envelope B5: "18 36 481 673"
3331 *ImageableArea EnvMonarch/Envelope Monarch: "18 36 261 504"
3332 *ImageableArea Executive/Executive: "18 36 504 720"
3333 *ImageableArea Legal/US Legal: "18 36 594 972"
3334
3335 *DefaultPaperDimension: Letter
3336 *PaperDimension Letter/US Letter: "612 792"
3337 *PaperDimension A4/A4: "595 842"
3338 *PaperDimension 11x17/11x17: "792 1224"
3339 *PaperDimension A3/A3: "842 1191"
3340 *PaperDimension A5/A5: "421 595"
3341 *PaperDimension B5/B5 (JIS): "516 729"
3342 *PaperDimension Env10/Envelope #10: "297 684"
3343 *PaperDimension EnvC5/Envelope C5: "459 649"
3344 *PaperDimension EnvDL/Envelope DL: "312 624"
3345 *PaperDimension EnvISOB5/Envelope B5: "499 709"
3346 *PaperDimension EnvMonarch/Envelope Monarch: "279 540"
3347 *PaperDimension Executive/Executive: "522 756"
3348 *PaperDimension Legal/US Legal: "612 1008"
3349
3350 *OpenUI *InputSlot/Media Source: PickOne
3351 *FoomaticRIPOption InputSlot: enum CmdLine E
3352 *OrderDependency: 100 AnySetup *InputSlot
3353 *DefaultInputSlot: Default
3354 *InputSlot Default/Printer default: "%% FoomaticRIPOptionSetting: InputSlot=Default"
3355 *FoomaticRIPOptionSetting InputSlot=Default: "\x01"
3356 *InputSlot Tray1/Tray 1: "%% FoomaticRIPOptionSetting: InputSlot=Tray1"
3357 *FoomaticRIPOptionSetting InputSlot=Tray1: "\x03"
3358 *InputSlot Tray2/Tray 2: "%% FoomaticRIPOptionSetting: InputSlot=Tray2"
3359 *FoomaticRIPOptionSetting InputSlot=Tray2: "\x04"
3360 *InputSlot Tray3/Tray 3: "%% FoomaticRIPOptionSetting: InputSlot=Tray3"
3361 *FoomaticRIPOptionSetting InputSlot=Tray3: "\x05"
3362 *InputSlot Tray4/Tray 4: "%% FoomaticRIPOptionSetting: InputSlot=Tray4"
3363 *FoomaticRIPOptionSetting InputSlot=Tray4: "\x06"
3364 *InputSlot Tray5/Tray 5: "%% FoomaticRIPOptionSetting: InputSlot=Tray5"
3365 *FoomaticRIPOptionSetting InputSlot=Tray5: "\x07"
3366 *InputSlot Tray6/Tray 6: "%% FoomaticRIPOptionSetting: InputSlot=Tray6"
3367 *FoomaticRIPOptionSetting InputSlot=Tray6: "\x08"
3368 *InputSlot Tray7/Tray 7: "%% FoomaticRIPOptionSetting: InputSlot=Tray7"
3369 *FoomaticRIPOptionSetting InputSlot=Tray7: "\x09"
3370 *InputSlot Manual/Manual Feeder: "%% FoomaticRIPOptionSetting: InputSlot=Manual"
3371 *FoomaticRIPOptionSetting InputSlot=Manual: "\x02"
3372 *CloseUI: *InputSlot
3373
3374 *JCLOpenUI *Manualfeed/Manual Feed of Paper: PickOne
3375 *OrderDependency: 100 JCLSetup *Manualfeed
3376 *DefaultManualfeed: Off
3377 *Manualfeed Off/Off: "@PJL SET MANUALFEED=OFF<0A>"
3378 *Manualfeed On/On: "@PJL SET MANUALFEED=ON<0A>"
3379 *JCLCloseUI: *Manualfeed
3380
3381 *OpenUI *Duplex/Double-Sided printing: PickOne
3382 *FoomaticRIPOption Duplex: enum CmdLine A
3383 *OrderDependency: 100 AnySetup *Duplex
3384 *DefaultDuplex: None
3385 *Duplex DuplexNoTumble/On (Flip on Long Edge): "%% FoomaticRIPOptionSetting: Duplex=DuplexNoTumble"
3386 *FoomaticRIPOptionSetting Duplex=DuplexNoTumble: " -dDuplex"
3387 *Duplex DuplexTumble/On (Flip on Short Edge): "%% FoomaticRIPOptionSetting: Duplex=DuplexTumble"
3388 *FoomaticRIPOptionSetting Duplex=DuplexTumble: " -dDuplex -dTumble"
3389 *Duplex None/Off: "%% FoomaticRIPOptionSetting: Duplex=None"
3390 *FoomaticRIPOptionSetting Duplex=None: ""
3391 *CloseUI: *Duplex
3392
3393 *JCLOpenUI *Copies/Number of Copies: PickOne
3394 *FoomaticRIPOption Copies: int JCL A
3395 *FoomaticRIPOptionPrototype Copies: "SET COPIES=%s"
3396 *FoomaticRIPOptionRange Copies: 1 100
3397 *OrderDependency: 100 JCLSetup *Copies
3398 *DefaultCopies: 1
3399 *FoomaticRIPDefaultCopies: 1
3400 *Copies 1/1: "@PJL SET COPIES=1<0A>"
3401 *Copies 2/2: "@PJL SET COPIES=2<0A>"
3402 *Copies 3/3: "@PJL SET COPIES=3<0A>"
3403 *Copies 4/4: "@PJL SET COPIES=4<0A>"
3404 *Copies 5/5: "@PJL SET COPIES=5<0A>"
3405 *Copies 6/6: "@PJL SET COPIES=6<0A>"
3406 *Copies 7/7: "@PJL SET COPIES=7<0A>"
3407 *Copies 8/8: "@PJL SET COPIES=8<0A>"
3408 *Copies 9/9: "@PJL SET COPIES=9<0A>"
3409 *Copies 10/10: "@PJL SET COPIES=10<0A>"
3410 *Copies 11/11: "@PJL SET COPIES=11<0A>"
3411 *Copies 12/12: "@PJL SET COPIES=12<0A>"
3412 *Copies 13/13: "@PJL SET COPIES=13<0A>"
3413 *Copies 14/14: "@PJL SET COPIES=14<0A>"
3414 *Copies 15/15: "@PJL SET COPIES=15<0A>"
3415 *Copies 16/16: "@PJL SET COPIES=16<0A>"
3416 *Copies 17/17: "@PJL SET COPIES=17<0A>"
3417 *Copies 18/18: "@PJL SET COPIES=18<0A>"
3418 *Copies 19/19: "@PJL SET COPIES=19<0A>"
3419 *Copies 20/20: "@PJL SET COPIES=20<0A>"
3420 *Copies 21/21: "@PJL SET COPIES=21<0A>"
3421 *Copies 22/22: "@PJL SET COPIES=22<0A>"
3422 *Copies 23/23: "@PJL SET COPIES=23<0A>"
3423 *Copies 24/24: "@PJL SET COPIES=24<0A>"
3424 *Copies 25/25: "@PJL SET COPIES=25<0A>"
3425 *Copies 26/26: "@PJL SET COPIES=26<0A>"
3426 *Copies 27/27: "@PJL SET COPIES=27<0A>"
3427 *Copies 28/28: "@PJL SET COPIES=28<0A>"
3428 *Copies 29/29: "@PJL SET COPIES=29<0A>"
3429 *Copies 30/30: "@PJL SET COPIES=30<0A>"
3430 *Copies 31/31: "@PJL SET COPIES=31<0A>"
3431 *Copies 32/32: "@PJL SET COPIES=32<0A>"
3432 *Copies 33/33: "@PJL SET COPIES=33<0A>"
3433 *Copies 34/34: "@PJL SET COPIES=34<0A>"
3434 *Copies 35/35: "@PJL SET COPIES=35<0A>"
3435 *Copies 36/36: "@PJL SET COPIES=36<0A>"
3436 *Copies 37/37: "@PJL SET COPIES=37<0A>"
3437 *Copies 38/38: "@PJL SET COPIES=38<0A>"
3438 *Copies 39/39: "@PJL SET COPIES=39<0A>"
3439 *Copies 40/40: "@PJL SET COPIES=40<0A>"
3440 *Copies 41/41: "@PJL SET COPIES=41<0A>"
3441 *Copies 42/42: "@PJL SET COPIES=42<0A>"
3442 *Copies 43/43: "@PJL SET COPIES=43<0A>"
3443 *Copies 44/44: "@PJL SET COPIES=44<0A>"
3444 *Copies 45/45: "@PJL SET COPIES=45<0A>"
3445 *Copies 46/46: "@PJL SET COPIES=46<0A>"
3446 *Copies 47/47: "@PJL SET COPIES=47<0A>"
3447 *Copies 48/48: "@PJL SET COPIES=48<0A>"
3448 *Copies 49/49: "@PJL SET COPIES=49<0A>"
3449 *Copies 50/50: "@PJL SET COPIES=50<0A>"
3450 *Copies 51/51: "@PJL SET COPIES=51<0A>"
3451 *Copies 52/52: "@PJL SET COPIES=52<0A>"
3452 *Copies 53/53: "@PJL SET COPIES=53<0A>"
3453 *Copies 54/54: "@PJL SET COPIES=54<0A>"
3454 *Copies 55/55: "@PJL SET COPIES=55<0A>"
3455 *Copies 56/56: "@PJL SET COPIES=56<0A>"
3456 *Copies 57/57: "@PJL SET COPIES=57<0A>"
3457 *Copies 58/58: "@PJL SET COPIES=58<0A>"
3458 *Copies 59/59: "@PJL SET COPIES=59<0A>"
3459 *Copies 60/60: "@PJL SET COPIES=60<0A>"
3460 *Copies 61/61: "@PJL SET COPIES=61<0A>"
3461 *Copies 62/62: "@PJL SET COPIES=62<0A>"
3462 *Copies 63/63: "@PJL SET COPIES=63<0A>"
3463 *Copies 64/64: "@PJL SET COPIES=64<0A>"
3464 *Copies 65/65: "@PJL SET COPIES=65<0A>"
3465 *Copies 66/66: "@PJL SET COPIES=66<0A>"
3466 *Copies 67/67: "@PJL SET COPIES=67<0A>"
3467 *Copies 68/68: "@PJL SET COPIES=68<0A>"
3468 *Copies 69/69: "@PJL SET COPIES=69<0A>"
3469 *Copies 70/70: "@PJL SET COPIES=70<0A>"
3470 *Copies 71/71: "@PJL SET COPIES=71<0A>"
3471 *Copies 72/72: "@PJL SET COPIES=72<0A>"
3472 *Copies 73/73: "@PJL SET COPIES=73<0A>"
3473 *Copies 74/74: "@PJL SET COPIES=74<0A>"
3474 *Copies 75/75: "@PJL SET COPIES=75<0A>"
3475 *Copies 76/76: "@PJL SET COPIES=76<0A>"
3476 *Copies 77/77: "@PJL SET COPIES=77<0A>"
3477 *Copies 78/78: "@PJL SET COPIES=78<0A>"
3478 *Copies 79/79: "@PJL SET COPIES=79<0A>"
3479 *Copies 80/80: "@PJL SET COPIES=80<0A>"
3480 *Copies 81/81: "@PJL SET COPIES=81<0A>"
3481 *Copies 82/82: "@PJL SET COPIES=82<0A>"
3482 *Copies 83/83: "@PJL SET COPIES=83<0A>"
3483 *Copies 84/84: "@PJL SET COPIES=84<0A>"
3484 *Copies 85/85: "@PJL SET COPIES=85<0A>"
3485 *Copies 86/86: "@PJL SET COPIES=86<0A>"
3486 *Copies 87/87: "@PJL SET COPIES=87<0A>"
3487 *Copies 88/88: "@PJL SET COPIES=88<0A>"
3488 *Copies 89/89: "@PJL SET COPIES=89<0A>"
3489 *Copies 90/90: "@PJL SET COPIES=90<0A>"
3490 *Copies 91/91: "@PJL SET COPIES=91<0A>"
3491 *Copies 92/92: "@PJL SET COPIES=92<0A>"
3492 *Copies 93/93: "@PJL SET COPIES=93<0A>"
3493 *Copies 94/94: "@PJL SET COPIES=94<0A>"
3494 *Copies 95/95: "@PJL SET COPIES=95<0A>"
3495 *Copies 96/96: "@PJL SET COPIES=96<0A>"
3496 *Copies 97/97: "@PJL SET COPIES=97<0A>"
3497 *Copies 98/98: "@PJL SET COPIES=98<0A>"
3498 *Copies 99/99: "@PJL SET COPIES=99<0A>"
3499 *Copies 100/100: "@PJL SET COPIES=100<0A>"
3500 *JCLCloseUI: *Copies
3501
3502 *CustomJCLCopies True: "@PJL SET COPIES=\1<0A>"
3503 *ParamCustomJCLCopies Copies/Number of Copies: 1 int 1 100
3504
3505
3506 *CloseGroup: General
3507
3508 *OpenGroup: Adjustment/Adjustment
3509
3510 *JCLOpenUI *REt/REt Setting: PickOne
3511 *OrderDependency: 100 JCLSetup *REt
3512 *DefaultREt: Medium
3513 *REt Dark/Dark: "@PJL SET RET=DARK<0A>"
3514 *REt Light/Light: "@PJL SET RET=LIGHT<0A>"
3515 *REt Medium/Medium: "@PJL SET RET=MEDIUM<0A>"
3516 *REt Off/Off: "@PJL SET RET=OFF<0A>"
3517 *JCLCloseUI: *REt
3518
3519 *JCLOpenUI *TonerDensity/Toner Density: PickOne
3520 *OrderDependency: 100 JCLSetup *TonerDensity
3521 *DefaultTonerDensity: 3
3522 *TonerDensity 1/1: "@PJL SET DENSITY=1<0A>"
3523 *TonerDensity 2/2: "@PJL SET DENSITY=2<0A>"
3524 *TonerDensity 3/3: "@PJL SET DENSITY=3<0A>"
3525 *TonerDensity 4/4: "@PJL SET DENSITY=4<0A>"
3526 *TonerDensity 5/5: "@PJL SET DENSITY=5<0A>"
3527 *JCLCloseUI: *TonerDensity
3528
3529 *FoomaticRIPOption GSResolution: enum CmdLine A 100
3530 *FoomaticRIPOptionSetting GSResolution=FromPrinterResolution: ""
3531 *FoomaticRIPOptionSetting GSResolution=300x300dpi: " -r300x300"
3532 *FoomaticRIPOptionSetting GSResolution=600x600dpi: " -r600x600"
3533 *FoomaticRIPOptionSetting GSResolution=1200x600dpi: " -r1200x600"
3534 *FoomaticRIPOptionSetting GSResolution=1200x1200dpi: " -r1200x1200"
3535
3536 *FoomaticRIPOption JCLResolution: enum JCL A 100
3537 *FoomaticRIPOptionSetting JCLResolution=FromPrinterResolution: ""
3538 *FoomaticRIPOptionSetting JCLResolution=300x300dpi: "SET RESOLUTION=30&&
3539 0"
3540 *End
3541 *FoomaticRIPOptionSetting JCLResolution=600x600dpi: "SET RESOLUTION=60&&
3542 0"
3543 *End
3544 *FoomaticRIPOptionSetting JCLResolution=1200x600dpi: "SET RESOLUTION=1&&
3545 200x600"
3546 *End
3547 *FoomaticRIPOptionSetting JCLResolution=1200x1200dpi: "SET RESOLUTION=&&
3548 1200"
3549 *End
3550
3551 *CloseGroup: Adjustment
3552
3553 *OpenGroup: PrintoutMode/Printout Mode
3554
3555 *OpenUI *FastRes/Fast Res.: PickOne
3556 *OrderDependency: 100 AnySetup *FastRes
3557 *DefaultFastRes: FromPrintoutMode
3558 *FastRes FromPrintoutMode/Controlled by 'Printout Mode': "%% FoomaticRIPOptionSetting: FastRes=@PrintoutMode"
3559 *FastRes Off/Off: "@PJL SET BITSPERPIXEL=1<0A>"
3560 *FastRes On/On: "@PJL SET BITSPERPIXEL=2<0A>"
3561 *CloseUI: *FastRes
3562
3563 *OpenUI *Economode/Toner Saving: PickOne
3564 *OrderDependency: 100 AnySetup *Economode
3565 *DefaultEconomode: FromPrintoutMode
3566 *Economode FromPrintoutMode/Controlled by 'Printout Mode': "%% FoomaticRIPOptionSetting: Economode=@PrintoutMode"
3567 *Economode Off/Off: "@PJL SET ECONOMODE=OFF<0A>"
3568 *Economode On/On: "@PJL SET ECONOMODE=ON<0A>"
3569 *CloseUI: *Economode
3570
3571 *OpenUI *ColorModel/Color Mode: PickOne
3572 *FoomaticRIPOption ColorModel: enum CmdLine B
3573 *OrderDependency: 100 AnySetup *ColorModel
3574 *DefaultColorModel: FromPrintoutMode
3575 *ColorModel FromPrintoutMode/Controlled by 'Printout Mode': "%% FoomaticRIPOptionSetting: ColorModel=@PrintoutMode"
3576 *ColorModel Color/Color: "%% FoomaticRIPOptionSetting: ColorModel=Color"
3577 *FoomaticRIPOptionSetting ColorModel=Color: " -sDEVICE=pxlcolor"
3578 *ColorModel Grayscale/Grayscale: "%% FoomaticRIPOptionSetting: ColorModel=Grayscale"
3579 *FoomaticRIPOptionSetting ColorModel=Grayscale: " -sDEVICE=pxlmono"
3580 *CloseUI: *ColorModel
3581
3582 *OpenUI *PrinterResolution/Resolution: PickOne
3583 *FoomaticRIPOption PrinterResolution: enum Composite A
3584 *OrderDependency: 99 AnySetup *PrinterResolution
3585 *DefaultPrinterResolution: FromPrintoutMode
3586 *PrinterResolution FromPrintoutMode/Controlled by 'Printout Mode': "%% FoomaticRIPOptionSetting: PrinterResolution=FromPrintoutMode"
3587 *FoomaticRIPOptionSetting PrinterResolution=FromPrintoutMode: ""
3588 *PrinterResolution 300x300dpi/300 DPI: "%% FoomaticRIPOptionSetting: PrinterResolution=300x300dpi"
3589 *FoomaticRIPOptionSetting PrinterResolution=300x300dpi: "JCLResolution&&
3590 =300x300dpi GSResolution=300x300dpi"
3591 *End
3592 *PrinterResolution 600x600dpi/600 DPI: "%% FoomaticRIPOptionSetting: PrinterResolution=600x600dpi"
3593 *FoomaticRIPOptionSetting PrinterResolution=600x600dpi: "JCLResolution&&
3594 =600x600dpi GSResolution=600x600dpi"
3595 *End
3596 *CloseUI: *PrinterResolution
3597
3598 *CloseGroup: PrintoutMode
3599
3600
3601 *% Generic boilerplate PPD stuff as standard PostScript fonts and so on
3602
3603 *DefaultFont: Courier
3604 *Font AvantGarde-Book: Standard "(001.006S)" Standard ROM
3605 *Font AvantGarde-BookOblique: Standard "(001.006S)" Standard ROM
3606 *Font AvantGarde-Demi: Standard "(001.007S)" Standard ROM
3607 *Font AvantGarde-DemiOblique: Standard "(001.007S)" Standard ROM
3608 *Font Bookman-Demi: Standard "(001.004S)" Standard ROM
3609 *Font Bookman-DemiItalic: Standard "(001.004S)" Standard ROM
3610 *Font Bookman-Light: Standard "(001.004S)" Standard ROM
3611 *Font Bookman-LightItalic: Standard "(001.004S)" Standard ROM
3612 *Font Courier: Standard "(002.004S)" Standard ROM
3613 *Font Courier-Bold: Standard "(002.004S)" Standard ROM
3614 *Font Courier-BoldOblique: Standard "(002.004S)" Standard ROM
3615 *Font Courier-Oblique: Standard "(002.004S)" Standard ROM
3616 *Font Helvetica: Standard "(001.006S)" Standard ROM
3617 *Font Helvetica-Bold: Standard "(001.007S)" Standard ROM
3618 *Font Helvetica-BoldOblique: Standard "(001.007S)" Standard ROM
3619 *Font Helvetica-Narrow: Standard "(001.006S)" Standard ROM
3620 *Font Helvetica-Narrow-Bold: Standard "(001.007S)" Standard ROM
3621 *Font Helvetica-Narrow-BoldOblique: Standard "(001.007S)" Standard ROM
3622 *Font Helvetica-Narrow-Oblique: Standard "(001.006S)" Standard ROM
3623 *Font Helvetica-Oblique: Standard "(001.006S)" Standard ROM
3624 *Font NewCenturySchlbk-Bold: Standard "(001.009S)" Standard ROM
3625 *Font NewCenturySchlbk-BoldItalic: Standard "(001.007S)" Standard ROM
3626 *Font NewCenturySchlbk-Italic: Standard "(001.006S)" Standard ROM
3627 *Font NewCenturySchlbk-Roman: Standard "(001.007S)" Standard ROM
3628 *Font Palatino-Bold: Standard "(001.005S)" Standard ROM
3629 *Font Palatino-BoldItalic: Standard "(001.005S)" Standard ROM
3630 *Font Palatino-Italic: Standard "(001.005S)" Standard ROM
3631 *Font Palatino-Roman: Standard "(001.005S)" Standard ROM
3632 *Font Symbol: Special "(001.007S)" Special ROM
3633 *Font Times-Bold: Standard "(001.007S)" Standard ROM
3634 *Font Times-BoldItalic: Standard "(001.009S)" Standard ROM
3635 *Font Times-Italic: Standard "(001.007S)" Standard ROM
3636 *Font Times-Roman: Standard "(001.007S)" Standard ROM
3637 *Font ZapfChancery-MediumItalic: Standard "(001.007S)" Standard ROM
3638 *Font ZapfDingbats: Special "(001.004S)" Standard ROM
3639 ----------------------------------------------------------------------------
3640
3641 Foomatic keywords
3642 -----------------
3643
3644 *FoomaticIDs: <printer> <driver>
3645 <printer>: The printer ID in the Foomatic database
3646 <driver>: The driver name/ID in the Foomatic database
3647
3648 *FoomaticRIPPostPipe: "<code>"
3649 <code>: A shell command line into which the output of foomatic-rip
3650 is piped. Only used with LPRng, LPD, GNUlpr, spooler-less
3651
3652 *FoomaticRIPCammandLine: "<code>"
3653 <code>: The general command line prototype, with spots to insert option
3654 settings ("%A", "%B", ...).
3655
3656 *FoomaticRIPCammandLinePDF: "<code>"
3657 <code>: The command line prototype for PDF input if it is different to
3658 the one for PostScript input, with spots to insert option
3659 settings ("%A", "%B", ...).
3660
3661 *FoomaticRIPNoPageAccounting: <boolean value>
3662 <value>: If True, no accounting code will be inserted into the
3663 PostScript data stream.
3664
3665 *FoomaticRIPOption <name>: <type> <style> <spot> [<order>]
3666 <name>: Option name; <type>: enum, bool, int, float;
3667 <style>: CmdLine, JCL, PS, Composite;
3668 <spot>: Insert this at "%<spot>" in the "*FoomaticRIPCammandLine";
3669 <order>: order number (1-choice options only)
3670
3671 *FoomaticRIPOptionSetting <name>=<choice>: "<code>"
3672 <name>: Option name; <choice>: choice name;
3673 <code>: Code to insert for Cmdline and JCL options,
3674 Settings of member options for Composite
3675 options (see below)
3676
3677 *FoomaticRIPOptionPrototype <name>: "<code>"
3678 (keyword only for numerical and string/password options)
3679 <name>: Option name;
3680 <code>: Code to insert for Cmdline, JCL, and
3681 PS options. With "%s" for the number/string
3682 set by the user.
3683
3684 *FoomaticRIPOptionRange <name>: <min> <max>
3685 (keyword only for numerical options)
3686 <name>: Option name;
3687 <min>, <max>: allowed range for the number.
3688
3689 *FoomaticRIPOptionMaxLength <name>: <length>
3690 (keyword only for string/password options)
3691 <name>: Option name;
3692 <length>: maximum allowed length for the string.
3693
3694 *FoomaticRIPOptionAllowedChars <name>: "<code>"
3695 (keyword only for string options)
3696 <name>: Option name;
3697 <code>: List of allowed characters in the string
3698 (checked by a '/^[...]*$/', see above).
3699
3700 *FoomaticRIPOptionAllowedRegExp <name>: "<code>"
3701 (keyword only for string options)
3702 <name>: Option name;
3703 <code>: Perl regular expression which the string must fulfill
3704 (checked by a '/.../', see above).
3705
3706 *FoomaticRIPDefault<name>: <value>
3707 (keyword only for numerical options)
3708 <name>: Option name;
3709 <value>: default value, only needs to be in
3710 the allowed range, does not need to be
3711 one of the enumerated choices.
3712
3713 *FoomaticRIPJobEntityMaxLength: <integer value>
3714 *FoomaticRIPUserEntityMaxLength: <integer value>
3715 *FoomaticRIPHostEntityMaxLength: <integer value>
3716 *FoomaticRIPTitleEntityMaxLength: <integer value>
3717 *FoomaticRIPOptionsEntityMaxLength: <integer value>
3718 <integer value>: Maximum length for the substitution strings for
3719 the special entities "&job;", "&user;", "&host;", "&title;", and
3720 "&options;" which can be used in the quoted strings of all "*Foomatic..."
3721 keywords (foomatic-filters 4.0.6 or newer needed).
3722
3723 All strings in quotes (Foomatic command line, snippets to insert in
3724 command line, "<code>" in the keyword descriptions above) are encoded
3725 with the "htmlify()" function of DB.pm, so they contain no forbidden
3726 characters ("<", ">", "\"") any more. In addition they are broken up
3727 into short lines. The filter (foomatic-rip) will put them together
3728 at first and then replace the HTML/XML entities by the original
3729 characters. If a string is split up, an "*End" line follows, as
3730 required by the Adobe specification. In the quoted strings also the
3731 following special entities can be used to insert job parameters:
3732
3733 Entity Gets replaced by
3734 ---------------------------------------------------------
3735 &job; Job ID
3736 &user; User name (who sent the job)
3737 &host; Job host name
3738 &title; Job title
3739 &options; Job options
3740 &copies; Number of copies
3741 &rbinumcopies; "%RBINumCopies:" of PostScript input
3742 &year; Job rendering date: 4-digit year
3743 &month; Job rendering date: 2-digit month
3744 &date; Job rendering date: 2-digit day of month
3745 &hour; Job rendering date: 2-digit hours (24 hours)
3746 &min; Job rendering date: 2-digit minutes
3747 &sec; Job rendering date: 2-digit seconds
3748
3749 foomatic-rip substitutes these entities by the appropriate parameters
3750 before starting the rendering process. This way job parameters can be
3751 sent to the printer. From foomatic-filters 4.0.6 on the length of the
3752 inserted strings can be limited, either by the above-mentioned
3753 "*FoomaticRIP...EntityMaxLength:" keywords in the PPD or by adding the
3754 length to the entities (ex: "&user8;", "&title16;", ...). If the
3755 string to insert for the entity is longer than the limit, it gets cut
3756 off to the limit. Note that adding numbers to the entities makes the
3757 PPD incompatible with older versions of foomatic-rip. PPDs with the
3758 above-mentioned new keywords work with older versions of foomatic-rip,
3759 but limits do not get applied. Therefore I generally recommend using
3760 the PPD keywords for PPDs to make them publically available.
3761
3762 All Foomatic-relevant info is stored with keywords beginning with
3763 "*Foomatic...", not in comment lines. So if some program strips the
3764 comments off the PPD file, the file still works. The data is stored
3765 in a way compliant to the Adobe specification.
3766
3767 The "*Foomatic..." lines are located in the option entries, so that all
3768 info which is related is located close to each other. This makes the
3769 file more easily readable. The lines also contain only the information
3770 which is not provided by the standard PPD lines. So redundancy is low
3771 and the PPD can more easily be edited and customized.
3772
3773 "*Foomatic..." lines are given to all non-PostScript options and to
3774 numerical or string/password PostScript options. Usual "Boolean" and
3775 "PickOne" PostScript options do not need them. Numerical and
3776 string/password options are "PickOne" for most frontends, but with the
3777 "*Foomatic..." lines the server (the foomatic-rip filter script)
3778 identifies them as numerical or string/password options (and so
3779 accepts values which are not listed) and, second, frontends could also
3780 read the "*Foomatic..." lines and so show the options as numerical or
3781 string (with input field, slider, combo box) or even as password
3782 (input field which shows asterisks instead of the actually typed
3783 characters), as KDE Print and XPP now do by reading the Perl
3784 structure.
3785
3786 Non-PostScript options with only one choice consist only of
3787 "*Foomatic..." lines. So the one choice is stored in the PPD file but
3788 frontends will not show a widget for these options.
3789
3790 Also composite options can be described more easily:
3791
3792 ----------------------------------------------------------------------------
3793
3794 *OpenUI *PrintoutMode/Printout Mode: PickOne
3795 *FoomaticRIPOption PrintoutMode: enum Composite C
3796 *OrderDependency: 20 AnySetup *PrintoutMode
3797 *DefaultPrintoutMode: Normal
3798 *PrintoutMode Draft/Draft (Economy): "%% FoomaticRIPOptionSetting:
3799 PrintoutMode=Draft"
3800 *FoomaticRIPOptionSetting PrintoutMode=Draft: "Resolution=300 &&
3801 MediaType=Normal Dither=VeryFast"
3802 *End
3803 *PrintoutMode Normal/Normal: "%% FoomaticRIPOptionSetting:
3804 PrintoutMode=Normal"
3805 *FoomaticRIPOptionSetting PrintoutMode=Normal: "Resolution=600 &&
3806 MediaType=Normal Dither=AdaptiveHybrid"
3807 *End
3808 *PrintoutMode High/High Quality: "%%
3809 FoomaticRIPOptionSetting: PrintoutMode=High"
3810 *FoomaticRIPOptionSetting PrintoutMode=High: "Resolution=1200 &&
3811 MediaType=Inkjet Dither=AdaptiveHybrid"
3812 *End
3813 *PrintoutMode Photo/Photo: "%% FoomaticRIPOptionSetting: PrintoutMode=Photo"
3814 *FoomaticRIPOptionSetting PrintoutMode=Photo: "Resolution=1200 &&
3815 MediaType=GlossyPhoto Dither=EvenTone"
3816 *End
3817 *CloseUI: *PrintoutMode
3818
3819 ----------------------------------------------------------------------------
3820
3821 Remark to the "*FoomaticRIPDefault<name>: <value>" entries for
3822 numerical options:
3823
3824 Adobe's PPD specs do not support numerical options. Therefore the
3825 numerical options are mapped to enumerated options in the PPD file and
3826 their characteristics as a numerical option are stored in
3827 "*Foomatic..." keywords. Especially a value between the enumerated
3828 fixed values can be used as the default value. Then this value must be
3829 given by a "*FoomaticRIPDefault<option>: <value>" line in the PPD
3830 file. But this value is only valid, if the "official" default given by
3831 a "*Default<option>: <value>" line (it must be one of the enumerated
3832 values) points to the enumerated value which is closest to this
3833 value. This way a user can select a default value with a tool only
3834 supporting PPD files but not Foomatic extensions. This tool only
3835 modifies the "*Default<option>: <value>" line and if the
3836 "*FoomaticRIPDefault<option>: <value>" had always priority, the user's
3837 change in "*Default<option>: <value>" had no effect.
3838
3839 For numerical, string, and password options there are also the CUPS
3840 PPD extensions for custom options used. This allows GUIs which use
3841 CUPS' PPD extensions give full access to these options to the
3842 user. See above.