From 51c22b864a743207ee25c82aaf24ac1cccd5fb2b Mon Sep 17 00:00:00 2001 From: Michael R Sweet Date: Thu, 6 Dec 2018 14:41:43 -0500 Subject: [PATCH] Update HTML man pages. --- doc/help/man-cups-files.conf.html | 7 ++++++ doc/help/man-cups-snmp.conf.html | 1 + doc/help/man-cups-snmp.html | 5 ++++- doc/help/man-cupsd.conf.html | 15 +++++++++---- doc/help/man-lp.html | 37 +++++-------------------------- doc/help/man-lpadmin.html | 11 +++++---- doc/help/man-lpr.html | 33 ++++----------------------- 7 files changed, 40 insertions(+), 69 deletions(-) diff --git a/doc/help/man-cups-files.conf.html b/doc/help/man-cups-files.conf.html index 6144a165c..bc2900777 100644 --- a/doc/help/man-cups-files.conf.html +++ b/doc/help/man-cups-files.conf.html @@ -191,6 +191,13 @@ On macOS the Font Book application manages system-installed fonts.
SMBConfigFile filename
Specifies the SMB service configuration file to update. +

Notes

+The scheduler MUST be restarted manually after making changes to the cups-files.conf file. +On Linux this is typically done using the +systemctl(8) +command, while on macOS the +launchctl(8) +command is used instead.

See Also

classes.conf(5), cups(1), diff --git a/doc/help/man-cups-snmp.conf.html b/doc/help/man-cups-snmp.conf.html index 7ff33532f..72f1067c7 100644 --- a/doc/help/man-cups-snmp.conf.html +++ b/doc/help/man-cups-snmp.conf.html @@ -28,6 +28,7 @@ There is no default for the broadcast address.
Specifies the community name to use. Only a single community name may be specified. The default community name is "public". +If no name is specified, all SNMP functions are disabled.
DebugLevel number
Specifies the logging level from 0 (none) to 3 (everything). Typically only used for debugging (thus the name). diff --git a/doc/help/man-cups-snmp.html b/doc/help/man-cups-snmp.html index debbaf92c..fdb4721f8 100644 --- a/doc/help/man-cups-snmp.html +++ b/doc/help/man-cups-snmp.html @@ -21,7 +21,7 @@ snmp - cups snmp backend --include-schemes snmp

Description

-The CUPS SNMP backend provides legacy discovery and identification of network printers using SNMPv1. +The DEPRECATED CUPS SNMP backend provides legacy discovery and identification of network printers using SNMPv1. When used for discovery through the scheduler, the backend will list all printers that respond to a broadcast SNMPv1 query with the "public" community name. Additional queries are then sent to printers that respond in order to determine the correct device URI, make and model, and other information needed for printing.

In the first form, the SNMP backend is run directly by the user to look up the device URI and other information when you have an IP address or hostname. @@ -39,6 +39,9 @@ The MaxRunTime value can be overridden using the CUPS_MAX_RUN_TIME environment v The SNMP backend reads the /etc/cups/snmp.conf configuration file, if present, to set the default broadcast address, community name, and logging level. +

Notes

+The CUPS SNMP backend is deprecated and will no longer be supported in a future +version of CUPS.

Conforming To

The CUPS SNMP backend uses the information from the Host, Printer, and Port Monitor MIBs along with some vendor private MIBs and intelligent port probes to determine the correct device URI and make and model for each printer.

See Also

diff --git a/doc/help/man-cupsd.conf.html b/doc/help/man-cupsd.conf.html index 62700a5b8..b1b0ac0b5 100644 --- a/doc/help/man-cupsd.conf.html +++ b/doc/help/man-cupsd.conf.html @@ -17,10 +17,7 @@ file configures the CUPS scheduler, It is normally located in the /etc/cups directory. -Note: File, directory, and user configuration directives that used to be allowed in the cupsd.conf file are now stored in the -cups-files.conf(5) -file instead in order to prevent certain types of privilege escalation attacks. -

Each line in the file can be a configuration directive, a blank line, or a comment. +Each line in the file can be a configuration directive, a blank line, or a comment. Configuration directives typically consist of a name and zero or more values separated by whitespace. The configuration directive name and values are case-insensitive. Comment lines start with the # character. @@ -580,6 +577,16 @@ Use "%{job-impressions-completed}" to insert the number of pages (sides) that we

Specifies the maximum amount of memory to use when converting documents into bitmaps for a printer. The default is "128m". +

Notes

+File, directory, and user configuration directives that used to be allowed in the cupsd.conf file are now stored in the +cups-files.conf(5) +file instead in order to prevent certain types of privilege escalation attacks. +

The scheduler MUST be restarted manually after making changes to the cupsd.conf file. +On Linux this is typically done using the +systemctl(8) +command, while on macOS the +launchctl(8) +command is used instead.

Conforming To

The cupsd.conf file format is based on the Apache HTTP Server configuration file format.

Examples

diff --git a/doc/help/man-lp.html b/doc/help/man-lp.html index 3c5bb5dd1..b79136137 100644 --- a/doc/help/man-lp.html +++ b/doc/help/man-lp.html @@ -141,48 +141,23 @@ Aside from the printer-specific options reported by the lpoptions(1) command, the following generic options are available:
-
-o collate=true -
Prints collated copies. -
-o fit-to-page -
Scales the print file to fit on the page. -
-o job-hold-until=when -
Holds the job until the specified local time. -"when" can be "indefinite" to hold the until released, "day-time" to print the job between 6am and 6pm local time, "night" to print the job between 6pm and 6am local time, "second-shift" to print the job between 4pm and 12am local time, "third-shift" to print the job between 12am and 8am local time, or "weekend" to print the job on Saturday or Sunday. -
-o job-hold-until=hh:mm -
Holds the job until the specified time in hours and minutes UTC. -
-o job-priority=priority -
Set the priority to a value from 1 (lowest) to 100 (highest), which influences when a job is scheduled for printing. -The default priority is typically 50.
-o job-sheets=name
Prints a cover page (banner) with the document. The "name" can be "classified", "confidential", "secret", "standard", "topsecret", or "unclassified". -
-o job-sheets=start-name,end-name -
Prints cover pages (banners) with the document.
-o media=size
Sets the page size to size. Most printers support at least the size names "a4", "letter", and "legal". -
-o mirror -
Mirrors each page.
-o number-up={2|4|6|9|16}
Prints 2, 4, 6, 9, or 16 document (input) pages on each output page. -
-o number-up-layout=layout -
Specifies the layout of pages with the "number-up" option. -The "layout" string can be "btlr", "btrl", "lrbt", "lrtb", "rlbt", "rltb", "tblr", or "tbrl" - the first two letters determine the column order while the second two letters determine the row order. -"bt" is bottom-to-top, "lr" is left-to-right, "rl" is right-to-left, and "tb" is top-to-bottom.
-o orientation-requested=4
Prints the job in landscape (rotated 90 degrees counter-clockwise).
-o orientation-requested=5
Prints the job in landscape (rotated 90 degrees clockwise).
-o orientation-requested=6
Prints the job in reverse portrait (rotated 180 degrees). -
-o outputorder=reverse -
Prints pages in reverse order. -
-o page-border=border -
Prints a border around each document page. -"border" is "double", "double-thick", "single", or "single-thick". -
-o page-ranges=page-list -
Specifies which pages to print in the document. -The list can contain a list of numbers and ranges (#-#) separated by commas, e.g., "1,3-5,16". -The page numbers refer to the output pages and not the document's original pages - options like "number-up" can affect the numbering of the pages. +
-o print-quality=3 +
-o print-quality=4 +
-o print-quality=5 +
Specifies the output quality - draft (3), normal (4), or best (5).
-o sides=one-sided
Prints on one side of the paper.
-o sides=two-sided-long-edge @@ -207,10 +182,10 @@ Print a double-sided legal document to a printer called "foo": lp -d foo -o media=legal -o sides=two-sided-long-edge filename -Print a presentation document 2-up to a printer called "foo": +Print a presentation document 2-up to a printer called "bar": 
 
-    lp -d foo -o number-up=2 filename
+    lp -d bar -o number-up=2 filename

See Also

cancel(1), diff --git a/doc/help/man-lpadmin.html b/doc/help/man-lpadmin.html index 42c0f7ebc..c7658f21b 100644 --- a/doc/help/man-lpadmin.html +++ b/doc/help/man-lpadmin.html @@ -109,8 +109,8 @@ Any print-time option can be defaulted, e.g., "-o number-up-default=2" to set th The default program is "none". The specified port monitor must be listed in the printer's PPD file.
-o printer-error-policy=name -
Sets the error policy to be used when the printer backend is unable to send the job to the printer. -The name must be one of "abort-job", "retry-job", "retry-current-job", or "stop-printer". +
Sets the policy for errors such as printers that cannot be found or accessed, don't support the format being printed, fail during submission of the print data, or cause one or more filters to crash. +The name must be one of "abort-job" (abort the job on error), "retry-job" (retry the job at a future time), "retry-current-job" (retry the current job immediately), or "stop-printer" (stop the printer on error). The default error policy is "stop-printer" for printers and "retry-current-job" for classes.
-o printer-is-shared=true @@ -166,12 +166,15 @@ Note: PPD files and printer drivers are deprecated and will not be supported in

Conforming To

Unlike the System V printing system, CUPS allows printer names to contain any printable character except SPACE, TAB, "/", or "#". Also, printer and class names are not case-sensitive. -Finally, the CUPS version of lpadmin may ask the user for an access password depending on the printing system configuration. +

Finally, the CUPS version of lpadmin may ask the user for an access password depending on the printing system configuration. This differs from the System V version which requires the root user to execute this command.

Notes

The CUPS version of lpadmin does not support all of the System V or Solaris printing system configuration options. -Interface scripts are not supported for security reasons. +

Interface scripts are not supported for security reasons.

The double meaning of the -E option is an unfortunate historical oddity. +

The lpadmin command communicates with the scheduler (cupsd) to make changes to the printing system configuration. +This configuration information is stored in several files including printers.conf and classes.conf. +These files should not be edited directly and are an implementation detail of CUPS that is subject to change at any time.

Example

Create an IPP Everywhere print queue: 
diff --git a/doc/help/man-lpr.html b/doc/help/man-lpr.html
index 986ef33e9..9d1541465 100644
--- a/doc/help/man-lpr.html
+++ b/doc/help/man-lpr.html
@@ -100,48 +100,23 @@ Aside from the printer-specific options reported by the
 lpoptions(1)
 command, the following generic options are available:
 

-
-o collate=true
-
Prints collated copies.
-
-o fit-to-page
-
Scales the print file to fit on the page.
-
-o job-hold-until=when
-
Holds the job until the specified local time.
-"when" can be "indefinite" to hold the until released, "day-time" to print the job between 6am and 6pm local time, "night" to print the job between 6pm and 6am local time, "second-shift" to print the job between 4pm and 12am local time, "third-shift" to print the job between 12am and 8am local time, or "weekend" to print the job on Saturday or Sunday.
-
-o job-hold-until=hh:mm
-
Holds the job until the specified time in hours and minutes UTC.
-
-o job-priority=priority
-
Set the priority to a value from 1 (lowest) to 100 (highest), which influences when a job is scheduled for printing.
-The default priority is typically 50.
 
-o job-sheets=name
 
Prints a cover page (banner) with the document.
 The "name" can be "classified", "confidential", "secret", "standard", "topsecret", or "unclassified".
-
-o job-sheets=start-name,end-name
-
Prints cover pages (banners) with the document.
 
-o media=size
 
Sets the page size to size. Most printers support at least the size names "a4", "letter", and "legal".
-
-o mirror
-
Mirrors each page.
 
-o number-up={2|4|6|9|16}
 
Prints 2, 4, 6, 9, or 16 document (input) pages on each output page.
-
-o number-up-layout=layout
-
Specifies the layout of pages with the "number-up" option.
-The "layout" string can be "btlr", "btrl", "lrbt", "lrtb", "rlbt", "rltb", "tblr", or "tbrl" - the first two letters determine the column order while the second two letters determine the row order.
-"bt" is bottom-to-top, "lr" is left-to-right, "rl" is right-to-left, and "tb" is top-to-bottom.
 
-o orientation-requested=4
 
Prints the job in landscape (rotated 90 degrees counter-clockwise).
 
-o orientation-requested=5
 
Prints the job in landscape (rotated 90 degrees clockwise).
 
-o orientation-requested=6
 
Prints the job in reverse portrait (rotated 180 degrees).
-
-o outputorder=reverse
-
Prints pages in reverse order.
-
-o page-border=border
-
Prints a border around each document page.
-"border" is "double", "double-thick", "single", or "single-thick".
-
-o page-ranges=page-list
-
Specifies which pages to print in the document.
-The list can contain a list of numbers and ranges (#-#) separated by commas, e.g., "1,3-5,16".
-The page numbers refer to the output pages and not the document's original pages - options like "number-up" can affect the numbering of the pages.
+
-o print-quality=3
+
-o print-quality=4
+
-o print-quality=5
+
Specifies the output quality - draft (3), normal (4), or best (5).
 
-o sides=one-sided
 
Prints on one side of the paper.
 
-o sides=two-sided-long-edge
-- 
2.39.2