- Added new `cupsGetClock` API.
- Added new `cupsParseOptions2` API with "end" argument.
- Added `cups-oauth` and `cups-x509` utilities (Issue #1184)
+- Added `DNSSDComputerName` directive to "cupsd.conf" and updated cupsd to
+ correctly update the mDNS hostname only if the `DNSSDHostName` directive is
+ not specified (Issue #1217)
- Updated documentation (Issue #984, Issue #1086, Issue #1182)
- Updated translations (Issue #1146, Issue #1161, Issue #1164)
- Updated the configure script to default to installing to /usr/local.
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>BrowseDNSSDSubTypes</strong><em>_subtype[,...]</em>
<br>
-Specifies a list of Bonjour sub-types to advertise for each shared printer.
-For example, "BrowseDNSSDSubTypes _cups,_print" will tell network clients that both CUPS sharing and IPP Everywhere are supported.
-The default is "_cups" which is necessary for printer sharing to work between systems using CUPS.
+Specifies the DNS-SD sub-types to advertise, separated by commas.
+The default is "_cups,_print,_universal" to advertise shared printers to CUPS, IPP Everywhere, and AirPrint clients, respectively.
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>BrowseLocalProtocols all</strong><br>
</p>
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>BrowseLocalProtocols none</strong><br>
Specifies which protocols to use for local printer sharing.
-The default is "dnssd" on systems that support Bonjour and "none" otherwise.
+The default is "dnssd" on systems that support DNS-SD and "none" otherwise.
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>BrowseWebIF Yes</strong><br>
</p>
Specifies whether encryption will be used for authenticated requests.
The default is "Required".
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>DefaultLanguage </strong><em>locale</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>DefaultLanguage </strong><em>LOCALE</em><br>
Specifies the default language to use for text and web content.
The default is "en".
</p>
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>DefaultPaperSize None</strong><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>DefaultPaperSize </strong><em>sizename</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>DefaultPaperSize </strong><em>SIZENAME</em><br>
Specifies the default paper size for new print queues. "Auto" uses a locale-specific default, while "None" specifies there is no default paper size.
Specific size names are typically "Letter" or "A4".
The default is "Auto".
Note: The default paper size must use a size name from the PPD file and not a PWG self-describing media size name.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>DefaultPolicy </strong><em>policy-name</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>DefaultPolicy </strong><em>POLICY-NAME</em><br>
Specifies the default access policy to use.
The default access policy is "default".
</p>
Specifies whether local printers are shared by default.
The default is "Yes".
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>DirtyCleanInterval </strong><em>seconds</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>DirtyCleanInterval </strong><em>SECONDS</em><br>
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.
The default value is "30".
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>DNSSDHostName</strong><em>hostname.example.com</em>
-<br>
-Specifies the fully-qualified domain name for the server that is used for Bonjour sharing.
-The default is typically the server's ".local" hostname.
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>DNSSDComputerName none</strong><br>
+</p>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>DNSSDComputerName "</strong><em>COMPUTER-NAME</em>"<br>
+Specifies the human readable computer name that is appended to any shared printer names, for example "My Printer @ Bob's Computer".
+The default is OS-specific and follows any system naming changes.
+The value "none" disables the "@ Computer Name" suffix added to shared printer names.
+</p>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>DNSSDHostName </strong><em>HOSTNAME</em><br>
+Specifies the fully-qualified domain name for the server that is used for DNS-SD sharing.
+The default is typically the server's ".local" hostname and is updated whenever that hostname changes.
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>ErrorPolicy abort-job</strong><br>
Specifies that a failed print job should be aborted (discarded) unless otherwise specified for the printer.
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>ErrorPolicy stop-printer</strong><br>
Specifies that a failed print job should stop the printer unless otherwise specified for the printer. The 'stop-printer' error policy is the default.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>FilterLimit </strong><em>limit</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>FilterLimit </strong><em>LIMIT</em><br>
Specifies the maximum cost of filters that are run concurrently, which can be used to minimize disk, memory, and CPU resource problems.
A limit of 0 disables filter limiting.
An average print to a non-PostScript printer needs a filter limit of about 200.
Setting the limit below these thresholds will effectively limit the scheduler to printing a single job at any time.
The default limit is "0".
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>FilterNice </strong><em>nice-value</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>FilterNice </strong><em>NICE-VALUE</em><br>
Specifies the scheduling priority (
<strong>nice</strong>(8)
The default is "Off" to avoid the potential server performance problems with hostname lookups.
Only set this option to "On" or "Double" if absolutely required.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>IdleExitTimeout </strong><em>seconds</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>IdleExitTimeout </strong><em>SECONDS</em><br>
Specifies the length of time to wait before shutting down due to inactivity.
The default is "60" seconds.
Note: Only applicable when
is run on-demand (e.g., with <strong>-l</strong>).
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>JobKillDelay </strong><em>seconds</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>JobKillDelay </strong><em>SECONDS</em><br>
Specifies the number of seconds to wait before killing the filters and backend associated with a canceled or held job.
The default is "300".
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>JobRetryInterval </strong><em>seconds</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>JobRetryInterval </strong><em>SECONDS</em><br>
Specifies the interval between retries of jobs in seconds.
This is typically used for fax queues but can also be used with normal print queues whose error policy is "retry-job".
The default is "300".
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>JobRetryLimit </strong><em>count</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>JobRetryLimit </strong><em>COUNT</em><br>
Specifies the number of retries that are done for jobs.
This is typically used for fax queues but can also be used with normal print queues whose error policy is "retry-job".
The default is "5".
Specifies whether to support HTTP keep-alive connections.
The default is "Yes".
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong><Limit </strong><em>operation </em>...<strong>> </strong>... <strong></Limit></strong><br>
-Specifies the IPP operations that are being limited inside a Policy section. IPP operation names are listed below in the section "IPP OPERATION NAMES".
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong><Limit </strong><em>OPERATION </em>...<strong>> </strong>... <strong></Limit></strong><br>
+Specifies the IPP operations that are being limited inside a Policy section.
+IPP operation names are listed below in the section "IPP OPERATION NAMES".
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong><Limit </strong><em>method </em>...<strong>> </strong>... <strong></Limit></strong><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong><Limit </strong><em>METHOD </em>...<strong>> </strong>... <strong></Limit></strong><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong><LimitExcept </strong><em>method </em>...<strong>> </strong>... <strong></LimitExcept></strong><br>
-Specifies the HTTP methods that are being limited inside a Location section. HTTP method names are listed below in the section "HTTP METHOD NAMES".
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong><LimitExcept </strong><em>METHOD </em>...<strong>> </strong>... <strong></LimitExcept></strong><br>
+Specifies the HTTP methods that are being limited inside a Location section.
+HTTP method names are listed below in the section "HTTP METHOD NAMES".
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>LimitRequestBody </strong><em>size</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>LimitRequestBody </strong><em>SIZE</em><br>
Specifies the maximum size of print files, IPP requests, and HTML form data.
The default is "0" which disables the limit check.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Listen </strong><em>ipv4-address</em><strong>:</strong><em>port</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Listen </strong><em>IPV4-ADDRESS</em><strong>:</strong><em>PORT</em><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Listen [</strong><em>ipv6-address</em><strong>]:</strong><em>port</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Listen [</strong><em>IPV6-ADDRESS</em><strong>]:</strong><em>PORT</em><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Listen *:</strong><em>port</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Listen *:</strong><em>PORT</em><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Listen </strong><em>/path/to/domain/socket</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Listen </strong><em>/PATH/TO/DOMAIN/SOCKET</em><br>
Listens to the specified address and port or domain socket path for connections.
Multiple Listen directives can be provided to listen on multiple addresses.
The Listen directive is similar to the Port directive but allows you to restrict access to specific interfaces or networks.
-Note: "Listen *:<em>port</em>" and "Port <em>port</em>" effectively listen on all IP addresses, so you cannot combine them with Listen directives for explicit IPv4 or IPv6 addresses on the same port.
+Note: "Listen *:<em>PORT</em>" and "Port <em>PORT</em>" effectively listen on all IP addresses, so you cannot combine them with Listen directives for explicit IPv4 or IPv6 addresses on the same port.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong><Location </strong><em>/path</em><strong>> </strong>... <strong></Location></strong><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong><Location </strong><em>/PATH</em><strong>> </strong>... <strong></Location></strong><br>
Specifies access control for the named location.
Paths are documented below in the section "LOCATION PATHS".
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>LogDebugHistory </strong><em>number</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>LogDebugHistory </strong><em>NUMBER</em><br>
Specifies the number of debugging messages that are retained for logging if an error occurs in a print job. Debug messages are logged regardless of the LogLevel setting.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>LogLevel </strong>none<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>LogLevel none</strong><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>LogLevel </strong>emerg<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>LogLevel emerg</strong><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>LogLevel </strong>alert<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>LogLevel alert</strong><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>LogLevel </strong>crit<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>LogLevel crit</strong><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>LogLevel </strong>error<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>LogLevel error</strong><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>LogLevel </strong>warn<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>LogLevel warn</strong><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>LogLevel </strong>notice<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>LogLevel notice</strong><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>LogLevel </strong>info<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>LogLevel info</strong><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>LogLevel </strong>debug<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>LogLevel debug</strong><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>LogLevel </strong>debug2<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>LogLevel debug2</strong><br>
Specifies the level of logging for the ErrorLog file.
The value "none" stops all logging while "debug2" logs everything.
The default is "warn".
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>LogTimeFormat </strong>standard<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>LogTimeFormat standard</strong><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>LogTimeFormat </strong>usecs<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>LogTimeFormat usecs</strong><br>
Specifies the format of the date and time in the log files.
The value "standard" is the default and logs whole seconds while "usecs" logs microseconds.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>MaxClients </strong><em>number</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>MaxClients </strong><em>NUMBER</em><br>
Specifies the maximum number of simultaneous clients that are allowed by the scheduler.
The default is "100".
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>MaxClientsPerHost </strong><em>number</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>MaxClientsPerHost </strong><em>NUMBER</em><br>
Specifies the maximum number of simultaneous clients that are allowed from a
single address.
The default is the MaxClients value.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>MaxCopies </strong><em>number</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>MaxCopies </strong><em>NUMBER</em><br>
Specifies the maximum number of copies that a user can print of each job.
The default is "9999".
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>MaxHoldTime </strong><em>seconds</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>MaxHoldTime </strong><em>SECONDS</em><br>
Specifies the maximum time a job may remain in the "indefinite" hold state before it is canceled.
The default is "0" which disables cancellation of held jobs.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>MaxJobs </strong><em>number</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>MaxJobs </strong><em>NUMBER</em><br>
Specifies the maximum number of simultaneous jobs that are allowed.
Set to "0" to allow an unlimited number of jobs.
The default is "500".
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>MaxJobsPerPrinter </strong><em>number</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>MaxJobsPerPrinter </strong><em>NUMBER</em><br>
Specifies the maximum number of simultaneous jobs that are allowed per printer.
The default is "0" which allows up to MaxJobs jobs per printer.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>MaxJobsPerUser </strong><em>number</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>MaxJobsPerUser </strong><em>NUMBER</em><br>
Specifies the maximum number of simultaneous jobs that are allowed per user.
The default is "0" which allows up to MaxJobs jobs per user.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>MaxJobTime </strong><em>seconds</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>MaxJobTime </strong><em>SECONDS</em><br>
Specifies the maximum time a job may take to print before it is canceled.
Set to "0" to disable cancellation of "stuck" jobs.
The default is "10800" (3 hours).
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>MaxLogSize </strong><em>size</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>MaxLogSize </strong><em>SIZE</em><br>
Specifies the maximum size of the log files before they are rotated.
The value "0" disables log rotation.
The default is "1048576" (1MB).
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>MaxSubscriptions </strong><em>number</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>MaxSubscriptions </strong><em>NUMBER</em><br>
Specifies the maximum number of simultaneous event subscriptions that are allowed.
Set to "0" to allow an unlimited number of subscriptions.
The default is "100".
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>MaxSubscriptionsPerJob </strong><em>number</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>MaxSubscriptionsPerJob </strong><em>NUMBER</em><br>
Specifies the maximum number of simultaneous event subscriptions that are allowed per job.
The default is "0" which allows up to MaxSubscriptions subscriptions per job.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>MaxSubscriptionsPerPrinter </strong><em>number</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>MaxSubscriptionsPerPrinter </strong><em>NUMBER</em><br>
Specifies the maximum number of simultaneous event subscriptions that are allowed per printer.
The default is "0" which allows up to MaxSubscriptions subscriptions per printer.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>MaxSubscriptionsPerUser </strong><em>number</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>MaxSubscriptionsPerUser </strong><em>NUMBER</em><br>
Specifies the maximum number of simultaneous event subscriptions that are allowed per user.
The default is "0" which allows up to MaxSubscriptions subscriptions per user.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>MultipleOperationTimeout </strong><em>seconds</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>MultipleOperationTimeout </strong><em>SECONDS</em><br>
Specifies the maximum amount of time to allow between files in a multiple file print job.
The default is "900" (15 minutes).
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong><Policy </strong><em>name</em><strong>> </strong>... <strong></Policy></strong><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong><Policy </strong><em>NAME</em><strong>> </strong>... <strong></Policy></strong><br>
Specifies access control for the named policy.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Port </strong><em>number</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Port </strong><em>NUMBER</em><br>
Listens to the specified port number for connections.
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>PreserveJobFiles Yes</strong><br>
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>PreserveJobFiles No</strong><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>PreserveJobFiles </strong><em>seconds</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>PreserveJobFiles </strong><em>SECONDS</em><br>
Specifies whether job files (documents) are preserved after a job is printed.
If a numeric value is specified, job files are preserved for the indicated number of seconds after printing.
The default is "86400" (preserve 1 day).
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>PreserveJobHistory No</strong><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>PreserveJobHistory </strong><em>seconds</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>PreserveJobHistory </strong><em>SECONDS</em><br>
Specifies whether the job history is preserved after a job is printed.
If a numeric value is specified, the job history is preserved for the indicated number of seconds after printing.
If "Yes", the job history is preserved until the MaxJobs limit is reached.
The default is "Yes".
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>ReadyPaperSizes </strong><em>sizename[,...]</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>ReadyPaperSizes </strong><em>SIZENAME[,...]</em><br>
Specifies a list of potential paper sizes that are reported as "ready" (loaded).
The actual list will only contain sizes that each printer supports.
The default is "Letter,Legal,Tabloid,4x6,Env10" when the default paper size is "Letter" and "A3,A4,A5,A6,EnvDL" otherwise.
Note: Paper sizes must use the size names from the PPD file and not PWG self-describing media size names.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>ReloadTimeout </strong><em>seconds</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>ReloadTimeout </strong><em>SECONDS</em><br>
Specifies the amount of time to wait for job completion before restarting the scheduler.
The default is "30".
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>ServerAdmin </strong><em>email-address</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>ServerAdmin </strong><em>EMAIL-ADDRESS</em><br>
Specifies the email address of the server administrator.
The default value is "root@ServerName".
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>ServerAlias </strong><em>hostname </em>[ ... <em>hostname </em>]<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>ServerAlias </strong><em>HOSTNAME [... HOSTNAME]</em>]<br>
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>ServerAlias *</strong><br>
The ServerAlias directive is used for HTTP Host header validation when clients connect to the scheduler from external interfaces.
Using the special name "*" can expose your system to known browser-based DNS rebinding attacks, even when accessing sites through a firewall.
If the auto-discovery of alternate names does not work, we recommend listing each alternate name with a ServerAlias directive instead of using "*".
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>ServerName </strong><em>hostname</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>ServerName </strong><em>HOSTNAME</em><br>
Specifies the fully-qualified hostname of the server.
The default is the value reported by the
<strong>hostname</strong>(1)
"Full" reports "CUPS/major.minor.path (osname osversion; architecture) IPP/2.1".
The default is "Minimal".
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>SSLListen </strong><em>ipv4-address</em><strong>:</strong><em>port</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>SSLListen </strong><em>IPV4-ADDRESS</em><strong>:</strong><em>PORT</em><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>SSLListen [</strong><em>ipv6-address</em><strong>]:</strong><em>port</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>SSLListen [</strong><em>IPV6-ADDRESS</em><strong>]:</strong><em>PORT</em><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>SSLListen *:</strong><em>port</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>SSLListen *:</strong><em>PORT</em><br>
Listens on the specified address and port for encrypted connections.
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"></p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>SSLOptions </strong>[<em>AllowDH</em>] [<em>AllowRC4</em>] [<em>AllowSSL3</em>] [<em>DenyCBC</em>] [<em>DenyTLS1.0</em>] [<em>MaxTLS1.0</em>] [<em>MaxTLS1.1</em>] [<em>MaxTLS1.2</em>] [<em>MaxTLS1.3</em>] [<em>MinTLS1.0</em>] [<em>MinTLS1.1</em>] [<em>MinTLS1.2</em>] [<em>MinTLS1.3</em>] [<em>NoSystem</em>]<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>SSLOptions </strong><em>OPTIONS</em><br>
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>SSLOptions None</strong><br>
Sets encryption options (only in /etc/cups/client.conf).
By default, CUPS only supports encryption using TLS v1.0 or higher using known secure cipher suites.
Security is reduced when <em>Allow</em> options are used.
Security is enhanced when <em>Deny</em> options are used.
-The <em>AllowDH</em> option enables cipher suites using plain Diffie-Hellman key negotiation (not supported on systems using GNU TLS).
-The <em>AllowRC4</em> option enables the 128-bit RC4 cipher suites, which are required for some older clients.
-The <em>AllowSSL3</em> option enables SSL v3.0, which is required for some older clients that do not support TLS v1.0.
-The <em>DenyCBC</em> option disables all CBC cipher suites.
-The <em>DenyTLS1.0</em> option disables TLS v1.0 support - this sets the minimum protocol version to TLS v1.1.
-The <em>MinTLS</em> options set the minimum TLS version to support.
-The <em>MaxTLS</em> options set the maximum TLS version to support.
-The <em>NoSystem</em> option disables applying system cryptographic policy.
+The <strong>AllowDH</strong> option enables cipher suites using plain Diffie-Hellman key negotiation (not supported on systems using GNU TLS).
+The <strong>AllowRC4</strong> option enables the 128-bit RC4 cipher suites, which are required for some older clients.
+The <strong>AllowSSL3</strong> option enables SSL v3.0, which is required for some older clients that do not support TLS v1.0.
+The <strong>DenyCBC</strong> option disables all CBC cipher suites.
+The <strong>DenyTLS1.0</strong> option disables TLS v1.0 support - this sets the minimum protocol version to TLS v1.1.
+The <strong>MinTLS1.0</strong>, <strong>MinTLS1.1</strong>, <strong>MinTLS1.2</strong>, and <strong>MinTLS1.3</strong> options set the minimum TLS version to support.
+The <strong>MaxTLS1.0</strong>, <strong>MaxTLS1.1</strong>, <strong>MaxTLS1.2</strong>, and <strong>MaxTLS1.3</strong> options set the maximum TLS version to support.
+The <strong>NoSystem</strong> option disables applying system cryptographic policy.
Not all operating systems support TLS 1.3 at this time.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>SSLPort </strong><em>port</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>SSLPort </strong><em>PORT</em><br>
Listens on the specified port for encrypted connections.
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>StrictConformance Yes</strong><br>
Specifies whether the scheduler requires clients to strictly adhere to the IPP specifications.
The default is "No".
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Timeout </strong><em>seconds</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Timeout </strong><em>SECONDS</em><br>
Specifies the HTTP request timeout.
The default is "900" (15 minutes).
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>WebInterface yes</strong><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>WebInterface Yes</strong><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>WebInterface no</strong><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>WebInterface No</strong><br>
Specifies whether the web interface is enabled.
The default is "No".
</p>
<a href="cupsd.html"><strong>cupsd</strong>(8):</a>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">GET<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>GET</strong><br>
Used by a client to download icons and other printer resources and to access the CUPS web interface.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">HEAD<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>HEAD</strong><br>
Used by a client to get the type, size, and modification date of resources.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">OPTIONS<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>OPTIONS</strong><br>
Used by a client to establish a secure (SSL/TLS) connection.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">POST<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>POST</strong><br>
Used by a client to submit IPP requests and HTML forms from the CUPS web interface.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">PUT<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>PUT</strong><br>
Used by a client to upload configuration files.
</p>
<h3 id="cupsd.conf-5.description.ipp-operation-names">Ipp Operation Names</h3>
<a href="cupsd.html"><strong>cupsd</strong>(8):</a>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">CUPS-Accept-Jobs<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>CUPS-Accept-Jobs</strong><br>
Allows a printer to accept new jobs.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">CUPS-Add-Modify-Class<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>CUPS-Add-Modify-Class</strong><br>
Adds or modifies a printer class.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">CUPS-Add-Modify-Printer<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>CUPS-Add-Modify-Printer</strong><br>
Adds or modifies a printer.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">CUPS-Authenticate-Job<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>CUPS-Authenticate-Job</strong><br>
Releases a job that is held for authentication.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">CUPS-Delete-Class<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>CUPS-Create-Local-Printer</strong><br>
+Creates a local, temporary IPP Everywhere printer.
+</p>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>CUPS-Delete-Class</strong><br>
Deletes a printer class.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">CUPS-Delete-Printer<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>CUPS-Delete-Printer</strong><br>
Deletes a printer.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">CUPS-Get-Classes<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>CUPS-Get-Classes</strong><br>
Gets a list of printer classes.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">CUPS-Get-Default<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>CUPS-Get-Default</strong><br>
Gets the server default printer or printer class.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">CUPS-Get-Devices<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>CUPS-Get-Devices</strong><br>
Gets a list of devices that are currently available.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">CUPS-Get-Document<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>CUPS-Get-Document</strong><br>
Gets a document file for a job.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">CUPS-Get-PPD<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>CUPS-Get-PPD</strong><br>
Gets a PPD file.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">CUPS-Get-PPDs<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>CUPS-Get-PPDs</strong><br>
Gets a list of installed PPD files.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">CUPS-Get-Printers<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>CUPS-Get-Printers</strong><br>
Gets a list of printers.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">CUPS-Move-Job<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>CUPS-Move-Job</strong><br>
Moves a job.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">CUPS-Reject-Jobs<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>CUPS-Reject-Jobs</strong><br>
Prevents a printer from accepting new jobs.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">CUPS-Set-Default<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>CUPS-Set-Default</strong><br>
Sets the server default printer or printer class.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">Cancel-Job<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Cancel-Job</strong><br>
Cancels a job.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">Cancel-Jobs<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Cancel-Jobs</strong><br>
Cancels one or more jobs.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">Cancel-My-Jobs<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Cancel-My-Jobs</strong><br>
Cancels one or more jobs creates by a user.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">Cancel-Subscription<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Cancel-Subscription</strong><br>
Cancels a subscription.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">Close-Job<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Close-Job</strong><br>
Closes a job that is waiting for more documents.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">Create-Job<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Create-Job</strong><br>
Creates a new job with no documents.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">Create-Job-Subscriptions<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Create-Job-Subscriptions</strong><br>
Creates a subscription for job events.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">Create-Printer-Subscriptions<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Create-Printer-Subscriptions</strong><br>
Creates a subscription for printer events.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">Get-Job-Attributes<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Get-Job-Attributes</strong><br>
Gets information about a job.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">Get-Jobs<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Get-Jobs</strong><br>
Gets a list of jobs.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">Get-Notifications<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Get-Notifications</strong><br>
Gets a list of event notifications for a subscription.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">Get-Printer-Attributes<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Get-Printer-Attributes</strong><br>
Gets information about a printer or printer class.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">Get-Subscription-Attributes<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Get-Subscription-Attributes</strong><br>
Gets information about a subscription.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">Get-Subscriptions<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Get-Subscriptions</strong><br>
Gets a list of subscriptions.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">Hold-Job<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Hold-Job</strong><br>
Holds a job from printing.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">Hold-New-Jobs<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Hold-New-Jobs</strong><br>
Holds all new jobs from printing.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">Pause-Printer<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Pause-Printer</strong><br>
Stops processing of jobs by a printer or printer class.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">Pause-Printer-After-Current-Job<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Pause-Printer-After-Current-Job</strong><br>
Stops processing of jobs by a printer or printer class after the current job is finished.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">Print-Job<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Print-Job</strong><br>
Creates a new job with a single document.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">Purge-Jobs<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Purge-Jobs</strong><br>
Cancels one or more jobs and deletes the job history.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">Release-Held-New-Jobs<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Release-Held-New-Jobs</strong><br>
Allows previously held jobs to print.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">Release-Job<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Release-Job</strong><br>
Allows a job to print.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">Renew-Subscription<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Renew-Subscription</strong><br>
Renews a subscription.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">Restart-Job<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Restart-Job</strong><br>
Reprints a job, if possible.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">Send-Document<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Send-Document</strong><br>
Adds a document to a job.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">Set-Job-Attributes<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Set-Job-Attributes</strong><br>
Changes job information.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">Set-Printer-Attributes<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Set-Printer-Attributes</strong><br>
Changes printer or printer class information.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">Validate-Job<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Validate-Job</strong><br>
Validates options for a new job.
</p>
<h3 id="cupsd.conf-5.description.location-paths">Location Paths</h3>
<a href="cupsd.html"><strong>cupsd</strong>(8):</a>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">/<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>/</strong><br>
The path for all get operations (get-printers, get-jobs, etc.)
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">/admin<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>/admin</strong><br>
The path for all administration operations (add-printer, delete-printer, start-printer, etc.)
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">/admin/conf<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>/admin/conf</strong><br>
The path for access to the CUPS configuration files (cupsd.conf, client.conf, etc.)
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">/admin/log<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>/admin/log</strong><br>
The path for access to the CUPS log files (access_log, error_log, page_log)
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">/classes<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>/classes</strong><br>
The path for all printer classes
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">/classes/name<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>/classes/name</strong><br>
The resource for the named printer class
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">/jobs<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>/jobs</strong><br>
The path for all jobs (hold-job, release-job, etc.)
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">/jobs/id<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>/jobs/id</strong><br>
The path for the specified job
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">/printers<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>/printers</strong><br>
The path for all printers
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">/printers/name<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>/printers/name</strong><br>
The path for the named printer
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">/printers/name.png<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>/printers/name.png</strong><br>
The icon file path for the named printer
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;">/printers/name.ppd<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>/printers/name.ppd</strong><br>
The PPD file path for the named printer
</p>
<h3 id="cupsd.conf-5.description.directives-valid-within-location-and-limit-sections">Directives Valid Within Location And Limit Sections</h3>
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Allow none</strong><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Allow </strong><em>host.domain.com</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Allow </strong><em>HOSTNAME</em><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Allow *.</strong><em>domain.com</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Allow *.</strong><em>DOMAIN</em><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Allow </strong><em>ipv4-address</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Allow </strong><em>IPV4-ADDRESS</em><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Allow </strong><em>ipv4-address</em><strong>/</strong><em>netmask</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Allow </strong><em>IPV4-ADDRESS</em><strong>/</strong><em>NETMASK</em><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Allow </strong><em>ipv4-address</em><strong>/</strong><em>mm</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Allow </strong><em>IPV4-ADDRESS</em><strong>/</strong><em>MM</em><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Allow [</strong><em>ipv6-address</em><strong>]</strong><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Allow [</strong><em>IPV6-ADDRESS</em><strong>]</strong><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Allow [</strong><em>ipv6-address</em><strong>]/</strong><em>mm</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Allow [</strong><em>IPV6-ADDRESS</em><strong>]/</strong><em>MM</em><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Allow @IF(</strong><em>name</em><strong>)</strong><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Allow @IF(</strong><em>NAME</em><strong>)</strong><br>
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Allow @LOCAL</strong><br>
Allows access from the named hosts, domains, addresses, or interfaces.
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Deny none</strong><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Deny </strong><em>host.domain.com</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Deny </strong><em>HOSTNAME</em><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Deny *.</strong><em>domain.com</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Deny *.</strong><em>DOMAIN</em><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Deny </strong><em>ipv4-address</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Deny </strong><em>IPV4-ADDRESS</em><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Deny </strong><em>ipv4-address</em><strong>/</strong><em>netmask</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Deny </strong><em>IPV4-ADDRESS</em><strong>/</strong><em>NETMASK</em><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Deny </strong><em>ipv4-address</em><strong>/</strong><em>mm</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Deny </strong><em>IPV4-ADDRESS</em><strong>/</strong><em>MM</em><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Deny [</strong><em>ipv6-address</em><strong>]</strong><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Deny [</strong><em>IPV6-ADDRESS</em><strong>]</strong><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Deny [</strong><em>ipv6-address</em><strong>]/</strong><em>mm</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Deny [</strong><em>IPV6-ADDRESS</em><strong>]/</strong><em>MM</em><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Deny @IF(</strong><em>name</em><strong>)</strong><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Deny @IF(</strong><em>NAME</em><strong>)</strong><br>
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Deny @LOCAL</strong><br>
Denies access from the named hosts, domains, addresses, or interfaces.
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Order deny,allow</strong><br>
Specifies that access is allowed by default. Deny lines are then processed followed by Allow lines to determine whether a client may access a particular resource.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Require group </strong><em>group-name </em>[ <em>group-name </em>... ]<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Require group </strong><em>GROUP-NAME [... GROUP-NAME]</em><br>
Specifies that an authenticated user must be a member of one of the named groups.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Require user {</strong><em>user-name</em>|<strong>@</strong><em>group-name</em>} ...<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Require user {</strong><em>USER-NAME</em>|<strong>@</strong><em>GROUP-NAME</em>} ...<br>
Specifies that an authenticated user must match one of the named users or be a member of one of the named groups.
The group name "@SYSTEM" corresponds to the list of groups defined by the SystemGroup directive in the
<a href="cups-files.conf.html"><strong>cups-files.conf</strong>(5)</a>
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>JobPrivateAccess default</strong><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>JobPrivateAccess </strong>{<em>user</em>|<strong>@</strong><em>group</em>|<strong>@ACL</strong>|<strong>@OWNER</strong>|<strong>@SYSTEM</strong>} ...<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>JobPrivateAccess </strong>{<em>USER</em>|<strong>@</strong><em>GROUP</em>|<strong>@ACL</strong>|<strong>@OWNER</strong>|<strong>@SYSTEM</strong>} ...<br>
Specifies an access list for a job's private values.
-The "default" access list is "@OWNER @SYSTEM".
+The default access list is "@OWNER @SYSTEM".
"@ACL" maps to the printer's requesting-user-name-allowed or requesting-user-name-denied values.
"@OWNER" maps to the job's owner.
"@SYSTEM" maps to the groups listed for the SystemGroup directive in the
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>JobPrivateValues none</strong><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>JobPrivateValues </strong><em>attribute-name </em>[ ... <em>attribute-name </em>]<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>JobPrivateValues </strong><em>ATTRIBUTE-NAME [... ATTRIBUTE-NAME]</em><br>
Specifies the list of job values to make private.
-The "default" values are "job-name", "job-originating-host-name", "job-originating-user-name", and "phone".
+The default values are "job-name", "job-originating-host-name", "job-originating-user-name", and "phone".
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>SubscriptionPrivateAccess all</strong><br>
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>SubscriptionPrivateAccess default</strong><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>SubscriptionPrivateAccess </strong>{<em>user</em>|<strong>@</strong><em>group</em>|<strong>@ACL</strong>|<strong>@OWNER</strong>|<strong>@SYSTEM</strong>} ...<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>SubscriptionPrivateAccess </strong>{<em>USER</em>|<strong>@</strong><em>GROUP</em>|<strong>@ACL</strong>|<strong>@OWNER</strong>|<strong>@SYSTEM</strong>} ...<br>
Specifies an access list for a subscription's private values.
-The "default" access list is "@OWNER @SYSTEM".
+The default access list is "@OWNER @SYSTEM".
"@ACL" maps to the printer's requesting-user-name-allowed or requesting-user-name-denied values.
"@OWNER" maps to the job's owner.
"@SYSTEM" maps to the groups listed for the SystemGroup directive in the
</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>SubscriptionPrivateValues none</strong><br>
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>SubscriptionPrivateValues </strong><em>attribute-name </em>[ ... <em>attribute-name </em>]<br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>SubscriptionPrivateValues </strong><em>ATTRIBUTE-NAME [... ATTRIBUTE-NAME]</em><br>
Specifies the list of subscription values to make private.
-The "default" values are "notify-events", "notify-pull-method", "notify-recipient-uri", "notify-subscriber-user-name", and "notify-user-data".
+The default values are "notify-events", "notify-pull-method", "notify-recipient-uri", "notify-subscriber-user-name", and "notify-user-data".
</p>
<h3 id="cupsd.conf-5.description.deprecated-directives">Deprecated Directives</h3>
<p>The following directives are deprecated and will be removed in a future release of CUPS:
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>AuthType Negotiate</strong><br>
Specifies Kerberos authentication is required.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Classification </strong><em>banner</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>Classification </strong><em>BANNER</em><br>
<br>
Specifies the security classification of the server.
Any valid banner name can be used, including "classified", "confidential", "secret", "topsecret", and "unclassified", or the banner can be omitted to disable secure printing functions.
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>DefaultAuthType Negotiate</strong><br>
Specifies that Kerberos authentication is required by default.
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>GSSServiceName </strong><em>name</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>GSSServiceName </strong><em>NAME</em><br>
Specifies the service name when using Kerberos authentication.
The default service name is "http."
</p>
- <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>PageLogFormat </strong><em>format-string</em><br>
+ <p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>PageLogFormat </strong><em>FORMAT-STRING</em><br>
Specifies the format of PageLog lines.
Sequences beginning with percent (%) characters are replaced with the corresponding information, while all other characters are copied literally.
The following percent sequences are recognized:
.\" Licensed under Apache License v2.0. See the file "LICENSE" for more
.\" information.
.\"
-.TH cupsd.conf 5 "CUPS" "2025-03-12" "OpenPrinting"
+.TH cupsd.conf 5 "CUPS" "2025-04-14" "OpenPrinting"
.SH NAME
cupsd.conf \- server configuration file for cups
.SH DESCRIPTION
.\"#BrowseDNSSDSubTypes
.TP 5
.BI BrowseDNSSDSubTypes _subtype[,...]
-Specifies a list of Bonjour sub-types to advertise for each shared printer.
-For example, "BrowseDNSSDSubTypes _cups,_print" will tell network clients that both CUPS sharing and IPP Everywhere are supported.
-The default is "_cups" which is necessary for printer sharing to work between systems using CUPS.
+Specifies the DNS-SD sub-types to advertise, separated by commas.
+The default is "_cups,_print,_universal" to advertise shared printers to CUPS, IPP Everywhere, and AirPrint clients, respectively.
.\"#BrowseLocalProtocols
.TP 5
\fBBrowseLocalProtocols all\fR
.TP 5
\fBBrowseLocalProtocols none\fR
Specifies which protocols to use for local printer sharing.
-The default is "dnssd" on systems that support Bonjour and "none" otherwise.
+The default is "dnssd" on systems that support DNS-SD and "none" otherwise.
.\"#BrowseWebIF
.TP 5
\fBBrowseWebIF Yes\fR
The default is "Required".
.\"#DefaultLanguage
.TP 5
-\fBDefaultLanguage \fIlocale\fR
+\fBDefaultLanguage \fILOCALE\fR
Specifies the default language to use for text and web content.
The default is "en".
.\"#DefaultPaperSize
.TP 5
\fBDefaultPaperSize None\fR
.TP 5
-\fBDefaultPaperSize \fIsizename\fR
+\fBDefaultPaperSize \fISIZENAME\fR
Specifies the default paper size for new print queues. "Auto" uses a locale-specific default, while "None" specifies there is no default paper size.
Specific size names are typically "Letter" or "A4".
The default is "Auto".
Note: The default paper size must use a size name from the PPD file and not a PWG self-describing media size name.
.\"#DefaultPolicy
.TP 5
-\fBDefaultPolicy \fIpolicy-name\fR
+\fBDefaultPolicy \fIPOLICY-NAME\fR
Specifies the default access policy to use.
The default access policy is "default".
.\"#DefaultShared
The default is "Yes".
.\"#DirtyCleanInterval
.TP 5
-\fBDirtyCleanInterval \fIseconds\fR
+\fBDirtyCleanInterval \fISECONDS\fR
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.
The default value is "30".
+.\"#DNSSDComputerName
+.TP 5
+\fBDNSSDComputerName none\fR
+.TP 5
+\fBDNSSDComputerName "\fICOMPUTER-NAME\fR"
+Specifies the human readable computer name that is appended to any shared printer names, for example "My Printer @ Bob's Computer".
+The default is OS-specific and follows any system naming changes.
+The value "none" disables the "@ Computer Name" suffix added to shared printer names.
.\"#DNSSDHostName
.TP 5
-.BI DNSSDHostName hostname.example.com
-Specifies the fully-qualified domain name for the server that is used for Bonjour sharing.
-The default is typically the server's ".local" hostname.
+\fBDNSSDHostName \fIHOSTNAME\fR
+Specifies the fully-qualified domain name for the server that is used for DNS-SD sharing.
+The default is typically the server's ".local" hostname and is updated whenever that hostname changes.
.\"#ErrorPolicy
.TP 5
\fBErrorPolicy abort-job\fR
Specifies that a failed print job should stop the printer unless otherwise specified for the printer. The 'stop-printer' error policy is the default.
.\"#FilterLimit
.TP 5
-\fBFilterLimit \fIlimit\fR
+\fBFilterLimit \fILIMIT\fR
Specifies the maximum cost of filters that are run concurrently, which can be used to minimize disk, memory, and CPU resource problems.
A limit of 0 disables filter limiting.
An average print to a non-PostScript printer needs a filter limit of about 200.
The default limit is "0".
.\"#FilterNice
.TP 5
-\fBFilterNice \fInice-value\fR
+\fBFilterNice \fINICE-VALUE\fR
Specifies the scheduling priority (
.BR nice (8)
value) of filters that are run to print a job.
Only set this option to "On" or "Double" if absolutely required.
.\"#IdleExitTimeout
.TP 5
-\fBIdleExitTimeout \fIseconds\fR
+\fBIdleExitTimeout \fISECONDS\fR
Specifies the length of time to wait before shutting down due to inactivity.
The default is "60" seconds.
Note: Only applicable when
is run on-demand (e.g., with \fB-l\fR).
.\"#JobKillDelay
.TP 5
-\fBJobKillDelay \fIseconds\fR
+\fBJobKillDelay \fISECONDS\fR
Specifies the number of seconds to wait before killing the filters and backend associated with a canceled or held job.
The default is "300".
.\"#JobRetryInterval
.TP 5
-\fBJobRetryInterval \fIseconds\fR
+\fBJobRetryInterval \fISECONDS\fR
Specifies the interval between retries of jobs in seconds.
This is typically used for fax queues but can also be used with normal print queues whose error policy is "retry-job".
The default is "300".
.\"#JobRetryLimit
.TP 5
-\fBJobRetryLimit \fIcount\fR
+\fBJobRetryLimit \fICOUNT\fR
Specifies the number of retries that are done for jobs.
This is typically used for fax queues but can also be used with normal print queues whose error policy is "retry-job".
The default is "5".
The default is "Yes".
.\"#LimitIPP
.TP 5
-\fB<Limit \fIoperation \fR...\fB> \fR... \fB</Limit>\fR
-Specifies the IPP operations that are being limited inside a Policy section. IPP operation names are listed below in the section "IPP OPERATION NAMES".
+\fB<Limit \fIOPERATION \fR...\fB> \fR... \fB</Limit>\fR
+Specifies the IPP operations that are being limited inside a Policy section.
+IPP operation names are listed below in the section "IPP OPERATION NAMES".
.\"#Limit
.TP 5
-\fB<Limit \fImethod \fR...\fB> \fR... \fB</Limit>\fR
+\fB<Limit \fIMETHOD \fR...\fB> \fR... \fB</Limit>\fR
.\"#LimitExcept
.TP 5
-\fB<LimitExcept \fImethod \fR...\fB> \fR... \fB</LimitExcept>\fR
-Specifies the HTTP methods that are being limited inside a Location section. HTTP method names are listed below in the section "HTTP METHOD NAMES".
+\fB<LimitExcept \fIMETHOD \fR...\fB> \fR... \fB</LimitExcept>\fR
+Specifies the HTTP methods that are being limited inside a Location section.
+HTTP method names are listed below in the section "HTTP METHOD NAMES".
.\"#LimitRequestBody
.TP 5
-\fBLimitRequestBody \fIsize\fR
+\fBLimitRequestBody \fISIZE\fR
Specifies the maximum size of print files, IPP requests, and HTML form data.
The default is "0" which disables the limit check.
.\"#Listen
.TP 5
-\fBListen \fIipv4-address\fB:\fIport\fR
+\fBListen \fIIPV4-ADDRESS\fB:\fIPORT\fR
.TP 5
-\fBListen [\fIipv6-address\fB]:\fIport\fR
+\fBListen [\fIIPV6-ADDRESS\fB]:\fIPORT\fR
.TP 5
-\fBListen *:\fIport\fR
+\fBListen *:\fIPORT\fR
.TP 5
-\fBListen \fI/path/to/domain/socket\fR
+\fBListen \fI/PATH/TO/DOMAIN/SOCKET\fR
Listens to the specified address and port or domain socket path for connections.
Multiple Listen directives can be provided to listen on multiple addresses.
The Listen directive is similar to the Port directive but allows you to restrict access to specific interfaces or networks.
-Note: "Listen *:\fIport\fR" and "Port \fIport\fR" effectively listen on all IP addresses, so you cannot combine them with Listen directives for explicit IPv4 or IPv6 addresses on the same port.
+Note: "Listen *:\fIPORT\fR" and "Port \fIPORT\fR" effectively listen on all IP addresses, so you cannot combine them with Listen directives for explicit IPv4 or IPv6 addresses on the same port.
.\"#Location
.TP 5
-\fB<Location \fI/path\fB> \fR... \fB</Location>\fR
+\fB<Location \fI/PATH\fB> \fR... \fB</Location>\fR
Specifies access control for the named location.
Paths are documented below in the section "LOCATION PATHS".
.\"#LogDebugHistory
.TP 5
-\fBLogDebugHistory \fInumber\fR
+\fBLogDebugHistory \fINUMBER\fR
Specifies the number of debugging messages that are retained for logging if an error occurs in a print job. Debug messages are logged regardless of the LogLevel setting.
.\"#LogLevel
.TP 5
-\fBLogLevel \fRnone
+\fBLogLevel none\fR
.TP 5
-\fBLogLevel \fRemerg
+\fBLogLevel emerg\fR
.TP 5
-\fBLogLevel \fRalert
+\fBLogLevel alert\fR
.TP 5
-\fBLogLevel \fRcrit
+\fBLogLevel crit\fR
.TP 5
-\fBLogLevel \fRerror
+\fBLogLevel error\fR
.TP 5
-\fBLogLevel \fRwarn
+\fBLogLevel warn\fR
.TP 5
-\fBLogLevel \fRnotice
+\fBLogLevel notice\fR
.TP 5
-\fBLogLevel \fRinfo
+\fBLogLevel info\fR
.TP 5
-\fBLogLevel \fRdebug
+\fBLogLevel debug\fR
.TP 5
-\fBLogLevel \fRdebug2
+\fBLogLevel debug2\fR
Specifies the level of logging for the ErrorLog file.
The value "none" stops all logging while "debug2" logs everything.
The default is "warn".
.\"#LogTimeFormat
.TP 5
-\fBLogTimeFormat \fRstandard
+\fBLogTimeFormat standard\fR
.TP 5
-\fBLogTimeFormat \fRusecs
+\fBLogTimeFormat usecs\fR
Specifies the format of the date and time in the log files.
The value "standard" is the default and logs whole seconds while "usecs" logs microseconds.
.\"#MaxClients
.TP 5
-\fBMaxClients \fInumber\fR
+\fBMaxClients \fINUMBER\fR
Specifies the maximum number of simultaneous clients that are allowed by the scheduler.
The default is "100".
.\"#MaxClientPerHost
.TP 5
-\fBMaxClientsPerHost \fInumber\fR
+\fBMaxClientsPerHost \fINUMBER\fR
Specifies the maximum number of simultaneous clients that are allowed from a
single address.
The default is the MaxClients value.
.\"#MaxCopies
.TP 5
-\fBMaxCopies \fInumber\fR
+\fBMaxCopies \fINUMBER\fR
Specifies the maximum number of copies that a user can print of each job.
The default is "9999".
.\"#MaxHoldTime
.TP 5
-\fBMaxHoldTime \fIseconds\fR
+\fBMaxHoldTime \fISECONDS\fR
Specifies the maximum time a job may remain in the "indefinite" hold state before it is canceled.
The default is "0" which disables cancellation of held jobs.
.\"#MaxJobs
.TP 5
-\fBMaxJobs \fInumber\fR
+\fBMaxJobs \fINUMBER\fR
Specifies the maximum number of simultaneous jobs that are allowed.
Set to "0" to allow an unlimited number of jobs.
The default is "500".
.\"#MaxJobsPerPrinter
.TP 5
-\fBMaxJobsPerPrinter \fInumber\fR
+\fBMaxJobsPerPrinter \fINUMBER\fR
Specifies the maximum number of simultaneous jobs that are allowed per printer.
The default is "0" which allows up to MaxJobs jobs per printer.
.\"#MaxJobsPerUser
.TP 5
-\fBMaxJobsPerUser \fInumber\fR
+\fBMaxJobsPerUser \fINUMBER\fR
Specifies the maximum number of simultaneous jobs that are allowed per user.
The default is "0" which allows up to MaxJobs jobs per user.
.\"#MaxJobTime
.TP 5
-\fBMaxJobTime \fIseconds\fR
+\fBMaxJobTime \fISECONDS\fR
Specifies the maximum time a job may take to print before it is canceled.
Set to "0" to disable cancellation of "stuck" jobs.
The default is "10800" (3 hours).
.\"#MaxLogSize
.TP 5
-\fBMaxLogSize \fIsize\fR
+\fBMaxLogSize \fISIZE\fR
Specifies the maximum size of the log files before they are rotated.
The value "0" disables log rotation.
The default is "1048576" (1MB).
.\"#MaxSubscriptions
.TP 5
-\fBMaxSubscriptions \fInumber\fR
+\fBMaxSubscriptions \fINUMBER\fR
Specifies the maximum number of simultaneous event subscriptions that are allowed.
Set to "0" to allow an unlimited number of subscriptions.
The default is "100".
.\"#MaxSubscriptionsPerJob
.TP 5
-\fBMaxSubscriptionsPerJob \fInumber\fR
+\fBMaxSubscriptionsPerJob \fINUMBER\fR
Specifies the maximum number of simultaneous event subscriptions that are allowed per job.
The default is "0" which allows up to MaxSubscriptions subscriptions per job.
.\"#MaxSubscriptionsPerPrinter
.TP 5
-\fBMaxSubscriptionsPerPrinter \fInumber\fR
+\fBMaxSubscriptionsPerPrinter \fINUMBER\fR
Specifies the maximum number of simultaneous event subscriptions that are allowed per printer.
The default is "0" which allows up to MaxSubscriptions subscriptions per printer.
.\"#MaxSubscriptionsPerUser
.TP 5
-\fBMaxSubscriptionsPerUser \fInumber\fR
+\fBMaxSubscriptionsPerUser \fINUMBER\fR
Specifies the maximum number of simultaneous event subscriptions that are allowed per user.
The default is "0" which allows up to MaxSubscriptions subscriptions per user.
.\"#MultipleOperationTimeout
.TP 5
-\fBMultipleOperationTimeout \fIseconds\fR
+\fBMultipleOperationTimeout \fISECONDS\fR
Specifies the maximum amount of time to allow between files in a multiple file print job.
The default is "900" (15 minutes).
.\"#Policy
.TP 5
-\fB<Policy \fIname\fB> \fR... \fB</Policy>\fR
+\fB<Policy \fINAME\fB> \fR... \fB</Policy>\fR
Specifies access control for the named policy.
.\"#Port
.TP 5
-\fBPort \fInumber\fR
+\fBPort \fINUMBER\fR
Listens to the specified port number for connections.
.\"#PreserveJobFiles
.TP 5
.TP 5
\fBPreserveJobFiles No\fR
.TP 5
-\fBPreserveJobFiles \fIseconds\fR
+\fBPreserveJobFiles \fISECONDS\fR
Specifies whether job files (documents) are preserved after a job is printed.
If a numeric value is specified, job files are preserved for the indicated number of seconds after printing.
The default is "86400" (preserve 1 day).
.TP 5
\fBPreserveJobHistory No\fR
.TP 5
-\fBPreserveJobHistory \fIseconds\fR
+\fBPreserveJobHistory \fISECONDS\fR
Specifies whether the job history is preserved after a job is printed.
If a numeric value is specified, the job history is preserved for the indicated number of seconds after printing.
If "Yes", the job history is preserved until the MaxJobs limit is reached.
The default is "Yes".
.\"#ReadyPaperSizes
.TP 5
-\fBReadyPaperSizes \fIsizename[,...]\fR
+\fBReadyPaperSizes \fISIZENAME[,...]\fR
Specifies a list of potential paper sizes that are reported as "ready" (loaded).
The actual list will only contain sizes that each printer supports.
The default is "Letter,Legal,Tabloid,4x6,Env10" when the default paper size is "Letter" and "A3,A4,A5,A6,EnvDL" otherwise.
Note: Paper sizes must use the size names from the PPD file and not PWG self-describing media size names.
.\"#ReloadTimeout
.TP 5
-\fBReloadTimeout \fIseconds\fR
+\fBReloadTimeout \fISECONDS\fR
Specifies the amount of time to wait for job completion before restarting the scheduler.
The default is "30".
.\"#ServerAdmin
.TP 5
-\fBServerAdmin \fIemail-address\fR
+\fBServerAdmin \fIEMAIL-ADDRESS\fR
Specifies the email address of the server administrator.
The default value is "root@ServerName".
.\"#ServerAlias
.TP 5
-\fBServerAlias \fIhostname \fR[ ... \fIhostname \fR]
+\fBServerAlias \fIHOSTNAME [... HOSTNAME]\fR]
.TP 5
\fBServerAlias *\fR
The ServerAlias directive is used for HTTP Host header validation when clients connect to the scheduler from external interfaces.
If the auto-discovery of alternate names does not work, we recommend listing each alternate name with a ServerAlias directive instead of using "*".
.\"#ServerName
.TP 5
-\fBServerName \fIhostname\fR
+\fBServerName \fIHOSTNAME\fR
Specifies the fully-qualified hostname of the server.
The default is the value reported by the
.BR hostname (1)
The default is "Minimal".
.\"#SSLListen
.TP 5
-\fBSSLListen \fIipv4-address\fB:\fIport\fR
+\fBSSLListen \fIIPV4-ADDRESS\fB:\fIPORT\fR
.TP 5
-\fBSSLListen [\fIipv6-address\fB]:\fIport\fR
+\fBSSLListen [\fIIPV6-ADDRESS\fB]:\fIPORT\fR
.TP 5
-\fBSSLListen *:\fIport\fR
+\fBSSLListen *:\fIPORT\fR
Listens on the specified address and port for encrypted connections.
.\"#SSLOptions
.TP 5
.TP 5
-\fBSSLOptions \fR[\fIAllowDH\fR] [\fIAllowRC4\fR] [\fIAllowSSL3\fR] [\fIDenyCBC\fR] [\fIDenyTLS1.0\fR] [\fIMaxTLS1.0\fR] [\fIMaxTLS1.1\fR] [\fIMaxTLS1.2\fR] [\fIMaxTLS1.3\fR] [\fIMinTLS1.0\fR] [\fIMinTLS1.1\fR] [\fIMinTLS1.2\fR] [\fIMinTLS1.3\fR] [\fINoSystem\fR]
+\fBSSLOptions \fIOPTIONS\fR
.TP 5
\fBSSLOptions None\fR
Sets encryption options (only in /etc/cups/client.conf).
By default, CUPS only supports encryption using TLS v1.0 or higher using known secure cipher suites.
Security is reduced when \fIAllow\fR options are used.
Security is enhanced when \fIDeny\fR options are used.
-The \fIAllowDH\fR option enables cipher suites using plain Diffie-Hellman key negotiation (not supported on systems using GNU TLS).
-The \fIAllowRC4\fR option enables the 128-bit RC4 cipher suites, which are required for some older clients.
-The \fIAllowSSL3\fR option enables SSL v3.0, which is required for some older clients that do not support TLS v1.0.
-The \fIDenyCBC\fR option disables all CBC cipher suites.
-The \fIDenyTLS1.0\fR option disables TLS v1.0 support - this sets the minimum protocol version to TLS v1.1.
-The \fIMinTLS\fR options set the minimum TLS version to support.
-The \fIMaxTLS\fR options set the maximum TLS version to support.
-The \fINoSystem\fR option disables applying system cryptographic policy.
+The \fBAllowDH\fR option enables cipher suites using plain Diffie-Hellman key negotiation (not supported on systems using GNU TLS).
+The \fBAllowRC4\fR option enables the 128-bit RC4 cipher suites, which are required for some older clients.
+The \fBAllowSSL3\fR option enables SSL v3.0, which is required for some older clients that do not support TLS v1.0.
+The \fBDenyCBC\fR option disables all CBC cipher suites.
+The \fBDenyTLS1.0\fR option disables TLS v1.0 support - this sets the minimum protocol version to TLS v1.1.
+The \fBMinTLS1.0\fR, \fBMinTLS1.1\fR, \fBMinTLS1.2\fR, and \fBMinTLS1.3\fR options set the minimum TLS version to support.
+The \fBMaxTLS1.0\fR, \fBMaxTLS1.1\fR, \fBMaxTLS1.2\fR, and \fBMaxTLS1.3\fR options set the maximum TLS version to support.
+The \fBNoSystem\fR option disables applying system cryptographic policy.
Not all operating systems support TLS 1.3 at this time.
.\"#SSLPort
.TP 5
-\fBSSLPort \fIport\fR
+\fBSSLPort \fIPORT\fR
Listens on the specified port for encrypted connections.
.\"#StrictConformance
.TP 5
The default is "No".
.\"#Timeout
.TP 5
-\fBTimeout \fIseconds\fR
+\fBTimeout \fISECONDS\fR
Specifies the HTTP request timeout.
The default is "900" (15 minutes).
.\"#WebInterface
.TP 5
-\fBWebInterface yes\fR
+\fBWebInterface Yes\fR
.TP 5
-\fBWebInterface no\fR
+\fBWebInterface No\fR
Specifies whether the web interface is enabled.
The default is "No".
.SS HTTP METHOD NAMES
The following HTTP methods are supported by
.BR cupsd (8):
.TP 5
-GET
+.B GET
Used by a client to download icons and other printer resources and to access the CUPS web interface.
.TP 5
-HEAD
+.B HEAD
Used by a client to get the type, size, and modification date of resources.
.TP 5
-OPTIONS
+.B OPTIONS
Used by a client to establish a secure (SSL/TLS) connection.
.TP 5
-POST
+.B POST
Used by a client to submit IPP requests and HTML forms from the CUPS web interface.
.TP 5
-PUT
+.B PUT
Used by a client to upload configuration files.
.SS IPP OPERATION NAMES
The following IPP operations are supported by
.BR cupsd (8):
.TP 5
-CUPS\-Accept\-Jobs
+.B CUPS\-Accept\-Jobs
Allows a printer to accept new jobs.
.TP 5
-CUPS\-Add\-Modify\-Class
+.B CUPS\-Add\-Modify\-Class
Adds or modifies a printer class.
.TP 5
-CUPS\-Add\-Modify\-Printer
+.B CUPS\-Add\-Modify\-Printer
Adds or modifies a printer.
.TP 5
-CUPS\-Authenticate\-Job
+.B CUPS\-Authenticate\-Job
Releases a job that is held for authentication.
.TP 5
-CUPS\-Delete\-Class
+.B CUPS\-Create\-Local\-Printer
+Creates a local, temporary IPP Everywhere printer.
+.TP 5
+.B CUPS\-Delete\-Class
Deletes a printer class.
.TP 5
-CUPS\-Delete\-Printer
+.B CUPS\-Delete\-Printer
Deletes a printer.
.TP 5
-CUPS\-Get\-Classes
+.B CUPS\-Get\-Classes
Gets a list of printer classes.
.TP 5
-CUPS\-Get\-Default
+.B CUPS\-Get\-Default
Gets the server default printer or printer class.
.TP 5
-CUPS\-Get\-Devices
+.B CUPS\-Get\-Devices
Gets a list of devices that are currently available.
.TP 5
-CUPS\-Get\-Document
+.B CUPS\-Get\-Document
Gets a document file for a job.
.TP 5
-CUPS\-Get\-PPD
+.B CUPS\-Get\-PPD
Gets a PPD file.
.TP 5
-CUPS\-Get\-PPDs
+.B CUPS\-Get\-PPDs
Gets a list of installed PPD files.
.TP 5
-CUPS\-Get\-Printers
+.B CUPS\-Get\-Printers
Gets a list of printers.
.TP 5
-CUPS\-Move\-Job
+.B CUPS\-Move\-Job
Moves a job.
.TP 5
-CUPS\-Reject\-Jobs
+.B CUPS\-Reject\-Jobs
Prevents a printer from accepting new jobs.
.TP 5
-CUPS\-Set\-Default
+.B CUPS\-Set\-Default
Sets the server default printer or printer class.
.TP 5
-Cancel\-Job
+.B Cancel\-Job
Cancels a job.
.TP 5
-Cancel\-Jobs
+.B Cancel\-Jobs
Cancels one or more jobs.
.TP 5
-Cancel\-My\-Jobs
+.B Cancel\-My\-Jobs
Cancels one or more jobs creates by a user.
.TP 5
-Cancel\-Subscription
+.B Cancel\-Subscription
Cancels a subscription.
.TP 5
-Close\-Job
+.B Close\-Job
Closes a job that is waiting for more documents.
.TP 5
-Create\-Job
+.B Create\-Job
Creates a new job with no documents.
.TP 5
-Create\-Job\-Subscriptions
+.B Create\-Job\-Subscriptions
Creates a subscription for job events.
.TP 5
-Create\-Printer\-Subscriptions
+.B Create\-Printer\-Subscriptions
Creates a subscription for printer events.
.TP 5
-Get\-Job\-Attributes
+.B Get\-Job\-Attributes
Gets information about a job.
.TP 5
-Get\-Jobs
+.B Get\-Jobs
Gets a list of jobs.
.TP 5
-Get\-Notifications
+.B Get\-Notifications
Gets a list of event notifications for a subscription.
.TP 5
-Get\-Printer\-Attributes
+.B Get\-Printer\-Attributes
Gets information about a printer or printer class.
.TP 5
-Get\-Subscription\-Attributes
+.B Get\-Subscription\-Attributes
Gets information about a subscription.
.TP 5
-Get\-Subscriptions
+.B Get\-Subscriptions
Gets a list of subscriptions.
.TP 5
-Hold\-Job
+.B Hold\-Job
Holds a job from printing.
.TP 5
-Hold\-New\-Jobs
+.B Hold\-New\-Jobs
Holds all new jobs from printing.
.TP 5
-Pause\-Printer
+.B Pause\-Printer
Stops processing of jobs by a printer or printer class.
.TP 5
-Pause\-Printer\-After\-Current\-Job
+.B Pause\-Printer\-After\-Current\-Job
Stops processing of jobs by a printer or printer class after the current job is finished.
.TP 5
-Print\-Job
+.B Print\-Job
Creates a new job with a single document.
.TP 5
-Purge\-Jobs
+.B Purge\-Jobs
Cancels one or more jobs and deletes the job history.
.TP 5
-Release\-Held\-New\-Jobs
+.B Release\-Held\-New\-Jobs
Allows previously held jobs to print.
.TP 5
-Release\-Job
+.B Release\-Job
Allows a job to print.
.TP 5
-Renew\-Subscription
+.B Renew\-Subscription
Renews a subscription.
.TP 5
-Restart\-Job
+.B Restart\-Job
Reprints a job, if possible.
.TP 5
-Send\-Document
+.B Send\-Document
Adds a document to a job.
.TP 5
-Set\-Job\-Attributes
+.B Set\-Job\-Attributes
Changes job information.
.TP 5
-Set\-Printer\-Attributes
+.B Set\-Printer\-Attributes
Changes printer or printer class information.
.TP 5
-Validate\-Job
+.B Validate\-Job
Validates options for a new job.
.SS LOCATION PATHS
The following paths are commonly used when configuring
.BR cupsd (8):
.TP 5
-/
+.B /
The path for all get operations (get-printers, get-jobs, etc.)
.TP 5
-/admin
+.B /admin
The path for all administration operations (add-printer, delete-printer, start-printer, etc.)
.TP 5
-/admin/conf
+.B /admin/conf
The path for access to the CUPS configuration files (cupsd.conf, client.conf, etc.)
.TP 5
-/admin/log
+.B /admin/log
The path for access to the CUPS log files (access_log, error_log, page_log)
.TP 5
-/classes
+.B /classes
The path for all printer classes
.TP 5
-/classes/name
+.B /classes/name
The resource for the named printer class
.TP 5
-/jobs
+.B /jobs
The path for all jobs (hold-job, release-job, etc.)
.TP 5
-/jobs/id
+.B /jobs/id
The path for the specified job
.TP 5
-/printers
+.B /printers
The path for all printers
.TP 5
-/printers/name
+.B /printers/name
The path for the named printer
.TP 5
-/printers/name.png
+.B /printers/name.png
The icon file path for the named printer
.TP 5
-/printers/name.ppd
+.B /printers/name.ppd
The PPD file path for the named printer
.SS DIRECTIVES VALID WITHIN LOCATION AND LIMIT SECTIONS
The following directives may be placed inside Location and Limit sections in the \fBcupsd.conf\fR file:
.TP 5
\fBAllow none\fR
.TP 5
-\fBAllow \fIhost.domain.com\fR
+\fBAllow \fIHOSTNAME\fR
.TP 5
-\fBAllow *.\fIdomain.com\fR
+\fBAllow *.\fIDOMAIN\fR
.TP 5
-\fBAllow \fIipv4-address\fR
+\fBAllow \fIIPV4-ADDRESS\fR
.TP 5
-\fBAllow \fIipv4-address\fB/\fInetmask\fR
+\fBAllow \fIIPV4-ADDRESS\fB/\fINETMASK\fR
.TP 5
-\fBAllow \fIipv4-address\fB/\fImm\fR
+\fBAllow \fIIPV4-ADDRESS\fB/\fIMM\fR
.TP 5
-\fBAllow [\fIipv6-address\fB]\fR
+\fBAllow [\fIIPV6-ADDRESS\fB]\fR
.TP 5
-\fBAllow [\fIipv6-address\fB]/\fImm\fR
+\fBAllow [\fIIPV6-ADDRESS\fB]/\fIMM\fR
.TP 5
-\fBAllow @IF(\fIname\fB)\fR
+\fBAllow @IF(\fINAME\fB)\fR
.TP 5
\fBAllow @LOCAL\fR
Allows access from the named hosts, domains, addresses, or interfaces.
.TP 5
\fBDeny none\fR
.TP 5
-\fBDeny \fIhost.domain.com\fR
+\fBDeny \fIHOSTNAME\fR
.TP 5
-\fBDeny *.\fIdomain.com\fR
+\fBDeny *.\fIDOMAIN\fR
.TP 5
-\fBDeny \fIipv4-address\fR
+\fBDeny \fIIPV4-ADDRESS\fR
.TP 5
-\fBDeny \fIipv4-address\fB/\fInetmask\fR
+\fBDeny \fIIPV4-ADDRESS\fB/\fINETMASK\fR
.TP 5
-\fBDeny \fIipv4-address\fB/\fImm\fR
+\fBDeny \fIIPV4-ADDRESS\fB/\fIMM\fR
.TP 5
-\fBDeny [\fIipv6-address\fB]\fR
+\fBDeny [\fIIPV6-ADDRESS\fB]\fR
.TP 5
-\fBDeny [\fIipv6-address\fB]/\fImm\fR
+\fBDeny [\fIIPV6-ADDRESS\fB]/\fIMM\fR
.TP 5
-\fBDeny @IF(\fIname\fB)\fR
+\fBDeny @IF(\fINAME\fB)\fR
.TP 5
\fBDeny @LOCAL\fR
Denies access from the named hosts, domains, addresses, or interfaces.
\fBOrder deny,allow\fR
Specifies that access is allowed by default. Deny lines are then processed followed by Allow lines to determine whether a client may access a particular resource.
.TP 5
-\fBRequire group \fIgroup-name \fR[ \fIgroup-name \fR... ]
+\fBRequire group \fIGROUP-NAME [... \fIGROUP-NAME]\fR
Specifies that an authenticated user must be a member of one of the named groups.
.TP 5
-\fBRequire user {\fIuser-name\fR|\fB@\fIgroup-name\fR} ...
+\fBRequire user {\fIUSER-NAME\fR|\fB@\fIGROUP-NAME\fR} ...
Specifies that an authenticated user must match one of the named users or be a member of one of the named groups.
The group name "@SYSTEM" corresponds to the list of groups defined by the SystemGroup directive in the
.BR cups-files.conf (5)
.TP 5
\fBJobPrivateAccess default\fR
.TP 5
-\fBJobPrivateAccess \fR{\fIuser\fR|\fB@\fIgroup\fR|\fB@ACL\fR|\fB@OWNER\fR|\fB@SYSTEM\fR} ...
+\fBJobPrivateAccess \fR{\fIUSER\fR|\fB@\fIGROUP\fR|\fB@ACL\fR|\fB@OWNER\fR|\fB@SYSTEM\fR} ...
Specifies an access list for a job's private values.
-The "default" access list is "@OWNER @SYSTEM".
+The default access list is "@OWNER @SYSTEM".
"@ACL" maps to the printer's requesting-user-name-allowed or requesting-user-name-denied values.
"@OWNER" maps to the job's owner.
"@SYSTEM" maps to the groups listed for the SystemGroup directive in the
.TP 5
\fBJobPrivateValues none\fR
.TP 5
-\fBJobPrivateValues \fIattribute-name \fR[ ... \fIattribute-name \fR]
+\fBJobPrivateValues \fIATTRIBUTE-NAME [... ATTRIBUTE-NAME]\fR
Specifies the list of job values to make private.
-The "default" values are "job-name", "job-originating-host-name", "job-originating-user-name", and "phone".
+The default values are "job-name", "job-originating-host-name", "job-originating-user-name", and "phone".
.TP 5
\fBSubscriptionPrivateAccess all\fR
.TP 5
\fBSubscriptionPrivateAccess default\fR
.TP 5
-\fBSubscriptionPrivateAccess \fR{\fIuser\fR|\fB@\fIgroup\fR|\fB@ACL\fR|\fB@OWNER\fR|\fB@SYSTEM\fR} ...
+\fBSubscriptionPrivateAccess \fR{\fIUSER\fR|\fB@\fIGROUP\fR|\fB@ACL\fR|\fB@OWNER\fR|\fB@SYSTEM\fR} ...
Specifies an access list for a subscription's private values.
-The "default" access list is "@OWNER @SYSTEM".
+The default access list is "@OWNER @SYSTEM".
"@ACL" maps to the printer's requesting-user-name-allowed or requesting-user-name-denied values.
"@OWNER" maps to the job's owner.
"@SYSTEM" maps to the groups listed for the SystemGroup directive in the
.TP 5
\fBSubscriptionPrivateValues none\fR
.TP 5
-\fBSubscriptionPrivateValues \fIattribute-name \fR[ ... \fIattribute-name \fR]
+\fBSubscriptionPrivateValues \fIATTRIBUTE-NAME [... ATTRIBUTE-NAME]\fR
Specifies the list of subscription values to make private.
-The "default" values are "notify-events", "notify-pull-method", "notify-recipient-uri", "notify-subscriber-user-name", and "notify-user-data".
+The default values are "notify-events", "notify-pull-method", "notify-recipient-uri", "notify-subscriber-user-name", and "notify-user-data".
.SS DEPRECATED DIRECTIVES
The following directives are deprecated and will be removed in a future release of CUPS:
.TP 5
Specifies Kerberos authentication is required.
.\"#Classification
.TP 5
-\fBClassification \fIbanner\fR
+\fBClassification \fIBANNER\fR
.br
Specifies the security classification of the server.
Any valid banner name can be used, including "classified", "confidential", "secret", "topsecret", and "unclassified", or the banner can be omitted to disable secure printing functions.
Specifies that Kerberos authentication is required by default.
.\"#GSSServiceName
.TP 5
-\fBGSSServiceName \fIname\fR
+\fBGSSServiceName \fINAME\fR
Specifies the service name when using Kerberos authentication.
The default service name is "http."
.\"#PageLogFormat
.TP 5
-\fBPageLogFormat \fIformat-string\fR
+\fBPageLogFormat \fIFORMAT-STRING\fR
Specifies the format of PageLog lines.
Sequences beginning with percent (%) characters are replaced with the corresponding information, while all other characters are copied literally.
The following percent sequences are recognized:
/*
* Printer class routines for the CUPS scheduler.
*
- * Copyright © 2020-2024 by OpenPrinting.
- * Copyright 2007-2017 by Apple Inc.
- * Copyright 1997-2007 by Easy Software Products, all rights reserved.
+ * Copyright © 2020-2025 by OpenPrinting.
+ * Copyright © 2007-2017 by Apple Inc.
+ * Copyright © 1997-2007 by Easy Software Products, all rights reserved.
*
- * Licensed under Apache License v2.0. See the file "LICENSE" for more information.
+ * Licensed under Apache License v2.0. See the file "LICENSE" for more
+ * information.
*/
/*
value[2048], /* Value string */
*name; /* Current user name */
cupsd_printer_t *pclass; /* Current printer class */
- int i; /* Looping var */
+ int i, j, /* Looping vars */
+ pcount; /* Number of printers */
cups_option_t *option; /* Current option */
* Write each local class known to the system...
*/
- for (pclass = (cupsd_printer_t *)cupsArrayFirst(Printers);
- pclass;
- pclass = (cupsd_printer_t *)cupsArrayNext(Printers))
+ cupsRWLockRead(&PrintersLock);
+
+ for (i = 0, pcount = cupsArrayGetCount(Printers); i < pcount; i ++)
{
/*
* Skip remote destinations and regular printers...
*/
+ pclass = (cupsd_printer_t *)cupsArrayGetElement(Printers, i);
+
if ((pclass->type & CUPS_PTYPE_REMOTE) ||
!(pclass->type & CUPS_PTYPE_CLASS))
continue;
pclass->job_sheets[1]);
cupsFilePutConf(fp, "JobSheets", value);
- for (i = 0; i < pclass->num_printers; i ++)
- cupsFilePrintf(fp, "Printer %s\n", pclass->printers[i]->name);
+ for (j = 0; j < pclass->num_printers; j ++)
+ cupsFilePrintf(fp, "Printer %s\n", pclass->printers[j]->name);
cupsFilePrintf(fp, "QuotaPeriod %d\n", pclass->quota_period);
cupsFilePrintf(fp, "PageLimit %d\n", pclass->page_limit);
if (pclass->error_policy)
cupsFilePutConf(fp, "ErrorPolicy", pclass->error_policy);
- for (i = pclass->num_options, option = pclass->options;
- i > 0;
- i --, option ++)
+ for (j = pclass->num_options, option = pclass->options;
+ j > 0;
+ j --, option ++)
{
snprintf(value, sizeof(value), "%s %s", option->name, option->value);
cupsFilePutConf(fp, "Option", value);
cupsFilePuts(fp, "</Class>\n");
}
+ cupsRWUnlock(&PrintersLock);
+
cupsdCloseCreatedConfFile(fp, filename);
}
{ "DefaultPolicy", &DefaultPolicy, CUPSD_VARTYPE_STRING },
{ "DefaultShared", &DefaultShared, CUPSD_VARTYPE_BOOLEAN },
{ "DirtyCleanInterval", &DirtyCleanInterval, CUPSD_VARTYPE_TIME },
+ { "DNSSDComputerName", &DNSSDComputerName, CUPSD_VARTYPE_STRING },
{ "DNSSDHostName", &DNSSDHostName, CUPSD_VARTYPE_STRING },
{ "ErrorPolicy", &ErrorPolicy, CUPSD_VARTYPE_STRING },
{ "FilterLimit", &FilterLimit, CUPSD_VARTYPE_INTEGER },
Browsing = CUPS_DEFAULT_BROWSING;
DefaultShared = CUPS_DEFAULT_DEFAULT_SHARED;
- cupsdSetString(&DNSSDSubTypes, "_cups,_print,_universal");
+ cupsdClearString(&DNSSDComputerName);
cupsdClearString(&DNSSDHostName);
+ cupsdSetString(&DNSSDSubTypes, "_cups,_print,_universal");
cupsdSetString(&ErrorPolicy, CUPS_DEFAULT_ERROR_POLICY);
return (0);
}
+ DNSSDComputerNameConfigured = DNSSDComputerName != NULL;
+ DNSSDHostNameConfigured = DNSSDHostName != NULL;
+
+ if (DNSSDComputerName && (!*DNSSDComputerName || !strcmp(DNSSDComputerName, "none")))
+ cupsdClearString(&DNSSDComputerName);
+
RunUser = getuid();
cupsdLogMessage(CUPSD_LOG_INFO, "Remote access is %s.",
void
cupsdStartBrowsing(void)
{
- cupsd_printer_t *p; /* Current printer */
-
-
if (!Browsing || !BrowseLocalProtocols)
return;
DNSSDPort = 0;
cupsdUpdateDNSSDName();
-
- /*
- * Register the individual printers
- */
-
- for (p = (cupsd_printer_t *)cupsArrayFirst(Printers); p; p = (cupsd_printer_t *)cupsArrayNext(Printers))
- {
- if (!(p->type & (CUPS_PTYPE_REMOTE | CUPS_PTYPE_SCANNER)))
- dnssdRegisterPrinter(p);
- }
}
}
void
cupsdUpdateDNSSDName(void)
{
- char name[1024]; /* Computer/host name */
+ char name[1024]; /* Computer/host name */
+ cupsd_printer_t *p; /* Current printer */
+ int i, /* Looping var */
+ pcount; /* Number of printers */
/*
if (!DNSSDPort)
return;
+ cupsdLogMessage(CUPSD_LOG_DEBUG, "Using port %d for DNS-SD services.", DNSSDPort);
+
/*
* Get the computer name...
*/
- if (cupsDNSSDCopyComputerName(DNSSDContext, name, sizeof(name)) && name[0])
- cupsdSetString(&DNSSDComputerName, name);
-
- if (!DNSSDComputerName)
+ if (!DNSSDComputerNameConfigured)
{
- /*
- * Use the ServerName instead...
- */
-
- cupsdLogMessage(CUPSD_LOG_DEBUG, "Using ServerName \"%s\" as computer name.", ServerName);
- cupsdSetString(&DNSSDComputerName, ServerName);
+ if (cupsDNSSDCopyComputerName(DNSSDContext, name, sizeof(name)) && name[0])
+ cupsdSetString(&DNSSDComputerName, name);
+ else
+ cupsdSetString(&DNSSDComputerName, ServerName);
}
+ if (DNSSDComputerName)
+ cupsdLogMessage(CUPSD_LOG_DEBUG, "Appending \"@ %s\" to DNS-SD shared printer names.", DNSSDComputerName);
+
/*
* Get the hostname...
*/
- if (cupsDNSSDCopyHostName(DNSSDContext, name, sizeof(name)))
- cupsdSetString(&DNSSDHostName, name);
-
- if (!DNSSDHostName)
+ if (!DNSSDHostNameConfigured)
{
- if (strchr(ServerName, '.'))
+ if (cupsDNSSDCopyHostName(DNSSDContext, name, sizeof(name)))
+ cupsdSetString(&DNSSDHostName, name);
+ else if (strchr(ServerName, '.'))
cupsdSetString(&DNSSDHostName, ServerName);
else
cupsdSetStringf(&DNSSDHostName, "%s.local", ServerName);
- cupsdLogMessage(CUPSD_LOG_INFO, "Defaulting to \"DNSSDHostName %s\".", DNSSDHostName);
+ cupsdLogMessage(CUPSD_LOG_DEBUG, "DNS-SD host name is now \"%s\".", DNSSDHostName);
}
/*
- * Then (re)register the web interface if enabled...
+ * Then (re)register the web interface if enabled and any shared printers...
*/
cupsDNSSDServiceDelete(DNSSDWebIF);
cupsDNSSDServiceAdd(DNSSDWebIF, "_http._tcp", /*domain*/NULL, DNSSDHostName, (uint16_t)DNSSDPort, /*num_txt*/0, /*txt*/NULL);
cupsDNSSDServicePublish(DNSSDWebIF);
}
+
+ /*
+ * (Re)register the individual printers
+ */
+
+ cupsRWLockRead(&PrintersLock);
+ for (i = 0, pcount = cupsArrayGetCount(Printers); i < pcount; i ++)
+ {
+ p = (cupsd_printer_t *)cupsArrayGetElement(Printers, i);
+
+ if (!(p->type & (CUPS_PTYPE_REMOTE | CUPS_PTYPE_SCANNER)))
+ dnssdRegisterPrinter(p);
+ }
+ cupsRWUnlock(&PrintersLock);
}
const char *reg_name; // Updated service name
- if (flags & CUPS_DNSSD_FLAGS_ERROR)
+ if ((flags & CUPS_DNSSD_FLAGS_ERROR) || !p)
return;
- if (!p)
- return;
+ if (flags & CUPS_DNSSD_FLAGS_HOST_CHANGE)
+ cupsdUpdateDNSSDName();
reg_name = cupsDNSSDServiceGetName(service);
/*
* Directory services definitions for the CUPS scheduler.
*
- * Copyright © 2020-2024 by OpenPrinting.
+ * Copyright © 2020-2025 by OpenPrinting.
* Copyright © 2007-2017 by Apple Inc.
* Copyright © 1997-2007 by Easy Software Products, all rights reserved.
*
BrowseLocalProtocols
VALUE(BROWSE_ALL);
/* Protocols to support for local printers */
-VAR char *DNSSDComputerName VALUE(NULL),
+VAR char *DNSSDComputerName VALUE(NULL);
/* Computer/server name */
- *DNSSDHostName VALUE(NULL),
+VAR int DNSSDComputerNameConfigured VALUE(0);
+ /* Was the DNSSDComputerName value configured in cupsd.conf? */
+VAR char *DNSSDHostName VALUE(NULL);
/* Hostname */
- *DNSSDSubTypes VALUE(NULL);
+VAR int DNSSDHostNameConfigured VALUE(0);
+ /* Was the DNSSDHostName value configured in cupsd.conf? */
+VAR char *DNSSDSubTypes VALUE(NULL);
/* Bonjour registration subtypes */
VAR cups_array_t *DNSSDAlias VALUE(NULL);
/* List of dynamic ServerAlias's */
* OK, build a list of printers for this printer...
*/
+ cupsRWLockWrite(&PrintersLock); // Should be a reader lock, but we can't easily update loop logic right now
+
if (first_printer_name)
{
if ((printer = cupsdFindDest(first_printer_name)) == NULL)
}
}
+ cupsRWUnlock(&PrintersLock);
+
cupsArrayDelete(ra);
con->response->request.status.status_code = IPP_STATUS_OK;
+++ /dev/null
-_mimeAddFilter
-_mimeAddType
-_mimeAddTypeRule
-_mimeDelete
-_mimeDeleteFilter
-_mimeDeleteType
-_mimeFileType
-_mimeFilter
-_mimeFilter2
-_mimeFilterLookup
-_mimeFirstFilter
-_mimeFirstType
-_mimeLoad
-_mimeLoadFilters
-_mimeLoadTypes
-_mimeNew
-_mimeNextFilter
-_mimeNextType
-_mimeNumFilters
-_mimeNumTypes
-_mimeSetErrorCallback
-_mimeType
* Insert the printer in the printer list alphabetically...
*/
+ cupsRWLockWrite(&PrintersLock);
+
if (!Printers)
Printers = cupsArrayNew(compare_printers, NULL);
- cupsdLogMessage(CUPSD_LOG_DEBUG2,
- "cupsdAddPrinter: Adding %s to Printers", p->name);
+ cupsdLogMessage(CUPSD_LOG_DEBUG2, "cupsdAddPrinter: Adding %s to Printers", p->name);
cupsArrayAdd(Printers, p);
+ cupsRWUnlock(&PrintersLock);
+
/*
* Return the new printer...
*/
cupsd_printer_t * /* O - Destination in list */
cupsdFindDest(const char *name) /* I - Name of printer or class to find */
{
- cupsd_printer_t key; /* Search key */
+ cupsd_printer_t key, /* Search key */
+ *match; /* Match */
+
+ cupsRWLockRead(&PrintersLock);
key.name = (char *)name;
- return ((cupsd_printer_t *)cupsArrayFind(Printers, &key));
+ match = (cupsd_printer_t *)cupsArrayFind(Printers, &key);
+
+ cupsRWUnlock(&PrintersLock);
+
+ return (match);
}
*value, /* Pointer to value */
*valueptr; /* Pointer into value */
cupsd_printer_t *p; /* Current printer */
- int found_raw = 0; /* Flag whether raw queue is installed */
- int found_driver = 0; /* Flag whether queue with classic driver is installed */
+ int found_raw = 0; /* Flag whether raw queue is installed */
+ int found_driver = 0;
+ /* Flag whether queue with classic driver is installed */
/*
* Remove the printer from the array(s) first...
*/
- cupsdLogMessage(CUPSD_LOG_DEBUG2,
- "cupsdRenamePrinter: Removing %s from Printers", p->name);
+ cupsRWLockWrite(&PrintersLock);
+
+ cupsdLogMessage(CUPSD_LOG_DEBUG2, "cupsdRenamePrinter: Removing %s from Printers", p->name);
cupsArrayRemove(Printers, p);
/*
* Add the printer back to the printer array(s)...
*/
- cupsdLogMessage(CUPSD_LOG_DEBUG2,
- "cupsdRenamePrinter: Adding %s to Printers", p->name);
+ cupsdLogMessage(CUPSD_LOG_DEBUG2, "cupsdRenamePrinter: Adding %s to Printers", p->name);
cupsArrayAdd(Printers, p);
+
+ cupsRWUnlock(&PrintersLock);
}
void
cupsdSaveAllPrinters(void)
{
- int i; /* Looping var */
+ int i, j, /* Looping vars */
+ pcount; /* Number of printers */
cups_file_t *fp; /* printers.conf file */
char filename[1024], /* printers.conf filename */
value[2048], /* Value string */
* Write each local printer known to the system...
*/
- for (printer = (cupsd_printer_t *)cupsArrayFirst(Printers);
- printer;
- printer = (cupsd_printer_t *)cupsArrayNext(Printers))
+ cupsRWLockRead(&PrintersLock);
+
+ for (i = 0, pcount = cupsArrayGetCount(Printers); i < pcount; i ++)
{
/*
* Skip printer classes and temporary queues...
*/
+ printer = (cupsd_printer_t *)cupsArrayGetElement(Printers, i);
+
if ((printer->type & CUPS_PTYPE_CLASS) || printer->temporary)
continue;
cupsFilePrintf(fp, "StateTime %d\n", (int)printer->state_time);
cupsFilePrintf(fp, "ConfigTime %d\n", (int)printer->config_time);
- for (i = 0; i < printer->num_reasons; i ++)
- if (strcmp(printer->reasons[i], "connecting-to-device") &&
- strcmp(printer->reasons[i], "cups-insecure-filter-warning") &&
- strcmp(printer->reasons[i], "cups-missing-filter-warning"))
- cupsFilePutConf(fp, "Reason", printer->reasons[i]);
+ for (j = 0; j < printer->num_reasons; j ++)
+ if (strcmp(printer->reasons[j], "connecting-to-device") &&
+ strcmp(printer->reasons[j], "cups-insecure-filter-warning") &&
+ strcmp(printer->reasons[j], "cups-missing-filter-warning"))
+ cupsFilePutConf(fp, "Reason", printer->reasons[j]);
cupsFilePrintf(fp, "Type %d\n", printer->type);
if (printer->error_policy)
cupsFilePutConf(fp, "ErrorPolicy", printer->error_policy);
- for (i = printer->num_options, option = printer->options;
- i > 0;
- i --, option ++)
+ for (j = printer->num_options, option = printer->options;
+ j > 0;
+ j --, option ++)
{
snprintf(value, sizeof(value), "%s %s", option->name, option->value);
cupsFilePutConf(fp, "Option", value);
{
snprintf(value, sizeof(value), "%s ", marker->name);
- for (i = 0, ptr = value + strlen(value);
- i < marker->num_values && ptr < (value + sizeof(value) - 1);
- i ++)
+ for (j = 0, ptr = value + strlen(value);
+ j < marker->num_values && ptr < (value + sizeof(value) - 1);
+ j ++)
{
- if (i)
+ if (j)
*ptr++ = ',';
- cupsCopyString(ptr, marker->values[i].string.text, (size_t)(value + sizeof(value) - ptr));
+ cupsCopyString(ptr, marker->values[j].string.text, (size_t)(value + sizeof(value) - ptr));
ptr += strlen(ptr);
}
{
cupsFilePrintf(fp, "Attribute %s %d", marker->name,
marker->values[0].integer);
- for (i = 1; i < marker->num_values; i ++)
- cupsFilePrintf(fp, ",%d", marker->values[i].integer);
+ for (j = 1; j < marker->num_values; j ++)
+ cupsFilePrintf(fp, ",%d", marker->values[j].integer);
cupsFilePuts(fp, "\n");
}
{
cupsFilePrintf(fp, "Attribute %s %d", marker->name,
marker->values[0].integer);
- for (i = 1; i < marker->num_values; i ++)
- cupsFilePrintf(fp, ",%d", marker->values[i].integer);
+ for (j = 1; j < marker->num_values; j ++)
+ cupsFilePrintf(fp, ",%d", marker->values[j].integer);
cupsFilePuts(fp, "\n");
}
{
cupsFilePrintf(fp, "Attribute %s %d", marker->name,
marker->values[0].integer);
- for (i = 1; i < marker->num_values; i ++)
- cupsFilePrintf(fp, ",%d", marker->values[i].integer);
+ for (j = 1; j < marker->num_values; j ++)
+ cupsFilePrintf(fp, ",%d", marker->values[j].integer);
cupsFilePuts(fp, "\n");
}
{
snprintf(value, sizeof(value), "%s ", marker->name);
- for (i = 0, ptr = value + strlen(value);
- i < marker->num_values && ptr < (value + sizeof(value) - 1);
- i ++)
+ for (j = 0, ptr = value + strlen(value);
+ j < marker->num_values && ptr < (value + sizeof(value) - 1);
+ j ++)
{
- if (i)
+ if (j)
*ptr++ = ',';
- cupsCopyString(ptr, marker->values[i].string.text, (size_t)(value + sizeof(value) - ptr));
+ cupsCopyString(ptr, marker->values[j].string.text, (size_t)(value + sizeof(value) - ptr));
ptr += strlen(ptr);
}
{
snprintf(value, sizeof(value), "%s ", marker->name);
- for (i = 0, ptr = value + strlen(value);
- i < marker->num_values && ptr < (value + sizeof(value) - 1);
- i ++)
+ for (j = 0, ptr = value + strlen(value);
+ j < marker->num_values && ptr < (value + sizeof(value) - 1);
+ j ++)
{
- if (i)
+ if (j)
*ptr++ = ',';
- cupsCopyString(ptr, marker->values[i].string.text, (size_t)(value + sizeof(value) - ptr));
+ cupsCopyString(ptr, marker->values[j].string.text, (size_t)(value + sizeof(value) - ptr));
ptr += strlen(ptr);
}
cupsFilePuts(fp, "</Printer>\n");
}
+ cupsRWUnlock(&PrintersLock);
+
cupsdCloseCreatedConfFile(fp, filename);
}
/*
* Printer definitions for the CUPS scheduler.
*
- * Copyright © 2020-2024 by OpenPrinting.
+ * Copyright © 2020-2025 by OpenPrinting.
* Copyright @ 2007-2017 by Apple Inc.
* Copyright @ 1997-2007 by Easy Software Products, all rights reserved.
*
- * Licensed under Apache License v2.0. See the file "LICENSE" for more information.
+ * Licensed under Apache License v2.0. See the file "LICENSE" for more
+ * information.
*/
#include <cups/pwg-private.h>
/* Next printer-id value */
VAR cups_array_t *Printers VALUE(NULL);
/* Printer list */
+VAR cups_rwlock_t PrintersLock VALUE(CUPS_RWLOCK_INITIALIZER);
+ /* Reader/writer lock for printers list */
VAR cupsd_printer_t *DefaultPrinter VALUE(NULL);
/* Default printer */
VAR char *DefaultPolicy VALUE(NULL);
projects / thirdparty / cups.git / commitdiff
