[thirdparty/cups.git] / doc / help / man-cupsd.conf.html

<!DOCTYPE HTML>
<html>
<!-- SECTION: Man Pages -->
<head>
	<link rel="stylesheet" type="text/css" href="../cups-printable.css">
	<title>cupsd.conf(5)</title>
</head>
<body>
<h1 class="title">cupsd.conf(5)</h1>
<h2 class="title"><a name="NAME">Name</a></h2>
cupsd.conf - server configuration file for cups
<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
The
<i>cupsd.conf</i>
file configures the CUPS scheduler,
<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8).</a>
It is normally located in the
<i>/etc/cups</i>
directory. <b>Note:</b> File, directory, and user configuration directives that used to be allowed in the <i>cupsd.conf</i> file are now stored in the <i>cups-files.conf(5)</i> instead in order to prevent certain types of privilege escalation attacks.
<p>Each line in the file can be a configuration directive, a blank line, or a comment. Comment lines start with the # character. The configuration directives are intentionally similar to those used by the popular Apache web server software and are described below.
<h2 class="title"><a name="TOP_LEVEL_DIRECTIVES">Top-level Directives</a></h2>
The following directives are understood by
<b>cupsd</b><b>(8).</b>
Consult the online help (<a href="http://localhost:631/help">http://localhost:631/help</a>) for detailed descriptions:
<dl class="man">
<dt>AccessLogLevel config
<dd style="margin-left: 5.0em"><dt>AccessLogLevel actions
<dd style="margin-left: 5.0em"><dt>AccessLogLevel all
<dd style="margin-left: 5.0em">Specifies the logging level for the AccessLog file.
<dt>AutoPurgeJobs Yes
<dd style="margin-left: 5.0em"><dt>AutoPurgeJobs No
<dd style="margin-left: 5.0em"><br>
Specifies whether to purge job history data automatically when
it is no longer required for quotas.
<dt>BrowseLocalProtocols [
<dd style="margin-left: 5.0em"><i>All</i>
] [
<i>DNSSD</i>
]
Specifies the protocols to use for local printer sharing.
<dt>BrowseWebIF Yes
<dd style="margin-left: 5.0em"><dt>BrowseWebIF No
<dd style="margin-left: 5.0em"><br>
Specifies whether the CUPS web interface is advertised via DNS-SD.
<dt>Browsing Yes
<dd style="margin-left: 5.0em"><dt>Browsing No
<dd style="margin-left: 5.0em"><br>
Specifies whether or not shared printers should be advertised.
<dt>Classification banner
<dd style="margin-left: 5.0em"><br>
Specifies the security classification of the server.
<dt>ClassifyOverride Yes
<dd style="margin-left: 5.0em"><dt>ClassifyOverride No
<dd style="margin-left: 5.0em"><br>
Specifies whether to allow users to override the classification
of individual print jobs.
<dt>DefaultAuthType Basic
<dd style="margin-left: 5.0em"><dt>DefaultAuthType Negotiate
<dd style="margin-left: 5.0em"><br>
Specifies the default type of authentication to use.
<dt>DefaultEncryption Never
<dd style="margin-left: 5.0em"><dt>DefaultEncryption IfRequested
<dd style="margin-left: 5.0em"><dt>DefaultEncryption Required
<dd style="margin-left: 5.0em">Specifies the type of encryption to use for authenticated requests.
<dt>DefaultLanguage locale
<dd style="margin-left: 5.0em">Specifies the default language to use for text and web content.
<dt>DefaultPaperSize Auto
<dd style="margin-left: 5.0em"><dt>DefaultPaperSize None
<dd style="margin-left: 5.0em"><dt>DefaultPaperSize sizename
<dd style="margin-left: 5.0em">Specifies the default paper size for new print queues. "Auto" uses a locale-
specific default, while "None" specifies there is no default paper size.
<dt>DefaultPolicy policy-name
<dd style="margin-left: 5.0em">Specifies the default access policy to use.
<dt>DefaultShared Yes
<dd style="margin-left: 5.0em"><dt>DefaultShared No
<dd style="margin-left: 5.0em">Specifies whether local printers are shared by default.
<dt>DirtyCleanInterval seconds
<dd style="margin-left: 5.0em">Specifies the delay for updating of configuration and state files. A value of 0
causes the update to happen as soon as possible, typically within a few
milliseconds.
<dt>FilterLimit limit
<dd style="margin-left: 5.0em">Specifies the maximum cost of filters that are run concurrently.
<dt>FilterNice nice-value
<dd style="margin-left: 5.0em">Specifies the scheduling priority ("nice" value) of filters that
are run to print a job.
<dt>GSSServiceName name
<dd style="margin-left: 5.0em">Specifies the service name when using Kerberos authentication. The default
service name is "http".
<dt>HostNameLookups On
<dd style="margin-left: 5.0em"><dt>HostNameLookups Off
<dd style="margin-left: 5.0em"><dt>HostNameLookups Double
<dd style="margin-left: 5.0em">Specifies whether or not to do reverse lookups on client addresses.
<dt>Include filename
<dd style="margin-left: 5.0em">Includes the named file.
<dt>JobKillDelay seconds
<dd style="margin-left: 5.0em">Specifies the number of seconds to wait before killing the filters and backend
associated with a canceled or held job.
<dt>JobRetryInterval seconds
<dd style="margin-left: 5.0em">Specifies the interval between retries of jobs in seconds.
<dt>JobRetryLimit count
<dd style="margin-left: 5.0em">Specifies the number of retries that are done for jobs.
<dt>KeepAlive Yes
<dd style="margin-left: 5.0em"><dt>KeepAlive No
<dd style="margin-left: 5.0em">Specifies whether to support HTTP keep-alive connections.
<dt>KeepAliveTimeout seconds
<dd style="margin-left: 5.0em">Specifies the amount of time that connections are kept alive.
<dt>&lt;Limit operations> ... &lt;/Limit>
<dd style="margin-left: 5.0em">Specifies the IPP operations that are being limited inside a policy.
<dt>&lt;Limit methods> ... &lt;/Limit>
<dd style="margin-left: 5.0em"><dt>&lt;LimitExcept methods> ... &lt;/LimitExcept>
<dd style="margin-left: 5.0em">Specifies the HTTP methods that are being limited inside a location.
<dt>LimitRequestBody
<dd style="margin-left: 5.0em">Specifies the maximum size of any print job request.
<dt>Listen ip-address:port
<dd style="margin-left: 5.0em"><dt>Listen *:port
<dd style="margin-left: 5.0em"><dt>Listen /path/to/domain/socket
<dd style="margin-left: 5.0em">Listens to the specified address and port or domain socket path.
<dt>&lt;Location /path> ... &lt;/Location>
<dd style="margin-left: 5.0em">Specifies access control for the named location.
<dt>LogDebugHistory #-messages
<dd style="margin-left: 5.0em">Specifies the number of debugging messages that are logged when an error
occurs in a print job.
<dt>LogLevel alert
<dd style="margin-left: 5.0em"><dt>LogLevel crit
<dd style="margin-left: 5.0em"><dt>LogLevel debug2
<dd style="margin-left: 5.0em"><dt>LogLevel debug
<dd style="margin-left: 5.0em"><dt>LogLevel emerg
<dd style="margin-left: 5.0em"><dt>LogLevel error
<dd style="margin-left: 5.0em"><dt>LogLevel info
<dd style="margin-left: 5.0em"><dt>LogLevel none
<dd style="margin-left: 5.0em"><dt>LogLevel notice
<dd style="margin-left: 5.0em"><dt>LogLevel warn
<dd style="margin-left: 5.0em">Specifies the logging level for the ErrorLog file.
<dt>LogTimeFormat standard
<dd style="margin-left: 5.0em"><dt>LogTimeFormat usecs
<dd style="margin-left: 5.0em">Specifies the format of the date and time in the log files.
<dt>MaxClients number
<dd style="margin-left: 5.0em">Specifies the maximum number of simultaneous clients to support.
<dt>MaxClientsPerHost number
<dd style="margin-left: 5.0em">Specifies the maximum number of simultaneous clients to support from a
single address.
<dt>MaxCopies number
<dd style="margin-left: 5.0em">Specifies the maximum number of copies that a user can print of each job.
<dt>MaxHoldTime seconds
<dd style="margin-left: 5.0em">Specifies the maximum time a job may remain in the "indefinite" hold state
before it is canceled. Set to 0 to disable cancellation of held jobs.
<dt>MaxJobs number
<dd style="margin-left: 5.0em">Specifies the maximum number of simultaneous jobs to support.
<dt>MaxJobsPerPrinter number
<dd style="margin-left: 5.0em">Specifies the maximum number of simultaneous jobs per printer to support.
<dt>MaxJobsPerUser number
<dd style="margin-left: 5.0em">Specifies the maximum number of simultaneous jobs per user to support.
<dt>MaxJobTime seconds
<dd style="margin-left: 5.0em">Specifies the maximum time a job may take to print before it is canceled. The
default is 10800 seconds (3 hours). Set to 0 to disable cancellation of "stuck"
jobs.
<dt>MaxLogSize number-bytes
<dd style="margin-left: 5.0em">Specifies the maximum size of the log files before they are
rotated (0 to disable rotation)
<dt>MaxRequestSize number-bytes
<dd style="margin-left: 5.0em">Specifies the maximum request/file size in bytes (0 for no limit)
<dt>MultipleOperationTimeout seconds
<dd style="margin-left: 5.0em">Specifies the maximum amount of time to allow between files in a multiple file
print job.
<dt>PageLogFormat format string
<dd style="margin-left: 5.0em">Specifies the format of page log lines.
<dt>PassEnv variable [... variable]
<dd style="margin-left: 5.0em">Passes the specified environment variable(s) to child processes.
<dt>&lt;Policy name> ... &lt;/Policy>
<dd style="margin-left: 5.0em">Specifies access control for the named policy.
<dt>Port number
<dd style="margin-left: 5.0em">Specifies a port number to listen to for HTTP requests.
<dt>PreserveJobFiles Yes
<dd style="margin-left: 5.0em"><dt>PreserveJobFiles No
<dd style="margin-left: 5.0em">Specifies whether or not to preserve job files after they are printed.
<dt>PreserveJobHistory Yes
<dd style="margin-left: 5.0em"><dt>PreserveJobHistory No
<dd style="margin-left: 5.0em">Specifies whether or not to preserve the job history after they are
printed.
<dt>PrintcapFormat bsd
<dd style="margin-left: 5.0em"><dt>PrintcapFormat plist
<dd style="margin-left: 5.0em"><dt>PrintcapFormat solaris
<dd style="margin-left: 5.0em">Specifies the format of the printcap file.
<dt>ReloadTimeout seconds
<dd style="margin-left: 5.0em">Specifies the amount of time to wait for job completion before
restarting the scheduler.
<dt>RIPCache bytes
<dd style="margin-left: 5.0em">Specifies the maximum amount of memory to use when converting images
and PostScript files to bitmaps for a printer.
<dt>Satisfy all
<dd style="margin-left: 5.0em"><dt>Satisfy any
<dd style="margin-left: 5.0em">Specifies whether all or any limits set for a Location must be
satisfied to allow access.
<dt>ServerAdmin user@domain.com
<dd style="margin-left: 5.0em">Specifies the email address of the server administrator.
<dt>ServerAlias hostname [... hostname]
<dd style="margin-left: 5.0em"><dt>ServerAlias *
<dd style="margin-left: 5.0em">Specifies an alternate name that the server is known by. The special name "*"
allows any name to be used.
<dt>ServerName hostname-or-ip-address
<dd style="margin-left: 5.0em">Specifies the fully-qualified hostname of the server.
<dt>ServerTokens Full
<dd style="margin-left: 5.0em"><dt>ServerTokens Major
<dd style="margin-left: 5.0em"><dt>ServerTokens Minimal
<dd style="margin-left: 5.0em"><dt>ServerTokens Minor
<dd style="margin-left: 5.0em"><dt>ServerTokens None
<dd style="margin-left: 5.0em"><dt>ServerTokens OS
<dd style="margin-left: 5.0em"><dt>ServerTokens ProductOnly
<dd style="margin-left: 5.0em">Specifies what information is included in the Server header of HTTP
responses.
<dt>SetEnv variable value
<dd style="margin-left: 5.0em">Set the specified environment variable to be passed to child processes.
<dt>SSLListen
<dd style="margin-left: 5.0em">Listens on the specified address and port for encrypted connections.
<dt>SSLPort
<dd style="margin-left: 5.0em">Listens on the specified port for encrypted connections.
<dt>StrictConformance Yes
<dd style="margin-left: 5.0em"><dt>StrictConformance No
<dd style="margin-left: 5.0em">Specifies whether the scheduler requires clients to strictly adhere to the IPP
specifications. The default is No.
<dt>Timeout seconds
<dd style="margin-left: 5.0em">Specifies the HTTP request timeout in seconds.
<dt>WebInterface yes
<dd style="margin-left: 5.0em"><dt>WebInterface no
<dd style="margin-left: 5.0em">Specifies whether the web interface is enabled.
</dl>
<h2 class="title"><a name="DIRECTIVES_VALID_WITHIN_LOCATION_AND_LIMIT_SECTIONS">Directives Valid Within Location And Limit Sections</a></h2>
The following directives may be placed inside Location and Limit sections in the <i>cupsd.conf</i> file:
<dl class="man">
<dt>Allow all
<dd style="margin-left: 5.0em"><dt>Allow none
<dd style="margin-left: 5.0em"><dt>Allow host.domain.com
<dd style="margin-left: 5.0em"><dt>Allow *.domain.com
<dd style="margin-left: 5.0em"><dt>Allow ip-address
<dd style="margin-left: 5.0em"><dt>Allow ip-address/netmask
<dd style="margin-left: 5.0em"><dt>Allow ip-address/mm
<dd style="margin-left: 5.0em"><dt>Allow @IF(name)
<dd style="margin-left: 5.0em"><dt>Allow @LOCAL
<dd style="margin-left: 5.0em">Allows access from the named hosts or addresses.
<dt>AuthType None
<dd style="margin-left: 5.0em"><dt>AuthType Basic
<dd style="margin-left: 5.0em"><dt>AuthType Negotiate
<dd style="margin-left: 5.0em">Specifies the authentication type (None, Basic, or Negotiate)
<dt>Deny all
<dd style="margin-left: 5.0em"><dt>Deny none
<dd style="margin-left: 5.0em"><dt>Deny host.domain.com
<dd style="margin-left: 5.0em"><dt>Deny *.domain.com
<dd style="margin-left: 5.0em"><dt>Deny ip-address
<dd style="margin-left: 5.0em"><dt>Deny ip-address/netmask
<dd style="margin-left: 5.0em"><dt>Deny ip-address/mm
<dd style="margin-left: 5.0em"><dt>Deny @IF(name)
<dd style="margin-left: 5.0em"><dt>Deny @LOCAL
<dd style="margin-left: 5.0em">Denies access to the named host or address.
<dt>Encryption IfRequested
<dd style="margin-left: 5.0em"><dt>Encryption Never
<dd style="margin-left: 5.0em"><dt>Encryption Required
<dd style="margin-left: 5.0em">Specifies the level of encryption that is required for a particular
location.
<dt>Order allow,deny
<dd style="margin-left: 5.0em"><dt>Order deny,allow
<dd style="margin-left: 5.0em">Specifies the order of HTTP access control (allow,deny or deny,allow)
<dt>Require group group-name-list
<dd style="margin-left: 5.0em"><dt>Require user user-name-list
<dd style="margin-left: 5.0em"><dt>Require valid-user
<dd style="margin-left: 5.0em">Specifies that user or group authentication is required.
</dl>
<h2 class="title"><a name="DIRECTIVES_VALID_WITHIN_POLICY_SECTIONS">Directives Valid Within Policy Sections</a></h2>
The following directives may be placed inside Policy sections in the <i>cupsd.conf</i> file:
<dl class="man">
<dt>JobPrivateAccess all
<dd style="margin-left: 5.0em"><dt>JobPrivateAccess default
<dd style="margin-left: 5.0em"><dt>JobPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+
<dd style="margin-left: 5.0em">Specifies an access list for a job's private values. The "default" access list is "@OWNER @SYSTEM". "@ACL" maps to the printer's requesting-user-name-allowed or requesting-user-name-denied values.
<dt>JobPrivateValues all
<dd style="margin-left: 5.0em"><dt>JobPrivateValues default
<dd style="margin-left: 5.0em"><dt>JobPrivateValues none
<dd style="margin-left: 5.0em"><dt>JobPrivateValues attribute-name-1 [ ... attribute-name-N ]
<dd style="margin-left: 5.0em">Specifies the list of job values to make private. The "default" values are "job-name", "job-originating-host-name", and "job-originating-user-name".
<dt>SubscriptionPrivateAccess all
<dd style="margin-left: 5.0em"><dt>SubscriptionPrivateAccess default
<dd style="margin-left: 5.0em"><dt>SubscriptionPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+
<dd style="margin-left: 5.0em">Specifies an access list for a subscription's private values. The "default"
access list is "@OWNER @SYSTEM". "@ACL" maps to the printer's
requesting-user-name-allowed or requesting-user-name-denied values.
<dt>SubscriptionPrivateValues all
<dd style="margin-left: 5.0em"><dt>SubscriptionPrivateValues default
<dd style="margin-left: 5.0em"><dt>SubscriptionPrivateValues none
<dd style="margin-left: 5.0em"><dt>SubscriptionPrivateValues attribute-name-1 [ ... attribute-name-N ]
<dd style="margin-left: 5.0em">Specifies the list of job values to make private. The "default" values are
"notify-events", "notify-pull-method", "notify-recipient-uri",
"notify-subscriber-user-name", and "notify-user-data".
</dl>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
<a href="man-classes.conf.html?TOPIC=Man+Pages"><b>classes.conf</b>(5),</a><a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5),</a><a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a><a href="man-mime.convs.html?TOPIC=Man+Pages"><b>mime.convs</b>(5),</a><a href="man-mime.types.html?TOPIC=Man+Pages"><b>mime.types</b>(5),</a><a href="man-printers.conf.html?TOPIC=Man+Pages"><b>printers.conf</b>(5),</a><a href="man-subscriptions.conf.html?TOPIC=Man+Pages"><b>subscriptions.conf</b>(5),</a>
<a href="http://localhost:631/help">http://localhost:631/help</a>
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright &copy; 2007-2014 by Apple Inc.

</body>
</html>
Commit	Line	Data
c277f98c	1	<!DOCTYPE HTML>
94436c5a MS	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>
	11	cupsd.conf - server configuration file for cups
	12	<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
c390f212 MS	13	The
	14	<i>cupsd.conf</i>
	15	file configures the CUPS scheduler,
	16	<a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8).</a>
	17	It is normally located in the
	18	<i>/etc/cups</i>
	19	directory. <b>Note:</b> File, directory, and user configuration directives that used to be allowed in the <i>cupsd.conf</i> file are now stored in the <i>cups-files.conf(5)</i> instead in order to prevent certain types of privilege escalation attacks.
	20	<p>Each line in the file can be a configuration directive, a blank line, or a comment. Comment lines start with the # character. The configuration directives are intentionally similar to those used by the popular Apache web server software and are described below.
	21	<h2 class="title"><a name="TOP_LEVEL_DIRECTIVES">Top-level Directives</a></h2>
	22	The following directives are understood by
	23	<b>cupsd</b><b>(8).</b>
	24	Consult the online help (<a href="http://localhost:631/help">http://localhost:631/help</a>) for detailed descriptions:
2909c66c MS	25	<dl class="man">
	26	<dt>AccessLogLevel config
	27	<dd style="margin-left: 5.0em"><dt>AccessLogLevel actions
	28	<dd style="margin-left: 5.0em"><dt>AccessLogLevel all
c390f212	29	<dd style="margin-left: 5.0em">Specifies the logging level for the AccessLog file.
2909c66c MS	30	<dt>AutoPurgeJobs Yes
	31	<dd style="margin-left: 5.0em"><dt>AutoPurgeJobs No
	32	<dd style="margin-left: 5.0em"><br>
c277f98c	33	Specifies whether to purge job history data automatically when
94436c5a	34	it is no longer required for quotas.
c390f212 MS	35	<dt>BrowseLocalProtocols [
	36	<dd style="margin-left: 5.0em"><i>All</i>
	37	] [
	38	<i>DNSSD</i>
	39	]
c277f98c	40	Specifies the protocols to use for local printer sharing.
2909c66c MS	41	<dt>BrowseWebIF Yes
	42	<dd style="margin-left: 5.0em"><dt>BrowseWebIF No
	43	<dd style="margin-left: 5.0em"><br>
c277f98c	44	Specifies whether the CUPS web interface is advertised via DNS-SD.
2909c66c MS	45	<dt>Browsing Yes
	46	<dd style="margin-left: 5.0em"><dt>Browsing No
	47	<dd style="margin-left: 5.0em"><br>
c277f98c	48	Specifies whether or not shared printers should be advertised.
2909c66c MS	49	<dt>Classification banner
2909c66c MS	50	<dd style="margin-left: 5.0em"><br>
c277f98c	51	Specifies the security classification of the server.
2909c66c MS	52	<dt>ClassifyOverride Yes
	53	<dd style="margin-left: 5.0em"><dt>ClassifyOverride No
	54	<dd style="margin-left: 5.0em"><br>
c277f98c	55	Specifies whether to allow users to override the classification
94436c5a	56	of individual print jobs.
2909c66c MS	57	<dt>DefaultAuthType Basic
	58	<dd style="margin-left: 5.0em"><dt>DefaultAuthType Negotiate
	59	<dd style="margin-left: 5.0em"><br>
c277f98c	60	Specifies the default type of authentication to use.
2909c66c MS	61	<dt>DefaultEncryption Never
	62	<dd style="margin-left: 5.0em"><dt>DefaultEncryption IfRequested
	63	<dd style="margin-left: 5.0em"><dt>DefaultEncryption Required
c390f212	64	<dd style="margin-left: 5.0em">Specifies the type of encryption to use for authenticated requests.
2909c66c	65	<dt>DefaultLanguage locale
c390f212	66	<dd style="margin-left: 5.0em">Specifies the default language to use for text and web content.
2909c66c MS	67	<dt>DefaultPaperSize Auto
	68	<dd style="margin-left: 5.0em"><dt>DefaultPaperSize None
	69	<dd style="margin-left: 5.0em"><dt>DefaultPaperSize sizename
c390f212	70	<dd style="margin-left: 5.0em">Specifies the default paper size for new print queues. "Auto" uses a locale-
94436c5a	71	specific default, while "None" specifies there is no default paper size.
2909c66c	72	<dt>DefaultPolicy policy-name
c390f212	73	<dd style="margin-left: 5.0em">Specifies the default access policy to use.
2909c66c MS	74	<dt>DefaultShared Yes
2909c66c MS	75	<dd style="margin-left: 5.0em"><dt>DefaultShared No
c390f212	76	<dd style="margin-left: 5.0em">Specifies whether local printers are shared by default.
2909c66c	77	<dt>DirtyCleanInterval seconds
c390f212	78	<dd style="margin-left: 5.0em">Specifies the delay for updating of configuration and state files. A value of 0
94436c5a MS	79	causes the update to happen as soon as possible, typically within a few
94436c5a MS	80	milliseconds.
2909c66c	81	<dt>FilterLimit limit
c390f212	82	<dd style="margin-left: 5.0em">Specifies the maximum cost of filters that are run concurrently.
2909c66c	83	<dt>FilterNice nice-value
c390f212	84	<dd style="margin-left: 5.0em">Specifies the scheduling priority ("nice" value) of filters that
94436c5a	85	are run to print a job.
2909c66c	86	<dt>GSSServiceName name
c390f212	87	<dd style="margin-left: 5.0em">Specifies the service name when using Kerberos authentication. The default
ffa2ca90	88	service name is "http".
2909c66c MS	89	<dt>HostNameLookups On
	90	<dd style="margin-left: 5.0em"><dt>HostNameLookups Off
	91	<dd style="margin-left: 5.0em"><dt>HostNameLookups Double
c390f212	92	<dd style="margin-left: 5.0em">Specifies whether or not to do reverse lookups on client addresses.
2909c66c	93	<dt>Include filename
c390f212	94	<dd style="margin-left: 5.0em">Includes the named file.
2909c66c	95	<dt>JobKillDelay seconds
c390f212	96	<dd style="margin-left: 5.0em">Specifies the number of seconds to wait before killing the filters and backend
94436c5a	97	associated with a canceled or held job.
2909c66c	98	<dt>JobRetryInterval seconds
c390f212	99	<dd style="margin-left: 5.0em">Specifies the interval between retries of jobs in seconds.
2909c66c	100	<dt>JobRetryLimit count
c390f212	101	<dd style="margin-left: 5.0em">Specifies the number of retries that are done for jobs.
2909c66c MS	102	<dt>KeepAlive Yes
2909c66c MS	103	<dd style="margin-left: 5.0em"><dt>KeepAlive No
c390f212	104	<dd style="margin-left: 5.0em">Specifies whether to support HTTP keep-alive connections.
2909c66c	105	<dt>KeepAliveTimeout seconds
c390f212	106	<dd style="margin-left: 5.0em">Specifies the amount of time that connections are kept alive.
2909c66c	107	<dt><Limit operations> ... </Limit>
c390f212	108	<dd style="margin-left: 5.0em">Specifies the IPP operations that are being limited inside a policy.
2909c66c MS	109	<dt><Limit methods> ... </Limit>
2909c66c MS	110	<dd style="margin-left: 5.0em"><dt><LimitExcept methods> ... </LimitExcept>
c390f212	111	<dd style="margin-left: 5.0em">Specifies the HTTP methods that are being limited inside a location.
2909c66c	112	<dt>LimitRequestBody
c390f212	113	<dd style="margin-left: 5.0em">Specifies the maximum size of any print job request.
2909c66c MS	114	<dt>Listen ip-address:port
	115	<dd style="margin-left: 5.0em"><dt>Listen *:port
	116	<dd style="margin-left: 5.0em"><dt>Listen /path/to/domain/socket
c390f212	117	<dd style="margin-left: 5.0em">Listens to the specified address and port or domain socket path.
2909c66c	118	<dt><Location /path> ... </Location>
c390f212	119	<dd style="margin-left: 5.0em">Specifies access control for the named location.
2909c66c	120	<dt>LogDebugHistory #-messages
c390f212	121	<dd style="margin-left: 5.0em">Specifies the number of debugging messages that are logged when an error
94436c5a	122	occurs in a print job.
2909c66c MS	123	<dt>LogLevel alert
	124	<dd style="margin-left: 5.0em"><dt>LogLevel crit
	125	<dd style="margin-left: 5.0em"><dt>LogLevel debug2
	126	<dd style="margin-left: 5.0em"><dt>LogLevel debug
	127	<dd style="margin-left: 5.0em"><dt>LogLevel emerg
	128	<dd style="margin-left: 5.0em"><dt>LogLevel error
	129	<dd style="margin-left: 5.0em"><dt>LogLevel info
	130	<dd style="margin-left: 5.0em"><dt>LogLevel none
	131	<dd style="margin-left: 5.0em"><dt>LogLevel notice
	132	<dd style="margin-left: 5.0em"><dt>LogLevel warn
c390f212	133	<dd style="margin-left: 5.0em">Specifies the logging level for the ErrorLog file.
2909c66c MS	134	<dt>LogTimeFormat standard
2909c66c MS	135	<dd style="margin-left: 5.0em"><dt>LogTimeFormat usecs
c390f212	136	<dd style="margin-left: 5.0em">Specifies the format of the date and time in the log files.
2909c66c	137	<dt>MaxClients number
c390f212	138	<dd style="margin-left: 5.0em">Specifies the maximum number of simultaneous clients to support.
2909c66c	139	<dt>MaxClientsPerHost number
c390f212	140	<dd style="margin-left: 5.0em">Specifies the maximum number of simultaneous clients to support from a
94436c5a	141	single address.
2909c66c	142	<dt>MaxCopies number
c390f212	143	<dd style="margin-left: 5.0em">Specifies the maximum number of copies that a user can print of each job.
2909c66c	144	<dt>MaxHoldTime seconds
c390f212	145	<dd style="margin-left: 5.0em">Specifies the maximum time a job may remain in the "indefinite" hold state
94436c5a	146	before it is canceled. Set to 0 to disable cancellation of held jobs.
2909c66c	147	<dt>MaxJobs number
c390f212	148	<dd style="margin-left: 5.0em">Specifies the maximum number of simultaneous jobs to support.
2909c66c	149	<dt>MaxJobsPerPrinter number
c390f212	150	<dd style="margin-left: 5.0em">Specifies the maximum number of simultaneous jobs per printer to support.
2909c66c	151	<dt>MaxJobsPerUser number
c390f212	152	<dd style="margin-left: 5.0em">Specifies the maximum number of simultaneous jobs per user to support.
2909c66c	153	<dt>MaxJobTime seconds
c390f212	154	<dd style="margin-left: 5.0em">Specifies the maximum time a job may take to print before it is canceled. The
94436c5a MS	155	default is 10800 seconds (3 hours). Set to 0 to disable cancellation of "stuck"
94436c5a MS	156	jobs.
2909c66c	157	<dt>MaxLogSize number-bytes
c390f212	158	<dd style="margin-left: 5.0em">Specifies the maximum size of the log files before they are
94436c5a	159	rotated (0 to disable rotation)
2909c66c	160	<dt>MaxRequestSize number-bytes
c390f212	161	<dd style="margin-left: 5.0em">Specifies the maximum request/file size in bytes (0 for no limit)
2909c66c	162	<dt>MultipleOperationTimeout seconds
c390f212	163	<dd style="margin-left: 5.0em">Specifies the maximum amount of time to allow between files in a multiple file
94436c5a	164	print job.
2909c66c	165	<dt>PageLogFormat format string
c390f212	166	<dd style="margin-left: 5.0em">Specifies the format of page log lines.
2909c66c	167	<dt>PassEnv variable [... variable]
c390f212	168	<dd style="margin-left: 5.0em">Passes the specified environment variable(s) to child processes.
2909c66c	169	<dt><Policy name> ... </Policy>
c390f212	170	<dd style="margin-left: 5.0em">Specifies access control for the named policy.
2909c66c	171	<dt>Port number
c390f212	172	<dd style="margin-left: 5.0em">Specifies a port number to listen to for HTTP requests.
2909c66c MS	173	<dt>PreserveJobFiles Yes
2909c66c MS	174	<dd style="margin-left: 5.0em"><dt>PreserveJobFiles No
c390f212	175	<dd style="margin-left: 5.0em">Specifies whether or not to preserve job files after they are printed.
2909c66c MS	176	<dt>PreserveJobHistory Yes
2909c66c MS	177	<dd style="margin-left: 5.0em"><dt>PreserveJobHistory No
c390f212	178	<dd style="margin-left: 5.0em">Specifies whether or not to preserve the job history after they are
94436c5a	179	printed.
2909c66c MS	180	<dt>PrintcapFormat bsd
	181	<dd style="margin-left: 5.0em"><dt>PrintcapFormat plist
	182	<dd style="margin-left: 5.0em"><dt>PrintcapFormat solaris
c390f212	183	<dd style="margin-left: 5.0em">Specifies the format of the printcap file.
2909c66c	184	<dt>ReloadTimeout seconds
c390f212	185	<dd style="margin-left: 5.0em">Specifies the amount of time to wait for job completion before
94436c5a	186	restarting the scheduler.
2909c66c	187	<dt>RIPCache bytes
c390f212	188	<dd style="margin-left: 5.0em">Specifies the maximum amount of memory to use when converting images
94436c5a	189	and PostScript files to bitmaps for a printer.
2909c66c MS	190	<dt>Satisfy all
2909c66c MS	191	<dd style="margin-left: 5.0em"><dt>Satisfy any
c390f212	192	<dd style="margin-left: 5.0em">Specifies whether all or any limits set for a Location must be
94436c5a	193	satisfied to allow access.
2909c66c	194	<dt>ServerAdmin user@domain.com
c390f212	195	<dd style="margin-left: 5.0em">Specifies the email address of the server administrator.
2909c66c MS	196	<dt>ServerAlias hostname [... hostname]
2909c66c MS	197	<dd style="margin-left: 5.0em"><dt>ServerAlias *
c390f212	198	<dd style="margin-left: 5.0em">Specifies an alternate name that the server is known by. The special name "*"
94436c5a	199	allows any name to be used.
2909c66c	200	<dt>ServerName hostname-or-ip-address
c390f212	201	<dd style="margin-left: 5.0em">Specifies the fully-qualified hostname of the server.
2909c66c MS	202	<dt>ServerTokens Full
	203	<dd style="margin-left: 5.0em"><dt>ServerTokens Major
	204	<dd style="margin-left: 5.0em"><dt>ServerTokens Minimal
	205	<dd style="margin-left: 5.0em"><dt>ServerTokens Minor
	206	<dd style="margin-left: 5.0em"><dt>ServerTokens None
	207	<dd style="margin-left: 5.0em"><dt>ServerTokens OS
	208	<dd style="margin-left: 5.0em"><dt>ServerTokens ProductOnly
c390f212	209	<dd style="margin-left: 5.0em">Specifies what information is included in the Server header of HTTP
94436c5a	210	responses.
2909c66c	211	<dt>SetEnv variable value
c390f212	212	<dd style="margin-left: 5.0em">Set the specified environment variable to be passed to child processes.
2909c66c	213	<dt>SSLListen
c390f212	214	<dd style="margin-left: 5.0em">Listens on the specified address and port for encrypted connections.
2909c66c	215	<dt>SSLPort
c390f212	216	<dd style="margin-left: 5.0em">Listens on the specified port for encrypted connections.
2909c66c MS	217	<dt>StrictConformance Yes
2909c66c MS	218	<dd style="margin-left: 5.0em"><dt>StrictConformance No
c390f212	219	<dd style="margin-left: 5.0em">Specifies whether the scheduler requires clients to strictly adhere to the IPP
94436c5a	220	specifications. The default is No.
c390f212 MS	221	<dt>Timeout seconds
	222	<dd style="margin-left: 5.0em">Specifies the HTTP request timeout in seconds.
	223	<dt>WebInterface yes
	224	<dd style="margin-left: 5.0em"><dt>WebInterface no
	225	<dd style="margin-left: 5.0em">Specifies whether the web interface is enabled.
	226	</dl>
	227	<h2 class="title"><a name="DIRECTIVES_VALID_WITHIN_LOCATION_AND_LIMIT_SECTIONS">Directives Valid Within Location And Limit Sections</a></h2>
	228	The following directives may be placed inside Location and Limit sections in the <i>cupsd.conf</i> file:
	229	<dl class="man">
	230	<dt>Allow all
	231	<dd style="margin-left: 5.0em"><dt>Allow none
	232	<dd style="margin-left: 5.0em"><dt>Allow host.domain.com
	233	<dd style="margin-left: 5.0em"><dt>Allow *.domain.com
	234	<dd style="margin-left: 5.0em"><dt>Allow ip-address
	235	<dd style="margin-left: 5.0em"><dt>Allow ip-address/netmask
	236	<dd style="margin-left: 5.0em"><dt>Allow ip-address/mm
	237	<dd style="margin-left: 5.0em"><dt>Allow @IF(name)
	238	<dd style="margin-left: 5.0em"><dt>Allow @LOCAL
	239	<dd style="margin-left: 5.0em">Allows access from the named hosts or addresses.
	240	<dt>AuthType None
	241	<dd style="margin-left: 5.0em"><dt>AuthType Basic
	242	<dd style="margin-left: 5.0em"><dt>AuthType Negotiate
	243	<dd style="margin-left: 5.0em">Specifies the authentication type (None, Basic, or Negotiate)
	244	<dt>Deny all
	245	<dd style="margin-left: 5.0em"><dt>Deny none
	246	<dd style="margin-left: 5.0em"><dt>Deny host.domain.com
	247	<dd style="margin-left: 5.0em"><dt>Deny *.domain.com
	248	<dd style="margin-left: 5.0em"><dt>Deny ip-address
	249	<dd style="margin-left: 5.0em"><dt>Deny ip-address/netmask
	250	<dd style="margin-left: 5.0em"><dt>Deny ip-address/mm
	251	<dd style="margin-left: 5.0em"><dt>Deny @IF(name)
	252	<dd style="margin-left: 5.0em"><dt>Deny @LOCAL
	253	<dd style="margin-left: 5.0em">Denies access to the named host or address.
	254	<dt>Encryption IfRequested
	255	<dd style="margin-left: 5.0em"><dt>Encryption Never
	256	<dd style="margin-left: 5.0em"><dt>Encryption Required
	257	<dd style="margin-left: 5.0em">Specifies the level of encryption that is required for a particular
	258	location.
	259	<dt>Order allow,deny
	260	<dd style="margin-left: 5.0em"><dt>Order deny,allow
	261	<dd style="margin-left: 5.0em">Specifies the order of HTTP access control (allow,deny or deny,allow)
	262	<dt>Require group group-name-list
	263	<dd style="margin-left: 5.0em"><dt>Require user user-name-list
	264	<dd style="margin-left: 5.0em"><dt>Require valid-user
	265	<dd style="margin-left: 5.0em">Specifies that user or group authentication is required.
	266	</dl>
	267	<h2 class="title"><a name="DIRECTIVES_VALID_WITHIN_POLICY_SECTIONS">Directives Valid Within Policy Sections</a></h2>
	268	The following directives may be placed inside Policy sections in the <i>cupsd.conf</i> file:
	269	<dl class="man">
	270	<dt>JobPrivateAccess all
	271	<dd style="margin-left: 5.0em"><dt>JobPrivateAccess default
	272	<dd style="margin-left: 5.0em"><dt>JobPrivateAccess {user\|@group\|@ACL\|@OWNER\|@SYSTEM}+
	273	<dd style="margin-left: 5.0em">Specifies an access list for a job's private values. The "default" access list is "@OWNER @SYSTEM". "@ACL" maps to the printer's requesting-user-name-allowed or requesting-user-name-denied values.
	274	<dt>JobPrivateValues all
	275	<dd style="margin-left: 5.0em"><dt>JobPrivateValues default
	276	<dd style="margin-left: 5.0em"><dt>JobPrivateValues none
	277	<dd style="margin-left: 5.0em"><dt>JobPrivateValues attribute-name-1 [ ... attribute-name-N ]
	278	<dd style="margin-left: 5.0em">Specifies the list of job values to make private. The "default" values are "job-name", "job-originating-host-name", and "job-originating-user-name".
2909c66c MS	279	<dt>SubscriptionPrivateAccess all
	280	<dd style="margin-left: 5.0em"><dt>SubscriptionPrivateAccess default
	281	<dd style="margin-left: 5.0em"><dt>SubscriptionPrivateAccess {user\|@group\|@ACL\|@OWNER\|@SYSTEM}+
c390f212	282	<dd style="margin-left: 5.0em">Specifies an access list for a subscription's private values. The "default"
94436c5a MS	283	access list is "@OWNER @SYSTEM". "@ACL" maps to the printer's
94436c5a MS	284	requesting-user-name-allowed or requesting-user-name-denied values.
2909c66c MS	285	<dt>SubscriptionPrivateValues all
	286	<dd style="margin-left: 5.0em"><dt>SubscriptionPrivateValues default
	287	<dd style="margin-left: 5.0em"><dt>SubscriptionPrivateValues none
	288	<dd style="margin-left: 5.0em"><dt>SubscriptionPrivateValues attribute-name-1 [ ... attribute-name-N ]
	289	<dd style="margin-left: 5.0em">Specifies the list of job values to make private. The "default" values are
94436c5a MS	290	"notify-events", "notify-pull-method", "notify-recipient-uri",
94436c5a MS	291	"notify-subscriber-user-name", and "notify-user-data".
2909c66c	292	</dl>
94436c5a	293	<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
c390f212	294	<a href="man-classes.conf.html?TOPIC=Man+Pages"><b>classes.conf</b>(5),</a><a href="man-cups-files.conf.html?TOPIC=Man+Pages"><b>cups-files.conf</b>(5),</a><a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a><a href="man-mime.convs.html?TOPIC=Man+Pages"><b>mime.convs</b>(5),</a><a href="man-mime.types.html?TOPIC=Man+Pages"><b>mime.types</b>(5),</a><a href="man-printers.conf.html?TOPIC=Man+Pages"><b>printers.conf</b>(5),</a><a href="man-subscriptions.conf.html?TOPIC=Man+Pages"><b>subscriptions.conf</b>(5),</a>
c277f98c	295	<a href="http://localhost:631/help">http://localhost:631/help</a>
94436c5a	296	<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
c390f212	297	Copyright © 2007-2014 by Apple Inc.
94436c5a MS	298
	299	</body>
	300	</html>