From: Michael Sweet Date: Thu, 7 Dec 2017 04:50:36 +0000 (-0500) Subject: Add information on printer options, sharing, and debug logging. X-Git-Tag: v2.3b1~34 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=f05177e23ddf3099f93b20005c960c3d82cf302c;p=thirdparty%2Fcups.git Add information on printer options, sharing, and debug logging. Add admin.html to installed help files. Fix CSS bug. --- diff --git a/doc/Makefile b/doc/Makefile index 6f8075db05..735dfdb26d 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -1,7 +1,7 @@ # # Documentation makefile for CUPS. # -# Copyright 2007-2016 by Apple Inc. +# Copyright 2007-2017 by Apple Inc. # Copyright 1997-2007 by Easy Software Products. # # Licensed under Apache License v2.0. See the file "LICENSE" for more information. @@ -40,6 +40,7 @@ HELPIMAGES = \ images/smiley.jpg HELPFILES = \ help/accounting.html \ + help/admin.html \ help/api-admin.html \ help/api-filter.html \ help/api-ppd.html \ diff --git a/doc/cups-printable.css b/doc/cups-printable.css index ec08fbc326..e9cf6286d8 100644 --- a/doc/cups-printable.css +++ b/doc/cups-printable.css @@ -61,12 +61,6 @@ P.formula { margin-left: 36pt; } -BLOCKQUOTE { - background: #eeeeee; - border: solid thin #999999; - padding: 10pt; -} - A IMG { border: none; } diff --git a/doc/cups.css b/doc/cups.css index 46fac54cc7..7c5c623cde 100644 --- a/doc/cups.css +++ b/doc/cups.css @@ -164,15 +164,6 @@ P.formula { margin-left: 36pt; } -BLOCKQUOTE { - background: #f0f0f0; - border: inset 1px #eeeeee; - padding: 10px; - /* These are not implemented by all browsers, but that's OK */ - border-radius: 5px; - -moz-border-radius: 5px; -} - A IMG { border: none; } diff --git a/doc/help/admin.html b/doc/help/admin.html index ffe9fdca3b..ca523ddd78 100644 --- a/doc/help/admin.html +++ b/doc/help/admin.html @@ -17,7 +17,7 @@

Classes are associated with one or more printers and are typically used to distribute print jobs amongst a group of printers or provide redundancy or high availability when printing. Print jobs sent to a class are forwarded to the next available printer in the class.

-

The lpadmin(8) program is used to add, modify, or delete destinations, while the lpinfo(8) command is used to list the available printer drivers and backends. The CUPS web interface ("http://localhost:631" or "https://servername:631") can also be used, and most operating systems provide their own GUI administration tools.

+

The lpadmin(8) program is used to add, modify, or delete destinations, while the lpinfo(8) command is used to list the available printer drivers and backends. The cupsctl(8) program is used to manage the printing system as a whole, including things like debug logging and printer sharing. The CUPS web interface ("http://localhost:631" or "https://servername:631") can also be used, and most operating systems provide their own GUI administration tools.

Managing Printers

@@ -49,7 +49,7 @@ -

The -x option deletes the named printer:

+

The -x option deletes the named printer:

lpadmin -x printername
@@ -125,6 +125,67 @@ direct usb://ZP/LazerJet%20MFP?serial=42 
lpadmin -p printername -v device-uri
+

Printer Options

+ +

The lpadmin command allows you to set various options for a printer:

+ +
+
-o cupsIPPSupplies=false
+
Turns off IPP supply level reporting for a printer.
+ +
-o cupsSNMPSupplies=false
+
Turns off SNMP supply level reporting for a printer.
+ +
-o name=value
+
Sets the default value for the named PPD option. For example, -o PageSize=Legal sets the default page size to US Legal.
+ +
-o printer-error-policy=name
+
Sets the error handling policy:
+
abort-job
+
Aborts the job on error.
+
retry-job
+
Retries the job at a future time.
+
retry-current-job
+
Retries the current job immediately.
+
stop-printer
+
Stops the printer on error.
+
+ +
-o printer-is-shared=true/false
+
Enables/disables per-printer sharing. See the section on Printer Sharing for more information.
+ +
-o printer-op-policy=name
+
Sets the operation policy associated with the printer. See the Managing Operation Policies help document for more information.
+ +
-u allow:{user|@group}{,user|,@group}*
+
-u allow:all
+
-u deny:{user|@group}{,user|,@group}*
+
-u deny:none
+
Sets user-level access control for the printer. The allow: list defines a whitelist of users and groups while the deny: list defines a blacklist of users and groups.
+
+ + +

Printer Sharing

+ +

CUPS supports sharing of printers with other computers and mobile devices. Two cupsctl options control the general printer sharing features:

+ +
+
--share-printers
+
Enables sharing of printers with other computers and mobile devices on your local network.
+ +
--remote-any
+
Expands printer sharing to any network that can reach your server.
+
+ +

Once you have enabled printer sharing, you then must select which printers will be shared using the lpadmin command and the -o printer-is-shared=true option.

+ +

For example, to share two printers ("foo" and "bar") on the local network, run the following commands:

+ + 
cupsctl --share-printers
+lpadmin -p foo -o printer-is-shared=true
+lpadmin -p bar -o printer-is-shared=true
+ +

Managing Classes

The lpadmin command is used to create, modify, or delete a class. The -c option specifies a class to create or modify and is combined with the -p option:

@@ -135,9 +196,19 @@ direct usb://ZP/LazerJet%20MFP?serial=42 
lpadmin -p printername -r classname
-

The -x option deletes the named class:

+

The -x option deletes the named class:

lpadmin -x classname
+ +

Debug Logging and Troubleshooting

+ +

The printing system log files track the activity of the scheduler, printer drivers, and backends. If problems occur and the log files do not provide sufficient details to diagnose the problem, you can enable debug logging using the cupsctl command:

+ + 
cupsctl --debug-logging
+ +

To disable debug logging, run the same command with the --no-debug-logging option:

+ + 
cupsctl --no-debug-logging