From 718ee2fff3cfeedf69dedf4ca68b14e2f49ff8c6 Mon Sep 17 00:00:00 2001 From: Michael Sweet Date: Wed, 7 Jun 2017 16:16:05 -0400 Subject: Save work on CUPS Programming Manual. --- doc/help/api-raster.html | 5 +- doc/help/cupspm.epub | Bin 221280 -> 218052 bytes doc/help/cupspm.html | 716 +++++------------------------------------------ 3 files changed, 66 insertions(+), 655 deletions(-) (limited to 'doc') diff --git a/doc/help/api-raster.html b/doc/help/api-raster.html index 54b88d1dc..f3d7253f0 100644 --- a/doc/help/api-raster.html +++ b/doc/help/api-raster.html @@ -605,7 +605,7 @@ the memory used to read the raster file:

Functions

cupsRasterClose

-

Close a raster stream.

+

void cupsRasterClose (
    cups_raster_t *r
@@ -615,7 +615,8 @@ void cupsRasterClose (

r
Stream to close
-

Discussion

+

Return Value

+

Close a raster stream.

The file descriptor associated with the raster stream must be closed separately as needed.

 CUPS 2.2/macOS 10.12 cupsRasterInitPWGHeader

diff --git a/doc/help/cupspm.epub b/doc/help/cupspm.epub index 48ec695cb..51f7600fc 100644 Binary files a/doc/help/cupspm.epub and b/doc/help/cupspm.epub differ diff --git a/doc/help/cupspm.html b/doc/help/cupspm.html index 531713057..17aeb9ad4 100644 --- a/doc/help/cupspm.html +++ b/doc/help/cupspm.html @@ -438,19 +438,12 @@ h3.title {
  • ippWrite
  • ippWriteFile
  • ippWriteIO
  • -
  • pwgFormatSizeName
  • -
  • pwgInitSize
  • -
  • pwgMediaForLegacy
  • -
  • pwgMediaForPPD
  • -
  • pwgMediaForPWG
  • -
  • pwgMediaForSize
  • Data Types
  • Structures
  • Enumerations

    The callback function returns 0 to stop enumeration or 1 to continue.

    +
    +

    Note that the callback function will likely be called multiple times for the same destination, so it is up to the caller to suppress any duplicate destinations.

    +

    The following example shows how to use cupsEnumDests to get a filtered array of destinations:

    typedef struct
     {
    @@ -1507,7 +1483,10 @@ printers.  The constant CUPS_PRINTER_DISCOVERED is used to filter o
     destinations that are available but have not yet been added locally.

    Enumeration happens on the current thread and does not return until all -destinations have been enumerated or the callback function returns 0. +destinations have been enumerated or the callback function returns 0.
    +
    +Note: The callback function will likely receive multiple updates for the same +destinations - it is up to the caller to suppress any duplicate destinations.

     CUPS 1.7/macOS 10.9 cupsFindDestDefault

    @@ -6799,173 +6778,6 @@ to a human-readable message on failure.

    Return Value

    Current state

    -

     CUPS 1.7/macOS 10.9 pwgFormatSizeName

    -

    Generate a PWG self-describing media size name.

    -

    -int pwgFormatSizeName (
    -    char *keyword,
    -    size_t keysize,
    -    const char *prefix,
    -    const char *name,
    -    int width,
    -    int length,
    -    const char *units
    -);

    -

    Parameters

    -
    -
    keyword
    -
    Keyword buffer
    -
    keysize
    -
    Size of keyword buffer
    -
    prefix
    -
    Prefix for PWG size or NULL for automatic
    -
    name
    -
    Size name or NULL
    -
    width
    -
    Width of page in 2540ths
    -
    length
    -
    Length of page in 2540ths
    -
    units
    -
    Units - "in", "mm", or NULL for automatic
    -
    -

    Return Value

    -

    1 on success, 0 on failure

    -

    Discussion

    -

    This function generates a PWG self-describing media size name of the form -"prefix_name_WIDTHxLENGTHunits". The prefix is typically "custom" or "roll" -for user-supplied sizes but can also be "disc", "iso", "jis", "jpn", "na", -"oe", "om", "prc", or "roc". A value of NULL automatically chooses -"oe" or "om" depending on the units.
    -
    -The size name may only contain lowercase letters, numbers, "-", and ".". If -NULL is passed, the size name will contain the formatted dimensions.
    -
    -The width and length are specified in hundredths of millimeters, equivalent -to 1/100000th of a meter or 1/2540th of an inch. The width, length, and -units used for the generated size name are calculated automatically if the -units string is NULL, otherwise inches ("in") or millimeters ("mm") -are used. - -

    -

     CUPS 1.7/macOS 10.9 pwgInitSize

    -

    Initialize a pwg_size_t structure using IPP Job Template -attributes.

    -

    -int pwgInitSize (
    -    pwg_size_t *size,
    -    ipp_t *job,
    -    int *margins_set
    -);

    -

    Parameters

    -
    -
    size
    -
    Size to initialize
    -
    job
    -
    Job template attributes
    -
    margins_set
    -
    1 if margins were set, 0 otherwise
    -
    -

    Return Value

    -

    1 if size was initialized, 0 otherwise

    -

    Discussion

    -

    This function initializes a pwg_size_t structure from an IPP "media" or -"media-col" attribute in the specified IPP message. 0 is returned if neither -attribute is found in the message or the values are not valid.
    -
    -The "margins_set" variable is initialized to 1 if any "media-xxx-margin" -member attribute was specified in the "media-col" Job Template attribute, -otherwise it is initialized to 0. - -

    -

     CUPS 1.7/macOS 10.9 pwgMediaForLegacy

    -

    Find a PWG media size by ISO/IPP legacy name.

    -

    -pwg_media_t *pwgMediaForLegacy (
    -    const char *legacy
    -);

    -

    Parameters

    -
    -
    legacy
    -
    Legacy size name
    -
    -

    Return Value

    -

    Matching size or NULL

    -

    Discussion

    -

    The "name" argument specifies the legacy ISO media size name, for example -"iso-a4" or "na-letter". - -

    -

     CUPS 1.7/macOS 10.9 pwgMediaForPPD

    -

    Find a PWG media size by Adobe PPD name.

    -

    -pwg_media_t *pwgMediaForPPD (
    -    const char *ppd
    -);

    -

    Parameters

    -
    -
    ppd
    -
    PPD size name
    -
    -

    Return Value

    -

    Matching size or NULL

    -

    Discussion

    -

    The "ppd" argument specifies an Adobe page size name as defined in Table B.1 -of the Adobe PostScript Printer Description File Format Specification Version -4.3.
    -
    -If the name is non-standard, the returned PWG media size is stored in -thread-local storage and is overwritten by each call to the function in the -thread. Custom names can be of the form "Custom.WIDTHxLENGTH[units]" or -"WIDTHxLENGTH[units]". - -

    -

     CUPS 1.7/macOS 10.9 pwgMediaForPWG

    -

    Find a PWG media size by 5101.1 self-describing name.

    -

    -pwg_media_t *pwgMediaForPWG (
    -    const char *pwg
    -);

    -

    Parameters

    -
    -
    pwg
    -
    PWG size name
    -
    -

    Return Value

    -

    Matching size or NULL

    -

    Discussion

    -

    The "pwg" argument specifies a self-describing media size name of the form -"prefix_name_WIDTHxLENGTHunits" as defined in PWG 5101.1.
    -
    -If the name is non-standard, the returned PWG media size is stored in -thread-local storage and is overwritten by each call to the function in the -thread. - -

    -

     CUPS 1.7/macOS 10.9 pwgMediaForSize

    -

    Get the PWG media size for the given dimensions.

    -

    -pwg_media_t *pwgMediaForSize (
    -    int width,
    -    int length
    -);

    -

    Parameters

    -
    -
    width
    -
    Width in hundredths of millimeters
    -
    length
    -
    Length in hundredths of millimeters
    -
    -

    Return Value

    -

    PWG media name

    -

    Discussion

    -

    The "width" and "length" are in hundredths of millimeters, equivalent to -1/100000th of a meter or 1/2540th of an inch.
    -
    -If the dimensions are non-standard, the returned PWG media size is stored in -thread-local storage and is overwritten by each call to the function in the -thread. - -

    Data Types

     CUPS 1.5/macOS 10.7 cups_client_cert_cb_t

    Client credentials callback @@ -6989,11 +6801,6 @@ typedef struct cups_dest_s cups_dest_t; information

    typedef struct _cups_dinfo_s cups_dinfo_t; -

    -

    cups_encoding_t

    -

    Language Encodings

    -

    -typedef enum cups_encoding_e cups_encoding_t;

    cups_job_t

    Job

    @@ -7039,24 +6846,6 @@ address types easier and more portable.

    typedef union _http_addr_u / http_addr_t; -

    -

     CUPS 1.2/macOS 10.5 http_addrlist_t

    -

    Socket address list, which is -used to enumerate all of the -addresses that are associated -with a hostname.

    -

    -typedef struct http_addrlist_s / http_addrlist_t; -

    -

    http_auth_t

    -

    HTTP authentication types

    -

    -typedef enum http_auth_e http_auth_t; -

    -

     CUPS 1.5/macOS 10.7 http_credential_t

    -

    HTTP credential data

    -

    -typedef struct http_credential_s http_credential_t;

    http_encoding_t

    HTTP transfer encoding values

    @@ -7108,11 +6897,6 @@ typedef enum http_uri_coding_e http_uri_coding_

    URI separation status

    typedef enum http_uri_status_e http_uri_status_t; -

    -

    http_version_t

    -

    HTTP version numbers

    -

    -typedef enum http_version_e http_version_t;

    ipp_attribute_t

    IPP attribute

    @@ -7125,26 +6909,11 @@ Please use the new accessor functions available in CUPS 1.6 and later, as these definitions will be moved to a private header file in a future release.

    typedef int(*)(void *context, ipp_t *dst, ipp_attribute_t *attr)ipp_copycb_t; -

    -

    ipp_dstate_t

    -

    Document states

    -

    -typedef enum ipp_dstate_e ipp_dstate_t; -

    -

    ipp_finish_t

    -

    Job collation types

    -

    -typedef enum ipp_finishings_e ipp_finish_t;

     CUPS 1.2/macOS 10.5 ipp_iocb_t

    IPP IO Callback Function

    typedef ssize_t(*)(void *context, ipp_uchar_t *buffer, size_t bytes) ipp_iocb_t; -

    -

    ipp_jcollate_t

    -

    Job collation types

    -

    -typedef enum ipp_jcollate_e ipp_jcollate_t;

    ipp_orient_t

    Orientation values

    @@ -7180,21 +6949,6 @@ typedef struct _ipp_s ipp_t;

    Unsigned 8-bit integer/character

    typedef unsigned char ipp_uchar_t; -

    -

    pwg_map_t

    -

    Map element - PPD to/from PWG

    -

    -typedef struct pwg_map_s pwg_map_t; -

    -

    pwg_media_t

    -

    Common media size data

    -

    -typedef struct pwg_media_s pwg_media_t; -

    -

    pwg_size_t

    -

    Size element - PPD to/from PWG

    -

    -typedef struct pwg_size_s pwg_size_t;

    Structures

    cups_dest_s

    @@ -7301,165 +7055,13 @@ typedef struct pwg_size_s pwg_size_t;
    top
    Top margin in hundredths of millimeters
    - -

     CUPS 1.2/macOS 10.5 http_addrlist_s

    -

    Socket address list, which is -used to enumerate all of the -addresses that are associated -with a hostname.

    -

    struct http_addrlist_s {
    -    http_addr_t addr;
    -    struct http_addrlist_s *next;
    -};

    -

    Members

    -
    -
    addr
    -
    Address
    -
    next
    -
    Pointer to next address in list
    -
    -

     CUPS 1.5/macOS 10.7 http_credential_s

    -

    HTTP credential data

    -

    struct http_credential_s {
    -    void *data;
    -    size_t datalen;
    -};

    -

    Members

    -
    -
    data
    -
    Pointer to credential data
    -
    datalen
    -
    Credential length
    -
    -

    pwg_map_s

    -

    Map element - PPD to/from PWG

    -

    struct pwg_map_s {
    -    char *pwg, *ppd;
    -};

    -

    Members

    -
    -
    ppd
    -
    PPD option keyword
    -
    -

    pwg_media_s

    -

    Common media size data

    -

    struct pwg_media_s {
    -    int width, length;
    -    const char *pwg, *legacy, *ppd;
    -};

    -

    Members

    -
    -
    length
    -
    Length in 2540ths
    -
    ppd
    -
    Standard Adobe PPD name
    -
    -

    pwg_size_s

    -

    Size element - PPD to/from PWG

    -

    struct pwg_size_s {
    -    pwg_map_t map;
    -    int width, length, left, bottom, right, top;
    -};

    -

    Members

    -
    -
    map
    -
    Map element
    -
    top
    -
    Top margin in 2540ths

    Constants

    -

    cups_encoding_e

    -

    Language Encodings

    -

    Constants

    -
    -
    CUPS_EUC_CN
    -
    EUC Simplified Chinese
    -
    CUPS_EUC_JP
    -
    EUC Japanese
    -
    CUPS_EUC_KR
    -
    EUC Korean
    -
    CUPS_EUC_TW
    -
    EUC Traditional Chinese
    -
    CUPS_ISO8859_1
    -
    ISO-8859-1
    -
    CUPS_ISO8859_10
    -
    ISO-8859-10
    -
    CUPS_ISO8859_11
    -
    ISO-8859-11
    -
    CUPS_ISO8859_13
    -
    ISO-8859-13
    -
    CUPS_ISO8859_14
    -
    ISO-8859-14
    -
    CUPS_ISO8859_15
    -
    ISO-8859-15
    -
    CUPS_ISO8859_16
    -
    ISO-8859-16
    -
    CUPS_ISO8859_2
    -
    ISO-8859-2
    -
    CUPS_ISO8859_3
    -
    ISO-8859-3
    -
    CUPS_ISO8859_4
    -
    ISO-8859-4
    -
    CUPS_ISO8859_5
    -
    ISO-8859-5
    -
    CUPS_ISO8859_6
    -
    ISO-8859-6
    -
    CUPS_ISO8859_7
    -
    ISO-8859-7
    -
    CUPS_ISO8859_8
    -
    ISO-8859-8
    -
    CUPS_ISO8859_9
    -
    ISO-8859-9
    -
    CUPS_JIS_X0213
    -
    JIS X0213 aka Shift JIS
    -
    CUPS_KOI8_R
    -
    KOI-8-R
    -
    CUPS_KOI8_U
    -
    KOI-8-U
    -
    CUPS_MAC_ROMAN
    -
    MacRoman
    -
    CUPS_US_ASCII
    -
    US ASCII
    -
    CUPS_UTF8
    -
    UTF-8
    -
    CUPS_WINDOWS_1250
    -
    CP-1250
    -
    CUPS_WINDOWS_1251
    -
    CP-1251
    -
    CUPS_WINDOWS_1252
    -
    CP-1252
    -
    CUPS_WINDOWS_1253
    -
    CP-1253
    -
    CUPS_WINDOWS_1254
    -
    CP-1254
    -
    CUPS_WINDOWS_1255
    -
    CP-1255
    -
    CUPS_WINDOWS_1256
    -
    CP-1256
    -
    CUPS_WINDOWS_1257
    -
    CP-1257
    -
    CUPS_WINDOWS_1258
    -
    CP-1258
    -
    CUPS_WINDOWS_1361
    -
    Korean Johab
    -
    CUPS_WINDOWS_874
    -
    CP-874
    -
    CUPS_WINDOWS_932
    -
    Japanese JIS X0208-1990
    -
    CUPS_WINDOWS_936
    -
    Simplified Chinese GB 2312-80
    -
    CUPS_WINDOWS_949
    -
    Korean KS C5601-1992
    -
    CUPS_WINDOWS_950
    -
    Traditional Chinese Big Five
    -

    cups_ptype_e

    Printer type/capability bit constants

    Constants

    -
    CUPS_PRINTER_3D  DEPRECATED 
    -
    Printer with 3D capabilities
    CUPS_PRINTER_AUTHENTICATED  CUPS 1.2/macOS 10.5 
    Printer requires authentication
    @@ -7482,9 +7084,6 @@ constants

    Can cover output
    CUPS_PRINTER_DEFAULT
    Default printer on network
    -
    CUPS_PRINTER_DELETE  DEPRECATED 
    -
    Delete printer -
    CUPS_PRINTER_DISCOVERED  CUPS 1.2/macOS 10.5 
    Printer was discovered
    CUPS_PRINTER_DUPLEX
    @@ -7497,9 +7096,6 @@ constants

    Local printer or class
    CUPS_PRINTER_MEDIUM
    Can print on Tabloid/B/C/A3/A2-size media
    -
    CUPS_PRINTER_MFP  CUPS 1.4/macOS 10.6 
    -
    Printer with scanning capabilities -
    CUPS_PRINTER_NOT_SHARED  CUPS 1.2/macOS 10.5 
    Printer is not shared
    @@ -7509,9 +7105,6 @@ constants

    Printer is rejecting jobs
    CUPS_PRINTER_REMOTE
    Remote printer or class
    -
    CUPS_PRINTER_SCANNER  CUPS 1.4/macOS 10.6 
    -
    Scanner-only device -
    CUPS_PRINTER_SMALL
    Can print on Letter/Legal/A4-size media
    CUPS_PRINTER_SORT
    @@ -7520,25 +7113,6 @@ constants

    Can staple output
    CUPS_PRINTER_VARIABLE
    Can print on rolls and custom-size media
    -
    -

    http_auth_e

    -

    HTTP authentication types

    -

    Constants

    -
    -
    HTTP_AUTH_BASIC
    -
    Basic authentication in use
    -
    HTTP_AUTH_MD5
    -
    Digest authentication in use
    -
    HTTP_AUTH_MD5_INT
    -
    Digest authentication in use for body
    -
    HTTP_AUTH_MD5_SESS
    -
    MD5-session authentication in use
    -
    HTTP_AUTH_MD5_SESS_INT
    -
    MD5-session authentication in use for body
    -
    HTTP_AUTH_NEGOTIATE  CUPS 1.3/macOS 10.5 
    -
    GSSAPI authentication in use
    -
    HTTP_AUTH_NONE
    -
    No authentication in use

    http_encoding_e

    HTTP transfer encoding values

    @@ -7841,35 +7415,9 @@ are server-oriented...

    URI buffer for httpAssembleURI is too small
    HTTP_URI_STATUS_UNKNOWN_SCHEME
    Unknown scheme in URI (warning)
    - -

    http_version_e

    -

    HTTP version numbers

    -

    Constants

    -
    -
    HTTP_VERSION_0_9
    -
    HTTP/0.9
    -
    HTTP_VERSION_1_0
    -
    HTTP/1.0
    -
    HTTP_VERSION_1_1
    -
    HTTP/1.1
    -
    -

    ipp_dstate_e

    -

    Document states

    -

    Constants

    -
    -
    IPP_DOCUMENT_ABORTED
    -
    Document is aborted
    -
    IPP_DOCUMENT_CANCELED
    -
    Document is canceled
    -
    IPP_DOCUMENT_COMPLETED
    -
    Document is completed
    -
    IPP_DOCUMENT_PENDING
    -
    Document is pending
    -
    IPP_DOCUMENT_PROCESSING
    -
    Document is processing

    ipp_finishings_e

    -

    Finishings

    +

    Finishings values

    Constants

    IPP_FINISHINGS_BALE
    @@ -7890,60 +7438,6 @@ are server-oriented...

    Apply protective liquid or powder coating
    IPP_FINISHINGS_COVER
    Add cover
    -
    IPP_FINISHINGS_CUPS_FOLD_ACCORDIAN
    -
    Accordian-fold the paper vertically into four sections
    -
    IPP_FINISHINGS_CUPS_FOLD_DOUBLE_GATE
    -
    Fold the top and bottom quarters of the paper towards the midline, then fold in half vertically
    -
    IPP_FINISHINGS_CUPS_FOLD_GATE
    -
    Fold the top and bottom quarters of the paper towards the midline
    -
    IPP_FINISHINGS_CUPS_FOLD_HALF
    -
    Fold the paper in half vertically
    -
    IPP_FINISHINGS_CUPS_FOLD_HALF_Z
    -
    Fold the paper in half horizontally, then Z-fold the paper vertically
    -
    IPP_FINISHINGS_CUPS_FOLD_LEFT_GATE
    -
    Fold the top quarter of the paper towards the midline
    -
    IPP_FINISHINGS_CUPS_FOLD_LETTER
    -
    Fold the paper into three sections vertically; sometimes also known as a C fold
    -
    IPP_FINISHINGS_CUPS_FOLD_PARALLEL
    -
    Fold the paper in half vertically two times, yielding four sections
    -
    IPP_FINISHINGS_CUPS_FOLD_POSTER
    -
    Fold the paper in half horizontally and vertically; sometimes also called a cross fold
    -
    IPP_FINISHINGS_CUPS_FOLD_RIGHT_GATE
    -
    Fold the bottom quarter of the paper towards the midline
    -
    IPP_FINISHINGS_CUPS_FOLD_Z
    -
    Fold the paper vertically into three sections, forming a Z
    -
    IPP_FINISHINGS_CUPS_PUNCH_BOTTOM_LEFT
    -
    Punch 1 hole bottom left
    -
    IPP_FINISHINGS_CUPS_PUNCH_BOTTOM_RIGHT
    -
    Punch 1 hole bottom right
    -
    IPP_FINISHINGS_CUPS_PUNCH_DUAL_BOTTOM
    -
    Punch 2 holes bottom edge
    -
    IPP_FINISHINGS_CUPS_PUNCH_DUAL_LEFT
    -
    Punch 2 holes left side
    -
    IPP_FINISHINGS_CUPS_PUNCH_DUAL_RIGHT
    -
    Punch 2 holes right side
    -
    IPP_FINISHINGS_CUPS_PUNCH_DUAL_TOP
    -
    Punch 2 holes top edge
    -
    IPP_FINISHINGS_CUPS_PUNCH_QUAD_BOTTOM
    -
    Punch 4 holes bottom edge
    -
    IPP_FINISHINGS_CUPS_PUNCH_QUAD_LEFT
    -
    Punch 4 holes left side
    -
    IPP_FINISHINGS_CUPS_PUNCH_QUAD_RIGHT
    -
    Punch 4 holes right side
    -
    IPP_FINISHINGS_CUPS_PUNCH_QUAD_TOP
    -
    Punch 4 holes top edge
    -
    IPP_FINISHINGS_CUPS_PUNCH_TOP_LEFT
    -
    Punch 1 hole top left
    -
    IPP_FINISHINGS_CUPS_PUNCH_TOP_RIGHT
    -
    Punch 1 hole top right
    -
    IPP_FINISHINGS_CUPS_PUNCH_TRIPLE_BOTTOM
    -
    Punch 3 holes bottom edge
    -
    IPP_FINISHINGS_CUPS_PUNCH_TRIPLE_LEFT
    -
    Punch 3 holes left side
    -
    IPP_FINISHINGS_CUPS_PUNCH_TRIPLE_RIGHT
    -
    Punch 3 holes right side
    -
    IPP_FINISHINGS_CUPS_PUNCH_TRIPLE_TOP
    -
    Punch 3 holes top edge
    IPP_FINISHINGS_EDGE_STITCH
    Stitch along any side
    IPP_FINISHINGS_EDGE_STITCH_BOTTOM
    @@ -8031,7 +7525,7 @@ are server-oriented...

    IPP_FINISHINGS_SADDLE_STITCH
    Staple interior
    IPP_FINISHINGS_STAPLE
    -
    Staple (any location)
    +
    Staple (any location/method)
    IPP_FINISHINGS_STAPLE_BOTTOM_LEFT
    Staple bottom left corner
    IPP_FINISHINGS_STAPLE_BOTTOM_RIGHT
    @@ -8066,14 +7560,6 @@ are server-oriented...

    Trim output after job
    IPP_FINISHINGS_TRIM_AFTER_PAGES
    Trim output after each page
    -
    -

    ipp_jcollate_e

    -

    Job collation types

    -

    Constants

    -
    -
    IPP_JCOLLATE_COLLATED_DOCUMENTS
    -
    IPP_JCOLLATE_UNCOLLATED_DOCUMENTS
    -
    IPP_JCOLLATE_UNCOLLATED_SHEETS

    ipp_jstate_e

    Job states

    @@ -8098,174 +7584,110 @@ are server-oriented...

    IPP operations

    Constants

    -
    IPP_OP_ACKNOWLEDGE_DOCUMENT
    -
    Acknowledge-Document
    -
    IPP_OP_ACKNOWLEDGE_IDENTIFY_PRINTER
    -
    Acknowledge-Identify-Printer
    -
    IPP_OP_ACKNOWLEDGE_JOB
    -
    Acknowledge-Job
    -
    IPP_OP_ACTIVATE_PRINTER
    -
    Start a printer
    -
    IPP_OP_ADD_DOCUMENT_IMAGES
    -
    Add-Document-Images
    IPP_OP_CANCEL_CURRENT_JOB
    -
    Cancel the current job
    -
    IPP_OP_CANCEL_DOCUMENT
    -
    Cancel-Document
    +
    Cancel-Current-Job: Cancel the current job
    IPP_OP_CANCEL_JOB
    -
    Cancel a job
    +
    Cancel-Job: Cancel a job
    IPP_OP_CANCEL_JOBS
    -
    Cancel-Jobs
    +
    Cancel-Jobs: Cancel all jobs (administrative)
    IPP_OP_CANCEL_MY_JOBS
    -
    Cancel-My-Jobs
    +
    Cancel-My-Jobs: Cancel a user's jobs
    IPP_OP_CANCEL_SUBSCRIPTION  CUPS 1.2/macOS 10.5 
    -
    Cancel a subscription
    +
    Cancel-Subscription: Cancel a subscription
    IPP_OP_CLOSE_JOB
    -
    Close-Job
    +
    Close-Job: Close a job and start printing
    IPP_OP_CREATE_JOB
    -
    Create an empty print job
    +
    Create-Job: Create an empty print job
    IPP_OP_CREATE_JOB_SUBSCRIPTIONS  CUPS 1.2/macOS 10.5 
    -
    Create one of more job subscriptions
    +
    Create-Job-Subscriptions: Create one of more job subscriptions
    IPP_OP_CREATE_PRINTER_SUBSCRIPTIONS  CUPS 1.2/macOS 10.5 
    -
    Create one or more printer subscriptions
    -
    IPP_OP_CUPS_ACCEPT_JOBS
    -
    Accept new jobs on a printer
    +
    Create-Printer-Subscriptions: Create one or more printer subscriptions
    IPP_OP_CUPS_ADD_MODIFY_CLASS
    -
    Add or modify a class
    +
    CUPS-Add-Modify-Class: Add or modify a class
    IPP_OP_CUPS_ADD_MODIFY_PRINTER
    -
    Add or modify a printer
    +
    CUPS-Add-Modify-Printer: Add or modify a printer
    IPP_OP_CUPS_AUTHENTICATE_JOB  CUPS 1.2/macOS 10.5 
    -
    Authenticate a job
    +
    CUPS-Authenticate-Job: Authenticate a job
    IPP_OP_CUPS_CREATE_LOCAL_PRINTER  CUPS 2.2 
    -
    Create a local (temporary) printer
    +
    CUPS-Create-Local-Printer: Create a local (temporary) printer
    IPP_OP_CUPS_DELETE_CLASS
    -
    Delete a class
    +
    CUPS-Delete-Class: Delete a class
    IPP_OP_CUPS_DELETE_PRINTER
    -
    Delete a printer
    -
    IPP_OP_CUPS_GET_CLASSES  DEPRECATED 
    -
    Get a list of classes
    +
    CUPS-Delete-Printer: Delete a printer
    IPP_OP_CUPS_GET_DEFAULT
    -
    Get the default printer
    +
    CUPS-Get-Default: Get the default printer
    IPP_OP_CUPS_GET_DEVICES  DEPRECATED 
    -
    Get a list of supported devices
    +
    CUPS-Get-Devices: Get a list of supported devices
    IPP_OP_CUPS_GET_DOCUMENT  CUPS 1.4/macOS 10.6 
    -
    Get a document file
    +
    CUPS-Get-Document: Get a document file
    IPP_OP_CUPS_GET_PPD  DEPRECATED 
    -
    Get a PPD file
    +
    CUPS-Get-PPD: Get a PPD file
    IPP_OP_CUPS_GET_PPDS  DEPRECATED 
    -
    Get a list of supported drivers
    +
    CUPS-Get-PPDs: Get a list of supported drivers
    IPP_OP_CUPS_GET_PRINTERS
    -
    Get a list of printers and/or classes
    +
    CUPS-Get-Printers: Get a list of printers and/or classes
    IPP_OP_CUPS_INVALID
    Invalid operation name for ippOpValue
    IPP_OP_CUPS_MOVE_JOB
    -
    Move a job to a different printer
    -
    IPP_OP_CUPS_REJECT_JOBS
    -
    Reject new jobs on a printer
    +
    CUPS-Move-Job: Move a job to a different printer
    IPP_OP_CUPS_SET_DEFAULT
    -
    Set the default printer
    -
    IPP_OP_DEACTIVATE_PRINTER
    -
    Stop a printer
    -
    IPP_OP_DELETE_DOCUMENT
    -
    Delete-Document
    -
    IPP_OP_DEREGISTER_OUTPUT_DEVICE
    -
    Deregister-Output-Device
    +
    CUPS-Set-Default: Set the default printer
    IPP_OP_DISABLE_PRINTER
    -
    Stop a printer
    +
    Disable-Printer: Reject new jobs for a printer
    IPP_OP_ENABLE_PRINTER
    -
    Start a printer
    -
    IPP_OP_FETCH_DOCUMENT
    -
    Fetch-Document
    -
    IPP_OP_FETCH_JOB
    -
    Fetch-Job
    -
    IPP_OP_GET_DOCUMENTS
    -
    Get-Documents
    -
    IPP_OP_GET_DOCUMENT_ATTRIBUTES
    -
    Get-Document-Attributes
    +
    Enable-Printer: Accept new jobs for a printer
    IPP_OP_GET_JOBS
    -
    Get a list of jobs
    +
    Get-Jobs: Get a list of jobs
    IPP_OP_GET_JOB_ATTRIBUTES
    -
    Get job attributes
    -
    IPP_OP_GET_NEXT_DOCUMENT_DATA
    -
    Get-Next-Document-Data
    +
    Get-Job-Attribute: Get information about a job
    IPP_OP_GET_NOTIFICATIONS  CUPS 1.2/macOS 10.5 
    -
    Get notification events
    -
    IPP_OP_GET_OUTPUT_DEVICE_ATTRIBUTES
    -
    Get-Output-Device-Attributes
    +
    Get-Notifications: Get notification events
    IPP_OP_GET_PRINTER_ATTRIBUTES
    -
    Get printer attributes
    +
    Get-Printer-Attributes: Get information about a printer
    IPP_OP_GET_PRINTER_SUPPORTED_VALUES
    -
    Get supported attribute values
    +
    Get-Printer-Supported-Values: Get supported values
    IPP_OP_GET_SUBSCRIPTIONS  CUPS 1.2/macOS 10.5 
    -
    Get list of subscriptions
    +
    Get-Subscriptions: Get list of subscriptions
    IPP_OP_GET_SUBSCRIPTION_ATTRIBUTES  CUPS 1.2/macOS 10.5 
    -
    Get subscription attributes
    +
    Get-Subscription-Attributes: Get subscription information
    IPP_OP_HOLD_JOB
    -
    Hold a job for printing
    +
    Hold-Job: Hold a job for printing
    IPP_OP_HOLD_NEW_JOBS
    -
    Hold new jobs
    +
    Hold-New-Jobs: Hold new jobs
    IPP_OP_IDENTIFY_PRINTER
    -
    Identify-Printer
    +
    Identify-Printer: Make the printer beep, flash, or display a message for identification
    IPP_OP_PAUSE_PRINTER
    -
    Stop a printer
    +
    Pause-Printer: Stop a printer
    IPP_OP_PAUSE_PRINTER_AFTER_CURRENT_JOB
    -
    Stop printer after the current job
    +
    Pause-Printer-After-Current-Job: Stop printer after the current job
    IPP_OP_PRINT_JOB
    -
    Print a single file
    -
    IPP_OP_PRINT_URI
    -
    Print a single URL
    +
    Print-Job: Print a single file
    IPP_OP_PROMOTE_JOB
    -
    Promote a job to print sooner
    -
    IPP_OP_PURGE_JOBS
    -
    Cancel all jobs
    +
    Promote-Job: Promote a job to print sooner
    IPP_OP_RELEASE_HELD_NEW_JOBS
    -
    Release new jobs
    +
    Release-Held-New-Jobs: Release new jobs that were previously held
    IPP_OP_RELEASE_JOB
    -
    Release a job for printing
    +
    Release-Job: Release a job for printing
    IPP_OP_RENEW_SUBSCRIPTION  CUPS 1.2/macOS 10.5 
    -
    Renew a printer subscription
    -
    IPP_OP_REPROCESS_JOB
    -
    Reprint a job
    -
    IPP_OP_RESTART_JOB
    -
    Reprint a job
    -
    IPP_OP_RESTART_PRINTER
    -
    Restart a printer
    -
    IPP_OP_RESUBMIT_JOB
    -
    Resubmit-Job
    +
    Renew-Subscription: Renew a printer subscription
    +
    IPP_OP_RESTART_JOB  DEPRECATED 
    +
    Restart-Job: Reprint a job
    IPP_OP_RESUME_JOB
    -
    Resume the current job
    +
    Resume-Job: Resume the current job
    IPP_OP_RESUME_PRINTER
    -
    Start a printer
    +
    Resume-Printer: Start a printer
    IPP_OP_SCHEDULE_JOB_AFTER
    -
    Schedule a job to print after another
    +
    Schedule-Job-After: Schedule a job to print after another
    IPP_OP_SEND_DOCUMENT
    -
    Add a file to a job
    -
    IPP_OP_SEND_URI
    -
    Add a URL to a job
    -
    IPP_OP_SET_DOCUMENT_ATTRIBUTES
    -
    Set-Document-Attributes
    +
    Send-Document: Add a file to a job
    IPP_OP_SET_JOB_ATTRIBUTES
    -
    Set job attributes
    +
    Set-Job-Attributes: Set job values
    IPP_OP_SET_PRINTER_ATTRIBUTES
    -
    Set printer attributes
    -
    IPP_OP_SHUTDOWN_PRINTER
    -
    Turn a printer off
    -
    IPP_OP_STARTUP_PRINTER
    -
    Turn a printer on
    +
    Set-Printer-Attributes: Set printer values
    IPP_OP_SUSPEND_CURRENT_JOB
    -
    Suspend the current job
    -
    IPP_OP_UPDATE_ACTIVE_JOBS
    -
    Update-Active-Jobs
    -
    IPP_OP_UPDATE_DOCUMENT_STATUS
    -
    Update-Document-Status
    -
    IPP_OP_UPDATE_JOB_STATUS
    -
    Update-Job-Status
    -
    IPP_OP_UPDATE_OUTPUT_DEVICE_ATTRIBUTES
    -
    Update-Output-Device-Attributes
    -
    IPP_OP_VALIDATE_DOCUMENT
    -
    Validate-Document
    +
    Suspend-Current-Job: Suspend the current job
    IPP_OP_VALIDATE_JOB
    -
    Validate job options
    +
    Validate-Job: Validate job values prior to submission

    ipp_orient_e

    Orientation values

    @@ -8334,8 +7756,6 @@ are server-oriented...

    IPP_STATUS_CUPS_INVALID
    Invalid status name for ippErrorValue
    -
    IPP_STATUS_CUPS_SEE_OTHER
    -
    cups-see-other
    IPP_STATUS_ERROR_ACCOUNT_AUTHORIZATION_FAILED
    client-error-account-authorization-failed
    IPP_STATUS_ERROR_ACCOUNT_CLOSED
    @@ -8372,8 +7792,8 @@ are server-oriented...

    cups-authentication-canceled - Authentication canceled by user
    IPP_STATUS_ERROR_CUPS_PKI  CUPS 1.5/macOS 10.7 
    cups-pki-error - Error negotiating a secure connection
    -
    IPP_STATUS_ERROR_CUPS_UPGRADE_REQUIRED
    -
    cups-upgrade-required - TLS upgrade required
    +
    IPP_STATUS_ERROR_CUPS_UPGRADE_REQUIRED  CUPS 1.5/macOS 10.7 
    +
    cups-upgrade-required - TLS upgrade required
    IPP_STATUS_ERROR_DEVICE
    server-error-device-error
    IPP_STATUS_ERROR_DOCUMENT_ACCESS
    @@ -8457,8 +7877,6 @@ are server-oriented...

    IPP_TAG_ADMINDEFINE
    Admin-defined value
    -
    IPP_TAG_BEGIN_COLLECTION
    -
    Beginning of collection value
    IPP_TAG_BOOLEAN
    Boolean value
    IPP_TAG_CHARSET
    @@ -8471,18 +7889,12 @@ are server-oriented...

    Default value
    IPP_TAG_DELETEATTR
    Delete-attribute value
    -
    IPP_TAG_DOCUMENT
    -
    Document group
    IPP_TAG_END
    End-of-attributes
    -
    IPP_TAG_END_COLLECTION
    -
    End of collection value
    IPP_TAG_ENUM
    Enumeration value
    IPP_TAG_EVENT_NOTIFICATION
    Event group
    -
    IPP_TAG_EXTENSION
    -
    Extension point for 32-bit tags
    IPP_TAG_INTEGER
    Integer value
    IPP_TAG_JOB
    @@ -8491,8 +7903,6 @@ are server-oriented...

    Keyword value
    IPP_TAG_LANGUAGE
    Language value
    -
    IPP_TAG_MEMBERNAME
    -
    Collection member name value
    IPP_TAG_MIMETYPE
    MIME media type value
    IPP_TAG_NAME
    -- cgit v1.2.3