diff options
author | Michael R Sweet <michael.r.sweet@gmail.com> | 2019-04-24 18:35:00 -0400 |
---|---|---|
committer | Michael R Sweet <michael.r.sweet@gmail.com> | 2019-04-24 18:35:00 -0400 |
commit | dc84a5a4cdb6900256a6ea9f627336bc19903dcc (patch) | |
tree | 5ffba3c61dae8ea76e5432ecf91cde4323338423 /doc | |
parent | e513da0cd84bca4b3db96b15b2bf936715182d88 (diff) | |
download | cups-dc84a5a4cdb6900256a6ea9f627336bc19903dcc.tar.gz |
Update man pages.
Default manufacturer is now "Example".
Add support for DEBUG:, ERROR:, and INFO: messages from print commands.
Info and error messages get copied to the job-state-message attribute.
Add support for updating printer-alert-description attributes.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/help/man-client.conf.html | 16 | ||||
-rw-r--r-- | doc/help/man-cupsd.conf.html | 12 | ||||
-rw-r--r-- | doc/help/man-ippevepcl.html | 7 | ||||
-rw-r--r-- | doc/help/man-ippeveprinter.html | 86 |
4 files changed, 97 insertions, 24 deletions
diff --git a/doc/help/man-client.conf.html b/doc/help/man-client.conf.html index 879213735..4cf714c96 100644 --- a/doc/help/man-client.conf.html +++ b/doc/help/man-client.conf.html @@ -60,6 +60,22 @@ Not all operating systems support TLS 1.3 at this time. The default is "Yes". <dt><b>User </b><i>name</i> <dd style="margin-left: 5.0em">Specifies the default user name to use for requests. +<dt><a name="UserAgentTokens"></a><b>UserAgentTokens None</b> +<dd style="margin-left: 5.0em"><dt><b>UserAgentTokens ProductOnly</b> +<dd style="margin-left: 5.0em"><dt><b>UserAgentTokens Major</b> +<dd style="margin-left: 5.0em"><dt><b>UserAgentTokens Minor</b> +<dd style="margin-left: 5.0em"><dt><b>UserAgentTokens Minimal</b> +<dd style="margin-left: 5.0em"><dt><b>UserAgentTokens OS</b> +<dd style="margin-left: 5.0em"><dt><b>UserAgentTokens Full</b> +<dd style="margin-left: 5.0em">Specifies what information is included in the User-Agent header of HTTP requests. +"None" disables the User-Agent header. +"ProductOnly" reports "CUPS". +"Major" reports "CUPS/major IPP/2". +"Minor" reports "CUPS/major.minor IPP/2.1". +"Minimal" reports "CUPS/major.minor.patch IPP/2.1". +"OS" reports "CUPS/major.minor.path (osname osversion) IPP/2.1". +"Full" reports "CUPS/major.minor.path (osname osversion; architecture) IPP/2.1". +The default is "Minimal". <dt><b>ValidateCerts Yes</b> <dd style="margin-left: 5.0em"><dt><b>ValidateCerts No</b> <dd style="margin-left: 5.0em">Specifies whether to only allow TLS with certificates whose common name matches the hostname. diff --git a/doc/help/man-cupsd.conf.html b/doc/help/man-cupsd.conf.html index b1b0ac0b5..a34be393f 100644 --- a/doc/help/man-cupsd.conf.html +++ b/doc/help/man-cupsd.conf.html @@ -267,13 +267,11 @@ command. <dd style="margin-left: 5.0em">Specifies what information is included in the Server header of HTTP responses. "None" disables the Server header. "ProductOnly" reports "CUPS". -"Major" reports "CUPS 2". -"Minor" reports "CUPS 2.0". -"Minimal" reports "CUPS 2.0.0". -"OS" reports "CUPS 2.0.0 (UNAME)" where UNAME is the output of the -<b>uname</b>(1) -command. -"Full" reports "CUPS 2.0.0 (UNAME) IPP/2.0". +"Major" reports "CUPS/major IPP/2". +"Minor" reports "CUPS/major.minor IPP/2.1". +"Minimal" reports "CUPS/major.minor.patch IPP/2.1". +"OS" reports "CUPS/major.minor.path (osname osversion) IPP/2.1". +"Full" reports "CUPS/major.minor.path (osname osversion; architecture) IPP/2.1". The default is "Minimal". <dt><a name="SSLListen"></a><b>SSLListen </b><i>ipv4-address</i><b>:</b><i>port</i> <dd style="margin-left: 5.0em"><dt><b>SSLListen [</b><i>ipv6-address</i><b>]:</b><i>port</i> diff --git a/doc/help/man-ippevepcl.html b/doc/help/man-ippevepcl.html index 929657ec4..b07b9be4d 100644 --- a/doc/help/man-ippevepcl.html +++ b/doc/help/man-ippevepcl.html @@ -27,12 +27,13 @@ are print commands for <a href="man-ippeveprinter.html?TOPIC=Man+Pages"><b>ippeveprinter</b>(1).</a> As with all print commands, these commands read either the filename specified on the command-line or from the standard input. Output is sent to the standard output. +Status and progress messages are sent to the standard error. <p><b>ippevepcl</b> -prints to B&W HP PCL laser printers and some color inkjet printers and supports printing of PWG Raster (image/pwg-raster) and Apple Raster (image/urf) print files. +prints to B&W HP PCL laser printers and supports printing of HP PCL (application/vnd.hp-pcl), PWG Raster (image/pwg-raster), and Apple Raster (image/urf) print files. <p><b>ippeveps</b> -print to Adobe PostScript printers and supports printing of PDF (application/pdf), JPEG (image/jpeg), PWG Raster (image/pwg-raster), and Apple Raster (image/urf) print files. +print to Adobe PostScript printers and supports printing of PDF (application/pdf), PostScript (application/postscript), JPEG (image/jpeg), PWG Raster (image/pwg-raster), and Apple Raster (image/urf) print files. Printer-specific commands are read from a supplied PPD file. -If no PPD file is specified, generic commands suitable for any Level 2 or Level 3 PostScript printer are used instead to specify copies, duplex printing, and media size. +If no PPD file is specified, generic commands suitable for any Level 2 or Level 3 PostScript printer are used instead to specify duplex printing and media size. <h2 class="title"><a name="EXIT_STATUS">Exit Status</a></h2> These programs return 1 on error and 0 on success. <h2 class="title"><a name="ENVIRONMENT">Environment</a></h2> diff --git a/doc/help/man-ippeveprinter.html b/doc/help/man-ippeveprinter.html index d653f254c..b0af8e245 100644 --- a/doc/help/man-ippeveprinter.html +++ b/doc/help/man-ippeveprinter.html @@ -20,10 +20,23 @@ ippeveprinter - an ipp everywhere printer application for cups ] [ <b>-2</b> ] [ +<b>-D</b> +<i>device-uri</i> +] [ +<b>-K</b> +<i>keypath</i> +] [ <b>-M</b> <i>manufacturer</i> ] [ <b>-P</b> +<i>filename.ppd</i> +] [ +<b>-V</b> +<i>ipp-version</i> +] [ +<b>-a</b> +<i>filename.conf</i> ] [ <b>-c</b> <i>command</i> @@ -34,8 +47,6 @@ ippeveprinter - an ipp everywhere printer application for cups <b>-f</b> <i>type/subtype[,...]</i> ] [ -<b>-h</b> -] [ <b>-i</b> <i>iconfile.png</i> ] [ @@ -54,7 +65,7 @@ ippeveprinter - an ipp everywhere printer application for cups <i>port</i> ] [ <b>-r</b> -<i>subtype</i> +<i>subtype[,subtype]</i> ] [ <b>-s</b> <i>speed[,color-speed]</i> @@ -77,24 +88,45 @@ The following options are recognized by <dd style="margin-left: 5.0em">Show the CUPS version. <dt><b>-2</b> <dd style="margin-left: 5.0em">Report support for two-sided (duplex) printing. +<dt><b>-D </b><i>device-uri</i> +<dd style="margin-left: 5.0em">Set the device URI for print output. +The URI can be a filename, directory, or a network socket URI of the form "socket://ADDRESS[:PORT]" (where the default port number is 9100). +When specifying a directory, +<b>ippeveprinter</b> +will create an output file using the job ID and name. <dt><b>-M </b><i>manufacturer</i> <dd style="margin-left: 5.0em">Set the manufacturer of the printer. -The default is "Test". -<dt><b>-P</b> -<dd style="margin-left: 5.0em">Report support for PIN printing. +The default is "Example". +<dt><b>-P </b><i>filename.ppd</i> +<dd style="margin-left: 5.0em">Load printer attributes from the specified PPD file. +This option is typically used in conjunction with the +<b>ippeveps</b>(7) +printer command ("-c ippeveps"). +<dt><b>-V 1.1</b> +<dd style="margin-left: 5.0em"><dt><b>-V 2.0</b> +<dd style="margin-left: 5.0em">Specifies the maximum IPP version to report. +2.0 is the default. <dt><b>-c </b><i>command</i> <dd style="margin-left: 5.0em">Run the specified command for each document that is printed. +If "command" is not an absolute path ("/path/to/command"), +<b>ippeveprinter</b> +looks for the command in the "ippeveprinter" subdirectory of the CUPS binary directory, typically /usr/lib/cups/ippeveprinter or /usr/libexec/cups/ippeveprinter. +The +<a href="man-cups-config.html?TOPIC=Man+Pages"><b>cups-config</b>(1)</a> +command can be used to discover the correct binary directory ("cups-config --serverbin"). +In addition, the CUPS_SERVERBIN environment variable can be used to override the default location of this directory - see the +<a href="man-cups.html?TOPIC=Man+Pages"><b>cups</b>(1)</a> +man page for more details. <dt><b>-d </b><i>spool-directory</i> <dd style="margin-left: 5.0em">Specifies the directory that will hold the print files. The default is a directory under the user's current temporary directory. <dt><b>-f </b><i>type/subtype[,...]</i> <dd style="margin-left: 5.0em">Specifies a list of MIME media types that the server will accept. -The default is "application/pdf,image/jpeg,image/pwg-raster". -<dt><b>-h</b> -<dd style="margin-left: 5.0em">Shows program help. +The default depends on the type of printer created. <dt><b>-i </b><i>iconfile.png</i> <dd style="margin-left: 5.0em">Specifies the printer icon file for the server. -The default is "printer.png". +The file must be a PNG format image. +The default is an internally-provided PNG image. <dt><b>-k</b> <dd style="margin-left: 5.0em">Keeps the print documents in the spool directory rather than deleting them. <dt><b>-l </b><i>location</i> @@ -111,8 +143,8 @@ command. <dt><b>-p </b><i>port</i> <dd style="margin-left: 5.0em">Specifies the port number to listen on. The default is a user-specific number from 8000 to 8999. -<dt><b>-r </b><i>subtype</i> -<dd style="margin-left: 5.0em">Specifies the Bonjour subtype(s) to advertise. +<dt><b>-r </b><i>subtype[,subtype]</i> +<dd style="margin-left: 5.0em">Specifies the DNS-SD subtype(s) to advertise. Separate multiple subtypes with a comma. The default is "_print". <dt><b>-s </b><i>speed[,color-speed]</i> @@ -120,7 +152,7 @@ The default is "_print". If two numbers are specified and the second number is greater than zero, the server will report support for color printing. The default is "10,0". <dt><b>-v[vvv]</b> -<dd style="margin-left: 5.0em">Be (very) verbose when logging activity to the standard output. +<dd style="margin-left: 5.0em">Be (very) verbose when logging activity to standard error. </dl> <h2 class="title"><a name="EXIT_STATUS">Exit Status</a></h2> The @@ -137,8 +169,34 @@ program is unique to CUPS and conforms to the IPP Everywhere (PWG 5100.14) speci <b>ippeveprinter</b> adds environment variables starting with "IPP_" for all IPP Job attributes in the print request. For example, when executing a command for an IPP Job containing the "media" Job Template attribute, the "IPP_MEDIA" environment variable will be set to the value of that attribute. +<p>In addition, all IPP "xxx-default" Printer Description attributes are added to the environment. +For example, the "IPP_MEDIA_DEFAULT" environment variable will be set to the default value for the "media" Job Template attribute. <p>Enumerated values are converted to their keyword equivalents. For example, a "print-quality" Job Template attribute with a enum value of 3 will become the "IPP_PRINT_QUALITY" environment variable with a value of "draft". +This string conversion only happens for standard Job Template attributes, currently "finishings", "orientation-requested", and "print-quality". +<p>Finally, the "CONTENT_TYPE" environment variable contains the MIME media type of the document being printed, the "DEVICE_URI" environment variable contains the device URI as specified with the "-D" option, and the "PPD" environment variable contains the PPD filename as specified with the "-P" option. +<h2 class="title"><a name="COMMAND_OUTPUT">Command Output</a></h2> +Unless they communicate directly with a printer, print commands send printer-ready data to the standard output. +<p>Print commands can send messages back to +<b>ippeveprinter</b> +on the standard error with one of the following prefixes: +<dl class="man"> +<dt><b>ATTR: </b><i>attribute=value[ attribute=value]</i> +<dd style="margin-left: 5.0em">Sets the named attribute(s) to the given values. +Currently only the "job-impressions" and "job-impressions-completed" Job Status attributes and the "marker-xxx", "printer-alert", "printer-alert-description", "printer-supply", and "printer-supply-description" Printer Status attributes can be set. +<dt><b>DEBUG: </b><i>Debugging message</i> +<dd style="margin-left: 5.0em">Logs a debugging message if at least two -v's have been specified. +<dt><b>ERROR: </b><i>Error message</i> +<dd style="margin-left: 5.0em">Logs an error message and copies the message to the "job-state-message" attribute. +<dt><b>INFO: </b><i>Informational message</i> +<dd style="margin-left: 5.0em">Logs an informational/progress message if -v has been specified and copies the message to the "job-state-message" attribute unless an error has been reported. +<dt><b>STATE: </b><i>keyword[,keyword,...]</i> +<dd style="margin-left: 5.0em">Sets the printer's "printer-state-reasons" attribute to the listed keywords. +<dt><b>STATE: -</b><i>keyword[,keyword,...]</i> +<dd style="margin-left: 5.0em">Removes the listed keywords from the printer's "printer-state-reasons" attribute. +<dt><b>STATE: +</b><i>keyword[,keyword,...]</i> +<dd style="margin-left: 5.0em">Adds the listed keywords to the printer's "printer-state-reasons" attribute. +</dl> <h2 class="title"><a name="EXAMPLES">Examples</a></h2> Run <b>ippeveprinter</b> @@ -152,7 +210,7 @@ with a service name of My Cool Printer: command whenever a job is sent to the server: <pre class="man"> - ippeveprinter -c file "My Cool Printer" + ippeveprinter -c /usr/bin/file "My Cool Printer" </pre> <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> PWG Internet Printing Protocol Workgroup (<a href="http://www.pwg.org/ipp">http://www.pwg.org/ipp</a>) |