Linux Standard Base Printing Specification 4.1

Linux Standard Base

#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_s {
    struct cups_lang_s *next;
    int used;
    cups_encoding_t encoding;
    char language[16];
    cups_array_t *strings;
} 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 struct _cups_array_s cups_array_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 int cupsDoAuthentication(http_t * http, const char *method,
				const char *resource);
extern ipp_t *cupsDoFileRequest(http_t * http, ipp_t * request,
				const char *resource,
				const char *filename);
extern void cupsEncodeOptions(ipp_t * ipp, int num_options,
			      cups_option_t * options);
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 const char *cupsGetDefault2(http_t * http);
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 cupsGetDests2(http_t * http, cups_dest_t * *dests);
extern http_status_t cupsGetFd(http_t * http, const char *resource,
			       int fd);
extern http_status_t cupsGetFile(http_t * http, const char *resource,
				 const char *filename);
extern int cupsGetJobs(cups_job_t * *jobs, const char *dest, int myjobs,
		       int completed);
extern int cupsGetJobs2(http_t * http, 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 *cupsGetPPD2(http_t * http, const char *printer);
extern const char *cupsGetPassword(const char *prompt);
extern const 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 cupsPrintFile2(http_t * http, 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 int cupsPrintFiles2(http_t * http, const char *printer,
			   int num_files, const char **files,
			   const char *title, int num_options,
			   cups_option_t * options);
extern http_status_t cupsPutFd(http_t * http, const char *resource,
			       int fd);
extern http_status_t cupsPutFile(http_t * http, const char *resource,
				 const char *filename);
extern const char *cupsServer(void);
extern void cupsSetDests(int num_dests, cups_dest_t * dests);
extern int cupsSetDests2(http_t * http, 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);

Name	Title	URL
CUPS API Reference	CUPS 1.2 API Reference	http://www.cups.org/documentation.php/doc-1.2/
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

Library	Runtime Name
libcups	libcups.so.2
libcupsimage	libcupsimage.so.2

`function()`		the name of a function
command		the name of a command or utility
`CONSTANT`		a constant value
`parameter`		a parameter
`variable`		a variable

name		the name of the interface
(symver)		An optional symbol version identifier, if required.
[`refno`]		A reference number indexing the table of referenced specifications that follows this table.

Library:	libcups
SONAME:	libcups.so.2

cupsAddDest [LSB]	cupsAddOption [LSB]	cupsCancelJob [LSB]	cupsDoAuthentication [CUPS 1.2]
cupsDoFileRequest [CUPS 1.2]	cupsEncodeOptions [CUPS 1.2]	cupsEncryption [LSB]	cupsFreeDests [LSB]
cupsFreeJobs [LSB]	cupsFreeOptions [LSB]	cupsGetDefault [LSB]	cupsGetDefault2 [CUPS 1.2]
cupsGetDest [LSB]	cupsGetDests [LSB]	cupsGetDests2 [CUPS 1.2]	cupsGetFd [CUPS 1.2]
cupsGetFile [CUPS 1.2]	cupsGetJobs [LSB]	cupsGetJobs2 [CUPS 1.2]	cupsGetOption [LSB]
cupsGetPPD [LSB]	cupsGetPPD2 [CUPS 1.2]	cupsGetPassword [LSB]	cupsLangEncoding [LSB]
cupsLangFlush [LSB]	cupsLangFree [LSB]	cupsLangGet [LSB]	cupsLastError [LSB]
cupsMarkOptions [LSB]	cupsParseOptions [LSB]	cupsPrintFile [LSB]	cupsPrintFile2 [CUPS 1.2]
cupsPrintFiles [LSB]	cupsPrintFiles2 [CUPS 1.2]	cupsPutFd [CUPS 1.2]	cupsPutFile [CUPS 1.2]
cupsServer [LSB]	cupsSetDests [LSB]	cupsSetDests2 [CUPS 1.2]	cupsSetEncryption [LSB]
cupsSetPasswordCB [LSB]	cupsSetServer [LSB]	cupsSetUser [LSB]	cupsTempFd [LSB]
cupsUser [LSB]	httpBlocking [CUPS 1.2]	httpCheck [CUPS 1.2]	httpClearCookie [CUPS 1.2]
httpClearFields [CUPS 1.2]	httpClose [CUPS 1.2]	httpConnect [CUPS 1.2]	httpConnectEncrypt [CUPS 1.2]
httpDecode64_2 [CUPS 1.2]	httpDelete [CUPS 1.2]	httpEncode64_2 [CUPS 1.2]	httpEncryption [CUPS 1.2]
httpError [CUPS 1.2]	httpFlush [CUPS 1.2]	httpGet [CUPS 1.2]	httpGetCookie [CUPS 1.2]
httpGetDateString [CUPS 1.2]	httpGetDateTime [CUPS 1.2]	httpGetField [CUPS 1.2]	httpGetHostByName [CUPS 1.2]
httpGetSubField [CUPS 1.2]	httpGets [CUPS 1.2]	httpHead [CUPS 1.2]	httpInitialize [CUPS 1.2]
httpMD5 [CUPS 1.2]	httpMD5Final [CUPS 1.2]	httpMD5String [CUPS 1.2]	httpOptions [CUPS 1.2]
httpPost [CUPS 1.2]	httpPut [CUPS 1.2]	httpReconnect [CUPS 1.2]	httpSetCookie [CUPS 1.2]
httpSetField [CUPS 1.2]	httpStatus [CUPS 1.2]	httpTrace [CUPS 1.2]	httpUpdate [CUPS 1.2]
httpWait [CUPS 1.2]	ippAddBoolean [CUPS 1.2]	ippAddBooleans [CUPS 1.2]	ippAddCollection [CUPS 1.2]
ippAddCollections [CUPS 1.2]	ippAddDate [CUPS 1.2]	ippAddInteger [CUPS 1.2]	ippAddIntegers [CUPS 1.2]
ippAddRange [CUPS 1.2]	ippAddRanges [CUPS 1.2]	ippAddResolution [CUPS 1.2]	ippAddResolutions [CUPS 1.2]
ippAddSeparator [CUPS 1.2]	ippAddString [CUPS 1.2]	ippAddStrings [CUPS 1.2]	ippDateToTime [CUPS 1.2]
ippDelete [CUPS 1.2]	ippDeleteAttribute [CUPS 1.2]	ippErrorString [CUPS 1.2]	ippFindAttribute [CUPS 1.2]
ippFindNextAttribute [CUPS 1.2]	ippLength [CUPS 1.2]	ippNew [CUPS 1.2]	ippPort [CUPS 1.2]
ippRead [CUPS 1.2]	ippReadFile [CUPS 1.2]	ippSetPort [CUPS 1.2]	ippTimeToDate [CUPS 1.2]
ippWrite [CUPS 1.2]	ippWriteFile [CUPS 1.2]	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]

cupsRasterClose [LSB]	cupsRasterOpen [LSB]	cupsRasterReadHeader [LSB]	cupsRasterReadPixels [LSB]
cupsRasterWriteHeader [LSB]	cupsRasterWritePixels [LSB]

`jobid`		The internal Job ID from CUPS.
`username`		The username of the user who submitted the job.
`jobtitle`		The job's title, as submitted by the user.
`numcopies`		The number of copies of the job requested.
`options`		A series of printer options, separated by spaces, each of which take the form `name` or `name=value`. The specific list of options supported is dependent on the printer and spooler, and is usually documented in the PPD file for the printer. An option may be preceded by a page specification, describing the pages to which the option should apply. A page specification consists of one or more items, separated by commas, and separated from the option name by a colon. Valid items include the words "even" and "odd", a single page number, and a page range. Page ranges are described with a starting page, a dash ("-"), and an ending page. If omitted, the starting and ending pages are the first and last page, respectively, but only one of the ends of the range may be omitted.
`file`		The full path to the file containing the job. This parameter is optional; if it is not supplied, the job is read from standard input.

`-v`		Verbose mode. Intended for debugging and testing purposes only.
`-q`		Quiet mode - minimal information output.
`-d`		Identical to the 'opts' option, but option information is left in text format. The PPD file will need to be specified using the --ppd option.
`--ppd` `ppdfile`		The PPD file `ppdfile` should be applied for processing this job.
`-J` `jobtitle`		Print the given job title in the header of every page of a plain text job.
`-o` `option=value`		Set an option setting for this job.

`-h --help`		Show GhostScript's help, as well as lists of the supported input formats, supported devices, and the search path for gs components.
`-q`		Suppress normal startup messages, and also set the processing parameter QUIET.
`-c`		Begin interpreting arguments as PostScript code. All following arguments are sent to the interpreter up to the next argument beginning with "-" followed by a non-digit, or with "@". This code is interpolated with the file list, so files specified before `-c` are interpreted beforehand, and files after `-c` are interpreted afterwards.
`-f`		Specifies a PostScript file to run as its argument. This is equivalent to the ps-file arguments, but is useful for terminating PostScript code as passed via `-c`.
`-d -D`		Set a processing parameter. The "name=value" pair follows immediately after the option, as in "-Dfoo=bar". The values here must be integers or the values "true" or "false". The equals sign and value may be omitted; this is assumed to set the name to "true".
`-s -S`		Set a processing parameter to a string value. The "name=value" pair follows immediately after the option, as in "-Sfoo=bar".
`-u`		Unset a processing parameter. The name to be unset follows immediately after the option, as in "-ufoo".
`-o`		Write rendered output to the named file, and also inhibit pauses and the interactive shell. This is equivalent to setting the processing parameters BATCH and NOPAUSE to true, and OutputFile to the parameter after -o.
`-r`		Set the device resolution. The resolution is specified as two numbers separated with an "x", as in "300x150", corresponding to the X and Y axis resolutions, respectively. If a single number is given without an "x", it is treated as the value for both resolutions. This is equivalent to setting DEVICEXRESOLUTION and DEVICEYRESOLUTION in systemdict.
`-g`		Set the device size, in pixels. The size is specified as two numbers separated with an "x", as in "640x480", corresponding to the width and height, respectively. This is equivalent to setting DEVICEWIDTH and DEVICEHEIGHT in systemdict.

`BATCH`		If set to true, do not enter an interactive shell after processing all command-line files.
`DEVICE`		Contains the name of the device used to render the page, as a string. The list of available devices can be discovered with the -h parameter, as described above. At least the following devices must be present: cups (CUPS Raster), ijs, pxlmono, pxlcolor, and opvp (OpenPrinting Vector).
`DEVICEHEIGHT`		Contains the height, in pixels, of the output device. The effect of this setting when the current driver is a vector driver is undefined.
`DEVICEHEIGHTPOINTS`		Sets the initial page height, in units of 1/72 of an inch.
`DEVICEWIDTH`		Contains the width, in pixels, of the output device. The effect of this setting when the current driver is a vector driver is undefined.
`DEVICEWIDTHPOINTS`		Sets the initial page width, in units of 1/72 of an inch.
`DEVICEXRESOLUTION`		Contains the resolution, in pixels per inch, of the X dimension (horizontal) of the output device.
`DEVICEYRESOLUTION`		Contains the resolution, in pixels per inch, of the Y dimension (vertical) of the output device.
`NOPAUSE`		If set to true, disable the prompt and pause normally displayed after rendering a page.
`OutputFile`		Contains the path to the file to which gs should write its output, as a string. This parameter may be set to '-', in which case gs's output is sent to standard output.
`PAPERSIZE`		Contains the string representation of the paper size. The ISO paper sizes a0-a10 (plus a4small), isob0-isob6, and c0-c6 are recognized, as are jisb0-jisb6 (JIS standard sizes) and the US paper sizes 11x17, ledger, legal, letter, lettersmall, and archA-archE.
`QUIET`		If set to true, suppress routine information comments on standard output.
`SAFER`		If set to true, disable several unsafe PostScript features: the deletefile and renamefile operators, piped commands, reading or writing to general files, and changing of certain system settings.
`STRICT`		If set to true, disable as many extensions to the Adobe PostScript specification as possible.

Foreword

Status of this Document

Introduction

I. Introductory Elements

Chapter 1. Scope

Chapter 2. Normative References

Chapter 3. Requirements

Chapter 4. Terms and Definitions

Chapter 5. Documentation Conventions

Chapter 6. PPD Format Extensions

II. LSB Printing Libraries

Chapter 7. Libraries

cupsAddDest

Name

Synopsis

Description

Return Value

cupsAddOption

Name

Synopsis

Description

Return Value

cupsCancelJob

Name

Synopsis

Description

Return Value

cupsEncryption

Name

Synopsis

Description

Return Value

cupsFreeDests

Name

Synopsis

Description

Return Value

cupsFreeJobs

Name

Synopsis

Description

Return Value

cupsFreeOptions

Name

Synopsis

Description

Return Value

cupsGetDefault

Name

Synopsis

Description

Return Value

cupsGetDest

Name

Synopsis

Description

Return Value

cupsGetDests

Name

Synopsis

Description

Return Value

cupsGetJobs

Name

Synopsis

Description

Return Value

cupsGetOption

Name

Synopsis

Description

Return Value

cupsGetPPD

Name

Synopsis

Description

Return Value

cupsGetPassword

Name

Synopsis