Skip to content

Commit ea48a23

Browse files
committed
Work on documentation.
Update ipptool to support inequality ("WITH-VALUE !number") conditions. Add PWG 5100.13 (NODRIVER) test file.
1 parent 6720984 commit ea48a23

37 files changed

Lines changed: 1202 additions & 281 deletions

cups/Makefile

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -674,13 +674,13 @@ tlscheck: tlscheck.o $(LIBCUPS_STATIC)
674674

675675
doc:
676676
echo "Generating CUPS Programming Manual..."
677-
$(RM) cupspm.xml
678-
codedoc --section "Programming" --body cupspm.md cupspm.xml \
679-
$(LIBOBJS:.o=.c) tls-openssl.c $(HEADERS) --coverimage cupspm.png \
680-
--epub ../doc/cupspm.epub
681-
codedoc --section "Programming" --body cupspm.md \
682-
cupspm.xml > ../doc/cupspm.html
683-
$(RM) cupspm.xml
677+
$(RM) cupspm3.xml
678+
codedoc --section "Programming" --body cupspm3.md cupspm3.xml \
679+
$(LIBOBJS:.o=.c) tls-openssl.c $(HEADERS) --coverimage cupspm3.png \
680+
--epub ../doc/cupspm3.epub
681+
codedoc --section "Programming" --body cupspm3.md \
682+
cupspm3.xml > ../doc/cupspm3.html
683+
$(RM) cupspm3.xml
684684

685685

686686
#

cups/cupspm.md renamed to cups/cupspm3.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: CUPS Programming Manual
2+
title: CUPS 3.0 Programming Manual
33
author: Michael R Sweet
44
copyright: Copyright © 2021-2025 by OpenPrinting. All Rights Reserved.
55
version: 3.0.0
@@ -11,16 +11,16 @@ version: 3.0.0
1111

1212
# Introduction
1313

14-
CUPS provides the "cups" library to talk to the different parts of CUPS and with
15-
Internet Printing Protocol (IPP) printers. The "cups" library functions are
14+
CUPS 3.0 provides the "cups3" library to talk to the different parts of CUPS and
15+
with Internet Printing Protocol (IPP) printers. The "cups" library functions are
1616
accessed by including the `<cups/cups.h>` header.
1717

1818
CUPS is based on the Internet Printing Protocol ("IPP"), which allows clients
1919
(applications) to communicate with a server (the scheduler, printers, etc.) to
2020
get a list of destinations, send print jobs, and so forth. You identify which
2121
server you want to communicate with using a pointer to the opaque structure
2222
`http_t`. The `CUPS_HTTP_DEFAULT` constant can be used when you want to talk to
23-
the CUPS scheduler.
23+
the default CUPS spooler.
2424

2525

2626
## Guidelines
File renamed without changes.

cups/cupspm.svg renamed to cups/cupspm3.svg

Lines changed: 2 additions & 2 deletions
Loading

doc/Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ DOCFILES = \
1818
cups.svg \
1919
cups-oauth.html \
2020
cups-x509.html \
21-
cupspm.epub \
22-
cupspm.html \
21+
cupspm3.epub \
22+
cupspm3.html \
2323
index.html \
2424
ippeveprinter.html \
2525
ippfind.html \

doc/client.conf.html

Lines changed: 142 additions & 44 deletions
Large diffs are not rendered by default.

doc/cups-oauth.html

Lines changed: 26 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -219,39 +219,43 @@ <h2 id="cups-oauth-1.options">Options</h2>
219219
The default is to request authorization for all supported OpenID scopes.
220220
</p>
221221
<h2 id="cups-oauth-1.sub-commands">Sub-Commands</h2>
222-
<h3 id="cups-oauth-1.sub-commands.authorize">Authorize</h3>
223-
<p>Starts an authorization workflow with the default web browser.
222+
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>authorize</strong> [<em>RESOURCE</em>]<br>
223+
Starts an authorization workflow with the default web browser.
224224
If a resource URI is specified, the authorization is specific to that resource.
225225
The access token is send to the standard output on success.
226226
</p>
227-
<h3 id="cups-oauth-1.sub-commands.clear">Clear</h3>
228-
<p>Clears any authorization for the specified resource or for all resources if no resource URI is supplied.
227+
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>clear</strong> [<em>RESOURCE</em>]<br>
228+
Clears any authorization for the specified resource or for all resources if no resource URI is supplied.
229229
</p>
230-
<h3 id="cups-oauth-1.sub-commands.get-access-token">Get-Access-Token</h3>
231-
<p>Output the current, unexpired access token, if any, to the standard output.
230+
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>get-access-token</strong> [<em>RESOURCE</em>]<br>
231+
Output the current, unexpired access token, if any, to the standard output.
232232
</p>
233-
<h3 id="cups-oauth-1.sub-commands.get-client-id">Get-Client-Id</h3>
234-
<p>Output the client ID string, if any, to the standard output.
233+
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>get-client-id</strong><br>
234+
Output the client ID string, if any, to the standard output.
235235
</p>
236-
<h3 id="cups-oauth-1.sub-commands.get-device-grant">Get-Device-Grant</h3>
237-
<p>Gets a device authorization grant and outputs the device code, user code, and web page to the standard output.
236+
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>get-device-grant</strong> [<em>RESOURCE</em>]<br>
237+
Gets a device authorization grant and outputs the device code, user code, and web page to the standard output.
238238
</p>
239-
<h3 id="cups-oauth-1.sub-commands.get-device-token">Get-Device-Token</h3>
240-
<p>Waits for device authorization to complete and outputs the device access token to the standard output.
239+
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>get-device-token</strong> [<em>RESOURCE</em>] <em>DEVICE-CODE</em><br>
240+
Waits for device authorization to complete and outputs the device access token to the standard output.
241241
</p>
242-
<h3 id="cups-oauth-1.sub-commands.get-metadata">Get-Metadata</h3>
243-
<p>Get the OAuth/OpenID authorization server metadata and send it to the standard output.
244-
If a name is specified, the output is just the value for the specified metadata.
242+
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>get-metadata</strong> [<em>NAME</em>]<br>
243+
Get the OAuth/OpenID authorization server metadata and send it to the standard output.
244+
If
245+
<em>NAME</em>
246+
is specified, the output is just the value for the named metadata.
245247
</p>
246-
<h3 id="cups-oauth-1.sub-commands.get-user-id">Get-User-Id</h3>
247-
<p>Get the OpenID user ID information and send it to the standard output.
248-
If a name is specified, the output is just the named claim from the user ID.
248+
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>get-user-id</strong> [<em>RESOURCE</em>] [<em>NAME</em>]<br>
249+
Get the OpenID user ID information and send it to the standard output.
250+
If
251+
<em>NAME</em>
252+
is specified, the output is just the named claim from the user ID.
249253
</p>
250-
<h3 id="cups-oauth-1.sub-commands.set-access-token">Set-Access-Token</h3>
251-
<p>Set the access token (which is sometimes also called an API key) for the specified resource or for all resources.
254+
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>set-access-token</strong> [<em>RESOURCE</em>] <em>TOKEN</em><br>
255+
Set the access token (which is sometimes also called an API key) for the specified resource or for all resources.
252256
</p>
253-
<h3 id="cups-oauth-1.sub-commands.set-client-data">Set-Client-Data</h3>
254-
<p>Set the client ID string and secret for an OAuth/OpenID authorization server.
257+
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>set-client-data</strong> <em>CLIENT-ID</em> <em>CLIENT-SECRET</em><br>
258+
Set the client ID string and secret for an OAuth/OpenID authorization server.
255259
</p>
256260
<h2 id="cups-oauth-1.environment-variables">Environment Variables</h2>
257261
<p>The

doc/cups-x509.html

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@
9797
<body>
9898
<h1 id="cups-x509-1">cups-x509(1)</h1>
9999
<h2 id="cups-x509-1.name">Name</h2>
100-
<p>cups-x509 - description
100+
<p>cups-x509 - manage x.509 certificates and certificate requests
101101
</p>
102102
<h2 id="cups-x509-1.synopsis">Synopsis</h2>
103103
<p><strong>cups-x509</strong>
@@ -215,31 +215,33 @@ <h2 id="cups-x509-1.options">Options</h2>
215215
The preset &quot;default-ca&quot; specifies those uses required for a Certificate Authority, and the preset &quot;default-tls&quot; specifies those uses required for TLS.
216216
</p>
217217
<h2 id="cups-x509-1.sub-commands">Sub-Commands</h2>
218-
<h3 id="cups-x509-1.sub-commands.ca-common-name">Ca Common-Name</h3>
219-
<p>Sign a certificate request for the specified common name.
218+
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>ca </strong><em>COMMON-NAME</em><br>
219+
Sign a certificate request for the specified common name.
220220
</p>
221-
<h3 id="cups-x509-1.sub-commands.cacert-common-name">Cacert Common-Name</h3>
222-
<p>Create a CA certificate for the specified common name.
221+
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>cacert </strong><em>COMMON-NAME</em><br>
222+
Create a CA certificate for the specified common name.
223223
</p>
224-
<h3 id="cups-x509-1.sub-commands.cert-common-name">Cert Common-Name</h3>
225-
<p>Create a certificate for the specified common name.
224+
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>cert </strong><em>COMMON-NAME</em><br>
225+
Create a certificate for the specified common name.
226226
</p>
227-
<h3 id="cups-x509-1.sub-commands.client-uri">Client Uri</h3>
228-
<p>Connect to the specified URI and validate the server's certificate.
227+
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>client </strong><em>URI</em><br>
228+
Connect to the specified URI and validate the server's certificate.
229229
</p>
230-
<h3 id="cups-x509-1.sub-commands.csr-common-name">Csr Common-Name</h3>
231-
<p>Create a certificate signing request for the specified common name.
230+
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>csr </strong><em>COMMON-NAME</em><br>
231+
Create a certificate signing request for the specified common name.
232232
</p>
233-
<h3 id="cups-x509-1.sub-commands.install-common-name-filename.crt-filename.key">Install Common-Name Filename.Crt [Filename.Key]</h3>
234-
<p>Installs a certificate and optional private key for the specified common name.
233+
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>install </strong><em>COMMON-NAME FILENAME.crt</em> [<em>FILENAME.key</em>]<br>
234+
Installs a certificate and optional private key for the specified common name.
235235
The certificate and private key are PEM-encoded files.
236236
</p>
237-
<h3 id="cups-x509-1.sub-commands.server-common-nameport">Server Common-Name[:Port]</h3>
238-
<p>Run a HTTPS test server that echos back the resource path for every GET request.
239-
If PORT is not specified, uses a port number from 8000 to 8999.
237+
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>server </strong><em>COMMON-NAME</em>[<strong>:</strong><em>PORT</em>]<br>
238+
Run a HTTPS test server that echos back the resource path for every GET request.
239+
If
240+
<em>PORT</em>
241+
is not specified, uses a port number from 8000 to 8999.
240242
</p>
241-
<h3 id="cups-x509-1.sub-commands.show-common-name">Show Common-Name</h3>
242-
<p>Shows any stored credentials for the specified common name.
243+
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>show </strong><em>COMMON-NAME</em><br>
244+
Shows any stored credentials for the specified common name.
243245
</p>
244246
<h2 id="cups-x509-1.examples">Examples</h2>
245247
<p>Create a certificate signing request for a 384-bit ECDSA certificate for &quot;server.example.com&quot;:
@@ -250,9 +252,9 @@ <h2 id="cups-x509-1.examples">Examples</h2>
250252
</p>
251253
<pre> cups-x509 install server.example.com server.example.com.crt
252254
</pre>
253-
<p>Run a test server for &quot;server.exmaple.com&quot; on port 8080:
255+
<p>Run a test server for &quot;server.example.com&quot; on port 8080:
254256
</p>
255-
<pre> cups-x509 server SERVER-NAME:8080
257+
<pre> cups-x509 server server.example.com:8080
256258
</pre>
257259
<p>Test a HTTPS client connection to &quot;www.example.com&quot; with validation:
258260
</p>
Binary file not shown.

0 commit comments

Comments
 (0)