From dda99de928a1e079f90351d0334c04b94cfccecf Mon Sep 17 00:00:00 2001 From: Michael R Sweet Date: Thu, 14 Dec 2017 17:22:14 -0500 Subject: [PATCH] Fix man page typos. --- doc/help/man-client.conf.html | 11 ++++++++--- doc/help/man-cups-files.conf.html | 11 +++++++---- doc/help/man-cupsd-logs.html | 18 ++++-------------- doc/help/man-cupsd.conf.html | 21 +++++++++++++++++---- doc/help/man-ipptool.html | 7 +++++++ doc/help/man-lpadmin.html | 11 +++++++++-- man/client.conf.man.in | 4 ++-- man/cupsd.conf.man.in | 4 ++-- man/ipptool.man | 5 +++-- 9 files changed, 59 insertions(+), 33 deletions(-) diff --git a/doc/help/man-client.conf.html b/doc/help/man-client.conf.html index b9791376f..85d9d8d4f 100644 --- a/doc/help/man-client.conf.html +++ b/doc/help/man-client.conf.html @@ -40,15 +40,20 @@ CUPS adds the remote hostname ("name@server.example.com") for you. The default n Note: This directive is not supported on macOS 10.7 or later.
ServerName hostname-or-ip-address[:port]/version=1.1
Specifies the address and optionally the port to use when connecting to a server running CUPS 1.3.12 and earlier. -
SSLOptions [AllowDH] [AllowRC4] [AllowSSL3] [DenyCBC] [DenyTLS1.0] +
SSLOptions [AllowDH] [AllowRC4] [AllowSSL3] [DenyCBC] [DenyTLS1.0] [MaxTLS1.0] [MaxTLS1.1] [MaxTLS1.2] [MaxTLS1.3] [MinTLS1.0] [MinTLS1.1] [MinTLS1.2] [MinTLS1.3]
SSLOptions None
Sets encryption options (only in /etc/cups/client.conf). By default, CUPS only supports encryption using TLS v1.0 or higher using known secure cipher suites. -The AllowDH option enables cipher suites using plain Diffie-Hellman key negotiation. -The AllowRC4 option enables the 128-bit RC4 cipher suites, which are required for some older clients that do not implement newer ones. +Security is reduced when Allow options are used. +Security is enhanced when Deny options are used. +The AllowDH option enables cipher suites using plain Diffie-Hellman key negotiation (not supported on systems using GNU TLS). +The AllowRC4 option enables the 128-bit RC4 cipher suites, which are required for some older clients. The AllowSSL3 option enables SSL v3.0, which is required for some older clients that do not support TLS v1.0. The DenyCBC option disables all CBC cipher suites. The DenyTLS1.0 option disables TLS v1.0 support - this sets the minimum protocol version to TLS v1.1. +The MinTLS options set the minimum TLS version to support. +The MaxTLS options set the maximum TLS version to support. +Not all operating systems support TLS 1.3 at this time.
TrustOnFirstUse Yes
TrustOnFirstUse No
Specifies whether to trust new TLS certificates by default. diff --git a/doc/help/man-cups-files.conf.html b/doc/help/man-cups-files.conf.html index 42dae48b3..6dd442ef4 100644 --- a/doc/help/man-cups-files.conf.html +++ b/doc/help/man-cups-files.conf.html @@ -95,10 +95,6 @@ The kind strings are:
permissions
Bad startup file permissions are fatal, for example shared TLS certificate and key files with world-read permissions. -
FileDevice Yes -
FileDevice No -
Specifies whether the file pseudo-device can be used for new printer queues. -The URI "file:///dev/null" is always allowed.
Group group-name-or-number
Specifies the group name or ID that will be used when executing external programs. The default group is operating system specific but is usually "lp" or "nobody". @@ -162,6 +158,13 @@ The default is "lp".

Deprecated Directives

The following directives are deprecated and will be removed from a future version of CUPS:
+
FileDevice Yes +
FileDevice No +
Specifies whether the file pseudo-device can be used for new printer queues. +The URI "file:///dev/null" is always allowed. +File devices cannot be used with "raw" print queues - a PPD file is required. +The specified file is overwritten for every print job. +Writing to directories is not supported.
FontPath directory[:...:directoryN]
Specifies a colon separated list of directories where fonts can be found. On Linux the diff --git a/doc/help/man-cupsd-logs.html b/doc/help/man-cupsd-logs.html index 30ee2af66..e2bf38802 100644 --- a/doc/help/man-cupsd-logs.html +++ b/doc/help/man-cupsd-logs.html @@ -142,25 +142,17 @@ The level field contains the type of message:

The message field contains a free-form textual message. Messages from job filters are prefixed with "[Job NNN]" where "NNN" is the job ID.

Page Log File Format

-The page_log file lists each page or group of pages that are sent to a printer. +The page_log file lists the total number of pages (sheets) that are printed. By default, each line contains the following information: 
 
-    printer user job-id date-time page-number num-copies job-billing
-      job-originating-host-name job-name media sides
-
-    printer user job-id date-time total num-impressions job-billing
+    printer user job-id date-time total num-sheets job-billing
       job-originating-host-name job-name media sides
-For example the entries for a two page job called "myjob" might look like: +For example the entry for a two page job called "myjob" might look like: 
 
-    DeskJet root 1 [20/May/1999:19:21:05 +0000] 1 1 acme-123
-      localhost myjob na_letter_8.5x11in one-sided
-    DeskJet root 1 [20/May/1999:19:21:05 +0000] 2 1 acme-123
-      localhost myjob na_letter_8.5x11in one-sided
-
     DeskJet root 1 [20/May/1999:19:21:06 +0000] total 2 acme-123
       localhost myjob na_letter_8.5x11in one-sided
 
@@ -174,9 +166,7 @@ If you send a job to a printer class, this field will contain the name of the pr
 
The job-id field contains the job number of the page being printed.
 
The date-time field contains the date and time of when the page started printing.
 The format of this field is identical to the data-time field in the access_log file.
-
The page-number and num-copies fields contain the page number and number of copies being printed of that page.
-For printers that cannot produce copies on their own, the num-copies field will always be 1.
-
Lines containing the keyword "total" have a num-impressions field instead which provides the total number of impressions (sides) that have been printed on for the job.
+
The num-sheets field provides the total number of pages (sheets) that have been printed on for the job.
 
The job-billing field contains a copy of the job-billing or job-account-id attributes provided with the IPP Create-Job or Print-Job requests or "-" if neither was provided.
 
The job-originating-host-name field contains the hostname or IP address of the client that printed the job.
 
The job-name field contains a copy of the job-name attribute provided with the IPP Create-Job or Print-Job requests or "-" if none was provided.
diff --git a/doc/help/man-cupsd.conf.html b/doc/help/man-cupsd.conf.html
index 908234855..f4e744833 100644
--- a/doc/help/man-cupsd.conf.html
+++ b/doc/help/man-cupsd.conf.html
@@ -41,6 +41,10 @@ The default access log level is "actions".
 


 Specifies whether to purge job history data automatically when it is no longer required for quotas.
 The default is "No".
+
BrowseDNSSDSubTypes_subtype[,...]
+
Specifies a list of Bonjour sub-types to advertise for each shared printer.
+For example, "BrowseDNSSDSubTypes _cups,_print" will tell network clients that both CUPS sharing and IPP Everywhere are supported.
+The default is "_cups" which is necessary for printer sharing to work between systems using CUPS.
 
BrowseLocalProtocols all
 
BrowseLocalProtocols dnssd
 
BrowseLocalProtocols none
@@ -86,6 +90,9 @@ The default is "Yes".
 
Specifies the delay for updating of configuration and state files.
 A value of 0 causes the update to happen as soon as possible, typically within a few milliseconds.
 The default value is "30".
+
DNSSDHostNamehostname.example.com
+
Specifies the fully-qualified domain name for the server that is used for Bonjour sharing.
+The default is typically the server's ".local" hostname.
 
ErrorPolicy abort-job
 
Specifies that a failed print job should be aborted (discarded) unless otherwise specified for the printer.
 
ErrorPolicy retry-job
@@ -279,15 +286,20 @@ The default is "Minimal".
 
SSLListen [ipv6-address]:port
 
SSLListen *:port
 
Listens on the specified address and port for encrypted connections.
-
SSLOptions [AllowDH] [AllowRC4] [AllowSSL3] [DenyCBC] [DenyTLS1.0]
+
SSLOptions [AllowDH] [AllowRC4] [AllowSSL3] [DenyCBC] [DenyTLS1.0] [MaxTLS1.0] [MaxTLS1.1] [MaxTLS1.2] [MaxTLS1.3] [MinTLS1.0] [MinTLS1.1] [MinTLS1.2] [MinTLS1.3]
 
SSLOptions None
-
Sets encryption options.
+
Sets encryption options (only in /etc/cups/client.conf).
 By default, CUPS only supports encryption using TLS v1.0 or higher using known secure cipher suites.
-The AllowDH option enables cipher suites using plain Diffie-Hellman key negotiation.
-The AllowRC4 option enables the 128-bit RC4 cipher suites, which are required for some older clients that do not implement newer ones.
+Security is reduced when Allow options are used.
+Security is enhanced when Deny options are used.
+The AllowDH option enables cipher suites using plain Diffie-Hellman key negotiation (not supported on systems using GNU TLS).
+The AllowRC4 option enables the 128-bit RC4 cipher suites, which are required for some older clients.
 The AllowSSL3 option enables SSL v3.0, which is required for some older clients that do not support TLS v1.0.
 The DenyCBC option disables all CBC cipher suites.
 The DenyTLS1.0 option disables TLS v1.0 support - this sets the minimum protocol version to TLS v1.1.
+The MinTLS options set the minimum TLS version to support.
+The MaxTLS options set the maximum TLS version to support.
+Not all operating systems support TLS 1.3 at this time.
 
SSLPort port
 
Listens on the specified port for encrypted connections.
 
StrictConformance Yes
@@ -567,6 +579,7 @@ The following percent sequences are recognized:
The default is the empty string, which disables page logging. The string "%p %u %j %T %P %C %{job-billing} %{job-originating-host-name} %{job-name} %{media} %{sides}" creates a page log with the standard items. +Use "%{job-impressions-completed}" to insert the number of pages (sides) that were printed, or "%{job-media-sheets-completed}" to insert the number of sheets that were printed.
RIPCache size
Specifies the maximum amount of memory to use when converting documents into bitmaps for a printer. The default is "128m". diff --git a/doc/help/man-ipptool.html b/doc/help/man-ipptool.html index ec40d1ad1..fbcb92d21 100644 --- a/doc/help/man-ipptool.html +++ b/doc/help/man-ipptool.html @@ -14,6 +14,9 @@ ipptool - perform internet printing protocol requests [ --help ] [ +--ippserver +filename +] [ --stop-after-include-error ] [ --version @@ -88,6 +91,10 @@ The following options are recognized by
--help
Shows program help. +
--ippserver filename +
Specifies that the test results should be written to the named +ippserver +attributes file.
--stop-after-include-error
Tells ipptool diff --git a/doc/help/man-lpadmin.html b/doc/help/man-lpadmin.html index 110a584eb..ae740b952 100644 --- a/doc/help/man-lpadmin.html +++ b/doc/help/man-lpadmin.html @@ -71,8 +71,7 @@ The following options are recognized when configuring a printer queue:
-c class
Adds the named printer to class. If class does not exist it is created automatically. -
-i ppd-file -
-P ppd-file +
-P ppd-file
Specifies a PostScript Printer Description (PPD) file to use with the printer.
-m model
Sets a standard PPD file for the printer from the model directory or using one of the driver interfaces. @@ -153,6 +152,13 @@ programs on the destination.
-L "location"
Provides a textual location of the destination.
+

Deprecated Options

+The following lpadmin options are deprecated: +
+
-i filename +
This option historically has been used to provide either a System V interface script or (as an implementation side-effect) a PPD file. +Since interface scripts are no longer supported, the -P option is preferred for providing a PPD file for a printer. +

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. @@ -160,6 +166,7 @@ Finally, the CUPS version of lpadmin may ask the user for an access passw 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.

Example

Create an IPP Everywhere print queue: 
diff --git a/man/client.conf.man.in b/man/client.conf.man.in
index ce10af3df..5012d75c8 100644
--- a/man/client.conf.man.in
+++ b/man/client.conf.man.in
@@ -64,8 +64,8 @@ The \fIAllowRC4\fR option enables the 128-bit RC4 cipher suites, which are requi
 The \fIAllowSSL3\fR option enables SSL v3.0, which is required for some older clients that do not support TLS v1.0.
 The \fIDenyCBC\fR option disables all CBC cipher suites.
 The \fIDenyTLS1.0\fR option disables TLS v1.0 support - this sets the minimum protocol version to TLS v1.1.
-The \fMinTLS\fR options set the minimum TLS version to support.
-The \fMaxTLS\fR options set the maximum TLS version to support.
+The \fIMinTLS\fR options set the minimum TLS version to support.
+The \fIMaxTLS\fR options set the maximum TLS version to support.
 Not all operating systems support TLS 1.3 at this time.
 .TP 5
 \fBTrustOnFirstUse Yes\fR
diff --git a/man/cupsd.conf.man.in b/man/cupsd.conf.man.in
index d07226928..ca3e9cee1 100644
--- a/man/cupsd.conf.man.in
+++ b/man/cupsd.conf.man.in
@@ -460,8 +460,8 @@ The \fIAllowRC4\fR option enables the 128-bit RC4 cipher suites, which are requi
 The \fIAllowSSL3\fR option enables SSL v3.0, which is required for some older clients that do not support TLS v1.0.
 The \fIDenyCBC\fR option disables all CBC cipher suites.
 The \fIDenyTLS1.0\fR option disables TLS v1.0 support - this sets the minimum protocol version to TLS v1.1.
-The \fMinTLS\fR options set the minimum TLS version to support.
-The \fMaxTLS\fR options set the maximum TLS version to support.
+The \fIMinTLS\fR options set the minimum TLS version to support.
+The \fIMaxTLS\fR options set the maximum TLS version to support.
 Not all operating systems support TLS 1.3 at this time.
 .\"#SSLPort
 .TP 5
diff --git a/man/ipptool.man b/man/ipptool.man
index 4cc9c9df9..3e9afe889 100644
--- a/man/ipptool.man
+++ b/man/ipptool.man
@@ -13,7 +13,8 @@ ipptool \- perform internet printing protocol requests
 [
 .B \-\-help
 ] [
-.BI \-\-ippserver filename
+.B \-\-ippserver
+.I filename
 ] [
 .B \-\-stop\-after\-include\-error
 ] [
@@ -90,7 +91,7 @@ The following options are recognized by
 .B \-\-help
 Shows program help.
 .TP 5
--BI \-\-ippserver filename
+\fB\-\-ippserver \fIfilename\fR
 Specifies that the test results should be written to the named
 .B ippserver
 attributes file.
-- 
2.39.2