Skip to content

Commit

Permalink
Update CUPS docos.
Browse files Browse the repository at this point in the history
  • Loading branch information
@michaelrsweet
michaelrsweet committed Oct 13, 2023
1 parent 323f662 commit 5d68333
Show file tree
Hide file tree
Showing 29 changed files with 19,607 additions and 0 deletions.
166 changes: 166 additions & 0 deletions cups-local/cancel.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,166 @@
<!DOCTYPE html>
<html>
<head>
<style><!--
body {
font-family: sans-serif;
font-size: 16pt;
margin: 54pt 36pt;
}
.center {
text-align: center;
}
code, kbd, pre, tt {
font-family: monospace;
}
dl {
margin-left: 2em;
}
h2, h3 {
border-bottom: solid 2px black;
}
h4 {
border-bottom: solid 1px black;
}
p {
text-align: justify;
}
span.info {
background: rgba(127,127,127,0.5);
border-radius: 5px;
float: right;
font-size: 80%;
padding: 4px 10px;
}
h4 span.info {
padding: 2px 8px;
}
table {
border-collapse: collapse;
margin-left: auto;
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;
text-align: left;
vertical-align: bottom;
}
table tbody tr:nth-child(even) {
background: rgba(127,127,127,0.125);
}
table tbody td {
border-bottom: solid 1px black;
padding: 4px 10px;
vertical-align: top;
}
table.figure tbody td {
border-bottom: none;
}
--></style>
<meta name="creator" content="mantohtml v2.0.1">
<title>cancel(1)</title>
</head>
<body>
<h1 id="cancel-1">cancel(1)</h1>
<h2 id="cancel-1.name">Name</h2>
<p>cancel - cancel jobs
</p>
<h2 id="cancel-1.synopsis">Synopsis</h2>
<p><strong>cancel</strong>
[
<strong>-h</strong>
<em>hostname[:port]</em>
] [
<strong>-E</strong>
] [
<strong>-U</strong>
<em>username</em>
] [
<strong>-a</strong>
] [
<strong>-u</strong>
<em>username</em>
] [
<strong>-x</strong>
] [
<em>id</em>
] [
<em>destination</em>
] [
<em>destination-id</em>
]
</p>
<h2 id="cancel-1.description">Description</h2>
<p>The <strong>cancel</strong> command cancels print jobs.
If no <em>destination</em> or <em>id</em> is specified, the currently printing job on the default destination is canceled.
</p>
<h2 id="cancel-1.options">Options</h2>
<p>The following options are recognized by <strong>cancel</strong>:
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>-a</strong><br>
Cancel all jobs on the named destination, or all jobs on all
destinations if none is provided.
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>-E</strong><br>
Forces encryption when connecting to the server.
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>-h </strong><em>hostname</em>[<em>:port</em>]<br>
Specifies an alternate server.
Note: This option must occur before all others.
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>-U </strong><em>username</em><br>
Specifies the username to use when connecting to the server.
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>-u </strong><em>username</em><br>
Cancels jobs owned by <em>username</em>.
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>-x</strong><br>
Deletes job data files in addition to canceling.
</p>
<h2 id="cancel-1.conforming-to">Conforming To</h2>
<p>Unlike the System V printing system, CUPS allows printer names to contain any printable character except SPACE, TAB, &quot;/&quot;, or &quot;#&quot;. Also, printer and class names are <em>not</em> case-sensitive.
</p>
<h2 id="cancel-1.examples">Examples</h2>
<p>Cancel the current print job:
</p>
<pre>
cancel

</pre>
<p>Cancel job &quot;myprinter-42&quot;:
</p>
<pre>
cancel myprinter-42

</pre>
<p>Cancel all jobs:
</p>
<pre>
cancel -a
</pre>
<h2 id="cancel-1.notes">Notes</h2>
<p>Administrators wishing to prevent unauthorized cancellation of jobs via the <em>-u</em> option should require authentication for Cancel-Jobs operations in
<strong>cupsd.conf</strong>(5).

</p>
<h2 id="cancel-1.see-also">See Also</h2>
<p><strong>cupsd.conf</strong>(5),

<strong>lp</strong>(1),

<strong>lpmove</strong>(8),

<strong>lpstat</strong>(1),

CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
</p>
<h2 id="cancel-1.copyright">Copyright</h2>
<p>Copyright &copy; 2021-2022 by OpenPrinting.
</body>
</html>
202 changes: 202 additions & 0 deletions cups-local/client.conf.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,202 @@
<!DOCTYPE html>
<html>
<head>
<style><!--
body {
font-family: sans-serif;
font-size: 16pt;
margin: 54pt 36pt;
}
.center {
text-align: center;
}
code, kbd, pre, tt {
font-family: monospace;
}
dl {
margin-left: 2em;
}
h2, h3 {
border-bottom: solid 2px black;
}
h4 {
border-bottom: solid 1px black;
}
p {
text-align: justify;
}
span.info {
background: rgba(127,127,127,0.5);
border-radius: 5px;
float: right;
font-size: 80%;
padding: 4px 10px;
}
h4 span.info {
padding: 2px 8px;
}
table {
border-collapse: collapse;
margin-left: auto;
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;
text-align: left;
vertical-align: bottom;
}
table tbody tr:nth-child(even) {
background: rgba(127,127,127,0.125);
}
table tbody td {
border-bottom: solid 1px black;
padding: 4px 10px;
vertical-align: top;
}
table.figure tbody td {
border-bottom: none;
}
--></style>
<meta name="creator" content="mantohtml v2.0.1">
<title>client.conf(5)</title>
</head>
<body>
<h1 id="client.conf-5">client.conf(5)</h1>
<h2 id="client.conf-5.name">Name</h2>
<p>client.conf - client configuration file for cups (deprecated on macos)
</p>
<h2 id="client.conf-5.description">Description</h2>
<p>The <strong>client.conf</strong> file configures the CUPS client and is normally located in the <em>/etc/cups</em> and/or <em>~/.cups</em> directories.
Each line in the file can be a configuration directive, a blank line, or a comment. Comment lines start with the # character.
</p>
<p><strong>Note:</strong> Starting with macOS 10.7, this file is only used by command-line and X11 applications plus the IPP backend.
The <strong>ServerName</strong> directive is not supported on macOS at all.
Starting with macOS 10.12, all applications can access these settings in the <em>/Library/Preferences/org.cups.PrintingPrefs.plist</em> file instead.
See the NOTES section below for more information.
</p>
<h3 id="client.conf-5.description.directives">Directives</h3>
<p>The following directives are understood by the client. Consult the online help for detailed descriptions:
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>AllowAnyRoot Yes</strong><br>
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>AllowAnyRoot No</strong><br>
Specifies whether to allow TLS with certificates that have not been signed by a trusted Certificate Authority.
The default is &quot;Yes&quot;.
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>AllowExpiredCerts Yes</strong><br>
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>AllowExpiredCerts No</strong><br>
Specifies whether to allow TLS with expired certificates.
The default is &quot;No&quot;.
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>DigestOptions DenyMD5</strong><br>
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>DigestOptions None</strong><br>
Specifies HTTP Digest authentication options.
<strong>DenyMD5</strong> disables support for the original MD5 hash algorithm.
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Encryption IfRequested</strong><br>
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Encryption Never</strong><br>
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Encryption Required</strong><br>
Specifies the level of encryption that should be used.
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>GSSServiceName </strong><em>name</em><br>
Specifies the Kerberos service name that is used for authentication, typically &quot;host&quot;, &quot;http&quot;, or &quot;ipp&quot;.
CUPS adds the remote hostname (&quot;[email protected]&quot;) for you. The default name is &quot;http&quot;.
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>ServerName </strong><em>hostname-or-ip-address</em>[<em>:port</em>]<br>
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>ServerName </strong><em>/domain/socket</em><br>
Specifies the address and optionally the port to use when connecting to the server.
<strong>Note: This directive is not supported on macOS 10.7 or later.</strong>
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>ServerName </strong><em>hostname-or-ip-address</em>[<em>:port</em>]<strong>/version=1.1</strong><br>
Specifies the address and optionally the port to use when connecting to a server running CUPS 1.3.12 and earlier.
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>SSLOptions </strong>[<em>AllowDH</em>] [<em>AllowRC4</em>] [<em>AllowSSL3</em>] [<em>DenyCBC</em>] [<em>DenyTLS1.0</em>] [<em>MaxTLS1.0</em>] [<em>MaxTLS1.1</em>] [<em>MaxTLS1.2</em>] [<em>MaxTLS1.3</em>] [<em>MinTLS1.0</em>] [<em>MinTLS1.1</em>] [<em>MinTLS1.2</em>] [<em>MinTLS1.3</em>]<br>
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>SSLOptions None</strong><br>
Sets encryption options (only in /etc/cups/client.conf).
By default, CUPS only supports encryption using TLS v1.0 or higher using known secure cipher suites.
Security is reduced when <em>Allow</em> options are used.
Security is enhanced when <em>Deny</em> options are used.
The <em>AllowDH</em> option enables cipher suites using plain Diffie-Hellman key negotiation (not supported on systems using GNU TLS).
The <em>AllowRC4</em> option enables the 128-bit RC4 cipher suites, which are required for some older clients.
The <em>AllowSSL3</em> option enables SSL v3.0, which is required for some older clients that do not support TLS v1.0.
The <em>DenyCBC</em> option disables all CBC cipher suites.
The <em>DenyTLS1.0</em> option disables TLS v1.0 support - this sets the minimum protocol version to TLS v1.1.
The <em>MinTLS</em> options set the minimum TLS version to support.
The <em>MaxTLS</em> options set the maximum TLS version to support.
Not all operating systems support TLS 1.3 at this time.
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>TrustOnFirstUse Yes</strong><br>
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>TrustOnFirstUse No</strong><br>
Specifies whether to trust new TLS certificates by default.
The default is &quot;Yes&quot;.
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>User </strong><em>name</em><br>
Specifies the default user name to use for requests.
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>UserAgentTokens None</strong><br>
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>UserAgentTokens ProductOnly</strong><br>
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>UserAgentTokens Major</strong><br>
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>UserAgentTokens Minor</strong><br>
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>UserAgentTokens Minimal</strong><br>
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>UserAgentTokens OS</strong><br>
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>UserAgentTokens Full</strong><br>
Specifies what information is included in the User-Agent header of HTTP requests.
&quot;None&quot; disables the User-Agent header.
&quot;ProductOnly&quot; reports &quot;CUPS&quot;.
&quot;Major&quot; reports &quot;CUPS/major IPP/2&quot;.
&quot;Minor&quot; reports &quot;CUPS/major.minor IPP/2.1&quot;.
&quot;Minimal&quot; reports &quot;CUPS/major.minor.patch IPP/2.1&quot;.
&quot;OS&quot; reports &quot;CUPS/major.minor.path (osname osversion) IPP/2.1&quot;.
&quot;Full&quot; reports &quot;CUPS/major.minor.path (osname osversion; architecture) IPP/2.1&quot;.
The default is &quot;Minimal&quot;.
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>ValidateCerts Yes</strong><br>
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>ValidateCerts No</strong><br>
Specifies whether to only allow TLS with certificates whose common name matches the hostname.
The default is &quot;No&quot;.
</p>
<h2 id="client.conf-5.notes">Notes</h2>
<p>The <strong>client.conf</strong> file is deprecated on macOS and will no longer be supported in a future version of CUPS.
Configuration settings can instead be viewed or changed using the
<strong>defaults</strong>(1)

command:
</p>
<pre>defaults write /Library/Preferences/org.cups.PrintingPrefs.plist Encryption Required
defaults write /Library/Preferences/org.cups.PrintingPrefs.plist TrustOnFirstUse -bool NO

defaults read /Library/Preferences/org.cups.PrintingPrefs.plist Encryption
</pre>
<p>On Linux and other systems using GNU TLS, the <em>/etc/cups/ssl/site.crl</em> file, if present, provides a list of revoked X.509 certificates and is used when validating certificates.
</p>
<h2 id="client.conf-5.see-also">See Also</h2>
<p><strong>cups</strong>(1),

<strong>default</strong>(1),

CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
</p>
<h2 id="client.conf-5.copyright">Copyright</h2>
<p>Copyright &copy; 2021-2023 by OpenPrinting.
</body>
</html>
Loading

0 comments on commit 5d68333

Please sign in to comment.