Clarify policy documentation #3980

Closed
michaelrsweet opened this Issue Nov 16, 2011 · 3 comments

Comments

Projects
None yet
1 participant
Collaborator

michaelrsweet commented Nov 16, 2011

Version: 1.6-current
CUPS.org User: smayhew

The current policy documentation lists a table of operations, instructions for creating policies, and presents two ways of using policies. One might interpret this to mean that any operation can be controlled a printer operation policy, however some operations only check the default policy. The request is to add a column to the table indicating whether an operation can be controlled via a printer operation policy.

Collaborator

michaelrsweet commented Nov 17, 2011

CUPS.org User: mike

I think I'd rather just add a note () in the operation name column with a description at the bottom ( = only used when defined in the default policy)

Collaborator

michaelrsweet commented Feb 16, 2012

CUPS.org User: mike

Fixed in Subversion repository.

Collaborator

michaelrsweet commented Feb 16, 2012

"cups-clarify-policy-documentation.patch":

diff -up cups-1.6svn-r10108/doc/help/policies.html.orig cups-1.6svn-r10108/doc/help/policies.html
--- cups-1.6svn-r10108/doc/help/policies.html.orig 2011-11-16 13:25:16.362204341 -0500
+++ cups-1.6svn-r10108/doc/help/policies.html 2011-11-16 13:44:57.413546203 -0500
@@ -149,6 +149,7 @@ HREF="ref-cupsd-conf.html#LimitIPP">

Name Used by CUPS? - Applicable to Printer Op Policy? Description @@ -156,87 +157,104 @@ HREF="ref-cupsd-conf.html#LimitIPP"> Print-Job Yes - Yes Creates a print job with a single file. Print-URI No - No Create a print job with a single URI. Validate-Job Yes - Yes Validates a print request before printing. Create-Job Yes - Yes Creates a print job with no files or URIs. Send-Document Yes - Yes Adds a file to a print job. Send-URI No - No Adds a URI to a print job. Cancel-Job Yes - Yes Cancels a print job. Get-Job-Attributes Yes - Yes Gets information and options associated with a job. Get-Jobs Yes - Yes Gets a list of jobs. Get-Printer-Attributes Yes - Yes Gets information and options associated with a printer or class. Hold-Job Yes - Yes Holds a print job for printing. Release-Job Yes - Yes Releases a print job for printing. Restart-Job Yes - Yes Reprints a print job. Pause-Printer Yes - Yes Stops a printer or class. Resume-Printer Yes - Yes Starts a printer or class. Purge-Jobs Yes - Yes Cancels all jobs on the server or a printer or class and removes the job history information. Set-Printer-Attributes - No - Yes - Yes Sets printer or class information; CUPS uses CUPS-Add-Modify-Printer and CUPS-Add-Modify-Class instead. @@ -244,216 +262,258 @@ HREF="ref-cupsd-conf.html#LimitIPP"> Set-Job-Attributes Yes - Yes Changes job options. Get-Printer-Supported-Values No - No Gets -supported attributes for a printer based on job options. Create-Printer-Subscription Yes - Yes Creates an event subscription for a printer or the server. Create-Job-Subscription Yes - No Creates an event subscription for a job. Get-Subscription-Attributes Yes - Yes Gets information for an event subscription. Get-Subscriptions Yes - Yes Gets a list of event subscriptions. Renew-Subscription Yes - Yes Renews an event subscription that is about to expire. Cancel-Subscription Yes - Yes Cancels an event subscription. Get-Notifications Yes - Yes Gets (pending) events for an event subscription. Send-Notifications No - No Sends events for an event subscription. Get-Printer-Support-Files No - No Gets printer driver files for a Novell client. Enable-Printer Yes - Yes Starts a printer or class. Disable-Printer Yes - Yes Stops a printer or class. Pause-Printer-After-Current-Job No - No Stops a printer or class after the current job is finished. Hold-New-Jobs No - No Holds new jobs submitted to a printer or class. Release-Held-New-Jobs No - No Releases jobs that were held because of the Hold-New-Jobs operation. Deactivate-Printer No - No Deactivates a printer or class. Activate-Printer No - No Activates a printer or class. Restart-Printer No - No Restarts a printer or class, resuming print jobs as needed. Shutdown-Printer No - No Powers a printer or class off. Startup-Printer No - No Powers a printer or class on. Reprocess-Job No - No Reprints a job on a different printer or class; CUPS has the CUPS-Move-Job operation instead. Cancel-Current-Job No - No Cancels the current job on a printer or class. Suspend-Current-Job No - No Stops the current job on a printer or class. Resume-Job No - No Resumes printing of a stopped job. Promote-Job No - No Prints a job before others. Schedule-Job-After No - No Prints a job after others. CUPS-Get-Default Yes - No Gets the server/network default printer or class. CUPS-Get-Printers Yes - No Gets a list of printers and/or classes. CUPS-Add-Modify-Printer Yes - Yes Adds or modifies a printer. CUPS-Delete-Printer Yes - No Removes a printer. CUPS-Get-Classes Yes - No Gets a list of classes. CUPS-Add-Modify-Class Yes - Yes Adds or modifies a class. CUPS-Delete-Class Yes - No Removes a class. CUPS-Accept-Jobs Yes - Yes Sets a printer's or class' printer-is-accepting-jobs attribute to true. CUPS-Reject-Jobs Yes - Yes Sets a printer's or class' printer-is-accepting-jobs attribute to false. CUPS-Set-Default Yes - No Sets the server/network default printer or class. CUPS-Get-Devices Yes - No Gets a list of printer devices. CUPS-Get-PPDs Yes - No Gets a list of printer drivers or manufacturers. CUPS-Move-Job Yes - Yes Moves a job to a different printer or class. CUPS-Authenticate-Job Yes - Yes Authenticates a job for printing. CUPS-Get-Document Yes - No Retrieves a document file from a job. @@ -597,5 +657,7 @@ lpadmin -p LaserJet4000 -o printer-op-po

To make the same change in the web interface, go to the printer's web page, for example "http://localhost:631/printers/LaserJet4000", and choose Set Default Options from the Administration menu button. Click on the Policies link and choose the desired policy from the pull-down list. Click on Set Default Options to change the policy for the printer.

+

Note that CUPS only checks the default policy for certain IPP operations. Refer to Table 1 to determine whether a particular IPP operation can be controlled via a printer operation policy.
+

michaelrsweet added this to the Stable milestone Mar 17, 2016

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment