From: Michael R Sweet Date: Thu, 5 Oct 2023 15:55:02 +0000 (-0400) Subject: Update documentation. X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=af268786e973d953bacd2670e96f0cbb51ec8e4c;p=thirdparty%2Fcups.git Update documentation. --- diff --git a/cups/cupspm.md b/cups/cupspm.md index c55d2f124f..d963d42a21 100644 --- a/cups/cupspm.md +++ b/cups/cupspm.md @@ -2,7 +2,7 @@ title: CUPS Programming Manual author: Michael R Sweet copyright: Copyright © 2021-2023 by OpenPrinting. All Rights Reserved. -version: 2.4.0 +version: 2.5.0 ... > Please [file issues on GitHub](https://github.com/openprinting/cups/issues) to @@ -158,31 +158,31 @@ The `type` and `mask` arguments are bitfields that allow the caller to filter the destinations based on categories and/or capabilities. The destination's "printer-type" value is masked by the `mask` value and compared to the `type` value when filtering. For example, to only enumerate destinations that are -hosted on the local system, pass `CUPS_PRINTER_LOCAL` for the `type` argument -and `CUPS_PRINTER_DISCOVERED` for the `mask` argument. The following constants +hosted on the local system, pass `CUPS_PTYPE_LOCAL` for the `type` argument +and `CUPS_PTYPE_DISCOVERED` for the `mask` argument. The following constants can be used for filtering: -- `CUPS_PRINTER_CLASS`: A collection of destinations. -- `CUPS_PRINTER_FAX`: A facsimile device. -- `CUPS_PRINTER_LOCAL`: A local printer or class. This constant has the value 0 +- `CUPS_PTYPE_CLASS`: A collection of destinations. +- `CUPS_PTYPE_FAX`: A facsimile device. +- `CUPS_PTYPE_LOCAL`: A local printer or class. This constant has the value 0 (no bits set) and is only used for the `type` argument and is paired with the - `CUPS_PRINTER_REMOTE` or `CUPS_PRINTER_DISCOVERED` constant passed in the + `CUPS_PTYPE_REMOTE` or `CUPS_PTYPE_DISCOVERED` constant passed in the `mask` argument. -- `CUPS_PRINTER_REMOTE`: A remote (shared) printer or class. -- `CUPS_PRINTER_DISCOVERED`: An available network printer or class. -- `CUPS_PRINTER_BW`: Can do B&W printing. -- `CUPS_PRINTER_COLOR`: Can do color printing. -- `CUPS_PRINTER_DUPLEX`: Can do two-sided printing. -- `CUPS_PRINTER_STAPLE`: Can staple output. -- `CUPS_PRINTER_COLLATE`: Can quickly collate copies. -- `CUPS_PRINTER_PUNCH`: Can punch output. -- `CUPS_PRINTER_COVER`: Can cover output. -- `CUPS_PRINTER_BIND`: Can bind output. -- `CUPS_PRINTER_SORT`: Can sort output (mailboxes, etc.) -- `CUPS_PRINTER_SMALL`: Can print on Letter/Legal/A4-size media. -- `CUPS_PRINTER_MEDIUM`: Can print on Tabloid/B/C/A3/A2-size media. -- `CUPS_PRINTER_LARGE`: Can print on D/E/A1/A0-size media. -- `CUPS_PRINTER_VARIABLE`: Can print on rolls and custom-size media. +- `CUPS_PTYPE_REMOTE`: A remote (shared) printer or class. +- `CUPS_PTYPE_DISCOVERED`: An available network printer or class. +- `CUPS_PTYPE_BW`: Can do B&W printing. +- `CUPS_PTYPE_COLOR`: Can do color printing. +- `CUPS_PTYPE_DUPLEX`: Can do two-sided printing. +- `CUPS_PTYPE_STAPLE`: Can staple output. +- `CUPS_PTYPE_COLLATE`: Can quickly collate copies. +- `CUPS_PTYPE_PUNCH`: Can punch output. +- `CUPS_PTYPE_COVER`: Can cover output. +- `CUPS_PTYPE_BIND`: Can bind output. +- `CUPS_PTYPE_SORT`: Can sort output (mailboxes, etc.) +- `CUPS_PTYPE_SMALL`: Can print on Letter/Legal/A4-size media. +- `CUPS_PTYPE_MEDIUM`: Can print on Tabloid/B/C/A3/A2-size media. +- `CUPS_PTYPE_LARGE`: Can print on D/E/A1/A0-size media. +- `CUPS_PTYPE_VARIABLE`: Can print on rolls and custom-size media. The `cb` argument specifies a function to call for every destination that is found: diff --git a/doc/help/api-admin.html b/doc/help/api-admin.html index d5e9ff5ab4..aedbdc34de 100644 --- a/doc/help/api-admin.html +++ b/doc/help/api-admin.html @@ -499,8 +499,7 @@ being provided by the cupsEnumDests an

Data Types

 CUPS 1.4/macOS 10.6 cups_device_cb_t

-

Device callback -

+

Device callback

typedef void (*cups_device_cb_t)(const char *device_class, const char *device_id, const char *device_info, const char *device_make_and_model, const char *device_uri, const char *device_location, void *user_data);

diff --git a/doc/help/api-ppd.html b/doc/help/api-ppd.html index 8873a6cd55..b9fca20d58 100644 --- a/doc/help/api-ppd.html +++ b/doc/help/api-ppd.html @@ -340,43 +340,20 @@ span.string {
  • ppd_attr_t
  • ppd_choice_t
  • ppd_conform_t
    • -
  • ppd_const_t
    • -
  • ppd_coption_t
    • -
  • ppd_cparam_t
    • -
  • ppd_cplimit_t
    • -
  • ppd_cptype_t
    • -
  • ppd_cpvalue_t
  • ppd_cs_t
    • -
  • ppd_emul_t
    • -
  • ppd_file_t
    • -
  • ppd_group_t
  • ppd_option_t
    • -
  • ppd_profile_t
  • ppd_section_t
    • -
  • ppd_size_t
  • ppd_status_t
  • ppd_ui_t
  • Structures
    • -
  • Unions
  • Enumerations