margin-left: 36pt;
}
+DL.man DD {
+ margin-left: 5em;
+}
+
+DL.man DT {
+ margin-left: 0;
+}
+
+PRE.man {
+ margin: 0;
+}
+
PRE.example {
background: #eeeeee;
border: dotted thin #999999;
margin-left: 36pt;
}
+DL.man DD {
+ margin-left: 5em;
+}
+
+DL.man DT {
+ margin-left: 0;
+}
+
+PRE.man {
+ margin: 0;
+}
+
PRE.example {
background: white;
border: dotted thin #999999;
margin-left: 0;
}
- PRE.command, PRE.example {
+ PRE.command, PRE.example, PRE.man {
margin-left: 0;
white-space: pre-wrap;
}
[
<i>filename</i>
]
-<pre>
+<pre class="man">
<b>#include <cups/cups.h></b>
constant defines the file descriptor that should be monitored for incoming requests.
<h3><a name="DEVICE_DISCOVERY">Device Discovery</a></h3>
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>
+<pre class="man">
device-class scheme "Unknown" "device-info"
device-class device-uri "device-make-and-model" "device-info"
<p>The
<i>device-class</i>
field is one of the following values:
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>direct</b>
-The device-uri refers to a specific direct-access device with no options, such as a parallel, USB, or SCSI device.
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>file</b>
-The device-uri refers to a file on disk.
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>network</b>
-The device-uri refers to a networked device and conforms to the general form for
-<br>
+<dl class="man">
+<dt><b>direct</b>
+<dd style="margin-left: 5.0em">The device-uri refers to a specific direct-access device with no options, such as a parallel, USB, or SCSI device.
+<dt><b>file</b>
+<dd style="margin-left: 5.0em">The device-uri refers to a file on disk.
+<dt><b>network</b>
+<dd style="margin-left: 5.0em">The device-uri refers to a networked device and conforms to the general form for
network URIs.
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>serial</b>
-The device-uri refers to a serial device with configurable baud rate and other options. If the device-uri contains a baud value, it represents the maximum baud rate supported by the device.
-<br>
+<dt><b>serial</b>
+<dd style="margin-left: 5.0em">The device-uri refers to a serial device with configurable baud rate and other options. If the device-uri contains a baud value, it represents the maximum baud rate supported by the device.
+</dl>
<p>The
<i>scheme</i>
field provides the URI scheme that is supported by the backend. Backends should use this form only when the backend supports any URI using that scheme. The
Backends without world read and execute permissions are run as the root user. Otherwise, the backend is run using an unprivileged user account, typically "lp".
<h2 class="title"><a name="EXIT_STATUS">Exit Status</a></h2>
The following exit codes are defined for backends:
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>CUPS_BACKEND_OK</b>
-The print file was successfully transmitted to the device or remote server.
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>CUPS_BACKEND_FAILED</b>
-<br>
+<dl class="man">
+<dt><b>CUPS_BACKEND_OK</b>
+<dd style="margin-left: 5.0em">The print file was successfully transmitted to the device or remote server.
+<dt><b>CUPS_BACKEND_FAILED</b>
+<dd style="margin-left: 5.0em"><br>
The print file was not successfully transmitted to the device or remote server. The scheduler will respond to this by canceling the job, retrying the job, or stopping the queue depending on the state of the
-<br>
<i>printer-error-policy</i>
attribute.
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>CUPS_BACKEND_AUTH_REQUIRED</b>
-The print file was not successfully transmitted because valid authentication information is required. The scheduler will respond to this by holding the job and adding the 'cups-held-for-authentication' keyword to the "job-reasons" Job Description attribute.
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>CUPS_BACKEND_HOLD</b>
-The print file was not successfully transmitted because it cannot be printed at this time. The scheduler will respond to this by holding the job.
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>CUPS_BACKEND_STOP</b>
-The print file was not successfully transmitted because it cannot be printed at this time. The scheduler will respond to this by stopping the queue.
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>CUPS_BACKEND_CANCEL</b>
-The print file was not successfully transmitted because one or more attributes are not supported or the job was canceled at the printer. The scheduler will respond to this by canceling the job.
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>CUPS_BACKEND_RETRY</b>
-The print file was not successfully transmitted because of a temporary issue. The scheduler will retry the job at a future time - other jobs may print before this one.
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>CUPS_BACKEND_RETRY_CURRENT</b>
-The print file was not successfully transmitted because of a temporary issue. The scheduler will retry the job immediately without allowing intervening jobs.
-<br>
+<dt><b>CUPS_BACKEND_AUTH_REQUIRED</b>
+<dd style="margin-left: 5.0em">The print file was not successfully transmitted because valid authentication information is required. The scheduler will respond to this by holding the job and adding the 'cups-held-for-authentication' keyword to the "job-reasons" Job Description attribute.
+<dt><b>CUPS_BACKEND_HOLD</b>
+<dd style="margin-left: 5.0em">The print file was not successfully transmitted because it cannot be printed at this time. The scheduler will respond to this by holding the job.
+<dt><b>CUPS_BACKEND_STOP</b>
+<dd style="margin-left: 5.0em">The print file was not successfully transmitted because it cannot be printed at this time. The scheduler will respond to this by stopping the queue.
+<dt><b>CUPS_BACKEND_CANCEL</b>
+<dd style="margin-left: 5.0em">The print file was not successfully transmitted because one or more attributes are not supported or the job was canceled at the printer. The scheduler will respond to this by canceling the job.
+<dt><b>CUPS_BACKEND_RETRY</b>
+<dd style="margin-left: 5.0em">The print file was not successfully transmitted because of a temporary issue. The scheduler will retry the job at a future time - other jobs may print before this one.
+<dt><b>CUPS_BACKEND_RETRY_CURRENT</b>
+<dd style="margin-left: 5.0em">The print file was not successfully transmitted because of a temporary issue. The scheduler will retry the job immediately without allowing intervening jobs.
+</dl>
<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
and
<a href="man-filter.html?TOPIC=Man+Pages"><b>filter</b>(7),</a>
CUPS backends can expect the following environment variable:
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>DEVICE_URI</b>
-The device URI associated with the printer.
-<br>
+<dl class="man">
+<dt><b>DEVICE_URI</b>
+<dd style="margin-left: 5.0em">The device URI associated with the printer.
+</dl>
<h2 class="title"><a name="FILES">Files</a></h2>
<i>/etc/cups/cups-files.conf</i>
<h2 class="title"><a name="NOTES">Notes</a></h2>
all jobs from the specified destination.
<h2 class="title"><a name="OPTIONS">Options</a></h2>
The following options are recognized by <i>cancel</i>:
-<p style="margin-left: 5.0em; text-indent: -5.0em">-E
-<br>
-<br>
+<dl class="man">
+<dt>-E
+<dd style="margin-left: 5.0em"><br>
Forces encryption when connecting to the server.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-U username
-<br>
-<br>
+<dt>-U username
+<dd style="margin-left: 5.0em"><br>
Specifies the username to use when connecting to the server.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-a
-<br>
-<br>
+<dt>-a
+<dd style="margin-left: 5.0em"><br>
Cancel all jobs on the named destination, or all jobs on all
destinations if none is provided.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-h hostname[:port]
-<br>
-<br>
+<dt>-h hostname[:port]
+<dd style="margin-left: 5.0em"><br>
Chooses an alternate server.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-u username
-<br>
-<br>
+<dt>-u username
+<dd style="margin-left: 5.0em"><br>
Cancels jobs owned by <i>username</i>.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-x
-<br>
-<br>
+<dt>-x
+<dd style="margin-left: 5.0em"><br>
Deletes job data files in addition to canceling.
+</dl>
<h2 class="title"><a name="COMPATIBILITY">Compatibility</a></h2>
Unlike the System V printing system, CUPS allows printer names to
contain any printable character except SPACE, TAB, "/", or "#".
<p>Each line in the file can be a configuration directive, a blank line,
or a comment. Comment lines start with the # character.
<h2 class="title"><a name="DIRECTIVES">Directives</a></h2>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><Class name> ... </Class>
-<br>
-<br>
+<dl class="man">
+<dt><Class name> ... </Class>
+<dd style="margin-left: 5.0em"><br>
Defines a specific printer class.
-<p style="margin-left: 5.0em; text-indent: -5.0em"><DefaultClass name> ... </Class>
-<br>
-<br>
+<dt><DefaultClass name> ... </Class>
+<dd style="margin-left: 5.0em"><br>
Defines a default printer class.
-<p style="margin-left: 5.0em; text-indent: -5.0em">Accepting Yes
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">Accepting No
-<br>
-<br>
+<dt>Accepting Yes
+<dd style="margin-left: 5.0em"><dt>Accepting No
+<dd style="margin-left: 5.0em"><br>
Specifies whether the printer is accepting new jobs.
-<p style="margin-left: 5.0em; text-indent: -5.0em">AllowUser [ user @group ... ]
-<br>
-<br>
+<dt>AllowUser [ user @group ... ]
+<dd style="margin-left: 5.0em"><br>
Allows specific users and groups to print to the printer.
-<p style="margin-left: 5.0em; text-indent: -5.0em">DenyUser [ user @group ... ]
-<br>
-<br>
+<dt>DenyUser [ user @group ... ]
+<dd style="margin-left: 5.0em"><br>
Prevents specific users and groups from printing to the printer.
-<p style="margin-left: 5.0em; text-indent: -5.0em">Info text
-<br>
-<br>
+<dt>Info text
+<dd style="margin-left: 5.0em"><br>
Specifies human-readable text describing the printer.
-<p style="margin-left: 5.0em; text-indent: -5.0em">JobSheets banner banner
-<br>
-<br>
+<dt>JobSheets banner banner
+<dd style="margin-left: 5.0em"><br>
Specifies the banner pages to use for the printer.
-<p style="margin-left: 5.0em; text-indent: -5.0em">KLimit number
-<br>
-<br>
+<dt>KLimit number
+<dd style="margin-left: 5.0em"><br>
Specifies the job-k-limit value for the printer.
-<p style="margin-left: 5.0em; text-indent: -5.0em">Location text
-<br>
-<br>
+<dt>Location text
+<dd style="margin-left: 5.0em"><br>
Specifies human-readable text describing the location of the printer.
-<p style="margin-left: 5.0em; text-indent: -5.0em">OpPolicy name
-<br>
-<br>
+<dt>OpPolicy name
+<dd style="margin-left: 5.0em"><br>
Specifies the operation policy for the printer.
-<p style="margin-left: 5.0em; text-indent: -5.0em">PageLimit number
-<br>
-<br>
+<dt>PageLimit number
+<dd style="margin-left: 5.0em"><br>
Specifies the job-page-limit value for the printer.
-<p style="margin-left: 5.0em; text-indent: -5.0em">Printer
-<br>
-<br>
+<dt>Printer
+<dd style="margin-left: 5.0em"><br>
Specifies a printer that is a member of the printer class.
-<p style="margin-left: 5.0em; text-indent: -5.0em">QuotaPeriod seconds
-<br>
-<br>
+<dt>QuotaPeriod seconds
+<dd style="margin-left: 5.0em"><br>
Specifies the job-quota-period value for the printer.
-<p style="margin-left: 5.0em; text-indent: -5.0em">Shared Yes
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">Shared No
-<br>
-<br>
+<dt>Shared Yes
+<dd style="margin-left: 5.0em"><dt>Shared No
+<dd style="margin-left: 5.0em"><br>
Specifies whether the printer is shared.
-<p style="margin-left: 5.0em; text-indent: -5.0em">State idle
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">State stopped
-<br>
-<br>
+<dt>State idle
+<dd style="margin-left: 5.0em"><dt>State stopped
+<dd style="margin-left: 5.0em"><br>
Specifies the initial state of the printer (Idle or Stopped)
-<p style="margin-left: 5.0em; text-indent: -5.0em">StateMessage text
-<br>
-<br>
+<dt>StateMessage text
+<dd style="margin-left: 5.0em"><br>
Specifies the message associated with the state.
-<p style="margin-left: 5.0em; text-indent: -5.0em">StateTime seconds
-<br>
-<br>
+<dt>StateTime seconds
+<dd style="margin-left: 5.0em"><br>
Specifies the date/time associated with the state.
+</dl>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
<i>cupsd(8)</i>, <i>cupsd.conf(5)</i>, <i>mime.convs(5)</i>,
<i>mime.types(5)</i>, <i>printers.conf(5)</i>,
<h2 class="title"><a name="DIRECTIVES">Directives</a></h2>
The following directives are understood by the client. Consult the
on-line help for detailed descriptions:
-<p style="margin-left: 5.0em; text-indent: -5.0em">Encryption IfRequested
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">Encryption Never
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">Encryption Required
-<br>
-<br>
+<dl class="man">
+<dt>Encryption IfRequested
+<dd style="margin-left: 5.0em"><dt>Encryption Never
+<dd style="margin-left: 5.0em"><dt>Encryption Required
+<dd style="margin-left: 5.0em"><br>
Specifies the level of encryption that is required for a particular
location.
-<p style="margin-left: 5.0em; text-indent: -5.0em">GSSServiceName name
-<br>
-Specifies the Kerberos service name that is used for authentication, typically
+<dt>GSSServiceName name
+<dd style="margin-left: 5.0em">Specifies the Kerberos service name that is used for authentication, typically
"host", "http", or "ipp". CUPS adds the remote hostname
("name@server.example.com") for you. The default name is
"http".
-<p style="margin-left: 5.0em; text-indent: -5.0em">ServerName hostname-or-ip-address[:port]
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">ServerName /domain/socket
-<br>
-<br>
+<dt>ServerName hostname-or-ip-address[:port]
+<dd style="margin-left: 5.0em"><dt>ServerName /domain/socket
+<dd style="margin-left: 5.0em"><br>
Specifies the address and optionally the port to use when connecting to the
server. <b>Note: Not supported on OS X 10.7 or later.</b>
-<p style="margin-left: 5.0em; text-indent: -5.0em">ServerName hostname-or-ip-address[:port]/version=1.1
-<br>
-<br>
+<dt>ServerName hostname-or-ip-address[:port]/version=1.1
+<dd style="margin-left: 5.0em"><br>
Specifies the address and optionally the port to use when connecting to a
server running CUPS 1.3.12 and earlier. <b>Note: Not supported on OS X 10.7 or
later.</b>
-<p style="margin-left: 5.0em; text-indent: -5.0em">User name
-<br>
-<br>
+<dt>User name
+<dd style="margin-left: 5.0em"><br>
Specifies the default user name to use for requests.
+</dl>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
<a href="http://localhost:631/help">http://localhost:631/help</a>
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
options for the compiler and linker, as well as determining installation
directories for filters, configuration files, and drivers.
<h2 class="title"><a name="OPTIONS">Options</a></h2>
-<p style="margin-left: 5.0em; text-indent: -5.0em">--api-version
-<br>
-<br>
+<dl class="man">
+<dt>--api-version
+<dd style="margin-left: 5.0em"><br>
Displays the current API version (major.minor).
-<p style="margin-left: 5.0em; text-indent: -5.0em">--build
-<br>
-<br>
+<dt>--build
+<dd style="margin-left: 5.0em"><br>
Displays a system-specific build number.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--cflags
-<br>
-<br>
+<dt>--cflags
+<dd style="margin-left: 5.0em"><br>
Displays the necessary compiler options.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--datadir
-<br>
-<br>
+<dt>--datadir
+<dd style="margin-left: 5.0em"><br>
Displays the default CUPS data directory.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--help
-<br>
-<br>
+<dt>--help
+<dd style="margin-left: 5.0em"><br>
Displays the program usage message.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--image
-<br>
-<br>
+<dt>--image
+<dd style="margin-left: 5.0em"><br>
When used with <i>--libs</i>, adds the CUPS imaging library to the
list of displayed libraries.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--ldflags
-<br>
-<br>
+<dt>--ldflags
+<dd style="margin-left: 5.0em"><br>
Displays the necessary linker options.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--libs
-<br>
-<br>
+<dt>--libs
+<dd style="margin-left: 5.0em"><br>
Displays the necessary librarys to link to.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--serverbin
-<br>
-<br>
+<dt>--serverbin
+<dd style="margin-left: 5.0em"><br>
Displays the default CUPS binary directory,
where filters and backends are stored.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--serverroot
-<br>
-<br>
+<dt>--serverroot
+<dd style="margin-left: 5.0em"><br>
Displays the default CUPS configuration file directory.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--static
-<br>
-<br>
+<dt>--static
+<dd style="margin-left: 5.0em"><br>
When used with <i>--libs</i>, shows the static libraries instead
of the default (shared) libraries.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--version
-<br>
-<br>
+<dt>--version
+<dd style="margin-left: 5.0em"><br>
Displays the full version number of the CUPS installation
(major.minor.patch).
+</dl>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
<a href="http://localhost:631/help">http://localhost:631/help</a>
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
cups-deviced - cups device daemon
<h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2>
<b>cups-deviced</b>
-<i>request-id</i> <i>limit</i> <i>user-id</i> <i>options</i>
+<i>request-id</i><i>limit</i><i>user-id</i><i>options</i>
<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
<i>cups-deviced</i> polls the backends in
<i>/usr/lib/cups/backend</i> or <i>/usr/libexec/cups/backend</i> (OS X) for a
<br>
<b>cups-driverd</b>
list
-<i>request_id</i> <i>limit</i> <i>options</i>
+<i>request_id</i><i>limit</i><i>options</i>
<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
<i>cups-driverd</i> shows or lists PPD files. It is run in
response to CUPS-Add-Modify-Printer or CUPS-Get-Devices requests.
<h3><a name="DRIVER_PROGRAMS">Driver Programs</a></h3>
Driver programs provide a interface to dynamically-generated PPD
files. The following arguments are currently defined:
-<p style="margin-left: 5.0em; text-indent: -5.0em">drivername list
-<br>
-<br>
+<dl class="man">
+<dt>drivername list
+<dd style="margin-left: 5.0em"><br>
Lists the supported PPD files to stdout.
-<p style="margin-left: 5.0em; text-indent: -5.0em">drivername cat ppdname
-<br>
-<br>
+<dt>drivername cat ppdname
+<dd style="margin-left: 5.0em"><br>
Writes the named PPD file to stdout.
+</dl>
<p>Driver programs MUST NOT query hardware or make other long-term operations that
would delay the return of a driver list. See the NOTES section below for
specific recommendations.
When run with the single argument "list", the program must list
the available PPD files it can generate to stdout using the
following format:
-<pre>
+<pre class="man">
"drivername:ppdname" language "make" "make and model"
"drivername:ppdname" language "make" "make and model" "1284 device id"
"drivername:ppdname" language "make" "make and model" "1284 device id" "(PPD product)"
<h3><a name="DRIVER_ERROR_MESSAGES">Driver Error Messages</a></h3>
Error messages can be relayed back to <i>cupsd</i> by writing them
to stderr. The following prefixes are recognized:
-<p style="margin-left: 5.0em; text-indent: -5.0em">DEBUG: [drivername]
-<br>
-<br>
+<dl class="man">
+<dt>DEBUG: [drivername]
+<dd style="margin-left: 5.0em"><br>
Debugging messages
-<p style="margin-left: 5.0em; text-indent: -5.0em">ERROR: [drivername]
-<br>
-<br>
+<dt>ERROR: [drivername]
+<dd style="margin-left: 5.0em"><br>
Error messages
-<p style="margin-left: 5.0em; text-indent: -5.0em">INFO: [drivername]
-<br>
-<br>
+<dt>INFO: [drivername]
+<dd style="margin-left: 5.0em"><br>
Informational messages
+</dl>
<h2 class="title"><a name="NOTES">Notes</a></h2>
Due to performance considerations, driver programs have been officially
deprecated and should not be used for new development. Currently only the
<h2 class="title"><a name="DIRECTIVES">Directives</a></h2>
The following directives are understood by <i>cupsd(8)</i>. Consult the
on-line help for detailed descriptions:
-<p style="margin-left: 5.0em; text-indent: -5.0em">AccessLog filename
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">AccessLog syslog
-<br>
-<br>
+<dl class="man">
+<dt>AccessLog filename
+<dd style="margin-left: 5.0em"><dt>AccessLog syslog
+<dd style="margin-left: 5.0em"><br>
Defines the access log filename.
-<p style="margin-left: 5.0em; text-indent: -5.0em">ConfigFilePerm mode
-<br>
-<br>
+<dt>ConfigFilePerm mode
+<dd style="margin-left: 5.0em"><br>
Specifies the permissions for all configuration files that the scheduler
writes.
-<p style="margin-left: 5.0em; text-indent: -5.0em">DataDir path
-<br>
-<br>
+<dt>DataDir path
+<dd style="margin-left: 5.0em"><br>
Specified the directory where data files can be found.
-<p style="margin-left: 5.0em; text-indent: -5.0em">DocumentRoot directory
-<br>
-<br>
+<dt>DocumentRoot directory
+<dd style="margin-left: 5.0em"><br>
Specifies the root directory for the internal web server documents.
-<p style="margin-left: 5.0em; text-indent: -5.0em">ErrorLog filename
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">ErrorLog syslog
-<br>
-<br>
+<dt>ErrorLog filename
+<dd style="margin-left: 5.0em"><dt>ErrorLog syslog
+<dd style="margin-left: 5.0em"><br>
Specifies the error log filename.
-<p style="margin-left: 5.0em; text-indent: -5.0em">FatalErrors none
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">FatalErrors all -kind [... -kind]
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">FatalErrors kind [... kind]
-<br>
-<br>
+<dt>FatalErrors none
+<dd style="margin-left: 5.0em"><dt>FatalErrors all -kind [... -kind]
+<dd style="margin-left: 5.0em"><dt>FatalErrors kind [... kind]
+<dd style="margin-left: 5.0em"><br>
Specifies which errors are fatal, causing the scheduler to exit. "Kind" is
"browse", "config", "listen", "log", or "permissions".
-<p style="margin-left: 5.0em; text-indent: -5.0em">FileDevice Yes
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">FileDevice No
-<br>
-<br>
+<dt>FileDevice Yes
+<dd style="margin-left: 5.0em"><dt>FileDevice No
+<dd style="margin-left: 5.0em"><br>
Specifies whether the file pseudo-device can be used for new
printer queues.
-<p style="margin-left: 5.0em; text-indent: -5.0em">FontPath directory[:directory:...]
-<br>
-<br>
+<dt>FontPath directory[:directory:...]
+<dd style="margin-left: 5.0em"><br>
Specifies the search path for fonts.
-<p style="margin-left: 5.0em; text-indent: -5.0em">Group group-name-or-number
-<br>
-<br>
+<dt>Group group-name-or-number
+<dd style="margin-left: 5.0em"><br>
Specifies the group name or ID that will be used when executing
external programs.
-<p style="margin-left: 5.0em; text-indent: -5.0em">LogFilePerm mode
-<br>
-<br>
+<dt>LogFilePerm mode
+<dd style="margin-left: 5.0em"><br>
Specifies the permissions for all log files that the scheduler writes.
-<p style="margin-left: 5.0em; text-indent: -5.0em">PageLog filename
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">PageLog syslog
-<br>
-<br>
+<dt>PageLog filename
+<dd style="margin-left: 5.0em"><dt>PageLog syslog
+<dd style="margin-left: 5.0em"><br>
Specifies the page log filename.
-<p style="margin-left: 5.0em; text-indent: -5.0em">Printcap
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">Printcap filename
-<br>
-<br>
+<dt>Printcap
+<dd style="margin-left: 5.0em"><dt>Printcap filename
+<dd style="margin-left: 5.0em"><br>
Specifies the filename for a printcap file that is updated
automatically with a list of available printers (needed for
legacy applications); specifying Printcap with no filename
disables printcap generation.
-<p style="margin-left: 5.0em; text-indent: -5.0em">RemoteRoot user-name
-<br>
-<br>
+<dt>RemoteRoot user-name
+<dd style="margin-left: 5.0em"><br>
Specifies the username that is associated with unauthenticated root
accesses.
-<p style="margin-left: 5.0em; text-indent: -5.0em">RequestRoot directory
-<br>
-<br>
+<dt>RequestRoot directory
+<dd style="margin-left: 5.0em"><br>
Specifies the directory to store print jobs and other HTTP request
data.
-<p style="margin-left: 5.0em; text-indent: -5.0em">Sandboxing off
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">Sandboxing relaxed
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">Sandboxing strict
-<br>
-Specifies the level of security sandboxing that is applied to print filters, backends, and other child processes of the scheduler. The default is "strict". (OS X only)
-<p style="margin-left: 5.0em; text-indent: -5.0em">ServerBin directory
-<br>
-<br>
+<dt>Sandboxing off
+<dd style="margin-left: 5.0em"><dt>Sandboxing relaxed
+<dd style="margin-left: 5.0em"><dt>Sandboxing strict
+<dd style="margin-left: 5.0em">Specifies the level of security sandboxing that is applied to print filters, backends, and other child processes of the scheduler. The default is "strict". (OS X only)
+<dt>ServerBin directory
+<dd style="margin-left: 5.0em"><br>
Specifies the directory where backends, CGIs, daemons, and filters may
be found.
-<p style="margin-left: 5.0em; text-indent: -5.0em">ServerKeychain path
-<br>
-<br>
+<dt>ServerKeychain path
+<dd style="margin-left: 5.0em"><br>
Specifies the location of TLS certificates and private keys.
-<p style="margin-left: 5.0em; text-indent: -5.0em">ServerRoot directory
-<br>
-<br>
+<dt>ServerRoot directory
+<dd style="margin-left: 5.0em"><br>
Specifies the directory where the server configuration files can be found.
-<p style="margin-left: 5.0em; text-indent: -5.0em">SyncOnClose Yes
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">SyncOnClose No
-<br>
-Specifies whether the scheduler calls <i>fsync(2)</i> after writing configuration
+<dt>SyncOnClose Yes
+<dd style="margin-left: 5.0em"><dt>SyncOnClose No
+<dd style="margin-left: 5.0em">Specifies whether the scheduler calls <i>fsync(2)</i> after writing configuration
or state files. The default is No.
-<p style="margin-left: 5.0em; text-indent: -5.0em">SystemGroup group-name [group-name ...]
-<br>
-<br>
+<dt>SystemGroup group-name [group-name ...]
+<dd style="margin-left: 5.0em"><br>
Specifies the group(s) to use for System class authentication.
-<p style="margin-left: 5.0em; text-indent: -5.0em">TempDir directory
-<br>
-<br>
+<dt>TempDir directory
+<dd style="margin-left: 5.0em"><br>
Specifies the directory where temporary files are stored.
-<p style="margin-left: 5.0em; text-indent: -5.0em">User user-name
-<br>
-<br>
+<dt>User user-name
+<dd style="margin-left: 5.0em"><br>
Specifies the user name or ID that is used when running external programs.
+</dl>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
<i>classes.conf(5)</i>, <i>cupsd(8)</i>, <i>cupsd.conf(5)</i>, <i>mime.convs(5)</i>,
<i>mime.types(5)</i>, <i>printers.conf(5)</i>,
add the following line to the <i>inetd.conf</i> file to enable the
<i>cups-lpd</i> mini-server:
<br>
-<pre>
+<pre class="man">
printer stream tcp nowait lp /usr/lib/cups/daemon/cups-lpd cups-lpd \
-o document-format=application/octet-stream
<p>If you are using the newer <i>xinetd(8)</i> daemon, create a file
named <i>/etc/xinetd.d/cups</i> containing the following lines:
<br>
-<pre>
+<pre class="man">
service printer
{
}
</pre>
<h2 class="title"><a name="OPTIONS">Options</a></h2>
-<p style="margin-left: 5.0em; text-indent: -5.0em">-h hostname[:port]
-<br>
-<br>
+<dl class="man">
+<dt>-h hostname[:port]
+<dd style="margin-left: 5.0em"><br>
Sets the CUPS server (and port) to use.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-n
-<br>
-<br>
+<dt>-n
+<dd style="margin-left: 5.0em"><br>
Disables reverse address lookups; normally <i>cups-lpd</i> will
try to discover the hostname of the client via a reverse DNS
lookup.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o name=value
-<br>
-<br>
+<dt>-o name=value
+<dd style="margin-left: 5.0em"><br>
Inserts options for all print queues. Most often this is used to
disable the "l" filter so that remote print jobs are filtered as
needed for printing; the examples in the previous section set the
"document-format" option to "application/octet-stream" which
forces autodetection of the print file format.
+</dl>
<h2 class="title"><a name="PERFORMANCE">Performance</a></h2>
<i>cups-lpd</i> performs well with small numbers of clients and
printers. However, since a new process is created for each
<h2 class="title"><a name="DIRECTIVES">Directives</a></h2>
The following directives are understood by the CUPS network backends. Consult
the on-line help for detailed descriptions:
-<p style="margin-left: 5.0em; text-indent: -5.0em">Address @IF(<i>name</i>)
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">Address @LOCAL
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">Address <i>address</i>
-<br>
-<br>
+<dl class="man">
+<dt>Address @IF(<i>name</i>)
+<dd style="margin-left: 5.0em"><dt>Address @LOCAL
+<dd style="margin-left: 5.0em"><dt>Address <i>address</i>
+<dd style="margin-left: 5.0em"><br>
Sends SNMP broadcast queries to the specified address(es). There is no default
for the broadcast address.
-<p style="margin-left: 5.0em; text-indent: -5.0em">Community <i>name</i>
-<br>
-<br>
+<dt>Community <i>name</i>
+<dd style="margin-left: 5.0em"><br>
Specifies the community name to use. Only a single community name may be
specified. The default community name is "public".
-<p style="margin-left: 5.0em; text-indent: -5.0em">DebugLevel number
-<br>
-<br>
+<dt>DebugLevel number
+<dd style="margin-left: 5.0em"><br>
Specifies the logging level from 0 (none) to 3 (everything). Typically only used
for debugging (thus the name). The default debug level is 0.
-<p style="margin-left: 5.0em; text-indent: -5.0em">DeviceURI "regular expression" device-uri [... device-uri]
-<br>
-<br>
+<dt>DeviceURI "regular expression" device-uri [... device-uri]
+<dd style="margin-left: 5.0em"><br>
Specifies one or more device URIs that should be used for a given make and model
string. The regular expression is used to match the detected make and model, and
the device URI strings must be of the form "scheme://%s[:port]/[path]", where
"%s" represents the detected address or hostname. There are no default device
URI matching rules.
-<p style="margin-left: 5.0em; text-indent: -5.0em">HostNameLookups on
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">HostNameLookups off
-<br>
-<br>
+<dt>HostNameLookups on
+<dd style="margin-left: 5.0em"><dt>HostNameLookups off
+<dd style="margin-left: 5.0em"><br>
Specifies whether the addresses of printers should be converted to hostnames or
left as numeric IP addresses. The default is "off".
-<p style="margin-left: 5.0em; text-indent: -5.0em">MaxRunTime <i>seconds</i>
-<br>
-<br>
+<dt>MaxRunTime <i>seconds</i>
+<dd style="margin-left: 5.0em"><br>
Specifies the maximum number of seconds that the SNMP backend will scan the
network for printers. The default is 120 seconds (2 minutes).
+</dl>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
cups-snmp(8),
<br>
<b>/usr/libexec/cups/backend/snmp</b>
<i>ip-address-or-hostname</i>
<br>
-<b>lpinfo</b> <b>-v</b> <b>--include-schemes</b> <b>snmp</b>
+<b>lpinfo</b><b>-v</b><b>--include-schemes</b><b>snmp</b>
<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
The CUPS SNMP backend provides legacy discovery and identification of network
printers using SNMPv1. When used for discovery through the scheduler, the
<b>CUPS</b>
removes the job from the queue and moves on to any other jobs you have submitted. You can also be notified when the job is finished, or if there are any errors during printing, in several different ways.
<h3><a name="WHERE_DO_I_BEGIN_">Where Do I Begin?</a></h3>
-The easiest way to start is by using the
-<b>CUPS</b>
-web interface to configure your printer. Go to "<a href="http://localhost:631"">http://localhost:631"</a> and choose the Administration tab at the top of the page. Click/press on the Add Printer button and follow the prompts.
+The easiest way to start is by using the web interface to configure your printer. Go to "<a href="http://localhost:631"">http://localhost:631"</a> and choose the Administration tab at the top of the page. Click/press on the Add Printer button and follow the prompts.
<p>When you are asked for a username and password, enter your login username and password or the "root" username and password.
-<p>After the printer is added,
-<b>CUPS</b>
-will ask you to set the default printer options (paper size, output mode, etc.) for the printer. Make any changes as needed and then click on the Set Default Options button to save them. Some printers also support auto-configuration - click on the Query Printer for Default Options button to update the options automatically.
+<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
<a href="man-lpadmin.html?TOPIC=Man+Pages"><b>lpadmin</b>(8)</a>
The
<b>CUPS</b>
web site (<a href="http://www.CUPS.org">http://www.CUPS.org</a>) provides access to the
-<b>CUPS</b>
-user mailing list, additional documentation and resources, and a bug report database. Most vendors also provide online discussion forums to ask printing questions for your operating system of choice.
+<i>cups</i>
+and
+<i>cups-devel</i>
+mailing lists, additional documentation and resources, and a bug report database. Most vendors also provide online discussion forums to ask printing questions for your operating system of choice.
<h2 class="title"><a name="ENVIRONMENT">Environment</a></h2>
<b>CUPS</b>
commands use the following environment variables to override the default locations of files and so forth. For security reasons, these environment variables are ignored for setuid programs:
-<p style="margin-left: 5.0em; text-indent: -5.0em">CUPS_SERVER
-<br>
-The hostname/IP address and port number of the CUPS scheduler (hostname:port or ipaddress:port).
-<p style="margin-left: 5.0em; text-indent: -5.0em">CUPS_ANYROOT
-<br>
-Whether to allow any X.509 certificate root (Y or N).
-<p style="margin-left: 5.0em; text-indent: -5.0em">CUPS_CACHEDIR
-<br>
-The directory where semi-persistent cache files can be found.
-<p style="margin-left: 5.0em; text-indent: -5.0em">CUPS_DATADIR
-<br>
-The directory where data files can be found.
-<p style="margin-left: 5.0em; text-indent: -5.0em">CUPS_ENCRYPTION
-<br>
-The default level of encryption (Always, IfRequested, Never, Required).
-<p style="margin-left: 5.0em; text-indent: -5.0em">CUPS_EXPIREDROOT
-<br>
-Whether to allow expired X.509 certificate roots (Y or N).
-<p style="margin-left: 5.0em; text-indent: -5.0em">CUPS_EXPIREDCERTS
-<br>
-Whether to allow expired X.509 certificates (Y or N).
-<p style="margin-left: 5.0em; text-indent: -5.0em">CUPS_GSSSERVICENAME
-<br>
-The Kerberos service name used for authentication.
-<p style="margin-left: 5.0em; text-indent: -5.0em">CUPS_SERVERBIN
-<br>
-The directory where server helper programs, filters, backend, etc. can be found.
-<p style="margin-left: 5.0em; text-indent: -5.0em">CUPS_SERVERROOT
-<br>
-The root directory of the server.
-<p style="margin-left: 5.0em; text-indent: -5.0em">CUPS_STATEDIR
-<br>
-The directory where state files can be found.
-<p style="margin-left: 5.0em; text-indent: -5.0em">CUPS_USER
-<br>
-Specifies the name of the user for print requests.
-<p style="margin-left: 5.0em; text-indent: -5.0em">HOME
-<br>
-Specifies the home directory of the current user.
-<p style="margin-left: 5.0em; text-indent: -5.0em">IPP_PORT
-<br>
-Specifies the default port number for IPP requests.
-<p style="margin-left: 5.0em; text-indent: -5.0em">LOCALEDIR
-<br>
-Specifies the location of localization files.
-<p style="margin-left: 5.0em; text-indent: -5.0em">LPDEST
-<br>
-Specifies the default print queue (System V standard).
-<p style="margin-left: 5.0em; text-indent: -5.0em">PRINTER
-<br>
-Specifies the default print queue (Berkeley standard).
-<p style="margin-left: 5.0em; text-indent: -5.0em">TMPDIR
-<br>
-Specifies the location of temporary files.
+<dl class="man">
+<dt><b>CUPS_ANYROOT</b>
+<dd style="margin-left: 5.0em">Whether to allow any X.509 certificate root (Y or N).
+<dt><b>CUPS_CACHEDIR</b>
+<dd style="margin-left: 5.0em">The directory where semi-persistent cache files can be found.
+<dt><b>CUPS_DATADIR</b>
+<dd style="margin-left: 5.0em">The directory where data files can be found.
+<dt><b>CUPS_ENCRYPTION</b>
+<dd style="margin-left: 5.0em">The default level of encryption (Always, IfRequested, Never, Required).
+<dt><b>CUPS_EXPIREDROOT</b>
+<dd style="margin-left: 5.0em">Whether to allow expired X.509 certificate roots (Y or N).
+<dt><b>CUPS_EXPIREDCERTS</b>
+<dd style="margin-left: 5.0em">Whether to allow expired X.509 certificates (Y or N).
+<dt><b>CUPS_GSSSERVICENAME</b>
+<dd style="margin-left: 5.0em">The Kerberos service name used for authentication.
+<dt><b>CUPS_SERVER</b>
+<dd style="margin-left: 5.0em">The hostname/IP address and port number of the CUPS scheduler (hostname:port or ipaddress:port).
+<dt><b>CUPS_SERVERBIN</b>
+<dd style="margin-left: 5.0em">The directory where server helper programs, filters, backend, etc. can be found.
+<dt><b>CUPS_SERVERROOT</b>
+<dd style="margin-left: 5.0em">The root directory of the server.
+<dt><b>CUPS_STATEDIR</b>
+<dd style="margin-left: 5.0em">The directory where state files can be found.
+<dt><b>CUPS_USER</b>
+<dd style="margin-left: 5.0em">Specifies the name of the user for print requests.
+<dt><b>HOME</b>
+<dd style="margin-left: 5.0em">Specifies the home directory of the current user.
+<dt><b>IPP_PORT</b>
+<dd style="margin-left: 5.0em">Specifies the default port number for IPP requests.
+<dt><b>LOCALEDIR</b>
+<dd style="margin-left: 5.0em">Specifies the location of localization files.
+<dt><b>LPDEST</b>
+<dd style="margin-left: 5.0em">Specifies the default print queue (System V standard).
+<dt><b>PRINTER</b>
+<dd style="margin-left: 5.0em">Specifies the default print queue (Berkeley standard).
+<dt><b>TMPDIR</b>
+<dd style="margin-left: 5.0em">Specifies the location of temporary files.
+</dl>
<h2 class="title"><a name="FILES">Files</a></h2>
-~/.cups/client.conf, ~/.cups/lpoptions
+<pre class="man">
+<i>~/.cups/client.conf</i>
+<i>~/.cups/lpoptions</i>
+</pre>
<h2 class="title"><a name="CONFORMING_TO">Conforming To</a></h2>
<b>CUPS</b>
conforms to the Internet Printing Protocol version 2.1 and implements the Berkeley and System V UNIX print commands.
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<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>(7),</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>
-<a href="http://localhost:631/help">http://localhost:631/help</a>,
-<a href="http://www.CUPS.org">http://www.CUPS.org</a>,
-<a href="http://www.pwg.org/ipp">http://www.pwg.org/ipp</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>(7),</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>,
+CUPS Web Site (<a href="http://www.CUPS.org)">http://www.CUPS.org)</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 © 2007-2014 by Apple Inc.
<h2 class="title"><a name="OPTIONS">Options</a></h2>
The following options are supported by both <i>cupsaccept</i> and
<i>cupsreject</i>:
-<p style="margin-left: 5.0em; text-indent: -5.0em">-E
-<br>
-<br>
+<dl class="man">
+<dt>-E
+<dd style="margin-left: 5.0em"><br>
Forces encryption when connecting to the server.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-U username
-<br>
-<br>
+<dt>-U username
+<dd style="margin-left: 5.0em"><br>
Sets the username that is sent when connecting to the server.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-h hostname[:port]
-<br>
-<br>
+<dt>-h hostname[:port]
+<dd style="margin-left: 5.0em"><br>
Chooses an alternate server.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-r "reason"
-<br>
-<br>
+<dt>-r "reason"
+<dd style="margin-left: 5.0em"><br>
Sets the reason string that is shown for a printer that is
rejecting jobs.
+</dl>
<h2 class="title"><a name="COMPATIBILITY">Compatibility</a></h2>
Unlike the System V printing system, CUPS allows printer names to
contain any printable character except SPACE, TAB, "/", or "#".
<h2 class="title"><a name="OPTIONS">Options</a></h2>
<i>cupsaddsmb</i> supports the following options:
-<p style="margin-left: 5.0em; text-indent: -5.0em">-H samba-server
-<br>
-<br>
+<dl class="man">
+<dt>-H samba-server
+<dd style="margin-left: 5.0em"><br>
Specifies the SAMBA server which defaults to the CUPS server.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-U samba-user[%samba-password]
-<br>
-<br>
+<dt>-U samba-user[%samba-password]
+<dd style="margin-left: 5.0em"><br>
Specifies the SAMBA print admin username which defaults to your
current username. If the username contains a percent (%)
character, then the text following the percent is treated as the
SAMBA password to use.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-a
-<br>
-<br>
+<dt>-a
+<dd style="margin-left: 5.0em"><br>
Exports all known printers. Otherwise only the named printers are
exported.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-h cups-server[:port]
-<br>
-<br>
+<dt>-h cups-server[:port]
+<dd style="margin-left: 5.0em"><br>
Specifies a different CUPS server to use.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-v
-<br>
-<br>
+<dt>-v
+<dd style="margin-left: 5.0em"><br>
Specifies that verbose information should be shown. This is
useful for debugging SAMBA configuration problems.
+</dl>
<h2 class="title"><a name="SAMBA_CONFIGURATION">Samba Configuration</a></h2>
<i>cupsaddsmb</i> uses the new RPC-based printing support in
SAMBA 2.2.x to provide printer drivers and PPD files to Windows
first configure the SAMBA <i>smb.conf(5)</i> file to support
printing through CUPS and provide a printer driver download
share, as follows:
-<pre>
+<pre class="man">
[global]
load printers = yes
to the <i>/usr/share/cups/drivers</i> directory and the 64-bit
drivers to the <i>/usr/share/cups/drivers/x64</i> directory exactly
as named below:
-<pre>
+<pre class="man">
[Windows 2000 and higher]
ps5ui.dll
<p>Once you have installed the driver on a Windows system, copy the
following files to the <i>/usr/share/cups/drivers</i> directory
exactly as named below:
-<pre>
+<pre class="man">
[Windows 95, 98, and Me]
ADFONTS.MFM
standard output in the format "name=value", one per line.
<h2 class="title"><a name="OPTIONS">Options</a></h2>
The following options are recognized:
-<p style="margin-left: 5.0em; text-indent: -5.0em">-E
-<br>
-<br>
+<dl class="man">
+<dt>-E
+<dd style="margin-left: 5.0em"><br>
Enables encryption on the connection to the scheduler.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-U <i>username</i>
-<br>
-<br>
+<dt>-U <i>username</i>
+<dd style="margin-left: 5.0em"><br>
Specifies an alternate username to use when authenticating with the scheduler.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-h <i>server[:port]</i>
-<br>
-<br>
+<dt>-h <i>server[:port]</i>
+<dd style="margin-left: 5.0em"><br>
Specifies the server address.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--[no-]debug-logging
-<br>
-<br>
+<dt>--[no-]debug-logging
+<dd style="margin-left: 5.0em"><br>
Enables or disables debug logging in the <b>error_log</b> file.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--[no-]remote-admin
-<br>
-<br>
+<dt>--[no-]remote-admin
+<dd style="margin-left: 5.0em"><br>
Enables or disables remote administration.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--[no-]remote-any
-<br>
-<br>
+<dt>--[no-]remote-any
+<dd style="margin-left: 5.0em"><br>
Enables or disables printing from any address, e.g. the Internet.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--[no-]share-printers
-<br>
-<br>
+<dt>--[no-]share-printers
+<dd style="margin-left: 5.0em"><br>
Enables or disables sharing of local printers with other computers.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--[no-]user-cancel-any
-<br>
-<br>
+<dt>--[no-]user-cancel-any
+<dd style="margin-left: 5.0em"><br>
Allows or prevents users from canceling jobs owned by others.
+</dl>
<h2 class="title"><a name="EXAMPLES">Examples</a></h2>
Display the current settings:
-<pre>
+<pre class="man">
cupsctl
</pre>
<p>Enable debug logging:
-<pre>
+<pre class="man">
cupsctl --debug-logging
</pre>
<p>Get the current debug logging state:
-<pre>
+<pre class="man">
cupsctl | grep '^_debug_logging' | awk -F= '{print $2}'
</pre>
<p>Disable printer sharing:
-<pre>
+<pre class="man">
cupsctl --no-share-printers
</pre>
<h2 class="title"><a name="KNOWN_ISSUES">Known Issues</a></h2>
<i>cupsd.conf</i>
file configures the CUPS scheduler,
<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8).</a>
-It is normally located in the <i>/etc/cups</i> directory. <b>Note:</b> File, directory, and user configuration directives that used to be allowed in the <i>cupsd.conf</i> file are now stored in the <i>cups-files.conf(5)</i> instead in order to prevent certain types of privilege escalation attacks.
+It is normally located in the
+<i>/etc/cups</i>
+directory. <b>Note:</b> File, directory, and user configuration directives that used to be allowed in the <i>cupsd.conf</i> file are now stored in the <i>cups-files.conf(5)</i> instead in order to prevent certain types of privilege escalation attacks.
<p>Each line in the file can be a configuration directive, a blank line, or a comment. Comment lines start with the # character. The configuration directives are intentionally similar to those used by the popular Apache web server software and are described below.
<h2 class="title"><a name="TOP_LEVEL_DIRECTIVES">Top-level Directives</a></h2>
The following directives are understood by
<b>cupsd</b><b>(8).</b>
Consult the online help (<a href="http://localhost:631/help">http://localhost:631/help</a>) for detailed descriptions:
-<p style="margin-left: 5.0em; text-indent: -5.0em">AccessLogLevel config
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">AccessLogLevel actions
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">AccessLogLevel all
-<br>
-Specifies the logging level for the AccessLog file.
-<p style="margin-left: 5.0em; text-indent: -5.0em">AutoPurgeJobs Yes
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">AutoPurgeJobs No
-<br>
-<br>
+<dl class="man">
+<dt>AccessLogLevel config
+<dd style="margin-left: 5.0em"><dt>AccessLogLevel actions
+<dd style="margin-left: 5.0em"><dt>AccessLogLevel all
+<dd style="margin-left: 5.0em">Specifies the logging level for the AccessLog file.
+<dt>AutoPurgeJobs Yes
+<dd style="margin-left: 5.0em"><dt>AutoPurgeJobs No
+<dd style="margin-left: 5.0em"><br>
Specifies whether to purge job history data automatically when
it is no longer required for quotas.
-<p style="margin-left: 5.0em; text-indent: -5.0em">BrowseLocalProtocols [
-<br>
-<i>All</i>
+<dt>BrowseLocalProtocols [
+<dd style="margin-left: 5.0em"><i>All</i>
] [
<i>DNSSD</i>
]
Specifies the protocols to use for local printer sharing.
-<p style="margin-left: 5.0em; text-indent: -5.0em">BrowseWebIF Yes
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">BrowseWebIF No
-<br>
-<br>
+<dt>BrowseWebIF Yes
+<dd style="margin-left: 5.0em"><dt>BrowseWebIF No
+<dd style="margin-left: 5.0em"><br>
Specifies whether the CUPS web interface is advertised via DNS-SD.
-<p style="margin-left: 5.0em; text-indent: -5.0em">Browsing Yes
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">Browsing No
-<br>
-<br>
+<dt>Browsing Yes
+<dd style="margin-left: 5.0em"><dt>Browsing No
+<dd style="margin-left: 5.0em"><br>
Specifies whether or not shared printers should be advertised.
-<p style="margin-left: 5.0em; text-indent: -5.0em">Classification banner
-<br>
-<br>
+<dt>Classification banner
+<dd style="margin-left: 5.0em"><br>
Specifies the security classification of the server.
-<p style="margin-left: 5.0em; text-indent: -5.0em">ClassifyOverride Yes
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">ClassifyOverride No
-<br>
-<br>
+<dt>ClassifyOverride Yes
+<dd style="margin-left: 5.0em"><dt>ClassifyOverride No
+<dd style="margin-left: 5.0em"><br>
Specifies whether to allow users to override the classification
of individual print jobs.
-<p style="margin-left: 5.0em; text-indent: -5.0em">DefaultAuthType Basic
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">DefaultAuthType Negotiate
-<br>
-<br>
+<dt>DefaultAuthType Basic
+<dd style="margin-left: 5.0em"><dt>DefaultAuthType Negotiate
+<dd style="margin-left: 5.0em"><br>
Specifies the default type of authentication to use.
-<p style="margin-left: 5.0em; text-indent: -5.0em">DefaultEncryption Never
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">DefaultEncryption IfRequested
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">DefaultEncryption Required
-<br>
-Specifies the type of encryption to use for authenticated requests.
-<p style="margin-left: 5.0em; text-indent: -5.0em">DefaultLanguage locale
-<br>
-Specifies the default language to use for text and web content.
-<p style="margin-left: 5.0em; text-indent: -5.0em">DefaultPaperSize Auto
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">DefaultPaperSize None
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">DefaultPaperSize sizename
-<br>
-Specifies the default paper size for new print queues. "Auto" uses a locale-
+<dt>DefaultEncryption Never
+<dd style="margin-left: 5.0em"><dt>DefaultEncryption IfRequested
+<dd style="margin-left: 5.0em"><dt>DefaultEncryption Required
+<dd style="margin-left: 5.0em">Specifies the type of encryption to use for authenticated requests.
+<dt>DefaultLanguage locale
+<dd style="margin-left: 5.0em">Specifies the default language to use for text and web content.
+<dt>DefaultPaperSize Auto
+<dd style="margin-left: 5.0em"><dt>DefaultPaperSize None
+<dd style="margin-left: 5.0em"><dt>DefaultPaperSize sizename
+<dd style="margin-left: 5.0em">Specifies the default paper size for new print queues. "Auto" uses a locale-
specific default, while "None" specifies there is no default paper size.
-<p style="margin-left: 5.0em; text-indent: -5.0em">DefaultPolicy policy-name
-<br>
-Specifies the default access policy to use.
-<p style="margin-left: 5.0em; text-indent: -5.0em">DefaultShared Yes
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">DefaultShared No
-<br>
-Specifies whether local printers are shared by default.
-<p style="margin-left: 5.0em; text-indent: -5.0em">DirtyCleanInterval seconds
-<br>
-Specifies the delay for updating of configuration and state files. A value of 0
+<dt>DefaultPolicy policy-name
+<dd style="margin-left: 5.0em">Specifies the default access policy to use.
+<dt>DefaultShared Yes
+<dd style="margin-left: 5.0em"><dt>DefaultShared No
+<dd style="margin-left: 5.0em">Specifies whether local printers are shared by default.
+<dt>DirtyCleanInterval seconds
+<dd style="margin-left: 5.0em">Specifies the delay for updating of configuration and state files. A value of 0
causes the update to happen as soon as possible, typically within a few
milliseconds.
-<p style="margin-left: 5.0em; text-indent: -5.0em">FilterLimit limit
-<br>
-Specifies the maximum cost of filters that are run concurrently.
-<p style="margin-left: 5.0em; text-indent: -5.0em">FilterNice nice-value
-<br>
-Specifies the scheduling priority ("nice" value) of filters that
+<dt>FilterLimit limit
+<dd style="margin-left: 5.0em">Specifies the maximum cost of filters that are run concurrently.
+<dt>FilterNice nice-value
+<dd style="margin-left: 5.0em">Specifies the scheduling priority ("nice" value) of filters that
are run to print a job.
-<p style="margin-left: 5.0em; text-indent: -5.0em">GSSServiceName name
-<br>
-Specifies the service name when using Kerberos authentication. The default
+<dt>GSSServiceName name
+<dd style="margin-left: 5.0em">Specifies the service name when using Kerberos authentication. The default
service name is "http".
-<p style="margin-left: 5.0em; text-indent: -5.0em">HostNameLookups On
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">HostNameLookups Off
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">HostNameLookups Double
-<br>
-Specifies whether or not to do reverse lookups on client addresses.
-<p style="margin-left: 5.0em; text-indent: -5.0em">Include filename
-<br>
-Includes the named file.
-<p style="margin-left: 5.0em; text-indent: -5.0em">JobKillDelay seconds
-<br>
-Specifies the number of seconds to wait before killing the filters and backend
+<dt>HostNameLookups On
+<dd style="margin-left: 5.0em"><dt>HostNameLookups Off
+<dd style="margin-left: 5.0em"><dt>HostNameLookups Double
+<dd style="margin-left: 5.0em">Specifies whether or not to do reverse lookups on client addresses.
+<dt>Include filename
+<dd style="margin-left: 5.0em">Includes the named file.
+<dt>JobKillDelay seconds
+<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.
-<p style="margin-left: 5.0em; text-indent: -5.0em">JobRetryInterval seconds
-<br>
-Specifies the interval between retries of jobs in seconds.
-<p style="margin-left: 5.0em; text-indent: -5.0em">JobRetryLimit count
-<br>
-Specifies the number of retries that are done for jobs.
-<p style="margin-left: 5.0em; text-indent: -5.0em">KeepAlive Yes
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">KeepAlive No
-<br>
-Specifies whether to support HTTP keep-alive connections.
-<p style="margin-left: 5.0em; text-indent: -5.0em">KeepAliveTimeout seconds
-<br>
-Specifies the amount of time that connections are kept alive.
-<p style="margin-left: 5.0em; text-indent: -5.0em"><Limit operations> ... </Limit>
-<br>
-Specifies the IPP operations that are being limited inside a policy.
-<p style="margin-left: 5.0em; text-indent: -5.0em"><Limit methods> ... </Limit>
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><LimitExcept methods> ... </LimitExcept>
-<br>
-Specifies the HTTP methods that are being limited inside a location.
-<p style="margin-left: 5.0em; text-indent: -5.0em">LimitRequestBody
-<br>
-Specifies the maximum size of any print job request.
-<p style="margin-left: 5.0em; text-indent: -5.0em">Listen ip-address:port
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">Listen *:port
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">Listen /path/to/domain/socket
-<br>
-Listens to the specified address and port or domain socket path.
-<p style="margin-left: 5.0em; text-indent: -5.0em"><Location /path> ... </Location>
-<br>
-Specifies access control for the named location.
-<p style="margin-left: 5.0em; text-indent: -5.0em">LogDebugHistory #-messages
-<br>
-Specifies the number of debugging messages that are logged when an error
+<dt>JobRetryInterval seconds
+<dd style="margin-left: 5.0em">Specifies the interval between retries of jobs in seconds.
+<dt>JobRetryLimit count
+<dd style="margin-left: 5.0em">Specifies the number of retries that are done for jobs.
+<dt>KeepAlive Yes
+<dd style="margin-left: 5.0em"><dt>KeepAlive No
+<dd style="margin-left: 5.0em">Specifies whether to support HTTP keep-alive connections.
+<dt>KeepAliveTimeout seconds
+<dd style="margin-left: 5.0em">Specifies the amount of time that connections are kept alive.
+<dt><Limit operations> ... </Limit>
+<dd style="margin-left: 5.0em">Specifies the IPP operations that are being limited inside a policy.
+<dt><Limit methods> ... </Limit>
+<dd style="margin-left: 5.0em"><dt><LimitExcept methods> ... </LimitExcept>
+<dd style="margin-left: 5.0em">Specifies the HTTP methods that are being limited inside a location.
+<dt>LimitRequestBody
+<dd style="margin-left: 5.0em">Specifies the maximum size of any print job request.
+<dt>Listen ip-address:port
+<dd style="margin-left: 5.0em"><dt>Listen *:port
+<dd style="margin-left: 5.0em"><dt>Listen /path/to/domain/socket
+<dd style="margin-left: 5.0em">Listens to the specified address and port or domain socket path.
+<dt><Location /path> ... </Location>
+<dd style="margin-left: 5.0em">Specifies access control for the named location.
+<dt>LogDebugHistory #-messages
+<dd style="margin-left: 5.0em">Specifies the number of debugging messages that are logged when an error
occurs in a print job.
-<p style="margin-left: 5.0em; text-indent: -5.0em">LogLevel alert
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">LogLevel crit
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">LogLevel debug2
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">LogLevel debug
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">LogLevel emerg
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">LogLevel error
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">LogLevel info
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">LogLevel none
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">LogLevel notice
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">LogLevel warn
-<br>
-Specifies the logging level for the ErrorLog file.
-<p style="margin-left: 5.0em; text-indent: -5.0em">LogTimeFormat standard
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">LogTimeFormat usecs
-<br>
-Specifies the format of the date and time in the log files.
-<p style="margin-left: 5.0em; text-indent: -5.0em">MaxClients number
-<br>
-Specifies the maximum number of simultaneous clients to support.
-<p style="margin-left: 5.0em; text-indent: -5.0em">MaxClientsPerHost number
-<br>
-Specifies the maximum number of simultaneous clients to support from a
+<dt>LogLevel alert
+<dd style="margin-left: 5.0em"><dt>LogLevel crit
+<dd style="margin-left: 5.0em"><dt>LogLevel debug2
+<dd style="margin-left: 5.0em"><dt>LogLevel debug
+<dd style="margin-left: 5.0em"><dt>LogLevel emerg
+<dd style="margin-left: 5.0em"><dt>LogLevel error
+<dd style="margin-left: 5.0em"><dt>LogLevel info
+<dd style="margin-left: 5.0em"><dt>LogLevel none
+<dd style="margin-left: 5.0em"><dt>LogLevel notice
+<dd style="margin-left: 5.0em"><dt>LogLevel warn
+<dd style="margin-left: 5.0em">Specifies the logging level for the ErrorLog file.
+<dt>LogTimeFormat standard
+<dd style="margin-left: 5.0em"><dt>LogTimeFormat usecs
+<dd style="margin-left: 5.0em">Specifies the format of the date and time in the log files.
+<dt>MaxClients number
+<dd style="margin-left: 5.0em">Specifies the maximum number of simultaneous clients to support.
+<dt>MaxClientsPerHost number
+<dd style="margin-left: 5.0em">Specifies the maximum number of simultaneous clients to support from a
single address.
-<p style="margin-left: 5.0em; text-indent: -5.0em">MaxCopies number
-<br>
-Specifies the maximum number of copies that a user can print of each job.
-<p style="margin-left: 5.0em; text-indent: -5.0em">MaxHoldTime seconds
-<br>
-Specifies the maximum time a job may remain in the "indefinite" hold state
+<dt>MaxCopies number
+<dd style="margin-left: 5.0em">Specifies the maximum number of copies that a user can print of each job.
+<dt>MaxHoldTime seconds
+<dd style="margin-left: 5.0em">Specifies the maximum time a job may remain in the "indefinite" hold state
before it is canceled. Set to 0 to disable cancellation of held jobs.
-<p style="margin-left: 5.0em; text-indent: -5.0em">MaxJobs number
-<br>
-Specifies the maximum number of simultaneous jobs to support.
-<p style="margin-left: 5.0em; text-indent: -5.0em">MaxJobsPerPrinter number
-<br>
-Specifies the maximum number of simultaneous jobs per printer to support.
-<p style="margin-left: 5.0em; text-indent: -5.0em">MaxJobsPerUser number
-<br>
-Specifies the maximum number of simultaneous jobs per user to support.
-<p style="margin-left: 5.0em; text-indent: -5.0em">MaxJobTime seconds
-<br>
-Specifies the maximum time a job may take to print before it is canceled. The
+<dt>MaxJobs number
+<dd style="margin-left: 5.0em">Specifies the maximum number of simultaneous jobs to support.
+<dt>MaxJobsPerPrinter number
+<dd style="margin-left: 5.0em">Specifies the maximum number of simultaneous jobs per printer to support.
+<dt>MaxJobsPerUser number
+<dd style="margin-left: 5.0em">Specifies the maximum number of simultaneous jobs per user to support.
+<dt>MaxJobTime seconds
+<dd style="margin-left: 5.0em">Specifies the maximum time a job may take to print before it is canceled. The
default is 10800 seconds (3 hours). Set to 0 to disable cancellation of "stuck"
jobs.
-<p style="margin-left: 5.0em; text-indent: -5.0em">MaxLogSize number-bytes
-<br>
-Specifies the maximum size of the log files before they are
+<dt>MaxLogSize number-bytes
+<dd style="margin-left: 5.0em">Specifies the maximum size of the log files before they are
rotated (0 to disable rotation)
-<p style="margin-left: 5.0em; text-indent: -5.0em">MaxRequestSize number-bytes
-<br>
-Specifies the maximum request/file size in bytes (0 for no limit)
-<p style="margin-left: 5.0em; text-indent: -5.0em">MultipleOperationTimeout seconds
-<br>
-Specifies the maximum amount of time to allow between files in a multiple file
+<dt>MaxRequestSize number-bytes
+<dd style="margin-left: 5.0em">Specifies the maximum request/file size in bytes (0 for no limit)
+<dt>MultipleOperationTimeout seconds
+<dd style="margin-left: 5.0em">Specifies the maximum amount of time to allow between files in a multiple file
print job.
-<p style="margin-left: 5.0em; text-indent: -5.0em">PageLogFormat format string
-<br>
-Specifies the format of page log lines.
-<p style="margin-left: 5.0em; text-indent: -5.0em">PassEnv variable [... variable]
-<br>
-Passes the specified environment variable(s) to child processes.
-<p style="margin-left: 5.0em; text-indent: -5.0em"><Policy name> ... </Policy>
-<br>
-Specifies access control for the named policy.
-<p style="margin-left: 5.0em; text-indent: -5.0em">Port number
-<br>
-Specifies a port number to listen to for HTTP requests.
-<p style="margin-left: 5.0em; text-indent: -5.0em">PreserveJobFiles Yes
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">PreserveJobFiles No
-<br>
-Specifies whether or not to preserve job files after they are printed.
-<p style="margin-left: 5.0em; text-indent: -5.0em">PreserveJobHistory Yes
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">PreserveJobHistory No
-<br>
-Specifies whether or not to preserve the job history after they are
+<dt>PageLogFormat format string
+<dd style="margin-left: 5.0em">Specifies the format of page log lines.
+<dt>PassEnv variable [... variable]
+<dd style="margin-left: 5.0em">Passes the specified environment variable(s) to child processes.
+<dt><Policy name> ... </Policy>
+<dd style="margin-left: 5.0em">Specifies access control for the named policy.
+<dt>Port number
+<dd style="margin-left: 5.0em">Specifies a port number to listen to for HTTP requests.
+<dt>PreserveJobFiles Yes
+<dd style="margin-left: 5.0em"><dt>PreserveJobFiles No
+<dd style="margin-left: 5.0em">Specifies whether or not to preserve job files after they are printed.
+<dt>PreserveJobHistory Yes
+<dd style="margin-left: 5.0em"><dt>PreserveJobHistory No
+<dd style="margin-left: 5.0em">Specifies whether or not to preserve the job history after they are
printed.
-<p style="margin-left: 5.0em; text-indent: -5.0em">PrintcapFormat bsd
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">PrintcapFormat plist
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">PrintcapFormat solaris
-<br>
-Specifies the format of the printcap file.
-<p style="margin-left: 5.0em; text-indent: -5.0em">ReloadTimeout seconds
-<br>
-Specifies the amount of time to wait for job completion before
+<dt>PrintcapFormat bsd
+<dd style="margin-left: 5.0em"><dt>PrintcapFormat plist
+<dd style="margin-left: 5.0em"><dt>PrintcapFormat solaris
+<dd style="margin-left: 5.0em">Specifies the format of the printcap file.
+<dt>ReloadTimeout seconds
+<dd style="margin-left: 5.0em">Specifies the amount of time to wait for job completion before
restarting the scheduler.
-<p style="margin-left: 5.0em; text-indent: -5.0em">RIPCache bytes
-<br>
-Specifies the maximum amount of memory to use when converting images
+<dt>RIPCache bytes
+<dd style="margin-left: 5.0em">Specifies the maximum amount of memory to use when converting images
and PostScript files to bitmaps for a printer.
-<p style="margin-left: 5.0em; text-indent: -5.0em">Satisfy all
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">Satisfy any
-<br>
-Specifies whether all or any limits set for a Location must be
+<dt>Satisfy all
+<dd style="margin-left: 5.0em"><dt>Satisfy any
+<dd style="margin-left: 5.0em">Specifies whether all or any limits set for a Location must be
satisfied to allow access.
-<p style="margin-left: 5.0em; text-indent: -5.0em">ServerAdmin user@domain.com
-<br>
-Specifies the email address of the server administrator.
-<p style="margin-left: 5.0em; text-indent: -5.0em">ServerAlias hostname [... hostname]
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">ServerAlias *
-<br>
-Specifies an alternate name that the server is known by. The special name "*"
+<dt>ServerAdmin user@domain.com
+<dd style="margin-left: 5.0em">Specifies the email address of the server administrator.
+<dt>ServerAlias hostname [... hostname]
+<dd style="margin-left: 5.0em"><dt>ServerAlias *
+<dd style="margin-left: 5.0em">Specifies an alternate name that the server is known by. The special name "*"
allows any name to be used.
-<p style="margin-left: 5.0em; text-indent: -5.0em">ServerName hostname-or-ip-address
-<br>
-Specifies the fully-qualified hostname of the server.
-<p style="margin-left: 5.0em; text-indent: -5.0em">ServerTokens Full
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">ServerTokens Major
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">ServerTokens Minimal
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">ServerTokens Minor
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">ServerTokens None
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">ServerTokens OS
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">ServerTokens ProductOnly
-<br>
-Specifies what information is included in the Server header of HTTP
+<dt>ServerName hostname-or-ip-address
+<dd style="margin-left: 5.0em">Specifies the fully-qualified hostname of the server.
+<dt>ServerTokens Full
+<dd style="margin-left: 5.0em"><dt>ServerTokens Major
+<dd style="margin-left: 5.0em"><dt>ServerTokens Minimal
+<dd style="margin-left: 5.0em"><dt>ServerTokens Minor
+<dd style="margin-left: 5.0em"><dt>ServerTokens None
+<dd style="margin-left: 5.0em"><dt>ServerTokens OS
+<dd style="margin-left: 5.0em"><dt>ServerTokens ProductOnly
+<dd style="margin-left: 5.0em">Specifies what information is included in the Server header of HTTP
responses.
-<p style="margin-left: 5.0em; text-indent: -5.0em">SetEnv variable value
-<br>
-Set the specified environment variable to be passed to child processes.
-<p style="margin-left: 5.0em; text-indent: -5.0em">SSLListen
-<br>
-Listens on the specified address and port for encrypted connections.
-<p style="margin-left: 5.0em; text-indent: -5.0em">SSLPort
-<br>
-Listens on the specified port for encrypted connections.
-<p style="margin-left: 5.0em; text-indent: -5.0em">StrictConformance Yes
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">StrictConformance No
-<br>
-Specifies whether the scheduler requires clients to strictly adhere to the IPP
+<dt>SetEnv variable value
+<dd style="margin-left: 5.0em">Set the specified environment variable to be passed to child processes.
+<dt>SSLListen
+<dd style="margin-left: 5.0em">Listens on the specified address and port for encrypted connections.
+<dt>SSLPort
+<dd style="margin-left: 5.0em">Listens on the specified port for encrypted connections.
+<dt>StrictConformance Yes
+<dd style="margin-left: 5.0em"><dt>StrictConformance No
+<dd style="margin-left: 5.0em">Specifies whether the scheduler requires clients to strictly adhere to the IPP
specifications. The default is No.
-<p style="margin-left: 5.0em; text-indent: -5.0em">Timeout seconds
-<br>
-Specifies the HTTP request timeout in seconds.
-<p style="margin-left: 5.0em; text-indent: -5.0em">WebInterface yes
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">WebInterface no
-<br>
-Specifies whether the web interface is enabled.
+<dt>Timeout seconds
+<dd style="margin-left: 5.0em">Specifies the HTTP request timeout in seconds.
+<dt>WebInterface yes
+<dd style="margin-left: 5.0em"><dt>WebInterface no
+<dd style="margin-left: 5.0em">Specifies whether the web interface is enabled.
+</dl>
<h2 class="title"><a name="DIRECTIVES_VALID_WITHIN_LOCATION_AND_LIMIT_SECTIONS">Directives Valid Within Location And Limit Sections</a></h2>
The following directives may be placed inside Location and Limit sections in the <i>cupsd.conf</i> file:
-<p style="margin-left: 5.0em; text-indent: -5.0em">Allow all
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">Allow none
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">Allow host.domain.com
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">Allow *.domain.com
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">Allow ip-address
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">Allow ip-address/netmask
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">Allow ip-address/mm
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">Allow @IF(name)
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">Allow @LOCAL
-<br>
-Allows access from the named hosts or addresses.
-<p style="margin-left: 5.0em; text-indent: -5.0em">AuthType None
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">AuthType Basic
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">AuthType Negotiate
-<br>
-Specifies the authentication type (None, Basic, or Negotiate)
-<p style="margin-left: 5.0em; text-indent: -5.0em">Deny all
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">Deny none
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">Deny host.domain.com
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">Deny *.domain.com
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">Deny ip-address
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">Deny ip-address/netmask
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">Deny ip-address/mm
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">Deny @IF(name)
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">Deny @LOCAL
-<br>
-Denies access to the named host or address.
-<p style="margin-left: 5.0em; text-indent: -5.0em">Encryption IfRequested
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">Encryption Never
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">Encryption Required
-<br>
-Specifies the level of encryption that is required for a particular
+<dl class="man">
+<dt>Allow all
+<dd style="margin-left: 5.0em"><dt>Allow none
+<dd style="margin-left: 5.0em"><dt>Allow host.domain.com
+<dd style="margin-left: 5.0em"><dt>Allow *.domain.com
+<dd style="margin-left: 5.0em"><dt>Allow ip-address
+<dd style="margin-left: 5.0em"><dt>Allow ip-address/netmask
+<dd style="margin-left: 5.0em"><dt>Allow ip-address/mm
+<dd style="margin-left: 5.0em"><dt>Allow @IF(name)
+<dd style="margin-left: 5.0em"><dt>Allow @LOCAL
+<dd style="margin-left: 5.0em">Allows access from the named hosts or addresses.
+<dt>AuthType None
+<dd style="margin-left: 5.0em"><dt>AuthType Basic
+<dd style="margin-left: 5.0em"><dt>AuthType Negotiate
+<dd style="margin-left: 5.0em">Specifies the authentication type (None, Basic, or Negotiate)
+<dt>Deny all
+<dd style="margin-left: 5.0em"><dt>Deny none
+<dd style="margin-left: 5.0em"><dt>Deny host.domain.com
+<dd style="margin-left: 5.0em"><dt>Deny *.domain.com
+<dd style="margin-left: 5.0em"><dt>Deny ip-address
+<dd style="margin-left: 5.0em"><dt>Deny ip-address/netmask
+<dd style="margin-left: 5.0em"><dt>Deny ip-address/mm
+<dd style="margin-left: 5.0em"><dt>Deny @IF(name)
+<dd style="margin-left: 5.0em"><dt>Deny @LOCAL
+<dd style="margin-left: 5.0em">Denies access to the named host or address.
+<dt>Encryption IfRequested
+<dd style="margin-left: 5.0em"><dt>Encryption Never
+<dd style="margin-left: 5.0em"><dt>Encryption Required
+<dd style="margin-left: 5.0em">Specifies the level of encryption that is required for a particular
location.
-<p style="margin-left: 5.0em; text-indent: -5.0em">Order allow,deny
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">Order deny,allow
-<br>
-Specifies the order of HTTP access control (allow,deny or deny,allow)
-<p style="margin-left: 5.0em; text-indent: -5.0em">Require group group-name-list
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">Require user user-name-list
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">Require valid-user
-<br>
-Specifies that user or group authentication is required.
+<dt>Order allow,deny
+<dd style="margin-left: 5.0em"><dt>Order deny,allow
+<dd style="margin-left: 5.0em">Specifies the order of HTTP access control (allow,deny or deny,allow)
+<dt>Require group group-name-list
+<dd style="margin-left: 5.0em"><dt>Require user user-name-list
+<dd style="margin-left: 5.0em"><dt>Require valid-user
+<dd style="margin-left: 5.0em">Specifies that user or group authentication is required.
+</dl>
<h2 class="title"><a name="DIRECTIVES_VALID_WITHIN_POLICY_SECTIONS">Directives Valid Within Policy Sections</a></h2>
The following directives may be placed inside Policy sections in the <i>cupsd.conf</i> file:
-<p style="margin-left: 5.0em; text-indent: -5.0em">JobPrivateAccess all
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">JobPrivateAccess default
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">JobPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+
-<br>
-Specifies an access list for a job's private values. The "default" access list is "@OWNER @SYSTEM". "@ACL" maps to the printer's requesting-user-name-allowed or requesting-user-name-denied values.
-<p style="margin-left: 5.0em; text-indent: -5.0em">JobPrivateValues all
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">JobPrivateValues default
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">JobPrivateValues none
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">JobPrivateValues attribute-name-1 [ ... attribute-name-N ]
-<br>
-Specifies the list of job values to make private. The "default" values are "job-name", "job-originating-host-name", and "job-originating-user-name".
-<p style="margin-left: 5.0em; text-indent: -5.0em">SubscriptionPrivateAccess all
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">SubscriptionPrivateAccess default
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">SubscriptionPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+
-<br>
-Specifies an access list for a subscription's private values. The "default"
+<dl class="man">
+<dt>JobPrivateAccess all
+<dd style="margin-left: 5.0em"><dt>JobPrivateAccess default
+<dd style="margin-left: 5.0em"><dt>JobPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+
+<dd style="margin-left: 5.0em">Specifies an access list for a job's private values. The "default" access list is "@OWNER @SYSTEM". "@ACL" maps to the printer's requesting-user-name-allowed or requesting-user-name-denied values.
+<dt>JobPrivateValues all
+<dd style="margin-left: 5.0em"><dt>JobPrivateValues default
+<dd style="margin-left: 5.0em"><dt>JobPrivateValues none
+<dd style="margin-left: 5.0em"><dt>JobPrivateValues attribute-name-1 [ ... attribute-name-N ]
+<dd style="margin-left: 5.0em">Specifies the list of job values to make private. The "default" values are "job-name", "job-originating-host-name", and "job-originating-user-name".
+<dt>SubscriptionPrivateAccess all
+<dd style="margin-left: 5.0em"><dt>SubscriptionPrivateAccess default
+<dd style="margin-left: 5.0em"><dt>SubscriptionPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+
+<dd style="margin-left: 5.0em">Specifies an access list for a subscription's private values. The "default"
access list is "@OWNER @SYSTEM". "@ACL" maps to the printer's
requesting-user-name-allowed or requesting-user-name-denied values.
-<p style="margin-left: 5.0em; text-indent: -5.0em">SubscriptionPrivateValues all
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">SubscriptionPrivateValues default
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">SubscriptionPrivateValues none
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">SubscriptionPrivateValues attribute-name-1 [ ... attribute-name-N ]
-<br>
-Specifies the list of job values to make private. The "default" values are
+<dt>SubscriptionPrivateValues all
+<dd style="margin-left: 5.0em"><dt>SubscriptionPrivateValues default
+<dd style="margin-left: 5.0em"><dt>SubscriptionPrivateValues none
+<dd style="margin-left: 5.0em"><dt>SubscriptionPrivateValues attribute-name-1 [ ... attribute-name-N ]
+<dd style="margin-left: 5.0em">Specifies the list of job values to make private. The "default" values are
"notify-events", "notify-pull-method", "notify-recipient-uri",
"notify-subscriber-user-name", and "notify-user-data".
+</dl>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<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>
+<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>
<a href="http://localhost:631/help">http://localhost:631/help</a>
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright © 2007-2014 by Apple Inc.
cupsd - cups scheduler
<h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2>
<b>cupsd</b>
-[ -c
+[
+<b>-c</b>
<i>config-file</i>
-] [ -f ] [ -F ] [ -h ] [ -l ] [ -t ]
+] [
+<b>-f</b>
+] [
+<b>-F</b>
+] [
+<b>-h</b>
+] [
+<b>-l</b>
+] [
+<b>-t</b>
+]
<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
<b>cupsd</b>
is the scheduler for CUPS. It implements a printing system based upon the Internet Printing Protocol, version 2.1. If no options are specified on the command-line then the default configuration file
<i>/etc/cups/cupsd.conf</i>
will be used.
<h2 class="title"><a name="OPTIONS">Options</a></h2>
-<p style="margin-left: 5.0em; text-indent: -5.0em">-c config-file
-<br>
-Uses the named configuration file.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-f
-<br>
-Run
+<dl class="man">
+<dt><b>-c</b><i> config-file</i>
+<dd style="margin-left: 5.0em">Uses the named configuration file.
+<dt><b>-f</b>
+<dd style="margin-left: 5.0em">Run
<b>cupsd</b>
in the foreground; the default is to run in the background as a "daemon".
-<p style="margin-left: 5.0em; text-indent: -5.0em">-F
-<br>
-Run
+<dt><b>-F</b>
+<dd style="margin-left: 5.0em">Run
<b>cupsd</b>
in the foreground but detach the process from the controlling terminal and current directory. This is useful for running
-<b>cupsd</b> from <b>init</b>(8).
-<p style="margin-left: 5.0em; text-indent: -5.0em">-h
-<br>
-Shows the program usage.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-l
-<br>
-This option is passed to
+<b>cupsd</b>
+from
+<b>init</b>(8).
+<dt><b>-h</b>
+<dd style="margin-left: 5.0em">Shows the program usage.
+<dt><b>-l</b>
+<dd style="margin-left: 5.0em">This option is passed to
<b>cupsd</b>
when it is run from
-<b>launchd</b>(8).
-<p style="margin-left: 5.0em; text-indent: -5.0em">-t
-<br>
-Test the configuration file for syntax errors.
-<h2 class="title"><a name="COMPATIBILITY">Compatibility</a></h2>
+<b>launchd</b>(8)
+or
+<b>systemd</b>(8).
+<dt><b>-t</b>
+<dd style="margin-left: 5.0em">Test the configuration file for syntax errors.
+</dl>
+<h2 class="title"><a name="FILES">Files</a></h2>
+<pre class="man">
+<i>/etc/cups/classes.conf</i>
+<i>/etc/cups/cups-files.conf</i>
+<i>/etc/cups/cupsd.conf</i>
+<i>/usr/share/cups/mime/mime.convs</i>
+<i>/usr/share/cups/mime/mime.types</i>
+<i>/etc/cups/printers.conf</i>
+</pre>
+<h2 class="title"><a name="CONFORMING_TO">Conforming To</a></h2>
+<b>cupsd</b>
+implements all of the required IPP/2.1 attributes and operations. It also implements several CUPS-specific administrative operations.
+<h2 class="title"><a name="EXAMPLES">Examples</a></h2>
+Run
+<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>
+Run
<b>cupsd</b>
-implements all of the required IPP/2.1 attributes and operations. It also implements several CUPS-specific administration operations.
+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>
-<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-deviced.html?TOPIC=Man+Pages"><b>cups-deviced</b>(8),</a> <a href="man-cups-driverd.html?TOPIC=Man+Pages"><b>cups-driverd</b>(8),</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-filter.html?TOPIC=Man+Pages"><b>filter</b>(7),</a> <b>launchd</b>(8), <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="http://localhost:631/help">http://localhost:631/help</a>
+<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-deviced.html?TOPIC=Man+Pages"><b>cups-deviced</b>(8),</a>
+<a href="man-cups-driverd.html?TOPIC=Man+Pages"><b>cups-driverd</b>(8),</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-filter.html?TOPIC=Man+Pages"><b>filter</b>(7),</a>
+<b>launchd</b>(8),
+<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>
Copyright © 2007-2014 by Apple Inc.
<i>cupsenable</i> starts the named printers or classes.
<p><i>cupsdisable</i> stops the named printers or classes. The
following options may be used:
-<p style="margin-left: 5.0em; text-indent: -5.0em">-E
-<br>
-<br>
+<dl class="man">
+<dt>-E
+<dd style="margin-left: 5.0em"><br>
Forces encryption of the connection to the server.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-U username
-<br>
-<br>
+<dt>-U username
+<dd style="margin-left: 5.0em"><br>
Uses the specified username when connecting to the server.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-c
-<br>
-<br>
+<dt>-c
+<dd style="margin-left: 5.0em"><br>
Cancels all jobs on the named destination.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-h server[:port]
-<br>
-<br>
+<dt>-h server[:port]
+<dd style="margin-left: 5.0em"><br>
Uses the specified server and port.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--hold
-<br>
-<br>
+<dt>--hold
+<dd style="margin-left: 5.0em"><br>
Holds remaining jobs on the named printer. Useful for allowing the current
job to complete before performing maintenance.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-r "reason"
-<br>
-<br>
+<dt>-r "reason"
+<dd style="margin-left: 5.0em"><br>
Sets the message associated with the stopped state. If no reason is specified
then the message is set to "Reason Unknown".
-<p style="margin-left: 5.0em; text-indent: -5.0em">--release
-<br>
-<br>
+<dt>--release
+<dd style="margin-left: 5.0em"><br>
Releases pending jobs for printing. Use after running <i>cupsdisable</i> with
the <i>--hold</i> option to resume printing.
+</dl>
<h2 class="title"><a name="COMPATIBILITY">Compatibility</a></h2>
Unlike the System V printing system, CUPS allows printer names to
contain any printable character except SPACE, TAB, "/", or "#".
<b>cupsfilter</b>
generates a PDF file. The converted file is sent to the standard output.
<h2 class="title"><a name="OPTIONS">Options</a></h2>
-<p style="margin-left: 5.0em; text-indent: -5.0em">--list-filters
-<br>
-Do not actually run the filters, just print the filters used to stdout.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-D
-<br>
-Delete the input file after conversion.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-U user
-<br>
-Specifies the username passed to the filters. The default is the name of the current user.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-c config-file
-<br>
-Uses the named cups-files.conf configuration file.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-d printer
-<br>
-Uses information from the named printer.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-e
-<br>
-Use every filter from the PPD file.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-i mime/type
-<br>
-Specifies the source file type. The default file type is guessed using the filename and contents of the file.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-j job-id[,N]
-<br>
-Converts document N from the specified job. If N is omitted, document 1 is converted.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-m mime/type
-<br>
-Specifies the destination file type. The default file type is application/pdf. Use printer/foo to convert to the printer format defined by the filters in the PPD file.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-n copies
-<br>
-Specifies the number of copies to generate.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o name=value
-<br>
-Specifies options to pass to the CUPS filters.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-p filename.ppd
-<br>
-Specifies the PPD file to use.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-t title
-<br>
-Specifies the document title.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-u
-<br>
-Delete the PPD file after conversion.
+<dl class="man">
+<dt>--list-filters
+<dd style="margin-left: 5.0em">Do not actually run the filters, just print the filters used to stdout.
+<dt>-D
+<dd style="margin-left: 5.0em">Delete the input file after conversion.
+<dt>-U user
+<dd style="margin-left: 5.0em">Specifies the username passed to the filters. The default is the name of the current user.
+<dt>-c config-file
+<dd style="margin-left: 5.0em">Uses the named cups-files.conf configuration file.
+<dt>-d printer
+<dd style="margin-left: 5.0em">Uses information from the named printer.
+<dt>-e
+<dd style="margin-left: 5.0em">Use every filter from the PPD file.
+<dt>-i mime/type
+<dd style="margin-left: 5.0em">Specifies the source file type. The default file type is guessed using the filename and contents of the file.
+<dt>-j job-id[,N]
+<dd style="margin-left: 5.0em">Converts document N from the specified job. If N is omitted, document 1 is converted.
+<dt>-m mime/type
+<dd style="margin-left: 5.0em">Specifies the destination file type. The default file type is application/pdf. Use printer/foo to convert to the printer format defined by the filters in the PPD file.
+<dt>-n copies
+<dd style="margin-left: 5.0em">Specifies the number of copies to generate.
+<dt>-o name=value
+<dd style="margin-left: 5.0em">Specifies options to pass to the CUPS filters.
+<dt>-p filename.ppd
+<dd style="margin-left: 5.0em">Specifies the PPD file to use.
+<dt>-t title
+<dd style="margin-left: 5.0em">Specifies the document title.
+<dt>-u
+<dd style="margin-left: 5.0em">Delete the PPD file after conversion.
+</dl>
<h2 class="title"><a name="EXIT_STATUS">Exit Status</a></h2>
<b>cupsfilter</b>
returns a non-zero exit status on any error.
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>
+<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>
-<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> mime.convs<b>(7),</b> mime.types<b>(7),</b>
+<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>mime.convs<b>(7),</b>mime.types<b>(7),</b>
<a href="http://localhost:631/help">http://localhost:631/help</a>
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright © 2007-2014 by Apple Inc.
on the standard input.
<h2 class="title"><a name="OPTIONS">Options</a></h2>
<i>cupstestppd</i> supports the following options:
-<p style="margin-left: 5.0em; text-indent: -5.0em">-I filename
-<br>
-<br>
+<dl class="man">
+<dt>-I filename
+<dd style="margin-left: 5.0em"><br>
Ignores all PCFileName warnings.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-I filters
-<br>
-<br>
+<dt>-I filters
+<dd style="margin-left: 5.0em"><br>
Ignores all filter errors.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-I profiles
-<br>
-<br>
+<dt>-I profiles
+<dd style="margin-left: 5.0em"><br>
Ignores all profile errors.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-R rootdir
-<br>
-<br>
+<dt>-R rootdir
+<dd style="margin-left: 5.0em"><br>
Specifies an alternate root directory for the filter, pre-filter,
and other support file checks.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-W constraints
-<br>
-<br>
+<dt>-W constraints
+<dd style="margin-left: 5.0em"><br>
Report all UIConstraint errors as warnings.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-W defaults
-<br>
-<br>
+<dt>-W defaults
+<dd style="margin-left: 5.0em"><br>
Except for size-related options, report all default option errors as warnings.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-W filters
-<br>
-<br>
+<dt>-W filters
+<dd style="margin-left: 5.0em"><br>
Report all filter errors as warnings.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-W profiles
-<br>
-<br>
+<dt>-W profiles
+<dd style="margin-left: 5.0em"><br>
Report all profile errors as warnings.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-W sizes
-<br>
-<br>
+<dt>-W sizes
+<dd style="margin-left: 5.0em"><br>
Report all media size errors as warnings.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-W translations
-<br>
-<br>
+<dt>-W translations
+<dd style="margin-left: 5.0em"><br>
Report all translation errors as warnings.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-W all
-<br>
-<br>
+<dt>-W all
+<dd style="margin-left: 5.0em"><br>
Report all of the previous errors as warnings.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-W none
-<br>
-<br>
+<dt>-W none
+<dd style="margin-left: 5.0em"><br>
Report all of the previous errors as errors.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-q
-<br>
-<br>
+<dt>-q
+<dd style="margin-left: 5.0em"><br>
Specifies that no information should be displayed.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-r
-<br>
-<br>
+<dt>-r
+<dd style="margin-left: 5.0em"><br>
Relaxes the PPD conformance requirements so that common
whitespace, control character, and formatting problems are not
treated as hard errors.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-v
-<br>
-<br>
+<dt>-v
+<dd style="margin-left: 5.0em"><br>
Specifies that detailed conformance testing results should be
displayed rather than the concise PASS/FAIL/ERROR status.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-vv
-<br>
-<br>
+<dt>-vv
+<dd style="margin-left: 5.0em"><br>
Specifies that all information in the PPD file should be
displayed in addition to the detailed conformance testing
results.
+</dl>
<p>The <i>-q</i>, <i>-v</i>, and <i>-vv</i> options are mutually exclusive.
<h2 class="title"><a name="EXIT_STATUS">Exit Status</a></h2>
<i>cupstestppd</i> returns zero on success and non-zero on error. The
error codes are as follows:
-<p style="margin-left: 5.0em; text-indent: -5.0em">1
-<br>
-<br>
+<dl class="man">
+<dt>1
+<dd style="margin-left: 5.0em"><br>
Bad command-line arguments or missing PPD filename.
-<p style="margin-left: 5.0em; text-indent: -5.0em">2
-<br>
-<br>
+<dt>2
+<dd style="margin-left: 5.0em"><br>
Unable to open or read PPD file.
-<p style="margin-left: 5.0em; text-indent: -5.0em">3
-<br>
-<br>
+<dt>3
+<dd style="margin-left: 5.0em"><br>
The PPD file contains format errors that cannot be skipped.
-<p style="margin-left: 5.0em; text-indent: -5.0em">4
-<br>
-<br>
+<dt>4
+<dd style="margin-left: 5.0em"><br>
The PPD file does not conform to the Adobe PPD specification.
+</dl>
<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>
+<pre class="man">
find . -name \*.ppd \! -exec cupstestppd -q '{}' \; -print
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>
+<pre class="man">
find . -name \*.ppd \! -exec cupstestppd -q '{}' \; \
-exec cupstestppd -v '{}' \;
[
<i>filename</i>
]
-<pre>
+<pre class="man">
<b>#include <cups/cups.h></b>
Use
<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>
+<pre class="man">
ppd_file_t *ppd = ppdOpenFile(getenv("PPD"));
cups_option_t *options = NULL;
<h2 class="title"><a name="LOG_MESSAGES">Log Messages</a></h2>
Messages sent to the standard error are generally stored in the printer's "printer-state-message" attribute and the current <b>ErrorLog</b> file.
Each line begins with a standard prefix:
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>ALERT: </b><i>message</i>
-<br>
-Sets the "printer-state-message" attribute and adds the specified message to the current <b>ErrorLog</b> using the "alert" log level.
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>ATTR: </b><i>attribute=value </i>[ <i>... attribute=value</i>]
-<br>
-Sets the named job or printer attribute(s). The following job attributes can be set: "job-media-progress". The following printer attributes can be set:
+<dl class="man">
+<dt><b>ALERT: </b><i>message</i>
+<dd style="margin-left: 5.0em">Sets the "printer-state-message" attribute and adds the specified message to the current <b>ErrorLog</b> using the "alert" log level.
+<dt><b>ATTR: </b><i>attribute=value </i>[ <i>... attribute=value</i>]
+<dd style="margin-left: 5.0em">Sets the named job or printer attribute(s). The following job attributes can be set: "job-media-progress". The following printer attributes can be set:
"auth-info-required", "marker-colors", "marker-high-levels", "marker-levels",
"marker-low-levels", "marker-message", "marker-names", "marker-types",
"printer-alert", and "printer-alert-description".
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>CRIT: </b><i>message</i>
-<br>
-Sets the "printer-state-message" attribute and adds the specified message to the current <b>ErrorLog</b> using the "critical" log level.
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>DEBUG: </b><i>message</i>
-<br>
-Adds the specified message to the current <b>ErrorLog</b> using the "debug" log level.
+<dt><b>CRIT: </b><i>message</i>
+<dd style="margin-left: 5.0em">Sets the "printer-state-message" attribute and adds the specified message to the current <b>ErrorLog</b> using the "critical" log level.
+<dt><b>DEBUG: </b><i>message</i>
+<dd style="margin-left: 5.0em">Adds the specified message to the current <b>ErrorLog</b> using the "debug" log level.
<b>DEBUG</b> messages are never stored in the "printer-state-message" attribute.
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>DEBUG2: </b><i>message</i>
-<br>
-<br>
+<dt><b>DEBUG2: </b><i>message</i>
+<dd style="margin-left: 5.0em"><br>
Adds the specified message to the current <b>ErrorLog</b> using the "debug2" log level.
<b>DEBUG2</b> messages are never stored in the "printer-state-message" attribute.
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>EMERG: </b><i>message</i>
-<br>
-Sets the "printer-state-message" attribute and adds the specified message to the current <b>ErrorLog</b> using the "emergency" log level.
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>ERROR:</b><i> message</i>
-<br>
-Sets the "printer-state-message" attribute and adds the specified message to the current <b>ErrorLog</b> using the "error" log level.
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>INFO:</b><i> message</i>
-<br>
-Sets the "printer-state-message" attribute. If the current <b>LogLevel</b> is set to "debug2", also adds the specified message to the current <b>ErrorLog</b> using the "info" log level.
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>NOTICE:</b><i> message</i>
-<br>
-Sets the "printer-state-message" attribute and adds the specified message to the current <b>ErrorLog</b> using the "notice" log level.
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>PAGE:</b><i> page-number #-copies</i>
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>PAGE:</b><i> total #-pages</i>
-<br>
-Adds an entry to the current <b>PageLog</b>. The first form adds <i>#-copies</i> to the "job-media-sheets-completed" attribute. The second form sets the "job-media-sheets-completed" attribute to <i>#-pages</i>.
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>PPD:</b><i> Keyword=Value</i> [ <i>... KeywordN=Value</i> ]
-<br>
-Sets the named keywords in the printer's PPD file. This is typically used to update default option keywords such as <b>DefaultPageSize</b> and the various installable options in the PPD file.
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>STATE:</b><i> printer-state-reason </i>[ <i>... printer-state-reason</i> ]
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>STATE: +</b><i> printer-state-reason </i>[ <i>... printer-state-reason</i> ]
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>STATE: -</b><i> printer-state-reason </i>[ <i>... printer-state-reason</i> ]
-<br>
-Sets, adds, or removes "printer-state-reason" keywords for the current queue. Typically this is used to indicate media, ink, and toner conditions on a printer.
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>WARNING:</b><i> message</i>
-<br>
-Sets the "printer-state-message" attribute and adds the specified message to the current <b>ErrorLog</b> using the "warning" log level.
+<dt><b>EMERG: </b><i>message</i>
+<dd style="margin-left: 5.0em">Sets the "printer-state-message" attribute and adds the specified message to the current <b>ErrorLog</b> using the "emergency" log level.
+<dt><b>ERROR:</b><i> message</i>
+<dd style="margin-left: 5.0em">Sets the "printer-state-message" attribute and adds the specified message to the current <b>ErrorLog</b> using the "error" log level.
+<dt><b>INFO:</b><i> message</i>
+<dd style="margin-left: 5.0em">Sets the "printer-state-message" attribute. If the current <b>LogLevel</b> is set to "debug2", also adds the specified message to the current <b>ErrorLog</b> using the "info" log level.
+<dt><b>NOTICE:</b><i> message</i>
+<dd style="margin-left: 5.0em">Sets the "printer-state-message" attribute and adds the specified message to the current <b>ErrorLog</b> using the "notice" log level.
+<dt><b>PAGE:</b><i> page-number #-copies</i>
+<dd style="margin-left: 5.0em"><dt><b>PAGE:</b><i> total #-pages</i>
+<dd style="margin-left: 5.0em">Adds an entry to the current <b>PageLog</b>. The first form adds <i>#-copies</i> to the "job-media-sheets-completed" attribute. The second form sets the "job-media-sheets-completed" attribute to <i>#-pages</i>.
+<dt><b>PPD:</b><i> Keyword=Value</i> [ <i>... KeywordN=Value</i> ]
+<dd style="margin-left: 5.0em">Sets the named keywords in the printer's PPD file. This is typically used to update default option keywords such as <b>DefaultPageSize</b> and the various installable options in the PPD file.
+<dt><b>STATE:</b><i> printer-state-reason </i>[ <i>... printer-state-reason</i> ]
+<dd style="margin-left: 5.0em"><dt><b>STATE: +</b><i> printer-state-reason </i>[ <i>... printer-state-reason</i> ]
+<dd style="margin-left: 5.0em"><dt><b>STATE: -</b><i> printer-state-reason </i>[ <i>... printer-state-reason</i> ]
+<dd style="margin-left: 5.0em">Sets, adds, or removes "printer-state-reason" keywords for the current queue. Typically this is used to indicate media, ink, and toner conditions on a printer.
+<dt><b>WARNING:</b><i> message</i>
+<dd style="margin-left: 5.0em">Sets the "printer-state-message" attribute and adds the specified message to the current <b>ErrorLog</b> using the "warning" log level.
+</dl>
<h2 class="title"><a name="ENVIRONMENT_VARIABLES">Environment Variables</a></h2>
The following environment variables are defined by the CUPS
server when executing the filter:
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>CHARSET</b>
-The default text character set, typically "utf-8".
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>CLASS</b>
-When a job is submitted to a printer class, contains the name of the destination printer class. Otherwise this environment variable will not be set.
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>CONTENT_TYPE</b>
-The MIME media type associated with the submitted job file, for example "application/postscript".
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>CUPS_CACHEDIR</b>
-The directory where semi-persistent cache files can be found and stored.
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>CUPS_DATADIR</b>
-The directory where data files can be found.
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>CUPS_FILETYPE</b>
-The type of file being printed: "job-sheet" for a banner page and "document"
-<br>
+<dl class="man">
+<dt><b>CHARSET</b>
+<dd style="margin-left: 5.0em">The default text character set, typically "utf-8".
+<dt><b>CLASS</b>
+<dd style="margin-left: 5.0em">When a job is submitted to a printer class, contains the name of the destination printer class. Otherwise this environment variable will not be set.
+<dt><b>CONTENT_TYPE</b>
+<dd style="margin-left: 5.0em">The MIME media type associated with the submitted job file, for example "application/postscript".
+<dt><b>CUPS_CACHEDIR</b>
+<dd style="margin-left: 5.0em">The directory where semi-persistent cache files can be found and stored.
+<dt><b>CUPS_DATADIR</b>
+<dd style="margin-left: 5.0em">The directory where data files can be found.
+<dt><b>CUPS_FILETYPE</b>
+<dd style="margin-left: 5.0em">The type of file being printed: "job-sheet" for a banner page and "document"
for a regular print file.
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>CUPS_MAX_MESSAGE</b>
-The maximum size of a message sent to <i>stderr</i>, including any leading prefix and the trailing newline.
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>CUPS_SERVERROOT</b>
-The root directory of the server.
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>FINAL_CONTENT_TYPE</b>
-The MIME media type associated with the output destined for the printer, for example "application/vnd.cups-postscript".
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>LANG</b>
-The default language locale (typically C or en).
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>PATH</b>
-The standard execution path for external programs that may be run by the filter.
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>PPD</b>
-The full pathname of the PostScript Printer Description (PPD) file for this printer.
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>PRINTER</b>
-The name of the printer.
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>RIP_CACHE</b>
-The recommended amount of memory to use for Raster Image Processors (RIPs).
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>SOFTWARE</b>
-The name and version number of the server (typically CUPS/<i>major.minor</i>).
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>TZ</b>
-The timezone of the server.
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>USER</b>
-The user executing the filter, typically "lp" or "root"; consult the <i>cups-files.conf</i> file for the current setting.
-<br>
+<dt><b>CUPS_MAX_MESSAGE</b>
+<dd style="margin-left: 5.0em">The maximum size of a message sent to <i>stderr</i>, including any leading prefix and the trailing newline.
+<dt><b>CUPS_SERVERROOT</b>
+<dd style="margin-left: 5.0em">The root directory of the server.
+<dt><b>FINAL_CONTENT_TYPE</b>
+<dd style="margin-left: 5.0em">The MIME media type associated with the output destined for the printer, for example "application/vnd.cups-postscript".
+<dt><b>LANG</b>
+<dd style="margin-left: 5.0em">The default language locale (typically C or en).
+<dt><b>PATH</b>
+<dd style="margin-left: 5.0em">The standard execution path for external programs that may be run by the filter.
+<dt><b>PPD</b>
+<dd style="margin-left: 5.0em">The full pathname of the PostScript Printer Description (PPD) file for this printer.
+<dt><b>PRINTER</b>
+<dd style="margin-left: 5.0em">The name of the printer.
+<dt><b>RIP_CACHE</b>
+<dd style="margin-left: 5.0em">The recommended amount of memory to use for Raster Image Processors (RIPs).
+<dt><b>SOFTWARE</b>
+<dd style="margin-left: 5.0em">The name and version number of the server (typically CUPS/<i>major.minor</i>).
+<dt><b>TZ</b>
+<dd style="margin-left: 5.0em">The timezone of the server.
+<dt><b>USER</b>
+<dd style="margin-left: 5.0em">The user executing the filter, typically "lp" or "root"; consult the <i>cups-files.conf</i> file for the current setting.
+</dl>
<h2 class="title"><a name="CONFORMING_TO">Conforming To</a></h2>
While the filter interface is compatible with System V interface
scripts, it will only work with the System V interface script as the
<b>ippfind</b>
--version
<h2 class="title"><a name="OPTIONS">Options</a></h2>
-<p style="margin-left: 5.0em; text-indent: -5.0em">--help
-<br>
-Show program help
-<p style="margin-left: 5.0em; text-indent: -5.0em">--version
-<br>
-Show program version
-<p style="margin-left: 5.0em; text-indent: -5.0em">-4
-<br>
-Use IPv4 when listing
-<p style="margin-left: 5.0em; text-indent: -5.0em">-6
-<br>
-Use IPv6 when listing
-<p style="margin-left: 5.0em; text-indent: -5.0em">-T seconds
-<br>
-Specify find timeout in seconds. If 1 or less, <i>ippfind</i> stops as soon as it thinks it has found everything. The default is 1 second.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-V version
-<br>
-Specifies the IPP version when listing. Supported values are 1.1, 2.0, 2.1, and 2.2.
+<dl class="man">
+<dt>--help
+<dd style="margin-left: 5.0em">Show program help
+<dt>--version
+<dd style="margin-left: 5.0em">Show program version
+<dt>-4
+<dd style="margin-left: 5.0em">Use IPv4 when listing
+<dt>-6
+<dd style="margin-left: 5.0em">Use IPv6 when listing
+<dt>-T seconds
+<dd style="margin-left: 5.0em">Specify find timeout in seconds. If 1 or less, <i>ippfind</i> stops as soon as it thinks it has found everything. The default is 1 second.
+<dt>-V version
+<dd style="margin-left: 5.0em">Specifies the IPP version when listing. Supported values are 1.1, 2.0, 2.1, and 2.2.
+</dl>
<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
<i>ippfind</i> finds services registered with a DNS server or available through local devices. Its primary purpose is to find IPP printers and show their URIs, show their current status, or run commands. For example, to show the status of all registered IPP printers on your network, run:
-<pre>
+<pre class="man">
ippfind --ls
</pre>
Similarly, to send a PostScript test page to every PostScript printer, run:
-<pre>
+<pre class="man">
ippfind --txt-pdl application/postscript --exec ipptool \
-f onepage-letter.ps '{}' print-job.test \;
</pre>
<h2 class="title"><a name="REGISTRATION_TYPES">Registration Types</a></h2>
<i>ippfind</i> supports the following registration types:
-<p style="margin-left: 5.0em; text-indent: -5.0em">_http._tcp
-<br>
-HyperText Transport Protocol (HTTP, RFC 2616)
-<p style="margin-left: 5.0em; text-indent: -5.0em">_https._tcp
-<br>
-Secure HyperText Transport Protocol (HTTPS, RFC 2818)
-<p style="margin-left: 5.0em; text-indent: -5.0em">_ipp._tcp
-<br>
-Internet Printing Protocol (IPP, RFC 2911)
-<p style="margin-left: 5.0em; text-indent: -5.0em">_ipps._tcp
-<br>
-Secure Internet Printing Protocol (IPPS, draft)
-<p style="margin-left: 5.0em; text-indent: -5.0em">_printer._tcp
-<br>
-Line Printer Daemon (LPD, RFC 1179)
+<dl class="man">
+<dt>_http._tcp
+<dd style="margin-left: 5.0em">HyperText Transport Protocol (HTTP, RFC 2616)
+<dt>_https._tcp
+<dd style="margin-left: 5.0em">Secure HyperText Transport Protocol (HTTPS, RFC 2818)
+<dt>_ipp._tcp
+<dd style="margin-left: 5.0em">Internet Printing Protocol (IPP, RFC 2911)
+<dt>_ipps._tcp
+<dd style="margin-left: 5.0em">Secure Internet Printing Protocol (IPPS, draft)
+<dt>_printer._tcp
+<dd style="margin-left: 5.0em">Line Printer Daemon (LPD, RFC 1179)
+</dl>
<h2 class="title"><a name="EXPRESSIONS">Expressions</a></h2>
<i>ippfind</i> supports expressions much like the <i>find(1)</i> utility. However, unlike <i>find</i>, <i>ippfind</i> uses POSIX regular expressions instead of shell filename matching patterns. If --exec, -l, --ls, -p, --print, --print-name, -q, --quiet, -s, or -x is not specified, <i>ippfind</i> adds --print to print the service URI of anything it finds. The following expressions are supported:
-<p style="margin-left: 5.0em; text-indent: -5.0em">-d regex
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">--domain regex
-<br>
-True if the domain matches the given regular expression.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--false
-<br>
-Always false.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-h regex
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">--host regex
-<br>
-True is the hostname matches the given regular expression.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-l
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">--ls
-<br>
-Lists attributes returned by Get-Printer-Attributes for IPP printers and traditional <i>find</i> "-ls" output for HTTP URLs. The result is true if the URI is accessible, false otherwise.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--local
-<br>
-True if the service is local to this computer.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-n regex
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">--name regex
-<br>
-True if the service instance name matches the given regular expression.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--path regex
-<br>
-True if the URI resource path matches the given regular expression.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-P number[-number]
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">--port number[-number]
-<br>
-True if the port matches the given number or range.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-p
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">--print
-<br>
-Prints the URI if the result of previous expressions is true. The result is always true.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-q
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">--quiet
-<br>
-Quiet mode - just returns the exit codes below.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-r
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">--remote
-<br>
-True if the service is not local to this computer.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-s
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">--print-name
-<br>
-Prints the service instance name if the result of previous expressions is true. The result is always true.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--true
-<br>
-Always true.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-t key
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">--txt key
-<br>
-True if the TXT record contains the named key.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--txt-<i>key</i> regex
-<br>
-True if the TXT record contains the named key and matches the given regular
+<dl class="man">
+<dt>-d regex
+<dd style="margin-left: 5.0em"><dt>--domain regex
+<dd style="margin-left: 5.0em">True if the domain matches the given regular expression.
+<dt>--false
+<dd style="margin-left: 5.0em">Always false.
+<dt>-h regex
+<dd style="margin-left: 5.0em"><dt>--host regex
+<dd style="margin-left: 5.0em">True is the hostname matches the given regular expression.
+<dt>-l
+<dd style="margin-left: 5.0em"><dt>--ls
+<dd style="margin-left: 5.0em">Lists attributes returned by Get-Printer-Attributes for IPP printers and traditional <i>find</i> "-ls" output for HTTP URLs. The result is true if the URI is accessible, false otherwise.
+<dt>--local
+<dd style="margin-left: 5.0em">True if the service is local to this computer.
+<dt>-n regex
+<dd style="margin-left: 5.0em"><dt>--name regex
+<dd style="margin-left: 5.0em">True if the service instance name matches the given regular expression.
+<dt>--path regex
+<dd style="margin-left: 5.0em">True if the URI resource path matches the given regular expression.
+<dt>-P number[-number]
+<dd style="margin-left: 5.0em"><dt>--port number[-number]
+<dd style="margin-left: 5.0em">True if the port matches the given number or range.
+<dt>-p
+<dd style="margin-left: 5.0em"><dt>--print
+<dd style="margin-left: 5.0em">Prints the URI if the result of previous expressions is true. The result is always true.
+<dt>-q
+<dd style="margin-left: 5.0em"><dt>--quiet
+<dd style="margin-left: 5.0em">Quiet mode - just returns the exit codes below.
+<dt>-r
+<dd style="margin-left: 5.0em"><dt>--remote
+<dd style="margin-left: 5.0em">True if the service is not local to this computer.
+<dt>-s
+<dd style="margin-left: 5.0em"><dt>--print-name
+<dd style="margin-left: 5.0em">Prints the service instance name if the result of previous expressions is true. The result is always true.
+<dt>--true
+<dd style="margin-left: 5.0em">Always true.
+<dt>-t key
+<dd style="margin-left: 5.0em"><dt>--txt key
+<dd style="margin-left: 5.0em">True if the TXT record contains the named key.
+<dt>--txt-<i>key</i> regex
+<dd style="margin-left: 5.0em">True if the TXT record contains the named key and matches the given regular
expression.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-u regex
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">--uri regex
-<br>
-True if the URI matches the given regular expression.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-x utility [argument ...] ;
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">--exec utility [argument ...] ;
-<br>
-Executes the specified program if the current result is true. "{foo}" arguments are replaced with the corresponding value - see SUBSTITUTIONS below.
+<dt>-u regex
+<dd style="margin-left: 5.0em"><dt>--uri regex
+<dd style="margin-left: 5.0em">True if the URI matches the given regular expression.
+<dt>-x utility [argument ...] ;
+<dd style="margin-left: 5.0em"><dt>--exec utility [argument ...] ;
+<dd style="margin-left: 5.0em">Executes the specified program if the current result is true. "{foo}" arguments are replaced with the corresponding value - see SUBSTITUTIONS below.
+</dl>
<p>Expressions may also contain modifiers:
-<p style="margin-left: 5.0em; text-indent: -5.0em">( expression )
-<br>
-Group the result of expressions.
-<p style="margin-left: 5.0em; text-indent: -5.0em">! expression
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">--not expression
-<br>
-Unary NOT of the expression.
-<p style="margin-left: 5.0em; text-indent: -5.0em">expression expression
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">expression --and expression
-<br>
-Logical AND of expressions.
-<p style="margin-left: 5.0em; text-indent: -5.0em">expression --or expression
-<br>
-Logical OR of expressions.
+<dl class="man">
+<dt>( expression )
+<dd style="margin-left: 5.0em">Group the result of expressions.
+<dt>! expression
+<dd style="margin-left: 5.0em"><dt>--not expression
+<dd style="margin-left: 5.0em">Unary NOT of the expression.
+<dt>expression expression
+<dd style="margin-left: 5.0em"><dt>expression --and expression
+<dd style="margin-left: 5.0em">Logical AND of expressions.
+<dt>expression --or expression
+<dd style="margin-left: 5.0em">Logical OR of expressions.
+</dl>
<h2 class="title"><a name="SUBSTITUTIONS">Substitutions</a></h2>
The substitutions for "{foo}" in -e and --exec are:
-<p style="margin-left: 5.0em; text-indent: -5.0em">{}
-<br>
-URI
-<p style="margin-left: 5.0em; text-indent: -5.0em">{service_domain}
-<br>
-Domain name, e.g., "example.com.", "local.", etc.
-<p style="margin-left: 5.0em; text-indent: -5.0em">{service_hostname}
-<br>
-Fully-qualified domain name, e.g., "printer.example.com.", "printer.local.", etc.
-<p style="margin-left: 5.0em; text-indent: -5.0em">{service_name}
-<br>
-Service instance name, e.g., "My Fine Printer".
-<p style="margin-left: 5.0em; text-indent: -5.0em">{service_port}
-<br>
-Port number for server, typically 631 for IPP and 80 for HTTP.
-<p style="margin-left: 5.0em; text-indent: -5.0em">{service_regtype}
-<br>
-DNS-SD registration type, e.g., "_ipp._tcp", "_http._tcp", etc.
-<p style="margin-left: 5.0em; text-indent: -5.0em">{service_scheme}
-<br>
-URI scheme for DNS-SD registration type, e.g., "ipp", "http", etc.
-<p style="margin-left: 5.0em; text-indent: -5.0em">{service_uri}
-<br>
-URI for service, e.g., "ipp://printer.local./ipp/print", "<a href="http://printer.local./"">http://printer.local./"</a>, etc.
-<p style="margin-left: 5.0em; text-indent: -5.0em">{txt_<i>key</i>}
-<br>
-Value of TXT record <i>key</i> (lowercase).
+<dl class="man">
+<dt>{}
+<dd style="margin-left: 5.0em">URI
+<dt>{service_domain}
+<dd style="margin-left: 5.0em">Domain name, e.g., "example.com.", "local.", etc.
+<dt>{service_hostname}
+<dd style="margin-left: 5.0em">Fully-qualified domain name, e.g., "printer.example.com.", "printer.local.", etc.
+<dt>{service_name}
+<dd style="margin-left: 5.0em">Service instance name, e.g., "My Fine Printer".
+<dt>{service_port}
+<dd style="margin-left: 5.0em">Port number for server, typically 631 for IPP and 80 for HTTP.
+<dt>{service_regtype}
+<dd style="margin-left: 5.0em">DNS-SD registration type, e.g., "_ipp._tcp", "_http._tcp", etc.
+<dt>{service_scheme}
+<dd style="margin-left: 5.0em">URI scheme for DNS-SD registration type, e.g., "ipp", "http", etc.
+<dt>{service_uri}
+<dd style="margin-left: 5.0em">URI for service, e.g., "ipp://printer.local./ipp/print", "<a href="http://printer.local./"">http://printer.local./"</a>, etc.
+<dt>{txt_<i>key</i>}
+<dd style="margin-left: 5.0em">Value of TXT record <i>key</i> (lowercase).
+</dl>
<h2 class="title"><a name="ENVIRONMENT_VARIABLES">Environment Variables</a></h2>
When executing a program, <i>ippfind</i> sets the following environment variables for the matching service registration:
-<p style="margin-left: 5.0em; text-indent: -5.0em">IPPFIND_SERVICE_DOMAIN
-<br>
-Domain name, e.g., "example.com.", "local.", etc.
-<p style="margin-left: 5.0em; text-indent: -5.0em">IPPFIND_SERVICE_HOSTNAME
-<br>
-Fully-qualified domain name, e.g., "printer.example.com.", "printer.local.", etc.
-<p style="margin-left: 5.0em; text-indent: -5.0em">IPPFIND_SERVICE_NAME
-<br>
-Service instance name, e.g., "My Fine Printer".
-<p style="margin-left: 5.0em; text-indent: -5.0em">IPPFIND_SERVICE_PORT
-<br>
-Port number for server, typically 631 for IPP and 80 for HTTP.
-<p style="margin-left: 5.0em; text-indent: -5.0em">IPPFIND_SERVICE_REGTYPE
-<br>
-DNS-SD registration type, e.g., "_ipp._tcp", "_http._tcp", etc.
-<p style="margin-left: 5.0em; text-indent: -5.0em">IPPFIND_SERVICE_SCHEME
-<br>
-URI scheme for DNS-SD registration type, e.g., "ipp", "http", etc.
-<p style="margin-left: 5.0em; text-indent: -5.0em">IPPFIND_SERVICE_URI
-<br>
-URI for service, e.g., "ipp://printer.local./ipp/print", "<a href="http://printer.local./"">http://printer.local./"</a>, etc.
-<p style="margin-left: 5.0em; text-indent: -5.0em">IPPFIND_TXT_<i>KEY</i>
-<br>
-Values of TXT record <i>KEY</i> (uppercase).
+<dl class="man">
+<dt>IPPFIND_SERVICE_DOMAIN
+<dd style="margin-left: 5.0em">Domain name, e.g., "example.com.", "local.", etc.
+<dt>IPPFIND_SERVICE_HOSTNAME
+<dd style="margin-left: 5.0em">Fully-qualified domain name, e.g., "printer.example.com.", "printer.local.", etc.
+<dt>IPPFIND_SERVICE_NAME
+<dd style="margin-left: 5.0em">Service instance name, e.g., "My Fine Printer".
+<dt>IPPFIND_SERVICE_PORT
+<dd style="margin-left: 5.0em">Port number for server, typically 631 for IPP and 80 for HTTP.
+<dt>IPPFIND_SERVICE_REGTYPE
+<dd style="margin-left: 5.0em">DNS-SD registration type, e.g., "_ipp._tcp", "_http._tcp", etc.
+<dt>IPPFIND_SERVICE_SCHEME
+<dd style="margin-left: 5.0em">URI scheme for DNS-SD registration type, e.g., "ipp", "http", etc.
+<dt>IPPFIND_SERVICE_URI
+<dd style="margin-left: 5.0em">URI for service, e.g., "ipp://printer.local./ipp/print", "<a href="http://printer.local./"">http://printer.local./"</a>, etc.
+<dt>IPPFIND_TXT_<i>KEY</i>
+<dd style="margin-left: 5.0em">Values of TXT record <i>KEY</i> (uppercase).
+</dl>
<h2 class="title"><a name="EXIT_CODES">Exit Codes</a></h2>
<i>ippfind</i> returns 0 if the result for all processed expressions is true, 1 if the result of any processed expression is false, 2 if browsing or any query or resolution failed, 3 if an undefined option or invalid expression was specified, and 4 if it ran out of memory.
<i>URI</i>
<i>filename</i>
[
-<i>...</i> <i>filenameN</i>
+<i>...</i><i>filenameN</i>
]
<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
<i>ipptool</i> sends IPP requests to the specified URI and tests and/or displays the results. Each named file defines one or more requests, including the expected response status, attributes, and values. Output is either a plain text, formatted text, CSV, or XML report on the standard output, with a non-zero exit status indicating that one or more tests have failed. The file format is described in <i>ipptoolfile(5)</i>.
<h2 class="title"><a name="OPTIONS">Options</a></h2>
The following options are recognized by <i>ipptool</i>:
-<p style="margin-left: 5.0em; text-indent: -5.0em">--help
-<br>
-Shows program help.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--stop-after-include-error
-<br>
-Tells <i>ipptool</i> to stop if an error occurs in an included file. Normally <i>ipptool</i> will continue with subsequent tests after the INCLUDE directive.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--version
-<br>
-Shows the version of <i>ipptool</i> being used.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-4
-<br>
-Specifies that <i>ipptool</i> must connect to the printer or server using IPv4.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-6
-<br>
-Specifies that <i>ipptool</i> must connect to the printer or server using IPv6.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-C
-<br>
-Specifies that requests should be sent using the HTTP/1.1 "Transfer-Encoding: chunked" header, which is required for conformance by all versions of IPP. The default is to use "Transfer-Encoding: chunked" for requests with attached files and "Content-Length:" for requests without attached files.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-E
-<br>
-Forces TLS encryption when connecting to the server using the HTTP "Upgrade" header.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-I
-<br>
-Specifies that <i>ipptool</i> will continue past errors.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-L
-<br>
-Specifies that requests should be sent using the HTTP/1.0 "Content-Length:" header, which is required for conformance by all versions of IPP. The default is to use "Transfer-Encoding: chunked" for requests with attached files and "Content-Length:" for requests without attached files.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-S
-<br>
-Forces (dedicated) SSL encryption when connecting to the server.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-T seconds
-<br>
-Specifies a timeout for IPP requests in seconds.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-V version
-<br>
-Specifies the default IPP version to use: 1.0, 1.1, 2.0, 2.1, or 2.2. If not specified, version 1.1 is used.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-X
-<br>
-Specifies that XML (Apple plist) output is desired instead of the plain text report. This option is incompatible with the <i>-i</i> (interval) and <i>-n</i> (repeat-count) options.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-c
-<br>
-Specifies that CSV (comma-separated values) output is desired instead of the plain text output.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-d name=value
-<br>
-Defines the named variable.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-f filename
-<br>
-Defines the default request filename for tests.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-i seconds
-<br>
-Specifies that the (last) file should be repeated at the specified interval. This option is incompatible with the <i>-X</i> (XML plist output) option.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-l
-<br>
-Specifies that plain text output is desired.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-n repeat-count
-<br>
-Specifies that the (last) file should be repeated the specified number of times. This option is incompatible with the <i>-X</i> (XML plist output) option.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-t
-<br>
-Specifies that CUPS test report output is desired instead of the plain text output.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-v
-<br>
-Specifies that all request and response attributes should be output in CUPS test mode (<i>-t</i>). This is the default for XML output.
+<dl class="man">
+<dt>--help
+<dd style="margin-left: 5.0em">Shows program help.
+<dt>--stop-after-include-error
+<dd style="margin-left: 5.0em">Tells <i>ipptool</i> to stop if an error occurs in an included file. Normally <i>ipptool</i> will continue with subsequent tests after the INCLUDE directive.
+<dt>--version
+<dd style="margin-left: 5.0em">Shows the version of <i>ipptool</i> being used.
+<dt>-4
+<dd style="margin-left: 5.0em">Specifies that <i>ipptool</i> must connect to the printer or server using IPv4.
+<dt>-6
+<dd style="margin-left: 5.0em">Specifies that <i>ipptool</i> must connect to the printer or server using IPv6.
+<dt>-C
+<dd style="margin-left: 5.0em">Specifies that requests should be sent using the HTTP/1.1 "Transfer-Encoding: chunked" header, which is required for conformance by all versions of IPP. The default is to use "Transfer-Encoding: chunked" for requests with attached files and "Content-Length:" for requests without attached files.
+<dt>-E
+<dd style="margin-left: 5.0em">Forces TLS encryption when connecting to the server using the HTTP "Upgrade" header.
+<dt>-I
+<dd style="margin-left: 5.0em">Specifies that <i>ipptool</i> will continue past errors.
+<dt>-L
+<dd style="margin-left: 5.0em">Specifies that requests should be sent using the HTTP/1.0 "Content-Length:" header, which is required for conformance by all versions of IPP. The default is to use "Transfer-Encoding: chunked" for requests with attached files and "Content-Length:" for requests without attached files.
+<dt>-S
+<dd style="margin-left: 5.0em">Forces (dedicated) SSL encryption when connecting to the server.
+<dt>-T seconds
+<dd style="margin-left: 5.0em">Specifies a timeout for IPP requests in seconds.
+<dt>-V version
+<dd style="margin-left: 5.0em">Specifies the default IPP version to use: 1.0, 1.1, 2.0, 2.1, or 2.2. If not specified, version 1.1 is used.
+<dt>-X
+<dd style="margin-left: 5.0em">Specifies that XML (Apple plist) output is desired instead of the plain text report. This option is incompatible with the <i>-i</i> (interval) and <i>-n</i> (repeat-count) options.
+<dt>-c
+<dd style="margin-left: 5.0em">Specifies that CSV (comma-separated values) output is desired instead of the plain text output.
+<dt>-d name=value
+<dd style="margin-left: 5.0em">Defines the named variable.
+<dt>-f filename
+<dd style="margin-left: 5.0em">Defines the default request filename for tests.
+<dt>-i seconds
+<dd style="margin-left: 5.0em">Specifies that the (last) file should be repeated at the specified interval. This option is incompatible with the <i>-X</i> (XML plist output) option.
+<dt>-l
+<dd style="margin-left: 5.0em">Specifies that plain text output is desired.
+<dt>-n repeat-count
+<dd style="margin-left: 5.0em">Specifies that the (last) file should be repeated the specified number of times. This option is incompatible with the <i>-X</i> (XML plist output) option.
+<dt>-t
+<dd style="margin-left: 5.0em">Specifies that CUPS test report output is desired instead of the plain text output.
+<dt>-v
+<dd style="margin-left: 5.0em">Specifies that all request and response attributes should be output in CUPS test mode (<i>-t</i>). This is the default for XML output.
+</dl>
<h2 class="title"><a name="EXIT_CODE">Exit Code</a></h2>
The <i>ipptool</i> program returns 0 if all tests were sucessful and 1 otherwise.
<h2 class="title"><a name="COMPATIBILITY">Compatibility</a></h2>
The <i>ipptool</i> program is unique to CUPS.
<h2 class="title"><a name="EXAMPLES">Examples</a></h2>
Get a list of completed jobs for "myprinter":
-<pre>
+<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>
+<pre class="man">
ipptool -d recipient=mailto:user@example.com \
ipp://localhost/printers/myprinter create-printer-subscription.test
</pre>
<h2 class="title"><a name="STANDARD_FILES">Standard Files</a></h2>
The following standard files are available:
-<pre>
+<pre class="man">
color.jpg
create-printer-subscription.test
<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
The <i>ipptool(1)</i> 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>
+<pre class="man">
# This is a comment
{
<h2 class="title"><a name="TOP_LEVEL_DIRECTIVES">Top-level Directives</a></h2>
The following directives can be used outside of a test:
-<p style="margin-left: 5.0em; text-indent: -5.0em">{ test }
-<br>
-Defines a test.
-<p style="margin-left: 5.0em; text-indent: -5.0em">DEFINE variable-name value
-<br>
-Defines the named variable to the given value. This is equivalent to specifying
+<dl class="man">
+<dt>{ test }
+<dd style="margin-left: 5.0em">Defines a test.
+<dt>DEFINE variable-name value
+<dd style="margin-left: 5.0em">Defines the named variable to the given value. This is equivalent to specifying
"-d variable-name=value" on the <i>ipptool</i> command-line.
-<p style="margin-left: 5.0em; text-indent: -5.0em">DEFINE-DEFAULT variable-name value
-<br>
-Defines the named variable to the given value if it does not already have a
+<dt>DEFINE-DEFAULT variable-name value
+<dd style="margin-left: 5.0em">Defines the named variable to the given value if it does not already have a
value.
-<p style="margin-left: 5.0em; text-indent: -5.0em">FILE-ID "identifier"
-<br>
-Specifies an identifier string for the current file.
-<p style="margin-left: 5.0em; text-indent: -5.0em">IGNORE-ERRORS yes
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">IGNORE-ERRORS no
-<br>
-Specifies whether, by default, <i>ipptool</i> will ignore errors and continue with
+<dt>FILE-ID "identifier"
+<dd style="margin-left: 5.0em">Specifies an identifier string for the current file.
+<dt>IGNORE-ERRORS yes
+<dd style="margin-left: 5.0em"><dt>IGNORE-ERRORS no
+<dd style="margin-left: 5.0em">Specifies whether, by default, <i>ipptool</i> will ignore errors and continue with
subsequent tests.
-<p style="margin-left: 5.0em; text-indent: -5.0em">INCLUDE "filename"
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">INCLUDE <filename>
-<br>
-Includes another test file. The first form includes a file relative to the
+<dt>INCLUDE "filename"
+<dd style="margin-left: 5.0em"><dt>INCLUDE <filename>
+<dd style="margin-left: 5.0em">Includes another test file. The first form includes a file relative to the
current test file, while the second form includes a file from the <i>ipptool</i>
include directory.
-<p style="margin-left: 5.0em; text-indent: -5.0em">INCLUDE-IF-DEFINED name "filename"
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">INCLUDE-IF-DEFINED name <filename>
-<br>
-Includes another test file if the named variable is defined. The first form
+<dt>INCLUDE-IF-DEFINED name "filename"
+<dd style="margin-left: 5.0em"><dt>INCLUDE-IF-DEFINED name <filename>
+<dd style="margin-left: 5.0em">Includes another test file if the named variable is defined. The first form
includes a file relative to the current test file, while the second form
includes a file from the <i>ipptool</i> include directory.
-<p style="margin-left: 5.0em; text-indent: -5.0em">INCLUDE-IF-NOT-DEFINED name "filename"
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">INCLUDE-IF-NOT-DEFINED name <filename>
-<br>
-Includes another test file if the named variable is not defined. The first form
+<dt>INCLUDE-IF-NOT-DEFINED name "filename"
+<dd style="margin-left: 5.0em"><dt>INCLUDE-IF-NOT-DEFINED name <filename>
+<dd style="margin-left: 5.0em">Includes another test file if the named variable is not defined. The first form
includes a file relative to the current test file, while the second form
includes a file from the <i>ipptool</i> include directory.
-<p style="margin-left: 5.0em; text-indent: -5.0em">SKIP-IF-DEFINED variable-name
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">SKIP-IF-NOT-DEFINED variable-name
-<br>
-Specifies that the remainder of the test file should be skipped when the
+<dt>SKIP-IF-DEFINED variable-name
+<dd style="margin-left: 5.0em"><dt>SKIP-IF-NOT-DEFINED variable-name
+<dd style="margin-left: 5.0em">Specifies that the remainder of the test file should be skipped when the
variable is or is not defined.
-<p style="margin-left: 5.0em; text-indent: -5.0em">STOP-AFTER-INCLUDE-ERROR no
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">STOP-AFTER-INCLUDE-ERROR yes
-<br>
-Specifies whether tests will be stopped after an error in an included file.
-<p style="margin-left: 5.0em; text-indent: -5.0em">TRANSFER auto
-<br>
-Specifies that tests will, by default, use "Transfer-Encoding: chunked" for
+<dt>STOP-AFTER-INCLUDE-ERROR no
+<dd style="margin-left: 5.0em"><dt>STOP-AFTER-INCLUDE-ERROR yes
+<dd style="margin-left: 5.0em">Specifies whether tests will be stopped after an error in an included file.
+<dt>TRANSFER auto
+<dd style="margin-left: 5.0em">Specifies that tests will, by default, use "Transfer-Encoding: chunked" for
requests with attached files and "Content-Length:" for requests without attached
files.
-<p style="margin-left: 5.0em; text-indent: -5.0em">TRANSFER chunked
-<br>
-Specifies that tests will, by default, use the HTTP/1.1 "Transfer-Encoding:
+<dt>TRANSFER chunked
+<dd style="margin-left: 5.0em">Specifies that tests will, by default, use the HTTP/1.1 "Transfer-Encoding:
chunked" header. This is the default and is equivalent to specifying "-c" on the
<i>ipptool</i> command-line. Support for chunked requests is required for
conformance with all versions of IPP.
-<p style="margin-left: 5.0em; text-indent: -5.0em">TRANSFER length
-<br>
-Specifies that tests will, by default, use the HTTP/1.0 "Content-Length:"
+<dt>TRANSFER length
+<dd style="margin-left: 5.0em">Specifies that tests will, by default, use the HTTP/1.0 "Content-Length:"
header. This is equivalent to specifying "-l" on the <i>ipptool</i> command-line.
Support for content length requests is required for conformance with all
versions of IPP.
-<p style="margin-left: 5.0em; text-indent: -5.0em">VERSION 1.0
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">VERSION 1.1
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">VERSION 2.0
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">VERSION 2.1
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">VERSION 2.2
-<br>
-Specifies the default IPP version number to use for the tests that follow.
+<dt>VERSION 1.0
+<dd style="margin-left: 5.0em"><dt>VERSION 1.1
+<dd style="margin-left: 5.0em"><dt>VERSION 2.0
+<dd style="margin-left: 5.0em"><dt>VERSION 2.1
+<dd style="margin-left: 5.0em"><dt>VERSION 2.2
+<dd style="margin-left: 5.0em">Specifies the default IPP version number to use for the tests that follow.
+</dl>
<h2 class="title"><a name="TEST_DIRECTIVES">Test Directives</a></h2>
The following directives are understood in a test:
-<p style="margin-left: 5.0em; text-indent: -5.0em">ATTR tag attribute-name value(s)
-<br>
-Adds an attribute to the test request. Values are separated by the comma (",")
+<dl class="man">
+<dt>ATTR tag attribute-name value(s)
+<dd style="margin-left: 5.0em">Adds an attribute to the test request. Values are separated by the comma (",")
character - escape commas using the "" character. Common attributes and values are listed in the IANA IPP registry - see references below.
-<p style="margin-left: 5.0em; text-indent: -5.0em">ATTR collection attribute-name { MEMBER tag member-name value(s) ... } [ ... { ... } ]
-<br>
-Adds a collection attribute to the test request. Member attributes follow the
+<dt>ATTR collection attribute-name { MEMBER tag member-name value(s) ... } [ ... { ... } ]
+<dd style="margin-left: 5.0em">Adds a collection attribute to the test request. Member attributes follow the
same syntax as regular attributes and can themselves be nested collections.
Multiple collection values can be supplied as needed.
-<p style="margin-left: 5.0em; text-indent: -5.0em">COMPRESSION deflate
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">COMPRESSION gzip
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">COMPRESSION none
-<br>
-<br>
+<dt>COMPRESSION deflate
+<dd style="margin-left: 5.0em"><dt>COMPRESSION gzip
+<dd style="margin-left: 5.0em"><dt>COMPRESSION none
+<dd style="margin-left: 5.0em"><br>
Uses the specified compression on the document data following the attributes in
a Print-Job or Send-Document request.
-<p style="margin-left: 5.0em; text-indent: -5.0em">DELAY seconds
-<br>
-Specifies a delay before this test will be run.
-<p style="margin-left: 5.0em; text-indent: -5.0em">DISPLAY attribute-name
-<br>
-Specifies that value of the named attribute should be output as part of the
+<dt>DELAY seconds
+<dd style="margin-left: 5.0em">Specifies a delay before this test will be run.
+<dt>DISPLAY attribute-name
+<dd style="margin-left: 5.0em">Specifies that value of the named attribute should be output as part of the
test report.
-<p style="margin-left: 5.0em; text-indent: -5.0em">EXPECT attribute-name [ predicate(s) ]
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">EXPECT ?attribute-name predicate(s)
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">EXPECT !attribute-name
-<br>
-Specifies that the response must/may/must not include the named attribute.
+<dt>EXPECT attribute-name [ predicate(s) ]
+<dd style="margin-left: 5.0em"><dt>EXPECT ?attribute-name predicate(s)
+<dd style="margin-left: 5.0em"><dt>EXPECT !attribute-name
+<dd style="margin-left: 5.0em">Specifies that the response must/may/must not include the named attribute.
Additional requirements can be added as predicates - see the "EXPECT PREDICATES"
section for more information on predicates.
-<p style="margin-left: 5.0em; text-indent: -5.0em">FILE filename
-<br>
-Specifies a file to include at the end of the request. This is typically used
+<dt>FILE filename
+<dd style="margin-left: 5.0em">Specifies a file to include at the end of the request. This is typically used
when sending a test print file.
-<p style="margin-left: 5.0em; text-indent: -5.0em">GROUP tag
-<br>
-Specifies the group tag for subsequent attributes in the request.
-<p style="margin-left: 5.0em; text-indent: -5.0em">IGNORE-ERRORS yes
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">IGNORE-ERRORS no
-<br>
-Specifies whether <i>ipptool</i> will ignore errors and continue with subsequent
+<dt>GROUP tag
+<dd style="margin-left: 5.0em">Specifies the group tag for subsequent attributes in the request.
+<dt>IGNORE-ERRORS yes
+<dd style="margin-left: 5.0em"><dt>IGNORE-ERRORS no
+<dd style="margin-left: 5.0em">Specifies whether <i>ipptool</i> will ignore errors and continue with subsequent
tests.
-<p style="margin-left: 5.0em; text-indent: -5.0em">NAME "literal string"
-<br>
-Specifies the human-readable name of the test.
-<p style="margin-left: 5.0em; text-indent: -5.0em">OPERATION operation-code
-<br>
-Specifies the operation to be performed.
-<p style="margin-left: 5.0em; text-indent: -5.0em">REQUEST-ID number
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">REQUEST-ID random
-<br>
-Specifies the request-id value to use in the request, either an integer or the
+<dt>NAME "literal string"
+<dd style="margin-left: 5.0em">Specifies the human-readable name of the test.
+<dt>OPERATION operation-code
+<dd style="margin-left: 5.0em">Specifies the operation to be performed.
+<dt>REQUEST-ID number
+<dd style="margin-left: 5.0em"><dt>REQUEST-ID random
+<dd style="margin-left: 5.0em">Specifies the request-id value to use in the request, either an integer or the
word "random" to use a randomly generated value (the default).
-<p style="margin-left: 5.0em; text-indent: -5.0em">RESOURCE path
-<br>
-Specifies an alternate resource path that is used for the HTTP POST request.
+<dt>RESOURCE path
+<dd style="margin-left: 5.0em">Specifies an alternate resource path that is used for the HTTP POST request.
The default is the resource from the URI provided to the <i>ipptool</i> program.
-<p style="margin-left: 5.0em; text-indent: -5.0em">SKIP-IF-DEFINED variable-name
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">SKIP-IF-NOT-DEFINED variable-name
-<br>
-Specifies that the current test should be skipped when the variable is or is not
+<dt>SKIP-IF-DEFINED variable-name
+<dd style="margin-left: 5.0em"><dt>SKIP-IF-NOT-DEFINED variable-name
+<dd style="margin-left: 5.0em">Specifies that the current test should be skipped when the variable is or is not
defined.
-<p style="margin-left: 5.0em; text-indent: -5.0em">SKIP-PREVIOUS-ERROR yes
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">SKIP-PREVIOUS-ERROR no
-<br>
-Specifies whether <i>ipptool</i> will skip the current test if the previous test
+<dt>SKIP-PREVIOUS-ERROR yes
+<dd style="margin-left: 5.0em"><dt>SKIP-PREVIOUS-ERROR no
+<dd style="margin-left: 5.0em">Specifies whether <i>ipptool</i> will skip the current test if the previous test
resulted in an error/failure.
-<p style="margin-left: 5.0em; text-indent: -5.0em">STATUS status-code [ predicate ]
-<br>
-Specifies an expected response status-code value. Additional requirements can be
+<dt>STATUS status-code [ predicate ]
+<dd style="margin-left: 5.0em">Specifies an expected response status-code value. Additional requirements can be
added as predicates - see the "STATUS PREDICATES" section for more information
on predicates.
-<p style="margin-left: 5.0em; text-indent: -5.0em">TEST-ID "identifier"
-<br>
-Specifies an identifier string for the current test.
-<p style="margin-left: 5.0em; text-indent: -5.0em">TRANSFER auto
-<br>
-Specifies that this test will use "Transfer-Encoding: chunked" if it has an
+<dt>TEST-ID "identifier"
+<dd style="margin-left: 5.0em">Specifies an identifier string for the current test.
+<dt>TRANSFER auto
+<dd style="margin-left: 5.0em">Specifies that this test will use "Transfer-Encoding: chunked" if it has an
attached file or "Content-Length:" otherwise.
-<p style="margin-left: 5.0em; text-indent: -5.0em">TRANSFER chunked
-<br>
-Specifies that this test will use the HTTP/1.1 "Transfer-Encoding: chunked"
+<dt>TRANSFER chunked
+<dd style="margin-left: 5.0em">Specifies that this test will use the HTTP/1.1 "Transfer-Encoding: chunked"
header.
-<p style="margin-left: 5.0em; text-indent: -5.0em">TRANSFER length
-<br>
-Specifies that this test will use the HTTP/1.0 "Content-Length:" header.
-<p style="margin-left: 5.0em; text-indent: -5.0em">VERSION 1.0
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">VERSION 1.1
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">VERSION 2.0
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">VERSION 2.1
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">VERSION 2.2
-<br>
-Specifies the IPP version number to use for this test.
+<dt>TRANSFER length
+<dd style="margin-left: 5.0em">Specifies that this test will use the HTTP/1.0 "Content-Length:" header.
+<dt>VERSION 1.0
+<dd style="margin-left: 5.0em"><dt>VERSION 1.1
+<dd style="margin-left: 5.0em"><dt>VERSION 2.0
+<dd style="margin-left: 5.0em"><dt>VERSION 2.1
+<dd style="margin-left: 5.0em"><dt>VERSION 2.2
+<dd style="margin-left: 5.0em">Specifies the IPP version number to use for this test.
+</dl>
<h2 class="title"><a name="EXPECT_PREDICATES">Expect Predicates</a></h2>
The following predicates are understood following the EXPECT test directive:
-<p style="margin-left: 5.0em; text-indent: -5.0em">COUNT number
-<br>
-Requires the EXPECT attribute to have the specified number of values.
-<p style="margin-left: 5.0em; text-indent: -5.0em">DEFINE-MATCH variable-name
-<br>
-Defines the variable to "1" when the EXPECT condition matches. A side-effect of
+<dl class="man">
+<dt>COUNT number
+<dd style="margin-left: 5.0em">Requires the EXPECT attribute to have the specified number of values.
+<dt>DEFINE-MATCH variable-name
+<dd style="margin-left: 5.0em">Defines the variable to "1" when the EXPECT condition matches. A side-effect of
this predicate is that this EXPECT will never fail a test.
-<p style="margin-left: 5.0em; text-indent: -5.0em">DEFINE-NO-MATCH variable-name
-<br>
-Defines the variable to "1" when the EXPECT condition does not match. A side-
+<dt>DEFINE-NO-MATCH variable-name
+<dd style="margin-left: 5.0em">Defines the variable to "1" when the EXPECT condition does not match. A side-
effect of this predicate is that this EXPECT will never fail a test.
-<p style="margin-left: 5.0em; text-indent: -5.0em">DEFINE-VALUE variable-name
-<br>
-Defines the variable to the value of the attribute when the EXPECT condition
+<dt>DEFINE-VALUE variable-name
+<dd style="margin-left: 5.0em">Defines the variable to the value of the attribute when the EXPECT condition
matches. A side-effect of this predicate is that this EXPECT will never fail a test.
-<p style="margin-left: 5.0em; text-indent: -5.0em">IF-DEFINED variable-name
-<br>
-Makes the EXPECT conditions apply only if the specified variable is defined.
-<p style="margin-left: 5.0em; text-indent: -5.0em">IF-NOT-DEFINED variable-name
-<br>
-Makes the EXPECT conditions apply only if the specified variable is not
+<dt>IF-DEFINED variable-name
+<dd style="margin-left: 5.0em">Makes the EXPECT conditions apply only if the specified variable is defined.
+<dt>IF-NOT-DEFINED variable-name
+<dd style="margin-left: 5.0em">Makes the EXPECT conditions apply only if the specified variable is not
defined.
-<p style="margin-left: 5.0em; text-indent: -5.0em">IN-GROUP tag
-<br>
-Requires the EXPECT attribute to be in the specified group tag.
-<p style="margin-left: 5.0em; text-indent: -5.0em">OF-TYPE tag[,tag,...]
-<br>
-Requires the EXPECT attribute to use the specified value tag(s).
-<p style="margin-left: 5.0em; text-indent: -5.0em">REPEAT-LIMIT number
-<br>
-<br>
+<dt>IN-GROUP tag
+<dd style="margin-left: 5.0em">Requires the EXPECT attribute to be in the specified group tag.
+<dt>OF-TYPE tag[,tag,...]
+<dd style="margin-left: 5.0em">Requires the EXPECT attribute to use the specified value tag(s).
+<dt>REPEAT-LIMIT number
+<dd style="margin-left: 5.0em"><br>
Specifies the maximum number of times to repeat. The default value is 1000.
-<p style="margin-left: 5.0em; text-indent: -5.0em">REPEAT-MATCH
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">REPEAT-NO-MATCH
-<br>
-Specifies that the current test should be repeated when the EXPECT condition
+<dt>REPEAT-MATCH
+<dd style="margin-left: 5.0em"><dt>REPEAT-NO-MATCH
+<dd style="margin-left: 5.0em">Specifies that the current test should be repeated when the EXPECT condition
matches or does not match.
-<p style="margin-left: 5.0em; text-indent: -5.0em">SAME-COUNT-AS attribute-name
-<br>
-Requires the EXPECT attribute to have the same number of values as the specified
+<dt>SAME-COUNT-AS attribute-name
+<dd style="margin-left: 5.0em">Requires the EXPECT attribute to have the same number of values as the specified
parallel attribute.
-<p style="margin-left: 5.0em; text-indent: -5.0em">WITH-ALL-HOSTNAMES "literal string"
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">WITH-ALL-HOSTNAMES "/regular expression/"
-<br>
-Requires that all URI values contain a matching hostname.
-<p style="margin-left: 5.0em; text-indent: -5.0em">WITH-ALL-RESOURCES "literal string"
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">WITH-ALL-RESOURCES "/regular expression/"
-<br>
-Requires that all URI values contain a matching resource (including leading /).
-<p style="margin-left: 5.0em; text-indent: -5.0em">WITH-ALL-SCHEMES "literal string"
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">WITH-ALL-SCHEMES "/regular expression/"
-<br>
-Requires that all URI values contain a matching scheme.
-<p style="margin-left: 5.0em; text-indent: -5.0em">WITH-ALL-VALUES "literal string"
-<br>
-Requires that all values of the EXPECT attribute match the literal string. Comparisons are case-sensitive.
-<p style="margin-left: 5.0em; text-indent: -5.0em">WITH-ALL-VALUES <number
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">WITH-ALL-VALUES =number
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">WITH-ALL-VALUES >number
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">WITH-ALL-VALUES number[,number,...]
-<br>
-Requires that all values of the EXPECT attribute match the number(s) or numeric comparison. When comparing rangeOfInteger values, the "<" and ">" operators only check the upper bound of the range.
-<p style="margin-left: 5.0em; text-indent: -5.0em">WITH-ALL-VALUES "false"
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">WITH-ALL-VALUES "true"
-<br>
-Requires that all values of the EXPECT attribute match the boolean value given.
-<p style="margin-left: 5.0em; text-indent: -5.0em">WITH-ALL-VALUES "/regular expression/"
-<br>
-Requires that all values of the EXPECT attribute match the regular expression, which must conform to the POSIX regular expression syntax. Comparisons are case-sensitive.
-<p style="margin-left: 5.0em; text-indent: -5.0em">WITH-HOSTNAME "literal string"
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">WITH-HOSTNAME "/regular expression/"
-<br>
-Requires that at least one URI value contains a matching hostname.
-<p style="margin-left: 5.0em; text-indent: -5.0em">WITH-RESOURCE "literal string"
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">WITH-RESOURCE "/regular expression/"
-<br>
-Requires that at least one URI value contains a matching resource (including leading /).
-<p style="margin-left: 5.0em; text-indent: -5.0em">WITH-SCHEME "literal string"
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">WITH-SCHEME "/regular expression/"
-<br>
-Requires that at least one URI value contains a matching scheme.
-<p style="margin-left: 5.0em; text-indent: -5.0em">WITH-VALUE "literal string"
-<br>
-Requires that at least one value of the EXPECT attribute matches the literal string. Comparisons are case-sensitive.
-<p style="margin-left: 5.0em; text-indent: -5.0em">WITH-VALUE <number
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">WITH-VALUE =number
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">WITH-VALUE >number
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">WITH-VALUE number[,number,...]
-<br>
-Requires that at least one value of the EXPECT attribute matches the number(s) or numeric comparison. When comparing rangeOfInteger values, the "<" and ">" operators only check the upper bound of the range.
-<p style="margin-left: 5.0em; text-indent: -5.0em">WITH-VALUE "false"
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">WITH-VALUE "true"
-<br>
-Requires that at least one value of the EXPECT attribute matches the boolean value given.
-<p style="margin-left: 5.0em; text-indent: -5.0em">WITH-VALUE "/regular expression/"
-<br>
-Requires that at least one value of the EXPECT attribute matches the regular expression, which must conform to the POSIX regular expression syntax. Comparisons are case-sensitive.
+<dt>WITH-ALL-HOSTNAMES "literal string"
+<dd style="margin-left: 5.0em"><dt>WITH-ALL-HOSTNAMES "/regular expression/"
+<dd style="margin-left: 5.0em">Requires that all URI values contain a matching hostname.
+<dt>WITH-ALL-RESOURCES "literal string"
+<dd style="margin-left: 5.0em"><dt>WITH-ALL-RESOURCES "/regular expression/"
+<dd style="margin-left: 5.0em">Requires that all URI values contain a matching resource (including leading /).
+<dt>WITH-ALL-SCHEMES "literal string"
+<dd style="margin-left: 5.0em"><dt>WITH-ALL-SCHEMES "/regular expression/"
+<dd style="margin-left: 5.0em">Requires that all URI values contain a matching scheme.
+<dt>WITH-ALL-VALUES "literal string"
+<dd style="margin-left: 5.0em">Requires that all values of the EXPECT attribute match the literal string. Comparisons are case-sensitive.
+<dt>WITH-ALL-VALUES <number
+<dd style="margin-left: 5.0em"><dt>WITH-ALL-VALUES =number
+<dd style="margin-left: 5.0em"><dt>WITH-ALL-VALUES >number
+<dd style="margin-left: 5.0em"><dt>WITH-ALL-VALUES number[,number,...]
+<dd style="margin-left: 5.0em">Requires that all values of the EXPECT attribute match the number(s) or numeric comparison. When comparing rangeOfInteger values, the "<" and ">" operators only check the upper bound of the range.
+<dt>WITH-ALL-VALUES "false"
+<dd style="margin-left: 5.0em"><dt>WITH-ALL-VALUES "true"
+<dd style="margin-left: 5.0em">Requires that all values of the EXPECT attribute match the boolean value given.
+<dt>WITH-ALL-VALUES "/regular expression/"
+<dd style="margin-left: 5.0em">Requires that all values of the EXPECT attribute match the regular expression, which must conform to the POSIX regular expression syntax. Comparisons are case-sensitive.
+<dt>WITH-HOSTNAME "literal string"
+<dd style="margin-left: 5.0em"><dt>WITH-HOSTNAME "/regular expression/"
+<dd style="margin-left: 5.0em">Requires that at least one URI value contains a matching hostname.
+<dt>WITH-RESOURCE "literal string"
+<dd style="margin-left: 5.0em"><dt>WITH-RESOURCE "/regular expression/"
+<dd style="margin-left: 5.0em">Requires that at least one URI value contains a matching resource (including leading /).
+<dt>WITH-SCHEME "literal string"
+<dd style="margin-left: 5.0em"><dt>WITH-SCHEME "/regular expression/"
+<dd style="margin-left: 5.0em">Requires that at least one URI value contains a matching scheme.
+<dt>WITH-VALUE "literal string"
+<dd style="margin-left: 5.0em">Requires that at least one value of the EXPECT attribute matches the literal string. Comparisons are case-sensitive.
+<dt>WITH-VALUE <number
+<dd style="margin-left: 5.0em"><dt>WITH-VALUE =number
+<dd style="margin-left: 5.0em"><dt>WITH-VALUE >number
+<dd style="margin-left: 5.0em"><dt>WITH-VALUE number[,number,...]
+<dd style="margin-left: 5.0em">Requires that at least one value of the EXPECT attribute matches the number(s) or numeric comparison. When comparing rangeOfInteger values, the "<" and ">" operators only check the upper bound of the range.
+<dt>WITH-VALUE "false"
+<dd style="margin-left: 5.0em"><dt>WITH-VALUE "true"
+<dd style="margin-left: 5.0em">Requires that at least one value of the EXPECT attribute matches the boolean value given.
+<dt>WITH-VALUE "/regular expression/"
+<dd style="margin-left: 5.0em">Requires that at least one value of the EXPECT attribute matches the regular expression, which must conform to the POSIX regular expression syntax. Comparisons are case-sensitive.
+</dl>
<h2 class="title"><a name="STATUS_PREDICATES">Status Predicates</a></h2>
The following predicates are understood following the STATUS test directive:
-<p style="margin-left: 5.0em; text-indent: -5.0em">DEFINE-MATCH variable-name
-<br>
-Defines the variable to "1" when the STATUS matches. A side-effect of this predicate is that this STATUS will never fail a test.
-<p style="margin-left: 5.0em; text-indent: -5.0em">DEFINE-NO-MATCH variable-name
-<br>
-Defines the variable to "1" when the STATUS does not match. A side-effect of this predicate is that this STATUS will never fail a test.
-<p style="margin-left: 5.0em; text-indent: -5.0em">IF-DEFINED variable-name
-<br>
-Makes the STATUS apply only if the specified variable is defined.
-<p style="margin-left: 5.0em; text-indent: -5.0em">IF-NOT-DEFINED variable-name
-<br>
-Makes the STATUS apply only if the specified variable is not defined.
-<p style="margin-left: 5.0em; text-indent: -5.0em">REPEAT-LIMIT number
-<br>
-<br>
+<dl class="man">
+<dt>DEFINE-MATCH variable-name
+<dd style="margin-left: 5.0em">Defines the variable to "1" when the STATUS matches. A side-effect of this predicate is that this STATUS will never fail a test.
+<dt>DEFINE-NO-MATCH variable-name
+<dd style="margin-left: 5.0em">Defines the variable to "1" when the STATUS does not match. A side-effect of this predicate is that this STATUS will never fail a test.
+<dt>IF-DEFINED variable-name
+<dd style="margin-left: 5.0em">Makes the STATUS apply only if the specified variable is defined.
+<dt>IF-NOT-DEFINED variable-name
+<dd style="margin-left: 5.0em">Makes the STATUS apply only if the specified variable is not defined.
+<dt>REPEAT-LIMIT number
+<dd style="margin-left: 5.0em"><br>
Specifies the maximum number of times to repeat. The default value is 1000.
-<p style="margin-left: 5.0em; text-indent: -5.0em">REPEAT-MATCH
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">REPEAT-NO-MATCH
-<br>
-Specifies that the current test should be repeated when the response status-code
+<dt>REPEAT-MATCH
+<dd style="margin-left: 5.0em"><dt>REPEAT-NO-MATCH
+<dd style="margin-left: 5.0em">Specifies that the current test should be repeated when the response status-code
matches or does not match the value specified by the STATUS directive.
+</dl>
<h2 class="title"><a name="OPERATION_CODES">Operation Codes</a></h2>
Operation codes correspond to the hexadecimal numbers (0xHHHH) and names from
RFC 2911 and other IPP extension specifications. Here is a complete list:
-<pre>
+<pre class="man">
Activate-Printer
CUPS-Accept-Jobs
CUPS-Add-Modify-Class
<h2 class="title"><a name="STATUS_CODES">Status Codes</a></h2>
Status codes correspond to the hexadecimal numbers (0xHHHH) and names from RFC
2911 and other IPP extension specifications. Here is a complete list:
-<pre>
+<pre class="man">
client-error-attributes-not-settable
client-error-attributes-or-values-not-supported
client-error-bad-request
<h2 class="title"><a name="TAGS">Tags</a></h2>
Value and group tags correspond to the names from RFC 2911 and other IPP
extension specifications. Here are the group tags:
-<pre>
+<pre class="man">
event-notification-attributes-tag
job-attributes-tag
operation-attributes-tag
unsupported-attributes-tag
</pre>
<p>Here are the value tags:
-<pre>
+<pre class="man">
admin-define
boolean
charset
literal string or attribute value by specifying "$variable-name". Aside from
variables defined using the "-d" option or "DEFINE" directive, the following
pre-defined variables are available:
-<p style="margin-left: 5.0em; text-indent: -5.0em">$$
-<br>
-Inserts a single "$" character.
-<p style="margin-left: 5.0em; text-indent: -5.0em">$ENV[name]
-<br>
-Inserts the value of the named environment variable, or an empty string if the
+<dl class="man">
+<dt>$$
+<dd style="margin-left: 5.0em">Inserts a single "$" character.
+<dt>$ENV[name]
+<dd style="margin-left: 5.0em">Inserts the value of the named environment variable, or an empty string if the
environment variable is not defined.
-<p style="margin-left: 5.0em; text-indent: -5.0em">$filename
-<br>
-Inserts the filename provided to <i>ipptool</i> with the "-f" option.
-<p style="margin-left: 5.0em; text-indent: -5.0em">$hostname
-<br>
-Inserts the hostname from the URI provided to <i>ipptool</i>.
-<p style="margin-left: 5.0em; text-indent: -5.0em">$job-id
-<br>
-Inserts the last job-id value returned in a test response or 0 if no job-id has
+<dt>$filename
+<dd style="margin-left: 5.0em">Inserts the filename provided to <i>ipptool</i> with the "-f" option.
+<dt>$hostname
+<dd style="margin-left: 5.0em">Inserts the hostname from the URI provided to <i>ipptool</i>.
+<dt>$job-id
+<dd style="margin-left: 5.0em">Inserts the last job-id value returned in a test response or 0 if no job-id has
been seen.
-<p style="margin-left: 5.0em; text-indent: -5.0em">$job-uri
-<br>
-Inserts the last job-uri value returned in a test response or an empty string if
+<dt>$job-uri
+<dd style="margin-left: 5.0em">Inserts the last job-uri value returned in a test response or an empty string if
no job-uri has been seen.
-<p style="margin-left: 5.0em; text-indent: -5.0em">$scheme
-<br>
-Inserts the scheme from the URI provided to <i>ipptool</i>.
-<p style="margin-left: 5.0em; text-indent: -5.0em">$notify-subscription-id
-<br>
-Inserts the last notify-subscription-id value returned in a test response or 0 if
+<dt>$scheme
+<dd style="margin-left: 5.0em">Inserts the scheme from the URI provided to <i>ipptool</i>.
+<dt>$notify-subscription-id
+<dd style="margin-left: 5.0em">Inserts the last notify-subscription-id value returned in a test response or 0 if
no notify-subscription-id has been seen.
-<p style="margin-left: 5.0em; text-indent: -5.0em">$port
-<br>
-Inserts the port number from the URI provided to <i>ipptool</i>.
-<p style="margin-left: 5.0em; text-indent: -5.0em">$resource
-<br>
-Inserts the resource path from the URI provided to <i>ipptool</i>.
-<p style="margin-left: 5.0em; text-indent: -5.0em">$uri
-<br>
-Inserts the URI provided to <i>ipptool</i>.
-<p style="margin-left: 5.0em; text-indent: -5.0em">$user
-<br>
-Inserts the current user's login name.
-<p style="margin-left: 5.0em; text-indent: -5.0em">$username
-<br>
-Inserts the username from the URI provided to <i>ipptool</i>, if any.
+<dt>$port
+<dd style="margin-left: 5.0em">Inserts the port number from the URI provided to <i>ipptool</i>.
+<dt>$resource
+<dd style="margin-left: 5.0em">Inserts the resource path from the URI provided to <i>ipptool</i>.
+<dt>$uri
+<dd style="margin-left: 5.0em">Inserts the URI provided to <i>ipptool</i>.
+<dt>$user
+<dd style="margin-left: 5.0em">Inserts the current user's login name.
+<dt>$username
+<dd style="margin-left: 5.0em">Inserts the username from the URI provided to <i>ipptool</i>, if any.
+</dl>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
<i>ipptool(1)</i>, RFC 2911,
<br>
followed by the default set using the <i>lpadmin(8)</i> command.
<h2 class="title"><a name="OPTIONS">Options</a></h2>
The following options are recognized by <i>lp</i>:
-<p style="margin-left: 5.0em; text-indent: -5.0em">--
-<br>
-<br>
+<dl class="man">
+<dt>--
+<dd style="margin-left: 5.0em"><br>
Marks the end of options; use this to print a file whose name
begins with a dash (-).
-<p style="margin-left: 5.0em; text-indent: -5.0em">-E
-<br>
-<br>
+<dt>-E
+<dd style="margin-left: 5.0em"><br>
Forces encryption when connecting to the server.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-U username
-<br>
-<br>
+<dt>-U username
+<dd style="margin-left: 5.0em"><br>
Specifies the username to use when connecting to the server.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-c
-<br>
-<br>
+<dt>-c
+<dd style="margin-left: 5.0em"><br>
This option is provided for backwards-compatibility only. On
systems that support it, this option forces the print file to be
copied to the spool directory before printing. In CUPS, print
files are always sent to the scheduler via IPP which has the
same effect.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-d destination
-<br>
-<br>
+<dt>-d destination
+<dd style="margin-left: 5.0em"><br>
Prints files to the named printer.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-h hostname[:port]
-<br>
-<br>
+<dt>-h hostname[:port]
+<dd style="margin-left: 5.0em"><br>
Chooses an alternate server.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-i job-id
-<br>
-<br>
+<dt>-i job-id
+<dd style="margin-left: 5.0em"><br>
Specifies an existing job to modify.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-m
-<br>
-<br>
+<dt>-m
+<dd style="margin-left: 5.0em"><br>
Sends an email when the job is completed.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-n copies
-<br>
-<br>
+<dt>-n copies
+<dd style="margin-left: 5.0em"><br>
Sets the number of copies to print from 1 to 100.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o "name=value [name=value ...]"
-<br>
-<br>
+<dt>-o "name=value [name=value ...]"
+<dd style="margin-left: 5.0em"><br>
Sets one or more job options.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-q priority
-<br>
-<br>
+<dt>-q priority
+<dd style="margin-left: 5.0em"><br>
Sets the job priority from 1 (lowest) to 100 (highest). The
default priority is 50.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-s
-<br>
-<br>
+<dt>-s
+<dd style="margin-left: 5.0em"><br>
Do not report the resulting job IDs (silent mode.)
-<p style="margin-left: 5.0em; text-indent: -5.0em">-t "name"
-<br>
-<br>
+<dt>-t "name"
+<dd style="margin-left: 5.0em"><br>
Sets the job name.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-H hh:mm
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">-H hold
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">-H immediate
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">-H restart
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">-H resume
-<br>
-<br>
+<dt>-H hh:mm
+<dd style="margin-left: 5.0em"><dt>-H hold
+<dd style="margin-left: 5.0em"><dt>-H immediate
+<dd style="margin-left: 5.0em"><dt>-H restart
+<dd style="margin-left: 5.0em"><dt>-H resume
+<dd style="margin-left: 5.0em"><br>
Specifies when the job should be printed. A value of <i>immediate</i> will print
the file immediately, a value of <i>hold</i> will hold the job indefinitely, and
a UTC time value (HH:MM) will hold the job until the specified UTC (not local)
time. Use a value of <i>resume</i> with the <i>-i</i> option to resume a held job.
Use a value of <i>restart</i> with the <i>-i</i> option to restart
a completed job.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-P page-list
-<br>
-<br>
+<dt>-P page-list
+<dd style="margin-left: 5.0em"><br>
Specifies which pages to print in the document. The list can
contain a list of numbers and ranges (#-#) separated by commas
(e.g. 1,3-5,16). The page numbers refer to the output pages and
not the document's original pages - options like "number-up" can
affect the numbering of the pages.
+</dl>
<h2 class="title"><a name="COMMON_JOB_OPTIONS">Common Job Options</a></h2>
Aside from the printer-specific options reported by the
<i>lpoptions(1)</i> command, the following generic options are
available:
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o media=size
-<br>
-<br>
+<dl class="man">
+<dt>-o media=size
+<dd style="margin-left: 5.0em"><br>
Sets the page size to <i>size</i>. Most printers support at least
the size names "a4", "letter", and "legal".
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o landscape
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o orientation-requested=4
-<br>
-<br>
+<dt>-o landscape
+<dd style="margin-left: 5.0em"><dt>-o orientation-requested=4
+<dd style="margin-left: 5.0em"><br>
Prints the job in landscape (rotated 90 degrees).
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o sides=one-sided
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o sides=two-sided-long-edge
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o sides=two-sided-short-edge
-<br>
-<br>
+<dt>-o sides=one-sided
+<dd style="margin-left: 5.0em"><dt>-o sides=two-sided-long-edge
+<dd style="margin-left: 5.0em"><dt>-o sides=two-sided-short-edge
+<dd style="margin-left: 5.0em"><br>
Prints on one or two sides of the paper. The value
"two-sided-long-edge" is normally used when printing portrait
(unrotated) pages, while "two-sided-short-edge" is used for
landscape pages.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o fit-to-page
-<br>
-<br>
+<dt>-o fit-to-page
+<dd style="margin-left: 5.0em"><br>
Scales the print file to fit on the page.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o number-up=2
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o number-up=4
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o number-up=6
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o number-up=9
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o number-up=16
-<br>
-<br>
+<dt>-o number-up=2
+<dd style="margin-left: 5.0em"><dt>-o number-up=4
+<dd style="margin-left: 5.0em"><dt>-o number-up=6
+<dd style="margin-left: 5.0em"><dt>-o number-up=9
+<dd style="margin-left: 5.0em"><dt>-o number-up=16
+<dd style="margin-left: 5.0em"><br>
Prints multiple document pages on each output page.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o cpi=N
-<br>
-<br>
+<dt>-o cpi=N
+<dd style="margin-left: 5.0em"><br>
Sets the number of characters per inch to use when printing a
text file. The default is 10.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o lpi=N
-<br>
-<br>
+<dt>-o lpi=N
+<dd style="margin-left: 5.0em"><br>
Sets the number of lines per inch to use when printing a text
file. The default is 6.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o page-bottom=N
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o page-left=N
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o page-right=N
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o page-top=N
-<br>
-<br>
+<dt>-o page-bottom=N
+<dd style="margin-left: 5.0em"><dt>-o page-left=N
+<dd style="margin-left: 5.0em"><dt>-o page-right=N
+<dd style="margin-left: 5.0em"><dt>-o page-top=N
+<dd style="margin-left: 5.0em"><br>
Sets the page margins when printing text files. The values are in
points - there are 72 points to the inch.
+</dl>
<h2 class="title"><a name="EXAMPLES">Examples</a></h2>
Print a double-sided legal document to a printer called "foo":
-<pre>
+<pre class="man">
lp -d foo -o media=legal -o sides=two-sided-long-edge filename
</pre>
<p>Print an image across 4 pages:
-<pre>
+<pre class="man">
lp -d bar -o scaling=200 filename
</pre>
<p>Print a text file with 12 characters per inch, 8 lines per inch, and
a 1 inch left margin:
-<pre>
+<pre class="man">
lp -d bar -o cpi=12 -o lpi=8 -o page-left=72 filename
</pre>
<h2 class="title"><a name="COMPATIBILITY">Compatibility</a></h2>
<h2 class="title"><a name="CONFIGURATION_OPTIONS">Configuration Options</a></h2>
The following options are recognized when configuring a printer
queue:
-<p style="margin-left: 5.0em; text-indent: -5.0em">-c class
-<br>
-<br>
+<dl class="man">
+<dt>-c class
+<dd style="margin-left: 5.0em"><br>
Adds the named <i>printer</i> to <i>class</i>. If <i>class</i> does
not exist it is created automatically.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-i interface
-<br>
-<br>
+<dt>-i interface
+<dd style="margin-left: 5.0em"><br>
Sets a System V style interface script for the printer. This
option cannot be specified with the <i>-P</i> option (PPD file)
and is intended for providing support for legacy printer drivers.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-m model
-<br>
-<br>
+<dt>-m model
+<dd style="margin-left: 5.0em"><br>
Sets a standard System V interface script or 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 <i>lpinfo(8)</i> command to get a list of supported models.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o cupsIPPSupplies=true
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o cupsIPPSupplies=false
-<br>
-<br>
+<dt>-o cupsIPPSupplies=true
+<dd style="margin-left: 5.0em"><dt>-o cupsIPPSupplies=false
+<dd style="margin-left: 5.0em"><br>
Specifies whether IPP supply level values should be reported.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o cupsSNMPSupplies=true
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o cupsSNMPSupplies=false
-<br>
-<br>
+<dt>-o cupsSNMPSupplies=true
+<dd style="margin-left: 5.0em"><dt>-o cupsSNMPSupplies=false
+<dd style="margin-left: 5.0em"><br>
Specifies whether SNMP supply level (RFC 3805) values should be reported.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o job-k-limit=value
-<br>
-<br>
+<dt>-o job-k-limit=value
+<dd style="margin-left: 5.0em"><br>
Sets the kilobyte limit for per-user quotas. The value is an
integer number of kilobytes; one kilobyte is 1024 bytes.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o job-page-limit=value
-<br>
-<br>
+<dt>-o job-page-limit=value
+<dd style="margin-left: 5.0em"><br>
Sets the page limit for per-user quotas. The value is the integer
number of pages that can be printed; double-sided pages are
counted as two pages.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o job-quota-period=value
-<br>
-<br>
+<dt>-o job-quota-period=value
+<dd style="margin-left: 5.0em"><br>
Sets the accounting period for per-user quotas. The value is an
integer number of seconds; 86,400 seconds are in one day.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o job-sheets-default=banner
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o job-sheets-default=banner,banner
-<br>
-<br>
+<dt>-o job-sheets-default=banner
+<dd style="margin-left: 5.0em"><dt>-o job-sheets-default=banner,banner
+<dd style="margin-left: 5.0em"><br>
Sets the default banner page(s) to use for print jobs.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o name=value
-<br>
-<br>
+<dt>-o name=value
+<dd style="margin-left: 5.0em"><br>
Sets a PPD option for the printer. PPD options can be listed using the <i>-l</i>
option with the <i>lpoptions(1)</i> command.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o name-default=value
-<br>
-<br>
+<dt>-o name-default=value
+<dd style="margin-left: 5.0em"><br>
Sets a default server-side option for the destination. Any print-time
option can be defaulted, e.g. "-o cpi-default=17" to set the default
"cpi" option value to 17.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o port-monitor=name
-<br>
-<br>
+<dt>-o port-monitor=name
+<dd style="margin-left: 5.0em"><br>
Sets the binary communications program to use when printing,
"none", "bcp", or "tbcp". The default program is "none". The
specified port monitor must be listed in the printer's PPD file.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o printer-error-policy=name
-<br>
-<br>
+<dt>-o printer-error-policy=name
+<dd style="margin-left: 5.0em"><br>
Sets the error policy to be used when the printer backend is
unable to send the job to the printer. The name must be one of
"abort-job", "retry-job", "retry-current-job", or "stop-printer". The default
error policy is "stop-printer" for printers and "retry-current-job" for
classes.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o printer-is-shared=true/false
-<br>
-<br>
+<dt>-o printer-is-shared=true/false
+<dd style="margin-left: 5.0em"><br>
Sets the destination to shared/published or unshared/unpublished.
Shared/published destinations are publicly announced by the server
on the LAN based on the browsing configuration in
<b>cupsd.conf</b>, while unshared/unpublished destinations are not
announced. The default value is "true".
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o printer-op-policy=name
-<br>
-<br>
+<dt>-o printer-op-policy=name
+<dd style="margin-left: 5.0em"><br>
Sets the IPP operation policy associated with the destination. The
name must be defined in the <b>cupsd.conf</b> in a Policy section.
The default operation policy is "default".
-<p style="margin-left: 5.0em; text-indent: -5.0em">-R name-default
-<br>
-<br>
+<dt>-R name-default
+<dd style="margin-left: 5.0em"><br>
Deletes the named option from <i>printer</i>.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-r class
-<br>
-<br>
+<dt>-r class
+<dd style="margin-left: 5.0em"><br>
Removes the named <i>printer</i> from <i>class</i>. If the
resulting class becomes empty it is removed.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-u allow:user,user,@group
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">-u deny:user,user,@group
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">-u allow:all
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">-u deny:none
-<br>
-<br>
+<dt>-u allow:user,user,@group
+<dd style="margin-left: 5.0em"><dt>-u deny:user,user,@group
+<dd style="margin-left: 5.0em"><dt>-u allow:all
+<dd style="margin-left: 5.0em"><dt>-u deny:none
+<dd style="margin-left: 5.0em"><br>
Sets user-level access control on a destination. Names starting with
"@" are interpreted as UNIX groups. The latter two forms turn
user-level access control off.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-v "device-uri"
-<br>
-<br>
+<dt>-v "device-uri"
+<dd style="margin-left: 5.0em"><br>
Sets the <i>device-uri</i> attribute of the printer queue. Use the <i>-v</i>
option with the <i>lpinfo(8)</i> command to get a list of supported device URIs
and schemes.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-D "info"
-<br>
-<br>
+<dt>-D "info"
+<dd style="margin-left: 5.0em"><br>
Provides a textual description of the destination.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-E
-<br>
-<br>
+<dt>-E
+<dd style="margin-left: 5.0em"><br>
Enables the destination and accepts jobs; this is the same as running the
<i>cupsaccept(8)</i> and <i>cupsenable(8)</i> programs on the destination.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-L "location"
-<br>
-<br>
+<dt>-L "location"
+<dd style="margin-left: 5.0em"><br>
Provides a textual location of the destination.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-P ppd-file
-<br>
-<br>
+<dt>-P ppd-file
+<dd style="margin-left: 5.0em"><br>
Specifies a PostScript Printer Description file to use with the
printer. If specified, this option overrides the <i>-i</i> option
(interface script).
+</dl>
<h2 class="title"><a name="COMPATIBILITY">Compatibility</a></h2>
Unlike the System V printing system, CUPS allows printer names to
contain any printable character except SPACE, TAB, "/", or "#".
<h2 class="title"><a name="COMMANDS">Commands</a></h2>
The <i>lpc</i> program accepts a subset of commands accepted by
the Berkeley <i>lpc</i> program of the same name:
-<p style="margin-left: 5.0em; text-indent: -5.0em">exit
-<br>
-<br>
+<dl class="man">
+<dt>exit
+<dd style="margin-left: 5.0em"><br>
Exits the command interpreter.
-<p style="margin-left: 5.0em; text-indent: -5.0em">help [command]
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">? [command]
-<br>
-<br>
+<dt>help [command]
+<dd style="margin-left: 5.0em"><dt>? [command]
+<dd style="margin-left: 5.0em"><br>
Displays a short help message.
-<p style="margin-left: 5.0em; text-indent: -5.0em">quit
-<br>
-<br>
+<dt>quit
+<dd style="margin-left: 5.0em"><br>
Exits the command interpreter.
-<p style="margin-left: 5.0em; text-indent: -5.0em">status [queue]
-<br>
-<br>
+<dt>status [queue]
+<dd style="margin-left: 5.0em"><br>
Displays the status of one or more printer or class queues.
+</dl>
<h2 class="title"><a name="LIMITATIONS">Limitations</a></h2>
Since <i>lpc</i> is geared towards the Berkeley printing system,
it is impossible to use <i>lpc</i> to configure printer or class
devices.
<h2 class="title"><a name="OPTIONS">Options</a></h2>
<i>lpinfo</i> accepts the following options:
-<p style="margin-left: 5.0em; text-indent: -5.0em">-E
-<br>
-<br>
+<dl class="man">
+<dt>-E
+<dd style="margin-left: 5.0em"><br>
Forces encryption when connecting to the server.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-U username
-<br>
-<br>
+<dt>-U username
+<dd style="margin-left: 5.0em"><br>
Sets the username to use when connecting to the server.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-h server[:port]
-<br>
-<br>
+<dt>-h server[:port]
+<dd style="margin-left: 5.0em"><br>
Selects an alternate server.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-l
-<br>
-<br>
+<dt>-l
+<dd style="margin-left: 5.0em"><br>
Shows a "long" listing of devices or drivers.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--device-id device-id-string
-<br>
-<br>
+<dt>--device-id device-id-string
+<dd style="margin-left: 5.0em"><br>
Specifies the IEEE-1284 device ID to match when listing drivers with the
<i>-m</i> option.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--exclude-schemes scheme-list
-<br>
-<br>
+<dt>--exclude-schemes scheme-list
+<dd style="margin-left: 5.0em"><br>
Specifies a comma-separated list of device or PPD schemes that should be
excluded from the results. Static PPD files use the "file" scheme.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--include-schemes scheme-list
-<br>
-<br>
+<dt>--include-schemes scheme-list
+<dd style="margin-left: 5.0em"><br>
Specifies a comma-separated list of device or PPD schemes that should be
included in the results. Static PPD files use the "file" scheme.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--language locale
-<br>
-<br>
+<dt>--language locale
+<dd style="margin-left: 5.0em"><br>
Specifies the language to match when listing drivers with the <i>-m</i> option.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--make-and-model name
-<br>
-<br>
+<dt>--make-and-model name
+<dd style="margin-left: 5.0em"><br>
Specifies the make and model to match when listing drivers with the <i>-m</i>
option.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--product name
-<br>
-<br>
+<dt>--product name
+<dd style="margin-left: 5.0em"><br>
Specifies the product to match when listing drivers with the <i>-m</i> option.
-<p style="margin-left: 5.0em; text-indent: -5.0em">--timeout seconds
-<br>
-<br>
+<dt>--timeout seconds
+<dd style="margin-left: 5.0em"><br>
Specifies the timeout when listing devices with the <i>-v</i> option.
+</dl>
<h2 class="title"><a name="COMPATIBILITY">Compatibility</a></h2>
The <i>lpinfo</i> command is unique to CUPS.
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
] [ -U
<i>username</i>
]
-<i>job</i> <i>destination</i>
+<i>job</i><i>destination</i>
<br>
<b>lpmove</b>
[ -E ] [ -h
] [ -U
<i>username</i>
]
-<i>source</i> <i>destination</i>
+<i>source</i><i>destination</i>
<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
<b>lpmove</b> moves the specified <i>job</i> or all jobs from
<i>source</i> to <i>destination</i>. <i>job</i> can be the job ID
number or the old destination and job ID:
<br>
-<pre>
+<pre class="man">
lpmove 123 newprinter
lpmove oldprinter-123 newprinter
</pre>
<h2 class="title"><a name="OPTIONS">Options</a></h2>
The <i>lpmove</i> command supports the following options:
-<p style="margin-left: 5.0em; text-indent: -5.0em">-E
-<br>
-<br>
+<dl class="man">
+<dt>-E
+<dd style="margin-left: 5.0em"><br>
Forces encryption when connecting to the server.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-U username
-<br>
-<br>
+<dt>-U username
+<dd style="margin-left: 5.0em"><br>
Specifies an alternate username.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-h server[:port]
-<br>
-<br>
+<dt>-h server[:port]
+<dd style="margin-left: 5.0em"><br>
Specifies an alternate server.
+</dl>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
<i>cancel(1)</i>, <i>lp(1)</i>,
<br>
<i>lpoptions</i> displays or sets printer options and defaults.
<i>lpoptions</i> shows the default printer options when run with no
arguments. Other options include:
-<p style="margin-left: 5.0em; text-indent: -5.0em">-E
-<br>
-<br>
+<dl class="man">
+<dt>-E
+<dd style="margin-left: 5.0em"><br>
Enables encryption when communicating with the CUPS server.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-U username
-<br>
-<br>
+<dt>-U username
+<dd style="margin-left: 5.0em"><br>
Uses an alternate username.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-d destination[/instance]
-<br>
-<br>
+<dt>-d destination[/instance]
+<dd style="margin-left: 5.0em"><br>
Sets the user default printer to <i>destination</i>. If <i>instance</i>
is supplied then that particular instance is used. This option
overrides the system default printer for the current user.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-h server[:port]
-<br>
-<br>
+<dt>-h server[:port]
+<dd style="margin-left: 5.0em"><br>
Uses an alternate server.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-l
-<br>
-<br>
+<dt>-l
+<dd style="margin-left: 5.0em"><br>
Lists the printer specific options and their current settings.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o option[=value]
-<br>
-<br>
+<dt>-o option[=value]
+<dd style="margin-left: 5.0em"><br>
Specifies a new option for the named destination.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-p destination[/instance]
-<br>
-<br>
+<dt>-p destination[/instance]
+<dd style="margin-left: 5.0em"><br>
Sets the destination and instance, if specified, for any options
that follow. If the named instance does not exist then it is
created.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-r option
-<br>
-<br>
+<dt>-r option
+<dd style="margin-left: 5.0em"><br>
Removes the specified option for the named destination.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-x destination[/instance]
-<br>
-<br>
+<dt>-x destination[/instance]
+<dd style="margin-left: 5.0em"><br>
Removes the options for the named destination and instance, if
specified. If the named instance does not exist then this does
nothing.
+</dl>
<p>If no options are specified using the <i>-o</i> option, then the
current options for the named printer are reported on the
standard output.
shown once every <i>interval</i> seconds.
<h2 class="title"><a name="OPTIONS">Options</a></h2>
<i>lpq</i> supports the following options:
-<p style="margin-left: 5.0em; text-indent: -5.0em">-E
-<br>
-<br>
+<dl class="man">
+<dt>-E
+<dd style="margin-left: 5.0em"><br>
Forces encryption when connecting to the server.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-P destination[/instance]
-<br>
-<br>
+<dt>-P destination[/instance]
+<dd style="margin-left: 5.0em"><br>
Specifies an alternate printer or class name.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-U username
-<br>
-<br>
+<dt>-U username
+<dd style="margin-left: 5.0em"><br>
Specifies an alternate username.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-a
-<br>
-<br>
+<dt>-a
+<dd style="margin-left: 5.0em"><br>
Reports jobs on all printers.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-h server[:port]
-<br>
-<br>
+<dt>-h server[:port]
+<dd style="margin-left: 5.0em"><br>
Specifies an alternate server.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-l
-<br>
-<br>
+<dt>-l
+<dd style="margin-left: 5.0em"><br>
Requests a more verbose (long) reporting format.
+</dl>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
<i>cancel(1)</i>, <i>lp(1)</i>, <i>lpr(1)</i>, <i>lprm(1)</i>,
<i>lpstat(1)</i>,
followed by the default set using the <i>lpadmin(8)</i> command.
<h2 class="title"><a name="OPTIONS">Options</a></h2>
The following options are recognized by <i>lpr</i>:
-<p style="margin-left: 5.0em; text-indent: -5.0em">-E
-<br>
-<br>
+<dl class="man">
+<dt>-E
+<dd style="margin-left: 5.0em"><br>
Forces encryption when connecting to the server.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-H server[:port]
-<br>
-<br>
+<dt>-H server[:port]
+<dd style="margin-left: 5.0em"><br>
Specifies an alternate server.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-C "name"
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">-J "name"
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">-T "name"
-<br>
-<br>
+<dt>-C "name"
+<dd style="margin-left: 5.0em"><dt>-J "name"
+<dd style="margin-left: 5.0em"><dt>-T "name"
+<dd style="margin-left: 5.0em"><br>
Sets the job name.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-P destination[/instance]
-<br>
-<br>
+<dt>-P destination[/instance]
+<dd style="margin-left: 5.0em"><br>
Prints files to the named printer.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-U username
-<br>
-<br>
+<dt>-U username
+<dd style="margin-left: 5.0em"><br>
Specifies an alternate username.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-# <i>copies</i>
-<br>
-<br>
+<dt>-# <i>copies</i>
+<dd style="margin-left: 5.0em"><br>
Sets the number of copies to print from 1 to 100.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-h
-<br>
-<br>
+<dt>-h
+<dd style="margin-left: 5.0em"><br>
Disables banner printing. This option is equivalent to "-o
job-sheets=none".
-<p style="margin-left: 5.0em; text-indent: -5.0em">-l
-<br>
-<br>
+<dt>-l
+<dd style="margin-left: 5.0em"><br>
Specifies that the print file is already formatted for the
destination and should be sent without filtering. This option is
equivalent to "-o raw".
-<p style="margin-left: 5.0em; text-indent: -5.0em">-m
-<br>
-<br>
+<dt>-m
+<dd style="margin-left: 5.0em"><br>
Send an email on job completion.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o option[=value]
-<br>
-<br>
+<dt>-o option[=value]
+<dd style="margin-left: 5.0em"><br>
Sets a job option.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-p
-<br>
-<br>
+<dt>-p
+<dd style="margin-left: 5.0em"><br>
Specifies that the print file should be formatted with a shaded
header with the date, time, job name, and page number. This
option is equivalent to "-o prettyprint" and is only useful when
printing text files.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-q
-<br>
-<br>
+<dt>-q
+<dd style="margin-left: 5.0em"><br>
Hold job for printing.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-r
-<br>
-<br>
+<dt>-r
+<dd style="margin-left: 5.0em"><br>
Specifies that the named print files should be deleted after
printing them.
+</dl>
<h2 class="title"><a name="COMPATIBILITY">Compatibility</a></h2>
The "c", "d", "f", "g", "i", "n", "t", "v", and "w" options
are not supported by CUPS and produce a warning message if used.
] [ -P
<i>destination[/instance]</i>
] [ - ] [
-<i>job</i> <i>ID(s)</i>
+<i>job</i><i>ID(s)</i>
]
<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
<i>lprm</i> cancels print jobs that have been queued for printing.
all jobs.
<h2 class="title"><a name="OPTIONS">Options</a></h2>
The <i>lprm</i> command supports the following options:
-<p style="margin-left: 5.0em; text-indent: -5.0em">-E
-<br>
-<br>
+<dl class="man">
+<dt>-E
+<dd style="margin-left: 5.0em"><br>
Forces encryption when connecting to the server.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-P destination[/instance]
-<br>
-<br>
+<dt>-P destination[/instance]
+<dd style="margin-left: 5.0em"><br>
Specifies the destination printer or class.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-U username
-<br>
-<br>
+<dt>-U username
+<dd style="margin-left: 5.0em"><br>
Specifies an alternate username.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-h server[:port]
-<br>
-<br>
+<dt>-h server[:port]
+<dd style="margin-left: 5.0em"><br>
Specifies an alternate server.
+</dl>
<h2 class="title"><a name="COMPATIBILITY">Compatibility</a></h2>
The CUPS version of <i>lprm</i> is compatible with the standard
Berkeley <i>lprm</i> command.
<i>lpstat</i> will list jobs queued by the current user.
<h2 class="title"><a name="OPTIONS">Options</a></h2>
The <i>lpstat</i> command supports the following options:
-<p style="margin-left: 5.0em; text-indent: -5.0em">-E
-<br>
-<br>
+<dl class="man">
+<dt>-E
+<dd style="margin-left: 5.0em"><br>
Forces encryption when connecting to the server.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-H
-<br>
-<br>
+<dt>-H
+<dd style="margin-left: 5.0em"><br>
Shows the server hostname and port.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-R
-<br>
-<br>
+<dt>-R
+<dd style="margin-left: 5.0em"><br>
Shows the ranking of print jobs.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-U username
-<br>
-<br>
+<dt>-U username
+<dd style="margin-left: 5.0em"><br>
Specifies an alternate username.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-W which-jobs
-<br>
-<br>
+<dt>-W which-jobs
+<dd style="margin-left: 5.0em"><br>
Specifies which jobs to show, <i>completed</i> or
<i>not-completed</i> (the default). This option <i>must</i> appear
before the <i>-o</i> option and/or any printer names, otherwise
the default (not-completed) value will be used in the request to
the scheduler.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-a [printer(s)]
-<br>
-<br>
+<dt>-a [printer(s)]
+<dd style="margin-left: 5.0em"><br>
Shows the accepting state of printer queues. If no printers are
specified then all printers are listed.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-c [class(es)]
-<br>
-<br>
+<dt>-c [class(es)]
+<dd style="margin-left: 5.0em"><br>
Shows the printer classes and the printers that belong to them.
If no classes are specified then all classes are listed.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-d
-<br>
-<br>
+<dt>-d
+<dd style="margin-left: 5.0em"><br>
Shows the current default destination.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-h server[:port]
-<br>
-<br>
+<dt>-h server[:port]
+<dd style="margin-left: 5.0em"><br>
Specifies an alternate server.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-l
-<br>
-<br>
+<dt>-l
+<dd style="margin-left: 5.0em"><br>
Shows a long listing of printers, classes, or jobs.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-o [destination(s)]
-<br>
-<br>
+<dt>-o [destination(s)]
+<dd style="margin-left: 5.0em"><br>
Shows the jobs queue on the specified destinations. If no destinations are
specified all jobs are shown.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-p [printer(s)]
-<br>
-<br>
+<dt>-p [printer(s)]
+<dd style="margin-left: 5.0em"><br>
Shows the printers and whether or not they are enabled for printing. If
no printers are specified then all printers are listed.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-r
-<br>
-<br>
+<dt>-r
+<dd style="margin-left: 5.0em"><br>
Shows whether the CUPS server is running.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-s
-<br>
-<br>
+<dt>-s
+<dd style="margin-left: 5.0em"><br>
Shows a status summary, including the default destination, a
list of classes and their member printers, and a list of printers and
their associated devices. This is equivalent to using the "-d", "-c",
and "-v" options.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-t
-<br>
-<br>
+<dt>-t
+<dd style="margin-left: 5.0em"><br>
Shows all status information. This is equivalent to using the "-r",
"-d", "-c", "-v", "-a", "-p", and "-o" options.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-u [user(s)]
-<br>
-<br>
+<dt>-u [user(s)]
+<dd style="margin-left: 5.0em"><br>
Shows a list of print jobs queued by the specified users. If no users
are specified, lists the jobs queued by the current user.
-<p style="margin-left: 5.0em; text-indent: -5.0em">-v [printer(s)]
-<br>
-<br>
+<dt>-v [printer(s)]
+<dd style="margin-left: 5.0em"><br>
Shows the printers and what device they are attached to. If no printers
are specified then all printers are listed.
+</dl>
<h2 class="title"><a name="COMPATIBILITY">Compatibility</a></h2>
Unlike the System V printing system, CUPS allows printer names to
contain any printable character except SPACE, TAB, "/", and "#".
<p>Each line in the file can be a configuration directive, a blank line,
or a comment. Comment lines start with the # character.
<h2 class="title"><a name="DIRECTIVES">Directives</a></h2>
-<p style="margin-left: 5.0em; text-indent: -5.0em">Cc <i>cc-address@domain.com</i>
-<br>
-<br>
+<dl class="man">
+<dt>Cc <i>cc-address@domain.com</i>
+<dd style="margin-left: 5.0em"><br>
Specifies an additional recipient for all email notifications.
-<p style="margin-left: 5.0em; text-indent: -5.0em">From <i>from-address@domain.com</i>
-<br>
-<br>
+<dt>From <i>from-address@domain.com</i>
+<dd style="margin-left: 5.0em"><br>
Specifies the sender of email notifications.
-<p style="margin-left: 5.0em; text-indent: -5.0em">Sendmail <i>sendmail command and options</i>
-<br>
-<br>
+<dt>Sendmail <i>sendmail command and options</i>
+<dd style="margin-left: 5.0em"><br>
Specifies the sendmail command to use when sending email
notifications. Only one <i>Sendmail</i> or <i>SMTPServer</i> line
may be present in the <i>mailto.conf</i> file. If multiple lines
are present, only the last one is used.
-<p style="margin-left: 5.0em; text-indent: -5.0em">SMTPServer <i>servername</i>
-<br>
-<br>
+<dt>SMTPServer <i>servername</i>
+<dd style="margin-left: 5.0em"><br>
Specifies a SMTP server to send email notifications to. Only one
<i>Sendmail</i> or <i>SMTPServer</i> line may be present in the
<i>mailto.conf</i> file. If multiple lines are present, only the
last one is used.
-<p style="margin-left: 5.0em; text-indent: -5.0em">Subject <i>subject-prefix</i>
-<br>
-<br>
+<dt>Subject <i>subject-prefix</i>
+<dd style="margin-left: 5.0em"><br>
Specifies a prefix string for the subject line of an email notification.
+</dl>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
<i>classes.conf(5)</i>, <i>cupsd(8)</i>, <i>cupsd.conf(5)</i>,
<i>mime.convs(5)</i>, <i>mime.types(5)</i>, <i>printers.conf(5)</i>,
the source and destination MIME types along with a relative cost
associated with the filter and the filter to run:
<br>
-<pre>
+<pre class="man">
super/type super/type cost filter
application/postscript application/vnd.cups-raster 50 pstoraster
series of file recognition rules that are used to automatically
identify print and web files:
<br>
-<pre>
+<pre class="man">
super/type rule [ ... ruleN]
</pre>
<h2 class="title"><a name="RULES">Rules</a></h2>
Rules take two forms - a filename extension by itself and functions with test
values inside parenthesis. The following functions are available:
-<p style="margin-left: 5.0em; text-indent: -5.0em">match("pattern")
-<br>
-<br>
+<dl class="man">
+<dt>match("pattern")
+<dd style="margin-left: 5.0em"><br>
Pattern match on filename
-<p style="margin-left: 5.0em; text-indent: -5.0em">ascii(offset,length)
-<br>
-<br>
+<dt>ascii(offset,length)
+<dd style="margin-left: 5.0em"><br>
True if bytes are valid printable ASCII (CR, NL, TAB, BS, 32-126)
-<p style="margin-left: 5.0em; text-indent: -5.0em">printable(offset,length)
-<br>
-<br>
+<dt>printable(offset,length)
+<dd style="margin-left: 5.0em"><br>
True if bytes are printable 8-bit chars (CR, NL, TAB, BS, 32-126, 128-254)
-<p style="margin-left: 5.0em; text-indent: -5.0em">priority(number)
-<br>
-<br>
+<dt>priority(number)
+<dd style="margin-left: 5.0em"><br>
Specifies the relative priority of this MIME type. The default priority is 100.
Larger values have higher priority while smaller values have lower priority.
-<p style="margin-left: 5.0em; text-indent: -5.0em">string(offset,"string")
-<br>
-<br>
+<dt>string(offset,"string")
+<dd style="margin-left: 5.0em"><br>
True if bytes are identical to string
-<p style="margin-left: 5.0em; text-indent: -5.0em">istring(offset,"string")
-<br>
-<br>
+<dt>istring(offset,"string")
+<dd style="margin-left: 5.0em"><br>
True if a case-insensitive comparison of the bytes is identical
-<p style="margin-left: 5.0em; text-indent: -5.0em">char(offset,value)
-<br>
-<br>
+<dt>char(offset,value)
+<dd style="margin-left: 5.0em"><br>
True if byte is identical
-<p style="margin-left: 5.0em; text-indent: -5.0em">short(offset,value)
-<br>
-<br>
+<dt>short(offset,value)
+<dd style="margin-left: 5.0em"><br>
True if 16-bit integer is identical
-<p style="margin-left: 5.0em; text-indent: -5.0em">int(offset,value)
-<br>
-<br>
+<dt>int(offset,value)
+<dd style="margin-left: 5.0em"><br>
True if 32-bit integer is identical
-<p style="margin-left: 5.0em; text-indent: -5.0em">locale("string")
-<br>
-<br>
+<dt>locale("string")
+<dd style="margin-left: 5.0em"><br>
True if current locale matches string
-<p style="margin-left: 5.0em; text-indent: -5.0em">contains(offset,range,"string")
-<br>
-<br>
+<dt>contains(offset,range,"string")
+<dd style="margin-left: 5.0em"><br>
True if the range contains the string
+</dl>
<h2 class="title"><a name="STRING_CONSTANTS">String Constants</a></h2>
String constants can be specified inside quotes ("") for strings
containing whitespace and angle brackets (<>) for hexadecimal
Messages sent to stderr are generally logged to the current <i>ErrorLog</i>.
Each line begins with a standard prefix:
-<p style="margin-left: 5.0em; text-indent: -5.0em">ALERT: message
-<br>
-<br>
+<dl class="man">
+<dt>ALERT: message
+<dd style="margin-left: 5.0em"><br>
Sets the printer-state-message attribute and adds the specified
message to the current <i>ErrorLog</i> using the "alert" log level.
-<p style="margin-left: 5.0em; text-indent: -5.0em">CRIT: message
-<br>
-<br>
+<dt>CRIT: message
+<dd style="margin-left: 5.0em"><br>
Sets the printer-state-message attribute and adds the specified
message to the current <i>ErrorLog</i> using the "critical" log level.
-<p style="margin-left: 5.0em; text-indent: -5.0em">DEBUG: message
-<br>
-<br>
+<dt>DEBUG: message
+<dd style="margin-left: 5.0em"><br>
Sets the printer-state-message attribute and adds the specified
message to the current <i>ErrorLog</i> using the "debug" log level.
-<p style="margin-left: 5.0em; text-indent: -5.0em">DEBUG2: message
-<br>
-<br>
+<dt>DEBUG2: message
+<dd style="margin-left: 5.0em"><br>
Sets the printer-state-message attribute and adds the specified
message to the current <i>ErrorLog</i> using the "debug2" log level.
-<p style="margin-left: 5.0em; text-indent: -5.0em">EMERG: message
-<br>
-<br>
+<dt>EMERG: message
+<dd style="margin-left: 5.0em"><br>
Sets the printer-state-message attribute and adds the specified
message to the current <i>ErrorLog</i> using the "emergency" log level.
-<p style="margin-left: 5.0em; text-indent: -5.0em">ERROR: message
-<br>
-<br>
+<dt>ERROR: message
+<dd style="margin-left: 5.0em"><br>
Sets the printer-state-message attribute and adds the specified
message to the current <i>ErrorLog</i> using the "error" log level.
-<p style="margin-left: 5.0em; text-indent: -5.0em">INFO: message
-<br>
-<br>
+<dt>INFO: message
+<dd style="margin-left: 5.0em"><br>
Sets the printer-state-message attribute. If the current <i>LogLevel</i>
is set to "debug2", also adds the specified message to the
current <i>ErrorLog</i> using the "info" log level.
-<p style="margin-left: 5.0em; text-indent: -5.0em">NOTICE: message
-<br>
-<br>
+<dt>NOTICE: message
+<dd style="margin-left: 5.0em"><br>
Sets the printer-state-message attribute and adds the specified
message to the current <i>ErrorLog</i> using the "notice" log level.
-<p style="margin-left: 5.0em; text-indent: -5.0em">WARNING: message
-<br>
-<br>
+<dt>WARNING: message
+<dd style="margin-left: 5.0em"><br>
Sets the printer-state-message attribute and adds the specified
message to the current <i>ErrorLog</i> using the "warning" log level.
+</dl>
<h2 class="title"><a name="ENVIRONMENT_VARIABLES">Environment Variables</a></h2>
The following environment variables are defined by the CUPS server when
executing the notifier:
-<p style="margin-left: 5.0em; text-indent: -5.0em">CHARSET
-<br>
-<br>
+<dl class="man">
+<dt>CHARSET
+<dd style="margin-left: 5.0em"><br>
The default text character set, typically utf-8.
-<p style="margin-left: 5.0em; text-indent: -5.0em">CUPS_CACHEDIR
-<br>
-<br>
+<dt>CUPS_CACHEDIR
+<dd style="margin-left: 5.0em"><br>
The directory for semi-persistent cache files can be found.
-<p style="margin-left: 5.0em; text-indent: -5.0em">CUPS_DATADIR
-<br>
-<br>
+<dt>CUPS_DATADIR
+<dd style="margin-left: 5.0em"><br>
The directory where data files can be found.
-<p style="margin-left: 5.0em; text-indent: -5.0em">CUPS_FILETYPE
-<br>
-<br>
+<dt>CUPS_FILETYPE
+<dd style="margin-left: 5.0em"><br>
The type of file being printed: "job-sheet" for a banner page and "document"
for a regular print file.
-<p style="margin-left: 5.0em; text-indent: -5.0em">CUPS_SERVERROOT
-<br>
-<br>
+<dt>CUPS_SERVERROOT
+<dd style="margin-left: 5.0em"><br>
The root directory of the server.
-<p style="margin-left: 5.0em; text-indent: -5.0em">LANG
-<br>
-<br>
+<dt>LANG
+<dd style="margin-left: 5.0em"><br>
The default language locale (typically C or en).
-<p style="margin-left: 5.0em; text-indent: -5.0em">PATH
-<br>
-<br>
+<dt>PATH
+<dd style="margin-left: 5.0em"><br>
The standard execution path for external programs that may be run by
the filter.
-<p style="margin-left: 5.0em; text-indent: -5.0em">SOFTWARE
-<br>
-<br>
+<dt>SOFTWARE
+<dd style="margin-left: 5.0em"><br>
The name and version number of the server (typically CUPS/1.2).
-<p style="margin-left: 5.0em; text-indent: -5.0em">TZ
-<br>
-<br>
+<dt>TZ
+<dd style="margin-left: 5.0em"><br>
The timezone of the server.
-<p style="margin-left: 5.0em; text-indent: -5.0em">USER
-<br>
-<br>
+<dt>USER
+<dd style="margin-left: 5.0em"><br>
The user executing the filter, typically "lp"; consult the <i>cupsd.conf(5)</i>
file for the current setting.
+</dl>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
<i>backend(7)</i>, <i>cupsd(8)</i>, <i>filter(7)</i>,
<br>
<p>Directives may be placed anywhere on a line and are followed by
one or more values. The following is a list of the available
directives and the values they accept:
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>#define</b> name value
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>#elif</b> {name | value}
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>#else</b>
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>#endif</b>
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>#font</b> name encoding "version" charset status
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>#if</b> {name | value}
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>#include</b> <filename>
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>#include</b> "filename"
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>#media</b> name width length
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>#media</b> "name/text" width length
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>#po</b> locale "filename.po"
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>Attribute</b> name "" value
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>Attribute</b> name keyword value
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>Attribute</b> name "keyword/text" value
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>Choice</b> name "code"
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>Choice</b> "name/text" "code"
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>ColorDevice</b> boolean-value
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>ColorModel</b> name colorspace colororder compression
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>ColorModel</b> "name/text" colorspace colororder compression
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>ColorProfile</b> resolution/mediatype gamma density matrix
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>Copyright</b> "text"
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>CustomMedia</b> name width length left bottom right top "size-code" "region-code"
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>CustomMedia</b> "name/text" width length left bottom right top "size-code" "region-code"
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>Cutter</b> boolean-value
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>Darkness</b> temperature name
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>Darkness</b> temperature "name/text"
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>DriverType</b> type
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>Duplex</b> type
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>Filter</b> mime-type cost program
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>Finishing</b> name
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>Finishing</b> "name/text"
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>Font</b> *
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>Font</b> name encoding "version" charset status
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>Group</b> name
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>Group</b> "name/text"
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>HWMargins</b> left bottom right top
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>InputSlot</b> position name
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>InputSlot</b> position "name/text"
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>Installable</b> name
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>Installable</b> "name/text"
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>LocAttribute</b> name "keyword/text" value
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>ManualCopies</b> boolean-value
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>Manufacturer</b> "name"
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>MaxSize</b> width length
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>MediaSize</b> name
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>MediaType</b> type name
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>MediaType</b> type "name/text"
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>MinSize</b> width length
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>ModelName</b> "name"
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>ModelNumber</b> number
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>Option</b> name type section order
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>Option</b> "name/text" type section order
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>PCFileName</b> "filename.ppd"
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>Resolution</b> colorspace bits-per-color row-count row-feed row-step name
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>Resolution</b> colorspace bits-per-color row-count row-feed row-step "name/text"
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>SimpleColorProfile</b> resolution/mediatype density yellow-density red-density gamma red-adjust green-adjust blue-adjust
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>Throughput</b> pages-per-minute
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>UIConstraints</b> "*Option1 *Option2"
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>UIConstraints</b> "*Option1 Choice1 *Option2"
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>UIConstraints</b> "*Option1 *Option2 Choice2"
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>UIConstraints</b> "*Option1 Choice1 *Option2 Choice2"
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>VariablePaperSize</b> boolean-value
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><b>Version</b> number
-<br>
+<dl class="man">
+<dt><b>#define</b> name value
+<dd style="margin-left: 5.0em"><dt><b>#elif</b> {name | value}
+<dd style="margin-left: 5.0em"><dt><b>#else</b>
+<dd style="margin-left: 5.0em"><dt><b>#endif</b>
+<dd style="margin-left: 5.0em"><dt><b>#font</b> name encoding "version" charset status
+<dd style="margin-left: 5.0em"><dt><b>#if</b> {name | value}
+<dd style="margin-left: 5.0em"><dt><b>#include</b> <filename>
+<dd style="margin-left: 5.0em"><dt><b>#include</b> "filename"
+<dd style="margin-left: 5.0em"><dt><b>#media</b> name width length
+<dd style="margin-left: 5.0em"><dt><b>#media</b> "name/text" width length
+<dd style="margin-left: 5.0em"><dt><b>#po</b> locale "filename.po"
+<dd style="margin-left: 5.0em"><dt><b>Attribute</b> name "" value
+<dd style="margin-left: 5.0em"><dt><b>Attribute</b> name keyword value
+<dd style="margin-left: 5.0em"><dt><b>Attribute</b> name "keyword/text" value
+<dd style="margin-left: 5.0em"><dt><b>Choice</b> name "code"
+<dd style="margin-left: 5.0em"><dt><b>Choice</b> "name/text" "code"
+<dd style="margin-left: 5.0em"><dt><b>ColorDevice</b> boolean-value
+<dd style="margin-left: 5.0em"><dt><b>ColorModel</b> name colorspace colororder compression
+<dd style="margin-left: 5.0em"><dt><b>ColorModel</b> "name/text" colorspace colororder compression
+<dd style="margin-left: 5.0em"><dt><b>ColorProfile</b> resolution/mediatype gamma density matrix
+<dd style="margin-left: 5.0em"><dt><b>Copyright</b> "text"
+<dd style="margin-left: 5.0em"><dt><b>CustomMedia</b> name width length left bottom right top "size-code" "region-code"
+<dd style="margin-left: 5.0em"><dt><b>CustomMedia</b> "name/text" width length left bottom right top "size-code" "region-code"
+<dd style="margin-left: 5.0em"><dt><b>Cutter</b> boolean-value
+<dd style="margin-left: 5.0em"><dt><b>Darkness</b> temperature name
+<dd style="margin-left: 5.0em"><dt><b>Darkness</b> temperature "name/text"
+<dd style="margin-left: 5.0em"><dt><b>DriverType</b> type
+<dd style="margin-left: 5.0em"><dt><b>Duplex</b> type
+<dd style="margin-left: 5.0em"><dt><b>Filter</b> mime-type cost program
+<dd style="margin-left: 5.0em"><dt><b>Finishing</b> name
+<dd style="margin-left: 5.0em"><dt><b>Finishing</b> "name/text"
+<dd style="margin-left: 5.0em"><dt><b>Font</b> *
+<dd style="margin-left: 5.0em"><dt><b>Font</b> name encoding "version" charset status
+<dd style="margin-left: 5.0em"><dt><b>Group</b> name
+<dd style="margin-left: 5.0em"><dt><b>Group</b> "name/text"
+<dd style="margin-left: 5.0em"><dt><b>HWMargins</b> left bottom right top
+<dd style="margin-left: 5.0em"><dt><b>InputSlot</b> position name
+<dd style="margin-left: 5.0em"><dt><b>InputSlot</b> position "name/text"
+<dd style="margin-left: 5.0em"><dt><b>Installable</b> name
+<dd style="margin-left: 5.0em"><dt><b>Installable</b> "name/text"
+<dd style="margin-left: 5.0em"><dt><b>LocAttribute</b> name "keyword/text" value
+<dd style="margin-left: 5.0em"><dt><b>ManualCopies</b> boolean-value
+<dd style="margin-left: 5.0em"><dt><b>Manufacturer</b> "name"
+<dd style="margin-left: 5.0em"><dt><b>MaxSize</b> width length
+<dd style="margin-left: 5.0em"><dt><b>MediaSize</b> name
+<dd style="margin-left: 5.0em"><dt><b>MediaType</b> type name
+<dd style="margin-left: 5.0em"><dt><b>MediaType</b> type "name/text"
+<dd style="margin-left: 5.0em"><dt><b>MinSize</b> width length
+<dd style="margin-left: 5.0em"><dt><b>ModelName</b> "name"
+<dd style="margin-left: 5.0em"><dt><b>ModelNumber</b> number
+<dd style="margin-left: 5.0em"><dt><b>Option</b> name type section order
+<dd style="margin-left: 5.0em"><dt><b>Option</b> "name/text" type section order
+<dd style="margin-left: 5.0em"><dt><b>PCFileName</b> "filename.ppd"
+<dd style="margin-left: 5.0em"><dt><b>Resolution</b> colorspace bits-per-color row-count row-feed row-step name
+<dd style="margin-left: 5.0em"><dt><b>Resolution</b> colorspace bits-per-color row-count row-feed row-step "name/text"
+<dd style="margin-left: 5.0em"><dt><b>SimpleColorProfile</b> resolution/mediatype density yellow-density red-density gamma red-adjust green-adjust blue-adjust
+<dd style="margin-left: 5.0em"><dt><b>Throughput</b> pages-per-minute
+<dd style="margin-left: 5.0em"><dt><b>UIConstraints</b> "*Option1 *Option2"
+<dd style="margin-left: 5.0em"><dt><b>UIConstraints</b> "*Option1 Choice1 *Option2"
+<dd style="margin-left: 5.0em"><dt><b>UIConstraints</b> "*Option1 *Option2 Choice2"
+<dd style="margin-left: 5.0em"><dt><b>UIConstraints</b> "*Option1 Choice1 *Option2 Choice2"
+<dd style="margin-left: 5.0em"><dt><b>VariablePaperSize</b> boolean-value
+<dd style="margin-left: 5.0em"><dt><b>Version</b> number
+<dd style="margin-left: 5.0em"></dl>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
ppdc(1), ppdhtml(1), ppdi(1), ppdmerge(1), ppdpo(1)
<br>
]
<i>ppd-file</i>
[
-<i>ppd-file2</i><i>...</i> <i>ppd-fileN</i>
+<i>ppd-file2</i><i>...</i><i>ppd-fileN</i>
]
<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
<i>ppdi</i> imports one or more PPD files into a PPD compiler source file.
<i>ppd-file</i>
<i>ppd-file2</i>
[
-<i>...</i> <i>ppd-fileN</i>
+<i>...</i><i>ppd-fileN</i>
]
<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
<i>ppdmerge</i> merges two or more PPD files into a single, multi-language
<p>Each line in the file can be a configuration directive, a blank line,
or a comment. Comment lines start with the # character.
<h2 class="title"><a name="DIRECTIVES">Directives</a></h2>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><Printer name> ... </Printer>
-<br>
-<br>
+<dl class="man">
+<dt><Printer name> ... </Printer>
+<dd style="margin-left: 5.0em"><br>
Defines a specific printer.
-<p style="margin-left: 5.0em; text-indent: -5.0em"><DefaultPrinter name> ... </Printer>
-<br>
-<br>
+<dt><DefaultPrinter name> ... </Printer>
+<dd style="margin-left: 5.0em"><br>
Defines a default printer.
-<p style="margin-left: 5.0em; text-indent: -5.0em">Accepting Yes
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">Accepting No
-<br>
-<br>
+<dt>Accepting Yes
+<dd style="margin-left: 5.0em"><dt>Accepting No
+<dd style="margin-left: 5.0em"><br>
Specifies whether the printer is accepting new jobs.
-<p style="margin-left: 5.0em; text-indent: -5.0em">AllowUser [ user @group ... ]
-<br>
-<br>
+<dt>AllowUser [ user @group ... ]
+<dd style="margin-left: 5.0em"><br>
Allows specific users and groups to print to the printer.
-<p style="margin-left: 5.0em; text-indent: -5.0em">DenyUser [ user @group ... ]
-<br>
-<br>
+<dt>DenyUser [ user @group ... ]
+<dd style="margin-left: 5.0em"><br>
Prevents specific users and groups from printing to the printer.
-<p style="margin-left: 5.0em; text-indent: -5.0em">DeviceURI uri
-<br>
-<br>
+<dt>DeviceURI uri
+<dd style="margin-left: 5.0em"><br>
Specifies the device URI for a printer.
-<p style="margin-left: 5.0em; text-indent: -5.0em">ErrorPolicy abort-job
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">ErrorPolicy retry-current-job
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">ErrorPolicy retry-job
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">ErrorPolicy stop-printer
-<br>
-<br>
+<dt>ErrorPolicy abort-job
+<dd style="margin-left: 5.0em"><dt>ErrorPolicy retry-current-job
+<dd style="margin-left: 5.0em"><dt>ErrorPolicy retry-job
+<dd style="margin-left: 5.0em"><dt>ErrorPolicy stop-printer
+<dd style="margin-left: 5.0em"><br>
Specifies the error policy for the printer.
-<p style="margin-left: 5.0em; text-indent: -5.0em">Info text
-<br>
-<br>
+<dt>Info text
+<dd style="margin-left: 5.0em"><br>
Specifies human-readable text describing the printer.
-<p style="margin-left: 5.0em; text-indent: -5.0em">JobSheets banner banner
-<br>
-<br>
+<dt>JobSheets banner banner
+<dd style="margin-left: 5.0em"><br>
Specifies the banner pages to use for the printer.
-<p style="margin-left: 5.0em; text-indent: -5.0em">KLimit number
-<br>
-<br>
+<dt>KLimit number
+<dd style="margin-left: 5.0em"><br>
Specifies the job-k-limit value for the printer.
-<p style="margin-left: 5.0em; text-indent: -5.0em">Location text
-<br>
-<br>
+<dt>Location text
+<dd style="margin-left: 5.0em"><br>
Specifies human-readable text describing the location of the printer.
-<p style="margin-left: 5.0em; text-indent: -5.0em">OpPolicy name
-<br>
-<br>
+<dt>OpPolicy name
+<dd style="margin-left: 5.0em"><br>
Specifies the operation policy for the printer.
-<p style="margin-left: 5.0em; text-indent: -5.0em">PageLimit number
-<br>
-<br>
+<dt>PageLimit number
+<dd style="margin-left: 5.0em"><br>
Specifies the job-page-limit value for the printer.
-<p style="margin-left: 5.0em; text-indent: -5.0em">PortMonitor monitor
-<br>
-<br>
+<dt>PortMonitor monitor
+<dd style="margin-left: 5.0em"><br>
Specifies the port monitor for a printer.
-<p style="margin-left: 5.0em; text-indent: -5.0em">QuotaPeriod seconds
-<br>
-<br>
+<dt>QuotaPeriod seconds
+<dd style="margin-left: 5.0em"><br>
Specifies the job-quota-period value for the printer.
-<p style="margin-left: 5.0em; text-indent: -5.0em">Shared Yes
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">Shared No
-<br>
-<br>
+<dt>Shared Yes
+<dd style="margin-left: 5.0em"><dt>Shared No
+<dd style="margin-left: 5.0em"><br>
Specifies whether the printer is shared.
-<p style="margin-left: 5.0em; text-indent: -5.0em">State idle
-<br>
-<p style="margin-left: 5.0em; text-indent: -5.0em">State stopped
-<br>
-<br>
+<dt>State idle
+<dd style="margin-left: 5.0em"><dt>State stopped
+<dd style="margin-left: 5.0em"><br>
Specifies the initial state of the printer (Idle or Stopped)
-<p style="margin-left: 5.0em; text-indent: -5.0em">StateMessage text
-<br>
-<br>
+<dt>StateMessage text
+<dd style="margin-left: 5.0em"><br>
Specifies the message associated with the state.
-<p style="margin-left: 5.0em; text-indent: -5.0em">StateTime seconds
-<br>
-<br>
+<dt>StateTime seconds
+<dd style="margin-left: 5.0em"><br>
Specifies the date/time associated with the state.
+</dl>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
<i>classes.conf(5)</i>, <i>cupsd(8)</i>, <i>cupsd.conf(5)</i>,
<i>mime.convs(5)</i>, <i>mime.types(5)</i>,
<p>Each line in the file can be a configuration directive, a blank line,
or a comment. Comment lines start with the # character.
<h2 class="title"><a name="DIRECTIVES">Directives</a></h2>
-<p style="margin-left: 5.0em; text-indent: -5.0em"><Subscription NNN> ... </Subscription>
-<br>
-<br>
+<dl class="man">
+<dt><Subscription NNN> ... </Subscription>
+<dd style="margin-left: 5.0em"><br>
Defines a subscription.
-<p style="margin-left: 5.0em; text-indent: -5.0em">Events name [ ... name ]
-<br>
-<br>
+<dt>Events name [ ... name ]
+<dd style="margin-left: 5.0em"><br>
Specifies the events that are subscribed.
-<p style="margin-left: 5.0em; text-indent: -5.0em">ExpirationTime unix-time
-<br>
-<br>
+<dt>ExpirationTime unix-time
+<dd style="margin-left: 5.0em"><br>
Specifies the expiration time of a subscription as a UNIX time
value in seconds since January 1st, 1970.
-<p style="margin-left: 5.0em; text-indent: -5.0em">Interval seconds
-<br>
-<br>
+<dt>Interval seconds
+<dd style="margin-left: 5.0em"><br>
Specifies the preferred time interval for event notifications in
seconds.
-<p style="margin-left: 5.0em; text-indent: -5.0em">JobId job-id
-<br>
-<br>
+<dt>JobId job-id
+<dd style="margin-left: 5.0em"><br>
Specifies the job ID associated with the subscription.
-<p style="margin-left: 5.0em; text-indent: -5.0em">LeaseDuration seconds
-<br>
-<br>
+<dt>LeaseDuration seconds
+<dd style="margin-left: 5.0em"><br>
Specifies the number of seconds that the subscription is valid
for. If 0, the subscription does not expire.
-<p style="margin-left: 5.0em; text-indent: -5.0em">NextEventId number
-<br>
-<br>
+<dt>NextEventId number
+<dd style="margin-left: 5.0em"><br>
Specifies the next notify-sequence-number to use for the
subscription.
-<p style="margin-left: 5.0em; text-indent: -5.0em">NextSubscriptionId number
-<br>
-<br>
+<dt>NextSubscriptionId number
+<dd style="margin-left: 5.0em"><br>
Specifies the next subscription-id to use.
-<p style="margin-left: 5.0em; text-indent: -5.0em">Owner username
-<br>
-<br>
+<dt>Owner username
+<dd style="margin-left: 5.0em"><br>
Specifies the user that owns the subscription.
-<p style="margin-left: 5.0em; text-indent: -5.0em">PrinterName printername
-<br>
-<br>
+<dt>PrinterName printername
+<dd style="margin-left: 5.0em"><br>
Specifies the printer or class associated with the subscription.
-<p style="margin-left: 5.0em; text-indent: -5.0em">Recipient uri
-<br>
-<br>
+<dt>Recipient uri
+<dd style="margin-left: 5.0em"><br>
Specifies the notify-recipient-uri value for push-type notifications.
-<p style="margin-left: 5.0em; text-indent: -5.0em">UserData hex-escaped-data
-<br>
-<br>
+<dt>UserData hex-escaped-data
+<dd style="margin-left: 5.0em"><br>
Specifies user data to be included in event notifications. This
is typically the "from" address in mailto: notifications.
+</dl>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
<i>classes.conf(5)</i>, <i>cupsd(8)</i>, <i>cupsd.conf(5)</i>,
<i>mime.convs(5)</i>, <i>mime.types(5)</i>, printers.conf(5)
.B CUPS
removes the job from the queue and moves on to any other jobs you have submitted. You can also be notified when the job is finished, or if there are any errors during printing, in several different ways.
.SS WHERE DO I BEGIN?
-The easiest way to start is by using the
-.B CUPS
-web interface to configure your printer. Go to "http://localhost:631" and choose the Administration tab at the top of the page. Click/press on the Add Printer button and follow the prompts.
+The easiest way to start is by using the web interface to configure your printer. Go to "http://localhost:631" and choose the Administration tab at the top of the page. Click/press on the Add Printer button and follow the prompts.
.LP
When you are asked for a username and password, enter your login username and password or the "root" username and password.
.LP
-After the printer is added,
-.B CUPS
-will ask you to set the default printer options (paper size, output mode, etc.) for the printer. Make any changes as needed and then click on the Set Default Options button to save them. Some printers also support auto-configuration - click on the Query Printer for Default Options button to update the options automatically.
+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.
.LP
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.
.LP
The
.B CUPS
web site (http://www.CUPS.org) provides access to the
-.B CUPS
-user mailing list, additional documentation and resources, and a bug report database. Most vendors also provide online discussion forums to ask printing questions for your operating system of choice.
+.I cups
+and
+.I cups-devel
+mailing lists, additional documentation and resources, and a bug report database. Most vendors also provide online discussion forums to ask printing questions for your operating system of choice.
.SH ENVIRONMENT
.B CUPS
commands use the following environment variables to override the default locations of files and so forth. For security reasons, these environment variables are ignored for setuid programs:
.TP 5
-CUPS_SERVER
-The hostname/IP address and port number of the CUPS scheduler (hostname:port or ipaddress:port).
-.TP 5
-CUPS_ANYROOT
+.B CUPS_ANYROOT
Whether to allow any X.509 certificate root (Y or N).
.TP 5
-CUPS_CACHEDIR
+.B CUPS_CACHEDIR
The directory where semi-persistent cache files can be found.
.TP 5
-CUPS_DATADIR
+.B CUPS_DATADIR
The directory where data files can be found.
.TP 5
-CUPS_ENCRYPTION
+.B CUPS_ENCRYPTION
The default level of encryption (Always, IfRequested, Never, Required).
.TP 5
-CUPS_EXPIREDROOT
+.B CUPS_EXPIREDROOT
Whether to allow expired X.509 certificate roots (Y or N).
.TP 5
-CUPS_EXPIREDCERTS
+.B CUPS_EXPIREDCERTS
Whether to allow expired X.509 certificates (Y or N).
.TP 5
-CUPS_GSSSERVICENAME
+.B CUPS_GSSSERVICENAME
The Kerberos service name used for authentication.
.TP 5
-CUPS_SERVERBIN
+.B CUPS_SERVER
+The hostname/IP address and port number of the CUPS scheduler (hostname:port or ipaddress:port).
+.TP 5
+.B CUPS_SERVERBIN
The directory where server helper programs, filters, backend, etc. can be found.
.TP 5
-CUPS_SERVERROOT
+.B CUPS_SERVERROOT
The root directory of the server.
.TP 5
-CUPS_STATEDIR
+.B CUPS_STATEDIR
The directory where state files can be found.
.TP 5
-CUPS_USER
+.B CUPS_USER
Specifies the name of the user for print requests.
.TP 5
-HOME
+.B HOME
Specifies the home directory of the current user.
.TP 5
-IPP_PORT
+.B IPP_PORT
Specifies the default port number for IPP requests.
.TP 5
-LOCALEDIR
+.B LOCALEDIR
Specifies the location of localization files.
.TP 5
-LPDEST
+.B LPDEST
Specifies the default print queue (System V standard).
.TP 5
-PRINTER
+.B PRINTER
Specifies the default print queue (Berkeley standard).
.TP 5
-TMPDIR
+.B TMPDIR
Specifies the location of temporary files.
.SH FILES
-~/.cups/client.conf, ~/.cups/lpoptions
+.nf
+.I ~/.cups/client.conf
+.I ~/.cups/lpoptions
+.fi
.SH CONFORMING TO
.B CUPS
conforms to the Internet Printing Protocol version 2.1 and implements the Berkeley and System V UNIX print commands.
.SH SEE ALSO
-.BR cancel (1), client.conf (7), cupsctl (8), cupsd (8), lp (1), lpadmin (8), lpinfo (8), lpoptions (1), lpr (1), lprm (1), lpq (1), lpstat (1),
-http://localhost:631/help,
-http://www.CUPS.org,
-http://www.pwg.org/ipp
+.BR cancel (1),
+.BR client.conf (7),
+.BR cupsctl (8),
+.BR cupsd (8),
+.BR lp (1),
+.BR lpadmin (8),
+.BR lpinfo (8),
+.BR lpoptions (1),
+.BR lpr (1),
+.BR lprm (1),
+.BR lpq (1),
+.BR lpstat (1),
+CUPS Online Help (http://localhost:631/help),
+CUPS Web Site (http://www.CUPS.org),
+PWG Internet Printing Protocol Workgroup (http://www.pwg.org/ipp)
.SH COPYRIGHT
Copyright \[co] 2007-2014 by Apple Inc.
.\"
.I cupsd.conf
file configures the CUPS scheduler,
.BR cupsd (8).
-It is normally located in the \fI/etc/cups\fR directory. \fBNote:\fR File, directory, and user configuration directives that used to be allowed in the \fIcupsd.conf\fR file are now stored in the \fIcups-files.conf(5)\fR instead in order to prevent certain types of privilege escalation attacks.
+It is normally located in the
+.I /etc/cups
+directory. \fBNote:\fR File, directory, and user configuration directives that used to be allowed in the \fIcupsd.conf\fR file are now stored in the \fIcups-files.conf(5)\fR instead in order to prevent certain types of privilege escalation attacks.
.LP
Each line in the file can be a configuration directive, a blank line, or a comment. Comment lines start with the # character. The configuration directives are intentionally similar to those used by the popular Apache web server software and are described below.
.SH TOP-LEVEL DIRECTIVES
.\" which should have been included with this file. If this file is
.\" file is missing or damaged, see the license at "http://www.cups.org/".
.\"
-.TH cupsd 8 "CUPS" "4 March 2014" "Apple Inc."
+.TH cupsd 8 "CUPS" "3 April 2014" "Apple Inc."
.SH NAME
cupsd \- cups scheduler
.SH SYNOPSIS
.B cupsd
-[ -c
+[
+.B \-c
.I config-file
-] [ -f ] [ -F ] [ -h ] [ -l ] [ -t ]
+] [
+.B \-f
+] [
+.B \-F
+] [
+.B \-h
+] [
+.B -l
+] [
+.B -t
+]
.SH DESCRIPTION
.B cupsd
is the scheduler for CUPS. It implements a printing system based upon the Internet Printing Protocol, version 2.1. If no options are specified on the command-line then the default configuration file
will be used.
.SH OPTIONS
.TP 5
--c config-file
+.BI \-c \ config-file
Uses the named configuration file.
.TP 5
--f
+.B \-f
Run
.B cupsd
in the foreground; the default is to run in the background as a "daemon".
.TP 5
--F
+.B \-F
Run
.B cupsd
in the foreground but detach the process from the controlling terminal and current directory. This is useful for running
-.BR cupsd from init (8).
+.B cupsd
+from
+.BR init (8).
.TP 5
--h
+.B \-h
Shows the program usage.
.TP 5
--l
+.B \-l
This option is passed to
.B cupsd
when it is run from
-.BR launchd (8).
+.BR launchd (8)
+or
+.BR systemd (8).
.TP 5
--t
+.B \-t
Test the configuration file for syntax errors.
-.SH COMPATIBILITY
+.SH FILES
+.nf
+.I /etc/cups/classes.conf
+.I /etc/cups/cups-files.conf
+.I /etc/cups/cupsd.conf
+.I /usr/share/cups/mime/mime.convs
+.I /usr/share/cups/mime/mime.types
+.I /etc/cups/printers.conf
+.fi
+.SH CONFORMING TO
+.B cupsd
+implements all of the required IPP/2.1 attributes and operations. It also implements several CUPS-specific administrative operations.
+.SH EXAMPLES
+Run
+.B cupsd
+in the background with the default configuration file:
+.nf
+
+ cupsd
+
+.fi
+Test a configuration file called
+.IR test.conf :
+.nf
+
+ cupsd \-t \-c test.conf
+
+.fi
+Run
.B cupsd
-implements all of the required IPP/2.1 attributes and operations. It also implements several CUPS-specific administration operations.
+in the foreground with a test configuration file called
+.IR test.conf :
+.nf
+
+ cupsd \-f \-c test.conf
+
+.fi
.SH SEE ALSO
-.BR backend (7), classes.conf (5), cups-deviced (8), cups-driverd (8), cups-lpd (8), cupsd.conf (5), filter (7), launchd (8), mime.convs (5), mime.types (5), printers.conf (5),
-http://localhost:631/help
+.BR backend (7),
+.BR classes.conf (5),
+.BR cups (1),
+.BR cups-deviced (8),
+.BR cups-driverd (8),
+.BR cups-lpd (8),
+.BR cupsd.conf (5),
+.BR filter (7),
+.BR launchd (8),
+.BR mime.convs (5),
+.BR mime.types (5),
+.BR printers.conf (5),
+.BR systemd (8),
+CUPS Online Help (http://localhost:631/help)
.SH COPYRIGHT
Copyright \[co] 2007-2014 by Apple Inc.
.\"
*outfile; /* Output file */
char line[1024], /* Line from file */
*lineptr, /* Pointer into line */
- name[1024]; /* Man page name */
+ name[1024], /* Man page name */
+ ddpost[256]; /* Tagged list post markup */
int section = -1, /* Man page section */
pre = 0, /* Preformatted */
font = 0, /* Current font */
font = 0;
html_alternate(line + 3, "b", "b", outfile);
+
+ if (post)
+ {
+ fputs(post, outfile);
+ post = NULL;
+ }
}
else if (!strncmp(line, ".I ", 3))
{
font = 0;
html_alternate(line + 3, "i", "i", outfile);
+
+ if (post)
+ {
+ fputs(post, outfile);
+ post = NULL;
+ }
}
else if (!strncmp(line, ".BI ", 4))
{
font = 0;
html_alternate(line + 4, "b", "i", outfile);
+
+ if (post)
+ {
+ fputs(post, outfile);
+ post = NULL;
+ }
}
else if (!strncmp(line, ".BR ", 4))
{
font = 0;
html_alternate(line + 4, "b", NULL, outfile);
+
+ if (post)
+ {
+ fputs(post, outfile);
+ post = NULL;
+ }
}
else if (!strncmp(line, ".IB ", 4))
{
font = 0;
html_alternate(line + 4, "i", "b", outfile);
+
+ if (post)
+ {
+ fputs(post, outfile);
+ post = NULL;
+ }
}
else if (!strncmp(line, ".IR ", 4))
{
font = 0;
html_alternate(line + 4, "i", NULL, outfile);
+
+ if (post)
+ {
+ fputs(post, outfile);
+ post = NULL;
+ }
}
else if (!strncmp(line, ".RB ", 4))
{
font = 0;
html_alternate(line + 4, NULL, "b", outfile);
+
+ if (post)
+ {
+ fputs(post, outfile);
+ post = NULL;
+ }
}
else if (!strncmp(line, ".RI ", 4))
{
font = 0;
html_alternate(line + 4, NULL, "i", outfile);
+
+ if (post)
+ {
+ fputs(post, outfile);
+ post = NULL;
+ }
}
else if (!strncmp(line, ".SB ", 4))
{
font = 0;
html_alternate(line + 4, "small", "b", outfile);
+
+ if (post)
+ {
+ fputs(post, outfile);
+ post = NULL;
+ }
}
else if (!strncmp(line, ".SM ", 4))
{
font = 0;
html_alternate(line + 4, "small", "small", outfile);
+
+ if (post)
+ {
+ fputs(post, outfile);
+ post = NULL;
+ }
}
else if (!strcmp(line, ".LP") || !strcmp(line, ".PP") || !strcmp(line, ".P"))
{
fputs("</div>\n", outfile);
}
- else if (!strcmp(line, ".HP") || !strncmp(line, ".HP ", 4) ||
- !strcmp(line, ".TP") || !strncmp(line, ".TP ", 4))
+ else if (!strcmp(line, ".HP") || !strncmp(line, ".HP ", 4))
{
/*
- * Hanging paragraph/tagged list...
+ * Hanging paragraph...
*
* .HP i
- * .TP i
*/
float amount = 3.0; /* Indentation */
if (line[1] == 'T')
post = "<br>\n";
}
+ else if (!strcmp(line, ".TP") || !strncmp(line, ".TP ", 4))
+ {
+ /*
+ * Tagged list...
+ *
+ * .TP i
+ */
+
+ float amount = 3.0; /* Indentation */
+
+ if (line[3])
+ amount = atof(line + 4);
+
+ fputs(end_fonts[font], outfile);
+ font = 0;
+
+ if (list && strcmp(list, "dl"))
+ {
+ fprintf(outfile, "</%s>\n", list);
+ list = NULL;
+ }
+
+ if (!list)
+ {
+ fputs("<dl class=\"man\">\n", outfile);
+ list = "dl";
+ }
+
+ fputs("<dt>", outfile);
+ snprintf(ddpost, sizeof(ddpost), "<dd style=\"margin-left: %.1fem\">", amount);
+ post = ddpost;
+ }
else if (!strncmp(line, ".IP ", 4))
{
/*
* Ignore unused commands...
*/
}
- else if (!strncmp(line, ".Vb", 3) || !strncmp(line, ".nf", 3))
+ else if (!strncmp(line, ".Vb", 3) || !strncmp(line, ".nf", 3) || !strncmp(line, ".EX", 3))
{
/*
* Start preformatted...
}
pre = 1;
- fputs("<pre>\n", outfile);
+ fputs("<pre class=\"man\">\n", outfile);
}
- else if (!strncmp(line, ".Ve", 3) || !strncmp(line, ".fi", 3))
+ else if (!strncmp(line, ".Ve", 3) || !strncmp(line, ".fi", 3) || !strncmp(line, ".EE", 3))
{
/*
* End preformatted...
while (isspace(*s & 255))
s ++;
-
- if (*s && *s != '(' && *s != '.' && *s != ',')
- putc(' ', fp);
}
putc('\n', fp);
break;
}
}
+ else if (*s == '(')
+ {
+ if (!strncmp(s, "(em", 3))
+ {
+ fputs("—", fp);
+ s += 3;
+ }
+ else if (!strncmp(s, "(en", 3))
+ {
+ fputs("–", fp);
+ s += 3;
+ }
+ else
+ {
+ putc(*s, fp);
+ s ++;
+ }
+ }
else if (*s == '[')
{
/*
projects / thirdparty / cups.git / commitdiff
