1<!DOCTYPE HTML> 2<html> 3<!-- SECTION: Man Pages --> 4<head> 5 <link rel="stylesheet" type="text/css" href="/cups-printable.css"> 6 <title>cupsd.conf(5)</title> 7</head> 8<body> 9<h1 class="title">cupsd.conf(5)</h1> 10<h2 class="title"><a name="NAME">Name</a></h2> 11cupsd.conf - server configuration file for cups 12<h2 class="title"><a name="DESCRIPTION">Description</a></h2> 13The 14<i>cupsd.conf</i> 15file configures the CUPS scheduler, 16<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8).</a> 17It is normally located in the 18<i>/etc/cups</i> 19directory. 20<b>Note:</b> File, directory, and user configuration directives that used to be allowed in the <b>cupsd.conf</b> file are now stored in the 21<a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5)</a> 22file instead in order to prevent certain types of privilege escalation attacks. 23<p>Each line in the file can be a configuration directive, a blank line, or a comment. 24Configuration directives typically consist of a name and zero or more values separated by whitespace. 25The configuration directive name and values are case-insensitive. 26Comment lines start with the # character. 27<h3><a name="TOP_LEVEL_DIRECTIVES">Top-level Directives</a></h3> 28The following top-level directives are understood by 29<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8):</a> 30<dl class="man"> 31<dt><b>AccessLogLevel config</b> 32<dd style="margin-left: 5.0em"><dt><b>AccessLogLevel actions</b> 33<dd style="margin-left: 5.0em"><dt><b>AccessLogLevel all</b> 34<dd style="margin-left: 5.0em">Specifies the logging level for the AccessLog file. 35The "config" level logs when printers and classes are added, deleted, or modified and when configuration files are accessed or updated. 36The "actions" level logs when print jobs are submitted, held, released, modified, or canceled, and any of the conditions for "config". 37The "all" level logs all requests. 38The default access log level is "actions". 39<dt><b>AutoPurgeJobs Yes</b> 40<dd style="margin-left: 5.0em"><dt><b>AutoPurgeJobs No</b> 41<dd style="margin-left: 5.0em"><br> 42Specifies whether to purge job history data automatically when it is no longer required for quotas. 43The default is "No". 44<dt><b>BrowseLocalProtocols all</b> 45<dd style="margin-left: 5.0em"><dt><b>BrowseLocalProtocols dnssd</b> 46<dd style="margin-left: 5.0em"><dt><b>BrowseLocalProtocols none</b> 47<dd style="margin-left: 5.0em">Specifies which protocols to use for local printer sharing. 48The default is "dnssd" on systems that support Bonjour and "none" otherwise. 49<dt><b>BrowseWebIF Yes</b> 50<dd style="margin-left: 5.0em"><dt><b>BrowseWebIF No</b> 51<dd style="margin-left: 5.0em"><br> 52Specifies whether the CUPS web interface is advertised. 53The default is "No". 54<dt><b>Browsing Yes</b> 55<dd style="margin-left: 5.0em"><dt><b>Browsing No</b> 56<dd style="margin-left: 5.0em"><br> 57Specifies whether shared printers are advertised. 58The default is "No". 59<dt><b>Classification </b><i>banner</i> 60<dd style="margin-left: 5.0em"><br> 61Specifies the security classification of the server. 62Any valid banner name can be used, including "classified", "confidential", "secret", "topsecret", and "unclassified", or the banner can be omitted to disable secure printing functions. 63The default is no classification banner. 64<dt><b>ClassifyOverride Yes</b> 65<dd style="margin-left: 5.0em"><dt><b>ClassifyOverride No</b> 66<dd style="margin-left: 5.0em"><br> 67Specifies whether users may override the classification (cover page) of individual print jobs using the "job-sheets" option. 68The default is "No". 69<dt><b>DefaultAuthType Basic</b> 70<dd style="margin-left: 5.0em"><dt><b>DefaultAuthType Negotiate</b> 71<dd style="margin-left: 5.0em"><br> 72Specifies the default type of authentication to use. 73The default is "Basic". 74<dt><b>DefaultEncryption Never</b> 75<dd style="margin-left: 5.0em"><dt><b>DefaultEncryption IfRequested</b> 76<dd style="margin-left: 5.0em"><dt><b>DefaultEncryption Required</b> 77<dd style="margin-left: 5.0em">Specifies whether encryption will be used for authenticated requests. 78The default is "Required". 79<dt><b>DefaultLanguage </b><i>locale</i> 80<dd style="margin-left: 5.0em">Specifies the default language to use for text and web content. 81The default is "en". 82<dt><b>DefaultPaperSize Auto</b> 83<dd style="margin-left: 5.0em"><dt><b>DefaultPaperSize None</b> 84<dd style="margin-left: 5.0em"><dt><b>DefaultPaperSize </b><i>sizename</i> 85<dd style="margin-left: 5.0em">Specifies the default paper size for new print queues. "Auto" uses a locale-specific default, while "None" specifies there is no default paper size. 86Specific size names are typically "Letter" or "A4". 87The default is "Auto". 88<dt><b>DefaultPolicy </b><i>policy-name</i> 89<dd style="margin-left: 5.0em">Specifies the default access policy to use. 90The default access policy is "default". 91<dt><b>DefaultShared Yes</b> 92<dd style="margin-left: 5.0em"><dt><b>DefaultShared No</b> 93<dd style="margin-left: 5.0em">Specifies whether local printers are shared by default. 94The default is "Yes". 95<dt><b>DirtyCleanInterval </b><i>seconds</i> 96<dd style="margin-left: 5.0em">Specifies the delay for updating of configuration and state files. 97A value of 0 causes the update to happen as soon as possible, typically within a few milliseconds. 98The default value is "30". 99<dt><b>ErrorPolicy abort-job</b> 100<dd style="margin-left: 5.0em">Specifies that a failed print job should be aborted (discarded) unless otherwise specified for the printer. 101<dt><b>ErrorPolicy retry-job</b> 102<dd style="margin-left: 5.0em">Specifies that a failed print job should be retried at a later time unless otherwise specified for the printer. 103<dt><b>ErrorPolicy retry-this-job</b> 104<dd style="margin-left: 5.0em">Specifies that a failed print job should be retried immediately unless otherwise specified for the printer. 105<dt><b>ErrorPolicy stop-printer</b> 106<dd style="margin-left: 5.0em">Specifies that a failed print job should stop the printer unless otherwise specified for the printer. The 'stop-printer' error policy is the default. 107<dt><b>FilterLimit </b><i>limit</i> 108<dd style="margin-left: 5.0em">Specifies the maximum cost of filters that are run concurrently, which can be used to minimize disk, memory, and CPU resource problems. 109A limit of 0 disables filter limiting. 110An average print to a non-PostScript printer needs a filter limit of about 200. 111A PostScript printer needs about half that (100). 112Setting the limit below these thresholds will effectively limit the scheduler to printing a single job at any time. 113The default limit is "0". 114<dt><b>FilterNice </b><i>nice-value</i> 115<dd style="margin-left: 5.0em">Specifies the scheduling priority ( 116<b>nice</b>(8) 117value) of filters that are run to print a job. 118The nice value ranges from 0, the highest priority, to 19, the lowest priority. 119The default is 0. 120<dt><b>GSSServiceName </b><i>name</i> 121<dd style="margin-left: 5.0em">Specifies the service name when using Kerberos authentication. 122The default service name is "http." 123<dt><b>HostNameLookups On</b> 124<dd style="margin-left: 5.0em"><dt><b>HostNameLookups Off</b> 125<dd style="margin-left: 5.0em"><dt><b>HostNameLookups Double</b> 126<dd style="margin-left: 5.0em">Specifies whether to do reverse lookups on connecting clients. 127The "Double" setting causes 128<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8)</a> 129to verify that the hostname resolved from the address matches one of the addresses returned for that hostname. 130Double lookups also prevent clients with unregistered addresses from connecting to your server. 131The default is "Off" to avoid the potential server performance problems with hostname lookups. 132Only set this option to "On" or "Double" if absolutely required. 133<dt><b>JobKillDelay </b><i>seconds</i> 134<dd style="margin-left: 5.0em">Specifies the number of seconds to wait before killing the filters and backend associated with a canceled or held job. 135The default is "30". 136<dt><b>JobRetryInterval </b><i>seconds</i> 137<dd style="margin-left: 5.0em">Specifies the interval between retries of jobs in seconds. 138This is typically used for fax queues but can also be used with normal print queues whose error policy is "retry-job" or "retry-current-job". 139The default is "30". 140<dt><b>JobRetryLimit </b><i>count</i> 141<dd style="margin-left: 5.0em">Specifies the number of retries that are done for jobs. 142This is typically used for fax queues but can also be used with normal print queues whose error policy is "retry-job" or "retry-current-job". 143The default is "5". 144<dt><b>KeepAlive Yes</b> 145<dd style="margin-left: 5.0em"><dt><b>KeepAlive No</b> 146<dd style="margin-left: 5.0em">Specifies whether to support HTTP keep-alive connections. 147The default is "Yes". 148<dt><b>KeepAliveTimeout </b><i>seconds</i> 149<dd style="margin-left: 5.0em">Specifies how long an idle client connection remains open. 150The default is "30". 151<dt><b><Limit </b><i>operation </i>...<b>> </b>... <b></Limit></b> 152<dd style="margin-left: 5.0em">Specifies the IPP operations that are being limited inside a Policy section. IPP operation names are listed below in the section "IPP OPERATIONS". 153<dt><b><Limit </b><i>method </i>...<b>> </b>... <b></Limit></b> 154<dd style="margin-left: 5.0em"><dt><b><LimitExcept </b><i>method </i>...<b>> </b>... <b></LimitExcept></b> 155<dd style="margin-left: 5.0em">Specifies the HTTP methods that are being limited inside a Location section. HTTP method names are listed below in the section "HTTP METHODS". 156<dt><b>LimitRequestBody </b><i>size</i> 157<dd style="margin-left: 5.0em">Specifies the maximum size of print files, IPP requests, and HTML form data. 158The default is "0" which disables the limit check. 159<dt><b>Listen </b><i>ipv4-address</i><b>:</b><i>port</i> 160<dd style="margin-left: 5.0em"><dt><b>Listen [</b><i>ipv6-address</i><b>]:</b><i>port</i> 161<dd style="margin-left: 5.0em"><dt><b>Listen *:</b><i>port</i> 162<dd style="margin-left: 5.0em"><dt><b>Listen </b><i>/path/to/domain/socket</i> 163<dd style="margin-left: 5.0em">Listens to the specified address and port or domain socket path for connections. 164Multiple Listen directives can be provided to listen on multiple addresses. 165The Listen directive is similar to the Port directive but allows you to restrict access to specific interfaces or networks. 166<dt><b>ListenBackLog </b><i>number</i> 167<dd style="margin-left: 5.0em">Specifies the number of pending connections that will be allowed. 168This normally only affects very busy servers that have reached the MaxClients limit, but can also be triggered by large numbers of simultaneous connections. 169When the limit is reached, the operating system will refuse additional connections until the scheduler can accept the pending ones. 170The default is the OS-defined default limit, typically either "5" for older operating systems or "128" for newer operating systems. 171<dt><b><Location </b><i>/path</i><b>> </b>... <b></Location></b> 172<dd style="margin-left: 5.0em">Specifies access control for the named location. 173Paths are documented below in the section "LOCATION PATHS". 174<dt><b>LogDebugHistory </b><i>number</i> 175<dd style="margin-left: 5.0em">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. 176<dt><b>LogLevel </b>none 177<dd style="margin-left: 5.0em"><dt><b>LogLevel </b>emerg 178<dd style="margin-left: 5.0em"><dt><b>LogLevel </b>alert 179<dd style="margin-left: 5.0em"><dt><b>LogLevel </b>crit 180<dd style="margin-left: 5.0em"><dt><b>LogLevel </b>error 181<dd style="margin-left: 5.0em"><dt><b>LogLevel </b>warn 182<dd style="margin-left: 5.0em"><dt><b>LogLevel </b>notice 183<dd style="margin-left: 5.0em"><dt><b>LogLevel </b>info 184<dd style="margin-left: 5.0em"><dt><b>LogLevel </b>debug 185<dd style="margin-left: 5.0em"><dt><b>LogLevel </b>debug2 186<dd style="margin-left: 5.0em">Specifies the level of logging for the ErrorLog file. 187The value "none" stops all logging while "debug2" logs everything. 188The default is "warn". 189<dt><b>LogTimeFormat </b>standard 190<dd style="margin-left: 5.0em"><dt><b>LogTimeFormat </b>usecs 191<dd style="margin-left: 5.0em">Specifies the format of the date and time in the log files. 192The value "standard" is the default and logs whole seconds while "usecs" logs microseconds. 193<dt><b>MaxClients </b><i>number</i> 194<dd style="margin-left: 5.0em">Specifies the maximum number of simultaneous clients that are allowed by the scheduler. 195The default is "100". 196<dt><b>MaxClientsPerHost </b><i>number</i> 197<dd style="margin-left: 5.0em">Specifies the maximum number of simultaneous clients that are allowed from a 198single address. 199The default is the MaxClients value. 200<dt><b>MaxCopies </b><i>number</i> 201<dd style="margin-left: 5.0em">Specifies the maximum number of copies that a user can print of each job. 202The default is "9999". 203<dt><b>MaxHoldTime </b><i>seconds</i> 204<dd style="margin-left: 5.0em">Specifies the maximum time a job may remain in the "indefinite" hold state before it is canceled. 205The default is "0" which disables cancellation of held jobs. 206<dt><b>MaxJobs </b><i>number</i> 207<dd style="margin-left: 5.0em">Specifies the maximum number of simultaneous jobs that are allowed. 208Set to "0" to allow an unlimited number of jobs. 209The default is "500". 210<dt><b>MaxJobsPerPrinter </b><i>number</i> 211<dd style="margin-left: 5.0em">Specifies the maximum number of simultaneous jobs that are allowed per printer. 212The default is "0" which allows up to MaxJobs jobs per printer. 213<dt><b>MaxJobsPerUser </b><i>number</i> 214<dd style="margin-left: 5.0em">Specifies the maximum number of simultaneous jobs that are allowed per user. 215The default is "0" which allows up to MaxJobs jobs per user. 216<dt><b>MaxJobTime </b><i>seconds</i> 217<dd style="margin-left: 5.0em">Specifies the maximum time a job may take to print before it is canceled. 218Set to "0" to disable cancellation of "stuck" jobs. 219The default is "10800" (3 hours). 220<dt><b>MaxLogSize </b><i>size</i> 221<dd style="margin-left: 5.0em">Specifies the maximum size of the log files before they are rotated. 222The value "0" disables log rotation. 223The default is "1048576" (1MB). 224<dt><b>MultipleOperationTimeout </b><i>seconds</i> 225<dd style="margin-left: 5.0em">Specifies the maximum amount of time to allow between files in a multiple file print job. 226The default is "300" (5 minutes). 227<dt><b>PageLogFormat </b><i>format-string</i> 228<dd style="margin-left: 5.0em">Specifies the format of PageLog lines. 229Sequences beginning with percent (%) characters are replaced with the corresponding information, while all other characters are copied literally. 230The following percent sequences are recognized: 231<pre class="man"> 232 233 "%%" inserts a single percent character. 234 "%{name}" inserts the value of the specified IPP attribute. 235 "%C" inserts the number of copies for the current page. 236 "%P" inserts the current page number. 237 "%T" inserts the current date and time in common log format. 238 "%j" inserts the job ID. 239 "%p" inserts the printer name. 240 "%u" inserts the username. 241 242</pre> 243The default is "%p %u %j %T %P %C %{job-billing} %{job-originating-host-name} %{job-name} %{media} %{sides}". 244<dt><b>PassEnv </b><i>variable </i>[ ... <i>variable </i>] 245<dd style="margin-left: 5.0em">Passes the specified environment variable(s) to child processes. 246<dt><b><Policy </b><i>name</i><b>> </b>... <b></Policy></b> 247<dd style="margin-left: 5.0em">Specifies access control for the named policy. 248<dt><b>Port </b><i>number</i> 249<dd style="margin-left: 5.0em">Listens to the specified port number for connections. 250<dt><b>PreserveJobFiles Yes</b> 251<dd style="margin-left: 5.0em"><dt><b>PreserveJobFiles No</b> 252<dd style="margin-left: 5.0em"><dt><b>PreserveJobFiles </b><i>seconds</i> 253<dd style="margin-left: 5.0em">Specifies whether job files (documents) are preserved after a job is printed. 254If a numeric value is specified, job files are preserved for the indicated number of seconds after printing. 255The default is "86400" (preserve 1 day). 256<dt><b>PreserveJobHistory Yes</b> 257<dd style="margin-left: 5.0em"><dt><b>PreserveJobHistory No</b> 258<dd style="margin-left: 5.0em"><dt><b>PreserveJobHistory </b><i>seconds</i> 259<dd style="margin-left: 5.0em">Specifies whether the job history is preserved after a job is printed. 260If a numeric value is specified, the job history is preserved for the indicated number of seconds after printing. 261If "Yes", the job history is preserved until the MaxJobs limit is reached. 262The default is "Yes". 263<dt><b>ReloadTimeout </b><i>seconds</i> 264<dd style="margin-left: 5.0em">Specifies the amount of time to wait for job completion before restarting the scheduler. 265The default is "30". 266<dt><b>RIPCache </b><i>size</i> 267<dd style="margin-left: 5.0em">Specifies the maximum amount of memory to use when converting documents into bitmaps for a printer. 268The default is "128m". 269<dt><b>ServerAdmin </b><i>email-address</i> 270<dd style="margin-left: 5.0em">Specifies the email address of the server administrator. 271The default value is "root@ServerName". 272<dt><b>ServerAlias </b><i>hostname </i>[ ... <i>hostname </i>] 273<dd style="margin-left: 5.0em"><dt><b>ServerAlias *</b> 274<dd style="margin-left: 5.0em">The ServerAlias directive is used for HTTP Host header validation when clients connect to the scheduler from external interfaces. 275Using the special name "*" can expose your system to known browser-based DNS rebinding attacks, even when accessing sites through a firewall. 276If the auto-discovery of alternate names does not work, we recommend listing each alternate name with a ServerAlias directive instead of using "*". 277<dt><b>ServerName </b><i>hostname</i> 278<dd style="margin-left: 5.0em">Specifies the fully-qualified hostname of the server. 279The default is the value reported by the 280<b>hostname</b>(1) 281command. 282<dt><b>ServerTokens None</b> 283<dd style="margin-left: 5.0em"><dt><b>ServerTokens ProductOnly</b> 284<dd style="margin-left: 5.0em"><dt><b>ServerTokens Major</b> 285<dd style="margin-left: 5.0em"><dt><b>ServerTokens Minor</b> 286<dd style="margin-left: 5.0em"><dt><b>ServerTokens Minimal</b> 287<dd style="margin-left: 5.0em"><dt><b>ServerTokens OS</b> 288<dd style="margin-left: 5.0em"><dt><b>ServerTokens Full</b> 289<dd style="margin-left: 5.0em">Specifies what information is included in the Server header of HTTP responses. 290"None" disables the Server header. 291"ProductOnly" reports "CUPS". 292"Major" reports "CUPS 2". 293"Minor" reports "CUPS 2.0". 294"Minimal" reports "CUPS 2.0.0". 295"OS" reports "CUPS 2.0.0 (UNAME)" where UNAME is the output of the 296<b>uname</b>(1) 297command. 298"Full" reports "CUPS 2.0.0 (UNAME) IPP/2.0". 299The default is "Minimal". 300<dt><b>SetEnv </b><i>variable value</i> 301<dd style="margin-left: 5.0em">Set the specified environment variable to be passed to child processes. 302<dt><dt><b>SSLListen </b><i>ipv4-address</i><b>:</b><i>port</i> 303<dd style="margin-left: 5.0em"><dt><b>SSLListen [</b><i>ipv6-address</i><b>]:</b><i>port</i> 304<dd style="margin-left: 5.0em"><dt><b>SSLListen *:</b><i>port</i> 305<dd style="margin-left: 5.0em">Listens on the specified address and port for encrypted connections. 306<dt><b>SSLPort </b><i>port</i> 307<dd style="margin-left: 5.0em">Listens on the specified port for encrypted connections. 308<dt><b>StrictConformance Yes</b> 309<dd style="margin-left: 5.0em"><dt><b>StrictConformance No</b> 310<dd style="margin-left: 5.0em">Specifies whether the scheduler requires clients to strictly adhere to the IPP specifications. 311The default is "No". 312<dt><b>Timeout </b><i>seconds</i> 313<dd style="margin-left: 5.0em">Specifies the HTTP request timeout. 314The default is "300" (5 minutes). 315<dt><b>WebInterface yes</b> 316<dd style="margin-left: 5.0em"><dt><b>WebInterface no</b> 317<dd style="margin-left: 5.0em">Specifies whether the web interface is enabled. 318The default is "No". 319</dl> 320<h3><a name="HTTP_METHOD_NAMES">Http Method Names</a></h3> 321The following HTTP methods are supported by 322<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8):</a> 323<dl class="man"> 324<dt>GET 325<dd style="margin-left: 5.0em">Used by a client to download icons and other printer resources and to access the CUPS web interface. 326<dt>HEAD 327<dd style="margin-left: 5.0em">Used by a client to get the type, size, and modification date of resources. 328<dt>OPTIONS 329<dd style="margin-left: 5.0em">Used by a client to establish a secure (SSL/TLS) connection. 330<dt>POST 331<dd style="margin-left: 5.0em">Used by a client to submit IPP requests and HTML forms from the CUPS web interface. 332<dt>PUT 333<dd style="margin-left: 5.0em">Used by a client to upload configuration files. 334</dl> 335<h3><a name="IPP_OPERATION_NAMES">Ipp Operation Names</a></h3> 336The following IPP operations are supported by 337<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8):</a> 338<dl class="man"> 339<dt>CUPS-Accept-Jobs 340<dd style="margin-left: 5.0em">Allows a printer to accept new jobs. 341<dt>CUPS-Add-Modify-Class 342<dd style="margin-left: 5.0em">Adds or modifies a printer class. 343<dt>CUPS-Add-Modify-Printer 344<dd style="margin-left: 5.0em">Adds or modifies a printer. 345<dt>CUPS-Authenticate-Job 346<dd style="margin-left: 5.0em">Releases a job that is held for authentication. 347<dt>CUPS-Delete-Class 348<dd style="margin-left: 5.0em">Deletes a printer class. 349<dt>CUPS-Delete-Printer 350<dd style="margin-left: 5.0em">Deletes a printer. 351<dt>CUPS-Get-Classes 352<dd style="margin-left: 5.0em">Gets a list of printer classes. 353<dt>CUPS-Get-Default 354<dd style="margin-left: 5.0em">Gets the server default printer or printer class. 355<dt>CUPS-Get-Devices 356<dd style="margin-left: 5.0em">Gets a list of devices that are currently available. 357<dt>CUPS-Get-Document 358<dd style="margin-left: 5.0em">Gets a document file for a job. 359<dt>CUPS-Get-PPD 360<dd style="margin-left: 5.0em">Gets a PPD file. 361<dt>CUPS-Get-PPDs 362<dd style="margin-left: 5.0em">Gets a list of installed PPD files. 363<dt>CUPS-Get-Printers 364<dd style="margin-left: 5.0em">Gets a list of printers. 365<dt>CUPS-Move-Job 366<dd style="margin-left: 5.0em">Moves a job. 367<dt>CUPS-Reject-Jobs 368<dd style="margin-left: 5.0em">Prevents a printer from accepting new jobs. 369<dt>CUPS-Set-Default 370<dd style="margin-left: 5.0em">Sets the server default printer or printer class. 371<dt>Cancel-Job 372<dd style="margin-left: 5.0em">Cancels a job. 373<dt>Cancel-Jobs 374<dd style="margin-left: 5.0em">Cancels one or more jobs. 375<dt>Cancel-My-Jobs 376<dd style="margin-left: 5.0em">Cancels one or more jobs creates by a user. 377<dt>Cancel-Subscription 378<dd style="margin-left: 5.0em">Cancels a subscription. 379<dt>Close-Job 380<dd style="margin-left: 5.0em">Closes a job that is waiting for more documents. 381<dt>Create-Job 382<dd style="margin-left: 5.0em">Creates a new job with no documents. 383<dt>Create-Job-Subscriptions 384<dd style="margin-left: 5.0em">Creates a subscription for job events. 385<dt>Create-Printer-Subscriptions 386<dd style="margin-left: 5.0em">Creates a subscription for printer events. 387<dt>Get-Job-Attributes 388<dd style="margin-left: 5.0em">Gets information about a job. 389<dt>Get-Jobs 390<dd style="margin-left: 5.0em">Gets a list of jobs. 391<dt>Get-Notifications 392<dd style="margin-left: 5.0em">Gets a list of event notifications for a subscription. 393<dt>Get-Printer-Attributes 394<dd style="margin-left: 5.0em">Gets information about a printer or printer class. 395<dt>Get-Subscription-Attributes 396<dd style="margin-left: 5.0em">Gets information about a subscription. 397<dt>Get-Subscriptions 398<dd style="margin-left: 5.0em">Gets a list of subscriptions. 399<dt>Hold-Job 400<dd style="margin-left: 5.0em">Holds a job from printing. 401<dt>Hold-New-Jobs 402<dd style="margin-left: 5.0em">Holds all new jobs from printing. 403<dt>Pause-Printer 404<dd style="margin-left: 5.0em">Stops processing of jobs by a printer or printer class. 405<dt>Pause-Printer-After-Current-Job 406<dd style="margin-left: 5.0em">Stops processing of jobs by a printer or printer class after the current job is finished. 407<dt>Print-Job 408<dd style="margin-left: 5.0em">Creates a new job with a single document. 409<dt>Purge-Jobs 410<dd style="margin-left: 5.0em">Cancels one or more jobs and deletes the job history. 411<dt>Release-Held-New-Jobs 412<dd style="margin-left: 5.0em">Allows previously held jobs to print. 413<dt>Release-Job 414<dd style="margin-left: 5.0em">Allows a job to print. 415<dt>Renew-Subscription 416<dd style="margin-left: 5.0em">Renews a subscription. 417<dt>Restart-Job 418<dd style="margin-left: 5.0em">Reprints a job, if possible. 419<dt>Send-Document 420<dd style="margin-left: 5.0em">Adds a document to a job. 421<dt>Set-Job-Attributes 422<dd style="margin-left: 5.0em">Changes job information. 423<dt>Set-Printer-Attributes 424<dd style="margin-left: 5.0em">Changes printer or printer class information. 425<dt>Validate-Job 426<dd style="margin-left: 5.0em">Validates options for a new job. 427</dl> 428<h3><a name="LOCATION_PATHS">Location Paths</a></h3> 429The following paths are commonly used when configuring 430<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8):</a> 431<dl class="man"> 432<dt>/ 433<dd style="margin-left: 5.0em">The path for all get operations (get-printers, get-jobs, etc.) 434<dt>/admin 435<dd style="margin-left: 5.0em">The path for all administration operations (add-printer, delete-printer, start-printer, etc.) 436<dt>/admin/conf 437<dd style="margin-left: 5.0em">The path for access to the CUPS configuration files (cupsd.conf, client.conf, etc.) 438<dt>/admin/log 439<dd style="margin-left: 5.0em">The path for access to the CUPS log files (access_log, error_log, page_log) 440<dt>/classes 441<dd style="margin-left: 5.0em">The path for all printer classes 442<dt>/classes/name 443<dd style="margin-left: 5.0em">The resource for the named printer class 444<dt>/jobs 445<dd style="margin-left: 5.0em">The path for all jobs (hold-job, release-job, etc.) 446<dt>/jobs/id 447<dd style="margin-left: 5.0em">The path for the specified job. 448<dt>/printers 449<dd style="margin-left: 5.0em">The path for all printers 450<dt>/printers/name 451<dd style="margin-left: 5.0em">The path for the named printer 452<dt>/printers/name.png 453<dd style="margin-left: 5.0em">The icon file path for the named printer 454<dt>/printers/name.ppd 455<dd style="margin-left: 5.0em">The PPD file path for the named printer 456</dl> 457<h3><a name="DIRECTIVES_VALID_WITHIN_LOCATION_AND_LIMIT_SECTIONS">Directives Valid Within Location And Limit Sections</a></h3> 458The following directives may be placed inside Location and Limit sections in the <b>cupsd.conf</b> file: 459<dl class="man"> 460<dt><b>Allow all</b> 461<dd style="margin-left: 5.0em"><dt><b>Allow none</b> 462<dd style="margin-left: 5.0em"><dt><b>Allow </b><i>host.domain.com</i> 463<dd style="margin-left: 5.0em"><dt><b>Allow *.</b><i>domain.com</i> 464<dd style="margin-left: 5.0em"><dt><b>Allow </b><i>ipv4-address</i> 465<dd style="margin-left: 5.0em"><dt><b>Allow </b><i>ipv4-address</i><b>/</b><i>netmask</i> 466<dd style="margin-left: 5.0em"><dt><b>Allow </b><i>ipv4-address</i><b>/</b><i>mm</i> 467<dd style="margin-left: 5.0em"><dt><b>Allow [</b><i>ipv6-address</i><b>]</b> 468<dd style="margin-left: 5.0em"><dt><b>Allow [</b><i>ipv6-address</i><b>]/</b><i>mm</i> 469<dd style="margin-left: 5.0em"><dt><b>Allow @IF(</b><i>name</i><b>)</b> 470<dd style="margin-left: 5.0em"><dt><b>Allow @LOCAL</b> 471<dd style="margin-left: 5.0em">Allows access from the named hosts, domains, addresses, or interfaces. 472The Order directive controls whether Allow lines are evaluated before or after Deny lines. 473<dt><b>AuthType None</b> 474<dd style="margin-left: 5.0em"><dt><b>AuthType Basic</b> 475<dd style="margin-left: 5.0em"><dt><b>AuthType Default</b> 476<dd style="margin-left: 5.0em"><dt><b>AuthType Negotiate</b> 477<dd style="margin-left: 5.0em">Specifies the type of authentication required. 478The value "Default" corresponds to the DefaultAuthType value. 479<dt><b>Deny all</b> 480<dd style="margin-left: 5.0em"><dt><b>Deny none</b> 481<dd style="margin-left: 5.0em"><dt><b>Deny </b><i>host.domain.com</i> 482<dd style="margin-left: 5.0em"><dt><b>Deny *.</b><i>domain.com</i> 483<dd style="margin-left: 5.0em"><dt><b>Deny </b><i>ipv4-address</i> 484<dd style="margin-left: 5.0em"><dt><b>Deny </b><i>ipv4-address</i><b>/</b><i>netmask</i> 485<dd style="margin-left: 5.0em"><dt><b>Deny </b><i>ipv4-address</i><b>/</b><i>mm</i> 486<dd style="margin-left: 5.0em"><dt><b>Deny [</b><i>ipv6-address</i><b>]</b> 487<dd style="margin-left: 5.0em"><dt><b>Deny [</b><i>ipv6-address</i><b>]/</b><i>mm</i> 488<dd style="margin-left: 5.0em"><dt><b>Deny @IF(</b><i>name</i><b>)</b> 489<dd style="margin-left: 5.0em"><dt><b>Deny @LOCAL</b> 490<dd style="margin-left: 5.0em">Denies access from the named hosts, domains, addresses, or interfaces. 491The Order directive controls whether Deny lines are evaluated before or after Allow lines. 492<dt><b>Encryption IfRequested</b> 493<dd style="margin-left: 5.0em"><dt><b>Encryption Never</b> 494<dd style="margin-left: 5.0em"><dt><b>Encryption Required</b> 495<dd style="margin-left: 5.0em">Specifies the level of encryption that is required for a particular location. 496The default value is "IfRequested". 497<dt><b>Order allow,deny</b> 498<dd style="margin-left: 5.0em">Specifies that access is denied by default. Allow lines are then processed followed by Deny lines to determine whether a client may access a particular resource. 499<dt><b>Order deny,allow</b> 500<dd style="margin-left: 5.0em">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. 501<dt><b>Require group </b><i>group-name </i>[ <i>group-name </i>... ] 502<dd style="margin-left: 5.0em">Specifies that an authenticated user must be a member of one of the named groups. 503<dt><b>Require user {</b><i>user-name</i>|<b>@</b><i>group-name</i>} ... 504<dd style="margin-left: 5.0em">Specifies that an authenticated user must match one of the named users or be a member of one of the named groups. 505The group name "@SYSTEM" corresponds to the list of groups defined by the SystemGroup directive in the 506<a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5)</a> 507file. 508The group name "@OWNER" corresponds to the owner of the resource, for example the person that submitted a print job. 509<dt><b>Require valid-user</b> 510<dd style="margin-left: 5.0em">Specifies that any authenticated user is acceptable. 511<dt><b>Satisfy all</b> 512<dd style="margin-left: 5.0em">Specifies that all Allow, AuthType, Deny, Order, and Require conditions must be satisfied to allow access. 513<dt><b>Satisfy any</b> 514<dd style="margin-left: 5.0em">Specifies that any a client may access a resource if either the authentication (AuthType/Require) or address (Allow/Deny/Order) conditions are satisfied. 515For example, this can be used to require authentication only for remote accesses. 516</dl> 517<h3><a name="DIRECTIVES_VALID_WITHIN_POLICY_SECTIONS">Directives Valid Within Policy Sections</a></h3> 518The following directives may be placed inside Policy sections in the <b>cupsd.conf</b> file: 519<dl class="man"> 520<dt><b>JobPrivateAccess all</b> 521<dd style="margin-left: 5.0em"><dt><b>JobPrivateAccess default</b> 522<dd style="margin-left: 5.0em"><dt><b>JobPrivateAccess </b>{<i>user</i>|<b>@</b><i>group</i>|<b>@ACL</b>|<b>@OWNER</b>|<b>@SYSTEM</b>} ... 523<dd style="margin-left: 5.0em">Specifies an access list for a job's private values. 524The "default" access list is "@OWNER @SYSTEM". 525"@ACL" maps to the printer's requesting-user-name-allowed or requesting-user-name-denied values. 526"@OWNER" maps to the job's owner. 527"@SYSTEM" maps to the groups listed for the SystemGroup directive in the 528<a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5)</a> 529file. 530<dt><b>JobPrivateValues all</b> 531<dd style="margin-left: 5.0em"><dt><b>JobPrivateValues default</b> 532<dd style="margin-left: 5.0em"><dt><b>JobPrivateValues none</b> 533<dd style="margin-left: 5.0em"><dt><b>JobPrivateValues </b><i>attribute-name </i>[ ... <i>attribute-name </i>] 534<dd style="margin-left: 5.0em">Specifies the list of job values to make private. 535The "default" values are "job-name", "job-originating-host-name", "job-originating-user-name", and "phone". 536<dt><b>SubscriptionPrivateAccess all</b> 537<dd style="margin-left: 5.0em"><dt><b>SubscriptionPrivateAccess default</b> 538<dd style="margin-left: 5.0em"><dt><b>SubscriptionPrivateAccess </b>{<i>user</i>|<b>@</b><i>group</i>|<b>@ACL</b>|<b>@OWNER</b>|<b>@SYSTEM</b>} ... 539<dd style="margin-left: 5.0em">Specifies an access list for a subscription's private values. 540The "default" access list is "@OWNER @SYSTEM". 541"@ACL" maps to the printer's requesting-user-name-allowed or requesting-user-name-denied values. 542"@OWNER" maps to the job's owner. 543"@SYSTEM" maps to the groups listed for the SystemGroup directive in the 544<a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5)</a> 545file. 546<dt><b>SubscriptionPrivateValues all</b> 547<dd style="margin-left: 5.0em"><dt><b>SubscriptionPrivateValues default</b> 548<dd style="margin-left: 5.0em"><dt><b>SubscriptionPrivateValues none</b> 549<dd style="margin-left: 5.0em"><dt><b>SubscriptionPrivateValues </b><i>attribute-name </i>[ ... <i>attribute-name </i>] 550<dd style="margin-left: 5.0em">Specifies the list of subscription values to make private. 551The "default" values are "notify-events", "notify-pull-method", "notify-recipient-uri", "notify-subscriber-user-name", and "notify-user-data". 552</dl> 553<h2 class="title"><a name="CONFORMING_TO">Conforming To</a></h2> 554The <b>cupsd.conf</b> file format is based on the Apache HTTP Server configuration file format. 555<h2 class="title"><a name="EXAMPLES">Examples</a></h2> 556Log everything with a maximum log file size of 32 megabytes: 557<pre class="man"> 558 559 AccessLogLevel all 560 LogLevel debug2 561 MaxLogSize 32m 562 563</pre> 564Require authentication for accesses from outside the 10. network: 565<pre class="man"> 566 567 <Location /> 568 Order allow,deny 569 Allow from 10./8 570 AuthType Basic 571 Require valid-user 572 Satisfy any 573 </Location> 574</pre> 575<h2 class="title"><a name="SEE_ALSO">See Also</a></h2> 576<a href="man-classes.conf.html?TOPIC=Man+Pages"><b>classes.conf</b>(5),</a> 577<a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5),</a> 578<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a> 579<a href="man-mime.convs.html?TOPIC=Man+Pages"><b>mime.convs</b>(5),</a> 580<a href="man-mime.types.html?TOPIC=Man+Pages"><b>mime.types</b>(5),</a> 581<a href="man-printers.conf.html?TOPIC=Man+Pages"><b>printers.conf</b>(5),</a> 582<a href="man-subscriptions.conf.html?TOPIC=Man+Pages"><b>subscriptions.conf</b>(5),</a> 583CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) 584<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> 585Copyright © 2007-2014 by Apple Inc. 586 587</body> 588</html> 589