From 4aa3ab79a9457660816a3c046da6d2b3924bf920 Mon Sep 17 00:00:00 2001
From: Michael R Sweet
Date: Fri, 28 Mar 2025 15:06:41 -0400
Subject: [PATCH] Update docos/web page for libcups 3.0rc4.
---
Gemfile.lock | 411 +++++++++++++----------
cups-local/index.html | 1 -
cups3.html | 11 +-
{cups-local => libcups}/client.conf.html | 120 +++++--
libcups/cups-oauth.html | 252 ++++++++++++++
libcups/cups-x509.html | 250 ++++++++++++++
libcups/cupspm.epub | Bin 391499 -> 391497 bytes
libcups/cupspm.html | 10 +-
libcups/index.html | 4 +
libcups/libcups.html | 110 ++++++
10 files changed, 961 insertions(+), 208 deletions(-)
rename {cups-local => libcups}/client.conf.html (59%)
create mode 100644 libcups/cups-oauth.html
create mode 100644 libcups/cups-x509.html
create mode 100644 libcups/libcups.html
diff --git a/Gemfile.lock b/Gemfile.lock
index e21e891007..3042a705a4 100644
--- a/Gemfile.lock
+++ b/Gemfile.lock
@@ -1,248 +1,309 @@
GEM
remote: https://rubygems.org/
specs:
- activesupport (4.2.10)
- i18n (~> 0.7)
- minitest (~> 5.1)
- thread_safe (~> 0.3, >= 0.3.4)
- tzinfo (~> 1.1)
- addressable (2.5.2)
- public_suffix (>= 2.0.2, < 4.0)
+ activesupport (8.0.2)
+ base64
+ benchmark (>= 0.3)
+ bigdecimal
+ concurrent-ruby (~> 1.0, >= 1.3.1)
+ connection_pool (>= 2.2.5)
+ drb
+ i18n (>= 1.6, < 2)
+ logger (>= 1.4.2)
+ minitest (>= 5.1)
+ securerandom (>= 0.3)
+ tzinfo (~> 2.0, >= 2.0.5)
+ uri (>= 0.13.1)
+ addressable (2.8.7)
+ public_suffix (>= 2.0.2, < 7.0)
+ base64 (0.2.0)
+ benchmark (0.4.0)
+ bigdecimal (3.1.9)
coffee-script (2.4.1)
coffee-script-source
execjs
- coffee-script-source (1.11.1)
+ coffee-script-source (1.12.2)
colorator (1.1.0)
- commonmarker (0.17.13)
- ruby-enum (~> 0.5)
- concurrent-ruby (1.1.3)
- dnsruby (1.61.2)
- addressable (~> 2.5)
- em-websocket (0.5.1)
+ commonmarker (0.23.11)
+ concurrent-ruby (1.3.5)
+ connection_pool (2.5.0)
+ csv (3.3.3)
+ dnsruby (1.72.4)
+ base64 (~> 0.2.0)
+ logger (~> 1.6.5)
+ simpleidn (~> 0.2.1)
+ drb (2.2.1)
+ em-websocket (0.5.3)
eventmachine (>= 0.12.9)
- http_parser.rb (~> 0.6.0)
- ethon (0.11.0)
- ffi (>= 1.3.0)
+ http_parser.rb (~> 0)
+ ethon (0.16.0)
+ ffi (>= 1.15.0)
eventmachine (1.2.7)
- execjs (2.7.0)
- faraday (0.15.4)
- multipart-post (>= 1.2, < 3)
- ffi (1.15.5)
+ execjs (2.10.0)
+ faraday (2.12.2)
+ faraday-net_http (>= 2.0, < 3.5)
+ json
+ logger
+ faraday-net_http (3.4.0)
+ net-http (>= 0.5.0)
+ ffi (1.17.1-aarch64-linux-gnu)
+ ffi (1.17.1-aarch64-linux-musl)
+ ffi (1.17.1-arm-linux-gnu)
+ ffi (1.17.1-arm-linux-musl)
+ ffi (1.17.1-arm64-darwin)
+ ffi (1.17.1-x86_64-darwin)
+ ffi (1.17.1-x86_64-linux-gnu)
+ ffi (1.17.1-x86_64-linux-musl)
forwardable-extended (2.6.0)
- gemoji (3.0.0)
- github-pages (193)
- activesupport (= 4.2.10)
- github-pages-health-check (= 1.8.1)
- jekyll (= 3.7.4)
- jekyll-avatar (= 0.6.0)
- jekyll-coffeescript (= 1.1.1)
- jekyll-commonmark-ghpages (= 0.1.5)
- jekyll-default-layout (= 0.1.4)
- jekyll-feed (= 0.11.0)
+ gemoji (4.1.0)
+ github-pages (232)
+ github-pages-health-check (= 1.18.2)
+ jekyll (= 3.10.0)
+ jekyll-avatar (= 0.8.0)
+ jekyll-coffeescript (= 1.2.2)
+ jekyll-commonmark-ghpages (= 0.5.1)
+ jekyll-default-layout (= 0.1.5)
+ jekyll-feed (= 0.17.0)
jekyll-gist (= 1.5.0)
- jekyll-github-metadata (= 2.9.4)
- jekyll-mentions (= 1.4.1)
- jekyll-optional-front-matter (= 0.3.0)
+ jekyll-github-metadata (= 2.16.1)
+ jekyll-include-cache (= 0.2.1)
+ jekyll-mentions (= 1.6.0)
+ jekyll-optional-front-matter (= 0.3.2)
jekyll-paginate (= 1.1.0)
- jekyll-readme-index (= 0.2.0)
- jekyll-redirect-from (= 0.14.0)
- jekyll-relative-links (= 0.5.3)
- jekyll-remote-theme (= 0.3.1)
+ jekyll-readme-index (= 0.3.0)
+ jekyll-redirect-from (= 0.16.0)
+ jekyll-relative-links (= 0.6.1)
+ jekyll-remote-theme (= 0.4.3)
jekyll-sass-converter (= 1.5.2)
- jekyll-seo-tag (= 2.5.0)
- jekyll-sitemap (= 1.2.0)
- jekyll-swiss (= 0.4.0)
- jekyll-theme-architect (= 0.1.1)
- jekyll-theme-cayman (= 0.1.1)
- jekyll-theme-dinky (= 0.1.1)
- jekyll-theme-hacker (= 0.1.1)
- jekyll-theme-leap-day (= 0.1.1)
- jekyll-theme-merlot (= 0.1.1)
- jekyll-theme-midnight (= 0.1.1)
- jekyll-theme-minimal (= 0.1.1)
- jekyll-theme-modernist (= 0.1.1)
- jekyll-theme-primer (= 0.5.3)
- jekyll-theme-slate (= 0.1.1)
- jekyll-theme-tactile (= 0.1.1)
- jekyll-theme-time-machine (= 0.1.1)
- jekyll-titles-from-headings (= 0.5.1)
- jemoji (= 0.10.1)
- kramdown (= 1.17.0)
- liquid (= 4.0.0)
- listen (= 3.1.5)
+ jekyll-seo-tag (= 2.8.0)
+ jekyll-sitemap (= 1.4.0)
+ jekyll-swiss (= 1.0.0)
+ jekyll-theme-architect (= 0.2.0)
+ jekyll-theme-cayman (= 0.2.0)
+ jekyll-theme-dinky (= 0.2.0)
+ jekyll-theme-hacker (= 0.2.0)
+ jekyll-theme-leap-day (= 0.2.0)
+ jekyll-theme-merlot (= 0.2.0)
+ jekyll-theme-midnight (= 0.2.0)
+ jekyll-theme-minimal (= 0.2.0)
+ jekyll-theme-modernist (= 0.2.0)
+ jekyll-theme-primer (= 0.6.0)
+ jekyll-theme-slate (= 0.2.0)
+ jekyll-theme-tactile (= 0.2.0)
+ jekyll-theme-time-machine (= 0.2.0)
+ jekyll-titles-from-headings (= 0.5.3)
+ jemoji (= 0.13.0)
+ kramdown (= 2.4.0)
+ kramdown-parser-gfm (= 1.1.0)
+ liquid (= 4.0.4)
mercenary (~> 0.3)
- minima (= 2.5.0)
- nokogiri (>= 1.8.2, < 2.0)
- rouge (= 2.2.1)
+ minima (= 2.5.1)
+ nokogiri (>= 1.16.2, < 2.0)
+ rouge (= 3.30.0)
terminal-table (~> 1.4)
- github-pages-health-check (1.8.1)
+ webrick (~> 1.8)
+ github-pages-health-check (1.18.2)
addressable (~> 2.3)
dnsruby (~> 1.60)
- octokit (~> 4.0)
- public_suffix (~> 2.0)
+ octokit (>= 4, < 8)
+ public_suffix (>= 3.0, < 6.0)
typhoeus (~> 1.3)
- html-pipeline (2.9.1)
+ html-pipeline (2.14.3)
activesupport (>= 2)
nokogiri (>= 1.4)
- http_parser.rb (0.6.0)
- i18n (0.9.5)
+ http_parser.rb (0.8.0)
+ i18n (1.14.7)
concurrent-ruby (~> 1.0)
- jekyll (3.7.4)
+ jekyll (3.10.0)
addressable (~> 2.4)
colorator (~> 1.0)
+ csv (~> 3.0)
em-websocket (~> 0.5)
- i18n (~> 0.7)
+ i18n (>= 0.7, < 2)
jekyll-sass-converter (~> 1.0)
jekyll-watch (~> 2.0)
- kramdown (~> 1.14)
+ kramdown (>= 1.17, < 3)
liquid (~> 4.0)
mercenary (~> 0.3.3)
pathutil (~> 0.9)
rouge (>= 1.7, < 4)
safe_yaml (~> 1.0)
- jekyll-avatar (0.6.0)
- jekyll (~> 3.0)
- jekyll-coffeescript (1.1.1)
+ webrick (>= 1.0)
+ jekyll-avatar (0.8.0)
+ jekyll (>= 3.0, < 5.0)
+ jekyll-coffeescript (1.2.2)
coffee-script (~> 2.2)
- coffee-script-source (~> 1.11.1)
- jekyll-commonmark (1.2.0)
- commonmarker (~> 0.14)
- jekyll (>= 3.0, < 4.0)
- jekyll-commonmark-ghpages (0.1.5)
- commonmarker (~> 0.17.6)
- jekyll-commonmark (~> 1)
- rouge (~> 2)
- jekyll-default-layout (0.1.4)
- jekyll (~> 3.0)
- jekyll-feed (0.11.0)
- jekyll (~> 3.3)
+ coffee-script-source (~> 1.12)
+ jekyll-commonmark (1.4.0)
+ commonmarker (~> 0.22)
+ jekyll-commonmark-ghpages (0.5.1)
+ commonmarker (>= 0.23.7, < 1.1.0)
+ jekyll (>= 3.9, < 4.0)
+ jekyll-commonmark (~> 1.4.0)
+ rouge (>= 2.0, < 5.0)
+ jekyll-default-layout (0.1.5)
+ jekyll (>= 3.0, < 5.0)
+ jekyll-feed (0.17.0)
+ jekyll (>= 3.7, < 5.0)
jekyll-gist (1.5.0)
octokit (~> 4.2)
- jekyll-github-metadata (2.9.4)
- jekyll (~> 3.1)
- octokit (~> 4.0, != 4.4.0)
- jekyll-mentions (1.4.1)
+ jekyll-github-metadata (2.16.1)
+ jekyll (>= 3.4, < 5.0)
+ octokit (>= 4, < 7, != 4.4.0)
+ jekyll-include-cache (0.2.1)
+ jekyll (>= 3.7, < 5.0)
+ jekyll-mentions (1.6.0)
html-pipeline (~> 2.3)
- jekyll (~> 3.0)
- jekyll-optional-front-matter (0.3.0)
- jekyll (~> 3.0)
+ jekyll (>= 3.7, < 5.0)
+ jekyll-optional-front-matter (0.3.2)
+ jekyll (>= 3.0, < 5.0)
jekyll-paginate (1.1.0)
- jekyll-readme-index (0.2.0)
- jekyll (~> 3.0)
- jekyll-redirect-from (0.14.0)
- jekyll (~> 3.3)
- jekyll-relative-links (0.5.3)
- jekyll (~> 3.3)
- jekyll-remote-theme (0.3.1)
- jekyll (~> 3.5)
- rubyzip (>= 1.2.1, < 3.0)
+ jekyll-readme-index (0.3.0)
+ jekyll (>= 3.0, < 5.0)
+ jekyll-redirect-from (0.16.0)
+ jekyll (>= 3.3, < 5.0)
+ jekyll-relative-links (0.6.1)
+ jekyll (>= 3.3, < 5.0)
+ jekyll-remote-theme (0.4.3)
+ addressable (~> 2.0)
+ jekyll (>= 3.5, < 5.0)
+ jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0)
+ rubyzip (>= 1.3.0, < 3.0)
jekyll-sass-converter (1.5.2)
sass (~> 3.4)
- jekyll-seo-tag (2.5.0)
- jekyll (~> 3.3)
- jekyll-sitemap (1.2.0)
- jekyll (~> 3.3)
- jekyll-swiss (0.4.0)
- jekyll-theme-architect (0.1.1)
- jekyll (~> 3.5)
+ jekyll-seo-tag (2.8.0)
+ jekyll (>= 3.8, < 5.0)
+ jekyll-sitemap (1.4.0)
+ jekyll (>= 3.7, < 5.0)
+ jekyll-swiss (1.0.0)
+ jekyll-theme-architect (0.2.0)
+ jekyll (> 3.5, < 5.0)
jekyll-seo-tag (~> 2.0)
- jekyll-theme-cayman (0.1.1)
- jekyll (~> 3.5)
+ jekyll-theme-cayman (0.2.0)
+ jekyll (> 3.5, < 5.0)
jekyll-seo-tag (~> 2.0)
- jekyll-theme-dinky (0.1.1)
- jekyll (~> 3.5)
+ jekyll-theme-dinky (0.2.0)
+ jekyll (> 3.5, < 5.0)
jekyll-seo-tag (~> 2.0)
- jekyll-theme-hacker (0.1.1)
- jekyll (~> 3.5)
+ jekyll-theme-hacker (0.2.0)
+ jekyll (> 3.5, < 5.0)
jekyll-seo-tag (~> 2.0)
- jekyll-theme-leap-day (0.1.1)
- jekyll (~> 3.5)
+ jekyll-theme-leap-day (0.2.0)
+ jekyll (> 3.5, < 5.0)
jekyll-seo-tag (~> 2.0)
- jekyll-theme-merlot (0.1.1)
- jekyll (~> 3.5)
+ jekyll-theme-merlot (0.2.0)
+ jekyll (> 3.5, < 5.0)
jekyll-seo-tag (~> 2.0)
- jekyll-theme-midnight (0.1.1)
- jekyll (~> 3.5)
+ jekyll-theme-midnight (0.2.0)
+ jekyll (> 3.5, < 5.0)
jekyll-seo-tag (~> 2.0)
- jekyll-theme-minimal (0.1.1)
- jekyll (~> 3.5)
+ jekyll-theme-minimal (0.2.0)
+ jekyll (> 3.5, < 5.0)
jekyll-seo-tag (~> 2.0)
- jekyll-theme-modernist (0.1.1)
- jekyll (~> 3.5)
+ jekyll-theme-modernist (0.2.0)
+ jekyll (> 3.5, < 5.0)
jekyll-seo-tag (~> 2.0)
- jekyll-theme-primer (0.5.3)
- jekyll (~> 3.5)
+ jekyll-theme-primer (0.6.0)
+ jekyll (> 3.5, < 5.0)
jekyll-github-metadata (~> 2.9)
jekyll-seo-tag (~> 2.0)
- jekyll-theme-slate (0.1.1)
- jekyll (~> 3.5)
+ jekyll-theme-slate (0.2.0)
+ jekyll (> 3.5, < 5.0)
jekyll-seo-tag (~> 2.0)
- jekyll-theme-tactile (0.1.1)
- jekyll (~> 3.5)
+ jekyll-theme-tactile (0.2.0)
+ jekyll (> 3.5, < 5.0)
jekyll-seo-tag (~> 2.0)
- jekyll-theme-time-machine (0.1.1)
- jekyll (~> 3.5)
+ jekyll-theme-time-machine (0.2.0)
+ jekyll (> 3.5, < 5.0)
jekyll-seo-tag (~> 2.0)
- jekyll-titles-from-headings (0.5.1)
- jekyll (~> 3.3)
- jekyll-watch (2.1.2)
+ jekyll-titles-from-headings (0.5.3)
+ jekyll (>= 3.3, < 5.0)
+ jekyll-watch (2.2.1)
listen (~> 3.0)
- jemoji (0.10.1)
- gemoji (~> 3.0)
+ jemoji (0.13.0)
+ gemoji (>= 3, < 5)
html-pipeline (~> 2.2)
- jekyll (~> 3.0)
- kramdown (1.17.0)
- liquid (4.0.0)
- listen (3.1.5)
- rb-fsevent (~> 0.9, >= 0.9.4)
- rb-inotify (~> 0.9, >= 0.9.7)
- ruby_dep (~> 1.2)
+ jekyll (>= 3.0, < 5.0)
+ json (2.10.2)
+ kramdown (2.4.0)
+ rexml
+ kramdown-parser-gfm (1.1.0)
+ kramdown (~> 2.0)
+ liquid (4.0.4)
+ listen (3.9.0)
+ rb-fsevent (~> 0.10, >= 0.10.3)
+ rb-inotify (~> 0.9, >= 0.9.10)
+ logger (1.6.6)
mercenary (0.3.6)
- mini_portile2 (2.3.0)
- minima (2.5.0)
- jekyll (~> 3.5)
+ minima (2.5.1)
+ jekyll (>= 3.5, < 5.0)
jekyll-feed (~> 0.9)
jekyll-seo-tag (~> 2.1)
- minitest (5.11.3)
- multipart-post (2.0.0)
- nokogiri (1.8.5)
- mini_portile2 (~> 2.3.0)
- octokit (4.13.0)
- sawyer (~> 0.8.0, >= 0.5.3)
+ minitest (5.25.5)
+ net-http (0.6.0)
+ uri
+ nokogiri (1.18.6-aarch64-linux-gnu)
+ racc (~> 1.4)
+ nokogiri (1.18.6-aarch64-linux-musl)
+ racc (~> 1.4)
+ nokogiri (1.18.6-arm-linux-gnu)
+ racc (~> 1.4)
+ nokogiri (1.18.6-arm-linux-musl)
+ racc (~> 1.4)
+ nokogiri (1.18.6-arm64-darwin)
+ racc (~> 1.4)
+ nokogiri (1.18.6-x86_64-darwin)
+ racc (~> 1.4)
+ nokogiri (1.18.6-x86_64-linux-gnu)
+ racc (~> 1.4)
+ nokogiri (1.18.6-x86_64-linux-musl)
+ racc (~> 1.4)
+ octokit (4.25.1)
+ faraday (>= 1, < 3)
+ sawyer (~> 0.9)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
- public_suffix (2.0.5)
- rb-fsevent (0.10.3)
- rb-inotify (0.9.10)
- ffi (>= 0.5.0, < 2)
- rouge (2.2.1)
- ruby-enum (0.7.2)
- i18n
- ruby_dep (1.5.0)
- rubyzip (1.2.2)
- safe_yaml (1.0.4)
- sass (3.7.2)
+ public_suffix (5.1.1)
+ racc (1.8.1)
+ rb-fsevent (0.11.2)
+ rb-inotify (0.11.1)
+ ffi (~> 1.0)
+ rexml (3.4.1)
+ rouge (3.30.0)
+ rubyzip (2.4.1)
+ safe_yaml (1.0.5)
+ sass (3.7.4)
sass-listen (~> 4.0.0)
sass-listen (4.0.0)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
- sawyer (0.8.1)
- addressable (>= 2.3.5, < 2.6)
- faraday (~> 0.8, < 1.0)
+ sawyer (0.9.2)
+ addressable (>= 2.3.5)
+ faraday (>= 0.17.3, < 3)
+ securerandom (0.4.1)
+ simpleidn (0.2.3)
terminal-table (1.8.0)
unicode-display_width (~> 1.1, >= 1.1.1)
- thread_safe (0.3.6)
- typhoeus (1.3.1)
+ typhoeus (1.4.1)
ethon (>= 0.9.0)
- tzinfo (1.2.5)
- thread_safe (~> 0.1)
- unicode-display_width (1.4.0)
+ tzinfo (2.0.6)
+ concurrent-ruby (~> 1.0)
+ unicode-display_width (1.8.0)
+ uri (1.0.3)
+ webrick (1.9.1)
PLATFORMS
- ruby
+ aarch64-linux-gnu
+ aarch64-linux-musl
+ arm-linux-gnu
+ arm-linux-musl
+ arm64-darwin
+ x86_64-darwin
+ x86_64-linux-gnu
+ x86_64-linux-musl
DEPENDENCIES
github-pages
BUNDLED WITH
- 1.17.2
+ 2.6.6
diff --git a/cups-local/index.html b/cups-local/index.html
index 9d1e483b6d..e9be669126 100644
--- a/cups-local/index.html
+++ b/cups-local/index.html
@@ -74,7 +74,6 @@ table.figure tbody td {
Man Pages
- cancel(1) - cancel jobs: HTML
- - client.conf(5) - client configuration file for cups: HTML
- cups(1) - a standards-based, open source printing system: HTML
- cupsaccept/cupsreject(8) - accept/reject jobs sent to a destination: HTML
- cupsdisable, cupsenable(8) - stop/start printers and classes: HTML
diff --git a/cups3.html b/cups3.html
index b5f94bff68..b6f554227a 100644
--- a/cups3.html
+++ b/cups3.html
@@ -15,9 +15,9 @@ layout: default3
·
Documentation
- libcups
- cups-local
- cups-sharing
+ libcups
+ cups-local
+ cups-sharing
@@ -55,10 +55,12 @@ layout: default3
- cancel(1) - cancel jobs: HTML
- - client.conf(5) - client configuration file for cups: HTML
+ - client.conf(5) - client configuration file for cups: HTML
- cups(1) - a standards-based, open source printing system: HTML
- cupsaccept/cupsreject(8) - accept/reject jobs sent to a destination: HTML
- cupsdisable, cupsenable(8) - stop/start printers and classes: HTML
+ - cups-oauth(1) - Interact with an OAuth/OpenID Authorization Server: HTML
+ - cups-x509(1) - Manage X.509 Certificates and Certificate Requests: HTML
- ippeveprinter(1) - An IPP Everywhere Printer Application for CUPS: HTML
- ippfind(1) - Find Internet Printing Protocol Printers: HTML
- ipptool(1) - Perform Internet Printing Protocol Requests: HTML
@@ -83,6 +85,7 @@ layout: default3
- CUPS Implementation of IPP: HTML
- CUPS Programming Manual: HTML · EPUB
- CUPS Raster Format: HTML
+ - libcups(3) - CUPS API Library: HTML
diff --git a/cups-local/client.conf.html b/libcups/client.conf.html
similarity index 59%
rename from cups-local/client.conf.html
rename to libcups/client.conf.html
index 70778b2379..98a264682f 100644
--- a/cups-local/client.conf.html
+++ b/libcups/client.conf.html
@@ -10,6 +10,15 @@ body {
.center {
text-align: center;
}
+a:link, a:visited {
+ color: #c00;
+ text-decoration: underline;
+}
+
+a:link:hover, a:active {
+ color: #f00;
+ text-decoration: underline;
+}
code, kbd, pre, tt {
font-family: monospace;
}
@@ -26,14 +35,16 @@ p {
text-align: justify;
}
span.info {
- background: rgba(127,127,127,0.5);
- border-radius: 5px;
+ background: #ddf;
+ border: solid 1px #77c;
+ border-top-left-radius: 5px;
+ border-top-right-radius: 5px;
float: right;
font-size: 80%;
- padding: 4px 10px;
+ padding: 2px 10px;
}
h4 span.info {
- padding: 2px 8px;
+ padding: 1px 8px;
}
table {
border-collapse: collapse;
@@ -41,10 +52,6 @@ table {
margin-right: auto;
max-width: 90%;
}
-table caption {
- font-style: italic;
- margin-bottom: 1em;
-}
table thead th {
border-bottom: solid 2px black;
padding: 0 10px;
@@ -52,18 +59,39 @@ table thead th {
vertical-align: bottom;
}
table tbody tr:nth-child(even) {
- background: rgba(127,127,127,0.125);
+ background: #ddd;
}
table tbody td {
border-bottom: solid 1px black;
padding: 4px 10px;
vertical-align: top;
}
-table.figure tbody td {
- border-bottom: none;
+blockquote {
+ background: #ddf;
+ border-left: solid 2px #77c;
+ margin-left: 0;
+ margin-right: 0;
+ padding: 10px;
+}
+/* Dark mode overrides */
+@media (prefers-color-scheme: dark) {
+ body {
+ background: black;
+ color: #ccc;
+ }
+ h2, h3, h4, table tbody td, table thead th {
+ border-color: #ccc;
+ }
+ blockquote, span.info {
+ background: #337;
+ border-color: #66f;
+ }
+ table tbody tr:nth-child(even) {
+ background: #444;
+ }
}
-->
-
+
client.conf(5)
@@ -75,9 +103,10 @@ table.figure tbody td {
The client.conf file configures the CUPS client and is normally located in the /etc/cups and/or ~/.cups directories.
Each line in the file can be a configuration directive, a blank line, or a comment. Comment lines start with the # character.
- Note: Starting with macOS 10.7, this file is only used by command-line and X11 applications plus the IPP backend.
-The ServerName directive is not supported on macOS at all.
-Starting with macOS 10.12, all applications can access these settings in the /Library/Preferences/org.cups.PrintingPrefs.plist file instead.
+
Note: macOS applications can access many of these settings in the /Library/Preferences/org.cups.PrintingPrefs.plist file instead.
+macOS also does not support the
+ServerName
+directive.
See the NOTES section below for more information.
Directives
@@ -108,9 +137,30 @@ Specifies HTTP Digest authentication options.
Encryption Required
Specifies the level of encryption that should be used.
- GSSServiceName name
-Specifies the Kerberos service name that is used for authentication, typically "host", "http", or "ipp".
-CUPS adds the remote hostname ("name@server.example.com") for you. The default name is "http".
+
BrowseDomains all
+
+ BrowseDomains none
+
+ BrowseDomains DOMAIN[,...,DOMAIN]
+Specifies the DNS-SD domains to browse for IPP printers.
+The value "all" browses the ".local" domain (mDNS) and all registered DNS domains on the local system.
+The value "none" disables browsing for network printers.
+
+ FilterLocation LOCATION[,...,LOCATION]
+
+ FilterLocation 'LOCATION'[,...,'LOCATION']
+
+ FilterLocation "LOCATION"[,...,"LOCATION"]
+Specifies a list of locations to use for destinations.
+
+ FilterLocation /REGULAR-EXPRESSION/
+Specifies a regular expression for matching locations to use for destinations.
+
+ FilterType any
+
+ FilterType TYPE[,...,TYPE]
+Specifies the type of destinations to use.
+The TYPE values are "mono" for B&W printers, "color" for color printers, "duplex" for printers with 2-sided printing capabilities, "simplex" for printers with 1-sided printing capabilities, "bind" for printers that can bind output, "cover" for printers that can cover output, "punch" for printers that can punch output, "sort" for printers that can sort output, "staple" for printers with a stapler, "small" for printers that support media up to US Legal/ISO A4, "medium" for printers that support media up to US Tabloid/ISO A3, and "large" for printers that support media larger than US Tabloid/ISO A3.
ServerName hostname-or-ip-address[:port]
@@ -172,11 +222,36 @@ The default is "Minimal".
ValidateCerts Yes
ValidateCerts No
-Specifies whether to only allow TLS with certificates whose common name matches the hostname.
+Specifies whether to only allow TLS with certificates whose commonName or subjectAltName values match the hostname of the printer or server.
The default is "No".
+
+ X.509 Certificate Store
+CUPS uses the system root CA certificate store and per-user certificate stores managed by CUPS.
+The per-user certificate stores are found in "/etc/cups/ssl" for the root user and "$XDG_CONFIG_HOME/cups/ssl" (Linux/*BSD), "$HOME/Library/Application Support/cups/ssl" (macOS), "%USERPROFILE%/AppData/Local/cups" (Windows), and/or "$HOME/.cups/ssl" for other user accounts.
+
+ Certificates, certificate signing requests, and private keys are stored as PEM-encoded files with the naming convention "COMMON-NAME.crt" for certificates, "COMMON-NAME.csr" for certificate signing requests, and "COMMON-NAME.key" for private keys. The special common name "_site_" is used for a site-specific root certificate that can be used for trust evaluations.
+
+ X.509 Certificate Validation
+CUPS supports validation of the certificate's commonName and subjectAltName field values, the certificate expiration date, and the certificate's root certificate(s), if any.
+Self-signed certificates are "pinned" (stored) to the host in order to do validation.
+Validation for certain non-printing servers may add additional restrictions to the policy defined in the
+client.conf
+file, for example OAuth authorization requires a CA-signed certificate.
+
+ The
+AllowAnyRoot
+directive controls whether unpinned self-signed certificates are acceptable.
+The
+TrustOnFirstUse
+directive controls whether self-certificates are automatically pinned in the per-user certificate store for subsequent host validations.
+When
+AllowAnyRoot
+is disabled,
+TrustOnFirstUse
+is also disabled.
Notes
-The client.conf file is deprecated on macOS and will no longer be supported in a future version of CUPS.
+
Because of sandboxing, the client.conf file is not generally accessible to applications on macOS.
Configuration settings can instead be viewed or changed using the
defaults(1)
@@ -192,11 +267,10 @@ defaults read /Library/Preferences/org.cups.PrintingPrefs.plist Encryption
See Also
cups(1),
-default(1),
+cups-x509(1)
-CUPS Online Help (http://localhost:631/help)
Copyright
-Copyright © 2021-2023 by OpenPrinting.
+
Copyright © 2021-2025 by OpenPrinting.