}
pre.command, pre.example {
- background: #eee;
- margin: 0 36pt;
- padding: 10px;
+ padding: 10px 20px;
}
p.compact {
margin-left: 0;
}
-pre.man {
- margin: 0;
-}
-
pre.command em, pre.example em {
font-family: lucida grande, geneva, helvetica, arial, sans-serif;
}
}
p code, li code, p.code, pre, ul.code li {
background: rgba(127,127,127,0.1);
- border: thin dotted gray;
+ border-left: thin dotted gray;
font-family: monospace;
hyphens: manual;
+ margin: 18pt 0;
-webkit-hyphens: manual;
page-break-inside: avoid;
}
}
pre.command, pre.example {
- background: #eee;
- margin: 0 36pt;
- padding: 10px;
+ padding: 10px 20px;
}
p.example {
}
p code, li code, p.code, pre, ul.code li {
background: rgba(127,127,127,0.1);
- border: thin dotted gray;
+ border-left: thin dotted gray;
font-family: monospace;
- font-size: 90%;
hyphens: manual;
+ margin: 18pt 0;
-webkit-hyphens: manual;
page-break-inside: avoid;
}
<i>filename</i>
]
<pre class="man">
-
<b>#include <cups/cups.h></b>
<b>const char *cupsBackendDeviceURI</b>(<b>char **</b><i>argv</i>);
</pre>
<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
Backends are a special type of
-<b>filter</b>(7)
+<a href="man-filter.html?TOPIC=Man+Pages"><b>filter</b>(7)</a>
which is used to send print data to and discover different devices on the system.
<p>Like filters, backends must be capable of reading from a filename on the command-line or from the standard input, copying the standard input to a temporary file as required by the physical interface.
<p>The command name (<i>argv[0]</i>) is set to the device URI of the destination printer.
When run with no arguments, the backend should list the devices and schemes it supports or is advertising to the standard output.
The output consists of zero or more lines consisting of any of the following forms:
<pre class="man">
-
device-class scheme "Unknown" "device-info"
device-class device-uri "device-make-and-model" "device-info"
device-class device-uri "device-make-and-model" "device-info" "device-id"
<p>All other exit code values are reserved.
<h2 class="title"><a name="ENVIRONMENT">Environment</a></h2>
In addition to the environment variables listed in
-<b>cups</b>(1)
+<a href="man-cups.html?TOPIC=Man+Pages"><b>cups</b>(1)</a>
and
-<b>filter</b>(7),
+<a href="man-filter.html?TOPIC=Man+Pages"><b>filter</b>(7),</a>
CUPS backends can expect the following environment variable:
<dl class="man">
<dt><b>DEVICE_URI</b>
Backends can also be installed with restricted permissions (0500 or 0700) that tell the scheduler to run them as the "root" user instead of an unprivileged user (typically "lp") on the system.
<p>Unless you are a developer and know what you are doing, please do not run backends directly.
Instead, use the
-<b>lp</b>(1)
+<a href="man-lp.html?TOPIC=Man+Pages"><b>lp</b>(1)</a>
or
-<b>lpr</b>(1)
+<a href="man-lpr.html?TOPIC=Man+Pages"><b>lpr</b>(1)</a>
programs to send print jobs or
-<b>lpinfo</b>(8)
+<a href="man-lpinfo.html?TOPIC=Man+Pages"><b>lpinfo</b>(8)</a>
to query for available printers using the backend.
The one exception is the SNMP backend - see
-<b>cups-snmp</b>(8)
+<a href="man-cups-snmp.html?TOPIC=Man+Pages"><b>cups-snmp</b>(8)</a>
for more information.
<h2 class="title"><a name="NOTES">Notes</a></h2>
CUPS printer drivers and backends are deprecated and will no longer be supported in a future feature release of CUPS.
Printers that do not support IPP can be supported using applications such as
-<b>ippeveprinter</b>(1).
+<a href="man-ippeveprinter.html?TOPIC=Man+Pages"><b>ippeveprinter</b>(1).</a>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
<i>cups</i>(1),
<i>cups-files.conf</i>(5),
<h2 class="title"><a name="EXAMPLES">Examples</a></h2>
Cancel the current print job:
<pre class="man">
-
cancel
</pre>
Cancel job "myprinter-42":
<pre class="man">
-
cancel myprinter-42
</pre>
Cancel all jobs:
<pre class="man">
-
cancel -a
</pre>
<h2 class="title"><a name="NOTES">Notes</a></h2>
Administrators wishing to prevent unauthorized cancellation of jobs via the <i>-u</i> option should require authentication for Cancel-Jobs operations in
-<b>cupsd.conf</b>(5).
+<a href="man-cupsd.conf.html?TOPIC=Man+Pages"><b>cupsd.conf</b>(5).</a>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>cupsd.conf</b>(5),
-<b>lp</b>(1),
-<b>lpmove</b>(8),
-<b>lpstat</b>(1),
+<a href="man-cupsd.conf.html?TOPIC=Man+Pages"><b>cupsd.conf</b>(5),</a>
+<a href="man-lp.html?TOPIC=Man+Pages"><b>lp</b>(1),</a>
+<a href="man-lpmove.html?TOPIC=Man+Pages"><b>lpmove</b>(8),</a>
+<a href="man-lpstat.html?TOPIC=Man+Pages"><b>lpstat</b>(1),</a>
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright © 2021 by OpenPrinting.
<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
The <b>classes.conf</b> file defines the local printer classes that are available.
It is normally located in the <i>/etc/cups</i> directory and is maintained by the
-<b>cupsd</b>(8)
+<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8)</a>
program.
This file is not intended to be edited or managed manually.
<h2 class="title"><a name="NOTES">Notes</a></h2>
The name, location, and format of this file are an implementation detail that will change in future releases of CUPS.
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>cupsd</b>(8),
-<b>cupsd.conf</b>(5),
-<b>mime.convs</b>(5),
-<b>mime.types</b>(5),
-<b>printers.conf</b>(5),
-<b>subscriptions.conf</b>(5),
+<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a>
+<a href="man-cupsd.conf.html?TOPIC=Man+Pages"><b>cupsd.conf</b>(5),</a>
+<a href="man-mime.convs.html?TOPIC=Man+Pages"><b>mime.convs</b>(5),</a>
+<a href="man-mime.types.html?TOPIC=Man+Pages"><b>mime.types</b>(5),</a>
+<a href="man-printers.conf.html?TOPIC=Man+Pages"><b>printers.conf</b>(5),</a>
+<a href="man-subscriptions.conf.html?TOPIC=Man+Pages"><b>subscriptions.conf</b>(5),</a>
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright © 2021 by OpenPrinting.
</pre>
On Linux and other systems using GNU TLS, the <i>/etc/cups/ssl/site.crl</i> file, if present, provides a list of revoked X.509 certificates and is used when validating certificates.
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>cups</b>(1),
+<a href="man-cups.html?TOPIC=Man+Pages"><b>cups</b>(1),</a>
<b>default</b>(1),
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
<h2 class="title"><a name="EXAMPLES">Examples</a></h2>
Show the currently installed version of CUPS:
<pre class="man">
-
cups-config --version
</pre>
Compile a simple one-file CUPS filter:
<pre class="man">
-
cc `cups-config --cflags --ldflags` -o filter filter.c \
`cups-config --libs`
</pre>
<dd style="margin-left: 5.0em">Formerly used to add the CUPS imaging library to the list of libraries.
</dl>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>cups</b>(1),
+<a href="man-cups.html?TOPIC=Man+Pages"><b>cups</b>(1),</a>
<b>pkg-config</b>(1),
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
cups-files.conf - file and directory configuration file for cups
<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
The <b>cups-files.conf</b> file configures the files and directories used by the CUPS scheduler,
-<b>cupsd</b>(8).
+<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8).</a>
It is normally located in the <i>/etc/cups</i> directory.
<p>Each line in the file can be a configuration directive, a blank line, or a comment.
Configuration directives typically consist of a name and zero or more values separated by whitespace.
Comment lines start with the # character.
<h3><a name="DIRECTIVES">Directives</a></h3>
The following directives are understood by
-<b>cupsd</b>(8):
+<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8):</a>
<dl class="man">
<dt><a name="AccessLog"></a><b>AccessLog</b>
<dd style="margin-left: 5.0em"><dt><b>AccessLog </b><i>filename</i>
The value "syslog" causes log entries to be sent to the system log daemon.
The server name may be included in filenames using the string "%s", for example:
<pre class="man">
-
AccessLog /var/log/cups/%s-access_log
</pre>
The value "syslog" causes log entries to be sent to the system log daemon.
The server name may be included in filenames using the string "%s", for example:
<pre class="man">
-
ErrorLog /var/log/cups/%s-error_log
</pre>
Specifying a blank filename disables page log generation.
The server name may be included in filenames using the string "%s", for example:
<pre class="man">
-
PageLog /var/log/cups/%s-page_log
</pre>
<b>launchctl</b>(8)
command is used instead.
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>classes.conf</b>(5),
-<b>cups</b>(1),
-<b>cupsd</b>(8),
-<b>cupsd.conf</b>(5),
-<b>mime.convs</b>(5),
-<b>mime.types</b>(5),
-<b>printers.conf</b>(5),
-<b>subscriptions.conf</b>(5),
+<a href="man-classes.conf.html?TOPIC=Man+Pages"><b>classes.conf</b>(5),</a>
+<a href="man-cups.html?TOPIC=Man+Pages"><b>cups</b>(1),</a>
+<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a>
+<a href="man-cupsd.conf.html?TOPIC=Man+Pages"><b>cupsd.conf</b>(5),</a>
+<a href="man-mime.convs.html?TOPIC=Man+Pages"><b>mime.convs</b>(5),</a>
+<a href="man-mime.types.html?TOPIC=Man+Pages"><b>mime.types</b>(5),</a>
+<a href="man-printers.conf.html?TOPIC=Man+Pages"><b>printers.conf</b>(5),</a>
+<a href="man-subscriptions.conf.html?TOPIC=Man+Pages"><b>subscriptions.conf</b>(5),</a>
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright © 2020-2021 by OpenPrinting.
<b>cups-lpd</b>
mini-server:
<pre class="man">
-
printer stream tcp nowait lp /usr/lib/cups/daemon/cups-lpd cups-lpd \
-o document-format=application/octet-stream
<b>cups-lpd</b>
service using the corresponding control program.
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>cups</b>(1),
-<b>cupsd</b>(8),
+<a href="man-cups.html?TOPIC=Man+Pages"><b>cups</b>(1),</a>
+<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a>
<b>inetd</b>(8),
<b>launchd</b>(8),
<b>xinetd</b>(8),
-CUPS Online Help (<a href="http://localhost:631/help)">http://localhost:631/help)</a>,
+CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>),
RFC 2569
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright © 2020-2021 by OpenPrinting.
file configures how the standard CUPS network backends (http, https, ipp, ipps, lpd, snmp, and socket) access printer information using SNMPv1 and is normally located in the <i>/etc/cups</i> directory.
Each line in the file can be a configuration directive, a blank line, or a comment. Comment lines start with the # character.
<p>The Community and DebugLevel directives are used by all backends. The remainder apply only to the SNMP backend -
-<b>cups-snmp</b>(8).
+<a href="man-cups-snmp.html?TOPIC=Man+Pages"><b>cups-snmp</b>(8).</a>
<h2 class="title"><a name="DIRECTIVES">Directives</a></h2>
The following directives are understood by the CUPS network backends:
<dl class="man">
<h2 class="title"><a name="NOTES">Notes</a></h2>
CUPS backends are deprecated and will no longer be supported in a future feature release of CUPS.
Printers that do not support IPP can be supported using applications such as
-<b>ippeveprinter</b>(1).
+<a href="man-ippeveprinter.html?TOPIC=Man+Pages"><b>ippeveprinter</b>(1).</a>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>cups-snmp</b>(8),
+<a href="man-cups-snmp.html?TOPIC=Man+Pages"><b>cups-snmp</b>(8),</a>
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright © 2021 by OpenPrinting.
<p>In the first form, the SNMP backend is run directly by the user to look up the device URI and other information when you have an IP address or hostname.
This can be used for programs that need to configure print queues where the user has supplied an address but nothing else.
<p>In the second form, the SNMP backend is run indirectly using the
-<b>lpinfo</b>(8)
+<a href="man-lpinfo.html?TOPIC=Man+Pages"><b>lpinfo</b>(8)</a>
command.
The output provides all printers detected via SNMP on the configured
broadcast addresses.
<h2 class="title"><a name="CONFORMING_TO">Conforming To</a></h2>
The CUPS SNMP backend uses the information from the Host, Printer, and Port Monitor MIBs along with some vendor private MIBs and intelligent port probes to determine the correct device URI and make and model for each printer.
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>backend</b>(7),
-<b>cups-snmp.conf</b>(5),
-<b>cupsd</b>(8),
-<b>lpinfo</b>(8),
+<a href="man-backend.html?TOPIC=Man+Pages"><b>backend</b>(7),</a>
+<a href="man-cups-snmp.conf.html?TOPIC=Man+Pages"><b>cups-snmp.conf</b>(5),</a>
+<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a>
+<a href="man-lpinfo.html?TOPIC=Man+Pages"><b>lpinfo</b>(8),</a>
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright © 2021 by OpenPrinting.
<p>After the printer is added you will be asked to set the default printer options (paper size, output mode, etc.) for the printer. Make any changes as needed and then click/press on the Set Default Options button to save them. Some printers also support auto-configuration - click/press on the Query Printer for Default Options button to update the options automatically.
<p>Once you have added the printer, you can print to it from any application. You can also choose Print Test Page from the maintenance menu to print a simple test page and verify that everything is working properly.
<p>You can also use the
-<b>lpadmin</b>(8)
+<a href="man-lpadmin.html?TOPIC=Man+Pages"><b>lpadmin</b>(8)</a>
and
-<b>lpinfo</b>(8)
+<a href="man-lpinfo.html?TOPIC=Man+Pages"><b>lpinfo</b>(8)</a>
commands to add printers to
<b>CUPS</b>.
Additionally, your operating system may include graphical user interfaces or automatically create printer queues when you connect a printer to your computer.
<h2 class="title"><a name="NOTES">Notes</a></h2>
CUPS printer drivers, backends, and PPD files are deprecated and will no longer be supported in a future feature release of CUPS.
Printers that do not support IPP can be supported using applications such as
-<b>ippeveprinter</b>(1).
+<a href="man-ippeveprinter.html?TOPIC=Man+Pages"><b>ippeveprinter</b>(1).</a>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>cancel</b>(1),
-<b>client.conf</b>(5),
-<b>cupsctl</b>(8),
-<b>cupsd</b>(8),
-<b>lp</b>(1),
-<b>lpadmin</b>(8),
-<b>lpinfo</b>(8),
-<b>lpoptions</b>(1),
-<b>lpr</b>(1),
-<b>lprm</b>(1),
-<b>lpq</b>(1),
-<b>lpstat</b>(1),
-CUPS Online Help (<a href="http://localhost:631/help)">http://localhost:631/help)</a>,
-OpenPrinting CUPS Web Site (<a href="https://openprinting.github.io/cups)">https://openprinting.github.io/cups)</a>,
+<a href="man-cancel.html?TOPIC=Man+Pages"><b>cancel</b>(1),</a>
+<a href="man-client.conf.html?TOPIC=Man+Pages"><b>client.conf</b>(5),</a>
+<a href="man-cupsctl.html?TOPIC=Man+Pages"><b>cupsctl</b>(8),</a>
+<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a>
+<a href="man-lp.html?TOPIC=Man+Pages"><b>lp</b>(1),</a>
+<a href="man-lpadmin.html?TOPIC=Man+Pages"><b>lpadmin</b>(8),</a>
+<a href="man-lpinfo.html?TOPIC=Man+Pages"><b>lpinfo</b>(8),</a>
+<a href="man-lpoptions.html?TOPIC=Man+Pages"><b>lpoptions</b>(1),</a>
+<a href="man-lpr.html?TOPIC=Man+Pages"><b>lpr</b>(1),</a>
+<a href="man-lprm.html?TOPIC=Man+Pages"><b>lprm</b>(1),</a>
+<a href="man-lpq.html?TOPIC=Man+Pages"><b>lpq</b>(1),</a>
+<a href="man-lpstat.html?TOPIC=Man+Pages"><b>lpstat</b>(1),</a>
+CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>),
+OpenPrinting CUPS Web Site (<a href="https://openprinting.github.io/cups">https://openprinting.github.io/cups</a>),
PWG Internet Printing Protocol Workgroup (<a href="http://www.pwg.org/ipp">http://www.pwg.org/ipp</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright © 2021 by OpenPrinting.
Also, printer and class names are <i>not</i> case-sensitive.
<p>Finally, the CUPS versions may ask the user for an access password depending on the printing system configuration.
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>cancel</b>(1),
-<b>cupsenable</b>(8),
-<b>lp</b>(1),
-<b>lpadmin</b>(8),
-<b>lpstat</b>(1),
+<a href="man-cancel.html?TOPIC=Man+Pages"><b>cancel</b>(1),</a>
+<a href="man-cupsenable.html?TOPIC=Man+Pages"><b>cupsenable</b>(8),</a>
+<a href="man-lp.html?TOPIC=Man+Pages"><b>lp</b>(1),</a>
+<a href="man-lpadmin.html?TOPIC=Man+Pages"><b>lpadmin</b>(8),</a>
+<a href="man-lpstat.html?TOPIC=Man+Pages"><b>lpstat</b>(1),</a>
<br>
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
<h2 class="title"><a name="EXAMPLES">Examples</a></h2>
Display the current settings:
<pre class="man">
-
cupsctl
</pre>
Enable debug logging:
<pre class="man">
-
cupsctl --debug-logging
</pre>
Get the current debug logging state:
<pre class="man">
-
cupsctl | grep '^_debug_logging' | awk -F= '{print $2}'
</pre>
Disable printer sharing:
<pre class="man">
-
cupsctl --no-share-printers
</pre>
<h2 class="title"><a name="KNOWN_ISSUES">Known Issues</a></h2>
You cannot set the Listen or Port directives using <b>cupsctl</b>.
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>cupsd.conf</b>(5),
-<b>cupsd</b>(8),
+<a href="man-cupsd.conf.html?TOPIC=Man+Pages"><b>cupsd.conf</b>(5),</a>
+<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a>
<br>
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
<i>argvN</i>
<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
The <b>cupsd-helper</b> programs perform long-running operations on behalf of the scheduler,
-<b>cupsd</b>(8).
+<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8).</a>
The <b>cups-deviced</b> helper program runs each CUPS
-<b>backend</b>(7)
+<a href="man-backend.html?TOPIC=Man+Pages"><b>backend</b>(7)</a>
with no arguments in order to discover the available printers.
<p>The <b>cups-driverd</b> helper program lists all available printer drivers, a subset of "matching" printer drivers, or a copy of a specific driver PPD file.
<p>The <b>cups-exec</b> helper program runs backends, filters, and other programs. On macOS these programs are run in a secure sandbox.
<h2 class="title"><a name="FILES">Files</a></h2>
The <b>cups-driverd</b> program looks for PPD and driver information files in the following directories:
<pre class="man">
-
<i>/Library/Printers</i>
<i>/opt/share/ppd</i>
<i>/System/Library/Printers</i>
<b>tar</b>(1)
archives to further reduce their size.
<p>Driver information files must conform to the format defined in
-<b>ppdcfile</b>(5).
+<a href="man-ppdcfile.html?TOPIC=Man+Pages"><b>ppdcfile</b>(5).</a>
<h2 class="title"><a name="NOTES">Notes</a></h2>
CUPS printer drivers, backends, and PPD files are deprecated and will no longer be supported in a future feature release of CUPS.
Printers that do not support IPP can be supported using applications such as
-<b>ippeveprinter</b>(1).
+<a href="man-ippeveprinter.html?TOPIC=Man+Pages"><b>ippeveprinter</b>(1).</a>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>backend</b>(7),
-<b>cups</b>(1),
-<b>cupsd</b>(8),
-<b>cupsd.conf</b>(5),
-<b>filter</b>(7),
-<b>ppdcfile</b>(5),
+<a href="man-backend.html?TOPIC=Man+Pages"><b>backend</b>(7),</a>
+<a href="man-cups.html?TOPIC=Man+Pages"><b>cups</b>(1),</a>
+<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a>
+<a href="man-cupsd.conf.html?TOPIC=Man+Pages"><b>cupsd.conf</b>(5),</a>
+<a href="man-filter.html?TOPIC=Man+Pages"><b>filter</b>(7),</a>
+<a href="man-ppdcfile.html?TOPIC=Man+Pages"><b>ppdcfile</b>(5),</a>
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright © 2021 by OpenPrinting.
<h2 class="title"><a name="NAME">Name</a></h2>
cupsd-logs - cupsd log files (access_log, error_log, and page_log)
<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
-<b>cupsd</b>(8)
+<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8)</a>
normally maintains three log files: <i>access_log</i> to track requests that are submitted to the scheduler, <i>error_log</i> to track progress and errors, and <i>page_log</i> to track pages that are printed.
Configuration directives in
-<b>cupsd.conf</b>(5)
+<a href="man-cupsd.conf.html?TOPIC=Man+Pages"><b>cupsd.conf</b>(5)</a>
and
-<b>cups-files.conf</b>(5)
+<a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5)</a>
control what information is logged and where it is stored.
<h3><a name="ACCESS_LOG_FILE_FORMAT">Access Log File Format</a></h3>
The <i>access_log</i> file lists each HTTP resource that is accessed by a web browser or client.
Each line is in an extended version of the so-called "Common Log Format" used by many web servers and web reporting tools:
<pre class="man">
-
<i>host group user date-time </i>"<i>method resource version</i>" <i>status bytes
ipp-operation ipp-status</i>
</pre>
For example:
<pre class="man">
-
10.0.1.2 - - [01/Dec/2005:21:50:28 +0000] "POST / HTTP/1.1" 200 317
CUPS-Get-Printers successful-ok-ignored-or-substituted-attributes
localhost - - [01/Dec/2005:21:50:32 +0000] "GET /admin HTTP/1.1"
<p>The <i>ipp-status</i> field contains either "-" for non-IPP requests or the IPP status code name for POST requests containing an IPP response.
<h3><a name="ERROR_LOG_FILE_FORMAT">Error Log File Format</a></h3>
The <i>error_log</i> file lists messages from the scheduler - errors, warnings, etc. The LogLevel directive in the
-<b>cupsd.conf</b>(5)
+<a href="man-cupsd.conf.html?TOPIC=Man+Pages"><b>cupsd.conf</b>(5)</a>
file controls which messages are logged:
<pre class="man">
-
level date-time message
</pre>
For example:
<pre class="man">
-
I [20/May/1999:19:18:28 +0000] [Job 1] Queued on 'DeskJet' by 'mike'.
D [20/May/1999:19:18:28 +0000] [Job 1] argv[0]="DeskJet"
D [20/May/1999:19:18:28 +0000] [Job 1] argv[1]="1"
The <i>page_log</i> file lists the total number of pages (sheets) that are printed.
By default, each line contains the following information:
<pre class="man">
-
<i>printer user job-id date-time </i><b>total </b><i>num-sheets job-billing
job-originating-host-name job-name media sides</i>
</pre>
For example the entry for a two page job called "myjob" might look like:
<pre class="man">
-
DeskJet root 1 [20/May/1999:19:21:06 +0000] total 2 acme-123
localhost myjob na_letter_8.5x11in one-sided
</pre>
The PageLogFormat directive in the
-<b>cupsd.conf</b>(5)
+<a href="man-cupsd.conf.html?TOPIC=Man+Pages"><b>cupsd.conf</b>(5)</a>
file can be used to change this information.
<p>The <i>printer</i> field contains the name of the printer that printed the page.
If you send a job to a printer class, this field will contain the name of the printer that was assigned the job.
<p>The <i>media</i> field contains a copy of the media or media-col/media-size attribute provided with the IPP Create-Job or Print-Job requests or "-" if none was provided.
<p>The <i>sides</i> field contains a copy of the sides attribute provided with the IPP Create-Job or Print-Job requests or "-" if none was provided.
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>cupsd</b>(8),
-<b>cupsd.conf</b>(5),
-<b>cups-files.conf</b>(5),
+<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a>
+<a href="man-cupsd.conf.html?TOPIC=Man+Pages"><b>cupsd.conf</b>(5),</a>
+<a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5),</a>
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright © 2021 by OpenPrinting.
The
<i>cupsd.conf</i>
file configures the CUPS scheduler,
-<b>cupsd</b>(8).
+<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8).</a>
It is normally located in the
<i>/etc/cups</i>
directory.
Comment lines start with the # character.
<h3><a name="TOP_LEVEL_DIRECTIVES">Top-level Directives</a></h3>
The following top-level directives are understood by
-<b>cupsd</b>(8):
+<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8):</a>
<dl class="man">
<dt><a name="AccessLogLevel"></a><b>AccessLogLevel config</b>
<dd style="margin-left: 5.0em"><dt><b>AccessLogLevel actions</b>
<dd style="margin-left: 5.0em"><dt><b>HostNameLookups Double</b>
<dd style="margin-left: 5.0em">Specifies whether to do reverse lookups on connecting clients.
The "Double" setting causes
-<b>cupsd</b>(8)
+<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8)</a>
to verify that the hostname resolved from the address matches one of the addresses returned for that hostname.
Double lookups also prevent clients with unregistered addresses from connecting to your server.
The default is "Off" to avoid the potential server performance problems with hostname lookups.
<dd style="margin-left: 5.0em">Specifies the length of time to wait before shutting down due to inactivity.
The default is "60" seconds.
Note: Only applicable when
-<b>cupsd</b>(8)
+<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8)</a>
is run on-demand (e.g., with <b>-l</b>).
<dt><a name="JobKillDelay"></a><b>JobKillDelay </b><i>seconds</i>
<dd style="margin-left: 5.0em">Specifies the number of seconds to wait before killing the filters and backend associated with a canceled or held job.
</dl>
<h3><a name="HTTP_METHOD_NAMES">Http Method Names</a></h3>
The following HTTP methods are supported by
-<b>cupsd</b>(8):
+<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8):</a>
<dl class="man">
<dt>GET
<dd style="margin-left: 5.0em">Used by a client to download icons and other printer resources and to access the CUPS web interface.
</dl>
<h3><a name="IPP_OPERATION_NAMES">Ipp Operation Names</a></h3>
The following IPP operations are supported by
-<b>cupsd</b>(8):
+<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8):</a>
<dl class="man">
<dt>CUPS-Accept-Jobs
<dd style="margin-left: 5.0em">Allows a printer to accept new jobs.
</dl>
<h3><a name="LOCATION_PATHS">Location Paths</a></h3>
The following paths are commonly used when configuring
-<b>cupsd</b>(8):
+<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8):</a>
<dl class="man">
<dt>/
<dd style="margin-left: 5.0em">The path for all get operations (get-printers, get-jobs, etc.)
<dt><b>Require user {</b><i>user-name</i>|<b>@</b><i>group-name</i>} ...
<dd style="margin-left: 5.0em">Specifies that an authenticated user must match one of the named users or be a member of one of the named groups.
The group name "@SYSTEM" corresponds to the list of groups defined by the SystemGroup directive in the
-<b>cups-files.conf</b>(5)
+<a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5)</a>
file.
The group name "@OWNER" corresponds to the owner of the resource, for example the person that submitted a print job.
Note: The 'root' user is not special and must be granted privileges like any other user account.
"@ACL" maps to the printer's requesting-user-name-allowed or requesting-user-name-denied values.
"@OWNER" maps to the job's owner.
"@SYSTEM" maps to the groups listed for the SystemGroup directive in the
-<b>cups-files.conf</b>(5)
+<a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5)</a>
file.
<dt><b>JobPrivateValues all</b>
<dd style="margin-left: 5.0em"><dt><b>JobPrivateValues default</b>
"@ACL" maps to the printer's requesting-user-name-allowed or requesting-user-name-denied values.
"@OWNER" maps to the job's owner.
"@SYSTEM" maps to the groups listed for the SystemGroup directive in the
-<b>cups-files.conf</b>(5)
+<a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5)</a>
file.
<dt><b>SubscriptionPrivateValues all</b>
<dd style="margin-left: 5.0em"><dt><b>SubscriptionPrivateValues default</b>
Sequences beginning with percent (%) characters are replaced with the corresponding information, while all other characters are copied literally.
The following percent sequences are recognized:
<pre class="man">
-
"%%" inserts a single percent character.
"%{name}" inserts the value of the specified IPP attribute.
"%C" inserts the number of copies for the current page.
</dl>
<h2 class="title"><a name="NOTES">Notes</a></h2>
File, directory, and user configuration directives that used to be allowed in the <b>cupsd.conf</b> file are now stored in the
-<b>cups-files.conf</b>(5)
+<a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5)</a>
file instead in order to prevent certain types of privilege escalation attacks.
<p>The scheduler MUST be restarted manually after making changes to the <b>cupsd.conf</b> file.
On Linux this is typically done using the
<h2 class="title"><a name="EXAMPLES">Examples</a></h2>
Log everything with a maximum log file size of 32 megabytes:
<pre class="man">
-
AccessLogLevel all
LogLevel debug2
MaxLogSize 32m
</pre>
Require authentication for accesses from outside the 10. network:
<pre class="man">
-
<Location />
Order allow,deny
Allow from 10./8
</Location>
</pre>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>classes.conf</b>(5),
-<b>cups-files.conf</b>(5),
-<b>cupsd</b>(8),
-<b>mime.convs</b>(5),
-<b>mime.types</b>(5),
-<b>printers.conf</b>(5),
-<b>subscriptions.conf</b>(5),
+<a href="man-classes.conf.html?TOPIC=Man+Pages"><b>classes.conf</b>(5),</a>
+<a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5),</a>
+<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a>
+<a href="man-mime.convs.html?TOPIC=Man+Pages"><b>mime.convs</b>(5),</a>
+<a href="man-mime.types.html?TOPIC=Man+Pages"><b>mime.types</b>(5),</a>
+<a href="man-printers.conf.html?TOPIC=Man+Pages"><b>printers.conf</b>(5),</a>
+<a href="man-subscriptions.conf.html?TOPIC=Man+Pages"><b>subscriptions.conf</b>(5),</a>
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright © 2020-2021 by OpenPrinting.
<b>cupsd</b>
in the background with the default configuration file:
<pre class="man">
-
cupsd
</pre>
Test a configuration file called
<i>test.conf</i>:
<pre class="man">
-
cupsd -t -c test.conf
</pre>
in the foreground with a test configuration file called
<i>test.conf</i>:
<pre class="man">
-
cupsd -f -c test.conf
</pre>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>backend</b>(7),
-<b>classes.conf</b>(5),
-<b>cups</b>(1),
-<b>cups-files.conf</b>(5),
-<b>cups-lpd</b>(8),
-<b>cupsd.conf</b>(5),
-<b>cupsd-helper</b>(8),
+<a href="man-backend.html?TOPIC=Man+Pages"><b>backend</b>(7),</a>
+<a href="man-classes.conf.html?TOPIC=Man+Pages"><b>classes.conf</b>(5),</a>
+<a href="man-cups.html?TOPIC=Man+Pages"><b>cups</b>(1),</a>
+<a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5),</a>
+<a href="man-cups-lpd.html?TOPIC=Man+Pages"><b>cups-lpd</b>(8),</a>
+<a href="man-cupsd.conf.html?TOPIC=Man+Pages"><b>cupsd.conf</b>(5),</a>
+<a href="man-cupsd-helper.html?TOPIC=Man+Pages"><b>cupsd-helper</b>(8),</a>
<b>cupsd-logs</b>(8),
-<b>filter</b>(7),
+<a href="man-filter.html?TOPIC=Man+Pages"><b>filter</b>(7),</a>
<b>launchd</b>(8),
-<b>mime.convs</b>(5),
-<b>mime.types</b>(5),
-<b>printers.conf</b>(5),
+<a href="man-mime.convs.html?TOPIC=Man+Pages"><b>mime.convs</b>(5),</a>
+<a href="man-mime.types.html?TOPIC=Man+Pages"><b>mime.types</b>(5),</a>
+<a href="man-printers.conf.html?TOPIC=Man+Pages"><b>printers.conf</b>(5),</a>
<b>systemd</b>(8),
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
<p>The CUPS versions of <b>disable</b> and <b>enable</b> may ask the user for an access password depending on the printing system configuration.
This differs from the System V versions which require the root user to execute these commands.
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>cupsaccept</b>(8),
+<a href="man-cupsaccept.html?TOPIC=Man+Pages"><b>cupsaccept</b>(8),</a>
<b>cupsreject</b>(8),
-<b>cancel</b>(1),
-<b>lp</b>(1),
-<b>lpadmin</b>(8),
-<b>lpstat</b>(1),
+<a href="man-cancel.html?TOPIC=Man+Pages"><b>cancel</b>(1),</a>
+<a href="man-lp.html?TOPIC=Man+Pages"><b>lp</b>(1),</a>
+<a href="man-lpadmin.html?TOPIC=Man+Pages"><b>lpadmin</b>(8),</a>
+<a href="man-lpstat.html?TOPIC=Man+Pages"><b>lpstat</b>(1),</a>
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright © 2021 by OpenPrinting.
returns a non-zero exit status on any error.
<h2 class="title"><a name="ENVIRONMENT">Environment</a></h2>
All of the standard
-<b>cups</b>(1)
+<a href="man-cups.html?TOPIC=Man+Pages"><b>cups</b>(1)</a>
environment variables affect the operation of
<b>cupsfilter</b>.
<h2 class="title"><a name="FILES">Files</a></h2>
<h2 class="title"><a name="NOTES">Notes</a></h2>
CUPS printer drivers, filters, and backends are deprecated and will no longer be supported in a future feature release of CUPS.
Printers that do not support IPP can be supported using applications such as
-<b>ippeveprinter</b>(1).
+<a href="man-ippeveprinter.html?TOPIC=Man+Pages"><b>ippeveprinter</b>(1).</a>
<p>Unlike when printing, filters run using the
<b>cupsfilter</b>
command use the current user and security session. This may result in different output or unexpected behavior.
<h2 class="title"><a name="EXAMPLE">Example</a></h2>
The following command will generate a PDF preview of job 42 for a printer named "myprinter" and save it to a file named "preview.pdf":
<pre class="man">
-
cupsfilter -m application/pdf -d myprinter -j 42 >preview.pdf
</pre>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>cups</b>(1),
-<b>cupsd.conf</b>(5),
+<a href="man-cups.html?TOPIC=Man+Pages"><b>cups</b>(1),</a>
+<a href="man-cupsd.conf.html?TOPIC=Man+Pages"><b>cupsd.conf</b>(5),</a>
<b>filter(7),</b>
<b>mime.convs</b>(7),
<b>mime.types</b>(7),
<h2 class="title"><a name="EXAMPLES">Examples</a></h2>
The following command will test all PPD files under the current directory and print the names of each file that does not conform:
<pre class="man">
-
find . -name \*.ppd \! -exec cupstestppd -q '{}' \; -print
</pre>
The next command tests all PPD files under the current directory and print detailed conformance testing results for the files that do not conform:
<pre class="man">
-
find . -name \*.ppd \! -exec cupstestppd -q '{}' \; \
-exec cupstestppd -v '{}' \;
</pre>
<h2 class="title"><a name="NOTES">Notes</a></h2>
PPD files are deprecated and will no longer be supported in a future feature release of CUPS.
Printers that do not support IPP can be supported using applications such as
-<b>ippeveprinter</b>(1).
+<a href="man-ippeveprinter.html?TOPIC=Man+Pages"><b>ippeveprinter</b>(1).</a>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>lpadmin</b>(8),
-CUPS Online Help (<a href="http://localhost:631/help)">http://localhost:631/help)</a>,
+<a href="man-lpadmin.html?TOPIC=Man+Pages"><b>lpadmin</b>(8),</a>
+CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>),
Adobe PostScript Printer Description File Format Specification, Version 4.3.
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright © 2021 by OpenPrinting.
<i>filename</i>
]
<pre class="man">
-
<b>#include <cups/cups.h></b>
<b>ssize_t cupsBackChannelRead</b>(<b>char *</b><i>buffer</i>, <b>size_t </b><i>bytes</i>,
<b>ppdFindMarkedChoice</b>()
to get the user-selected choice for a PPD option. For example, a filter might use the following code to determine the current value of the <b>Duplex</b> PPD option:
<pre class="man">
-
ppd_file_t *ppd = ppdOpenFile(getenv("PPD"));
cups_option_t *options = NULL;
int num_options = cupsParseOptions(argv[5], 0, &options);
<h2 class="title"><a name="NOTES">Notes</a></h2>
CUPS printer drivers and backends are deprecated and will no longer be supported in a future feature release of CUPS.
Printers that do not support IPP can be supported using applications such as
-<b>ippeveprinter</b>(1).
+<a href="man-ippeveprinter.html?TOPIC=Man+Pages"><b>ippeveprinter</b>(1).</a>
<p>CUPS filters are not meant to be run directly by the user.
Aside from the legacy System V interface issues (<i>argv[0]</i> is the printer name), CUPS filters also expect specific environment variables and file descriptors, and typically run in a user session that (on macOS) has additional restrictions that affect how it runs.
Unless you are a developer and know what you are doing, please do not run filters directly.
Instead, use the
-<b>cupsfilter</b>(8)
+<a href="man-cupsfilter.html?TOPIC=Man+Pages"><b>cupsfilter</b>(8)</a>
program to use the appropriate filters to do the conversions you need.
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>backend</b>(7),
-<b>cups</b>(1),
-<b>cups-files.conf</b>(5),
-<b>cupsd</b>(8),
-<b>cupsfilter</b>(8),
+<a href="man-backend.html?TOPIC=Man+Pages"><b>backend</b>(7),</a>
+<a href="man-cups.html?TOPIC=Man+Pages"><b>cups</b>(1),</a>
+<a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5),</a>
+<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a>
+<a href="man-cupsfilter.html?TOPIC=Man+Pages"><b>cupsfilter</b>(8),</a>
<br>
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
and
<b>ippeveps</b>
are print commands for
-<b>ippeveprinter</b>(1).
+<a href="man-ippeveprinter.html?TOPIC=Man+Pages"><b>ippeveprinter</b>(1).</a>
As with all print commands, these commands read either the filename specified on the command-line or from the standard input.
Output is sent to the standard output.
Status and progress messages are sent to the standard error.
<b>ippeveprinter</b>
looks for the command in the "command" subdirectory of the CUPS binary directory, typically /usr/lib/cups/command or /usr/libexec/cups/command.
The
-<b>cups-config</b>(1)
+<a href="man-cups-config.html?TOPIC=Man+Pages"><b>cups-config</b>(1)</a>
command can be used to discover the correct binary directory ("cups-config --serverbin").
In addition, the CUPS_SERVERBIN environment variable can be used to override the default location of this directory - see the
-<b>cups</b>(1)
+<a href="man-cups.html?TOPIC=Man+Pages"><b>cups</b>(1)</a>
man page for more details.
<dt><b>-d </b><i>spool-directory</i>
<dd style="margin-left: 5.0em">Specifies the directory that will hold the print files.
<b>ippeveprinter</b>
with a service name of My Cool Printer:
<pre class="man">
-
ippeveprinter "My Cool Printer"
</pre>
<p>Run the
<b>file</b>(1)
command whenever a job is sent to the server:
<pre class="man">
-
ippeveprinter -c /usr/bin/file "My Cool Printer"
</pre>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>ippevepcl</b>(7),
+<a href="man-ippevepcl.html?TOPIC=Man+Pages"><b>ippevepcl</b>(7),</a>
<b>ippeveps</b>(7),
PWG Internet Printing Protocol Workgroup (<a href="http://www.pwg.org/ipp">http://www.pwg.org/ipp</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
<h2 class="title"><a name="EXAMPLES">Examples</a></h2>
To show the status of all registered IPP printers on your network, run:
<pre class="man">
-
ippfind --ls
</pre>
Similarly, to send a PostScript test page to every PostScript printer, run:
<pre class="man">
-
ippfind --txt-pdl application/postscript --exec ipptool
-f onepage-letter.ps '{}' print-job.test \;
</pre>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>ipptool</b>(1)
+<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(1)</a>
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright © 2021 by OpenPrinting.
The
<i>testfile</i>
format is described in
-<b>ipptoolfile</b>(5).
+<a href="man-ipptoolfile.html?TOPIC=Man+Pages"><b>ipptoolfile</b>(5).</a>
<h2 class="title"><a name="OPTIONS">Options</a></h2>
The following options are recognized by
<b>ipptool:</b>
<h2 class="title"><a name="FILES">Files</a></h2>
The following standard files are available:
<pre class="man">
-<i>color.jpg</i>
-<i>create-printer-subscription.test</i>
-<i>document-a4.pdf</i>
-<i>document-a4.ps</i>
-<i>document-letter.pdf</i>
-<i>document-letter.ps</i>
-<i>get-completed-jobs.test</i>
-<i>get-jobs.test</i>
-<i>get-notifications.test</i>
-<i>get-printer-attributes.test</i>
-<i>get-subscriptions.test</i>
-<i>gray.jpg</i>
-<i>ipp-1.1.test</i>
-<i>ipp-2.0.test</i>
-<i>ipp-2.1.test</i>
-<i>ipp-2.2.test</i>
-<i>ipp-everywhere.test</i>
-<i>onepage-a4.pdf</i>
-<i>onepage-a4.ps</i>
-<i>onepage-letter.pdf</i>
-<i>onepage-letter.ps</i>
-<i>print-job.test</i>
-<i>print-job-deflate.test</i>
-<i>print-job-gzip.test</i>
-<i>testfile.jpg</i>
-<i>testfile.pcl</i>
-<i>testfile.pdf</i>
-<i>testfile.ps</i>
-<i>testfile.txt</i>
-<i>validate-job.test</i>
+ color.jpg
+ create-printer-subscription.test
+ document-a4.pdf
+ document-a4.ps
+ document-letter.pdf
+ document-letter.ps
+ get-completed-jobs.test
+ get-jobs.test
+ get-notifications.test
+ get-printer-attributes.test
+ get-subscriptions.test
+ gray.jpg
+ ipp-1.1.test
+ ipp-2.0.test
+ ipp-2.1.test
+ ipp-2.2.test
+ ipp-everywhere.test
+ onepage-a4.pdf
+ onepage-a4.ps
+ onepage-letter.pdf
+ onepage-letter.ps
+ print-job.test
+ print-job-deflate.test
+ print-job-gzip.test
+ testfile.jpg
+ testfile.pcl
+ testfile.pdf
+ testfile.ps
+ testfile.txt
+ validate-job.test
</pre>
<h2 class="title"><a name="CONFORMING_TO">Conforming To</a></h2>
The
<h2 class="title"><a name="EXAMPLES">Examples</a></h2>
Get a list of completed jobs for "myprinter":
<pre class="man">
-
ipptool ipp://localhost/printers/myprinter get-completed-jobs.test
</pre>
<p>Send email notifications to "user@example.com" when "myprinter" changes:
<pre class="man">
-
ipptool -d recipient=mailto:user@example.com \
ipp://localhost/printers/myprinter create-printer-subscription.test
</pre>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>ipptoolfile</b>(5),
-IANA IPP Registry (<a href="https://www.iana.org/assignments/ipp\-registrations)">https://www.iana.org/assignments/ipp\-registrations)</a>,
+<a href="man-ipptoolfile.html?TOPIC=Man+Pages"><b>ipptoolfile</b>(5),</a>
+IANA IPP Registry (<a href="https://www.iana.org/assignments/ipp-registrations">https://www.iana.org/assignments/ipp-registrations</a>),
PWG Internet Printing Protocol Workgroup (<a href="https://www.pwg.org/ipp">https://www.pwg.org/ipp</a>)
-RFC 8011 (<a href="https://datatracker.ietf.org/doc/html/rfc8011)">https://datatracker.ietf.org/doc/html/rfc8011)</a>,
+RFC 8011 (<a href="https://datatracker.ietf.org/doc/html/rfc8011">https://datatracker.ietf.org/doc/html/rfc8011</a>),
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright © 2021 by OpenPrinting.
ipptoolfile - ipptool file format
<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
The
-<b>ipptool</b>(1)
+<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(1)</a>
program accepts free-form plain text files that describe one or more IPP requests.
Comments start with the "#" character and continue to the end of the line.
Each request is enclosed by curly braces, for example:
<pre class="man">
-
# This is a comment
{
# The name of the test
Operation codes correspond to the hexadecimal numbers (0xHHHH) and names from RFC 8011 and other IPP extension specifications. Here is a complete list of names supported by
<b>ipptool</b>(8):
<pre class="man">
-
+ Acknowledge-Document
+ Acknowledge-Identify-Printer
+ Acknowledge-Job
Activate-Printer
+ Add-Document-Images
+ Allocate-Printer-Resources
+ Cancel-Current-Job
+ Cancel-Job
+ Cancel-Jobs
+ Cancel-My-Jobs
+ Cancel-Resource
+ Cancel-Subscription
+ Close-Job
+ Create-Job
+ Create-Job-Subscriptions
+ Create-Printer
+ Create-Printer-Subscriptions
+ Create-Resource
+ Create-Resource-Subscriptions
+ Create-System-Subscriptions
+ CUPS-Accept-Jobs
CUPS-Accept-Jobs
CUPS-Add-Modify-Class
CUPS-Add-Modify-Printer
CUPS-Authenticate-Job
+ CUPS-Create-Local-Printer
CUPS-Delete-Class
CUPS-Delete-Printer
CUPS-Get-Classes
CUPS-Move-Job
CUPS-Reject-Jobs
CUPS-Set-Default
- Cancel-Current-Job
- Cancel-Job
- Cancel-Jobs
- Cancel-My-Jobs
- Cancel-Subscription
- Close-Job
- Create-Job
- Create-Job-Subscriptions
- Create-Printer-Subscriptions
Deactivate-Printer
+ Deallocate-Printer-Resources
+ Delete-Printer
+ Deregister-Output-Device
+ Disable-All-Printers
Disable-Printer
+ Enable-All-Printers
Enable-Printer
+ Fetch-Document
+ Fetch-Job
Get-Job-Attributes
Get-Jobs
+ Get-Next-Document-Data
Get-Notifications
+ Get-Output-Device-Attributes
Get-Printer-Attributes
Get-Printer-Support-Files
Get-Printer-Supported-Values
+ Get-Printers
Get-Subscription-Attributes
Get-Subscriptions
+ Get-System-Attributes
+ Get-System-Supported-Values
Hold-Job
Hold-New-Jobs
Identify-Printer
+ Install-Resource
+ Pause-All-Printers
+ Pause-All-Printers-After-Current-Job
Pause-Printer
Pause-Printer-After-Current-Job
Print-Job
Print-URI
Promote-Job
Purge-Jobs
+ Register-Output-Device
Release-Held-New-Jobs
Release-Job
Renew-Subscription
Reprocess-Job
Restart-Job
Restart-Printer
+ Restart-System
Resubmit-Job
+ Resume-All-Printers
Resume-Job
Resume-Printer
Schedule-Job-After
Send-Document
Send-Hardcopy-Document
Send-Notifications
+ Send-Resource-Data
Send-URI
Set-Job-Attributes
Set-Printer-Attributes
+ Set-Resource-Attributes
+ Set-System-Attributes
+ Shutdown-All-Printers
+ Shutdown-One-Printer
Shutdown-Printer
+ Startup-All-Printers
+ Startup-One-Printer
Startup-Printer
Suspend-Current-Job
+ Update-Active-Jobs
+ Update-Document-Status
+ Update-Job-Status
+ Update-Output-Device-Attributes
Validate-Document
Validate-Job
</pre>
Status codes correspond to the hexadecimal numbers (0xHHHH) and names from RFC 8011 and other IPP extension specifications. Here is a complete list of the names supported by
<b>ipptool</b>(8):
<pre class="man">
-
client-error-account-authorization-failed
client-error-account-closed
client-error-account-info-needed
client-error-ignored-all-subscriptions
client-error-not-authenticated
client-error-not-authorized
+ client-error-not-fetchable
client-error-not-found
client-error-not-possible
client-error-print-support-file-not-found
<h3><a name="TAGS">Tags</a></h3>
Value and group tags correspond to the names from RFC 8011 and other IPP extension specifications. Here are the group tags:
<pre class="man">
-
document-attributes-tag
event-notification-attributes-tag
- job-attributes-tag
- operation-attributes-tag
- printer-attributes-tag
+ job | job-attributes-tag
+ operation | operation-attributes-tag
+ printer | printer-attributes-tag
+ resource-attributes-tag
subscription-attributes-tag
+ system-attributes-tag
unsupported-attributes-tag
</pre>
<p>Here are the value tags:
<pre class="man">
-
admin-define
boolean
charset
- collection
+ collection | begCollection
dateTime
default
delete-attribute
enum
integer
keyword
- mimeMediaType
- nameWithLanguage
- nameWithoutLanguage
- naturalLanguage
+ language | naturalLanguage
+ mimetype | mimeMediaType
+ name | nameWithLanguage | nameWithoutLanguage
no-value
not-settable
octetString
rangeOfInteger
resolution
- textWithLanguage
- textWithoutLanguage
+ text | textWithLanguage | textWithoutLanguage
unknown
unsupported
uri
<dd style="margin-left: 5.0em">Inserts the current user's login name.
</dl>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>ipptool</b>(1),
-IANA IPP Registry (<a href="https://www.iana.org/assignments/ipp-registrations)">https://www.iana.org/assignments/ipp-registrations)</a>,
-PWG Internet Printing Protocol Workgroup (<a href="https://www.pwg.org/ipp)">https://www.pwg.org/ipp)</a>,
+<a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(1),</a>
+IANA IPP Registry (<a href="https://www.iana.org/assignments/ipp-registrations">https://www.iana.org/assignments/ipp-registrations</a>),
+PWG Internet Printing Protocol Workgroup (<a href="https://www.pwg.org/ipp">https://www.pwg.org/ipp</a>),
RFC 8011 (<a href="https://datatracker.ietf.org/doc/html/rfc8011">https://datatracker.ietf.org/doc/html/rfc8011</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright © 2021 by OpenPrinting.
<h3><a name="THE_DEFAULT_DESTINATION">The Default Destination</a></h3>
CUPS provides many ways to set the default destination. The <b>LPDEST</b> and <b>PRINTER</b> environment variables are consulted first.
If neither are set, the current default set using the
-<b>lpoptions</b>(1)
+<a href="man-lpoptions.html?TOPIC=Man+Pages"><b>lpoptions</b>(1)</a>
command is used, followed by the default set using the
-<b>lpadmin</b>(8)
+<a href="man-lpadmin.html?TOPIC=Man+Pages"><b>lpadmin</b>(8)</a>
command.
<h2 class="title"><a name="OPTIONS">Options</a></h2>
The following options are recognized by <i>lp</i>:
</dl>
<h3><a name="COMMON_JOB_OPTIONS">Common Job Options</a></h3>
Aside from the printer-specific options reported by the
-<b>lpoptions</b>(1)
+<a href="man-lpoptions.html?TOPIC=Man+Pages"><b>lpoptions</b>(1)</a>
command, the following generic options are available:
<dl class="man">
<dt><b>-o job-sheets=</b><i>name</i>
<h2 class="title"><a name="EXAMPLES">Examples</a></h2>
Print two copies of a document to the default printer:
<pre class="man">
-
lp -n 2 filename
</pre>
Print a double-sided legal document to a printer called "foo":
<pre class="man">
-
lp -d foo -o media=legal -o sides=two-sided-long-edge filename
</pre>
Print a presentation document 2-up to a printer called "bar":
<pre class="man">
-
lp -d bar -o number-up=2 filename
</pre>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>cancel</b>(1),
-<b>lpadmin</b>(8),
-<b>lpoptions</b>(1),
-<b>lpq</b>(1),
-<b>lpr</b>(1),
-<b>lprm</b>(1),
-<b>lpstat</b>(1),
+<a href="man-cancel.html?TOPIC=Man+Pages"><b>cancel</b>(1),</a>
+<a href="man-lpadmin.html?TOPIC=Man+Pages"><b>lpadmin</b>(8),</a>
+<a href="man-lpoptions.html?TOPIC=Man+Pages"><b>lpoptions</b>(1),</a>
+<a href="man-lpq.html?TOPIC=Man+Pages"><b>lpq</b>(1),</a>
+<a href="man-lpr.html?TOPIC=Man+Pages"><b>lpr</b>(1),</a>
+<a href="man-lprm.html?TOPIC=Man+Pages"><b>lprm</b>(1),</a>
+<a href="man-lpstat.html?TOPIC=Man+Pages"><b>lpstat</b>(1),</a>
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright © 2021 by OpenPrinting.
<p>When specified before the <i>-d</i>, <i>-p</i>, or <i>-x</i> options, the <i>-E</i> option forces encryption when connecting to the server.
<p>The first form of the command (<i>-d</i>) sets the default printer or class to <i>destination</i>.
Subsequent print jobs submitted via the
-<b>lp</b>(1)
+<a href="man-lp.html?TOPIC=Man+Pages"><b>lp</b>(1)</a>
or
-<b>lpr</b>(1)
+<a href="man-lpr.html?TOPIC=Man+Pages"><b>lpr</b>(1)</a>
commands will use this destination unless the user specifies otherwise with the
-<b>lpoptions</b>(1)
+<a href="man-lpoptions.html?TOPIC=Man+Pages"><b>lpoptions</b>(1)</a>
command.
<p>The second form of the command (<i>-p</i>) configures the named printer or class. The additional options are described below.
<p>The third form of the command (<i>-x</i>) deletes the printer or class <i>destination</i>.
<dt><b>-m </b><i>model</i>
<dd style="margin-left: 5.0em">Sets a standard PPD file for the printer from the <i>model</i> directory or using one of the driver interfaces.
Use the <i>-m</i> option with the
-<b>lpinfo</b>(8)
+<a href="man-lpinfo.html?TOPIC=Man+Pages"><b>lpinfo</b>(8)</a>
command to get a list of supported models.
The model "raw" clears any existing PPD file and the model "everywhere" queries the printer referred to by the specified IPP <i>device-uri</i>.
Note: Models other than "everywhere" are deprecated and will not be supported in a future version of CUPS.
<dt><b>-o </b><i>name</i><b>=</b><i>value</i>
<dd style="margin-left: 5.0em">Sets a PPD option for the printer.
PPD options can be listed using the <i>-l</i> option with the
-<b>lpoptions</b>(1)
+<a href="man-lpoptions.html?TOPIC=Man+Pages"><b>lpoptions</b>(1)</a>
command.
<dt><b>-o </b><i>name</i><b>-default=</b><i>value</i>
<dd style="margin-left: 5.0em">Sets a default server-side option for the destination.
<dt><b>-v "</b><i>device-uri</i><b>"</b>
<dd style="margin-left: 5.0em">Sets the <i>device-uri</i> attribute of the printer queue.
Use the <i>-v</i> option with the
-<b>lpinfo</b>(8)
+<a href="man-lpinfo.html?TOPIC=Man+Pages"><b>lpinfo</b>(8)</a>
command to get a list of supported device URIs and schemes.
<dt><b>-D "</b><i>info</i><b>"</b>
<dd style="margin-left: 5.0em">Provides a textual description of the destination.
<dt><b>-E</b>
<dd style="margin-left: 5.0em">When specified before the <b>-d</b>, <b>-p</b>, or <b>-x</b> options, forces the use of TLS encryption on the connection to the scheduler.
Otherwise, enables the destination and accepts jobs; this is the same as running the
-<b>cupsaccept</b>(8)
+<a href="man-cupsaccept.html?TOPIC=Man+Pages"><b>cupsaccept</b>(8)</a>
and
-<b>cupsenable</b>(8)
+<a href="man-cupsenable.html?TOPIC=Man+Pages"><b>cupsenable</b>(8)</a>
programs on the destination.
<dt><b>-L "</b><i>location</i><b>"</b>
<dd style="margin-left: 5.0em">Provides a textual location of the destination.
<h2 class="title"><a name="NOTES">Notes</a></h2>
CUPS printer drivers and backends are deprecated and will no longer be supported in a future feature release of CUPS.
Printers that do not support IPP can be supported using applications such as
-<b>ippeveprinter</b>(1).
+<a href="man-ippeveprinter.html?TOPIC=Man+Pages"><b>ippeveprinter</b>(1).</a>
<p>The CUPS version of <b>lpadmin</b> does not support all of the System V or Solaris printing system configuration options.
<p>Interface scripts are not supported for security reasons.
<p>The double meaning of the <b>-E</b> option is an unfortunate historical oddity.
<h2 class="title"><a name="EXAMPLE">Example</a></h2>
Create an IPP Everywhere print queue:
<pre class="man">
-
lpadmin -p myprinter -E -v ipp://myprinter.local/ipp/print -m everywhere
</pre>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>cupsaccept</b>(8),
-<b>cupsenable</b>(8),
-<b>lpinfo</b>(8),
-<b>lpoptions</b>(1),
+<a href="man-cupsaccept.html?TOPIC=Man+Pages"><b>cupsaccept</b>(8),</a>
+<a href="man-cupsenable.html?TOPIC=Man+Pages"><b>cupsenable</b>(8),</a>
+<a href="man-lpinfo.html?TOPIC=Man+Pages"><b>lpinfo</b>(8),</a>
+<a href="man-lpoptions.html?TOPIC=Man+Pages"><b>lpoptions</b>(1),</a>
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright © 2021 by OpenPrinting.
This program is deprecated and will be removed in a future feature release of CUPS.
<p>Since <b>lpc</b> is geared towards the Berkeley printing system, it is impossible to use <b>lpc</b> to configure printer or class queues provided by CUPS.
To configure printer or class queues you must use the
-<b>lpadmin</b>(8)
+<a href="man-lpadmin.html?TOPIC=Man+Pages"><b>lpadmin</b>(8)</a>
command or another CUPS-compatible client with that functionality.
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>cancel</b>(1),
-<b>cupsaccept</b>(8),
-<b>cupsenable</b>(8),
-<b>lp</b>(1),
-<b>lpadmin</b>(8),
-<b>lpr</b>(1),
-<b>lprm</b>(1),
-<b>lpstat</b>(1),
+<a href="man-cancel.html?TOPIC=Man+Pages"><b>cancel</b>(1),</a>
+<a href="man-cupsaccept.html?TOPIC=Man+Pages"><b>cupsaccept</b>(8),</a>
+<a href="man-cupsenable.html?TOPIC=Man+Pages"><b>cupsenable</b>(8),</a>
+<a href="man-lp.html?TOPIC=Man+Pages"><b>lp</b>(1),</a>
+<a href="man-lpadmin.html?TOPIC=Man+Pages"><b>lpadmin</b>(8),</a>
+<a href="man-lpr.html?TOPIC=Man+Pages"><b>lpr</b>(1),</a>
+<a href="man-lprm.html?TOPIC=Man+Pages"><b>lprm</b>(1),</a>
+<a href="man-lpstat.html?TOPIC=Man+Pages"><b>lpstat</b>(1),</a>
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright © 2021 by OpenPrinting.
<h2 class="title"><a name="EXAMPLES">Examples</a></h2>
List all devices:
<pre class="man">
-
lpinfo -v
</pre>
List all drivers:
<pre class="man">
-
lpinfo -m
</pre>
List drivers matching "HP LaserJet":
<pre class="man">
-
lpinfo --make-and-model "HP LaserJet" -m
</pre>
<h2 class="title"><a name="NOTES">Notes</a></h2>
CUPS printer drivers and backends are deprecated and will no longer be supported in a future feature release of CUPS.
Printers that do not support IPP can be supported using applications such as
-<b>ippeveprinter</b>(1).
+<a href="man-ippeveprinter.html?TOPIC=Man+Pages"><b>ippeveprinter</b>(1).</a>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>lpadmin</b>(8),
+<a href="man-lpadmin.html?TOPIC=Man+Pages"><b>lpadmin</b>(8),</a>
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright © 2021 by OpenPrinting.
<h2 class="title"><a name="EXAMPLES">Examples</a></h2>
Move job 123 from "oldprinter" to "newprinter":
<pre class="man">
-
lpmove 123 newprinter
<i>or</i>
</pre>
Move all jobs from "oldprinter" to "newprinter":
<pre class="man">
-
lpmove oldprinter newprinter
</pre>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>cancel</b>(1),
-<b>lp</b>(1),
-<b>lpr</b>(1),
-<b>lprm</b>(1),
+<a href="man-cancel.html?TOPIC=Man+Pages"><b>cancel</b>(1),</a>
+<a href="man-lp.html?TOPIC=Man+Pages"><b>lp</b>(1),</a>
+<a href="man-lpr.html?TOPIC=Man+Pages"><b>lpr</b>(1),</a>
+<a href="man-lprm.html?TOPIC=Man+Pages"><b>lprm</b>(1),</a>
<br>
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
<b>lpoptions</b> displays or sets printer options and defaults.
If no printer is specified using the <i>-p</i> option, the default printer is used as described in
-<b>lp</b>(1).
+<a href="man-lp.html?TOPIC=Man+Pages"><b>lp</b>(1).</a>
<p>If no <i>-l</i>, <i>-o</i>, or <i>-r</i> options are specified, the current options are reported on the standard output.
<p>Options set with the <b>lpoptions</b> command are used by the
-<b>lp</b>(1)
+<a href="man-lp.html?TOPIC=Man+Pages"><b>lp</b>(1)</a>
and
-<b>lpr</b>(1)
+<a href="man-lpr.html?TOPIC=Man+Pages"><b>lpr</b>(1)</a>
commands when submitting jobs.
<p>When run by the root user, <b>lpoptions</b> gets and sets default options and instances for all users in the <i>/etc/cups/lpoptions</i> file.
Otherwise, the per-user defaults are managed in the <i>~/.cups/lpoptions</i> file.
<dd style="margin-left: 5.0em">Sets the destination and instance, if specified, for any options that follow.
If the named instance does not exist then it is created.
Destinations can only be created using the
-<b>lpadmin</b>(8)
+<a href="man-lpadmin.html?TOPIC=Man+Pages"><b>lpadmin</b>(8)</a>
program.
<dt><b>-r </b><i>option</i>
<dd style="margin-left: 5.0em">Removes the specified option from the named destination.
<dd style="margin-left: 5.0em">Removes the options for the named destination and instance, if specified.
If the named instance does not exist then this does nothing.
Destinations can only be removed using the
-<b>lpadmin</b>(8)
+<a href="man-lpadmin.html?TOPIC=Man+Pages"><b>lpadmin</b>(8)</a>
command.
</dl>
<h2 class="title"><a name="FILES">Files</a></h2>
<h2 class="title"><a name="CONFORMING_TO">Conforming To</a></h2>
The <b>lpoptions</b> command is unique to CUPS.
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>cancel</b>(1),
-<b>lp</b>(1),
-<b>lpadmin</b>(8),
-<b>lpr</b>(1),
-<b>lprm</b>(1),
+<a href="man-cancel.html?TOPIC=Man+Pages"><b>cancel</b>(1),</a>
+<a href="man-lp.html?TOPIC=Man+Pages"><b>lp</b>(1),</a>
+<a href="man-lpadmin.html?TOPIC=Man+Pages"><b>lpadmin</b>(8),</a>
+<a href="man-lpr.html?TOPIC=Man+Pages"><b>lpr</b>(1),</a>
+<a href="man-lprm.html?TOPIC=Man+Pages"><b>lprm</b>(1),</a>
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright © 2021 by OpenPrinting.
<dd style="margin-left: 5.0em">Requests a more verbose (long) reporting format.
</dl>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>cancel</b>(1),
-<b>lp</b>(1),
-<b>lpr</b>(1),
-<b>lprm</b>(1),
-<b>lpstat</b>(1),
+<a href="man-cancel.html?TOPIC=Man+Pages"><b>cancel</b>(1),</a>
+<a href="man-lp.html?TOPIC=Man+Pages"><b>lp</b>(1),</a>
+<a href="man-lpr.html?TOPIC=Man+Pages"><b>lpr</b>(1),</a>
+<a href="man-lprm.html?TOPIC=Man+Pages"><b>lprm</b>(1),</a>
+<a href="man-lpstat.html?TOPIC=Man+Pages"><b>lpstat</b>(1),</a>
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright © 2021 by OpenPrinting.
<h3><a name="THE_DEFAULT_DESTINATION">The Default Destination</a></h3>
CUPS provides many ways to set the default destination. The <b>LPDEST</b> and <b>PRINTER</b> environment variables are consulted first.
If neither are set, the current default set using the
-<b>lpoptions</b>(1)
+<a href="man-lpoptions.html?TOPIC=Man+Pages"><b>lpoptions</b>(1)</a>
command is used, followed by the default set using the
-<b>lpadmin</b>(8)
+<a href="man-lpadmin.html?TOPIC=Man+Pages"><b>lpadmin</b>(8)</a>
command.
<h2 class="title"><a name="OPTIONS">Options</a></h2>
The following options are recognized by <i>lpr</i>:
</dl>
<h3><a name="COMMON_JOB_OPTIONS">Common Job Options</a></h3>
Aside from the printer-specific options reported by the
-<b>lpoptions</b>(1)
+<a href="man-lpoptions.html?TOPIC=Man+Pages"><b>lpoptions</b>(1)</a>
command, the following generic options are available:
<dl class="man">
<dt><b>-o job-sheets=</b><i>name</i>
<h2 class="title"><a name="EXAMPLES">Examples</a></h2>
Print two copies of a document to the default printer:
<pre class="man">
-
lpr -# 2 filename
</pre>
Print a double-sided legal document to a printer called "foo":
<pre class="man">
-
lpr -P foo -o media=legal -o sides=two-sided-long-edge filename
</pre>
Print a presentation document 2-up to a printer called "foo":
<pre class="man">
-
lpr -P foo -o number-up=2 filename
</pre>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>cancel</b>(1),
-<b>lp</b>(1),
-<b>lpadmin</b>(8),
-<b>lpoptions</b>(1),
-<b>lpq</b>(1),
-<b>lprm</b>(1),
-<b>lpstat</b>(1),
+<a href="man-cancel.html?TOPIC=Man+Pages"><b>cancel</b>(1),</a>
+<a href="man-lp.html?TOPIC=Man+Pages"><b>lp</b>(1),</a>
+<a href="man-lpadmin.html?TOPIC=Man+Pages"><b>lpadmin</b>(8),</a>
+<a href="man-lpoptions.html?TOPIC=Man+Pages"><b>lpoptions</b>(1),</a>
+<a href="man-lpq.html?TOPIC=Man+Pages"><b>lpq</b>(1),</a>
+<a href="man-lprm.html?TOPIC=Man+Pages"><b>lprm</b>(1),</a>
+<a href="man-lpstat.html?TOPIC=Man+Pages"><b>lpstat</b>(1),</a>
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright © 2021 by OpenPrinting.
<h2 class="title"><a name="EXAMPLES">Examples</a></h2>
Cancel the current job on the default printer:
<pre class="man">
-
lprm
</pre>
Cancel job 1234:
<pre class="man">
-
lprm 1234
</pre>
Cancel all jobs:
<pre class="man">
-
lprm -
</pre>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>cancel</b>(1),
-<b>lp</b>(1),
-<b>lpq</b>(1),
-<b>lpr</b>(1),
-<b>lpstat</b>(1),
+<a href="man-cancel.html?TOPIC=Man+Pages"><b>cancel</b>(1),</a>
+<a href="man-lp.html?TOPIC=Man+Pages"><b>lp</b>(1),</a>
+<a href="man-lpq.html?TOPIC=Man+Pages"><b>lpq</b>(1),</a>
+<a href="man-lpr.html?TOPIC=Man+Pages"><b>lpr</b>(1),</a>
+<a href="man-lpstat.html?TOPIC=Man+Pages"><b>lpstat</b>(1),</a>
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright © 2021 by OpenPrinting.
<p>The <i>-h</i>, <i>-e</i>, <i>-E</i>, <i>-U</i>, and <i>-W</i> options are unique to CUPS.
<p>The Solaris <i>-f</i>, <i>-P</i>, and <i>-S</i> options are silently ignored.
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>cancel</b>(1),
-<b>lp</b>(1),
-<b>lpq</b>(1),
-<b>lpr</b>(1),
-<b>lprm</b>(1),
+<a href="man-cancel.html?TOPIC=Man+Pages"><b>cancel</b>(1),</a>
+<a href="man-lp.html?TOPIC=Man+Pages"><b>lp</b>(1),</a>
+<a href="man-lpq.html?TOPIC=Man+Pages"><b>lpq</b>(1),</a>
+<a href="man-lpr.html?TOPIC=Man+Pages"><b>lpr</b>(1),</a>
+<a href="man-lprm.html?TOPIC=Man+Pages"><b>lprm</b>(1),</a>
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright © 2021 by OpenPrinting.
<dd style="margin-left: 5.0em">Specifies a prefix string for the subject line of an email notification.
</dl>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>cupsd</b>(8),
+<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a>
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright © 2021 by OpenPrinting.
Comment lines start with the # character.
Filter lines specify the source and destination MIME types along with a relative cost associated with the filter and the filter to run:
<pre class="man">
-
source/type destination/type cost filter
</pre>
<h2 class="title"><a name="EXAMPLES">Examples</a></h2>
Define a filter that converts PostScript documents to CUPS Raster format:
<pre class="man">
-
application/vnd.cups-postscript application/vnd.cups-raster 50 pstoraster
</pre>
<h2 class="title"><a name="NOTES">Notes</a></h2>
CUPS filters are deprecated and will no longer be supported in a future feature release of CUPS.
Printers that do not support IPP can be supported using applications such as
-<b>ippeveprinter</b>(1).
+<a href="man-ippeveprinter.html?TOPIC=Man+Pages"><b>ippeveprinter</b>(1).</a>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>cups-files.conf</b>(5),
-<b>cupsd.conf</b>(5),
-<b>cupsd</b>(8),
-<b>cupsfilter</b>(8),
-<b>mime.types</b>(5),
+<a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5),</a>
+<a href="man-cupsd.conf.html?TOPIC=Man+Pages"><b>cupsd.conf</b>(5),</a>
+<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a>
+<a href="man-cupsfilter.html?TOPIC=Man+Pages"><b>cupsfilter</b>(8),</a>
+<a href="man-mime.types.html?TOPIC=Man+Pages"><b>mime.types</b>(5),</a>
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright © 2021 by OpenPrinting.
Comment lines start with the # character.
Rule lines start with the MIME media type and are optionally followed by a series of file recognition rules:
<pre class="man">
-
<i>mime/type </i>[ <i>rule </i>... <i>rule </i>]
</pre>
Rules can be extended over multiple lines using the backslash character (\):
<pre class="man">
-
<i>mime/type </i>[ <i>really-really-really-long-rule </i>... <b>\
</b><i>rule </i>]
<h2 class="title"><a name="EXAMPLES">Examples</a></h2>
Define two MIME media types for raster data, with one being a subset with higher priority:
<pre class="man">
-
application/vnd.cups-raster string(0,"RaSt") string(0,"tSaR") \
string(0,"RaS2") string(0,"2SaR") \
string(0,"RaS3") string(0,"3SaR")
string(4,PwgRaster<00>) priority(150)
</pre>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>cups-files.conf</b>(5),
-<b>cupsd.conf</b>(5),
-<b>cupsd</b>(8),
-<b>cupsfilter</b>(8),
-<b>mime.convs</b>(5),
+<a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5),</a>
+<a href="man-cupsd.conf.html?TOPIC=Man+Pages"><b>cupsd.conf</b>(5),</a>
+<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a>
+<a href="man-cupsfilter.html?TOPIC=Man+Pages"><b>cupsfilter</b>(8),</a>
+<a href="man-mime.convs.html?TOPIC=Man+Pages"><b>mime.convs</b>(5),</a>
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright © 2021 by OpenPrinting.
functions and exit on error.
Notifiers are encouraged to exit after a suitable period of inactivity, however they may exit after reading the first message or stay running until an error is seen.
Notifiers inherit the environment and can use the logging mechanism documented in
-<b>filter</b>(7).
+<a href="man-filter.html?TOPIC=Man+Pages"><b>filter</b>(7).</a>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>cupsd</b>(8),
-<b>filter</b>(7),
+<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a>
+<a href="man-filter.html?TOPIC=Man+Pages"><b>filter</b>(7),</a>
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright © 2021 by OpenPrinting.
<h2 class="title"><a name="NOTES">Notes</a></h2>
PPD files are deprecated and will no longer be supported in a future feature release of CUPS.
Printers that do not support IPP can be supported using applications such as
-<b>ippeveprinter</b>(1).
+<a href="man-ippeveprinter.html?TOPIC=Man+Pages"><b>ippeveprinter</b>(1).</a>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>ppdhtml</b>(1),
-<b>ppdi</b>(1),
-<b>ppdmerge</b>(1),
-<b>ppdpo</b>(1),
-<b>ppdcfile</b>(5),
+<a href="man-ppdhtml.html?TOPIC=Man+Pages"><b>ppdhtml</b>(1),</a>
+<a href="man-ppdi.html?TOPIC=Man+Pages"><b>ppdi</b>(1),</a>
+<a href="man-ppdmerge.html?TOPIC=Man+Pages"><b>ppdmerge</b>(1),</a>
+<a href="man-ppdpo.html?TOPIC=Man+Pages"><b>ppdpo</b>(1),</a>
+<a href="man-ppdcfile.html?TOPIC=Man+Pages"><b>ppdcfile</b>(5),</a>
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright © 2021 by OpenPrinting.
ppdcfile - cups ppd compiler source file format (deprecated)
<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
The CUPS PPD compiler reads meta files that contain descriptions of one or more PPD files to be generated by
-<b>ppdc</b>(1).
+<a href="man-ppdc.html?TOPIC=Man+Pages"><b>ppdc</b>(1).</a>
This man page provides a quick reference to the supported keywords and should be used in conjunction with the online help for CUPS.
<p>The source file format is plain ASCII text that can be edited using your favorite text editor. Comments are supported using the C (/* ... */) and C++ (// ...) comment mechanisms.
<p>Printer driver information can be grouped and shared using curly braces ({ ... }); PPD files are written when a close brace or end-of-file is seen and a PCFileName directive has been defined.
<h2 class="title"><a name="NOTES">Notes</a></h2>
PPD files are deprecated and will no longer be supported in a future feature release of CUPS.
Printers that do not support IPP can be supported using applications such as
-<b>ippeveprinter</b>(1).
+<a href="man-ippeveprinter.html?TOPIC=Man+Pages"><b>ippeveprinter</b>(1).</a>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>ppdc</b>(1),
-<b>ppdhtml</b>(1),
-<b>ppdi</b>(1),
-<b>ppdmerge</b>(1),
-<b>ppdpo</b>(1),
+<a href="man-ppdc.html?TOPIC=Man+Pages"><b>ppdc</b>(1),</a>
+<a href="man-ppdhtml.html?TOPIC=Man+Pages"><b>ppdhtml</b>(1),</a>
+<a href="man-ppdi.html?TOPIC=Man+Pages"><b>ppdi</b>(1),</a>
+<a href="man-ppdmerge.html?TOPIC=Man+Pages"><b>ppdmerge</b>(1),</a>
+<a href="man-ppdpo.html?TOPIC=Man+Pages"><b>ppdpo</b>(1),</a>
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright © 2021 by OpenPrinting.
<h2 class="title"><a name="NOTES">Notes</a></h2>
PPD files are deprecated and will no longer be supported in a future feature release of CUPS.
Printers that do not support IPP can be supported using applications such as
-<b>ippeveprinter</b>(1).
+<a href="man-ippeveprinter.html?TOPIC=Man+Pages"><b>ippeveprinter</b>(1).</a>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>ppdc</b>(1),
-<b>ppdcfile</b>(5),
-<b>ppdi</b>(1),
-<b>ppdmerge</b>(1),
-<b>ppdpo</b>(1),
+<a href="man-ppdc.html?TOPIC=Man+Pages"><b>ppdc</b>(1),</a>
+<a href="man-ppdcfile.html?TOPIC=Man+Pages"><b>ppdcfile</b>(5),</a>
+<a href="man-ppdi.html?TOPIC=Man+Pages"><b>ppdi</b>(1),</a>
+<a href="man-ppdmerge.html?TOPIC=Man+Pages"><b>ppdmerge</b>(1),</a>
+<a href="man-ppdpo.html?TOPIC=Man+Pages"><b>ppdpo</b>(1),</a>
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright © 2021 by OpenPrinting.
<h2 class="title"><a name="NOTES">Notes</a></h2>
PPD files are deprecated and will no longer be supported in a future feature release of CUPS.
Printers that do not support IPP can be supported using applications such as
-<b>ippeveprinter</b>(1).
+<a href="man-ippeveprinter.html?TOPIC=Man+Pages"><b>ippeveprinter</b>(1).</a>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>ppdc</b>(1),
-<b>ppdhtml</b>(1),
-<b>ppdmerge</b>(1),
-<b>ppdpo</b>(1),
-<b>ppdcfile</b>(5),
+<a href="man-ppdc.html?TOPIC=Man+Pages"><b>ppdc</b>(1),</a>
+<a href="man-ppdhtml.html?TOPIC=Man+Pages"><b>ppdhtml</b>(1),</a>
+<a href="man-ppdmerge.html?TOPIC=Man+Pages"><b>ppdmerge</b>(1),</a>
+<a href="man-ppdpo.html?TOPIC=Man+Pages"><b>ppdpo</b>(1),</a>
+<a href="man-ppdcfile.html?TOPIC=Man+Pages"><b>ppdcfile</b>(5),</a>
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright © 2021 by OpenPrinting.
<h2 class="title"><a name="NOTES">Notes</a></h2>
PPD files are deprecated and will no longer be supported in a future feature release of CUPS.
Printers that do not support IPP can be supported using applications such as
-<b>ippeveprinter</b>(1).
+<a href="man-ippeveprinter.html?TOPIC=Man+Pages"><b>ippeveprinter</b>(1).</a>
<p><b>ppdmerge</b> does not check whether the merged PPD files are for the same device.
Merging of different device PPDs will yield unpredictable results.
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>ppdc</b>(1),
-<b>ppdhtml</b>(1),
-<b>ppdi</b>(1),
-<b>ppdpo</b>(1),
-<b>ppdcfile</b>(5),
+<a href="man-ppdc.html?TOPIC=Man+Pages"><b>ppdc</b>(1),</a>
+<a href="man-ppdhtml.html?TOPIC=Man+Pages"><b>ppdhtml</b>(1),</a>
+<a href="man-ppdi.html?TOPIC=Man+Pages"><b>ppdi</b>(1),</a>
+<a href="man-ppdpo.html?TOPIC=Man+Pages"><b>ppdpo</b>(1),</a>
+<a href="man-ppdcfile.html?TOPIC=Man+Pages"><b>ppdcfile</b>(5),</a>
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright © 2021 by OpenPrinting.
<h2 class="title"><a name="NOTES">Notes</a></h2>
PPD files are deprecated and will no longer be supported in a future feature release of CUPS.
Printers that do not support IPP can be supported using applications such as
-<b>ippeveprinter</b>(1).
+<a href="man-ippeveprinter.html?TOPIC=Man+Pages"><b>ippeveprinter</b>(1).</a>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>ppdc</b>(1),
-<b>ppdhtml</b>(1),
-<b>ppdi</b>(1),
-<b>ppdmerge</b>(1),
+<a href="man-ppdc.html?TOPIC=Man+Pages"><b>ppdc</b>(1),</a>
+<a href="man-ppdhtml.html?TOPIC=Man+Pages"><b>ppdhtml</b>(1),</a>
+<a href="man-ppdi.html?TOPIC=Man+Pages"><b>ppdi</b>(1),</a>
+<a href="man-ppdmerge.html?TOPIC=Man+Pages"><b>ppdmerge</b>(1),</a>
<b>ppdcfile(5),</b>
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
printers.conf - printer configuration file for cups
<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
The <b>printers.conf</b> file defines the local printers that are available. It is normally located in the <i>/etc/cups</i> directory and is maintained by the
-<b>cupsd</b>(8)
+<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8)</a>
program. This file is not intended to be edited or managed manually.
<h2 class="title"><a name="NOTES">Notes</a></h2>
The name, location, and format of this file are an implementation detail that will change in future releases of CUPS.
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>classes.conf</b>(5),
-<b>cups-files.conf</b>(5),
-<b>cupsd</b>(8),
-<b>cupsd.conf</b>(5),
-<b>mime.convs</b>(5),
-<b>mime.types</b>(5),
-<b>subscriptions.conf</b>(5),
+<a href="man-classes.conf.html?TOPIC=Man+Pages"><b>classes.conf</b>(5),</a>
+<a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5),</a>
+<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a>
+<a href="man-cupsd.conf.html?TOPIC=Man+Pages"><b>cupsd.conf</b>(5),</a>
+<a href="man-mime.convs.html?TOPIC=Man+Pages"><b>mime.convs</b>(5),</a>
+<a href="man-mime.types.html?TOPIC=Man+Pages"><b>mime.types</b>(5),</a>
+<a href="man-subscriptions.conf.html?TOPIC=Man+Pages"><b>subscriptions.conf</b>(5),</a>
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright © 2021 by OpenPrinting.
<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
The <b>subscriptions.conf</b> file defines the local event notification subscriptions that are active.
It is normally located in the <i>/etc/cups</i> directory and is maintained by the
-<b>cupsd</b>(8)
+<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8)</a>
program.
This file is not intended to be edited or managed manually.
<h2 class="title"><a name="NOTES">Notes</a></h2>
The name, location, and format of this file are an implementation detail that will change in future releases of CUPS.
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>classes.conf</b>(5),
-<b>cups-files.conf</b>(5),
-<b>cupsd</b>(8),
-<b>cupsd.conf</b>(5),
-<b>mime.convs</b>(5),
-<b>mime.types</b>(5),
-<b>printers.conf</b>(5),
+<a href="man-classes.conf.html?TOPIC=Man+Pages"><b>classes.conf</b>(5),</a>
+<a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5),</a>
+<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a>
+<a href="man-cupsd.conf.html?TOPIC=Man+Pages"><b>cupsd.conf</b>(5),</a>
+<a href="man-mime.convs.html?TOPIC=Man+Pages"><b>mime.convs</b>(5),</a>
+<a href="man-mime.types.html?TOPIC=Man+Pages"><b>mime.types</b>(5),</a>
+<a href="man-printers.conf.html?TOPIC=Man+Pages"><b>printers.conf</b>(5),</a>
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright © 2021 by OpenPrinting.
.\" Licensed under Apache License v2.0. See the file "LICENSE" for more
.\" information.
.\"
-.TH ipptool 1 "CUPS" "2021-09-17" "OpenPrinting"
+.TH ipptool 1 "CUPS" "2021-09-20" "OpenPrinting"
.SH NAME
ipptool \- perform internet printing protocol requests
.SH SYNOPSIS
.SH FILES
The following standard files are available:
.nf
-.I color.jpg
-.I create\-printer\-subscription.test
-.I document\-a4.pdf
-.I document\-a4.ps
-.I document\-letter.pdf
-.I document\-letter.ps
-.I get\-completed\-jobs.test
-.I get\-jobs.test
-.I get\-notifications.test
-.I get\-printer\-attributes.test
-.I get\-subscriptions.test
-.I gray.jpg
-.I ipp\-1.1.test
-.I ipp\-2.0.test
-.I ipp\-2.1.test
-.I ipp\-2.2.test
-.I ipp\-everywhere.test
-.I onepage\-a4.pdf
-.I onepage\-a4.ps
-.I onepage\-letter.pdf
-.I onepage\-letter.ps
-.I print\-job.test
-.I print\-job\-deflate.test
-.I print\-job\-gzip.test
-.I testfile.jpg
-.I testfile.pcl
-.I testfile.pdf
-.I testfile.ps
-.I testfile.txt
-.I validate\-job.test
+
+ color.jpg
+ create\-printer\-subscription.test
+ document\-a4.pdf
+ document\-a4.ps
+ document\-letter.pdf
+ document\-letter.ps
+ get\-completed\-jobs.test
+ get\-jobs.test
+ get\-notifications.test
+ get\-printer\-attributes.test
+ get\-subscriptions.test
+ gray.jpg
+ ipp\-1.1.test
+ ipp\-2.0.test
+ ipp\-2.1.test
+ ipp\-2.2.test
+ ipp\-everywhere.test
+ onepage\-a4.pdf
+ onepage\-a4.ps
+ onepage\-letter.pdf
+ onepage\-letter.ps
+ print\-job.test
+ print\-job\-deflate.test
+ print\-job\-gzip.test
+ testfile.jpg
+ testfile.pcl
+ testfile.pdf
+ testfile.ps
+ testfile.txt
+ validate\-job.test
.fi
.SH CONFORMING TO
The
.\" Licensed under Apache License v2.0. See the file "LICENSE" for more
.\" information.
.\"
-.TH ipptoolfile 5 "CUPS" "2021-09-17" "OpenPrinting"
+.TH ipptoolfile 5 "CUPS" "2021-09-20" "OpenPrinting"
.SH NAME
ipptoolfile \- ipptool file format
.SH DESCRIPTION
.BR ipptool (8):
.nf
+ Acknowledge\-Document
+ Acknowledge\-Identify\-Printer
+ Acknowledge\-Job
Activate\-Printer
+ Add\-Document\-Images
+ Allocate\-Printer\-Resources
+ Cancel\-Current\-Job
+ Cancel\-Job
+ Cancel\-Jobs
+ Cancel\-My\-Jobs
+ Cancel\-Resource
+ Cancel\-Subscription
+ Close\-Job
+ Create\-Job
+ Create\-Job\-Subscriptions
+ Create\-Printer
+ Create\-Printer\-Subscriptions
+ Create\-Resource
+ Create\-Resource\-Subscriptions
+ Create\-System\-Subscriptions
+ CUPS\-Accept\-Jobs
CUPS\-Accept\-Jobs
CUPS\-Add\-Modify\-Class
CUPS\-Add\-Modify\-Printer
CUPS\-Authenticate\-Job
+ CUPS\-Create\-Local\-Printer
CUPS\-Delete\-Class
CUPS\-Delete\-Printer
CUPS\-Get\-Classes
CUPS\-Move\-Job
CUPS\-Reject\-Jobs
CUPS\-Set\-Default
- Cancel\-Current\-Job
- Cancel\-Job
- Cancel\-Jobs
- Cancel\-My\-Jobs
- Cancel\-Subscription
- Close\-Job
- Create\-Job
- Create\-Job\-Subscriptions
- Create\-Printer\-Subscriptions
Deactivate\-Printer
+ Deallocate\-Printer\-Resources
+ Delete\-Printer
+ Deregister\-Output\-Device
+ Disable\-All\-Printers
Disable\-Printer
+ Enable\-All\-Printers
Enable\-Printer
+ Fetch\-Document
+ Fetch\-Job
Get\-Job\-Attributes
Get\-Jobs
+ Get\-Next\-Document\-Data
Get\-Notifications
+ Get\-Output\-Device\-Attributes
Get\-Printer\-Attributes
Get\-Printer\-Support\-Files
Get\-Printer\-Supported\-Values
+ Get\-Printers
Get\-Subscription\-Attributes
Get\-Subscriptions
+ Get\-System\-Attributes
+ Get\-System\-Supported\-Values
Hold\-Job
Hold\-New\-Jobs
Identify\-Printer
+ Install\-Resource
+ Pause\-All\-Printers
+ Pause\-All\-Printers\-After\-Current\-Job
Pause\-Printer
Pause\-Printer\-After\-Current\-Job
Print\-Job
Print\-URI
Promote\-Job
Purge\-Jobs
+ Register\-Output\-Device
Release\-Held\-New\-Jobs
Release\-Job
Renew\-Subscription
Reprocess\-Job
Restart\-Job
Restart\-Printer
+ Restart\-System
Resubmit\-Job
+ Resume\-All\-Printers
Resume\-Job
Resume\-Printer
Schedule\-Job\-After
Send\-Document
Send\-Hardcopy\-Document
Send\-Notifications
+ Send\-Resource\-Data
Send\-URI
Set\-Job\-Attributes
Set\-Printer\-Attributes
+ Set\-Resource\-Attributes
+ Set\-System\-Attributes
+ Shutdown\-All\-Printers
+ Shutdown\-One\-Printer
Shutdown\-Printer
+ Startup\-All\-Printers
+ Startup\-One\-Printer
Startup\-Printer
Suspend\-Current\-Job
+ Update\-Active\-Jobs
+ Update\-Document\-Status
+ Update\-Job\-Status
+ Update\-Output\-Device\-Attributes
Validate\-Document
Validate\-Job
.fi
client\-error\-ignored\-all\-subscriptions
client\-error\-not\-authenticated
client\-error\-not\-authorized
+ client\-error\-not\-fetchable
client\-error\-not\-found
client\-error\-not\-possible
client\-error\-print\-support\-file\-not\-found
document\-attributes\-tag
event\-notification\-attributes\-tag
- job\-attributes\-tag
- operation\-attributes\-tag
- printer\-attributes\-tag
+ job | job\-attributes\-tag
+ operation | operation\-attributes\-tag
+ printer | printer\-attributes\-tag
+ resource\-attributes\-tag
subscription\-attributes\-tag
+ system\-attributes\-tag
unsupported\-attributes\-tag
.fi
.LP
admin\-define
boolean
charset
- collection
+ collection | begCollection
dateTime
default
delete\-attribute
enum
integer
keyword
- mimeMediaType
- nameWithLanguage
- nameWithoutLanguage
- naturalLanguage
+ language | naturalLanguage
+ mimetype | mimeMediaType
+ name | nameWithLanguage | nameWithoutLanguage
no\-value
not\-settable
octetString
rangeOfInteger
resolution
- textWithLanguage
- textWithoutLanguage
+ text | textWithLanguage | textWithoutLanguage
unknown
unsupported
uri
* Process man page text...
*/
+ if (pre == 1)
+ {
+ pre ++;
+ if (!line[0])
+ continue; // Skip initial blank line
+ }
+
html_fputs(line, &font, outfile);
putc('\n', outfile);
if (isalnum(*s & 255) && *next == '(')
{
- /*
- * See if the man file is available locally...
- */
-
- char name[1024], /* Name */
- manfile[1024], /* Man page filename */
- manurl[1024]; /* Man page URL */
+ // "name (section)" - see if the man file is available locally...
+ char name[1024], // Name
+ manfile[1024], // Man page filename
+ manurl[1024]; // Man page URL
strlcpy(name, s, sizeof(name));
if ((size_t)(end - s) < sizeof(name))
name[end - s] = '\0';
- snprintf(manfile, sizeof(manfile), "%s.man", name);
snprintf(manurl, sizeof(manurl), "man-%s.html?TOPIC=Man+Pages", name);
-
+ snprintf(manfile, sizeof(manfile), "%s.%d", name, atoi(next + 1));
if (!access(manfile, 0))
{
- /*
- * Local man page, do a link...
- */
-
+ // Local man page, do a link...
fprintf(fp, "<a href=\"%s\">", manurl);
link = 1;
}
* Embed URL...
*/
- char temp[1024]; /* Temporary string */
- const char *end = s + 6; /* End of URL */
-
- while (*end && !isspace(*end & 255))
- end ++;
-
- if (end[-1] == ',' || end[-1] == '.' || end[-1] == ')')
- end --;
+ char temp[1024], // Temporary string
+ *tempptr; // Pointer into temporary string
- strlcpy(temp, s, sizeof(temp));
- if ((size_t)(end -s) < sizeof(temp))
- temp[end - s] = '\0';
+ for (tempptr = temp; *s && !isspace(*s & 255) && tempptr < (temp + sizeof(temp) - 1); s ++)
+ {
+ if (strchr(",.)", *s) && strchr(",. \n\r\t", s[1]))
+ {
+ // End of URL
+ break;
+ }
+ else if (*s == '\\' && s[1])
+ {
+ // Escaped character
+ s ++;
+ *tempptr++ = *s;
+ }
+ else
+ {
+ // Regular character...
+ *tempptr++ = *s;
+ }
+ }
+ *tempptr = '\0';
fprintf(fp, "<a href=\"%s\">%s</a>", temp, temp);
- s = end;
}
else
html_putc(*s++ & 255, fp);