, and many other simple tags (, , , # ...). Note that to distinguish what is XML and what is the embedded # HTML, the following replacements have to be made: # # < --> < # > --> > # " --> " # ' --> ' # & --> & # I don't believe this:<p> <i>1200x1200 dpi only possible with Windows drivers, 600x600 can be reached w/o particular software. The difference is visible, but only slightly, so the Functionality got "Mostly"<p></i><p> Do the following:<p> Set the resolution on the front panel to "Prores 1200", not to "Fastres 1200". When you use CUPS with HPs PPD file, turn off "Fastres 1200" in the printer configuration options.<p> Try the generic PostScript PPD file which comes with KUPS 1.0 or newer. driver/md2k.xml =============== The driver files contain information about drivers. There are a few things, but the two biggies are the prototype and the printers list md2k # According to the Adobe specifications for PPD files every PPD file # must contain a unique DOS-compatible file name (the "*PCFileName"), # a file name with an up to 8 characters log base name and an up to 3 # characters long extension, and upper and lower case letters being # considered as equal. As every PPD file is for a printer/driver combo, # we let the last 2 characters being provided by the driver entry: M2 # The drivers listed by the OpenPrinting database are usually not # developed by OpenPrinting. Most free software printer drivers come # from independent projects, initiated by peopke who want to get their # printers to work under Linux, some other drivers come from the # printer manufacturers. So even if OpenPrinting hosts a downloadable # package of the driver the development of the driver is not part of # OpenPrinting. Therefore every driver entry has to contain a # reference to the developers of the driver, where the driver can be # actually downloaded. The appropriate link goes into the tag: http://plaza26.mbn.or.jp/~higamasa/gdevmd2k/ # The driver XML files can contain the following tags to describe the # driver's properties, so that a user can easily find the driver which # is most suitable for him. The properties are shown in the gray # driver info boxes on the OpenPrinting web site and they are also # supposed to be shown by printer setup tools when they offer to # download a driver from OpenPrinting. It is especially important to # supply them if a downloadable driver package or PPD files are # supplied. # Supplier's name, internationalization (with .........) # optional # SpliX project # Does the driver come from the printer's manufacturer or from a third # party. The third form tells also the manufacturer names of the # printers which are from the manufacturer which developed the # driver. If there are also printers from other manufacturers # supported (like for the PCL driver HPIJS) then the OpenPrinting web # site does not show this driver as manufacturer-supplied on the pages # of the printers of other manufacturers. # OR OR # HP|Apollo # License name. Here should be put the common short name or # abbreviation if the license is one of the common free software # licenses. Otherwise it should contain something short and # descriptive, for non-free drivers simply "Commercial". The license # name can be internationalized with language tags # (.........). # GPL # The license text does not need to be supplied for common free # software licenses. It should be supplied if: # # - The license is not free ( tag set) # - The driver has patent issues ( tag set, describe the # patent issues here in that case) # - The license of the driver is free but none of the common licenses # ( tag not set) # # # ... # # # License texts can also be linked from external sites: # # # # ... # # License texts have to be given always as plain text, UTF-8-encoded. # Mark with this tag whether the driver is non-free software # # All driver entries without this tag are considered to be free # software. # This tag tells whether there are any patent issues with the driver # # The absence of the tag tells that the driver is free of patent # issues. # If a driver entry provides a and is or with printer setup tools which download this # driver are supposed to present the license text and ask the user # whether he agrees with it. # Printer manufacturers could want to package their drivers for # different market regions (Europe, Asia/Pacific, Americas, ...) as # the markets demand different capabilities of printer drivers and # different user-settable options (CJK-language-related stufff for # example). So there could even be two different driver flavors for # the same printer but adapted to different regions. To express these # driver properties there are special tags. # For each flavor of the driver a separate driver entry (driver XML # file) has to be supplied. There is no requirement of certain # properties of the driver flavors to be equal or not. Especially the # printer lists can contain printers which are not in all flavors, for # example if printers are only sold in certain regions. To mark which # entries are belonging together one adds a group tag to each XML # file, with the same group name, but the name must be different to # the names of all already existing groups. A locales tag contains all # language/country codes for which the driver flavor is intended: # epson-inkjet # de en_UK en_IE fr_FR es_ES # The codes in the locales taghs should be different for the group # members, to allow to automatically select the most suitable flavor # if the detected printer is supported by more than one flavor. # For downloadable drivers support contacts should be given, so that # users get informed before they do the download and do not complain # at their OS distribution vendor if the driver downloaded from # OpenPrinting does not work. The human-readable string for the # support contact can be internationalized with language tags # (.........). # # SpliX forum at SourceForge # LaserStar Support # # This is an internationalized short description of the driver, # typically one line, to be used in the gray driver info boxes, in the # driver overview list, and also by printer setup tools. If a driver # entry is for a development version of a driver, tell it here, as the # long description is not shown everywhere. # # # Driver for Samsung SPL2 (ML-1710, ...) and SPLc (CLP-500, ...) laser # printers # # # If there are downloadable packages for this driver entry on the # OpenPrinting web site, usually packages whose name are the driver's # name (in all lowercase, "_" replaced by "-", optionally preceeded by # "openprinting-" or "openprinting-ppds-") are considered to belong to # this entry. If the package names are different, or if it depends on # the version number whether a package belongs to this entry, a # section has to be supplied. It is also required if the # driver package is split up into several components, to assign scopes # to them. Scopes can be: "general", "gui", "printer", "scanner", # "fax", ... Uses the "general" scope if packages are not split. Wild # cards are the same as used for file masks in the shell (NOT regular # expressions). They must match both Debian and RPM package file # names. Note that between file name and version number is a "-" for # RPMs and a "_" for Debian packages. # # *splix*1.[0-9].[0-9]* # # It is possible to give absolute paths which can point to external # sites, as for example the site of a printer manufacturer, so that # the package can be hosted there but auto-downloaded via # OpenPrinting. Important is that these packages are auto-downloadable # LSB packages and that a non-interactive download is provided (should # also work with utilities like "wget"). Licenses which the users have # to agree on have to get supplied in the driver XML file. Printer # setup tools are supposed to ask the user for agreeing if the driver # is marked as non-free or with patent issues. # Example for packages provided by an external site: # # http://download.example.com/printerdrivers/*canon-inkjet* # # The section should make it easier for a user to # compare different drivers by giving some technical properties and # ratings (0...100) for common document types, system load, and # execution speed. The higher the number, the better the driver # performs here. It is not required to supply all items. Items can be # left out or can stay empty. sections of the same # format can also be used in the entries in the # list, to describe exceptions for particular printers. If an item is # left out or empty there, the appropriate item in the general # section is used, so only the items which are # different for the given printer need to be listed. # # 1200 # 1200 # OR # 100 # 100 # 100 # 80 # 50 # 90 # # Not all tags are required here, if the valur for a tag is not known, # the tag has to be left out. Do not put empty tags (like # "" or "" here. # The section describes everything needed to execute the # driver. # Sometimes it is possible that a driver depends on another driver, # for example a manufacturer publishes a core driver which is # completely free software and supports most of their printer. In # addition, he publishes closed-source plugins for the core driver to # support additional printers where they cannot open the driver code # for IP reasons. He wants to link in all his driver packages for # automatic download with the tags. To make everything work # correctly he creates one driver entry for the core driver and one # for each plugin. The printers which do not need the plugin get # listed as supported by the core driver, the printers needing a # plugin are listed as supported by the plugin. To avoid that then # only a plugin gets automatically downloaded one adds a # tag to each entry of a plugin, to the beginning of the # section: # gutenprint # hpijs # The version attribute is optional, without, every version is # accepted. Optional relationships (>=, <=, =, <, >) allow to not only # accept the given version. The '>´ and '<' have to be replaced by the # appropriate XML entities, as described earlier here for other text # in the XML files. More than one tag is allowed. # Driver types are # # : The driver code is compiled into Ghostscript # # : IJS plug-in. These are raster drivers which connect # to the IJS interface of the renderer, usually of # Ghostscript but also of pdftoijs or others. The # interface is based on pipes and is bi-directional. # It makes the driver independent of the renderer. # # : CUPS Raster driver. The raster driver standard # introduced by CUPS. The renderer generates the CUPS # Raster format, a bitmap format optimized for printing, # and it gets piped into the driver. # # : OpenPrinting Vector driver. DLL and IPC interface for # plugging printer drivers into the renderer. This is # the only solution of mudular printer drivers for high- # level graphics (vector) PDLs. # # : A uniprint driver, consisting of one or more .upp # files for Ghostscript. # # : The driver code is a separate executable and the # driver does not fit into the groups listed above, # usually either a filter which converts generic # bitmap output of Ghostscript to the printer's # language, or a wrapper around Ghostscript. # # : A driver which has PostScript as output (for # PostScript printers). It usually does not call # Ghostscript but only applies the user's option # settings to the data stream. But Ghostscript can # be called here, too, as for downgrading to a lower # PostScript level or for handling PDF input. # # The driver type only provides information for the web pages (or # driver auto-download facilities of printer setup tools), it is not # used when generating PPD files. # The driver's section can also contain a # # # # which suppresses the usage of PJL options (options which send PJL # commands to the printer). This is done with drivers where the driver # itself already produces a PJL header and where the PJL options # defined for the supported printers would badly interfere. In most # cases this is not needed, as foomatic-rip merges the PJL headers of # the driver and of the PJL options. # And the driver's section can also contain a # # # # This suppresses the inserting of page accounting code (for CUPS) # into the PostScript data stream. Some drivers lead to unexpected # behavior with that. Especially for the generic PostScript drivers # (which do not use Ghostscript in most cases) the accounting code # should not be inserted. # The prototype defines what command the backends run to drive this # printer. It must take at least PostScript, preferably both PDF and # PostScript on stdin and generate the printer's native language on # stdout. Various %A, %B, etc substitution "spots" are specified; this # is where substition options will be placed. gs -q -dBATCH -dSAFER -dQUIET -dNOPAUSE -sDEVICE=md2k%A%Z -sOutputFile=- - Part of the gdevmd2k-0.2a package by Shinya Umino. The web page and documentation are in Japanese. <a href="/clippings/MD5000-translation.txt">Here</a> is an English translation of the driver's web page, and <a href="/clippings/alpsmd.txt">here</a> is the README from the driver package. # if there is only a and not a entry, # foomatic-rip will feed both PostScript and PDF into the command line # defined with , otherwise for PostScript input the # command line is used and for PDF input the # command line. Both are defined the same way and the # same command line snippets are inserted from the option settings. # If there is only a defined, PDF will only be fed in if # the command line begins with "gs " (this means Ghostscript is called # and Ghostscript understands both PostScript and PDF) and there are # no options based on inserting active PostScript code into the input # data stream. Otherwise foomatic-rip converts PDF input to PostScript # at first and feeds the PostScript through the command line. # The printer list is a simple list of printers that this driver works # with. Alternatively, one can tell that a given printer works with a # given driver also by a list in the printer's XML file (see # above). printer/Alps-MD-1000 printer/Alps-MD-1300 printer/Alps-MD-2000 printer/Alps-MD-4000 # In the printer list it is also possible to place comments or # exceptions in the driver's functionality (see above) specific to a # certain printer/driver pair: # # printer/HP-LaserJet_4050 # # to 1200dpi # # # # # # Note that printer/driver relationships can also be expressed by # adding the driver to the lists of the appropriate printer # XML files. source/opt/2.xml ================ # Every option exists independently from printers or drivers, because # they might apply to arbitrary combinations of printers and/or # drivers. In practice, some drivers have wholly unique options # (gutenprint for example), while others (lots of generic basic # Ghostscript drivers, for example) share some options. # Options are of a type "enum", "bool", "int", "float", "string", or # "password", options have an ID. The id is also the filename. # The shortname is a spaceless short name for the thing. It must not # contain / or : (otherwise it will not be handled correctly in PPD # files). It should be one of the standard Adobe PPD option names if # apropriate # Various things here, and all , are internationalized. # They take the usual posix locale codes in the form xx[_YY], where xx # is a two-letter iso language code, and YY is two-letter country code # to distinguish differing national dialects. # # Generally the national dialects won't be very common or necessary # here. The backends currently require that content be provided. PageSize # The longname is a short phrase describing the thing in more detail # GUI tools usually show longnames Page Size # The are used to form documentation. In theory these can # become man pages or the like. Example: # # # This option allows the user to get a lighter or darker printout, but # keeping totally black areas black and not making white areas gray. # # # The execution section describe how the backend should execute this # option. The order and spot apply to the *driver*'s prototype for # (once called commandline) style options, or # just the order applies for and # options. The order and the go into the "*OrderDependency" # line of the appropriate option entry in the PPD file, for this example # one would get # *OrderDependency: 100 DocumentSetup *PageSize # When no is given, "AnySetup" is used as a default. # For options the is inserted into # the driver's command line, at the spot (e. g. "%A") whose letter is # given between the ... tags, the of # an option is a snippet of PostScript code which # is inserted into the PostScript data stream of the job, for # DSC-conforming PostScript into the section specified with # , otherwise in the beginning. The lines of # options are PJL commands which are sent to the printer # before the output of the driver's command line is sent. Because this # only works reliably when the driver output does not have its own PJL # command header, these options are ignored when the driver's XML file # is marked with a tag in its section. Drivers # which produce their own PJL and therefore are marked with # are for example "hpijs" and "hl1250". There is also the # execution style for composite options, see the # "Composite Options" section below. The user's value gets put into # the 's %s location. # The ... tags put the option into the PPD # option group named here. In many PPD-based GUIs ("kprinter", "xpp", # OpenOffice.org, ...) every group is shown as a tab or a tree branch # containing the member options of this group. You can also specify # subgroups. Then you have to use a "group path" similar to directory # paths, with the group and subgroup names separated by slashes # (General/Paper is the "Paper" subgroup in the # "General" group). Subgroups are not recommended as there is no GUI # supporting them. If an option is member of a composite option (See # "Composite Options" section below), the ... # tags will be ignored. General 100 DocumentSetup Z <</PageSize[%s]/ImagingBBox null>>setpagedevice # The constraints define what printer/driver combinations this option # applies to. The *most specific* constraint rules the day; it's # "sense" says whether or not the option is "in". The winning # constraint also provides the default value used when this option # applies to that printer and driver. # Constraint elements are: driver, make, model. The driver is the # driver name, or not present to apply to any driver. The make is the # printer make, or not present to apply to any printer make. The # model is the driver model, or not present to apply to any printer. # Instead of make/model, you can also specify id. # IMPORTANT: The make and model must match the one in the printer xml # definition, and everywhere else in the other options. One needs to # write a utility to change printer names sensibly. # It is illegal to have a model with no make. # It is illegal to have none of make/model/driver. # It is illegal to have *no* constraints, or at least such options are # never used. # For enum options, the defval is the id of the enum_val that is the # default. For other option types, it is the actual default value # (ie, a number, or 1 or 0 for boolean, etc). sj48 ev/1 r4081 ev/1 # A gajillion constraints deleted US Letter Letter # If present, the driverval is what gets substituted in for the %s in # the option's prototype. This way the user-visible stuff can be # anything. 612 792 # This enum_val has no constraints. It *is* OK for enum_vals to # have no constraints; they are assumed to apply unless # constrained otherwise. A3 A3 842 1191 # Here are some example constraints for an enum_val. The A3 size # paper doesn't fit on lots of printers, so there are various # constraints to make the right thing happen. ml85p na HP DeskJet 1000C pnm2ppa na HP DeskJet 820C pnm2ppa na # lots more... # To allow custom page sizes to be used one has add a choice with the # "" being "Custom" to the "PageSize" option (example # below). This choice will be treated as the custom page size. When # the user selects this choice, he has to provide the width and the # height of the page in addition. These values are converted into # PostScript points (1/72 inches) and inserted into placeholders in # the "" of this choice. The "" should # contain a placeholder "%0" for the page width and "%1" for the page # height. Alternatively the "" can contain two zeros # ("0") from which the first will be replaced by the page width and # the second by the page height. Then one gets Adobe-compliant entries # for the custom page size in the PPD files and one can set a custom # page size with the following commands: # CUPS: lpr -P huge -o PageSize=Custom.500x750cm bigposter.ps # LPRng: lpr -P huge -Z PageSize=Custom.500x750cm bigposter.ps # GNUlpr: lpr -P huge -o PageSize=Custom.500x750cm bigposter.ps # LPD: lpr -P huge -JPageSize=Custom.500x750cm bigposter.ps # PPR (RIP): ppr -P huge -F "*PageSize Custom" --ripopts 500x750cm # bigposter.ps # PPR (Int.): ppr -P huge -F "*PageSize Custom" -i 500x750cm bigposter.ps # PDQ: pdq -P huge -oPageSize_Custom -aPageWidth=500 # -aPageHeight=750 -oPageSizeUnit_cm bigposter.ps # No spooler: foomatic-rip -P huge -o PageSize=Custom.500x750cm # bigposter.ps # Here is an example for a custom page size setting: # # # Custom size # # # # Custom # # # %0 %1 # # The entry # 0 0 # would have the same effect as the of the example. # For numerical (int, float) and bool options there is no # section. Instead of this section numerical options have tags to # specify minimum and maximum value: # 10.0 # 0.0 # For the %s in the a number, either the user's choice # when he has specified this option or the default value is # inserted. Only numbers between the minimum and the maximum and in # case of int options only integer numbers are allowed. # Bool options can be set or not be set. There will be # inserted if they are set, nothing if they are not set. A %s in the # is not allowed, there is nothing to insert for it. As # in the option's constraints one can use 0 for not # setting the option by default or 1 for setting it by default. # Bool options need the specification of a name for the case when they # are not set. This will be used by GUIs and in PPD files: # # CorrectBlack # # This name should not contain spaces, ":", or "/". # See below for string, password, and composite options. Composite Options ----------------- This is an option type to make it easier for users to choose the best settings for a certain printing task, even if the driver has very many options. The idea is to have an enumerated choice option which does not directly modify something in the driver's command line but sets several of the other options. One example is the "PrintoutMode" option which will be made available for all printer/driver combos which have at least one option regarding the printout quality or document type. The possible choices should be the same for every printer and driver, so that users (especially newbies) can bring their printers in the right mode by choosing one easy to understand item from a menu instead of having to switch several cryptic driver options. For now the choices are the following: Command line GUI Intention ----------------------------------------------------------------------- Draft Draft Very fast, ink/toner-saving printout Normal Normal Quick standard quality printout High High Quality High quality for plain paper VeryHigh Very High Quality Highest quality for plain/inkjet paper Photo Photo Highest quality for photo paper These choices can also have one of the following modifiers: Modifier Intention ----------------------------------------------------------------------- .Gray Grayscale printing on a color printer .Mono Monochrome printing (no grayscales, black or white) Examples: Command line GUI Comment --------------------------------------------------------------------- High.Gray High Quality Grayscale Photo Photo Color photos on color printer VeryHigh.Mono Very High Quality Monochrome Really black text in highest quality on inkjet printer, not suitable for halftone images. Normal Normal Standard color in 300/360 dpi on normal paper, grayscale on black-and-white printers Not all choices/combinations of basic choices and modifiers must be present. Often modes are simply not available on certain printer/driver combos, as "Photo" on most lasers. It is highly recommended to have "Normal" available, though (and having this the default). The GUI names can have additional remarks in parantheses, for example when manual intervention (other cartridge, photo paper) is needed. To add such an option to the database, one only needs to add an option XML file like the one below into the db/source/opt directory of the database. The file db/source/opt/pcl3-PrintoutMode.xml could look like this: -------------------------------------------------------------------------- Printout Mode PrintoutMode 10 AnySetup A pcl3 ev/pcl3-PrintoutMode-Normal Draft Draft MediaType=Plain Resolution=150 Quality=Draft IntensityRendering=Halftones Passes=1 Normal Normal MediaType=Plain Resolution=300 Quality=Normal IntensityRendering=Halftones Passes=1 High High MediaType=Plain Resolution=600 Quality=Presentation IntensityRendering=FloydSteinberg Passes=4 Photo (on photo paper) Photo MediaType=Premium Resolution=600 Quality=Presentation IntensityRendering=FloydSteinberg Passes=4 -------------------------------------------------------------------------- The shown option is only an example, it is neither in the BZR repository nore will it work with all printers which use the "pcl3" driver. You can paste it into a file (make the s being one line, the items separated by spaces) and copy it to db/source/opt/ to try it out. The "" tag for the execution style specifies it as a composite option. The and are meaningless in a composite option and the ""s contain a space-separated list of all settings of which the pre-made configuration represented by this choice consists. Every choice of the composite option must set EXACTLY THE SAME individual options. In no choice it is allowed to leave out one of them. These individual options are the member options of the composite option. Not all options of a driver/printer combo need to be member options of the composite option. It is not allowed to have one option being member of more than one composite option. The composite option must be an enumerated choice option, the member options must be enumerated choice or boolean options. Member options can even be composite options, so composite options can be nested. It is enough to add a composite option as shown. The PPD generator (getppd() in lib/Foomatic/DB.pm, package "foomatic-db-engine") will take care of the rest. It will - Order all member options into a group (PPD group, see "Option Grouping" below) named after the composite option. - Add to every member option the choice "Controlled by ''" and make this choice the default. If this is chosen, the composite option will set the value for this member, depending on what value is chosen for the composite option. If the user chooses something else than "Controlled by ''" the member option does not obey the setting given by the composite option. So the advanced user can also set the member options individually. - If necessary the and of the composite option is replaced by other values in the PPD file, so that the composite option will be stuffed into the PostScript data stream always before all its member options. Do not give "0" as the order number to any of the member options. A composite option can also span only one (but not zero) member option. This is for example done with the "PrintoutMode" option of the HPIJS driver ("foomatic-db-hpijs" package). This driver has only one option for setting resolution and quality, but this options has sometimes many choices with rather cryptic names. The "PrintoutMode" maps to the most important choices with the above-mentioned names, and in addition, these names are the same as of the "PrintoutMode" options of other drivers, so the user finds the important printing modes more easily. The facility of composite options can also be used for other things than for a "PrintoutMode" option, for example a finisher could be controlled by a composite option (to have the most common finishing tasks as "Bound booklet", "Stapled booklet", "Letter in envelope", ...). Forced Composite Options ------------------------ Forced composite options are very similar to composite options, but the user cannot set the individual member options, but only the composite option (the user is forced to use the composite option). This allows options acting at two or more places. Example: A printer driver is a filter which converts a generic bitmap produced by Ghostscript to the printer's native format. The command line for converting PostScript to the printer's language could look like this gs -q -dBATCH -dSAFER -dNOPAUSE -sDEVICE=bitcmyk -r600 -sOutputFile=- - | filter -size=x where and is the page size in points (1/72 inches). In addition, Ghostscript needs to know the page size. For this one usually puts the following PostScript code into the PostScript input file: < ]/ImagingBBox null>>setpagedevice where and is again the page size in points. So we need two options for setting the page size, one PostScript option to set the page size for Ghostscript and one command line option to set the page size for the filter. The user would have to change both when he wants to print on another paper size, and it does not make sense to have different settings for the two. So one could make the "PageSize" option a composite option of the two, but then the GUI exposes an ugly "PageSize" group with the two individual options. To avoid this, one uses a forced composite option ("Forced" because the user is forced to use the composite option, the individual member options are not accessible). Assuming that the name of the PostScript option for the page size is "GSPageSize", the name of the page size option for the filter is "filterPageSize" and both have the choices "A4", "Letter", and "Legal", the forced composite option named "PageSize" would look as follows: -------------------------------------------------------------------------- Page Size PageSize 10 AnySetup A filter ev/filter-PageSize-Letter Letter Letter GSPageSize=Letter filterPageSize=Letter Legal Legal GSPageSize=Legal filterPageSize=Legal A4 A4 GSPageSize=A4 filterPageSize=A4 -------------------------------------------------------------------------- This looks exactly like a usual composite option and works also the same way. The only difference is that instead of an "" tag "" is used. If the PPD generator finds such an option, it hides the member options by only using "*Foomatic..." keywords to describe them, not any standard PPD keywords as "*OpenUI...", "*OrderDependency...", ... This way PPD-aware graphical frontends do not see the member options but foomatic-rip has all information from them to run the driver correctly. String and Password Options --------------------------- These options allow the user to supply nearly arbitrary strings (within limits of length, characters and structure) to the printer driver, for example names of color calibration files, fax numbers, passwords for confidential jobs, ... Frequently needed strings can be added as enumerated choices, so a frontend can show the option as a combo-box. The enumerated choices are also used for frontends which only support options as defined by the PPD spec. So having enumerated choices is highly recommended for most of these options. In the XML database string and password options look similar to enumerated choice options. The differences are the option types "string" or "password" and the additional tags to restrict the possible strings. The "" tags give a length limit, it should once not allow strings longer than around 100 characters, as otherwise foomatic-configure could generate a line longer than the allowed 255 characters in the PPD file when setting the default value, and second, which is very important, it should not allow strings which are too long for the printer filter or driver so that buffer overflows cannot occur. Not using the "" tags makes arbitrary long strings to be accepted, this is not recommended. With "" the accepted strings can be restricted to contain only the characters given in the list. This restrictions does not only avoid that the filter chokes on a wrong option, it serves mainly for security reasons, for example to avoid a string like "|| rm -rf * ||" for a command line option. So if the option prototype does not quote the string, command delimiter characters, I/O re-directors, and shell special characters (";", "|", "&", "<", ">", "*", "?", "[", "]", "{", "}", "(", ")", "$", "\", "'", """) should not be allowed. If the string is quoted by the option prototype, the closing quote character and the backslash should not be allowed, so that one cannot escape from the quoting. The allowed characters are checked by a "/^[...]*$/" expression in the Perl scripts, so ranges with "-", a list of forbidden characters with a leading "^", or special characters as "\w", "\d", "\x07", ... are allowed. To allow a backslash, one has to escape it by using two backslashes ("\\"). To allow a "-" it must be in the end of the list to not make it defining a range and for a "^" must be placed at any other place than the beginning of the string if it should be explicitly allowed. "" allows also to restrict the structure of the string, as it defines an arbitrary Perl regular expression (see "man perlre") which has to be matched by the string. This serves also for having only strings which are usable by the filter and which do not destroy the command line structure. With this one can for example forbid a backslash as the last character to avoid escaping the closing quote of the option prototype. Regular expressions are applied via a '/.../' expression in the Perl scripts. To apply the pattern matching modifiers "i", "m", "s", or "x" (as "/.../i" for case-insensitive matching) begin the regular expression with "(?)" (as "(?i)..." for case-insensitive matching). It is highly recommended to use at least one of "" and "", as otherwise all characters are allowed in the user-supplied string and so a malicious user can execute arbitrary shell or PostScript commands. If both tags are used, both conditions have to be fulfilled. Note that for the character lists and regular expressions in the XML files the following character substitutions have to be done: < --> < > --> > " --> " ' --> ' & --> & Here is an example for an option to supply the file name for an ICC profile for the "foo2zjs" driver (this option is neither in the CVS for the Foomatic database nor tested with this driver): -------------------------------------------------------------------------- This option controls which .ICM file to use for color correction. ICM files are stored in the directory /usr/share/foo2zjs/icm/. ICM Color Profile ICM Adjustment 300 A -G%s 127 A-Za-z0-9\._/- (?<!\/)$ foo2zjs ev/foo2zjs-ICM-none Minolta magicolor 2300 DL foo2zjs ev/foo2zjs-ICM-DL2312 Minolta magicolor 2200 DL foo2zjs ev/foo2zjs-ICM-DL2200RGB No ICM color correction None File DL2312.icm DL2312 DL2312.icm HP LaserJet 1000 File DL2324.icm DL2324 DL2324.icm HP LaserJet 1000 ... -------------------------------------------------------------------------- This option allows to choose either one of the given file names, either by using the ""s or the ""s, or one can give every arbitrary other file name with a maximum length of 127 characters, only containing letters, digits, periods, underscores, dashes, and slashes, and not having a slash in the end (no directories). Note that in Perl the period must be escaped by a backslash to be taken literally, otherwise it stands for an arbitrary character. The regular expression for blocking out strings ending with a slash is "(?" may differ from the "", the string inserted at the "%s" place holder in the "" is always the "", independent whether the user supplies the "" directly or the "". In this example both lpr -o ICM= file.ps and lpr -o ICM=None file.ps supply an empty string as the value of the ICM option. For the default value there must be an enumerated choice, if there is none, the PPD generator will create one. So this entry is allowed (this option is only an example, it is not in the CVS of the Foomatic database): -------------------------------------------------------------------------- Password (for confidential jobs) Password General 100 B --pass=%s 30 A-Za-z0-9\.,_\+\=\:-/ mydriver -------------------------------------------------------------------------- The default value is an empty string here. So the PPD generator will add a choice for the empty string. Normally, automatically added choices get the same "" as the string itself, but if the string is not allowed as an option name in a PPD file, the "" will be modified. For an empty string (as in the example above) "None" will be used and all characters except numbers, letters, and underscores ("_") will be replaced by underscores. The option types "string" and "password" are treated exactly the same way by the PPD generator and by foomatic-rip, the different names are only for frontends to know whether the input field should display the typed characters or asterisks on the screen. CUPS Custom Options ------------------- CUPS defines several extensions to the PPD specifications to support the functionality of modern printers: http://www.cups.org/documentation.php/doc-1.4/spec-ppd.html There are extensions for so-called "Custom Options" where instead of given enumerated choices freely choosable custom values can be supplied. As Foomatic's numerical, string, and password options can be implemented as CUPS custom options in the PPDs as well, the PPD generator does both implementations in the PPDs. There are the "*Foomatic..." keywords generated, as before, but also the CUPS PPD extension, consisting of the keywords "*Custom" and "*ParamCustom" keywords. This way GUIs which are aware of CUPS' custom options give full access to Foomatic's numerical, string, and password options. foomatic-rip understands also PPD files now which describe custom options only by the CUPS extension and not with "*Foomatic..." keywords. Allowed characters and regular expressions for string and password options cannot be described by CUPS PPD extensions. So CUPS-aware GUIs will allow input of strings which do not match these restrictions, but foomatic-rip will let the option fall back to the default value in such a case. This way the security is assured. Option Grouping --------------- All options should be put in groups (with the tags "..." in the "" section of the option XML files, see above). This way many GUIs sort the options into tabs or tree branches according to the groups. This way one gets only the most important options on the first tab and not so often needed ones on additional tabs. This also overrides the automatic option grouping of CUPS (Groups "General" and "Extra"). It is recommended to have the options in groups as follows (plus perhaps special groups, but not one group for every option): General Here go options which are most used on a job-by-job basis, as the options for paper type, size, and tray, ink type, duplex, ... and all options affecting the printout quality, as resolution, dithering, ... and especially "PrintoutMode". If a "PrintoutMode" option is present, all quality-related options covered by the "PrintoutMode" option go into the automatically created "PrintoutMode" group (see above). And this is intended, these options are now usually controlled by "PrintoutMode" and so they are not the most important options for the first tab any more. Do not put color/brightness/gamma, ... options here, they go to "Adjustment". Options typically to go here are: o PageSize o InputSlot o MediaType o InkType o Duplex o PrintoutMode o Resolution o REt o Dither o FastRes o Economode o ... All options mentioned after "PrintoutMode" will usually be used as member options for "PrintoutMode", they are only in this group when there is no "PrintoutMode" option. PrintoutMode This group only exists if there is a "PrintoutMode" option, because it is generated by this option. It contains the member options of "PrintoutMode". Typical candidates are o Resolution o REt o Dither o FastRes o Economode o ... They do not need an "PrintoutMode" line, they are put into this group automatically. You should better put an "General" line into these options, so that they go into the "General" group when there is a printer/driver combo for which no "PrintoutMode" option applies. Adjustment Options for correcting the appearance of colors, contrast, ..., for head alignment, ... etc. Here most numerical options will go, but also things like "Density", also if it is an enumerated choice option. Typical candidates are: o Gamma o Brightness o Contrast o Density o Saturation o Cyan o Magenta o Yellow o ... Finishing If a printer has a stapler, folder, cutter, envelope packer, or similar devices to do additional processing on the ready printout, the options to control this stuff go into this group. Examples: o Stapling o Binding o Cutting o Booklet o ... Miscellaneous Options which do not fit into the mentioned groups and for which it is not worth to make a special group. Unprintable margins ------------------- On most printers you cannot print arbitrarily close to the borders of the paper. You usually will have margins of certain width on which you cannot print. For filters and application programs to know about these margins PPD files have "*ImageableArea" lines which define the positions of the lower, the upper, the left, and the right borders of the area on which the printer can print. There is one line for each paper size listed in the "*PageSize" option. To conveniently generate these lines one can use the following XML structure in the Foomatic database entries: -------------------------------------------------------------------------- pt 9 36 18 18 0 0 0 10 585 ... ... -------------------------------------------------------------------------- This structure is allowed in printer entries in the "" section and in driver entries in the "" section or inside a "" entry of the driver's printer list. In the "" section of a driver entry the margins are valid for all printers used with this driver, in a "" entry they apply only to the given printer/driver combo. The shown example could be for the HP PhotoSmart 7150/7350, which does full-bleed only on HP's special photo paper with an 0.5 inch wide tear-off tab on the lower border (and some other paper sizes used in the photo tray). On all other paper sizes the printer leaves white borders of half an inch at the top and at the bottom and a quarter of an inch on the left and right hand side (1 inch are 72 pt). In addition, the page size "A4" allows to print up to 10 points to the left and the right borders. At first we give the general borders ("" section) where we choose the unit "pt" (PostScript points) for the numbers. These borders are valid for all paper sizes which are not explicitly mentioned with an "" section. For our printers one of the exceptions is the 4x6 photo paper with the tear-off tab (including the tab the paper is 4x6.5 inches large). here the printer prints up to the left, right, and top borders. Therefore we have margins of zero here. At the lower border the printer still leaves half an inch white (therefore probably HP introduced the tear-off tab), so we keep the 36 pt of the "" section by not mentioning a new lower border. For A4 we redefine the left and the right border. This is also possible in absolute PostScript coordinates measured from the lower left corner, as we do here. We indicate this with the "" tag. The left border is at 10 pt from the left, and as A4 paper is 595 pt wide, the right border is at 585 points from the left. One hint for the choice of the units: Float numbers as border widths are allowed, but it is recommended for having exact info to choose a unit which gives integer numbers for the widths (which is always possible with the "dotsNNNdpi" unit with NNN being the maximum resolution of the printer). A "" section in a printer entry should represent the printer's hardware capabilities. Such a section in a driver entry should represent how the driver's limitations are. If there are margins defined in both the printer and the driver entry of the desired printer/driver combo, the more restrictive (wider) borders count. If there are no border definitions in both the printer and the driver entry, the borders are assumed to be of the default widths. Adding arbitrary extra entries to the PPD file ---------------------------------------------- The "" tags allow to add extra lines to the PPD file. The tags can be put into the top level ("") of a printer XML entry, into the "" section of a driver XML entry, or into the "" entries of the printer list in a driver XML file. They serve mainly to put a default resolution into PPD files for drivers without "Resolution" option. Examples: "hpijs" driver, default resolution for HP DeskJet 350. For this driver the default resolution depends on the printer class. Therefore the appropriate ""s have to be in the printer entries of the printer list: -------------------------------------------------------------------------- hpijs ... printer/HP-DeskJet_350C *DefaultResolution: 600dpi in 0.25 0.25 0.125 0.67 0.135 0.135 ... -------------------------------------------------------------------------- "pnm2ppa" driver: This driver has no "Resolution" option, and all printers print in 600 dpi with it. So we put the "" into the "" section: -------------------------------------------------------------------------- pnm2ppa http://sourceforge.net/projects/pnm2ppa/ gs -q -dNOPAUSE -dPARANOIDSAFER -dBATCH -r600%A%Z -sOutputFile=- - | pnm2ppa%C%B -i - -o - *DefaultResolution: 600dpi ... -------------------------------------------------------------------------- Note that leading spaces are removed from the lines between the "" tags before they get inserted into the PPD file. The lines are added at the end of the PPD file header, right after the lines for the basic hardware capabilities of the printer. Example for a Foomatic-generated PPD file ----------------------------------------- Below is an example PPD file, the PPD file for the Citizen printiva600U used with the "ppmtomd" driver. It was generated with the command line ./foomatic-ppdfile -p HP-Color_LaserJet_4550 -d pxlcolor The structure is completely Adobe-compliant and no relevant information is in comments. Besides the usual keywords which one finds in PPDs there are some special ones beginning with "*Foomatic...". These keywords are read by foomatic-rip and contain all information to build the renderer's command line. See explanations for these keywords below the example file. If a printer has auto-detection information in the Foomatic database, the manufacturer and model names from there are inserted in the "*Manufacturer:" and "*Product:" fields and the IEEE-1284 ID string is put into the "*1284DeviceID:" field. Independent whether there is auto-detection information, there is an additional "DRV:" field in the "*1284DeviceID:" which contains driver properties. These properties are put here, so that they appear in CUPS' PPD/driver overview listings ("lpinfo -l -m"). This way a printer setup tool can show the driver properties in a driver overview without needing to generate and read the PPD files. The following properties are available (comma-separated): D: Driver name R: Driver Recommended for this printer (0, 1)? M: Driver supplied by the Manufacturer (0, 1)? O: Driver marked Obsolete in the OpenPrinting database (0, 1)? F: Driver is Free software (0, 1)? P: Driver has Patent issues (0, 1)? S: Support contacts (c: commercial, c: voluntary, u: unknown, more than one possible) T: Driver Type: G: Ghostscript built-in, C: CUPS-Raster, I: IJS, O: OpenPrinting Vector, F: Filter, U: Ghostscript Uniprint, P: PostScript X: Maximum X resolution of the driver in dpi Y: Maximum Y resolution of the driver in dpi C: Does the driver support Color printing (0, 1)? t: Rating for Text document printing with this driver (0 ... 100) l: Rating for Line art document printing with this driver (0 ... 100) g: Rating for Graphics document printing with this driver (0 ... 100) p: Rating for Photo document printing with this driver (0 ... 100) d: Rating for system loaD caused when printing with this driver (0 ... 100) s: Rating for processing Speed of this driver (0 ... 100) The "DRV:" field in a device ID looks like this: *1284DeviceID: "MFG:Hewlett-Packard;MDL:HP LaserJet 4050 Series;CMD:PJL,MLC,PCL, PCLXL,POSTSCRIPT;DES:Hewlett-Packard LaserJet 4050 Series;DRV:Dljet4,R0,M0,F1,Sv,TG,X600,Y600,C0,t90,l90,g60,p30,s90;" If there is no device ID for a printer, the "*1284DeviceID" will contain only the "DRV:" field. The PPDs contain the driver properties also in clear text, like this: *driverName ljet4/ljet4 - Built-in Ghostscript driver for PCL 5e laser printers: "" *driverType G/Ghostscript built-in: "" *driverUrl: "http://www.ghostscript.com/" *driverObsolete: False *driverRecommendedReplacement: hpijs (only if driver is obsolete) *driverSupplier: "GPL Ghostscript" *driverManufacturerSupplied: False *driverLicense: "GPL" *driverFreeSoftware: True *driverSupportContactVoluntary: "http://forums.openprinting.org/ OpenPrinting forums" *driverSupportContactCommercial: "http://... ..." *driverSupportContactUnknown: "http://... ..." *driverMaxResolution: 600 600 *driverColor: False *driverTextSupport: 90 *driverLineartSupport: 90 *driverGraphicsSupport: 60 *driverPhotoSupport: 30 *driverSystemmLoad: 90 *driverRenderingSpeed: 90 ---------------------------------------------------------------------------- *PPD-Adobe: "4.3" *% *% For information on using this, and to obtain the required backend *% script, consult http://www.openprinting.org/ *% *% This file is published under the GNU General Public License *% *% PPD-O-MATIC (4.0.0 or newer) generated this PPD file. It is for use with *% all programs and environments which use PPD files for dealing with *% printer capability information. The printer must be configured with the *% "foomatic-rip" backend filter script of Foomatic 4.0.0 or newer. This *% file and "foomatic-rip" work together to support PPD-controlled printer *% driver option access with all supported printer drivers and printing *% spoolers. *% *% To save this file on your disk, wait until the download has completed *% (the animation of the browser logo must stop) and then use the *% "Save as..." command in the "File" menu of your browser or in the *% pop-up manu when you click on this document with the right mouse button. *% DO NOT cut and paste this file into an editor with your mouse. This can *% introduce additional line breaks which lead to unexpected results. *% *% You may save this file as 'HP-Color_LaserJet_4550-pxlcolor.ppd' *% *% *FormatVersion: "4.3" *FileVersion: "1.1" *LanguageVersion: English *LanguageEncoding: ISOLatin1 *PCFileName: "PXLCOLOR.PPD" *Manufacturer: "HP" *Product: "(HP Color LaserJet 4550)" *cupsVersion: 1.0 *cupsManualCopies: True *cupsModelNumber: 2 *cupsFilter: "application/vnd.cups-postscript 100 foomatic-rip" *cupsFilter: "application/vnd.cups-pdf 0 foomatic-rip" *%pprRIP: foomatic-rip other *ModelName: "HP Color LaserJet 4550" *ShortNickName: "HP Color LaserJet 4550 pxlcolor" *NickName: "HP Color LaserJet 4550 Foomatic/pxlcolor" *PSVersion: "(3010.000) 550" *PSVersion: "(3010.000) 651" *PSVersion: "(3010.000) 652" *PSVersion: "(3010.000) 653" *PSVersion: "(3010.000) 704" *PSVersion: "(3010.000) 705" *PSVersion: "(3010.000) 800" *PSVersion: "(3010.000) 815" *PSVersion: "(3010.000) 850" *PSVersion: "(3010.000) 860" *PSVersion: "(3010.000) 861" *PSVersion: "(3010.000) 862" *PSVersion: "(3010.000) 863" *LanguageLevel: "3" *ColorDevice: True *DefaultColorSpace: RGB *FileSystem: False *Throughput: "1" *LandscapeOrientation: Plus90 *TTRasterizer: Type42 *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;" *driverName pxlcolor/pxlcolor: "" *driverType G/Ghostscript built-in: "" *driverUrl: "http://www.ghostscript.com/" *driverObsolete: False *DefaultResolution: 1200dpi *VariablePaperSize: False *FoomaticIDs: HP-Color_LaserJet_4550 pxlcolor *FoomaticRIPCommandLine: "gs -q -dBATCH -dPARANOIDSAFER -dNOPAUSE%B%A%&& Z -sOutputFile=- - | perl -p -e 'if (! $did) { s/\xc0.\xf8\x26/\x&& c0%E\xf8\x26/ && $did++; }'" *End *OpenGroup: General/General *OpenUI *PrintoutMode/Printout Mode: PickOne *FoomaticRIPOption PrintoutMode: enum Composite A *OrderDependency: 10 AnySetup *PrintoutMode *DefaultPrintoutMode: Normal *PrintoutMode Draft/Draft: "%% FoomaticRIPOptionSetting: PrintoutMode=Draft" *FoomaticRIPOptionSetting PrintoutMode=Draft: "PrinterResolution=300x3&& 00dpi ColorModel=Color Economode=On FastRes=Off" *End *PrintoutMode Draft.Gray/Draft Grayscale: "%% FoomaticRIPOptionSetting: PrintoutMode=Draft.Gray" *FoomaticRIPOptionSetting PrintoutMode=Draft.Gray: "PrinterResolution=&& 300x300dpi ColorModel=Grayscale Economode=On FastRes=Off" *End *PrintoutMode Normal/Normal: "%% FoomaticRIPOptionSetting: PrintoutMode=Normal" *FoomaticRIPOptionSetting PrintoutMode=Normal: "PrinterResolution=600x&& 600dpi ColorModel=Color Economode=Off FastRes=On" *End *PrintoutMode Normal.Gray/Normal Grayscale: "%% FoomaticRIPOptionSetting: PrintoutMode=Normal.Gray" *FoomaticRIPOptionSetting PrintoutMode=Normal.Gray: "PrinterResolution&& =600x600dpi ColorModel=Grayscale Economode=Off FastRes=On" *End *PrintoutMode High/High Quality: "%% FoomaticRIPOptionSetting: PrintoutMode=High" *FoomaticRIPOptionSetting PrintoutMode=High: "PrinterResolution=1200x1&& 200dpi ColorModel=Color Economode=Off FastRes=Off" *End *PrintoutMode High.Gray/High Quality Grayscale: "%% FoomaticRIPOptionSetting: PrintoutMode=High.Gray" *FoomaticRIPOptionSetting PrintoutMode=High.Gray: "PrinterResolution=1&& 200x1200dpi ColorModel=Grayscale Economode=Off FastRes=Off" *End *CloseUI: *PrintoutMode *OpenUI *PageSize/Page Size: PickOne *FoomaticRIPOption PageSize: enum CmdLine A *OrderDependency: 100 AnySetup *PageSize *DefaultPageSize: Letter *PageSize Letter/US Letter: "%% FoomaticRIPOptionSetting: PageSize=Letter" *FoomaticRIPOptionSetting PageSize=Letter: " -dDEVICEWIDTHPOINTS=612 -&& dDEVICEHEIGHTPOINTS=792" *End *PageSize A4/A4: "%% FoomaticRIPOptionSetting: PageSize=A4" *FoomaticRIPOptionSetting PageSize=A4: " -dDEVICEWIDTHPOINTS=595 -dDEV&& ICEHEIGHTPOINTS=842" *End *PageSize 11x17/11x17: "%% FoomaticRIPOptionSetting: PageSize=11x17" *FoomaticRIPOptionSetting PageSize=11x17: " -dDEVICEWIDTHPOINTS=792 -d&& DEVICEHEIGHTPOINTS=1224" *End *PageSize A3/A3: "%% FoomaticRIPOptionSetting: PageSize=A3" *FoomaticRIPOptionSetting PageSize=A3: " -dDEVICEWIDTHPOINTS=842 -dDEV&& ICEHEIGHTPOINTS=1191" *End *PageSize A5/A5: "%% FoomaticRIPOptionSetting: PageSize=A5" *FoomaticRIPOptionSetting PageSize=A5: " -dDEVICEWIDTHPOINTS=421 -dDEV&& ICEHEIGHTPOINTS=595" *End *PageSize B5/B5 (JIS): "%% FoomaticRIPOptionSetting: PageSize=B5" *FoomaticRIPOptionSetting PageSize=B5: " -dDEVICEWIDTHPOINTS=516 -dDEV&& ICEHEIGHTPOINTS=729" *End *PageSize Env10/Envelope #10: "%% FoomaticRIPOptionSetting: PageSize=Env10" *FoomaticRIPOptionSetting PageSize=Env10: " -dDEVICEWIDTHPOINTS=297 -d&& DEVICEHEIGHTPOINTS=684" *End *PageSize EnvC5/Envelope C5: "%% FoomaticRIPOptionSetting: PageSize=EnvC5" *FoomaticRIPOptionSetting PageSize=EnvC5: " -dDEVICEWIDTHPOINTS=459 -d&& DEVICEHEIGHTPOINTS=649" *End *PageSize EnvDL/Envelope DL: "%% FoomaticRIPOptionSetting: PageSize=EnvDL" *FoomaticRIPOptionSetting PageSize=EnvDL: " -dDEVICEWIDTHPOINTS=312 -d&& DEVICEHEIGHTPOINTS=624" *End *PageSize EnvISOB5/Envelope B5: "%% FoomaticRIPOptionSetting: PageSize=EnvISOB5" *FoomaticRIPOptionSetting PageSize=EnvISOB5: " -dDEVICEWIDTHPOINTS=499&& -dDEVICEHEIGHTPOINTS=709" *End *PageSize EnvMonarch/Envelope Monarch: "%% FoomaticRIPOptionSetting: PageSize=EnvMonarch" *FoomaticRIPOptionSetting PageSize=EnvMonarch: " -dDEVICEWIDTHPOINTS=2&& 79 -dDEVICEHEIGHTPOINTS=540" *End *PageSize Executive/Executive: "%% FoomaticRIPOptionSetting: PageSize=Executive" *FoomaticRIPOptionSetting PageSize=Executive: " -dDEVICEWIDTHPOINTS=52&& 2 -dDEVICEHEIGHTPOINTS=756" *End *PageSize Legal/US Legal: "%% FoomaticRIPOptionSetting: PageSize=Legal" *FoomaticRIPOptionSetting PageSize=Legal: " -dDEVICEWIDTHPOINTS=612 -d&& DEVICEHEIGHTPOINTS=1008" *End *CloseUI: *PageSize *OpenUI *PageRegion: PickOne *OrderDependency: 100 AnySetup *PageRegion *DefaultPageRegion: Letter *PageRegion Letter/US Letter: "%% FoomaticRIPOptionSetting: PageSize=Letter" *PageRegion A4/A4: "%% FoomaticRIPOptionSetting: PageSize=A4" *PageRegion 11x17/11x17: "%% FoomaticRIPOptionSetting: PageSize=11x17" *PageRegion A3/A3: "%% FoomaticRIPOptionSetting: PageSize=A3" *PageRegion A5/A5: "%% FoomaticRIPOptionSetting: PageSize=A5" *PageRegion B5/B5 (JIS): "%% FoomaticRIPOptionSetting: PageSize=B5" *PageRegion Env10/Envelope #10: "%% FoomaticRIPOptionSetting: PageSize=Env10" *PageRegion EnvC5/Envelope C5: "%% FoomaticRIPOptionSetting: PageSize=EnvC5" *PageRegion EnvDL/Envelope DL: "%% FoomaticRIPOptionSetting: PageSize=EnvDL" *PageRegion EnvISOB5/Envelope B5: "%% FoomaticRIPOptionSetting: PageSize=EnvISOB5" *PageRegion EnvMonarch/Envelope Monarch: "%% FoomaticRIPOptionSetting: PageSize=EnvMonarch" *PageRegion Executive/Executive: "%% FoomaticRIPOptionSetting: PageSize=Executive" *PageRegion Legal/US Legal: "%% FoomaticRIPOptionSetting: PageSize=Legal" *CloseUI: *PageRegion *DefaultImageableArea: Letter *ImageableArea Letter/US Letter: "18 36 594 756" *ImageableArea A4/A4: "18 36 577 806" *ImageableArea 11x17/11x17: "18 36 774 1188" *ImageableArea A3/A3: "18 36 824 1155" *ImageableArea A5/A5: "18 36 403 559" *ImageableArea B5/B5 (JIS): "18 36 498 693" *ImageableArea Env10/Envelope #10: "18 36 279 648" *ImageableArea EnvC5/Envelope C5: "18 36 441 613" *ImageableArea EnvDL/Envelope DL: "18 36 294 588" *ImageableArea EnvISOB5/Envelope B5: "18 36 481 673" *ImageableArea EnvMonarch/Envelope Monarch: "18 36 261 504" *ImageableArea Executive/Executive: "18 36 504 720" *ImageableArea Legal/US Legal: "18 36 594 972" *DefaultPaperDimension: Letter *PaperDimension Letter/US Letter: "612 792" *PaperDimension A4/A4: "595 842" *PaperDimension 11x17/11x17: "792 1224" *PaperDimension A3/A3: "842 1191" *PaperDimension A5/A5: "421 595" *PaperDimension B5/B5 (JIS): "516 729" *PaperDimension Env10/Envelope #10: "297 684" *PaperDimension EnvC5/Envelope C5: "459 649" *PaperDimension EnvDL/Envelope DL: "312 624" *PaperDimension EnvISOB5/Envelope B5: "499 709" *PaperDimension EnvMonarch/Envelope Monarch: "279 540" *PaperDimension Executive/Executive: "522 756" *PaperDimension Legal/US Legal: "612 1008" *OpenUI *InputSlot/Media Source: PickOne *FoomaticRIPOption InputSlot: enum CmdLine E *OrderDependency: 100 AnySetup *InputSlot *DefaultInputSlot: Default *InputSlot Default/Printer default: "%% FoomaticRIPOptionSetting: InputSlot=Default" *FoomaticRIPOptionSetting InputSlot=Default: "\x01" *InputSlot Tray1/Tray 1: "%% FoomaticRIPOptionSetting: InputSlot=Tray1" *FoomaticRIPOptionSetting InputSlot=Tray1: "\x03" *InputSlot Tray2/Tray 2: "%% FoomaticRIPOptionSetting: InputSlot=Tray2" *FoomaticRIPOptionSetting InputSlot=Tray2: "\x04" *InputSlot Tray3/Tray 3: "%% FoomaticRIPOptionSetting: InputSlot=Tray3" *FoomaticRIPOptionSetting InputSlot=Tray3: "\x05" *InputSlot Tray4/Tray 4: "%% FoomaticRIPOptionSetting: InputSlot=Tray4" *FoomaticRIPOptionSetting InputSlot=Tray4: "\x06" *InputSlot Tray5/Tray 5: "%% FoomaticRIPOptionSetting: InputSlot=Tray5" *FoomaticRIPOptionSetting InputSlot=Tray5: "\x07" *InputSlot Tray6/Tray 6: "%% FoomaticRIPOptionSetting: InputSlot=Tray6" *FoomaticRIPOptionSetting InputSlot=Tray6: "\x08" *InputSlot Tray7/Tray 7: "%% FoomaticRIPOptionSetting: InputSlot=Tray7" *FoomaticRIPOptionSetting InputSlot=Tray7: "\x09" *InputSlot Manual/Manual Feeder: "%% FoomaticRIPOptionSetting: InputSlot=Manual" *FoomaticRIPOptionSetting InputSlot=Manual: "\x02" *CloseUI: *InputSlot *JCLOpenUI *Manualfeed/Manual Feed of Paper: PickOne *OrderDependency: 100 JCLSetup *Manualfeed *DefaultManualfeed: Off *Manualfeed Off/Off: "@PJL SET MANUALFEED=OFF<0A>" *Manualfeed On/On: "@PJL SET MANUALFEED=ON<0A>" *JCLCloseUI: *Manualfeed *OpenUI *Duplex/Double-Sided printing: PickOne *FoomaticRIPOption Duplex: enum CmdLine A *OrderDependency: 100 AnySetup *Duplex *DefaultDuplex: None *Duplex DuplexNoTumble/On (Flip on Long Edge): "%% FoomaticRIPOptionSetting: Duplex=DuplexNoTumble" *FoomaticRIPOptionSetting Duplex=DuplexNoTumble: " -dDuplex" *Duplex DuplexTumble/On (Flip on Short Edge): "%% FoomaticRIPOptionSetting: Duplex=DuplexTumble" *FoomaticRIPOptionSetting Duplex=DuplexTumble: " -dDuplex -dTumble" *Duplex None/Off: "%% FoomaticRIPOptionSetting: Duplex=None" *FoomaticRIPOptionSetting Duplex=None: "" *CloseUI: *Duplex *JCLOpenUI *Copies/Number of Copies: PickOne *FoomaticRIPOption Copies: int JCL A *FoomaticRIPOptionPrototype Copies: "SET COPIES=%s" *FoomaticRIPOptionRange Copies: 1 100 *OrderDependency: 100 JCLSetup *Copies *DefaultCopies: 1 *FoomaticRIPDefaultCopies: 1 *Copies 1/1: "@PJL SET COPIES=1<0A>" *Copies 2/2: "@PJL SET COPIES=2<0A>" *Copies 3/3: "@PJL SET COPIES=3<0A>" *Copies 4/4: "@PJL SET COPIES=4<0A>" *Copies 5/5: "@PJL SET COPIES=5<0A>" *Copies 6/6: "@PJL SET COPIES=6<0A>" *Copies 7/7: "@PJL SET COPIES=7<0A>" *Copies 8/8: "@PJL SET COPIES=8<0A>" *Copies 9/9: "@PJL SET COPIES=9<0A>" *Copies 10/10: "@PJL SET COPIES=10<0A>" *Copies 11/11: "@PJL SET COPIES=11<0A>" *Copies 12/12: "@PJL SET COPIES=12<0A>" *Copies 13/13: "@PJL SET COPIES=13<0A>" *Copies 14/14: "@PJL SET COPIES=14<0A>" *Copies 15/15: "@PJL SET COPIES=15<0A>" *Copies 16/16: "@PJL SET COPIES=16<0A>" *Copies 17/17: "@PJL SET COPIES=17<0A>" *Copies 18/18: "@PJL SET COPIES=18<0A>" *Copies 19/19: "@PJL SET COPIES=19<0A>" *Copies 20/20: "@PJL SET COPIES=20<0A>" *Copies 21/21: "@PJL SET COPIES=21<0A>" *Copies 22/22: "@PJL SET COPIES=22<0A>" *Copies 23/23: "@PJL SET COPIES=23<0A>" *Copies 24/24: "@PJL SET COPIES=24<0A>" *Copies 25/25: "@PJL SET COPIES=25<0A>" *Copies 26/26: "@PJL SET COPIES=26<0A>" *Copies 27/27: "@PJL SET COPIES=27<0A>" *Copies 28/28: "@PJL SET COPIES=28<0A>" *Copies 29/29: "@PJL SET COPIES=29<0A>" *Copies 30/30: "@PJL SET COPIES=30<0A>" *Copies 31/31: "@PJL SET COPIES=31<0A>" *Copies 32/32: "@PJL SET COPIES=32<0A>" *Copies 33/33: "@PJL SET COPIES=33<0A>" *Copies 34/34: "@PJL SET COPIES=34<0A>" *Copies 35/35: "@PJL SET COPIES=35<0A>" *Copies 36/36: "@PJL SET COPIES=36<0A>" *Copies 37/37: "@PJL SET COPIES=37<0A>" *Copies 38/38: "@PJL SET COPIES=38<0A>" *Copies 39/39: "@PJL SET COPIES=39<0A>" *Copies 40/40: "@PJL SET COPIES=40<0A>" *Copies 41/41: "@PJL SET COPIES=41<0A>" *Copies 42/42: "@PJL SET COPIES=42<0A>" *Copies 43/43: "@PJL SET COPIES=43<0A>" *Copies 44/44: "@PJL SET COPIES=44<0A>" *Copies 45/45: "@PJL SET COPIES=45<0A>" *Copies 46/46: "@PJL SET COPIES=46<0A>" *Copies 47/47: "@PJL SET COPIES=47<0A>" *Copies 48/48: "@PJL SET COPIES=48<0A>" *Copies 49/49: "@PJL SET COPIES=49<0A>" *Copies 50/50: "@PJL SET COPIES=50<0A>" *Copies 51/51: "@PJL SET COPIES=51<0A>" *Copies 52/52: "@PJL SET COPIES=52<0A>" *Copies 53/53: "@PJL SET COPIES=53<0A>" *Copies 54/54: "@PJL SET COPIES=54<0A>" *Copies 55/55: "@PJL SET COPIES=55<0A>" *Copies 56/56: "@PJL SET COPIES=56<0A>" *Copies 57/57: "@PJL SET COPIES=57<0A>" *Copies 58/58: "@PJL SET COPIES=58<0A>" *Copies 59/59: "@PJL SET COPIES=59<0A>" *Copies 60/60: "@PJL SET COPIES=60<0A>" *Copies 61/61: "@PJL SET COPIES=61<0A>" *Copies 62/62: "@PJL SET COPIES=62<0A>" *Copies 63/63: "@PJL SET COPIES=63<0A>" *Copies 64/64: "@PJL SET COPIES=64<0A>" *Copies 65/65: "@PJL SET COPIES=65<0A>" *Copies 66/66: "@PJL SET COPIES=66<0A>" *Copies 67/67: "@PJL SET COPIES=67<0A>" *Copies 68/68: "@PJL SET COPIES=68<0A>" *Copies 69/69: "@PJL SET COPIES=69<0A>" *Copies 70/70: "@PJL SET COPIES=70<0A>" *Copies 71/71: "@PJL SET COPIES=71<0A>" *Copies 72/72: "@PJL SET COPIES=72<0A>" *Copies 73/73: "@PJL SET COPIES=73<0A>" *Copies 74/74: "@PJL SET COPIES=74<0A>" *Copies 75/75: "@PJL SET COPIES=75<0A>" *Copies 76/76: "@PJL SET COPIES=76<0A>" *Copies 77/77: "@PJL SET COPIES=77<0A>" *Copies 78/78: "@PJL SET COPIES=78<0A>" *Copies 79/79: "@PJL SET COPIES=79<0A>" *Copies 80/80: "@PJL SET COPIES=80<0A>" *Copies 81/81: "@PJL SET COPIES=81<0A>" *Copies 82/82: "@PJL SET COPIES=82<0A>" *Copies 83/83: "@PJL SET COPIES=83<0A>" *Copies 84/84: "@PJL SET COPIES=84<0A>" *Copies 85/85: "@PJL SET COPIES=85<0A>" *Copies 86/86: "@PJL SET COPIES=86<0A>" *Copies 87/87: "@PJL SET COPIES=87<0A>" *Copies 88/88: "@PJL SET COPIES=88<0A>" *Copies 89/89: "@PJL SET COPIES=89<0A>" *Copies 90/90: "@PJL SET COPIES=90<0A>" *Copies 91/91: "@PJL SET COPIES=91<0A>" *Copies 92/92: "@PJL SET COPIES=92<0A>" *Copies 93/93: "@PJL SET COPIES=93<0A>" *Copies 94/94: "@PJL SET COPIES=94<0A>" *Copies 95/95: "@PJL SET COPIES=95<0A>" *Copies 96/96: "@PJL SET COPIES=96<0A>" *Copies 97/97: "@PJL SET COPIES=97<0A>" *Copies 98/98: "@PJL SET COPIES=98<0A>" *Copies 99/99: "@PJL SET COPIES=99<0A>" *Copies 100/100: "@PJL SET COPIES=100<0A>" *JCLCloseUI: *Copies *CustomJCLCopies True: "@PJL SET COPIES=\1<0A>" *ParamCustomJCLCopies Copies/Number of Copies: 1 int 1 100 *CloseGroup: General *OpenGroup: Adjustment/Adjustment *JCLOpenUI *REt/REt Setting: PickOne *OrderDependency: 100 JCLSetup *REt *DefaultREt: Medium *REt Dark/Dark: "@PJL SET RET=DARK<0A>" *REt Light/Light: "@PJL SET RET=LIGHT<0A>" *REt Medium/Medium: "@PJL SET RET=MEDIUM<0A>" *REt Off/Off: "@PJL SET RET=OFF<0A>" *JCLCloseUI: *REt *JCLOpenUI *TonerDensity/Toner Density: PickOne *OrderDependency: 100 JCLSetup *TonerDensity *DefaultTonerDensity: 3 *TonerDensity 1/1: "@PJL SET DENSITY=1<0A>" *TonerDensity 2/2: "@PJL SET DENSITY=2<0A>" *TonerDensity 3/3: "@PJL SET DENSITY=3<0A>" *TonerDensity 4/4: "@PJL SET DENSITY=4<0A>" *TonerDensity 5/5: "@PJL SET DENSITY=5<0A>" *JCLCloseUI: *TonerDensity *FoomaticRIPOption GSResolution: enum CmdLine A 100 *FoomaticRIPOptionSetting GSResolution=FromPrinterResolution: "" *FoomaticRIPOptionSetting GSResolution=300x300dpi: " -r300x300" *FoomaticRIPOptionSetting GSResolution=600x600dpi: " -r600x600" *FoomaticRIPOptionSetting GSResolution=1200x600dpi: " -r1200x600" *FoomaticRIPOptionSetting GSResolution=1200x1200dpi: " -r1200x1200" *FoomaticRIPOption JCLResolution: enum JCL A 100 *FoomaticRIPOptionSetting JCLResolution=FromPrinterResolution: "" *FoomaticRIPOptionSetting JCLResolution=300x300dpi: "SET RESOLUTION=30&& 0" *End *FoomaticRIPOptionSetting JCLResolution=600x600dpi: "SET RESOLUTION=60&& 0" *End *FoomaticRIPOptionSetting JCLResolution=1200x600dpi: "SET RESOLUTION=1&& 200x600" *End *FoomaticRIPOptionSetting JCLResolution=1200x1200dpi: "SET RESOLUTION=&& 1200" *End *CloseGroup: Adjustment *OpenGroup: PrintoutMode/Printout Mode *OpenUI *FastRes/Fast Res.: PickOne *OrderDependency: 100 AnySetup *FastRes *DefaultFastRes: FromPrintoutMode *FastRes FromPrintoutMode/Controlled by 'Printout Mode': "%% FoomaticRIPOptionSetting: FastRes=@PrintoutMode" *FastRes Off/Off: "@PJL SET BITSPERPIXEL=1<0A>" *FastRes On/On: "@PJL SET BITSPERPIXEL=2<0A>" *CloseUI: *FastRes *OpenUI *Economode/Toner Saving: PickOne *OrderDependency: 100 AnySetup *Economode *DefaultEconomode: FromPrintoutMode *Economode FromPrintoutMode/Controlled by 'Printout Mode': "%% FoomaticRIPOptionSetting: Economode=@PrintoutMode" *Economode Off/Off: "@PJL SET ECONOMODE=OFF<0A>" *Economode On/On: "@PJL SET ECONOMODE=ON<0A>" *CloseUI: *Economode *OpenUI *ColorModel/Color Mode: PickOne *FoomaticRIPOption ColorModel: enum CmdLine B *OrderDependency: 100 AnySetup *ColorModel *DefaultColorModel: FromPrintoutMode *ColorModel FromPrintoutMode/Controlled by 'Printout Mode': "%% FoomaticRIPOptionSetting: ColorModel=@PrintoutMode" *ColorModel Color/Color: "%% FoomaticRIPOptionSetting: ColorModel=Color" *FoomaticRIPOptionSetting ColorModel=Color: " -sDEVICE=pxlcolor" *ColorModel Grayscale/Grayscale: "%% FoomaticRIPOptionSetting: ColorModel=Grayscale" *FoomaticRIPOptionSetting ColorModel=Grayscale: " -sDEVICE=pxlmono" *CloseUI: *ColorModel *OpenUI *PrinterResolution/Resolution: PickOne *FoomaticRIPOption PrinterResolution: enum Composite A *OrderDependency: 99 AnySetup *PrinterResolution *DefaultPrinterResolution: FromPrintoutMode *PrinterResolution FromPrintoutMode/Controlled by 'Printout Mode': "%% FoomaticRIPOptionSetting: PrinterResolution=FromPrintoutMode" *FoomaticRIPOptionSetting PrinterResolution=FromPrintoutMode: "" *PrinterResolution 300x300dpi/300 DPI: "%% FoomaticRIPOptionSetting: PrinterResolution=300x300dpi" *FoomaticRIPOptionSetting PrinterResolution=300x300dpi: "JCLResolution&& =300x300dpi GSResolution=300x300dpi" *End *PrinterResolution 600x600dpi/600 DPI: "%% FoomaticRIPOptionSetting: PrinterResolution=600x600dpi" *FoomaticRIPOptionSetting PrinterResolution=600x600dpi: "JCLResolution&& =600x600dpi GSResolution=600x600dpi" *End *CloseUI: *PrinterResolution *CloseGroup: PrintoutMode *% Generic boilerplate PPD stuff as standard PostScript fonts and so on *DefaultFont: Courier *Font AvantGarde-Book: Standard "(001.006S)" Standard ROM *Font AvantGarde-BookOblique: Standard "(001.006S)" Standard ROM *Font AvantGarde-Demi: Standard "(001.007S)" Standard ROM *Font AvantGarde-DemiOblique: Standard "(001.007S)" Standard ROM *Font Bookman-Demi: Standard "(001.004S)" Standard ROM *Font Bookman-DemiItalic: Standard "(001.004S)" Standard ROM *Font Bookman-Light: Standard "(001.004S)" Standard ROM *Font Bookman-LightItalic: Standard "(001.004S)" Standard ROM *Font Courier: Standard "(002.004S)" Standard ROM *Font Courier-Bold: Standard "(002.004S)" Standard ROM *Font Courier-BoldOblique: Standard "(002.004S)" Standard ROM *Font Courier-Oblique: Standard "(002.004S)" Standard ROM *Font Helvetica: Standard "(001.006S)" Standard ROM *Font Helvetica-Bold: Standard "(001.007S)" Standard ROM *Font Helvetica-BoldOblique: Standard "(001.007S)" Standard ROM *Font Helvetica-Narrow: Standard "(001.006S)" Standard ROM *Font Helvetica-Narrow-Bold: Standard "(001.007S)" Standard ROM *Font Helvetica-Narrow-BoldOblique: Standard "(001.007S)" Standard ROM *Font Helvetica-Narrow-Oblique: Standard "(001.006S)" Standard ROM *Font Helvetica-Oblique: Standard "(001.006S)" Standard ROM *Font NewCenturySchlbk-Bold: Standard "(001.009S)" Standard ROM *Font NewCenturySchlbk-BoldItalic: Standard "(001.007S)" Standard ROM *Font NewCenturySchlbk-Italic: Standard "(001.006S)" Standard ROM *Font NewCenturySchlbk-Roman: Standard "(001.007S)" Standard ROM *Font Palatino-Bold: Standard "(001.005S)" Standard ROM *Font Palatino-BoldItalic: Standard "(001.005S)" Standard ROM *Font Palatino-Italic: Standard "(001.005S)" Standard ROM *Font Palatino-Roman: Standard "(001.005S)" Standard ROM *Font Symbol: Special "(001.007S)" Special ROM *Font Times-Bold: Standard "(001.007S)" Standard ROM *Font Times-BoldItalic: Standard "(001.009S)" Standard ROM *Font Times-Italic: Standard "(001.007S)" Standard ROM *Font Times-Roman: Standard "(001.007S)" Standard ROM *Font ZapfChancery-MediumItalic: Standard "(001.007S)" Standard ROM *Font ZapfDingbats: Special "(001.004S)" Standard ROM ---------------------------------------------------------------------------- Foomatic keywords ----------------- *FoomaticIDs: : The printer ID in the Foomatic database : The driver name/ID in the Foomatic database *FoomaticRIPPostPipe: "" : A shell command line into which the output of foomatic-rip is piped. Only used with LPRng, LPD, GNUlpr, spooler-less *FoomaticRIPCammandLine: "" : The general command line prototype, with spots to insert option settings ("%A", "%B", ...). *FoomaticRIPCammandLinePDF: "" : The command line prototype for PDF input if it is different to the one for PostScript input, with spots to insert option settings ("%A", "%B", ...). *FoomaticNoPageAccounting: : If True, no accounting code will be inserted into the PostScript data stream. *FoomaticRIPOption :