The following directives are understood by
<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8):</a>
<dl class="man">
-<dt><b>AccessLog</b>
+<dt><a name="AccessLog"></a><b>AccessLog</b>
<dd style="margin-left: 5.0em"><dt><b>AccessLog </b><i>filename</i>
<dd style="margin-left: 5.0em"><dt><b>AccessLog syslog</b>
<dd style="margin-left: 5.0em">Defines the access log filename.
</pre>
The default is "/var/log/cups/access_log".
-<dt><b>ConfigFilePerm </b><i>mode</i>
+<dt><a name="ConfigFilePerm"></a><b>ConfigFilePerm </b><i>mode</i>
<dd style="margin-left: 5.0em">Specifies the permissions for all configuration files that the scheduler writes.
The default is "0644" on OS X and "0640" on all other operating systems.
</dl>
This is done because printer device URIs sometimes contain sensitive authentication information that should not be generally known on the system.
There is no way to disable this security feature.
<dl class="man">
-<dt><b>DataDir </b><i>path</i>
+<dt><a name="DataDir"></a><b>DataDir </b><i>path</i>
<dd style="margin-left: 5.0em">Specifies the directory where data files can be found.
The default is usually "/usr/share/cups".
-<dt><b>DocumentRoot </b><i>directory</i>
+<dt><a name="DocumentRoot"></a><b>DocumentRoot </b><i>directory</i>
<dd style="margin-left: 5.0em">Specifies the root directory for the CUPS web interface content.
The default is usually "/usr/share/doc/cups".
-<dt><b>ErrorLog</b>
+<dt><a name="ErrorLog"></a><b>ErrorLog</b>
<dd style="margin-left: 5.0em"><dt><b>ErrorLog </b><i>filename</i>
<dd style="margin-left: 5.0em"><dt><b>ErrorLog syslog</b>
<dd style="margin-left: 5.0em">Defines the error log filename.
</pre>
The default is "/var/log/cups/error_log".
-<dt><b>FatalErrors none</b>
+<dt><a name="FatalErrors"></a><b>FatalErrors none</b>
<dd style="margin-left: 5.0em"><dt><b>FatalErrors all </b><i>-kind </i>[ ... <i>-kind </i>]
<dd style="margin-left: 5.0em"><dt><b>FatalErrors </b><i>kind </i>[ ... <i>kind </i>]
<dd style="margin-left: 5.0em">Specifies which errors are fatal, causing the scheduler to exit.
<dt><b>permissions</b>
<dd style="margin-left: 5.0em">Bad startup file permissions are fatal, for example shared TLS certificate and key files with world-read permissions.
</div>
-<dt><b>FileDevice Yes</b>
+<dt><a name="FileDevice"></a><b>FileDevice Yes</b>
<dd style="margin-left: 5.0em"><dt><b>FileDevice No</b>
<dd style="margin-left: 5.0em">Specifies whether the file pseudo-device can be used for new printer queues.
The URI "file:///dev/null" is always allowed.
-<dt><b>Group </b><i>group-name-or-number</i>
+<dt><a name="Group"></a><b>Group </b><i>group-name-or-number</i>
<dd style="margin-left: 5.0em">Specifies the group name or ID that will be used when executing external programs.
The default group is operating system specific but is usually "lp" or "nobody".
-<dt><b>LogFilePerm </b><i>mode</i>
+<dt><a name="LogFilePerm"></a><b>LogFilePerm </b><i>mode</i>
<dd style="margin-left: 5.0em">Specifies the permissions of all log files that the scheduler writes.
The default is "0644".
-<dt><b>PageLog </b>[ <i>filename</i> ]
+<dt><a name="PageLog"></a><b>PageLog </b>[ <i>filename</i> ]
<dd style="margin-left: 5.0em"><dt><b>PageLog syslog</b>
<dd style="margin-left: 5.0em">Defines the page log filename.
The value "syslog" causes log entries to be sent to the system log daemon.
</pre>
The default is "/var/log/cups/page_log".
-<dt><b>RemoteRoot </b><i>username</i>
+<dt><a name="RemoteRoot"></a><b>RemoteRoot </b><i>username</i>
<dd style="margin-left: 5.0em">Specifies the username that is associated with unauthenticated accesses by clients claiming to be the root user.
The default is "remroot".
-<dt><b>RequestRoot </b><i>directory</i>
+<dt><a name="RequestRoot"></a><b>RequestRoot </b><i>directory</i>
<dd style="margin-left: 5.0em">Specifies the directory that contains print jobs and other HTTP request data.
The default is "/var/spool/cups".
-<dt><b>Sandboxing off</b>
+<dt><a name="Sandboxing"></a><b>Sandboxing off</b>
<dd style="margin-left: 5.0em"><dt><b>Sandboxing relaxed</b>
<dd style="margin-left: 5.0em"><dt><b>Sandboxing strict</b>
<dd style="margin-left: 5.0em">Specifies the level of security sandboxing that is applied to print filters, backends, and other child processes of the scheduler.
The default is "strict".
This directive is currently only used/supported on OS X.
-<dt><b>ServerBin </b><i>directory</i>
+<dt><a name="ServerBin"></a><b>ServerBin </b><i>directory</i>
<dd style="margin-left: 5.0em">Specifies the directory containing the backends, CGI programs, filters, helper programs, notifiers, and port monitors.
The default is "/usr/lib/cups" or "/usr/libexec/cups" depending on the platform.
-<dt><b>ServerKeychain </b><i>path</i>
+<dt><a name="ServerKeychain"></a><b>ServerKeychain </b><i>path</i>
<dd style="margin-left: 5.0em">Specifies the location of TLS certificates and private keys.
The default is "/Library/Keychains/System.keychain" on OS X and "/etc/cups/ssl" on all other operating systems.
-<dt><b>ServerRoot </b><i>directory</i>
+<dt><a name="ServerRoot"></a><b>ServerRoot </b><i>directory</i>
<dd style="margin-left: 5.0em">Specifies the directory containing the server configuration files.
The default is "/etc/cups".
-<dt><b>SyncOnClose Yes</b>
+<dt><a name="SyncOnClose"></a><b>SyncOnClose Yes</b>
<dd style="margin-left: 5.0em"><dt><b>SyncOnClose No</b>
<dd style="margin-left: 5.0em">Specifies whether the scheduler calls
<b>fsync</b>(2)
after writing configuration or state files.
The default is "No".
-<dt><b>SystemGroup </b><i>group-name </i>[ ... <i>group-name</i> ]
+<dt><a name="SystemGroup"></a><b>SystemGroup </b><i>group-name </i>[ ... <i>group-name</i> ]
<dd style="margin-left: 5.0em">Specifies the group(s) to use for <i>@SYSTEM</i> group authentication.
The default contains "admin", "lpadmin", "root", "sys", and/or "system".
-<dt><b>TempDir </b><i>directory</i>
+<dt><a name="TempDir"></a><b>TempDir </b><i>directory</i>
<dd style="margin-left: 5.0em">Specifies the directory where temporary files are stored.
The default is "/var/spool/cups/tmp".
-<dt><b>User </b><i>username</i>
+<dt><a name="User"></a><b>User </b><i>username</i>
<dd style="margin-left: 5.0em">Specifies the user name or ID that is used when running external programs.
The default is "lp".
</dl>
The following top-level directives are understood by
<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8):</a>
<dl class="man">
-<dt><b>AccessLogLevel config</b>
+<dt><a name="AccessLogLevel"></a><b>AccessLogLevel config</b>
<dd style="margin-left: 5.0em"><dt><b>AccessLogLevel actions</b>
<dd style="margin-left: 5.0em"><dt><b>AccessLogLevel all</b>
<dd style="margin-left: 5.0em">Specifies the logging level for the AccessLog file.
The "actions" level logs when print jobs are submitted, held, released, modified, or canceled, and any of the conditions for "config".
The "all" level logs all requests.
The default access log level is "actions".
-<dt><b>AutoPurgeJobs Yes</b>
+<dt><a name="AutoPurgeJobs"></a><b>AutoPurgeJobs Yes</b>
<dd style="margin-left: 5.0em"><dt><b>AutoPurgeJobs No</b>
<dd style="margin-left: 5.0em"><br>
Specifies whether to purge job history data automatically when it is no longer required for quotas.
The default is "No".
-<dt><b>BrowseLocalProtocols all</b>
+<dt><a name="BrowseLocalProtocols"></a><b>BrowseLocalProtocols all</b>
<dd style="margin-left: 5.0em"><dt><b>BrowseLocalProtocols dnssd</b>
<dd style="margin-left: 5.0em"><dt><b>BrowseLocalProtocols none</b>
<dd style="margin-left: 5.0em">Specifies which protocols to use for local printer sharing.
The default is "dnssd" on systems that support Bonjour and "none" otherwise.
-<dt><b>BrowseWebIF Yes</b>
+<dt><a name="BrowseWebIF"></a><b>BrowseWebIF Yes</b>
<dd style="margin-left: 5.0em"><dt><b>BrowseWebIF No</b>
<dd style="margin-left: 5.0em"><br>
Specifies whether the CUPS web interface is advertised.
The default is "No".
-<dt><b>Browsing Yes</b>
+<dt><a name="Browsing"></a><b>Browsing Yes</b>
<dd style="margin-left: 5.0em"><dt><b>Browsing No</b>
<dd style="margin-left: 5.0em"><br>
Specifies whether shared printers are advertised.
The default is "No".
-<dt><b>Classification </b><i>banner</i>
+<dt><a name="Classification"></a><b>Classification </b><i>banner</i>
<dd style="margin-left: 5.0em"><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.
The default is no classification banner.
-<dt><b>ClassifyOverride Yes</b>
+<dt><a name="ClassifyOverride"></a><b>ClassifyOverride Yes</b>
<dd style="margin-left: 5.0em"><dt><b>ClassifyOverride No</b>
<dd style="margin-left: 5.0em"><br>
Specifies whether users may override the classification (cover page) of individual print jobs using the "job-sheets" option.
The default is "No".
-<dt><b>DefaultAuthType Basic</b>
+<dt><a name="DefaultAuthType"></a><b>DefaultAuthType Basic</b>
<dd style="margin-left: 5.0em"><dt><b>DefaultAuthType Negotiate</b>
<dd style="margin-left: 5.0em"><br>
Specifies the default type of authentication to use.
The default is "Basic".
-<dt><b>DefaultEncryption Never</b>
+<dt><a name="DefaultEncryption"></a><b>DefaultEncryption Never</b>
<dd style="margin-left: 5.0em"><dt><b>DefaultEncryption IfRequested</b>
<dd style="margin-left: 5.0em"><dt><b>DefaultEncryption Required</b>
<dd style="margin-left: 5.0em">Specifies whether encryption will be used for authenticated requests.
The default is "Required".
-<dt><b>DefaultLanguage </b><i>locale</i>
+<dt><a name="DefaultLanguage"></a><b>DefaultLanguage </b><i>locale</i>
<dd style="margin-left: 5.0em">Specifies the default language to use for text and web content.
The default is "en".
-<dt><b>DefaultPaperSize Auto</b>
+<dt><a name="DefaultPaperSize"></a><b>DefaultPaperSize Auto</b>
<dd style="margin-left: 5.0em"><dt><b>DefaultPaperSize None</b>
<dd style="margin-left: 5.0em"><dt><b>DefaultPaperSize </b><i>sizename</i>
<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.
Specific size names are typically "Letter" or "A4".
The default is "Auto".
-<dt><b>DefaultPolicy </b><i>policy-name</i>
+<dt><a name="DefaultPolicy"></a><b>DefaultPolicy </b><i>policy-name</i>
<dd style="margin-left: 5.0em">Specifies the default access policy to use.
The default access policy is "default".
-<dt><b>DefaultShared Yes</b>
+<dt><a name="DefaultShared"></a><b>DefaultShared Yes</b>
<dd style="margin-left: 5.0em"><dt><b>DefaultShared No</b>
<dd style="margin-left: 5.0em">Specifies whether local printers are shared by default.
The default is "Yes".
-<dt><b>DirtyCleanInterval </b><i>seconds</i>
+<dt><a name="DirtyCleanInterval"></a><b>DirtyCleanInterval </b><i>seconds</i>
<dd style="margin-left: 5.0em">Specifies the delay for updating of configuration and state files.
A value of 0 causes the update to happen as soon as possible, typically within a few milliseconds.
The default value is "30".
-<dt><b>ErrorPolicy abort-job</b>
+<dt><a name="ErrorPolicy"></a><b>ErrorPolicy abort-job</b>
<dd style="margin-left: 5.0em">Specifies that a failed print job should be aborted (discarded) unless otherwise specified for the printer.
<dt><b>ErrorPolicy retry-job</b>
<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.
<dd style="margin-left: 5.0em">Specifies that a failed print job should be retried immediately unless otherwise specified for the printer.
<dt><b>ErrorPolicy stop-printer</b>
<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.
-<dt><b>FilterLimit </b><i>limit</i>
+<dt><a name="FilterLimit"></a><b>FilterLimit </b><i>limit</i>
<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.
A limit of 0 disables filter limiting.
An average print to a non-PostScript printer needs a filter limit of about 200.
A PostScript printer needs about half that (100).
Setting the limit below these thresholds will effectively limit the scheduler to printing a single job at any time.
The default limit is "0".
-<dt><b>FilterNice </b><i>nice-value</i>
+<dt><a name="FilterNice"></a><b>FilterNice </b><i>nice-value</i>
<dd style="margin-left: 5.0em">Specifies the scheduling priority (
<b>nice</b>(8)
value) of filters that are run to print a job.
The nice value ranges from 0, the highest priority, to 19, the lowest priority.
The default is 0.
-<dt><b>GSSServiceName </b><i>name</i>
+<dt><a name="GSSServiceName"></a><b>GSSServiceName </b><i>name</i>
<dd style="margin-left: 5.0em">Specifies the service name when using Kerberos authentication.
The default service name is "http."
<dt><b>HostNameLookups On</b>
-<dd style="margin-left: 5.0em"><dt><b>HostNameLookups Off</b>
+<dd style="margin-left: 5.0em"><dt><a name="HostNameLookups"></a><b>HostNameLookups Off</b>
<dd style="margin-left: 5.0em"><dt><b>HostNameLookups Double</b>
<dd style="margin-left: 5.0em">Specifies whether to do reverse lookups on connecting clients.
The "Double" setting causes
Double lookups also prevent clients with unregistered addresses from connecting to your server.
The default is "Off" to avoid the potential server performance problems with hostname lookups.
Only set this option to "On" or "Double" if absolutely required.
-<dt><b>JobKillDelay </b><i>seconds</i>
+<dt><a name="JobKillDelay"></a><b>JobKillDelay </b><i>seconds</i>
<dd style="margin-left: 5.0em">Specifies the number of seconds to wait before killing the filters and backend associated with a canceled or held job.
The default is "30".
-<dt><b>JobRetryInterval </b><i>seconds</i>
+<dt><a name="JobRetryInterval"></a><b>JobRetryInterval </b><i>seconds</i>
<dd style="margin-left: 5.0em">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" or "retry-current-job".
The default is "30".
-<dt><b>JobRetryLimit </b><i>count</i>
+<dt><a name="JobRetryLimit"></a><b>JobRetryLimit </b><i>count</i>
<dd style="margin-left: 5.0em">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" or "retry-current-job".
The default is "5".
-<dt><b>KeepAlive Yes</b>
+<dt><a name="KeepAlive"></a><b>KeepAlive Yes</b>
<dd style="margin-left: 5.0em"><dt><b>KeepAlive No</b>
<dd style="margin-left: 5.0em">Specifies whether to support HTTP keep-alive connections.
The default is "Yes".
-<dt><b>KeepAliveTimeout </b><i>seconds</i>
+<dt><a name="KeepAliveTimeout"></a><b>KeepAliveTimeout </b><i>seconds</i>
<dd style="margin-left: 5.0em">Specifies how long an idle client connection remains open.
The default is "30".
-<dt><b><Limit </b><i>operation </i>...<b>> </b>... <b></Limit></b>
+<dt><a name="LimitIPP"></a><b><Limit </b><i>operation </i>...<b>> </b>... <b></Limit></b>
<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".
-<dt><b><Limit </b><i>method </i>...<b>> </b>... <b></Limit></b>
-<dd style="margin-left: 5.0em"><dt><b><LimitExcept </b><i>method </i>...<b>> </b>... <b></LimitExcept></b>
+<dt><a name="Limit"></a><b><Limit </b><i>method </i>...<b>> </b>... <b></Limit></b>
+<dd style="margin-left: 5.0em"><dt><a name="LimitExcept"></a><b><LimitExcept </b><i>method </i>...<b>> </b>... <b></LimitExcept></b>
<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".
-<dt><b>LimitRequestBody </b><i>size</i>
+<dt><a name="LimitRequestBody"></a><b>LimitRequestBody </b><i>size</i>
<dd style="margin-left: 5.0em">Specifies the maximum size of print files, IPP requests, and HTML form data.
The default is "0" which disables the limit check.
-<dt><b>Listen </b><i>ipv4-address</i><b>:</b><i>port</i>
+<dt><a name="Listen"></a><b>Listen </b><i>ipv4-address</i><b>:</b><i>port</i>
<dd style="margin-left: 5.0em"><dt><b>Listen [</b><i>ipv6-address</i><b>]:</b><i>port</i>
<dd style="margin-left: 5.0em"><dt><b>Listen *:</b><i>port</i>
<dd style="margin-left: 5.0em"><dt><b>Listen </b><i>/path/to/domain/socket</i>
<dd style="margin-left: 5.0em">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.
-<dt><b>ListenBackLog </b><i>number</i>
+<dt><a name="ListenBackLog"></a><b>ListenBackLog </b><i>number</i>
<dd style="margin-left: 5.0em">Specifies the number of pending connections that will be allowed.
This normally only affects very busy servers that have reached the MaxClients limit, but can also be triggered by large numbers of simultaneous connections.
When the limit is reached, the operating system will refuse additional connections until the scheduler can accept the pending ones.
The default is the OS-defined default limit, typically either "5" for older operating systems or "128" for newer operating systems.
-<dt><b><Location </b><i>/path</i><b>> </b>... <b></Location></b>
+<dt><a name="Location"></a><b><Location </b><i>/path</i><b>> </b>... <b></Location></b>
<dd style="margin-left: 5.0em">Specifies access control for the named location.
Paths are documented below in the section "LOCATION PATHS".
-<dt><b>LogDebugHistory </b><i>number</i>
+<dt><a name="LogDebugHistory"></a><b>LogDebugHistory </b><i>number</i>
<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.
-<dt><b>LogLevel </b>none
+<dt><a name="LogLevel"></a><b>LogLevel </b>none
<dd style="margin-left: 5.0em"><dt><b>LogLevel </b>emerg
<dd style="margin-left: 5.0em"><dt><b>LogLevel </b>alert
<dd style="margin-left: 5.0em"><dt><b>LogLevel </b>crit
<dd style="margin-left: 5.0em">Specifies the level of logging for the ErrorLog file.
The value "none" stops all logging while "debug2" logs everything.
The default is "warn".
-<dt><b>LogTimeFormat </b>standard
+<dt><a name="LogTimeFormat"></a><b>LogTimeFormat </b>standard
<dd style="margin-left: 5.0em"><dt><b>LogTimeFormat </b>usecs
<dd style="margin-left: 5.0em">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.
-<dt><b>MaxClients </b><i>number</i>
+<dt><a name="MaxClients"></a><b>MaxClients </b><i>number</i>
<dd style="margin-left: 5.0em">Specifies the maximum number of simultaneous clients that are allowed by the scheduler.
The default is "100".
-<dt><b>MaxClientsPerHost </b><i>number</i>
+<dt><a name="MaxClientPerHost"></a><b>MaxClientsPerHost </b><i>number</i>
<dd style="margin-left: 5.0em">Specifies the maximum number of simultaneous clients that are allowed from a
single address.
The default is the MaxClients value.
-<dt><b>MaxCopies </b><i>number</i>
+<dt><a name="MaxCopies"></a><b>MaxCopies </b><i>number</i>
<dd style="margin-left: 5.0em">Specifies the maximum number of copies that a user can print of each job.
The default is "9999".
-<dt><b>MaxHoldTime </b><i>seconds</i>
+<dt><a name="MaxHoldTime"></a><b>MaxHoldTime </b><i>seconds</i>
<dd style="margin-left: 5.0em">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.
-<dt><b>MaxJobs </b><i>number</i>
+<dt><a name="MaxJobs"></a><b>MaxJobs </b><i>number</i>
<dd style="margin-left: 5.0em">Specifies the maximum number of simultaneous jobs that are allowed.
Set to "0" to allow an unlimited number of jobs.
The default is "500".
-<dt><b>MaxJobsPerPrinter </b><i>number</i>
+<dt><a name="MaxJobsPerPrinter"></a><b>MaxJobsPerPrinter </b><i>number</i>
<dd style="margin-left: 5.0em">Specifies the maximum number of simultaneous jobs that are allowed per printer.
The default is "0" which allows up to MaxJobs jobs per printer.
-<dt><b>MaxJobsPerUser </b><i>number</i>
+<dt><a name="MaxJobsPerUser"></a><b>MaxJobsPerUser </b><i>number</i>
<dd style="margin-left: 5.0em">Specifies the maximum number of simultaneous jobs that are allowed per user.
The default is "0" which allows up to MaxJobs jobs per user.
-<dt><b>MaxJobTime </b><i>seconds</i>
+<dt><a name="MaxJobTime"></a><b>MaxJobTime </b><i>seconds</i>
<dd style="margin-left: 5.0em">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).
-<dt><b>MaxLogSize </b><i>size</i>
+<dt><a name="MaxLogSize"></a><b>MaxLogSize </b><i>size</i>
<dd style="margin-left: 5.0em">Specifies the maximum size of the log files before they are rotated.
The value "0" disables log rotation.
The default is "1048576" (1MB).
-<dt><b>MultipleOperationTimeout </b><i>seconds</i>
+<dt><a name="MultipleOperationTimeout"></a><b>MultipleOperationTimeout </b><i>seconds</i>
<dd style="margin-left: 5.0em">Specifies the maximum amount of time to allow between files in a multiple file print job.
The default is "300" (5 minutes).
-<dt><b>PageLogFormat </b><i>format-string</i>
+<dt><a name="PageLogFormat"></a><b>PageLogFormat </b><i>format-string</i>
<dd style="margin-left: 5.0em">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:
</pre>
The default is "%p %u %j %T %P %C %{job-billing} %{job-originating-host-name} %{job-name} %{media} %{sides}".
-<dt><b>PassEnv </b><i>variable </i>[ ... <i>variable </i>]
+<dt><a name="PassEnv"></a><b>PassEnv </b><i>variable </i>[ ... <i>variable </i>]
<dd style="margin-left: 5.0em">Passes the specified environment variable(s) to child processes.
-<dt><b><Policy </b><i>name</i><b>> </b>... <b></Policy></b>
+<dt><a name="Policy"></a><b><Policy </b><i>name</i><b>> </b>... <b></Policy></b>
<dd style="margin-left: 5.0em">Specifies access control for the named policy.
-<dt><b>Port </b><i>number</i>
+<dt><a name="Port"></a><b>Port </b><i>number</i>
<dd style="margin-left: 5.0em">Listens to the specified port number for connections.
-<dt><b>PreserveJobFiles Yes</b>
+<dt><a name="PreserveJobFiles"></a><b>PreserveJobFiles Yes</b>
<dd style="margin-left: 5.0em"><dt><b>PreserveJobFiles No</b>
<dd style="margin-left: 5.0em"><dt><b>PreserveJobFiles </b><i>seconds</i>
<dd style="margin-left: 5.0em">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).
-<dt><b>PreserveJobHistory Yes</b>
+<dt><a name="PreserveJobHistory"></a><b>PreserveJobHistory Yes</b>
<dd style="margin-left: 5.0em"><dt><b>PreserveJobHistory No</b>
<dd style="margin-left: 5.0em"><dt><b>PreserveJobHistory </b><i>seconds</i>
<dd style="margin-left: 5.0em">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".
-<dt><b>ReloadTimeout </b><i>seconds</i>
+<dt><a name="ReloadTimeout"></a><b>ReloadTimeout </b><i>seconds</i>
<dd style="margin-left: 5.0em">Specifies the amount of time to wait for job completion before restarting the scheduler.
The default is "30".
-<dt><b>RIPCache </b><i>size</i>
+<dt><a name="RIPCache"></a><b>RIPCache </b><i>size</i>
<dd style="margin-left: 5.0em">Specifies the maximum amount of memory to use when converting documents into bitmaps for a printer.
The default is "128m".
-<dt><b>ServerAdmin </b><i>email-address</i>
+<dt><a name="ServerAdmin"></a><b>ServerAdmin </b><i>email-address</i>
<dd style="margin-left: 5.0em">Specifies the email address of the server administrator.
The default value is "root@ServerName".
-<dt><b>ServerAlias </b><i>hostname </i>[ ... <i>hostname </i>]
+<dt><a name="ServerAlias"></a><b>ServerAlias </b><i>hostname </i>[ ... <i>hostname </i>]
<dd style="margin-left: 5.0em"><dt><b>ServerAlias *</b>
<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.
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 "*".
-<dt><b>ServerName </b><i>hostname</i>
+<dt><a name="ServerName"></a><b>ServerName </b><i>hostname</i>
<dd style="margin-left: 5.0em">Specifies the fully-qualified hostname of the server.
The default is the value reported by the
<b>hostname</b>(1)
command.
-<dt><b>ServerTokens None</b>
+<dt><a name="ServerTokens"></a><b>ServerTokens None</b>
<dd style="margin-left: 5.0em"><dt><b>ServerTokens ProductOnly</b>
<dd style="margin-left: 5.0em"><dt><b>ServerTokens Major</b>
<dd style="margin-left: 5.0em"><dt><b>ServerTokens Minor</b>
command.
"Full" reports "CUPS 2.0.0 (UNAME) IPP/2.0".
The default is "Minimal".
-<dt><b>SetEnv </b><i>variable value</i>
+<dt><a name="SetEnv"></a><b>SetEnv </b><i>variable value</i>
<dd style="margin-left: 5.0em">Set the specified environment variable to be passed to child processes.
-<dt><dt><b>SSLListen </b><i>ipv4-address</i><b>:</b><i>port</i>
+<dt><a name="SSLListen"></a><b>SSLListen </b><i>ipv4-address</i><b>:</b><i>port</i>
<dd style="margin-left: 5.0em"><dt><b>SSLListen [</b><i>ipv6-address</i><b>]:</b><i>port</i>
<dd style="margin-left: 5.0em"><dt><b>SSLListen *:</b><i>port</i>
<dd style="margin-left: 5.0em">Listens on the specified address and port for encrypted connections.
-<dt><b>SSLOptions </b>[<i>AllowRC4</i>] [<i>AllowSSL3</i>]
+<dt><a name="SSLOptions"></a><b>SSLOptions </b>[<i>AllowRC4</i>] [<i>AllowSSL3</i>]
<dd style="margin-left: 5.0em"><dt><b>SSLOptions None</b>
<dd style="margin-left: 5.0em">Sets encryption options.
By default, CUPS only supports encryption using TLS v1.0 or higher using known secure cipher suites.
The <i>AllowRC4</i> option enables the 128-bit RC4 cipher suites, which are required for some older clients that do not implement newer ones.
The <i>AllowSSL3</i> option enables SSL v3.0, which is required for some older clients that do not support TLS v1.0.
-<dt><b>SSLPort </b><i>port</i>
+<dt><a name="SSLPort"></a><b>SSLPort </b><i>port</i>
<dd style="margin-left: 5.0em">Listens on the specified port for encrypted connections.
-<dt><b>StrictConformance Yes</b>
+<dt><a name="StrictConformance"></a><b>StrictConformance Yes</b>
<dd style="margin-left: 5.0em"><dt><b>StrictConformance No</b>
<dd style="margin-left: 5.0em">Specifies whether the scheduler requires clients to strictly adhere to the IPP specifications.
The default is "No".
-<dt><b>Timeout </b><i>seconds</i>
+<dt><a name="Timeout"></a><b>Timeout </b><i>seconds</i>
<dd style="margin-left: 5.0em">Specifies the HTTP request timeout.
The default is "300" (5 minutes).
-<dt><b>WebInterface yes</b>
+<dt><a name="WebInterface"></a><b>WebInterface yes</b>
<dd style="margin-left: 5.0em"><dt><b>WebInterface no</b>
<dd style="margin-left: 5.0em">Specifies whether the web interface is enabled.
The default is "No".
<H2 CLASS="title"><A NAME="BASICS">The Basics</A></H2>
-<P>Operation policies are used for all IPP requests sent to the scheduler and are evaluated <em>after</em> the <A HREF="ref-cupsd-conf.html#Location"><TT>Location</TT></A> based access control rules. This means that operation policies can only add additional security restrictions to a request, never relax them. Use <TT>Location</TT> based access control rules for server-wide limits and operation policies for limits on individual printers, tasks, or services.</P>
+<P>Operation policies are used for all IPP requests sent to the scheduler and are evaluated <em>after</em> the <A HREF="man-cupsd.conf.html#Location"><TT>Location</TT></A> based access control rules. This means that operation policies can only add additional security restrictions to a request, never relax them. Use <TT>Location</TT> based access control rules for server-wide limits and operation policies for limits on individual printers, tasks, or services.</P>
-<P>Policies are stored in the <VAR>cupsd.conf</VAR> file in <A HREF="
ref-cupsd-conf.html#Policy"><TT>Policy</TT></A> sections. Each policy has an alphanumeric name that is used to select it. Inside the policy section are one or more <A
-HREF="
ref-cupsd-conf.html#LimitIPP"><TT>Limit</TT></A> subsections which list the operations that are affected by the rules inside it. <A HREF="#LISTING01">Listing 1</A> shows the default operation policy, appropriately called "default", that is shipped with CUPS.</P>
+<P>Policies are stored in the <VAR>cupsd.conf</VAR> file in <A HREF="
man-cupsd.conf.html#Policy"><TT>Policy</TT></A> sections. Each policy has an alphanumeric name that is used to select it. Inside the policy section are one or more <A
+HREF="
man-cupsd.conf.html#LimitIPP"><TT>Limit</TT></A> subsections which list the operations that are affected by the rules inside it. <A HREF="#LISTING01">Listing 1</A> shows the default operation policy, appropriately called "default", that is shipped with CUPS.</P>
-<P>The easiest way to add a policy to the <VAR>cupsd.conf</VAR> file is to use the web interface. Click on the <VAR>Administration</VAR> tab and then the <VAR>Edit Configuration File</VAR> button to edit the current <VAR>cupsd.conf</VAR> file. Click on the <VAR>Save Changes</VAR> button to save the changes and restart the scheduler. If you edit the <VAR>cupsd.conf</VAR> file from the console, make sure to <A HREF="ref-cupsd-conf.html">restart the cupsd process</A> before trying to use the new policy.</P>
+<P>The easiest way to add a policy to the <VAR>cupsd.conf</VAR> file is to use the web interface. Click on the <VAR>Administration</VAR> tab and then the <VAR>Edit Configuration File</VAR> button to edit the current <VAR>cupsd.conf</VAR> file. Click on the <VAR>Save Changes</VAR> button to save the changes and restart the scheduler. If you edit the <VAR>cupsd.conf</VAR> file from the console, make sure to <A HREF="man-cupsd.conf.html">restart the cupsd process</A> before trying to use the new policy.</P>
<PRE CLASS="example">
<EM>Listing 1: <A NAME="LISTING01">Default Operation Policy</A></EM>
<P>The operation names are listed on a single line with spaces separating them. Each name corresponds to the IPP operation described in any of the IETF or PWG standards documents for the Internet Printing Protocol. <A HREF="#TABLE01">Table 1</A> lists all of the operations that have been defined along with their usage in CUPS.</P>
-<P>The access control rules are listed after the <TT>Limit</TT> line and are the same as those used for <A HREF="ref-cupsd-conf.html#Location"><TT>Location</TT></A> sections. In this case, we require the owner of the job ("@OWNER") or a member of the <A HREF="ref-cupsd-conf.html#SystemGroup"><TT>SystemGroup</TT></A> ("@SYSTEM") to do the operation. Because we do not include an <A HREF="ref-cupsd-conf.html#AuthType"><TT>AuthType</TT></A> directive here, the user information can come from the IPP request itself or the authenticated username from the HTTP request. The administrative operations starting on line 9, however, <em>do</em> use the <TT>AuthType</TT> directive, and so administrative operations need to be authenticated:</P>
+<P>The access control rules are listed after the <TT>Limit</TT> line and are the same as those used for <A HREF="man-cupsd.conf.html#Location"><TT>Location</TT></A> sections. In this case, we require the owner of the job ("@OWNER") or a member of the <A HREF="man-cupsd.conf.html#SystemGroup"><TT>SystemGroup</TT></A> ("@SYSTEM") to do the operation. Because we do not include an <A HREF="man-cupsd.conf.html#AuthType"><TT>AuthType</TT></A> directive here, the user information can come from the IPP request itself or the authenticated username from the HTTP request. The administrative operations starting on line 9, however, <em>do</em> use the <TT>AuthType</TT> directive, and so administrative operations need to be authenticated:</P>
<PRE CLASS="example">
9 <Limit CUPS-Add-Modify-Printer CUPS-Delete-Printer CUPS-Add-Modify-Class
</Limit>
</PRE>
-<P>The directives inside the <TT>Limit</TT> subsection can use any of the normal limiting directives: <A HREF="
ref-cupsd-conf.html#Allow"><TT>Allow</TT></A>, <A HREF="ref-cupsd-conf.html#AuthType"><TT>AuthType</TT></A>, <A HREF="ref-cupsd-conf.html#Deny"><TT>Deny</TT></A>, <A HREF="ref-cupsd-conf.html#Encryption"><TT>Encryption</TT></A>, <A HREF="ref-cupsd-conf.html#Require"><TT>Require</TT></A>, and <A HREF="ref-cupsd-conf.html#Satisfy"><TT>Satisfy</TT></A>. <A HREF="#TABLE02">Table 2</A> lists some basic "recipes" for different access control rules.</P>
+<P>The directives inside the <TT>Limit</TT> subsection can use any of the normal limiting directives: <A HREF="
man-cupsd.conf.html#Allow"><TT>Allow</TT></A>, <A HREF="man-cupsd.conf.html#AuthType"><TT>AuthType</TT></A>, <A HREF="man-cupsd.conf.html#Deny"><TT>Deny</TT></A>, <A HREF="man-cupsd.conf.html#Encryption"><TT>Encryption</TT></A>, <A HREF="man-cupsd.conf.html#Require"><TT>Require</TT></A>, and <A HREF="man-cupsd.conf.html#Satisfy"><TT>Satisfy</TT></A>. <A HREF="#TABLE02">Table 2</A> lists some basic "recipes" for different access control rules.</P>
<DIV CLASS="table"><TABLE WIDTH="80%" SUMMARY="Access Control Recipes">
<CAPTION>Table 2: <A NAME="TABLE02">Access Control Recipes</A></CAPTION>
<H2 CLASS="title"><A NAME="SELECT">Using Policies</A></H2>
-<P>Once you have created a policy, you can use it in two ways. The first way is to assign it as the default policy for the system using the <A HREF="ref-cupsd-conf.html#DefaultPolicy"><TT>DefaultPolicy</TT></A> directive in the <VAR>cupsd.conf</VAR> file. For example, add the following line to the <VAR>cupsd.conf</VAR> file to use the "lab999" policy from the previous section:</P>
+<P>Once you have created a policy, you can use it in two ways. The first way is to assign it as the default policy for the system using the <A HREF="man-cupsd.conf.html#DefaultPolicy"><TT>DefaultPolicy</TT></A> directive in the <VAR>cupsd.conf</VAR> file. For example, add the following line to the <VAR>cupsd.conf</VAR> file to use the "lab999" policy from the previous section:</P>
<PRE CLASS="example">
DefaultPolicy lab999
.SS DIRECTIVES
The following directives are understood by
.BR cupsd (8):
+.\"#AccessLog
.TP 5
\fBAccessLog\fR
.TP 5
.fi
The default is "/var/log/cups/access_log".
+.\"#ConfigFilePerm
.TP 5
\fBConfigFilePerm \fImode\fR
Specifies the permissions for all configuration files that the scheduler writes.
\fBNote:\fR The permissions for the \fIprinters.conf\fR file are currently masked to only allow access from the scheduler user (typically root).
This is done because printer device URIs sometimes contain sensitive authentication information that should not be generally known on the system.
There is no way to disable this security feature.
+.\"#DataDir
.TP 5
\fBDataDir \fIpath\fR
Specifies the directory where data files can be found.
The default is usually "/usr/share/cups".
+.\"#DocumentRoot
.TP 5
\fBDocumentRoot \fIdirectory\fR
Specifies the root directory for the CUPS web interface content.
The default is usually "/usr/share/doc/cups".
+.\"#ErrorLog
.TP 5
\fBErrorLog\fR
.TP 5
.fi
The default is "/var/log/cups/error_log".
+.\"#FatalErrors
.TP 5
\fBFatalErrors none\fR
.TP 5
.B permissions
Bad startup file permissions are fatal, for example shared TLS certificate and key files with world-read permissions.
.RE
+.\"#FileDevice
.TP 5
\fBFileDevice Yes\fR
.TP 5
\fBFileDevice No\fR
Specifies whether the file pseudo-device can be used for new printer queues.
The URI "file:///dev/null" is always allowed.
+.\"#Group
.TP 5
\fBGroup \fIgroup-name-or-number\fR
Specifies the group name or ID that will be used when executing external programs.
The default group is operating system specific but is usually "lp" or "nobody".
+.\"#LogFilePerm
.TP 5
\fBLogFilePerm \fImode\fR
Specifies the permissions of all log files that the scheduler writes.
The default is "0644".
+.\"#PageLog
.TP 5
\fBPageLog \fR[ \fIfilename\fR ]
.TP 5
.fi
The default is "/var/log/cups/page_log".
+.\"#RemoteRoot
.TP 5
\fBRemoteRoot \fIusername\fR
Specifies the username that is associated with unauthenticated accesses by clients claiming to be the root user.
The default is "remroot".
+.\"#RequestRoot
.TP 5
\fBRequestRoot \fIdirectory\fR
Specifies the directory that contains print jobs and other HTTP request data.
The default is "/var/spool/cups".
+.\"#Sandboxing
.TP 5
\fBSandboxing off\fR
.TP 5
Specifies the level of security sandboxing that is applied to print filters, backends, and other child processes of the scheduler.
The default is "strict".
This directive is currently only used/supported on OS X.
+.\"#ServerBin
.TP 5
\fBServerBin \fIdirectory\fR
Specifies the directory containing the backends, CGI programs, filters, helper programs, notifiers, and port monitors.
The default is "/usr/lib/cups" or "/usr/libexec/cups" depending on the platform.
+.\"#ServerKeychain
.TP 5
\fBServerKeychain \fIpath\fR
Specifies the location of TLS certificates and private keys.
The default is "/Library/Keychains/System.keychain" on OS X and "/etc/cups/ssl" on all other operating systems.
+.\"#ServerRoot
.TP 5
\fBServerRoot \fIdirectory\fR
Specifies the directory containing the server configuration files.
The default is "/etc/cups".
+.\"#SyncOnClose
.TP 5
\fBSyncOnClose Yes\fR
.TP 5
.BR fsync (2)
after writing configuration or state files.
The default is "No".
+.\"#SystemGroup
.TP 5
\fBSystemGroup \fIgroup-name \fR[ ... \fIgroup-name\fR ]
Specifies the group(s) to use for \fI@SYSTEM\fR group authentication.
The default contains "admin", "lpadmin", "root", "sys", and/or "system".
+.\"#TempDir
.TP 5
\fBTempDir \fIdirectory\fR
Specifies the directory where temporary files are stored.
The default is "/var/spool/cups/tmp".
+.\"#User
.TP 5
\fBUser \fIusername\fR
Specifies the user name or ID that is used when running external programs.
.SS TOP-LEVEL DIRECTIVES
The following top-level directives are understood by
.BR cupsd (8):
+.\"#AccessLogLevel
.TP 5
\fBAccessLogLevel config\fR
.TP 5
The "actions" level logs when print jobs are submitted, held, released, modified, or canceled, and any of the conditions for "config".
The "all" level logs all requests.
The default access log level is "actions".
+.\"#AutoPurgeJobs
.TP 5
\fBAutoPurgeJobs Yes\fR
.TP 5
.br
Specifies whether to purge job history data automatically when it is no longer required for quotas.
The default is "No".
+.\"#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.
+.\"#BrowseWebIF
.TP 5
\fBBrowseWebIF Yes\fR
.TP 5
.br
Specifies whether the CUPS web interface is advertised.
The default is "No".
+.\"#Browsing
.TP 5
\fBBrowsing Yes\fR
.TP 5
.br
Specifies whether shared printers are advertised.
The default is "No".
+.\"#Classification
.TP 5
\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.
The default is no classification banner.
+.\"#ClassifyOverride
.TP 5
\fBClassifyOverride Yes\fR
.TP 5
.br
Specifies whether users may override the classification (cover page) of individual print jobs using the "job-sheets" option.
The default is "No".
+.\"#DefaultAuthType
.TP 5
\fBDefaultAuthType Basic\fR
.TP 5
.br
Specifies the default type of authentication to use.
The default is "Basic".
+.\"#DefaultEncryption
.TP 5
\fBDefaultEncryption Never\fR
.TP 5
\fBDefaultEncryption Required\fR
Specifies whether encryption will be used for authenticated requests.
The default is "Required".
+.\"#DefaultLanguage
.TP 5
\fBDefaultLanguage \fIlocale\fR
Specifies the default language to use for text and web content.
The default is "en".
+.\"#DefaultPaperSize
.TP 5
\fBDefaultPaperSize Auto\fR
.TP 5
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".
+.\"#DefaultPolicy
.TP 5
\fBDefaultPolicy \fIpolicy-name\fR
Specifies the default access policy to use.
The default access policy is "default".
+.\"#DefaultShared
.TP 5
\fBDefaultShared Yes\fR
.TP 5
\fBDefaultShared No\fR
Specifies whether local printers are shared by default.
The default is "Yes".
+.\"#DirtyCleanInterval
.TP 5
\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".
+.\"#ErrorPolicy
.TP 5
\fBErrorPolicy abort-job\fR
Specifies that a failed print job should be aborted (discarded) unless otherwise specified for the printer.
.TP 5
\fBErrorPolicy stop-printer\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
Specifies the maximum cost of filters that are run concurrently, which can be used to minimize disk, memory, and CPU resource problems.
A PostScript printer needs about half that (100).
Setting the limit below these thresholds will effectively limit the scheduler to printing a single job at any time.
The default limit is "0".
+.\"#FilterNice
.TP 5
\fBFilterNice \fInice-value\fR
Specifies the scheduling priority (
value) of filters that are run to print a job.
The nice value ranges from 0, the highest priority, to 19, the lowest priority.
The default is 0.
+.\"#GSSServiceName
.TP 5
\fBGSSServiceName \fIname\fR
Specifies the service name when using Kerberos authentication.
The default service name is "http."
.TP 5
+.\"#HostNameLookups
\fBHostNameLookups On\fR
.TP 5
\fBHostNameLookups Off\fR
Double lookups also prevent clients with unregistered addresses from connecting to your server.
The default is "Off" to avoid the potential server performance problems with hostname lookups.
Only set this option to "On" or "Double" if absolutely required.
+.\"#JobKillDelay
.TP 5
\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 "30".
+.\"#JobRetryInterval
.TP 5
\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" or "retry-current-job".
The default is "30".
+.\"#JobRetryLimit
.TP 5
\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" or "retry-current-job".
The default is "5".
+.\"#KeepAlive
.TP 5
\fBKeepAlive Yes\fR
.TP 5
\fBKeepAlive No\fR
Specifies whether to support HTTP keep-alive connections.
The default is "Yes".
+.\"#KeepAliveTimeout
.TP 5
\fBKeepAliveTimeout \fIseconds\fR
Specifies how long an idle client connection remains open.
The default is "30".
+.\"#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 OPERATIONS".
+.\"#Limit
.TP 5
\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 METHODS".
+.\"#LimitRequestBody
.TP 5
\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
.TP 5
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.
+.\"#ListenBackLog
.TP 5
\fBListenBackLog \fInumber\fR
Specifies the number of pending connections that will be allowed.
This normally only affects very busy servers that have reached the MaxClients limit, but can also be triggered by large numbers of simultaneous connections.
When the limit is reached, the operating system will refuse additional connections until the scheduler can accept the pending ones.
The default is the OS-defined default limit, typically either "5" for older operating systems or "128" for newer operating systems.
+.\"#Location
.TP 5
\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
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
.TP 5
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
.TP 5
\fBLogTimeFormat \fRusecs
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
Specifies the maximum number of simultaneous clients that are allowed by the scheduler.
The default is "100".
+.\"#MaxClientPerHost
.TP 5
\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
Specifies the maximum number of copies that a user can print of each job.
The default is "9999".
+.\"#MaxHoldTime
.TP 5
\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
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
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
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
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
Specifies the maximum size of the log files before they are rotated.
The value "0" disables log rotation.
The default is "1048576" (1MB).
+.\"#MultipleOperationTimeout
.TP 5
\fBMultipleOperationTimeout \fIseconds\fR
Specifies the maximum amount of time to allow between files in a multiple file print job.
The default is "300" (5 minutes).
+.\"#PageLogFormat
.TP 5
\fBPageLogFormat \fIformat-string\fR
Specifies the format of PageLog lines.
.fi
The default is "%p %u %j %T %P %C %{job-billing} %{job-originating-host-name} %{job-name} %{media} %{sides}".
+.\"#PassEnv
.TP 5
\fBPassEnv \fIvariable \fR[ ... \fIvariable \fR]
Passes the specified environment variable(s) to child processes.
+.\"#Policy
.TP 5
\fB<Policy \fIname\fB> \fR... \fB</Policy>\fR
Specifies access control for the named policy.
+.\"#Port
.TP 5
\fBPort \fInumber\fR
Listens to the specified port number for connections.
+.\"#PreserveJobFiles
.TP 5
\fBPreserveJobFiles Yes\fR
.TP 5
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).
+.\"#PreserveJobHistory
.TP 5
\fBPreserveJobHistory Yes\fR
.TP 5
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".
+.\"#ReloadTimeout
.TP 5
\fBReloadTimeout \fIseconds\fR
Specifies the amount of time to wait for job completion before restarting the scheduler.
The default is "30".
+.\"#RIPCache
.TP 5
\fBRIPCache \fIsize\fR
Specifies the maximum amount of memory to use when converting documents into bitmaps for a printer.
The default is "128m".
+.\"#ServerAdmin
.TP 5
\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]
.TP 5
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 "*".
+.\"#ServerName
.TP 5
\fBServerName \fIhostname\fR
Specifies the fully-qualified hostname of the server.
The default is the value reported by the
.BR hostname (1)
command.
+.\"#ServerTokens
.TP 5
\fBServerTokens None\fR
.TP 5
command.
"Full" reports "CUPS 2.0.0 (UNAME) IPP/2.0".
The default is "Minimal".
+.\"#SetEnv
.TP 5
\fBSetEnv \fIvariable value\fR
Set the specified environment variable to be passed to child processes.
-.TP 5
+.\"#SSLListen
.TP 5
\fBSSLListen \fIipv4-address\fB:\fIport\fR
.TP 5
.TP 5
\fBSSLListen *:\fIport\fR
Listens on the specified address and port for encrypted connections.
+.\"#SSLOptions
.TP 5
\fBSSLOptions \fR[\fIAllowRC4\fR] [\fIAllowSSL3\fR]
.TP 5
By default, CUPS only supports encryption using TLS v1.0 or higher using known secure cipher suites.
The \fIAllowRC4\fR option enables the 128-bit RC4 cipher suites, which are required for some older clients that do not implement newer ones.
The \fIAllowSSL3\fR option enables SSL v3.0, which is required for some older clients that do not support TLS v1.0.
+.\"#SSLPort
.TP 5
\fBSSLPort \fIport\fR
Listens on the specified port for encrypted connections.
+.\"#StrictConformance
.TP 5
\fBStrictConformance Yes\fR
.TP 5
\fBStrictConformance No\fR
Specifies whether the scheduler requires clients to strictly adhere to the IPP specifications.
The default is "No".
+.\"#Timeout
.TP 5
\fBTimeout \fIseconds\fR
Specifies the HTTP request timeout.
The default is "300" (5 minutes).
+.\"#WebInterface
.TP 5
\fBWebInterface yes\fR
.TP 5
*outfile; /* Output file */
char line[1024], /* Line from file */
*lineptr, /* Pointer into line */
+ anchor[1024], /* Anchor */
name[1024], /* Man page name */
ddpost[256]; /* Tagged list post markup */
int section = -1, /* Man page section */
"\t<link rel=\"stylesheet\" type=\"text/css\" "
"href=\"../cups-printable.css\">\n", outfile);
+ anchor[0] = '\0';
+
while (fgets(line, sizeof(line), infile))
{
size_t linelen = strlen(line); /* Length of line */
else
fputs("<h3><a name=\"", outfile);
- for (lineptr = line + 4; *lineptr; lineptr ++)
- if (*lineptr == '\"')
- continue;
- else if (isalnum(*lineptr & 255))
- html_putc(*lineptr, outfile);
- else
- html_putc('_', outfile);
+ if (anchor[0])
+ {
+ fputs(anchor, outfile);
+ anchor[0] = '\0';
+ }
+ else
+ {
+ for (lineptr = line + 4; *lineptr; lineptr ++)
+ if (*lineptr == '\"')
+ continue;
+ else if (isalnum(*lineptr & 255))
+ html_putc(*lineptr, outfile);
+ else
+ html_putc('_', outfile);
+ }
fputs("\">", outfile);
fputs(end_fonts[font], outfile);
font = 0;
+ if (anchor[0])
+ fprintf(outfile, "<a name=\"%s\">", anchor);
+
html_alternate(line + 3, "b", "b", outfile);
+ if (anchor[0])
+ {
+ fputs("</a>", outfile);
+ anchor[0] = '\0';
+ }
+
if (post)
{
fputs(post, outfile);
fputs(end_fonts[font], outfile);
font = 0;
+ if (anchor[0])
+ fprintf(outfile, "<a name=\"%s\">", anchor);
+
html_alternate(line + 3, "i", "i", outfile);
+ if (anchor[0])
+ {
+ fputs("</a>", outfile);
+ anchor[0] = '\0';
+ }
+
if (post)
{
fputs(post, outfile);
fputs(end_fonts[font], outfile);
font = 0;
+ if (anchor[0])
+ fprintf(outfile, "<a name=\"%s\">", anchor);
+
html_alternate(line + 4, "b", "i", outfile);
+ if (anchor[0])
+ {
+ fputs("</a>", outfile);
+ anchor[0] = '\0';
+ }
+
if (post)
{
fputs(post, outfile);
fputs(end_fonts[font], outfile);
font = 0;
+ if (anchor[0])
+ fprintf(outfile, "<a name=\"%s\">", anchor);
+
html_alternate(line + 4, "b", NULL, outfile);
+ if (anchor[0])
+ {
+ fputs("</a>", outfile);
+ anchor[0] = '\0';
+ }
+
if (post)
{
fputs(post, outfile);
fputs(end_fonts[font], outfile);
font = 0;
+ if (anchor[0])
+ fprintf(outfile, "<a name=\"%s\">", anchor);
+
html_alternate(line + 4, "i", "b", outfile);
+ if (anchor[0])
+ {
+ fputs("</a>", outfile);
+ anchor[0] = '\0';
+ }
+
if (post)
{
fputs(post, outfile);
fputs(end_fonts[font], outfile);
font = 0;
+ if (anchor[0])
+ fprintf(outfile, "<a name=\"%s\">", anchor);
+
html_alternate(line + 4, "i", NULL, outfile);
+ if (anchor[0])
+ {
+ fputs("</a>", outfile);
+ anchor[0] = '\0';
+ }
+
if (post)
{
fputs(post, outfile);
fputs(end_fonts[font], outfile);
font = 0;
+ if (anchor[0])
+ fprintf(outfile, "<a name=\"%s\">", anchor);
+
html_alternate(line + 4, NULL, "b", outfile);
+ if (anchor[0])
+ {
+ fputs("</a>", outfile);
+ anchor[0] = '\0';
+ }
+
if (post)
{
fputs(post, outfile);
fputs(end_fonts[font], outfile);
font = 0;
+ if (anchor[0])
+ fprintf(outfile, "<a name=\"%s\">", anchor);
+
html_alternate(line + 4, NULL, "i", outfile);
+ if (anchor[0])
+ {
+ fputs("</a>", outfile);
+ anchor[0] = '\0';
+ }
+
if (post)
{
fputs(post, outfile);
fputs(end_fonts[font], outfile);
font = 0;
+ if (anchor[0])
+ fprintf(outfile, "<a name=\"%s\">", anchor);
+
html_alternate(line + 4, "small", "b", outfile);
+ if (anchor[0])
+ {
+ fputs("</a>", outfile);
+ anchor[0] = '\0';
+ }
+
if (post)
{
fputs(post, outfile);
fputs(end_fonts[font], outfile);
font = 0;
+ if (anchor[0])
+ fprintf(outfile, "<a name=\"%s\">", anchor);
+
html_alternate(line + 4, "small", "small", outfile);
+ if (anchor[0])
+ {
+ fputs("</a>", outfile);
+ anchor[0] = '\0';
+ }
+
if (post)
{
fputs(post, outfile);
}
fputs("<p>", outfile);
+
+ if (anchor[0])
+ {
+ fprintf(outfile, "<a name=\"%s\"></a>", anchor);
+ anchor[0] = '\0';
+ }
}
else if (!strcmp(line, ".RS") || !strncmp(line, ".RS ", 4))
{
fprintf(outfile, "<p style=\"margin-left: %.1fem; text-indent: %.1fem\">", amount, -amount);
+ if (anchor[0])
+ {
+ fprintf(outfile, "<a name=\"%s\"></a>", anchor);
+ anchor[0] = '\0';
+ }
+
if (line[1] == 'T')
post = "<br>\n";
}
fputs("<dt>", outfile);
snprintf(ddpost, sizeof(ddpost), "<dd style=\"margin-left: %.1fem\">", amount);
post = ddpost;
+
+ if (anchor[0])
+ {
+ fprintf(outfile, "<a name=\"%s\"></a>", anchor);
+ anchor[0] = '\0';
+ }
}
else if (!strncmp(line, ".IP ", 4))
{
fprintf(outfile, "<li style=\"margin-left: %.1fem;\">", amount);
else
fprintf(outfile, "<p style=\"margin-left: %.1fem;\">", amount);
+
+ if (anchor[0])
+ {
+ fprintf(outfile, "<a name=\"%s\"></a>", anchor);
+ anchor[0] = '\0';
+ }
}
else if (!strncmp(line, ".br", 3))
{
*/
}
#endif /* 0 */
+ else if (!strncmp(line, ".\\\"#", 4))
+ {
+ /*
+ * Anchor for HTML output...
+ */
+
+ strlcpy(anchor, line + 4, sizeof(anchor));
+ }
else if (strncmp(line, ".\\\"", 3))
{
/*
projects / thirdparty / cups.git / commitdiff
