]> git.ipfire.org Git - thirdparty/cups.git/blobdiff - doc/help/ref-cupsd-conf.html.in
Merge changes from CUPS 1.6svn-r10390.
[thirdparty/cups.git] / doc / help / ref-cupsd-conf.html.in
index 38f00d2a37295c34bcd61602c7a2b5df941ea842..ef666f32d85a6e4a0867a39692dfc3e2ea9daf78 100644 (file)
@@ -42,6 +42,12 @@ sudo launchctl load /System/Library/LaunchDaemons/org.cups.cupsd.plist
 <P>You can also edit this file from the CUPS web interface, which
 automatically handles restarting the scheduler.</P>
 
+<BLOCKQUOTE><B>Note:</B>
+
+<P>The specification of time units ("w" for weeks, "h" for hours, etc.) in the various time interval directives is new in CUPS 1.6. Prior releases of CUPS only supported time intervals in seconds.</P>
+
+</BLOCKQUOTE>
+
 
 <H2 CLASS="title"><A NAME="AccessLog">AccessLog</A></H2>
 
@@ -632,17 +638,19 @@ HREF="#Limit"><CODE>Limit</CODE></A> section.</P>
 <H3>Examples</H3>
 
 <PRE CLASS="command">
+DirtyCleanInterval 1w
+DirtyCleanInterval 1d
+DirtyCleanInterval 1h
+DirtyCleanInterval 1m
 DirtyCleanInterval 30
 DirtyCleanInterval 0
 </PRE>
 
 <H3>Description</H3>
 
-<P>The <CODE>DirtyCleanInterval</CODE> directive specifies the number of
-seconds to wait before updating configuration and state files for printers,
-classes, subscriptions, and jobs. The default is 30 seconds. A value of 0
-causes the update to occur as soon as possible, typically within a few
-milliseconds.</P>
+<P>The <CODE>DirtyCleanInterval</CODE> directive specifies the amount of time to wait before updating configuration and state files for printers, classes, subscriptions, and jobs in seconds (no suffix), minutes ("m" suffix), hours ("h" suffix), days ("d" suffix), or weeks ("w" suffix). A value of <CODE>0</CODE> causes the update to occur as soon as possible, typically within a few milliseconds.</P>
+
+<P>The default value is <CODE>30</CODE> (30 seconds).</P>
 
 
 <H2 CLASS="title"><A NAME="DocumentRoot">DocumentRoot</A></H2>
@@ -1011,7 +1019,7 @@ JobPrivateValues attribute-name-1 [ ... attribute-name-N ]
 
 <P>The <CODE>JobPrivateValues</CODE> directive specifies the list of job values
 to make private. The "default" values are "job-name",
-"job-originating-host-name", and "job-originating-user-name".</P>
+"job-originating-host-name", "job-originating-user-name", and "phone".</P>
 
 <P>The <CODE>JobPrivateValues</CODE> directive must appear inside a <A
 HREF="#Policy"><CODE>Policy</CODE></A> section.</P>
@@ -1022,17 +1030,18 @@ HREF="#Policy"><CODE>Policy</CODE></A> section.</P>
 <H3>Examples</H3>
 
 <PRE CLASS="command">
+JobRetryInterval 1w
+JobRetryInterval 1d
+JobRetryInterval 1h
+JobRetryInterval 1m
 JobRetryInterval 30
-JobRetryInterval 120
 </PRE>
 
 <H3>Description</H3>
 
-<P>The <CODE>JobRetryInterval</CODE> directive specifies the
-number of seconds to wait before retrying a job. This is
-typically used for fax queues but can also be used with normal
-print queues whose error policy is <CODE>retry-job</CODE>. The
-default is 30 seconds.</P>
+<P>The <CODE>JobRetryInterval</CODE> directive specifies the amount of time to wait before retrying a job in seconds (no suffix), minutes ("m" suffix), hours ("h" suffix), days ("d" suffix), or weeks ("w" suffix). This is typically used for fax queues but can also be used with normal print queues whose error policy is <CODE>retry-job</CODE> or <CODE>retry-current-job</CODE>.</P>
+
+<P>The default is <CODE>30</CODE> (30 seconds).</P>
 
 
 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.4/Mac OS X 10.6</SPAN><A NAME="JobKillDelay">JobKillDelay</A></H2>
@@ -1040,15 +1049,18 @@ default is 30 seconds.</P>
 <H3>Examples</H3>
 
 <PRE CLASS="command">
+JobKillDelay 1w
+JobKillDelay 1d
+JobKillDelay 1h
+JobKillDelay 1m
 JobKillDelay 30
-JobKillDelay 120
 </PRE>
 
 <H3>Description</H3>
 
-<P>The <CODE>JobKillDelay</CODE> directive specifies the number of seconds to
-wait before killing the filters and backend associated with a canceled or held
-job. The default is 30 seconds.</P>
+<P>The <CODE>JobKillDelay</CODE> directive specifies the amount of time to wait before killing the filters and backend associated with a canceled or held job in seconds (no suffix), minutes ("m" suffix), hours ("h" suffix), days ("d" suffix), or weeks ("w" suffix).</P>
+
+<P>The default is <CODE>30</CODE> (30 seconds).</P>
 
 
 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/Mac OS X 10.5</SPAN><A NAME="JobRetryLimit">JobRetryLimit</A></H2>
@@ -1095,15 +1107,18 @@ field of each request.</P>
 <H3>Examples</H3>
 
 <PRE CLASS="command">
-KeepAliveTimeout 60
+KeepAliveTimeout 1w
+KeepAliveTimeout 1d
+KeepAliveTimeout 1h
+KeepAliveTimeout 1m
 KeepAliveTimeout 30
 </PRE>
 
 <H3>Description</H3>
 
-<P>The <CODE>KeepAliveTimeout</CODE> directive controls how long
-a persistent HTTP connection will remain open after the last
-request. The default is 30 seconds.</P>
+<P>The <CODE>KeepAliveTimeout</CODE> directive controls how long a persistent HTTP connection will remain open after the last request in seconds (no suffix), minutes ("m" suffix), hours ("h" suffix), days ("d" suffix), or weeks ("w" suffix).</P>
+
+<P>The default is <CODE>30</CODE> (30 seconds).</P>
 
 
 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.7</SPAN><A NAME="Limit">Limit (Location)</A></H2>
@@ -1681,14 +1696,16 @@ copies to 100.</P>
 
 <PRE CLASS="command">
 MaxHoldTime 10800
+MaxHoldTime 3h
+MaxHoldTime 180m
 MaxHoldTime 0
 </PRE>
 
 <H3>Description</H3>
 
-<P>The <CODE>MaxHoldTime</CODE> directive controls the maximum number of seconds allowed for a job to remain in the "indefinite" hold state. The job is canceled automatically if it remains held indefinitely longer than the specified number of seconds.</P>
+<P>The <CODE>MaxHoldTime</CODE> directive controls the maximum number of seconds allowed for a job to remain in the "indefinite" hold state. The job is canceled automatically if it remains held indefinitely longer than the specified time interval in seconds (no suffix), minutes ("m" suffix), hours ("h" suffix), days ("d" suffix), or weeks ("w" suffix).</P>
 
-<p>The default setting is 0 which disables this functionality.</P>
+<p>The default setting is <CODE>0</CODE> which disables this functionality.</P>
 
 
 <H2 CLASS="title"><A NAME="MaxJobs">MaxJobs</A></H2>
@@ -1763,6 +1780,8 @@ default setting is 0.</P>
 
 <PRE CLASS="command">
 MaxJobTime 10800
+MaxJobTime 3h
+MaxJobTime 180m
 MaxJobTime 0
 </PRE>
 
@@ -1770,10 +1789,9 @@ MaxJobTime 0
 
 <P>The <CODE>MaxJobTime</CODE> directive controls the maximum number of
 seconds allowed for a job to complete printing before it is considered "stuck".
-The job is canceled automatically if it takes longer than the specified number of seconds to complete.</P>
+The job is canceled automatically if it takes longer than the specified time to complete in seconds (no suffix), minutes ("m" suffix), hours ("h" suffix), days ("d" suffix), or weeks ("w" suffix).</P>
 
-<p>Setting the maximum time to 0 disables this functionality. The default
-setting is 10800 seconds (3 hours).</P>
+<p>Setting the maximum time to <CODE>0</CODE> disables this functionality. The default setting is <CODE>3h</CODE> (3 hours).</P>
 
 
 <H2 CLASS="title"><A NAME="MaxLogSize">MaxLogSize</A></H2>
@@ -1825,15 +1843,18 @@ directive instead.</P>
 <H3>Examples</H3>
 
 <PRE CLASS="command">
-MultipleOperationTimeout 60
+MultipleOperationTimeout 1w
+MultipleOperationTimeout 1d
+MultipleOperationTimeout 1h
+MultipleOperationTimeout 5m
 MultipleOperationTimeout 300
-MultipleOperationTimeout 86400
 </PRE>
 
 <H3>Description</H3>
 
-<P>The <CODE>MultipleOperationTimeout</CODE> directive sets the maximum amount
-of time between files in a multi-file print job. The default is 300 seconds.</P>
+<P>The <CODE>MultipleOperationTimeout</CODE> directive sets the maximum amount of time between files in a multi-file print job in seconds (no suffix), minutes ("m" suffix), hours ("h" suffix), days ("d" suffix), or weeks ("w" suffix).</P>
+
+<P>The default is <CODE>5m</CODE> (five minutes).</P>
 
 
 <H2 CLASS="title"><A NAME="Order">Order</A></H2>
@@ -2026,20 +2047,24 @@ the IPv4 and IPv6 wildcard address.</P>
 <PRE CLASS="command">
 PreserveJobHistory On
 PreserveJobHistory Off
+PreserveJobHistory 1w
+PreserveJobHistory 7d
+PreserveJobHistory 168h
+PreserveJobHistory 10080m
+PreserveJobHistory 604800
 </PRE>
 
 <H3>Description</H3>
 
-<P>The <CODE>PreserveJobHistory</CODE> directive controls whether
-the history of completed, canceled, or aborted print jobs is
-stored on disk.</P>
+<P>The <CODE>PreserveJobHistory</CODE> directive controls whether the history of completed, canceled, or aborted print jobs is retained by the scheduler. A value of <CODE>On</CODE> preserves job information until the administrator purges it with the <CODE>cancel</CODE> command. A value of <CODE>Off</CODE> removes the job information as soon as each job is completed, canceled, or aborted. Numeric values preserve job information for the specified number of seconds (no suffix), minutes ("m" suffix), hours ("h" suffix), days ("d" suffix), or weeks ("w" suffix).</P>
 
-<P>A value of <CODE>On</CODE> (the default) preserves job
-information until the administrator purges it with the
-<CODE>cancel</CODE> command.</P>
+<P>The default value is <CODE>On</CODE>.</P>
 
-<P>A value of <CODE>Off</CODE> removes the job information as
-soon as each job is completed, canceled, or aborted.</P>
+<BLOCKQUOTE><B>Note:</B>
+
+<P>The <A HREF="#MaxJobs"><CODE>MaxJobs</CODE></A>, <A HREF="#MaxJobsPerPrinter"><CODE>MaxJobsPerPrinter</CODE></A>, and <A HREF="#MaxJobsPerUser"><CODE>MaxJobsPerUser</CODE></A> directives can cause job history to be discarded to make room for new jobs.</P>
+
+</BLOCKQUOTE>
 
 
 <H2 CLASS="title"><A NAME="PreserveJobFiles">PreserveJobFiles</A></H2>
@@ -2049,21 +2074,26 @@ soon as each job is completed, canceled, or aborted.</P>
 <PRE CLASS="command">
 PreserveJobFiles On
 PreserveJobFiles Off
+PreserveJobFiles 1w
+PreserveJobFiles 7d
+PreserveJobFiles 168h
+PreserveJobFiles 10080m
+PreserveJobFiles 604800
 </PRE>
 
 <H3>Description</H3>
 
-<P>The <CODE>PreserveJobFiles</CODE> directive controls whether
-the document files of completed, canceled, or aborted print jobs
-are stored on disk.</P>
+<P>The <CODE>PreserveJobFiles</CODE> directive controls whether the document files of completed, canceled, or aborted print jobs are retained. Jobs can be restarted (and reprinted) as desired until they are purged.</P>
+
+<P>A value of <CODE>On</CODE> preserves job files until the administrator purges them with the <CODE>cancel</CODE> command. A value of <CODE>Off</CODE> removes the job files as soon as each job is completed, canceled, or aborted. Numeric values preserve job files for the specified number of seconds (no suffix), minutes ("m" suffix), hours ("h" suffix), days ("d" suffix), or weeks ("w" suffix).</P>
 
-<P>A value of <CODE>On</CODE> preserves job files until the
-administrator purges them with the <CODE>cancel</CODE> command.
-Jobs can be restarted (and reprinted) as desired until they are
-purged.</P>
+<P>The default value is <CODE>1d</CODE> (one day).</P>
 
-<P>A value of <CODE>Off</CODE> (the default) removes the job
-files as soon as each job is completed, canceled, or aborted.</P>
+<BLOCKQUOTE><B>Note:</B>
+
+<P>The <A HREF="#MaxJobs"><CODE>MaxJobs</CODE></A>, <A HREF="#MaxJobsPerPrinter"><CODE>MaxJobsPerPrinter</CODE></A>, <A HREF="#MaxJobsPerUser"><CODE>MaxJobsPerUser</CODE></A>, and <A HREF="#PreserveJobHistory"><CODE>PreserveJobHistory</CODE></A> directives can cause job files to be discarded sooner than specified.</P>
+
+</BLOCKQUOTE>
 
 
 <H2 CLASS="title"><A NAME="Printcap">Printcap</A></H2>
@@ -2239,17 +2269,18 @@ megabytes.</P>
 
 <PRE CLASS="command">
 RootCertDuration 0
+RootCertDuration 1w
+RootCertDuration 1d
+RootCertDuration 1h
+RootCertDuration 5m
 RootCertDuration 300
 </PRE>
 
 <H3>Description</H3>
 
-<P>The <CODE>RootCertDuration</CODE> directive specifies the
-number of seconds the <EM>root certificate</EM> remains valid.
-The scheduler will generate a new certificate as needed when the
-number of seconds has expired. If set to 0, the root certificate
-is generated only once on startup or on a restart. The default is
-300 seconds.</P>
+<P>The <CODE>RootCertDuration</CODE> directive specifies the amount of time the <EM>root certificate</EM> remains valid in seconds (no suffix), minutes ("m" suffix), hours ("h" suffix), days ("d" suffix), or weeks ("w" suffix). The scheduler will generate a new certificate as needed when the given time interval has expired. If set to 0, the root certificate is generated only once on startup or on a restart.</P>
+
+<P>The default is <CODE>5m</CODE> (five minutes).</P>
 
 
 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.7</SPAN><A NAME="Satisfy">Satisfy</A></H2>
@@ -2649,15 +2680,19 @@ an appropriate temporary directory called
 <H3>Examples</H3>
 
 <PRE CLASS="command">
+Timeout 1w
+Timeout 1d
+Timeout 1h
+Timeout 5m
 Timeout 300
-Timeout 90
 </PRE>
 
 <H3>Description</H3>
 
 <P>The <CODE>Timeout</CODE> directive controls the amount of time
-to wait before an active HTTP or IPP request times out. The
-default timeout is 300 seconds.</P>
+to wait before an active HTTP or IPP request times out in seconds (no suffix), minutes ("m" suffix), hours ("h" suffix), days ("d" suffix), or weeks ("w" suffix).</P>
+
+<P>The default timeout is <CODE>5m</CODE> (five minutes).</P>
 
 
 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2/Mac OS X 10.5</SPAN><A NAME="UseNetworkDefault">UseNetworkDefault</A></H2>