From: Michael Sweet Date: Mon, 12 Jun 2017 13:05:40 +0000 (-0400) Subject: Save work on documentation. X-Git-Tag: v2.2.4~41 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=65bebeac765e0aab4cf2eae77d1d2b49e3b896dd;p=thirdparty%2Fcups.git Save work on documentation. --- diff --git a/cups/cups-private.h b/cups/cups-private.h index 264fd01c8e..6fd66a9ced 100644 --- a/cups/cups-private.h +++ b/cups/cups-private.h @@ -1,7 +1,7 @@ /* * Private definitions for CUPS. * - * Copyright 2007-2015 by Apple Inc. + * Copyright 2007-2017 by Apple Inc. * Copyright 1997-2007 by Easy Software Products, all rights reserved. * * These coded instructions, statements, and computer programs are the @@ -105,7 +105,7 @@ typedef struct _cups_globals_s /**** CUPS global state data ****/ int need_res_init; /* Need to reinitialize resolver? */ /* ipp.c */ - ipp_uchar_t ipp_date[11]; /* RFC-1903 date/time data */ + ipp_uchar_t ipp_date[11]; /* RFC-2579 date/time data */ _cups_buffer_t *cups_buffers; /* Buffer list */ /* ipp-support.c */ diff --git a/cups/cupspm.md b/cups/cupspm.md index c7f86d87dc..35b5a75321 100644 --- a/cups/cupspm.md +++ b/cups/cupspm.md @@ -729,3 +729,21 @@ created: } fclose(fp); + + +# Sending IPP Requests + +## Connecting to the Scheduler or Printer + +cupsDestConnect and httpConnect2 + +httpGetTrust, etc. + + +## Creating an IPP Request + +## Sending the IPP Request + +## Getting the IPP Response + +## Authentication diff --git a/cups/ipp-support.c b/cups/ipp-support.c index b49ac0d2f9..675e5f380c 100644 --- a/cups/ipp-support.c +++ b/cups/ipp-support.c @@ -1,7 +1,7 @@ /* * Internet Printing Protocol support functions for CUPS. * - * Copyright 2007-2014 by Apple Inc. + * Copyright 2007-2017 by Apple Inc. * Copyright 1997-2007 by Easy Software Products, all rights reserved. * * These coded instructions, statements, and computer programs are the @@ -2243,7 +2243,7 @@ ippStateString(ipp_state_t state) /* I - State value */ /* * 'ippTagString()' - Return the tag name corresponding to a tag value. * - * The returned names are defined in RFC 2911 and 3382. + * The returned names are defined in RFC 8011 and the IANA IPP Registry. * * @since CUPS 1.4/macOS 10.6@ */ @@ -2263,7 +2263,7 @@ ippTagString(ipp_tag_t tag) /* I - Tag value */ /* * 'ippTagValue()' - Return the tag value corresponding to a tag name. * - * The tag names are defined in RFC 2911 and 3382. + * The tag names are defined in RFC 8011 and the IANA IPP Registry. * * @since CUPS 1.4/macOS 10.6@ */ diff --git a/cups/ipp.c b/cups/ipp.c index 817c9d5fab..429a05eafe 100644 --- a/cups/ipp.c +++ b/cups/ipp.c @@ -316,7 +316,7 @@ ippAddCollections( /* - * 'ippAddDate()' - Add a date attribute to an IPP message. + * 'ippAddDate()' - Add a dateTime attribute to an IPP message. * * The @code ipp@ parameter refers to an IPP message previously created using * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions. @@ -1380,7 +1380,7 @@ ippContainsInteger( * specified string value. * * Returns non-zero when the attribute contains a matching charset, keyword, - * language, mimeMediaType, name, text, URI, or URI scheme value. + * naturalLanguage, mimeMediaType, name, text, uri, or uriScheme value. * * @since CUPS 1.7/macOS 10.9@ */ @@ -1759,12 +1759,12 @@ ippCopyAttributes( /* - * 'ippDateToTime()' - Convert from RFC 1903 Date/Time format to UNIX time - * in seconds. + * 'ippDateToTime()' - Convert from RFC 2579 Date/Time format to time in + * seconds. */ time_t /* O - UNIX time value */ -ippDateToTime(const ipp_uchar_t *date) /* I - RFC 1903 date info */ +ippDateToTime(const ipp_uchar_t *date) /* I - RFC 2579 date info */ { struct tm unixdate; /* UNIX date/time info */ time_t t; /* Computed time */ @@ -1776,7 +1776,7 @@ ippDateToTime(const ipp_uchar_t *date) /* I - RFC 1903 date info */ memset(&unixdate, 0, sizeof(unixdate)); /* - * RFC-1903 date/time format is: + * RFC-2579 date/time format is: * * Byte(s) Description * ------- ----------- @@ -2152,7 +2152,7 @@ ippFirstAttribute(ipp_t *ipp) /* I - IPP message */ * 'ippGetBoolean()' - Get a boolean value for an attribute. * * The @code element@ parameter specifies which value to get from 0 to - * @link ippGetCount(attr)@ - 1. + * @code ippGetCount(attr)@ - 1. * * @since CUPS 1.6/macOS 10.8@ */ @@ -2181,7 +2181,7 @@ ippGetBoolean(ipp_attribute_t *attr, /* I - IPP attribute */ * 'ippGetCollection()' - Get a collection value for an attribute. * * The @code element@ parameter specifies which value to get from 0 to - * @link ippGetCount(attr)@ - 1. + * @code ippGetCount(attr)@ - 1. * * @since CUPS 1.6/macOS 10.8@ */ @@ -2232,15 +2232,15 @@ ippGetCount(ipp_attribute_t *attr) /* I - IPP attribute */ /* - * 'ippGetDate()' - Get a date value for an attribute. + * 'ippGetDate()' - Get a dateTime value for an attribute. * * The @code element@ parameter specifies which value to get from 0 to - * @link ippGetCount(attr)@ - 1. + * @code ippGetCount(attr)@ - 1. * * @since CUPS 1.6/macOS 10.8@ */ -const ipp_uchar_t * /* O - Date value or @code NULL@ */ +const ipp_uchar_t * /* O - dateTime value or @code NULL@ */ ippGetDate(ipp_attribute_t *attr, /* I - IPP attribute */ int element) /* I - Value number (0-based) */ { @@ -2288,7 +2288,7 @@ ippGetGroupTag(ipp_attribute_t *attr) /* I - IPP attribute */ * 'ippGetInteger()' - Get the integer/enum value for an attribute. * * The @code element@ parameter specifies which value to get from 0 to - * @link ippGetCount(attr)@ - 1. + * @code ippGetCount(attr)@ - 1. * * @since CUPS 1.6/macOS 10.8@ */ @@ -2341,7 +2341,7 @@ ippGetName(ipp_attribute_t *attr) /* I - IPP attribute */ * 'ippGetOctetString()' - Get an octetString value from an IPP attribute. * * The @code element@ parameter specifies which value to get from 0 to - * @link ippGetCount(attr)@ - 1. + * @code ippGetCount(attr)@ - 1. * * @since CUPS 1.7/macOS 10.9@ */ @@ -2404,7 +2404,7 @@ ippGetOperation(ipp_t *ipp) /* I - IPP request message */ * 'ippGetRange()' - Get a rangeOfInteger value from an attribute. * * The @code element@ parameter specifies which value to get from 0 to - * @link ippGetCount(attr)@ - 1. + * @code ippGetCount(attr)@ - 1. * * @since CUPS 1.6/macOS 10.8@ */ @@ -2466,7 +2466,7 @@ ippGetRequestId(ipp_t *ipp) /* I - IPP message */ * 'ippGetResolution()' - Get a resolution value for an attribute. * * The @code element@ parameter specifies which value to get from 0 to - * @link ippGetCount(attr)@ - 1. + * @code ippGetCount(attr)@ - 1. * * @since CUPS 1.6/macOS 10.8@ */ @@ -2560,7 +2560,7 @@ ippGetStatusCode(ipp_t *ipp) /* I - IPP response or event message */ * 'ippGetString()' - Get the string and optionally the language code for an attribute. * * The @code element@ parameter specifies which value to get from 0 to - * @link ippGetCount(attr)@ - 1. + * @code ippGetCount(attr)@ - 1. * * @since CUPS 1.6/macOS 10.8@ */ @@ -2625,7 +2625,7 @@ ippGetValueTag(ipp_attribute_t *attr) /* I - IPP attribute */ int /* O - Major version number or 0 on error */ ippGetVersion(ipp_t *ipp, /* I - IPP message */ - int *minor) /* O - Minor version number or @code NULL@ */ + int *minor) /* O - Minor version number or @code NULL@ for don't care */ { /* * Range check input... @@ -2722,9 +2722,9 @@ ippNew(void) /* * 'ippNewRequest()' - Allocate a new IPP request message. * - * The new request message is initialized with the attributes-charset and - * attributes-natural-language attributes added. The - * attributes-natural-language value is derived from the current locale. + * The new request message is initialized with the "attributes-charset" and + * "attributes-natural-language" attributes added. The + * "attributes-natural-language" value is derived from the current locale. * * @since CUPS 1.2/macOS 10.5@ */ @@ -2786,11 +2786,11 @@ ippNewRequest(ipp_op_t op) /* I - Operation code */ /* * 'ippNewResponse()' - Allocate a new IPP response message. * - * The new response message is initialized with the same version-number, - * request-id, attributes-charset, and attributes-natural-language as the - * provided request message. If the attributes-charset or - * attributes-natural-language attributes are missing from the request, - * "utf-8" and a value derived from the current locale are substituted, + * The new response message is initialized with the same "version-number", + * "request-id", "attributes-charset", and "attributes-natural-language" as the + * provided request message. If the "attributes-charset" or + * "attributes-natural-language" attributes are missing from the request, + * 'utf-8' and a value derived from the current locale are substituted, * respectively. * * @since CUPS 1.7/macOS 10.9@ @@ -3706,7 +3706,7 @@ ippReadIO(void *src, /* I - Data source */ * The @code attr@ parameter may be modified as a result of setting the value. * * The @code element@ parameter specifies which value to set from 0 to - * @link ippGetCount(attr)@. + * @code ippGetCount(attr)@. * * @since CUPS 1.6/macOS 10.8@ */ @@ -3748,7 +3748,7 @@ ippSetBoolean(ipp_t *ipp, /* I - IPP message */ * The @code attr@ parameter may be modified as a result of setting the value. * * The @code element@ parameter specifies which value to set from 0 to - * @link ippGetCount(attr)@. + * @code ippGetCount(attr)@. * * @since CUPS 1.6/macOS 10.8@ */ @@ -3789,7 +3789,7 @@ ippSetCollection( /* - * 'ippSetDate()' - Set a date value in an attribute. + * 'ippSetDate()' - Set a dateTime value in an attribute. * * The @code ipp@ parameter refers to an IPP message previously created using * the @link ippNew@, @link ippNewRequest@, or @link ippNewResponse@ functions. @@ -3797,7 +3797,7 @@ ippSetCollection( * The @code attr@ parameter may be modified as a result of setting the value. * * The @code element@ parameter specifies which value to set from 0 to - * @link ippGetCount(attr)@. + * @code ippGetCount(attr)@. * * @since CUPS 1.6/macOS 10.8@ */ @@ -3806,7 +3806,7 @@ int /* O - 1 on success, 0 on failure */ ippSetDate(ipp_t *ipp, /* I - IPP message */ ipp_attribute_t **attr, /* IO - IPP attribute */ int element, /* I - Value number (0-based) */ - const ipp_uchar_t *datevalue)/* I - Date value */ + const ipp_uchar_t *datevalue)/* I - dateTime value */ { _ipp_value_t *value; /* Current value */ @@ -3854,7 +3854,7 @@ ippSetGroupTag( ipp_tag_t group_tag) /* I - Group tag */ { /* - * Range check input - group tag must be 0x01 to 0x0F, per RFC 2911... + * Range check input - group tag must be 0x01 to 0x0F, per RFC 8011... */ if (!ipp || !attr || !*attr || @@ -3881,7 +3881,7 @@ ippSetGroupTag( * The @code attr@ parameter may be modified as a result of setting the value. * * The @code element@ parameter specifies which value to set from 0 to - * @link ippGetCount(attr)@. + * @code ippGetCount(attr)@. * * @since CUPS 1.6/macOS 10.8@ */ @@ -3966,7 +3966,7 @@ ippSetName(ipp_t *ipp, /* I - IPP message */ * The @code attr@ parameter may be modified as a result of setting the value. * * The @code element@ parameter specifies which value to set from 0 to - * @link ippGetCount(attr)@. + * @code ippGetCount(attr)@. * * @since CUPS 1.7/macOS 10.9@ */ @@ -4084,7 +4084,7 @@ ippSetOperation(ipp_t *ipp, /* I - IPP request message */ * The @code attr@ parameter may be modified as a result of setting the value. * * The @code element@ parameter specifies which value to set from 0 to - * @link ippGetCount(attr)@. + * @code ippGetCount(attr)@. * * @since CUPS 1.6/macOS 10.8@ */ @@ -4164,7 +4164,7 @@ ippSetRequestId(ipp_t *ipp, /* I - IPP message */ * The @code attr@ parameter may be modified as a result of setting the value. * * The @code element@ parameter specifies which value to set from 0 to - * @link ippGetCount(attr)@. + * @code ippGetCount(attr)@. * * @since CUPS 1.6/macOS 10.8@ */ @@ -4272,7 +4272,7 @@ ippSetStatusCode(ipp_t *ipp, /* I - IPP response or event message */ * The @code attr@ parameter may be modified as a result of setting the value. * * The @code element@ parameter specifies which value to set from 0 to - * @link ippGetCount(attr)@. + * @code ippGetCount(attr)@. * * @since CUPS 1.6/macOS 10.8@ */ @@ -4334,7 +4334,7 @@ ippSetString(ipp_t *ipp, /* I - IPP message */ * The @code attr@ parameter may be modified as a result of setting the value. * * The @code element@ parameter specifies which value to set from 0 to - * @link ippGetCount(attr)@. + * @code ippGetCount(attr)@. * * The @code format@ parameter uses formatting characters compatible with the * printf family of standard functions. Additional arguments follow it as @@ -4372,7 +4372,7 @@ ippSetStringf(ipp_t *ipp, /* I - IPP message */ * The @code attr@ parameter may be modified as a result of setting the value. * * The @code element@ parameter specifies which value to set from 0 to - * @link ippGetCount(attr)@. + * @code ippGetCount(attr)@. * * The @code format@ parameter uses formatting characters compatible with the * printf family of standard functions. Additional arguments follow it as @@ -4715,19 +4715,19 @@ ippSetVersion(ipp_t *ipp, /* I - IPP message */ /* - * 'ippTimeToDate()' - Convert from UNIX time to RFC 1903 format. + * 'ippTimeToDate()' - Convert from time in seconds to RFC 2579 format. */ -const ipp_uchar_t * /* O - RFC-1903 date/time data */ -ippTimeToDate(time_t t) /* I - UNIX time value */ +const ipp_uchar_t * /* O - RFC-2579 date/time data */ +ippTimeToDate(time_t t) /* I - Time in seconds */ { struct tm *unixdate; /* UNIX unixdate/time info */ ipp_uchar_t *date = _cupsGlobals()->ipp_date; - /* RFC-1903 date/time data */ + /* RFC-2579 date/time data */ /* - * RFC-1903 date/time format is: + * RFC-2579 date/time format is: * * Byte(s) Description * ------- ----------- @@ -4767,7 +4767,7 @@ ippTimeToDate(time_t t) /* I - UNIX time value */ * * This function validates the contents of an attribute based on the name and * value tag. 1 is returned if the attribute is valid, 0 otherwise. On - * failure, cupsLastErrorString() is set to a human-readable message. + * failure, @link cupsLastErrorString@ is set to a human-readable message. * * @since CUPS 1.7/macOS 10.9@ */ @@ -4823,7 +4823,7 @@ ippValidateAttribute( { ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad attribute name - invalid character " - "(RFC 2911 section 4.1.3)."), attr->name); + "(RFC 8011 section 5.1.4)."), attr->name); return (0); } @@ -4831,7 +4831,7 @@ ippValidateAttribute( { ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad attribute name - bad length %d " - "(RFC 2911 section 4.1.3)."), attr->name, + "(RFC 8011 section 5.1.4)."), attr->name, (int)(ptr - attr->name)); return (0); } @@ -4849,7 +4849,7 @@ ippValidateAttribute( { ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad boolen value %d " - "(RFC 2911 section 4.1.11)."), attr->name, + "(RFC 8011 section 5.1.21)."), attr->name, attr->values[i].boolean); return (0); } @@ -4863,7 +4863,7 @@ ippValidateAttribute( { ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad enum value %d - out of range " - "(RFC 2911 section 4.1.4)."), attr->name, + "(RFC 8011 section 5.1.5)."), attr->name, attr->values[i].integer); return (0); } @@ -4877,7 +4877,7 @@ ippValidateAttribute( { ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad octetString value - bad length %d " - "(RFC 2911 section 4.1.10)."), attr->name, + "(RFC 8011 section 5.1.20)."), attr->name, attr->values[i].unknown.length); return (0); } @@ -4893,7 +4893,7 @@ ippValidateAttribute( { ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad dateTime month %u " - "(RFC 2911 section 4.1.14)."), attr->name, date[2]); + "(RFC 8011 section 5.1.15)."), attr->name, date[2]); return (0); } @@ -4901,7 +4901,7 @@ ippValidateAttribute( { ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad dateTime day %u " - "(RFC 2911 section 4.1.14)."), attr->name, date[3]); + "(RFC 8011 section 5.1.15)."), attr->name, date[3]); return (0); } @@ -4909,7 +4909,7 @@ ippValidateAttribute( { ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad dateTime hours %u " - "(RFC 2911 section 4.1.14)."), attr->name, date[4]); + "(RFC 8011 section 5.1.15)."), attr->name, date[4]); return (0); } @@ -4917,7 +4917,7 @@ ippValidateAttribute( { ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad dateTime minutes %u " - "(RFC 2911 section 4.1.14)."), attr->name, date[5]); + "(RFC 8011 section 5.1.15)."), attr->name, date[5]); return (0); } @@ -4925,7 +4925,7 @@ ippValidateAttribute( { ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad dateTime seconds %u " - "(RFC 2911 section 4.1.14)."), attr->name, date[6]); + "(RFC 8011 section 5.1.15)."), attr->name, date[6]); return (0); } @@ -4933,7 +4933,7 @@ ippValidateAttribute( { ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad dateTime deciseconds %u " - "(RFC 2911 section 4.1.14)."), attr->name, date[7]); + "(RFC 8011 section 5.1.15)."), attr->name, date[7]); return (0); } @@ -4941,7 +4941,7 @@ ippValidateAttribute( { ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad dateTime UTC sign '%c' " - "(RFC 2911 section 4.1.14)."), attr->name, date[8]); + "(RFC 8011 section 5.1.15)."), attr->name, date[8]); return (0); } @@ -4949,7 +4949,7 @@ ippValidateAttribute( { ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad dateTime UTC hours %u " - "(RFC 2911 section 4.1.14)."), attr->name, date[9]); + "(RFC 8011 section 5.1.15)."), attr->name, date[9]); return (0); } @@ -4957,7 +4957,7 @@ ippValidateAttribute( { ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad dateTime UTC minutes %u " - "(RFC 2911 section 4.1.14)."), attr->name, date[10]); + "(RFC 8011 section 5.1.15)."), attr->name, date[10]); return (0); } } @@ -4971,7 +4971,7 @@ ippValidateAttribute( ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad resolution value %dx%d%s - cross " "feed resolution must be positive " - "(RFC 2911 section 4.1.15)."), attr->name, + "(RFC 8011 section 5.1.16)."), attr->name, attr->values[i].resolution.xres, attr->values[i].resolution.yres, attr->values[i].resolution.units == @@ -4986,7 +4986,7 @@ ippValidateAttribute( ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad resolution value %dx%d%s - feed " "resolution must be positive " - "(RFC 2911 section 4.1.15)."), attr->name, + "(RFC 8011 section 5.1.16)."), attr->name, attr->values[i].resolution.xres, attr->values[i].resolution.yres, attr->values[i].resolution.units == @@ -5001,7 +5001,7 @@ ippValidateAttribute( { ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad resolution value %dx%d%s - bad " - "units value (RFC 2911 section 4.1.15)."), + "units value (RFC 8011 section 5.1.16)."), attr->name, attr->values[i].resolution.xres, attr->values[i].resolution.yres, attr->values[i].resolution.units == @@ -5020,7 +5020,7 @@ ippValidateAttribute( { ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad rangeOfInteger value %d-%d - lower " - "greater than upper (RFC 2911 section 4.1.13)."), + "greater than upper (RFC 8011 section 5.1.14)."), attr->name, attr->values[i].range.lower, attr->values[i].range.upper); return (0); @@ -5082,7 +5082,7 @@ ippValidateAttribute( { ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad text value \"%s\" - bad UTF-8 " - "sequence (RFC 2911 section 4.1.1)."), attr->name, + "sequence (RFC 8011 section 5.1.2)."), attr->name, attr->values[i].string.text); return (0); } @@ -5091,7 +5091,7 @@ ippValidateAttribute( { ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad text value \"%s\" - bad length %d " - "(RFC 2911 section 4.1.1)."), attr->name, + "(RFC 8011 section 5.1.2)."), attr->name, attr->values[i].string.text, (int)(ptr - attr->values[i].string.text)); return (0); @@ -5140,7 +5140,7 @@ ippValidateAttribute( { ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad name value \"%s\" - bad UTF-8 " - "sequence (RFC 2911 section 4.1.2)."), attr->name, + "sequence (RFC 8011 section 5.1.3)."), attr->name, attr->values[i].string.text); return (0); } @@ -5149,7 +5149,7 @@ ippValidateAttribute( { ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad name value \"%s\" - bad length %d " - "(RFC 2911 section 4.1.2)."), attr->name, + "(RFC 8011 section 5.1.3)."), attr->name, attr->values[i].string.text, (int)(ptr - attr->values[i].string.text)); return (0); @@ -5169,7 +5169,7 @@ ippValidateAttribute( { ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad keyword value \"%s\" - invalid " - "character (RFC 2911 section 4.1.3)."), + "character (RFC 8011 section 5.1.4)."), attr->name, attr->values[i].string.text); return (0); } @@ -5178,7 +5178,7 @@ ippValidateAttribute( { ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad keyword value \"%s\" - bad " - "length %d (RFC 2911 section 4.1.3)."), + "length %d (RFC 8011 section 5.1.4)."), attr->name, attr->values[i].string.text, (int)(ptr - attr->values[i].string.text)); return (0); @@ -5200,7 +5200,7 @@ ippValidateAttribute( { ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad URI value \"%s\" - %s " - "(RFC 2911 section 4.1.5)."), attr->name, + "(RFC 8011 section 5.1.6)."), attr->name, attr->values[i].string.text, uri_status_strings[uri_status - HTTP_URI_STATUS_OVERFLOW]); @@ -5211,7 +5211,7 @@ ippValidateAttribute( { ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad URI value \"%s\" - bad length %d " - "(RFC 2911 section 4.1.5)."), attr->name, + "(RFC 8011 section 5.1.6)."), attr->name, attr->values[i].string.text, (int)strlen(attr->values[i].string.text)); } @@ -5234,7 +5234,7 @@ ippValidateAttribute( { ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad uriScheme value \"%s\" - bad " - "characters (RFC 2911 section 4.1.6)."), + "characters (RFC 8011 section 5.1.7)."), attr->name, attr->values[i].string.text); return (0); } @@ -5243,7 +5243,7 @@ ippValidateAttribute( { ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad uriScheme value \"%s\" - bad " - "length %d (RFC 2911 section 4.1.6)."), + "length %d (RFC 8011 section 5.1.7)."), attr->name, attr->values[i].string.text, (int)(ptr - attr->values[i].string.text)); return (0); @@ -5263,7 +5263,7 @@ ippValidateAttribute( { ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad charset value \"%s\" - bad " - "characters (RFC 2911 section 4.1.7)."), + "characters (RFC 8011 section 5.1.8)."), attr->name, attr->values[i].string.text); return (0); } @@ -5272,7 +5272,7 @@ ippValidateAttribute( { ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad charset value \"%s\" - bad " - "length %d (RFC 2911 section 4.1.7)."), + "length %d (RFC 8011 section 5.1.8)."), attr->name, attr->values[i].string.text, (int)(ptr - attr->values[i].string.text)); return (0); @@ -5318,7 +5318,7 @@ ippValidateAttribute( { ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad naturalLanguage value \"%s\" - bad " - "characters (RFC 2911 section 4.1.8)."), + "characters (RFC 8011 section 5.1.9)."), attr->name, attr->values[i].string.text); regfree(&re); return (0); @@ -5328,7 +5328,7 @@ ippValidateAttribute( { ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad naturalLanguage value \"%s\" - bad " - "length %d (RFC 2911 section 4.1.8)."), + "length %d (RFC 8011 section 5.1.9)."), attr->name, attr->values[i].string.text, (int)strlen(attr->values[i].string.text)); regfree(&re); @@ -5372,7 +5372,7 @@ ippValidateAttribute( { ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad mimeMediaType value \"%s\" - bad " - "characters (RFC 2911 section 4.1.9)."), + "characters (RFC 8011 section 5.1.10)."), attr->name, attr->values[i].string.text); regfree(&re); return (0); @@ -5382,7 +5382,7 @@ ippValidateAttribute( { ipp_set_error(IPP_STATUS_ERROR_BAD_REQUEST, _("\"%s\": Bad mimeMediaType value \"%s\" - bad " - "length %d (RFC 2911 section 4.1.9)."), + "length %d (RFC 8011 section 5.1.10)."), attr->name, attr->values[i].string.text, (int)strlen(attr->values[i].string.text)); regfree(&re); @@ -5405,8 +5405,8 @@ ippValidateAttribute( * 'ippValidateAttributes()' - Validate all attributes in an IPP message. * * This function validates the contents of the IPP message, including each - * attribute. Like @link ippValidateAttribute@, cupsLastErrorString() is set - * to a human-readable message on failure. + * attribute. Like @link ippValidateAttribute@, @link cupsLastErrorString@ is + * set to a human-readable message on failure. * * @since CUPS 1.7/macOS 10.9@ */ diff --git a/cups/ipp.h b/cups/ipp.h index feea0899f5..2a4f546c75 100644 --- a/cups/ipp.h +++ b/cups/ipp.h @@ -276,7 +276,7 @@ typedef enum ipp_op_e /**** IPP operations ****/ IPP_OP_GET_NOTIFICATIONS, /* Get-Notifications: Get notification events @since CUPS 1.2/macOS 10.5@ */ IPP_OP_SEND_NOTIFICATIONS, /* Send-Notifications: Send notification events @private@ */ IPP_OP_GET_RESOURCE_ATTRIBUTES, /* Get-Resource-Attributes: Get resource information @private@ */ - IPP_OP_GET_RESOURCE_DATA, /* Get-Resource-Data: Get resource data @private@ */ + IPP_OP_GET_RESOURCE_DATA, /* Get-Resource-Data: Get resource data @private@ @deprecated@ */ IPP_OP_GET_RESOURCES, /* Get-Resources: Get list of resources @private@ */ IPP_OP_GET_PRINT_SUPPORT_FILES, /* Get-Printer-Support-Files: Get printer support files @private@ */ IPP_OP_ENABLE_PRINTER, /* Enable-Printer: Accept new jobs for a printer */ @@ -442,7 +442,7 @@ typedef enum ipp_orient_e /**** Orientation values ****/ # endif /* !_CUPS_NO_DEPRECATED */ } ipp_orient_t; -typedef enum ipp_pstate_e /**** Printer states ****/ +typedef enum ipp_pstate_e /**** Printer state values ****/ { IPP_PSTATE_IDLE = 3, /* Printer is idle */ IPP_PSTATE_PROCESSING, /* Printer is working */ @@ -455,7 +455,7 @@ typedef enum ipp_pstate_e /**** Printer states ****/ # endif /* _CUPS_NO_DEPRECATED */ } ipp_pstate_t; -typedef enum ipp_quality_e /**** Qualities ****/ +typedef enum ipp_quality_e /**** Print quality values ****/ { IPP_QUALITY_DRAFT = 3, /* Draft quality */ IPP_QUALITY_NORMAL, /* Normal quality */ @@ -468,7 +468,7 @@ typedef enum ipp_res_e /**** Resolution units ****/ IPP_RES_PER_CM /* Pixels per centimeter */ } ipp_res_t; -typedef enum ipp_state_e /**** IPP states ****/ +typedef enum ipp_state_e /**** ipp_t state values ****/ { IPP_STATE_ERROR = -1, /* An error occurred */ IPP_STATE_IDLE, /* Nothing is happening/request completed */ @@ -485,7 +485,7 @@ typedef enum ipp_state_e /**** IPP states ****/ # endif /* !_CUPS_NO_DEPRECATED */ } ipp_state_t; -typedef enum ipp_status_e /**** IPP status codes ****/ +typedef enum ipp_status_e /**** IPP status code values ****/ { IPP_STATUS_CUPS_INVALID = -1, /* Invalid status name for @link ippErrorValue@ */ IPP_STATUS_OK = 0x0000, /* successful-ok */ @@ -636,7 +636,7 @@ typedef enum ipp_status_e /**** IPP status codes ****/ # endif /* _CUPS_NO_DEPRECATED */ } ipp_status_t; -typedef enum ipp_tag_e /**** Format tags for attributes ****/ +typedef enum ipp_tag_e /**** Value and group tag values for attributes ****/ { IPP_TAG_CUPS_INVALID = -1, /* Invalid tag name for @link ippTagValue@ */ IPP_TAG_ZERO = 0x00, /* Zero tag - used for separators */ @@ -695,10 +695,11 @@ typedef struct _ipp_attribute_s ipp_attribute_t; /**** New in CUPS 1.2/macOS 10.5 ****/ typedef ssize_t (*ipp_iocb_t)(void *context, ipp_uchar_t *buffer, size_t bytes); - /**** IPP IO Callback Function @since CUPS 1.2/macOS 10.5@ ****/ + /**** ippReadIO/ippWriteIO callback function @since CUPS 1.2/macOS 10.5@ ****/ /**** New in CUPS 1.6/macOS 10.8 ****/ typedef int (*ipp_copycb_t)(void *context, ipp_t *dst, ipp_attribute_t *attr); + /**** ippCopyAttributes callback function @since CUPS 1.6/macOS 10.8 ****/ /* @@ -805,7 +806,7 @@ typedef union _ipp_value_u /**** Attribute Value ****/ } _ipp_value_t; typedef _ipp_value_t ipp_value_t; /**** Convenience typedef that will be removed @private@ ****/ -struct _ipp_attribute_s /**** Attribute ****/ +struct _ipp_attribute_s /**** IPP attribute ****/ { ipp_attribute_t *next; /* Next attribute in list */ ipp_tag_t group_tag, /* Job/Printer/Operation group tag */ diff --git a/doc/help/cupspm.epub b/doc/help/cupspm.epub index 6a35cb7e15..ef8ac473ac 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 45610d1bf3..7ece8f0cf0 100644 --- a/doc/help/cupspm.html +++ b/doc/help/cupspm.html @@ -160,7 +160,6 @@ table.list td { padding: 5px 2px 5px 10px; text-align: left; vertical-align: top; - width: 80%; } h1.title { } @@ -303,7 +302,6 @@ h3.title {
  • httpGetExpect
  • httpGetFd
  • httpGetField
    • -
  • httpGetHostByName
  • httpGetHostname
  • httpGetKeepAlive
  • httpGetLength2
    • @@ -342,7 +340,6 @@ h3.title {
  • httpShutdown
  • httpStateString
  • httpStatus
    • -
  • httpTrace
  • httpURIStatusString
  • httpUpdate
  • httpWait
    • @@ -2696,7 +2693,7 @@ int httpCompareCredentials(cups_array_t *cred1, cups_array_t *cred2);

    port Port number addrlist - List of addresses or NULL to lookup + List of addresses or NULL to lookup family Address family to use or AF_UNSPEC for any encryption @@ -2793,7 +2790,7 @@ char *httpDecode64_2(char *out, int *outlen, const char *in);

    Decoded string

    Discussion

    The caller must initialize "outlen" to the maximum size of the decoded -string before calling @httpDecode64_2@. On return "outlen" contains the +string before calling httpDecode64_2. On return "outlen" contains the decoded length of the string.

    @@ -2864,7 +2861,7 @@ name.

    Return Value

    Field index

    httpFlush

    -

    Flush data from a HTTP connection.

    +

    Flush data read from a HTTP connection.

    void httpFlush(http_t *http);

    Parameters

    @@ -2873,7 +2870,7 @@ void httpFlush(http_t *http);

    HTTP connection

     CUPS 1.2/macOS 10.5 httpFlushWrite

    -

    Flush data in write buffer.

    +

    Flush data written to a HTTP connection.

    int httpFlushWrite(http_t *http);

    Parameters

    @@ -2917,7 +2914,7 @@ time_t httpGetActivity(http_t *http);

    Return Value

    Time of last read or write

    Discussion

    -

    The return value is the UNIX time of the last read or write. +

    The return value is the time in seconds of the last read or write.

     CUPS 2.0/OS 10.10 httpGetAddress

    @@ -2932,7 +2929,11 @@ time_t httpGetActivity(http_t *http);

    Return Value

    Connected address or NULL

    Discussion

    -

    Returns NULL if the socket is currently unconnected. +

    For connections created with httpConnect2, the address is for the +server. For connections created with httpAccept, the address is for +the client.
    +
    +Returns NULL if the socket is currently unconnected.

     CUPS 1.3/macOS 10.5 httpGetAuthString

    @@ -2947,10 +2948,10 @@ char *httpGetAuthString(http_t *http);

    Return Value

    Authorization string

    Discussion

    -

    The authorization string is set by cupsDoAuthentication() and -httpSetAuthString(). Use httpGetAuthString() to retrieve the -string to use with httpSetField() for the HTTP_FIELD_AUTHORIZATION -value. +

    The authorization string is set by cupsDoAuthentication and +httpSetAuthString. Use httpGetAuthString to retrieve the +string to use with httpSetField for the +HTTP_FIELD_AUTHORIZATION value.

     CUPS 1.2/macOS 10.5 httpGetBlocking

    @@ -2995,7 +2996,7 @@ const char *httpGetCookie(http_t *http);

    HTTP connection

    Return Value

    -

    Cookie data or NULL

    +

    Cookie data or NULL

     CUPS 1.2/macOS 10.5 httpGetDateString2

    Get a formatted date/time string from a time value.

    @@ -3003,7 +3004,7 @@ const char *httpGetDateString2(time_t t, char *s, int slen);

    Parameters

    - + @@ -3021,7 +3022,7 @@ time_t httpGetDateTime(const char *s);

    tUNIX time
    Time in seconds
    s String buffer
    slen Date/time string

    Return Value

    -

    UNIX time

    +

    Time in seconds

     CUPS 2.0/OS 10.10 httpGetEncryption

    Get the current encryption mode of a connection.

    @@ -3079,18 +3080,6 @@ const char *httpGetField(http_t *http, Return Value

    Field value

    -

     DEPRECATED httpGetHostByName

    -

    Lookup a hostname or IPv4 address, and return -address records for the specified name.

    -

    -struct hostent *httpGetHostByName(const char *name);

    -

    Parameters

    - - - -
    nameHostname or IP address
    -

    Return Value

    -

    Host entry

     CUPS 1.2/macOS 10.5 httpGetHostname

    Get the FQDN for the connection or local system.

    @@ -3221,7 +3210,7 @@ char *httpGetSubField2(http_t *http, Size of value buffer

    Return Value

    -

    Value or NULL

    +

    Value or NULL

    httpGetVersion

    Get the HTTP version at the other end.

    @@ -3247,7 +3236,7 @@ char *httpGets(char *line, int length, http_t *http);

    HTTP connection

    Return Value

    -

    Line or NULL

    +

    Line or NULL

    httpHead

    Send a HEAD request to the server.

    @@ -3343,7 +3332,7 @@ ssize_t httpPeek(http_t *http, char *buffer, size_t length

    Discussion

    This function copies available data from the given HTTP connection, reading a buffer as needed. The data is still available for reading using -httpRead or httpRead2.
    +httpRead2.

    For non-blocking connections the usual timeouts apply. @@ -3498,9 +3487,10 @@ void httpSetAuthString(http_t *http, const char *scheme, c

    Discussion

    This function just stores a copy of the current authorization string in -the HTTP connection object. You must still call httpSetField() to set -HTTP_FIELD_AUTHORIZATION prior to issuing a HTTP request using httpGet(), -httpHead(), httpOptions(), httpPost, or httpPut(). +the HTTP connection object. You must still call httpSetField to set +HTTP_FIELD_AUTHORIZATION prior to issuing a HTTP request using +httpGet, httpHead, httpOptions, httpPost, or +httpPut.

     CUPS 1.1.19/macOS 10.3 httpSetCookie

    @@ -3610,7 +3600,7 @@ void httpSetTimeout(http_t *http, double timeout, Number of seconds for timeout, must be greater than 0 cb - Callback function or NULL + Callback function or NULL user_data User data pointer @@ -3652,20 +3642,7 @@ const char *httpStatus(http_status_t status);

    Localized status string

    Discussion

    The returned string is localized to the current POSIX locale and is based -on the status strings defined in RFC 2616.

    -

    httpTrace

    -

    Send an TRACE request to the server.

    -

    -int httpTrace(http_t *http, const char *uri);

    -

    Parameters

    - - - - - -
    httpHTTP connection
    uriURI for trace
    -

    Return Value

    -

    Status of call (0 = success)

    +on the status strings defined in RFC 7231.

     CUPS 2.0/OS 10.10 httpURIStatusString

    Return a string describing a URI status code.

    @@ -3842,7 +3819,7 @@ event notification (IPP_TAG_EVENT_NOTIFICATION), operation

    ippAddDate

    -

    Add a date attribute to an IPP message.

    +

    Add a dateTime attribute to an IPP message.

    ipp_attribute_t *ippAddDate(ipp_t *ipp, ipp_tag_t group, const char *name, const ipp_uchar_t *value);

    Parameters

    @@ -4372,7 +4349,7 @@ int ippContainsString(ipp_attribute_t *attr, cons

    1 on a match, 0 on no match

    Discussion

    Returns non-zero when the attribute contains a matching charset, keyword, -language, mimeMediaType, name, text, URI, or URI scheme value. +naturalLanguage, mimeMediaType, name, text, uri, or uriScheme value.

     CUPS 1.6/macOS 10.8 ippCopyAttribute

    @@ -4456,14 +4433,14 @@ using the cupsArrayDelete function.

    ippDateToTime

    -

    Convert from RFC 1903 Date/Time format to UNIX time -in seconds.

    +

    Convert from RFC 2579 Date/Time format to time in +seconds.

    time_t ippDateToTime(const ipp_uchar_t *date);

    Parameters

    - +
    dateRFC 1903 date info
    RFC 2579 date info

    Return Value

    UNIX time value

    @@ -4625,7 +4602,7 @@ int ippGetBoolean(ipp_attribute_t *attr, int elem

    Boolean value or 0 on error

    Discussion

    The element parameter specifies which value to get from 0 to -ippGetCount(attr) - 1. +ippGetCount(attr) - 1.

     CUPS 1.6/macOS 10.8 ippGetCollection

    @@ -4643,7 +4620,7 @@ int ippGetBoolean(ipp_attribute_t *attr, int elem

    Collection value or NULL on error

    Discussion

    The element parameter specifies which value to get from 0 to -ippGetCount(attr) - 1. +ippGetCount(attr) - 1.

     CUPS 1.6/macOS 10.8 ippGetCount

    @@ -4658,7 +4635,7 @@ int ippGetCount(ipp_attribute_t *attr);

    Return Value

    Number of values or 0 on error

     CUPS 1.6/macOS 10.8 ippGetDate

    -

    Get a date value for an attribute.

    +

    Get a dateTime value for an attribute.

    const ipp_uchar_t *ippGetDate(ipp_attribute_t *attr, int element);

    Parameters

    @@ -4669,10 +4646,10 @@ const ipp_uchar_t *ippGetDate(Value number (0-based)

    Return Value

    -

    Date value or NULL

    +

    dateTime value or NULL

    Discussion

    The element parameter specifies which value to get from 0 to -ippGetCount(attr) - 1. +ippGetCount(attr) - 1.

     CUPS 1.6/macOS 10.8 ippGetGroupTag

    @@ -4701,7 +4678,7 @@ int ippGetInteger(ipp_attribute_t *attr, int elem

    Value or 0 on error

    Discussion

    The element parameter specifies which value to get from 0 to -ippGetCount(attr) - 1. +ippGetCount(attr) - 1.

     CUPS 1.6/macOS 10.8 ippGetName

    @@ -4732,7 +4709,7 @@ void *ippGetOctetString(ipp_attribute_t *attr, in

    Pointer to octetString data

    Discussion

    The element parameter specifies which value to get from 0 to -ippGetCount(attr) - 1. +ippGetCount(attr) - 1.

     CUPS 1.6/macOS 10.8 ippGetOperation

    @@ -4763,7 +4740,7 @@ int ippGetRange(ipp_attribute_t *attr, int elemen

    Lower value of range or 0

    Discussion

    The element parameter specifies which value to get from 0 to -ippGetCount(attr) - 1. +ippGetCount(attr) - 1.

     CUPS 1.6/macOS 10.8 ippGetRequestId

    @@ -4796,7 +4773,7 @@ int ippGetResolution(ipp_attribute_t *attr, int e

    Horizontal/cross feed resolution or 0

    Discussion

    The element parameter specifies which value to get from 0 to -ippGetCount(attr) - 1. +ippGetCount(attr) - 1.

     CUPS 1.6/macOS 10.8 ippGetState

    @@ -4837,7 +4814,7 @@ const char *ippGetString(ipp_attribute_t *attr, i

    Return Value

    Get the string and optionally the language code for an attribute.

    The element parameter specifies which value to get from 0 to -ippGetCount(attr) - 1. +ippGetCount(attr) - 1.

     CUPS 1.6/macOS 10.8 ippGetValueTag

    @@ -4860,7 +4837,7 @@ int ippGetVersion(ipp_t *ipp, int *minor);

    ipp IPP message minor - Minor version number or NULL + Minor version number or NULL for don't care

    Return Value

    Major version number or 0 on error

    @@ -4893,9 +4870,9 @@ size_t ippLength(ipp_t *ipp);

    Return Value

    IPP request message

    Discussion

    -

    The new request message is initialized with the attributes-charset and -attributes-natural-language attributes added. The -attributes-natural-language value is derived from the current locale. +

    The new request message is initialized with the "attributes-charset" and +"attributes-natural-language" attributes added. The +"attributes-natural-language" value is derived from the current locale.

     CUPS 1.7/macOS 10.9 ippNewResponse

    @@ -4910,11 +4887,11 @@ attributes-natural-language value is derived from the current locale.

    Return Value

    IPP response message

    Discussion

    -

    The new response message is initialized with the same version-number, -request-id, attributes-charset, and attributes-natural-language as the -provided request message. If the attributes-charset or -attributes-natural-language attributes are missing from the request, -"utf-8" and a value derived from the current locale are substituted, +

    The new response message is initialized with the same "version-number", +"request-id", "attributes-charset", and "attributes-natural-language" as the +provided request message. If the "attributes-charset" or +"attributes-natural-language" attributes are missing from the request, +'utf-8' and a value derived from the current locale are substituted, respectively.

    @@ -5026,7 +5003,7 @@ the ippNew, ip The attr parameter may be modified as a result of setting the value.

    The element parameter specifies which value to set from 0 to -    ippGetCount(attr). +ippGetCount(attr).

     CUPS 1.6/macOS 10.8 ippSetCollection

    @@ -5053,11 +5030,11 @@ the ippNew, ip The attr parameter may be modified as a result of setting the value.

    The element parameter specifies which value to set from 0 to -    ippGetCount(attr). +ippGetCount(attr).

     CUPS 1.6/macOS 10.8 ippSetDate

    -

    Set a date value in an attribute.

    +

    Set a dateTime value in an attribute.

    int ippSetDate(ipp_t *ipp, ipp_attribute_t **attr, int element, const ipp_uchar_t *datevalue);

    Parameters

    @@ -5069,7 +5046,7 @@ int ippSetDate(ipp_t *ipp, ipp_a element Value number (0-based) datevalue - Date value + dateTime value

    Return Value

    1 on success, 0 on failure

    @@ -5080,7 +5057,7 @@ the     ippNew, ip The attr parameter may be modified as a result of setting the value.

    The element parameter specifies which value to set from 0 to -    ippGetCount(attr). +ippGetCount(attr).

     CUPS 1.6/macOS 10.8 ippSetGroupTag

    @@ -5135,7 +5112,7 @@ the ippNew, ip The attr parameter may be modified as a result of setting the value.

    The element parameter specifies which value to set from 0 to -    ippGetCount(attr). +ippGetCount(attr).

     CUPS 1.6/macOS 10.8 ippSetName

    @@ -5186,7 +5163,7 @@ the ippNew, ip The attr parameter may be modified as a result of setting the value.

    The element parameter specifies which value to set from 0 to -    ippGetCount(attr). +ippGetCount(attr).

     CUPS 1.6/macOS 10.8 ippSetOperation

    @@ -5242,7 +5219,7 @@ the ippNew, ip The attr parameter may be modified as a result of setting the value.

    The element parameter specifies which value to set from 0 to -    ippGetCount(attr). +ippGetCount(attr).

     CUPS 1.6/macOS 10.8 ippSetRequestId

    @@ -5293,7 +5270,7 @@ the ippNew, ip The attr parameter may be modified as a result of setting the value.

    The element parameter specifies which value to set from 0 to -    ippGetCount(attr). +ippGetCount(attr).

     CUPS 1.6/macOS 10.8 ippSetState

    @@ -5351,7 +5328,7 @@ the ippNew, ip The attr parameter may be modified as a result of setting the value.

    The element parameter specifies which value to set from 0 to -    ippGetCount(attr). +ippGetCount(attr).

     CUPS 1.7/macOS 10.9 ippSetStringf

    @@ -5380,7 +5357,7 @@ the ippNew, ip The attr parameter may be modified as a result of setting the value.

    The element parameter specifies which value to set from 0 to -    ippGetCount(attr).
    +ippGetCount(attr).

    The format parameter uses formatting characters compatible with the printf family of standard functions. Additional arguments follow it as @@ -5414,7 +5391,7 @@ the ippNew, ip The attr parameter may be modified as a result of setting the value.

    The element parameter specifies which value to set from 0 to -    ippGetCount(attr).
    +ippGetCount(attr).

    The format parameter uses formatting characters compatible with the printf family of standard functions. Additional arguments follow it as @@ -5501,7 +5478,7 @@ const char *ippTagString(ipp_tag_t tag);

    Return Value

    Tag name

    Discussion

    -

    The returned names are defined in RFC 2911 and 3382. +

    The returned names are defined in RFC 8011 and the IANA IPP Registry.

     CUPS 1.4/macOS 10.6 ippTagValue

    @@ -5516,20 +5493,20 @@ ipp_tag_t ippTagValue(const char *name);

    Return Value

    Tag value

    Discussion

    -

    The tag names are defined in RFC 2911 and 3382. +

    The tag names are defined in RFC 8011 and the IANA IPP Registry.

    ippTimeToDate

    -

    Convert from UNIX time to RFC 1903 format.

    +

    Convert from time in seconds to RFC 2579 format.

    const ipp_uchar_t *ippTimeToDate(time_t t);

    Parameters

    - +
    tUNIX time value
    Time in seconds

    Return Value

    -

    RFC-1903 date/time data

    +

    RFC-2579 date/time data

     CUPS 1.7/macOS 10.9 ippValidateAttribute

    Validate the contents of an attribute.

    @@ -5544,7 +5521,7 @@ int ippValidateAttribute(ipp_attribute_t *attr);<

    Discussion

    This function validates the contents of an attribute based on the name and value tag. 1 is returned if the attribute is valid, 0 otherwise. On -failure, cupsLastErrorString() is set to a human-readable message. +failure, cupsLastErrorString is set to a human-readable message.

     CUPS 1.7/macOS 10.9 ippValidateAttributes

    @@ -5560,8 +5537,8 @@ int ippValidateAttributes(ipp_t *ipp);

    1 if valid, 0 otherwise

    Discussion

    This function validates the contents of the IPP message, including each -attribute. Like ippValidateAttribute, cupsLastErrorString() is set -to a human-readable message on failure. +attribute. Like ippValidateAttribute, cupsLastErrorString is +set to a human-readable message on failure.

    ippWrite

    @@ -5729,15 +5706,13 @@ typedef enum http_uri_status_e http_uri_status_

    typedef struct _ipp_attribute_s ipp_attribute_t;

    -

    ipp_copycb_t

    -

    The following structures are PRIVATE starting with CUPS 1.6/macOS 10.8. -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.

    +

     CUPS 1.6/macOS 10.8 ipp_copycb_t

    +

    ippCopyAttributes callback function

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

     CUPS 1.2/macOS 10.5 ipp_iocb_t

    -

    IPP IO Callback Function

    +

    ippReadIO/ippWriteIO callback function

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

    @@ -5747,12 +5722,12 @@ typedef ssize_t(*)(void *context, ipp_uchar_t *buffer, size_t bytes) ipp_iocb_t; typedef enum ipp_orient_e ipp_orient_t;

    ipp_pstate_t

    -

    Printer states

    +

    Printer state values

    typedef enum ipp_pstate_e ipp_pstate_t;

    ipp_quality_t

    -

    Qualities

    +

    Print quality values

    typedef enum ipp_quality_e ipp_quality_t;

    @@ -5762,7 +5737,7 @@ typedef enum ipp_quality_e ipp_quality_t; typedef enum ipp_res_e ipp_res_t;

    ipp_state_t

    -

    IPP states

    +

    ipp_t state values

    typedef enum ipp_state_e ipp_state_t;

    @@ -6221,7 +6196,7 @@ are server-oriented...

    IPP_ORIENT_REVERSE_PORTRAIT 180 degrees

    ipp_pstate_e

    -

    Printer states

    +

    Printer state values

    Constants

    @@ -6229,7 +6204,7 @@ are server-oriented...

    IPP_PSTATE_IDLE Printer is idle
    IPP_PSTATE_STOPPED Printer is stopped

    ipp_quality_e

    -

    Qualities

    +

    Print quality values

    Constants

    @@ -6244,7 +6219,7 @@ are server-oriented...

    IPP_QUALITY_DRAFT Draft quality
    IPP_RES_PER_INCH Pixels per inch

    ipp_state_e

    -

    IPP states

    +

    ipp_t state values

    Constants

    @@ -6254,7 +6229,7 @@ are server-oriented...

    IPP_STATE_ATTRIBUTE One or more attributes need to be sent/received
    IPP_STATE_IDLE Nothing is happening/request completed

    ipp_status_e

    -

    IPP status codes

    +

    IPP status code values

    Constants

    @@ -6317,7 +6292,7 @@ are server-oriented...

    IPP_STATUS_CUPS_INVALID Invalid status name for ippErrorValue
    IPP_STATUS_OK_TOO_MANY_EVENTS successful-ok-too-many-events

    ipp_tag_e

    -

    Format tags for attributes

    +

    Value and group tag values for attributes

    Constants

    diff --git a/xcode/CUPS.xcodeproj/project.pbxproj b/xcode/CUPS.xcodeproj/project.pbxproj index 6629a73c34..2edef83435 100644 --- a/xcode/CUPS.xcodeproj/project.pbxproj +++ b/xcode/CUPS.xcodeproj/project.pbxproj @@ -4897,8 +4897,8 @@ 72220EDE133305BB00FCA411 /* http-addr.c */, 72220EDF133305BB00FCA411 /* http-addrlist.c */, 72220EE1133305BB00FCA411 /* http-support.c */, - 72220EE5133305BB00FCA411 /* ipp-support.c */, 72220EE6133305BB00FCA411 /* ipp.c */, + 72220EE5133305BB00FCA411 /* ipp-support.c */, 72220EE8133305BB00FCA411 /* langprintf.c */, 72220EEA133305BB00FCA411 /* language.c */, 72220EEF133305BB00FCA411 /* md5.c */,
    IPP_TAG_ADMINDEFINE Admin-defined value