From: Michael R Sweet Date: Tue, 27 Apr 2021 19:55:36 +0000 (-0400) Subject: Add missing MaxSubscriptionsXxx docos (Issue #177) X-Git-Tag: v2.4b1~134 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=10e4edb359ecc20782c99fe6d0a4b5dbbc88ac09;p=thirdparty%2Fcups.git Add missing MaxSubscriptionsXxx docos (Issue #177) --- diff --git a/CHANGES.md b/CHANGES.md index c3d66edfee..267597d0eb 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -38,7 +38,7 @@ CUPS v2.4rc1 (Pending) - Now use a 60 second timeout for reading USB backchannel data (Issue #160) - The USB backend now tries harder to find a serial number (Issue #170) - Fixed `@IF(name)` handling in `cupsd.conf` (Apple #5918) -- Documentation fixes (Issue #92, Issue #163) +- Documentation fixes (Issue #92, Issue #163, Issue #177) - Localization updates (Issue #123, Issue #129, Issue #134, Issue #146, Issue #164) - USB quirk updates (Apple #5766, Apple #5838, Apple #5843, Apple #5867) diff --git a/doc/help/man-cupsd.conf.html b/doc/help/man-cupsd.conf.html index fc095a696f..5f672d652f 100644 --- a/doc/help/man-cupsd.conf.html +++ b/doc/help/man-cupsd.conf.html @@ -30,11 +30,11 @@ The following top-level directives are understood by
AccessLogLevel all
Specifies the logging level for the AccessLog file. The "config" level logs when printers and classes are added, deleted, or modified and when configuration files are accessed or updated. -The "actions" level logs when print jobs are submitted, held, released, modified, or canceled, and any of the conditions for "config". +The "actions" level logs when print subscriptions 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 Yes -
AutoPurgeJobs No +
AutoPurgeSubscriptions Yes +
AutoPurgeSubscriptions No

Specifies whether to purge job history data automatically when it is no longer required for quotas. The default is "No". @@ -131,11 +131,11 @@ is run on-demand (e.g., with -l).
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 seconds -
Specifies the interval between retries of jobs in seconds. +
Specifies the interval between retries of subscriptions 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 count -
Specifies the number of retries that are done for jobs. +
Specifies the number of retries that are done for subscriptions. 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 Yes @@ -197,25 +197,38 @@ The default is the MaxClients value. The default is "9999".
MaxHoldTime seconds
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 number -
Specifies the maximum number of simultaneous jobs that are allowed. -Set to "0" to allow an unlimited number of jobs. +The default is "0" which disables cancellation of held subscriptions. +
MaxSubscriptions number +
Specifies the maximum number of simultaneous subscriptions that are allowed. +Set to "0" to allow an unlimited number of subscriptions. The default is "500". -
MaxJobsPerPrinter number -
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 number -
Specifies the maximum number of simultaneous jobs that are allowed per user. -The default is "0" which allows up to MaxJobs jobs per user. +
MaxSubscriptionsPerPrinter number +
Specifies the maximum number of simultaneous subscriptions that are allowed per printer. +The default is "0" which allows up to MaxSubscriptions subscriptions per printer. +
MaxSubscriptionsPerUser number +
Specifies the maximum number of simultaneous subscriptions that are allowed per user. +The default is "0" which allows up to MaxSubscriptions subscriptions per user.
MaxJobTime seconds
Specifies the maximum time a job may take to print before it is canceled. -Set to "0" to disable cancellation of "stuck" jobs. +Set to "0" to disable cancellation of "stuck" subscriptions. The default is "10800" (3 hours).
MaxLogSize size
Specifies the maximum size of the log files before they are rotated. The value "0" disables log rotation. The default is "1048576" (1MB). +
MaxSubscriptions number +
Specifies the maximum number of simultaneous event subscriptions that are allowed. +Set to "0" to allow an unlimited number of subscriptions. +The default is "100". +
MaxSubscriptionsPerJob number +
Specifies the maximum number of simultaneous event subscriptions that are allowed per job. +The default is "0" which allows up to MaxSubscriptions subscriptions per job. +
MaxSubscriptionsPerPrinter number +
Specifies the maximum number of simultaneous event subscriptions that are allowed per printer. +The default is "0" which allows up to MaxSubscriptions subscriptions per printer. +
MaxSubscriptionsPerUser number +
Specifies the maximum number of simultaneous event subscriptions that are allowed per user. +The default is "0" which allows up to MaxSubscriptions subscriptions per user.
MultipleOperationTimeout seconds
Specifies the maximum amount of time to allow between files in a multiple file print job. The default is "900" (15 minutes). @@ -234,7 +247,7 @@ The default is "86400" (preserve 1 day).
PreserveJobHistory seconds
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. +If "Yes", the job history is preserved until the MaxSubscriptions limit is reached. The default is "Yes".
ReadyPaperSizes sizename[,...]
Specifies a list of potential paper sizes that are reported as "ready" (loaded). @@ -324,8 +337,8 @@ The following HTTP methods are supported by The following IPP operations are supported by cupsd(8):
-
CUPS-Accept-Jobs -
Allows a printer to accept new jobs. +
CUPS-Accept-Subscriptions +
Allows a printer to accept new subscriptions.
CUPS-Add-Modify-Class
Adds or modifies a printer class.
CUPS-Add-Modify-Printer @@ -352,16 +365,16 @@ The following IPP operations are supported by
Gets a list of printers.
CUPS-Move-Job
Moves a job. -
CUPS-Reject-Jobs -
Prevents a printer from accepting new jobs. +
CUPS-Reject-Subscriptions +
Prevents a printer from accepting new subscriptions.
CUPS-Set-Default
Sets the server default printer or printer class.
Cancel-Job
Cancels a job. -
Cancel-Jobs -
Cancels one or more jobs. -
Cancel-My-Jobs -
Cancels one or more jobs creates by a user. +
Cancel-Subscriptions +
Cancels one or more subscriptions. +
Cancel-My-Subscriptions +
Cancels one or more subscriptions creates by a user.
Cancel-Subscription
Cancels a subscription.
Close-Job @@ -374,8 +387,8 @@ The following IPP operations are supported by
Creates a subscription for printer events.
Get-Job-Attributes
Gets information about a job. -
Get-Jobs -
Gets a list of jobs. +
Get-Subscriptions +
Gets a list of subscriptions.
Get-Notifications
Gets a list of event notifications for a subscription.
Get-Printer-Attributes @@ -386,18 +399,18 @@ The following IPP operations are supported by
Gets a list of subscriptions.
Hold-Job
Holds a job from printing. -
Hold-New-Jobs -
Holds all new jobs from printing. +
Hold-New-Subscriptions +
Holds all new subscriptions from printing.
Pause-Printer -
Stops processing of jobs by a printer or printer class. +
Stops processing of subscriptions by a printer or printer class.
Pause-Printer-After-Current-Job -
Stops processing of jobs by a printer or printer class after the current job is finished. +
Stops processing of subscriptions by a printer or printer class after the current job is finished.
Print-Job
Creates a new job with a single document. -
Purge-Jobs -
Cancels one or more jobs and deletes the job history. -
Release-Held-New-Jobs -
Allows previously held jobs to print. +
Purge-Subscriptions +
Cancels one or more subscriptions and deletes the job history. +
Release-Held-New-Subscriptions +
Allows previously held subscriptions to print.
Release-Job
Allows a job to print.
Renew-Subscription @@ -418,7 +431,7 @@ The following paths are commonly used when configuring cupsd(8):
/ -
The path for all get operations (get-printers, get-jobs, etc.) +
The path for all get operations (get-printers, get-subscriptions, etc.)
/admin
The path for all administration operations (add-printer, delete-printer, start-printer, etc.)
/admin/conf @@ -429,9 +442,9 @@ The following paths are commonly used when configuring
The path for all printer classes
/classes/name
The resource for the named printer class -
/jobs -
The path for all jobs (hold-job, release-job, etc.) -
/jobs/id +
/subscriptions +
The path for all subscriptions (hold-job, release-job, etc.) +
/subscriptions/id
The path for the specified job
/printers
The path for all printers @@ -555,7 +568,7 @@ The default is no classification banner.
ClassifyOverride Yes
ClassifyOverride No

-Specifies whether users may override the classification (cover page) of individual print jobs using the "job-sheets" option. +Specifies whether users may override the classification (cover page) of individual print subscriptions using the "job-sheets" option. The default is "No".
DefaultAuthType Negotiate
Specifies that Kerberos authentication is required by default. diff --git a/man/cupsd.conf.5 b/man/cupsd.conf.5 index 972826ec61..791ef8b107 100644 --- a/man/cupsd.conf.5 +++ b/man/cupsd.conf.5 @@ -8,7 +8,7 @@ .\" Licensed under Apache License v2.0. See the file "LICENSE" for more .\" information. .\" -.TH cupsd.conf 5 "CUPS" "2021-03-11" "OpenPrinting" +.TH cupsd.conf 5 "CUPS" "2021-04-27" "OpenPrinting" .SH NAME cupsd.conf \- server configuration file for cups .SH DESCRIPTION @@ -35,14 +35,14 @@ The following top-level directives are understood by \fBAccessLogLevel all\fR Specifies the logging level for the AccessLog file. The "config" level logs when printers and classes are added, deleted, or modified and when configuration files are accessed or updated. -The "actions" level logs when print jobs are submitted, held, released, modified, or canceled, and any of the conditions for "config". +The "actions" level logs when print subscriptions 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 +.\"#AutoPurgeSubscriptions .TP 5 -\fBAutoPurgeJobs Yes\fR +\fBAutoPurgeSubscriptions Yes\fR .TP 5 -\fBAutoPurgeJobs No\fR +\fBAutoPurgeSubscriptions No\fR .br Specifies whether to purge job history data automatically when it is no longer required for quotas. The default is "No". @@ -191,13 +191,13 @@ The default is "30". .\"#JobRetryInterval .TP 5 \fBJobRetryInterval \fIseconds\fR -Specifies the interval between retries of jobs in seconds. +Specifies the interval between retries of subscriptions 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. +Specifies the number of retries that are done for subscriptions. 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 @@ -303,28 +303,28 @@ The default is "9999". .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 +The default is "0" which disables cancellation of held subscriptions. +.\"#MaxSubscriptions .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. +\fBMaxSubscriptions \fInumber\fR +Specifies the maximum number of simultaneous subscriptions that are allowed. +Set to "0" to allow an unlimited number of subscriptions. The default is "500". -.\"#MaxJobsPerPrinter +.\"#MaxSubscriptionsPerPrinter .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 +\fBMaxSubscriptionsPerPrinter \fInumber\fR +Specifies the maximum number of simultaneous subscriptions that are allowed per printer. +The default is "0" which allows up to MaxSubscriptions subscriptions per printer. +.\"#MaxSubscriptionsPerUser .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. +\fBMaxSubscriptionsPerUser \fInumber\fR +Specifies the maximum number of simultaneous subscriptions that are allowed per user. +The default is "0" which allows up to MaxSubscriptions subscriptions 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. +Set to "0" to disable cancellation of "stuck" subscriptions. The default is "10800" (3 hours). .\"#MaxLogSize .TP 5 @@ -332,6 +332,27 @@ The default is "10800" (3 hours). Specifies the maximum size of the log files before they are rotated. The value "0" disables log rotation. The default is "1048576" (1MB). +.\"#MaxSubscriptions +.TP 5 +\fBMaxSubscriptions \fInumber\fR +Specifies the maximum number of simultaneous event subscriptions that are allowed. +Set to "0" to allow an unlimited number of subscriptions. +The default is "100". +.\"#MaxSubscriptionsPerJob +.TP 5 +\fBMaxSubscriptionsPerJob \fInumber\fR +Specifies the maximum number of simultaneous event subscriptions that are allowed per job. +The default is "0" which allows up to MaxSubscriptions subscriptions per job. +.\"#MaxSubscriptionsPerPrinter +.TP 5 +\fBMaxSubscriptionsPerPrinter \fInumber\fR +Specifies the maximum number of simultaneous event subscriptions that are allowed per printer. +The default is "0" which allows up to MaxSubscriptions subscriptions per printer. +.\"#MaxSubscriptionsPerUser +.TP 5 +\fBMaxSubscriptionsPerUser \fInumber\fR +Specifies the maximum number of simultaneous event subscriptions that are allowed per user. +The default is "0" which allows up to MaxSubscriptions subscriptions per user. .\"#MultipleOperationTimeout .TP 5 \fBMultipleOperationTimeout \fIseconds\fR @@ -364,7 +385,7 @@ The default is "86400" (preserve 1 day). \fBPreserveJobHistory \fIseconds\fR Specifies whether the job history is preserved after a job is printed. If a numeric value is specified, the job history is preserved for the indicated number of seconds after printing. -If "Yes", the job history is preserved until the MaxJobs limit is reached. +If "Yes", the job history is preserved until the MaxSubscriptions limit is reached. The default is "Yes". .\"#ReadyPaperSizes .TP 5 @@ -493,8 +514,8 @@ Used by a client to upload configuration files. The following IPP operations are supported by .BR cupsd (8): .TP 5 -CUPS\-Accept\-Jobs -Allows a printer to accept new jobs. +CUPS\-Accept\-Subscriptions +Allows a printer to accept new subscriptions. .TP 5 CUPS\-Add\-Modify\-Class Adds or modifies a printer class. @@ -535,8 +556,8 @@ Gets a list of printers. CUPS\-Move\-Job Moves a job. .TP 5 -CUPS\-Reject\-Jobs -Prevents a printer from accepting new jobs. +CUPS\-Reject\-Subscriptions +Prevents a printer from accepting new subscriptions. .TP 5 CUPS\-Set\-Default Sets the server default printer or printer class. @@ -544,11 +565,11 @@ Sets the server default printer or printer class. Cancel\-Job Cancels a job. .TP 5 -Cancel\-Jobs -Cancels one or more jobs. +Cancel\-Subscriptions +Cancels one or more subscriptions. .TP 5 -Cancel\-My\-Jobs -Cancels one or more jobs creates by a user. +Cancel\-My\-Subscriptions +Cancels one or more subscriptions creates by a user. .TP 5 Cancel\-Subscription Cancels a subscription. @@ -568,8 +589,8 @@ Creates a subscription for printer events. Get\-Job\-Attributes Gets information about a job. .TP 5 -Get\-Jobs -Gets a list of jobs. +Get\-Subscriptions +Gets a list of subscriptions. .TP 5 Get\-Notifications Gets a list of event notifications for a subscription. @@ -586,23 +607,23 @@ Gets a list of subscriptions. Hold\-Job Holds a job from printing. .TP 5 -Hold\-New\-Jobs -Holds all new jobs from printing. +Hold\-New\-Subscriptions +Holds all new subscriptions from printing. .TP 5 Pause\-Printer -Stops processing of jobs by a printer or printer class. +Stops processing of subscriptions by a printer or printer class. .TP 5 Pause\-Printer\-After\-Current\-Job -Stops processing of jobs by a printer or printer class after the current job is finished. +Stops processing of subscriptions by a printer or printer class after the current job is finished. .TP 5 Print\-Job Creates a new job with a single document. .TP 5 -Purge\-Jobs -Cancels one or more jobs and deletes the job history. +Purge\-Subscriptions +Cancels one or more subscriptions and deletes the job history. .TP 5 -Release\-Held\-New\-Jobs -Allows previously held jobs to print. +Release\-Held\-New\-Subscriptions +Allows previously held subscriptions to print. .TP 5 Release\-Job Allows a job to print. @@ -629,7 +650,7 @@ The following paths are commonly used when configuring .BR cupsd (8): .TP 5 / -The path for all get operations (get-printers, get-jobs, etc.) +The path for all get operations (get-printers, get-subscriptions, etc.) .TP 5 /admin The path for all administration operations (add-printer, delete-printer, start-printer, etc.) @@ -646,10 +667,10 @@ The path for all printer classes /classes/name The resource for the named printer class .TP 5 -/jobs -The path for all jobs (hold-job, release-job, etc.) +/subscriptions +The path for all subscriptions (hold-job, release-job, etc.) .TP 5 -/jobs/id +/subscriptions/id The path for the specified job .TP 5 /printers @@ -826,7 +847,7 @@ The default is no classification banner. .TP 5 \fBClassifyOverride No\fR .br -Specifies whether users may override the classification (cover page) of individual print jobs using the "job-sheets" option. +Specifies whether users may override the classification (cover page) of individual print subscriptions using the "job-sheets" option. The default is "No". .TP 5 \fBDefaultAuthType Negotiate\fR