Copyright © 2008 Linux Foundation
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".
Portions of the text may be copyrighted by the following parties:
The Regents of the University of California
Free Software Foundation
Ian F. Darwin
Paul Vixie
BSDI (now Wind River)
Andrew G Morgan
Jean-loup Gailly and Mark Adler
Massachusetts Institute of Technology
Apple Inc.
Easy Software Products
artofcode LLC
Till Kamppeter
Manfred Wassman
Python Software Foundation
These excerpts are being used in accordance with their respective licenses.
Linux is the registered trademark of Linus Torvalds in the U.S. and other countries.
UNIX is a registered trademark of The Open Group.
LSB is a trademark of the Linux Foundation in the United States and other countries.
AMD is a trademark of Advanced Micro Devices, Inc.
Intel and Itanium are registered trademarks and Intel386 is a trademark of Intel Corporation.
PowerPC is a registered trademark and PowerPC Architecture is a trademark of the IBM Corporation.
S/390 is a registered trademark of the IBM Corporation.
OpenGL is a registered trademark of Silicon Graphics, Inc.
This is version 4.0 of the LSB-Printing Module Specification.
An implementation of this version of the specification may not claim to be an implementation of LSB-Printing Module unless it has successfully completed the compliance process as defined by the Linux Foundation.
The LSB-Printing Module defines the multimedia components that are required to be present on a conforming system.
This document should be used in conjunction with the documents it references. Information referenced in this way is as much a part of this document as is the information explicitly included here.
The LSB-Printing module defines the multimedia components found on an LSB conforming system.
The specifications listed below are referenced in whole or in part by the LSB-Printing Module Standard. Such references may be normative or informative; a reference to specification shall only be considered normative if it is explicitly cited as such. The LSB-Printing Module may make normative references to a portion of these specifications (that is, to define a specific function or group of functions); in such cases, only the explicitly referenced portion of the specification is to be considered normative.
Table 2-1. Normative References
| Name | Title | URL |
|---|---|---|
| Filesystem Hierarchy Standard | Filesystem Hierarchy Standard (FHS) 2.3 | http://www.pathname.com/fhs/ |
| ISO C (1999) | ISO/IEC 9899: 1999, Programming Languages --C | |
| PPD Specification | PostScript Printer Description File Format Specification version 4.3 | http://partners.adobe.com/public/developer/en/ps/5003.PPD_Spec_v4.3.pdf |
| PPD Specification Update | Update to PPD Specification Version 4.3 | http://partners.adobe.com/public/developer/en/ps/5645.PPD_Update.pdf |
The libraries listed in Table 3-1 shall be available on a Linux Standard Base system, with the specified runtime names. This list may be supplemented or amended by the architecture-specific specification.
Table 3-1. Standard Library Names
| Library | Runtime Name |
|---|---|
| libcups | libcups.so.2 |
| libcupsimage | libcupsimage.so.2 |
These libraries will be in an implementation-defined directory which the dynamic linker shall search by default.
For the purposes of this document, the following definitions, as specified in the ISO/IEC Directives, Part 2, 2001, 4th Edition, apply:
For the purposes of this document, the following terms apply:
Describes a value or behavior that is not defined by this document but is selected by an implementor. The value or behavior may vary among implementations that conform to this document. An application should not rely on the existence of the value or behavior. An application that relies on such a value or behavior cannot be assured to be portable across conforming implementations. The implementor shall document such a value or behavior so that it can be used correctly by an application.
A file that is read by an interpreter (e.g., awk). The first line of the shell script includes a reference to its interpreter binary.
Describes the nature of a value or behavior not defined by this document which results from use of an invalid program construct or invalid data input. The value or behavior may vary among implementations that conform to this document. An application should not rely on the existence or validity of the value or behavior. An application that relies on any particular value or behavior cannot be assured to be portable across conforming implementations.
Describes the nature of a value or behavior not specified by this document which results from use of a valid program construct or valid data input. The value or behavior may vary among implementations that conform to this document. An application should not rely on the existence or validity of the value or behavior. An application that relies on any particular value or behavior cannot be assured to be portable across conforming implementations.
The Postscript Printer Description (PPD) format is used in a text file to describe device capabilities for a printing device. PPD files shall conform to the format described by PPD Specification and PPD Specification Update. In addition, several extensions to the standard attribute list are recognized, as listed below. The "cupsVersion" attribute is required in a compliant PPD, while the other attributes are optional.
This string attribute specifies an sRGB-based color profile consisting of gamma and density controls and a 3x3 CMY color transform matrix.
The attribute has the following parameter usage:
*cupsColorProfile Resolution/MediaType: "density gamma m00 m01 m02 m10 m11 m12 m20 m21 m22"
The Resolution and MediaType values may be "-" to act as a wildcard. Otherwise, they must match one of the Resolution or MediaType attributes defined in the PPD file.
The density and gamma values define the gamma and density adjustment function such that (in terms of C math):
f(x) = density * pow(x, gamma)
The m00 through m22 values define a 3x3 transformation matrix for the CMY color values. The density function is applied after the CMY transformation:
| m00 m01 m02 | | m10 m11 m12 | | m20 m21 m22 |
This boolean attribute specifies whether the PPD defines a facsimile device. The default is false.
The attribute has the following parameter usage:
*cupsFilter: "source/type cost program"
This string attribute provides a conversion rule from the given source type to the printer's native format using the filter "program". A source type is specified according to the conventions of the MIME specification, using "type/subtype" nomenclature, and may refer to a standard MIME type or a CUPS-specific MIME type using the prefix "vnd.cups-" in the subtype. If a printer supports the source type directly, the special filter program "-" may be specified. The cost is an arbitrary positive integer, used to calculate the relative impact a print job has on system load.
This boolean attribute notifies the RIP filters that the destination printer does not support copy generation in hardware. The default value is false.
This integer attribute specifies a printer-specific model number. This number can be used by a filter program to adjust the output for a specific model of printer.
The attribute has the following parameter usage:
*cupsVersion: "major.minor"
This required attribute describes which version of the CUPS PPD file extensions was used. Currently it must be the string "1.0" or "1.1". The strings "1.2" and "1.3" represent newer versions of the CUPS PPD API that are not covered in this version of the specification, and are currently not allowed, although they may be found in non-conforming PPDs which use a newer version of the CUPS PPD specification.
The attribute has the following parameter usage:
*FoomaticIDs printer driver
The parameters correspond to the IDs in the Foomatic database for the printer and driver, respectively.
This boolean attribute tells foomatic-rip whether or not to insert accounting information into the PostScript data stream. By default, foomatic-rip will insert this information.
The attribute has the following parameter usage:
*FoomaticRIPCommandLine "code"
This attribute defines the command line in the "code" parameter for the renderer that is called by foomatic-rip. The command must take PostScript on standard input and provide the job data stream in the printer's native language on standard output. The command must exit with status 0 if the conversion was successful and exit with another status if an error occurs. The "code" parameter may contain option setting wildcards, as described below under "FoomaticRIPOption".
The attribute has the following parameter usage:
*FoomaticRIPDefaultOptionName value
This attribute sets a default for a Foomatic option. The name of the attribute should contain the name of the option appended to "FoomaticRIPDefault", with the desired default value as the only parameter.
This option is only used to provide numeric options in the PPD, which are not supported by the Adobe spec, via enumerated options, and should not be used except for that purpose.
The attribute has the following parameter usage:
*FoomaticRIPOption name: type style spot [order]
This attribute sets options for the command line specified in the "FoomaticRIPCommandLine" attribute. The "name" parameter specifies the option name, the "type" parameter specifies the option type, the "style" parameter specifies one of "CmdLine", "JCL", "PS", or "Composite", and the "spot" parameter specifies a letter, which is prepended with a "%" and used in the "FoomaticRIPCommandLine" attribute to indicate where the option should go in the command line. The optional "order" parameter indicates an order number for one-choice options.
The attribute has the following parameter usage:
*FoomaticRIPOptionAllowedChars name: "code"
This option sets a list of allowed characters in a string option. The "name" parameter identifies the option, while the "code" parameter is a list of allowed characters.
The attribute has the following parameter usage:
*FoomaticRIPOptionAllowedRegExp name: "code"
This option causes the option named by "name" to be validated by the Perl-style regular expression in "code".
The attribute has the following parameter usage:
*FoomaticRIPOptionMaxLength name: length
For string or password options, this attribute sets a maximum length which can be returned. The "name" parameter identifies the option, and the "length" parameter is the maximum number of characters allowed.
The attribute has the following parameter usage:
*FoomaticRIPOptionPrototype name: "code"
For string, password, or simulated numeric options, this attribute sets a code prototype to be inserted into the output. This works for options where the FoomaticRIPOption "style" parameter is set to CmdLine, JCL, or PS. The value of the option can be represented with the string "%s" in the "code" parameter.
The attribute has the following parameter usage:
*FoomaticRIPOptionRange name: min max
This attribute adds a minimux and maximum limit to numeric options (that are simulated by Foomatic via emumerated options). The "name" parameter identifies the option, while the "min" and "max" parameters set the minumum and maximum allowed values, respectively, for the option.
The attribute has the following parameter usage:
*FoomaticRIPOptionSetting name=choice: "code"
This attribute adds code to an option, identified by "name", with a FoomaticRIPOption "style" parameter set to Composite. It inserts options for other options that are members of the Composite option "name".
The attribute has the following parameter usage:
*FoomaticRIPPostPipe "code"
This attribute defines the command line in the "code" parameter for the job output command used by foomatic-rip in standalone mode. The command should take printer-native data on standard input. The "code" parameter should include the preceding shell pipe symbol ("|").
Table 7-1 defines the library name and shared object name for the libcups library
The behavior of the interfaces in this library is specified by the following specifications:
| [LSB] This Specification |
An LSB conforming implementation shall provide the generic functions for CUPS Convenience ABI specified in Table 7-2, with the full mandatory functionality as described in the referenced underlying specification.
Table 7-2. libcups - CUPS Convenience ABI Function Interfaces
| cupsAddDest [LSB] | cupsAddOption [LSB] | cupsCancelJob [LSB] | cupsEncryption [LSB] |
| cupsFreeDests [LSB] | cupsFreeJobs [LSB] | cupsFreeOptions [LSB] | cupsGetDefault [LSB] |
| cupsGetDest [LSB] | cupsGetDests [LSB] | cupsGetJobs [LSB] | cupsGetOption [LSB] |
| cupsGetPPD [LSB] | cupsGetPassword [LSB] | cupsLangEncoding [LSB] | cupsLangFlush [LSB] |
| cupsLangFree [LSB] | cupsLangGet [LSB] | cupsLastError [LSB] | cupsMarkOptions [LSB] |
| cupsParseOptions [LSB] | cupsPrintFile [LSB] | cupsPrintFiles [LSB] | cupsServer [LSB] |
| cupsSetDests [LSB] | cupsSetEncryption [LSB] | cupsSetPasswordCB [LSB] | cupsSetServer [LSB] |
| cupsSetUser [LSB] | cupsTempFd [LSB] | cupsUser [LSB] | ppdClose [LSB] |
| ppdCollect [LSB] | ppdConflicts [LSB] | ppdEmit [LSB] | ppdEmitFd [LSB] |
| ppdEmitJCL [LSB] | ppdErrorString [LSB] | ppdFindAttr [LSB] | ppdFindChoice [LSB] |
| ppdFindMarkedChoice [LSB] | ppdFindNextAttr [LSB] | ppdFindOption [LSB] | ppdIsMarked [LSB] |
| ppdLastError [LSB] | ppdMarkDefaults [LSB] | ppdMarkOption [LSB] | ppdOpen [LSB] |
| ppdOpenFd [LSB] | ppdOpenFile [LSB] | ppdPageLength [LSB] | ppdPageSize [LSB] |
| ppdPageWidth [LSB] | ppdSetConformance [LSB] |
This section defines global identifiers and their values that are associated with interfaces contained in libcups. These definitions are organized into groups that correspond to system headers. This convention is used as a convenience for the reader, and does not imply the existence of these headers, or their content. Where an interface is defined as requiring a particular system header file all of the data definitions for that system header file presented here shall be in effect.
This section gives data definitions to promote binary application portability, not to repeat source interface definitions available elsewhere. System providers and application developers should use this ABI to supplement - not to replace - source interface definition specifications.
This specification uses the ISO C (1999) C Language as the reference programming language, and data definitions are specified in ISO C format. The C language is used here as a convenient notation. Using a C language description of these data objects does not preclude their use by other programming languages.
#define _CUPS_CUPS_H_
#define CUPS_VERSION_MAJOR 1
#define CUPS_VERSION_MINOR 1
#define CUPS_VERSION 1.0123
#define CUPS_VERSION_PATCH 23
#define cupsLangDefault() cupsLangGet(NULL)
typedef enum {
CUPS_AUTO_ENCODING = -1,
CUPS_US_ASCII = 0,
CUPS_ISO8859_1 = 1,
CUPS_ISO8859_2 = 2,
CUPS_ISO8859_3 = 3,
CUPS_ISO8859_4 = 4,
CUPS_ISO8859_5 = 5,
CUPS_ISO8859_6 = 6,
CUPS_ISO8859_7 = 7,
CUPS_ISO8859_8 = 8,
CUPS_ISO8859_9 = 9,
CUPS_ISO8859_10 = 10,
CUPS_UTF8 = 11,
CUPS_ISO8859_13 = 12,
CUPS_ISO8859_14 = 13,
CUPS_ISO8859_15 = 14,
CUPS_WINDOWS_874 = 15,
CUPS_WINDOWS_1250 = 16,
CUPS_WINDOWS_1251 = 17,
CUPS_WINDOWS_1252 = 18,
CUPS_WINDOWS_1253 = 19,
CUPS_WINDOWS_1254 = 20,
CUPS_WINDOWS_1255 = 21,
CUPS_WINDOWS_1256 = 22,
CUPS_WINDOWS_1257 = 23,
CUPS_WINDOWS_1258 = 24,
CUPS_KOI8_R = 25,
CUPS_KOI8_U = 26
} cups_encoding_t;
typedef struct cups_lang_str {
struct cups_lang_str *next;
int used;
cups_encoding_t encoding;
char language[16];
char *messages[506];
} cups_lang_t;
typedef enum {
HTTP_ENCRYPT_IF_REQUESTED = 0,
HTTP_ENCRYPT_NEVER = 1,
HTTP_ENCRYPT_REQUIRED = 2,
HTTP_ENCRYPT_ALWAYS = 3
} http_encryption_t;
typedef struct {
char *name;
char *value;
} cups_option_t;
typedef struct {
char *name;
char *instance;
int is_default;
int num_options;
cups_option_t *options;
} cups_dest_t;
typedef enum {
HTTP_WAITING = 0,
HTTP_OPTIONS = 1,
HTTP_GET = 2,
HTTP_GET_SEND = 3,
HTTP_HEAD = 4,
HTTP_POST = 5,
HTTP_POST_RECV = 6,
HTTP_POST_SEND = 7,
HTTP_PUT = 8,
HTTP_PUT_RECV = 9,
HTTP_DELETE = 10,
HTTP_TRACE = 11,
HTTP_CLOSE = 12,
HTTP_STATUS = 13
} http_state_t;
typedef enum {
HTTP_ERROR = -1,
HTTP_CONTINUE = 100,
HTTP_SWITCHING_PROTOCOLS = 101,
HTTP_OK = 200,
HTTP_CREATED = 201,
HTTP_ACCEPTED = 202,
HTTP_NOT_AUTHORITATIVE = 203,
HTTP_NO_CONTENT = 204,
HTTP_RESET_CONTENT = 205,
HTTP_PARTIAL_CONTENT = 206,
HTTP_MULTIPLE_CHOICES = 300,
HTTP_MOVED_PERMANENTLY = 301,
HTTP_MOVED_TEMPORARILY = 302,
HTTP_SEE_OTHER = 303,
HTTP_NOT_MODIFIED = 304,
HTTP_USE_PROXY = 305,
HTTP_BAD_REQUEST = 400,
HTTP_UNAUTHORIZED = 401,
HTTP_PAYMENT_REQUIRED = 402,
HTTP_FORBIDDEN = 403,
HTTP_NOT_FOUND = 404,
HTTP_METHOD_NOT_ALLOWED = 405,
HTTP_NOT_ACCEPTABLE = 406,
HTTP_PROXY_AUTHENTICATION = 407,
HTTP_REQUEST_TIMEOUT = 408,
HTTP_CONFLICT = 409,
HTTP_GONE = 410,
HTTP_LENGTH_REQUIRED = 411,
HTTP_PRECONDITION = 412,
HTTP_REQUEST_TOO_LARGE = 413,
HTTP_URI_TOO_LONG = 414,
HTTP_UNSUPPORTED_MEDIATYPE = 415,
HTTP_UPGRADE_REQUIRED = 426,
HTTP_SERVER_ERROR = 500,
HTTP_NOT_IMPLEMENTED = 501,
HTTP_BAD_GATEWAY = 502,
HTTP_SERVICE_UNAVAILABLE = 503,
HTTP_GATEWAY_TIMEOUT = 504,
HTTP_NOT_SUPPORTED = 505
} http_status_t;
typedef enum {
HTTP_0_9 = 9,
HTTP_1_0 = 100,
HTTP_1_1 = 101
} http_version_t;
typedef enum {
HTTP_KEEPALIVE_OFF = 0,
HTTP_KEEPALIVE_ON = 1
} http_keepalive_t;
typedef enum {
HTTP_ENCODE_LENGTH = 0,
HTTP_ENCODE_CHUNKED = 1
} http_encoding_t;
typedef enum {
IPP_JOB_PENDING = 3,
IPP_JOB_HELD = 4,
IPP_JOB_PROCESSING = 5,
IPP_JOB_STOPPED = 6,
IPP_JOB_CANCELLED = 7,
IPP_JOB_ABORTED = 8,
IPP_JOB_COMPLETED = 9
} ipp_jstate_t;
typedef struct {
int id;
char *dest;
char *title;
char *user;
char *format;
ipp_jstate_t state;
int size;
int priority;
time_t completed_time;
time_t creation_time;
time_t processing_time;
} cups_job_t;
typedef enum {
IPP_OK = 0,
IPP_OK_SUBST = 1,
IPP_OK_CONFLICT = 2,
IPP_OK_IGNORED_SUBSCRIPTIONS = 3,
IPP_OK_IGNORED_NOTIFICATIONS = 4,
IPP_OK_TOO_MANY_EVENTS = 5,
IPP_OK_BUT_CANCEL_SUBSCRIPTION = 6,
IPP_REDIRECTION_OTHER_SITE = 768,
IPP_BAD_REQUEST = 1024,
IPP_FORBIDDEN = 1025,
IPP_NOT_AUTHENTICATED = 1026,
IPP_NOT_AUTHORIZED = 1027,
IPP_NOT_POSSIBLE = 1028,
IPP_TIMEOUT = 1029,
IPP_NOT_FOUND = 1030,
IPP_GONE = 1031,
IPP_REQUEST_ENTITY = 1032,
IPP_REQUEST_VALUE = 1033,
IPP_DOCUMENT_FORMAT = 1034,
IPP_ATTRIBUTES = 1035,
IPP_URI_SCHEME = 1036,
IPP_CHARSET = 1037,
IPP_CONFLICT = 1038,
IPP_COMPRESSION_NOT_SUPPORTED = 1039,
IPP_COMPRESSION_ERROR = 1040,
IPP_DOCUMENT_FORMAT_ERROR = 1041,
IPP_DOCUMENT_ACCESS_ERROR = 1042,
IPP_ATTRIBUTES_NOT_SETTABLE = 1043,
IPP_IGNORED_ALL_SUBSCRIPTIONS = 1044,
IPP_TOO_MANY_SUBSCRIPTIONS = 1045,
IPP_IGNORED_ALL_NOTIFICATIONS = 1046,
IPP_PRINT_SUPPORT_FILE_NOT_FOUND = 1047,
IPP_INTERNAL_ERROR = 1280,
IPP_OPERATION_NOT_SUPPORTED = 1281,
IPP_SERVICE_UNAVAILABLE = 1282,
IPP_VERSION_NOT_SUPPORTED = 1283,
IPP_DEVICE_ERROR = 1284,
IPP_TEMPORARY_ERROR = 1285,
IPP_NOT_ACCEPTING = 1286,
IPP_PRINTER_BUSY = 1287,
IPP_ERROR_JOB_CANCELLED = 1288,
IPP_MULTIPLE_JOBS_NOT_SUPPORTED = 1289,
IPP_PRINTER_IS_DEACTIVATED = 1290
} ipp_status_t;
typedef struct _http_s http_t;
extern int cupsAddDest(const char *name, const char *instance,
int num_dests, cups_dest_t * *dests);
extern int cupsAddOption(const char *name, const char *value,
int num_options, cups_option_t * *options);
extern int cupsCancelJob(const char *printer, int job);
extern http_encryption_t cupsEncryption(void);
extern void cupsFreeDests(int num_dests, cups_dest_t * dests);
extern void cupsFreeJobs(int num_jobs, cups_job_t * jobs);
extern void cupsFreeOptions(int num_options, cups_option_t * options);
extern const char *cupsGetDefault(void);
extern cups_dest_t *cupsGetDest(const char *name, const char *instance,
int num_dests, cups_dest_t * dests);
extern int cupsGetDests(cups_dest_t * *dests);
extern int cupsGetJobs(cups_job_t * *jobs, const char *dest, int myjobs,
int completed);
extern const char *cupsGetOption(const char *name, int num_options,
cups_option_t * options);
extern const char *cupsGetPPD(const char *printer);
extern const char *cupsGetPassword(const char *prompt);
extern char *cupsLangEncoding(cups_lang_t * lang);
extern void cupsLangFlush(void);
extern void cupsLangFree(cups_lang_t * lang);
extern cups_lang_t *cupsLangGet(const char *language);
extern ipp_status_t cupsLastError(void);
extern int cupsMarkOptions(ppd_file_t * ppd, int num_options,
cups_option_t * options);
extern int cupsParseOptions(const char *arg, int num_options,
cups_option_t * *options);
extern int cupsPrintFile(const char *printer, const char *filename,
const char *title, int num_options,
cups_option_t * options);
extern int cupsPrintFiles(const char *printer, int num_files,
const char **files, const char *title,
int num_options, cups_option_t * options);
extern const char *cupsServer(void);
extern void cupsSetDests(int num_dests, cups_dest_t * dests);
extern void cupsSetEncryption(http_encryption_t e);
extern void cupsSetPasswordCB(const char *(*cb) (const char *));
extern void cupsSetServer(const char *server);
extern void cupsSetUser(const char *user);
extern int cupsTempFd(char *filename, int len);
extern const char *cupsUser(void); |
#define _CUPS_PPD_H_
#define PPD_MAX_LINE 256
#define PPD_VERSION 4.3
#define PPD_MAX_NAME 41
#define PPD_MAX_TEXT 81
typedef enum {
PPD_CS_CMYK = -4,
PPD_CS_CMY = -3,
PPD_CS_GRAY = 1,
PPD_CS_RGB = 3,
PPD_CS_RGBK = 4,
PPD_CS_N = 5
} ppd_cs_t;
typedef struct {
char name[41];
char *start;
char *stop;
} ppd_emul_t;
typedef enum {
PPD_UI_BOOLEAN = 0,
PPD_UI_PICKONE = 1,
PPD_UI_PICKMANY = 2
} ppd_ui_t;
typedef enum {
PPD_ORDER_ANY = 0,
PPD_ORDER_DOCUMENT = 1,
PPD_ORDER_EXIT = 2,
PPD_ORDER_JCL = 3,
PPD_ORDER_PAGE = 4,
PPD_ORDER_PROLOG = 5
} ppd_section_t;
typedef struct {
char marked;
char choice[41];
char text[81];
char *code;
void *option;
} ppd_choice_t;
typedef struct {
char conflicted;
char keyword[41];
char defchoice[41];
char text[81];
ppd_ui_t ui;
ppd_section_t section;
float order;
int num_choices;
ppd_choice_t *choices;
} ppd_option_t;
typedef struct ppd_group_str {
char text[40];
char name[41];
int num_options;
ppd_option_t *options;
int num_subgroups;
struct ppd_group_str *subgroups;
} ppd_group_t;
typedef struct {
int marked;
char name[41];
float width;
float length;
float left;
float bottom;
float right;
float top;
} ppd_size_t;
typedef struct {
char option1[41];
char choice1[41];
char option2[41];
char choice2[41];
} ppd_const_t;
typedef struct {
char resolution[41];
char media_type[41];
float density;
float gamma;
float matrix[3][3];
} ppd_profile_t;
typedef struct {
char name[41];
char spec[41];
char text[81];
char *value;
} ppd_attr_t;
typedef struct {
int language_level;
int color_device;
int variable_sizes;
int accurate_screens;
int contone_only;
int landscape;
int model_number;
int manual_copies;
int throughput;
ppd_cs_t colorspace;
char *patches;
int num_emulations;
ppd_emul_t *emulations;
char *jcl_begin;
char *jcl_ps;
char *jcl_end;
char *lang_encoding;
char *lang_version;
char *modelname;
char *ttrasterizer;
char *manufacturer;
char *product;
char *nickname;
char *shortnickname;
int num_groups;
ppd_group_t *groups;
int num_sizes;
ppd_size_t *sizes;
float custom_min[2];
float custom_max[2];
float custom_margins[4];
int num_consts;
ppd_const_t *consts;
int num_fonts;
char **fonts;
int num_profiles;
ppd_profile_t *profiles;
int num_filters;
char **filters;
int flip_duplex;
char *protocols;
char *pcfilename;
int num_attrs;
int cur_attr;
ppd_attr_t **attrs;
} ppd_file_t;
typedef enum {
PPD_OK = 0,
PPD_FILE_OPEN_ERROR = 1,
PPD_NULL_FILE = 2,
PPD_ALLOC_ERROR = 3,
PPD_MISSING_PPDADOBE4 = 4,
PPD_MISSING_VALUE = 5,
PPD_INTERNAL_ERROR = 6,
PPD_BAD_OPEN_GROUP = 7,
PPD_NESTED_OPEN_GROUP = 8,
PPD_BAD_OPEN_UI = 9,
PPD_NESTED_OPEN_UI = 10,
PPD_BAD_ORDER_DEPENDENCY = 11,
PPD_BAD_UI_CONSTRAINTS = 12,
PPD_MISSING_ASTERISK = 13,
PPD_LINE_TOO_LONG = 14,
PPD_ILLEGAL_CHARACTER = 15,
PPD_ILLEGAL_MAIN_KEYWORD = 16,
PPD_ILLEGAL_OPTION_KEYWORD = 17,
PPD_ILLEGAL_TRANSLATION = 18,
PPD_ILLEGAL_WHITESPACE = 19
} ppd_status_t;
typedef enum {
PPD_CONFORM_RELAXED = 0,
PPD_CONFORM_STRICT = 1
} ppd_conform_t;
extern void ppdClose(ppd_file_t * ppd);
extern int ppdCollect(ppd_file_t * ppd, ppd_section_t section,
ppd_choice_t * **choices);
extern int ppdConflicts(ppd_file_t * ppd);
extern int ppdEmit(ppd_file_t * ppd, FILE * fp, ppd_section_t section);
extern int ppdEmitFd(ppd_file_t * ppd, int fd, ppd_section_t section);
extern int ppdEmitJCL(ppd_file_t * ppd, FILE * fp, int job_id,
const char *user, const char *title);
extern const char *ppdErrorString(ppd_status_t status);
extern ppd_attr_t *ppdFindAttr(ppd_file_t * ppd, const char *name,
const char *spec);
extern ppd_choice_t *ppdFindChoice(ppd_option_t * o, const char *option);
extern ppd_choice_t *ppdFindMarkedChoice(ppd_file_t * ppd,
const char *keyword);
extern ppd_attr_t *ppdFindNextAttr(ppd_file_t * ppd, const char *name,
const char *spec);
extern ppd_option_t *ppdFindOption(ppd_file_t * ppd, const char *keyword);
extern int ppdIsMarked(ppd_file_t * ppd, const char *keyword,
const char *option);
extern ppd_status_t ppdLastError(int *line);
extern void ppdMarkDefaults(ppd_file_t * ppd);
extern int ppdMarkOption(ppd_file_t * ppd, const char *keyword,
const char *option);
extern ppd_file_t *ppdOpen(FILE * fp);
extern ppd_file_t *ppdOpenFd(int fd);
extern ppd_file_t *ppdOpenFile(const char *filename);
extern float ppdPageLength(ppd_file_t * ppd, const char *name);
extern ppd_size_t *ppdPageSize(ppd_file_t * ppd, const char *name);
extern float ppdPageWidth(ppd_file_t * ppd, const char *name);
extern void ppdSetConformance(ppd_conform_t c); |
The interfaces defined on the following pages are included in libcups and are defined by this specification. Unless otherwise noted, these interfaces shall be included in the source standard.
Other interfaces listed in Section 7.1 shall behave as described in the referenced base document.
Add a destination to the list of destinations.
This function cannot be used to add a new class or printer queue, it only adds a new container of saved options for the named destination or instance.
If the named destination already exists, the destination list is returned unchanged. Adding a new instance of a destination creates a copy of that destination's options.
Use the cupsSaveDests() function to save the updated list of destinations to the user's lpoptions file.
Cancel a print job on the default server.
Use the cupsLastError() and cupsLastErrorString() functions to get the cause of any failure.
Get the default encryption settings.
The default encryption setting comes from the CUPS_ENCRYPTION environment variable, then the ~/.cupsrc file, and finally the /etc/cups/client.conf file. If not set, the default is HTTP_ENCRYPT_IF_REQUESTED.
Get the default printer or class for the default server.
This function returns the default printer or class as defined by the LPDEST or PRINTER environment variables. If these environment variables are not set, the server default destination is returned. Applications should use the cupsGetDests() and cupsGetDest() functions to get the user-defined default printer, as this function does not support the lpoptions-defined default printer.
Get the named destination from the list.
Use the cupsGetDests() or cupsGetDests2() functions to get a list of supported destinations for the current user.
Get the list of destinations from the default server.
Starting with CUPS 1.2, the returned list of destinations include the printer-info, printer-is-accepting-jobs, printer-is-shared, printer-make-and-model, printer-state, printer-state-change-time, printer-state-reasons, and printer-type attributes as options.
Use the cupsFreeDests() function to free the destination list and the cupsGetDest() function to find a particular destination.
Get the PPD file for a printer on the default server.
For classes, cupsGetPPD() returns the PPD file for the first printer in the class.
Get a password from the user.
Uses the current password callback function. Returns NULL if the user does not provide a password.
Parse options from a command-line argument.
This function converts space-delimited name/value pairs according to the PAPI text option ABNF specification. Collection values ("name={a=... b=... c=...}") are stored with the curley brackets intact - use cupsParseOptions() on the value to extract the collection attributes.
Return the hostname/address of the default server.
The returned value can be a fully-qualified hostname, a numeric IPv4 or IPv6 address, or a domain socket pathname.
Save the list of destinations for the default server.
This function saves the destinations to /etc/cups/lpoptions when run as root and ~/.cups/lpoptions when run as a normal user.
Set the password callback for CUPS.
Pass NULL to restore the default (console) password callback.
Set the default server name.
The "server" string can be a fully-qualified hostname, a numeric IPv4 or IPv6 address, or a domain socket pathname. Pass NULL to restore the default server name.
Creates a temporary file.
The temporary filename is returned in the filename buffer. The temporary file is opened for reading and writing.
Mark an option in a PPD file.
Notes:
-1 is returned if the given option would conflict with any currently selected option.
Table 7-3 defines the library name and shared object name for the libcupsimage library
The behavior of the interfaces in this library is specified by the following specifications:
| [LSB] This Specification |
An LSB conforming implementation shall provide the generic functions for CUPS Raster ABI specified in Table 7-4, with the full mandatory functionality as described in the referenced underlying specification.
This section defines global identifiers and their values that are associated with interfaces contained in libcupsimage. These definitions are organized into groups that correspond to system headers. This convention is used as a convenience for the reader, and does not imply the existence of these headers, or their content. Where an interface is defined as requiring a particular system header file all of the data definitions for that system header file presented here shall be in effect.
This section gives data definitions to promote binary application portability, not to repeat source interface definitions available elsewhere. System providers and application developers should use this ABI to supplement - not to replace - source interface definition specifications.
This specification uses the ISO C (1999) C Language as the reference programming language, and data definitions are specified in ISO C format. The C language is used here as a convenient notation. Using a C language description of these data objects does not preclude their use by other programming languages.
#define _CUPS_RASTER_H_
#define CUPS_RASTER_SYNC 0x52615374
#define CUPS_RASTER_REVSYNC 0x74536152
#define CUPS_RASTER_HAVE_COLORIMETRIC 1
typedef enum {
CUPS_RASTER_READ = 0,
CUPS_RASTER_WRITE = 1
} cups_mode_t;
typedef struct _cups_raster_s cups_raster_t;
typedef enum {
CUPS_ADVANCE_NONE = 0,
CUPS_ADVANCE_FILE = 1,
CUPS_ADVANCE_JOB = 2,
CUPS_ADVANCE_SET = 3,
CUPS_ADVANCE_PAGE = 4
} cups_adv_t;
typedef enum {
CUPS_FALSE = 0,
CUPS_TRUE = 1
} cups_bool_t;
typedef enum {
CUPS_CUT_NONE = 0,
CUPS_CUT_FILE = 1,
CUPS_CUT_JOB = 2,
CUPS_CUT_SET = 3,
CUPS_CUT_PAGE = 4
} cups_cut_t;
typedef enum {
CUPS_JOG_NONE = 0,
CUPS_JOG_FILE = 1,
CUPS_JOG_JOB = 2,
CUPS_JOG_SET = 3
} cups_jog_t;
typedef enum {
CUPS_EDGE_TOP = 0,
CUPS_EDGE_RIGHT = 1,
CUPS_EDGE_BOTTOM = 2,
CUPS_EDGE_LEFT = 3
} cups_edge_t;
typedef enum {
CUPS_ORIENT_0 = 0,
CUPS_ORIENT_90 = 1,
CUPS_ORIENT_180 = 2,
CUPS_ORIENT_270 = 3
} cups_orient_t;
typedef enum {
CUPS_ORDER_CHUNKED = 0,
CUPS_ORDER_BANDED = 1,
CUPS_ORDER_PLANAR = 2
} cups_order_t;
typedef enum {
CUPS_CSPACE_W = 0,
CUPS_CSPACE_RGB = 1,
CUPS_CSPACE_RGBA = 2,
CUPS_CSPACE_K = 3,
CUPS_CSPACE_CMY = 4,
CUPS_CSPACE_YMC = 5,
CUPS_CSPACE_CMYK = 6,
CUPS_CSPACE_YMCK = 7,
CUPS_CSPACE_KCMY = 8,
CUPS_CSPACE_KCMYcm = 9,
CUPS_CSPACE_GMCK = 10,
CUPS_CSPACE_GMCS = 11,
CUPS_CSPACE_WHITE = 12,
CUPS_CSPACE_GOLD = 13,
CUPS_CSPACE_SILVER = 14,
CUPS_CSPACE_CIEXYZ = 15,
CUPS_CSPACE_CIELab = 16,
CUPS_CSPACE_ICC1 = 32,
CUPS_CSPACE_ICC2 = 33,
CUPS_CSPACE_ICC3 = 34,
CUPS_CSPACE_ICC4 = 35,
CUPS_CSPACE_ICC5 = 36,
CUPS_CSPACE_ICC6 = 37,
CUPS_CSPACE_ICC7 = 38,
CUPS_CSPACE_ICC8 = 39,
CUPS_CSPACE_ICC9 = 40,
CUPS_CSPACE_ICCA = 41,
CUPS_CSPACE_ICCB = 42,
CUPS_CSPACE_ICCC = 43,
CUPS_CSPACE_ICCD = 44,
CUPS_CSPACE_ICCE = 45,
CUPS_CSPACE_ICCF = 46
} cups_cspace_t;
typedef struct {
char MediaClass[64];
char MediaColor[64];
char MediaType[64];
char OutputType[64];
unsigned int AdvanceDistance;
cups_adv_t AdvanceMedia;
cups_bool_t Collate;
cups_cut_t CutMedia;
cups_bool_t Duplex;
unsigned int HWResolution[2];
unsigned int ImagingBoundingBox[4];
cups_bool_t InsertSheet;
cups_jog_t Jog;
cups_edge_t LeadingEdge;
unsigned int Margins[2];
cups_bool_t ManualFeed;
unsigned int MediaPosition;
unsigned int MediaWeight;
cups_bool_t MirrorPrint;
cups_bool_t NegativePrint;
unsigned int NumCopies;
cups_orient_t Orientation;
cups_bool_t OutputFaceUp;
unsigned int PageSize[2];
cups_bool_t Separations;
cups_bool_t TraySwitch;
cups_bool_t Tumble;
unsigned int cupsWidth;
unsigned int cupsHeight;
unsigned int cupsMediaType;
unsigned int cupsBitsPerColor;
unsigned int cupsBitsPerPixel;
unsigned int cupsBytesPerLine;
cups_order_t cupsColorOrder;
cups_cspace_t cupsColorSpace;
unsigned int cupsCompression;
unsigned int cupsRowCount;
unsigned int cupsRowFeed;
unsigned int cupsRowStep;
} cups_page_header_t;
extern void cupsRasterClose(cups_raster_t * r);
extern cups_raster_t *cupsRasterOpen(int fd, cups_mode_t mode);
extern unsigned int cupsRasterReadHeader(cups_raster_t * r,
cups_page_header_t * h);
extern unsigned int cupsRasterReadPixels(cups_raster_t * r,
unsigned char *p,
unsigned int len);
extern unsigned int cupsRasterWriteHeader(cups_raster_t * r,
cups_page_header_t * h);
extern unsigned int cupsRasterWritePixels(cups_raster_t * r,
unsigned char *p,
unsigned int len); |
The interfaces defined on the following pages are included in libcupsimage and are defined by this specification. Unless otherwise noted, these interfaces shall be included in the source standard.
Other interfaces listed in Section 7.4 shall behave as described in the referenced base document.
An LSB conforming implementation shall provide the commands and utilities as described in Table 8-1, with at least the behavior described as mandatory in the referenced underlying specification, with the following exceptions:
If any operand (except one which follows --) starts with a
hyphen, the behavior is unspecified.
Rationale (Informative): Applications should place options before operands, or use
--, as needed. This text is needed because, by default, GNU option parsing differs from POSIX, unless the environment variablePOSIXLY_CORRECTis set. For example, ls . -a in GNU ls means to list the current directory, showing all files (that is,"."is an operand and-ais an option). In POSIX,"."and-aare both operands, and the command means to list the current directory, and also the file named -a. Suggesting that applications rely on the setting of thePOSIXLY_CORRECTenvironment variable, or try to set it, seems worse than just asking the applications to invoke commands in ways which work with either the POSIX or GNU behaviors.
Referenced Specification(s)
[1]. This Specification
This section contains descriptions for commands and utilities whose specified behavior in the LSB contradicts or extends the standards referenced. It also contains commands and utilities only required by the LSB and not specified by other standards.
foomatic-rip is a universal print filter which works with every known free software printer spooler.
This page describes the facilities of foomatic-rip when used as a CUPS filter and when used outside of a print system. While implementations of foomatic-rip may support other print systems, such use is not documented here.
When run as a CUPS filter, foomatic-rip reads the job from the specified file, or from standard input if no file is specified. It renders the file into a printer-specific format, and writes the result to standard output.
When run standalone, foomatic-rip will read the job from the specified files, or from standard input if no files are given. The files are rendered into a printer-specific format, which is then output according to the PPD option "FoomaticRIPPostPipe", documented in the LSB.
Printer capabilities are described to foomatic-rip via PPD files, as described (with extensions used by foomatic-rip) in the LSB. The method foomatic-rip uses to determine the proper PPD file for the printer in question is defined by the implementation of both the spooler and foomatic-rip.
Unless otherwise noted, all parameters are required when running foomatic-rip as a CUPS filter.
Till Kamppeter <till.kamppeter@gmail.com> with parts of Manfred Wassmanns's <manolo@NCC-1701.B.Shuttle.de> man pages for the Foomatic 2.0.x filters.
Jeff Licquia <licquia@linux-foundation.org> adapted the original man page for the LSB.
The gs command invokes Ghostscript, an interpreter of Adobe Systems' PostScript(tm) and Portable Document Format (PDF) languages. gs reads the files named by ps-file in sequence and executes them as Ghostscript programs. After doing this, it reads further input from the standard input stream (normally the keyboard), interpreting each line separately. The interpreter exits gracefully when it encounters the "quit" command (either in a file or from the keyboard), at end-of-file, or at an interrupt signal (such as Control-C at the keyboard).
Some of GhostScript's options are set via command-line options; others are set as processing parameters, each of which consists of a name and a value.
Processing parameters may have arbitrary names; no limits are placed on the settings that may be made. However, certain settings have meaning to the gs interpreter, and drivers may use other settings. Below is a list of recognized settings that the gs interpreter must respect.
In addition to the requirements for /usr/share in the Filesystem Hierarchy Standard, an LSB conforming system shall also provide the following directories or symbolic links to directories:
| /usr/share/ppd | ppd files |