Gecko [ www.utparral.edu.mx ]

Name	Size	Permission
accounting.html	2.63 KB	-rw-r--r--
admin.html	11.66 KB	-rw-r--r--
api-admin.html	16.86 KB	-rw-r--r--
api-filter.html	57.21 KB	-rw-r--r--
api-ppd.html	84.63 KB	-rw-r--r--
cgi.html	2.12 KB	-rw-r--r--
cupspm.html	434.33 KB	-rw-r--r--
encryption.html	4.21 KB	-rw-r--r--
firewalls.html	3.94 KB	-rw-r--r--
glossary.html	2.66 KB	-rw-r--r--
kerberos.html	4.58 KB	-rw-r--r--
license.html	11.78 KB	-rw-r--r--
man-backend.html	9.71 KB	-rw-r--r--
man-cancel.html	2.79 KB	-rw-r--r--
man-classes.conf.html	1.5 KB	-rw-r--r--
man-client.conf.html	6.95 KB	-rw-r--r--
man-cupsaccept.html	2.71 KB	-rw-r--r--
man-cups-config.html	3.52 KB	-rw-r--r--
man-cupsd.conf.html	39.71 KB	-rw-r--r--
man-cupsd-helper.html	3.05 KB	-rw-r--r--
man-cupsd.html	3.76 KB	-rw-r--r--
man-cupsd-logs.html	9.93 KB	-rw-r--r--
man-cupsenable.html	3.2 KB	-rw-r--r--
man-cups-files.conf.html	13 KB	-rw-r--r--
man-cups.html	8.2 KB	-rw-r--r--
man-cups-lpd.html	4.66 KB	-rw-r--r--
man-cups-snmp.html	2.96 KB	-rw-r--r--
man-cupstestppd.html	4.94 KB	-rw-r--r--
man-filter.html	11.7 KB	-rw-r--r--
man-ippevepcl.html	1.94 KB	-rw-r--r--
man-ippeveprinter.html	10.03 KB	-rw-r--r--
man-ippfind.html	9.77 KB	-rw-r--r--
man-ipptoolfile.html	30.03 KB	-rw-r--r--
man-ipptool.html	7.56 KB	-rw-r--r--
man-lpadmin.html	10.65 KB	-rw-r--r--
man-lpc.html	2.52 KB	-rw-r--r--
man-lp.html	7.78 KB	-rw-r--r--
man-lpinfo.html	3.76 KB	-rw-r--r--
man-lpmove.html	2.08 KB	-rw-r--r--
man-lpoptions.html	4.31 KB	-rw-r--r--
man-lpq.html	2.19 KB	-rw-r--r--
man-lpr.html	6.38 KB	-rw-r--r--
man-lprm.html	2.3 KB	-rw-r--r--
man-lpstat.html	4.77 KB	-rw-r--r--
man-mime.convs.html	2.89 KB	-rw-r--r--
man-mime.types.html	5.72 KB	-rw-r--r--
man-notifier.html	1.49 KB	-rw-r--r--
man-ppdc.html	3.78 KB	-rw-r--r--
man-ppdhtml.html	2.11 KB	-rw-r--r--
man-ppdi.html	2.27 KB	-rw-r--r--
man-ppdmerge.html	2.03 KB	-rw-r--r--
man-ppdpo.html	2.33 KB	-rw-r--r--
man-printers.conf.html	1.58 KB	-rw-r--r--
man-subscriptions.conf.html	1.61 KB	-rw-r--r--
network.html	18.56 KB	-rw-r--r--
options.html	16.42 KB	-rw-r--r--
overview.html	3.4 KB	-rw-r--r--
policies.html	21.25 KB	-rw-r--r--
postscript-driver.html	20.5 KB	-rw-r--r--
ppd-compiler.html	42.29 KB	-rw-r--r--
raster-driver.html	17.57 KB	-rw-r--r--
ref-ppdcfile.html	69.29 KB	-rw-r--r--
security.html	4.44 KB	-rw-r--r--
sharing.html	4.45 KB	-rw-r--r--
spec-banner.html	4.05 KB	-rw-r--r--
spec-command.html	6.08 KB	-rw-r--r--
spec-design.html	11.61 KB	-rw-r--r--
spec-ipp.html	65.41 KB	-rw-r--r--
spec-ppd.html	86.91 KB	-rw-r--r--
spec-raster.html	23.34 KB	-rw-r--r--
spec-stp.html	3.79 KB	-rw-r--r--
translation.html	24.29 KB	-rw-r--r--

Code Editor : man-ipptoolfile.html

<!DOCTYPE HTML>
<html>

<head>
	<link rel="stylesheet" type="text/css" href="../cups-printable.css">
	<title>ipptoolfile(5)</title>
</head>
<body>
<h1 class="title">ipptoolfile(5)</h1>
<h2 class="title"><a name="NAME">Name</a></h2>
ipptoolfile - ipptool file format
<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
The
<a href="man-ipptool.html?TOPIC=Man+Pages">ipptool(1)</a>
program accepts free-form plain text files that describe one or more IPP requests.
Comments start with the "#" character and continue to the end of the line.
Each request is enclosed by curly braces, for example:
<pre class="man">
 # This is a comment
 {
 # The name of the test
 NAME "Print PDF File"

# The request to send
      OPERATION Print-Job

GROUP operation-attributes-tag
      ATTR charset attributes-charset utf-8
      ATTR language attributes-natural-language en
      ATTR uri printer-uri $uri
      ATTR name requesting-user-name $user
      ATTR mimeMediaType document-format application/pdf

GROUP job-attributes-tag
      ATTR collection media-col {
        # US Letter plain paper from the "main" tray
        MEMBER collection media-size {
          MEMBER integer x-dimension 21590
          MEMBER integer y-dimension 27940
        }
        MEMBER integer media-top-margin 423
        MEMBER integer media-bottom-margin 423
        MEMBER integer media-left-margin 423
        MEMBER integer media-right-margin 423
        MEMBER keyword media-source "main"
        MEMBER keyword media-type "stationery"
      }

FILE testfile.pdf

# The response to expect
      STATUS successful-ok
      EXPECT job-id OF-TYPE integer WITH-VALUE >0
      EXPECT job-uri OF-TYPE uri
    }
    {
      # The name of the test
      NAME "Wait for Job to Complete"

# The request to send
      OPERATION Get-Job-Attributes

GROUP operation-attributes-tag
      ATTR charset attributes-charset utf-8
      ATTR language attributes-natural-language en
      ATTR uri printer-uri $uri
      ATTR integer job-id $job-id
      ATTR name requesting-user-name $user

# The response to expect
      STATUS successful-ok
      EXPECT job-id OF-TYPE integer WITH-VALUE $job-id
      EXPECT job-uri OF-TYPE uri
      EXPECT job-state OF-TYPE enum WITH-VALUE >5 REPEAT-NO-MATCH
      EXPECT job-originating-user-name OF-TYPE name WITH-VALUE "$user"

# Show the job state until completed...
 DISPLAY job-state
 DISPLAY job-state-reasons
 }
</pre>
<h3><a name="TOP_LEVEL_DIRECTIVES">Top-level Directives</a></h3>
The following directives can be used outside of a test:
<dl class="man">
<dt>{ test }
<dd style="margin-left: 5.0em">Defines a test.
<dt>DEFINE variable-name value
<dd style="margin-left: 5.0em">Defines the named variable to the given value. This is equivalent to specifying -d variable-name=value on the
ipptool(8)
command-line.
<dt>DEFINE-DEFAULT variable-name value
<dd style="margin-left: 5.0em">Defines the named variable to the given value if it does not already have a value.
<dt>FILE-ID "identifier"
<dd style="margin-left: 5.0em">Specifies an identifier string for the current file.
<dt>IGNORE-ERRORS yes
<dd style="margin-left: 5.0em"><dt>IGNORE-ERRORS no
<dd style="margin-left: 5.0em">Specifies whether, by default,
ipptool(8)
will ignore errors and continue with subsequent tests.
<dt>INCLUDE "filename"
<dd style="margin-left: 5.0em"><dt>INCLUDE &lt;filename>
<dd style="margin-left: 5.0em">Includes another test file. The first form includes a file relative to the current test file, while the second form includes a file from the
ipptool(8)
include directory.
<dt>INCLUDE-IF-DEFINED name "filename"
<dd style="margin-left: 5.0em"><dt>INCLUDE-IF-DEFINED name &lt;filename>
<dd style="margin-left: 5.0em">Includes another test file if the named variable is defined. The first form includes a file relative to the current test file, while the second form includes a file from the
ipptool(8)
include directory.
<dt>INCLUDE-IF-NOT-DEFINED name "filename"
<dd style="margin-left: 5.0em"><dt>INCLUDE-IF-NOT-DEFINED name &lt;filename>
<dd style="margin-left: 5.0em">Includes another test file if the named variable is not defined. The first form includes a file relative to the current test file, while the second form includes a file from the
ipptool(8)
include directory.
<dt>SKIP-IF-DEFINED variable-name
<dd style="margin-left: 5.0em"><dt>SKIP-IF-NOT-DEFINED variable-name
<dd style="margin-left: 5.0em">Specifies that the remainder of the test file should be skipped when the variable is or is not defined.
<dt>STOP-AFTER-INCLUDE-ERROR no
<dd style="margin-left: 5.0em"><dt>STOP-AFTER-INCLUDE-ERROR yes
<dd style="margin-left: 5.0em">Specifies whether tests will be stopped after an error in an included file.
<dt>TRANSFER auto
<dd style="margin-left: 5.0em">Specifies that tests will, by default, use "Transfer-Encoding: chunked" for requests with attached files and "Content-Length:" for requests without attached files.
<dt>TRANSFER chunked
<dd style="margin-left: 5.0em">Specifies that tests will, by default, use the HTTP/1.1 "Transfer-Encoding: chunked" header. This is the default and is equivalent to specifying -c on the
ipptool(8)
command-line. Support for chunked requests is required for conformance with all versions of IPP.
<dt>TRANSFER length
<dd style="margin-left: 5.0em">Specifies that tests will, by default, use the HTTP/1.0 "Content-Length:" header. This is equivalent to specifying -l on the
ipptool(8)
command-line. Support for content length requests is required for conformance with all versions of IPP.
<dt>VERSION 1.0
<dd style="margin-left: 5.0em"><dt>VERSION 1.1
<dd style="margin-left: 5.0em"><dt>VERSION 2.0
<dd style="margin-left: 5.0em"><dt>VERSION 2.1
<dd style="margin-left: 5.0em"><dt>VERSION 2.2
<dd style="margin-left: 5.0em">Specifies the default IPP version number to use for the tests that follow.
</dl>
<h3><a name="TEST_DIRECTIVES">Test Directives</a></h3>
The following directives are understood within a test:
<dl class="man">
<dt>ATTR out-of-band-tag attribute-name
<dd style="margin-left: 5.0em"><dt>ATTR tag attribute-name value(s)
<dd style="margin-left: 5.0em">Adds an attribute to the test request.
Out-of-band tags (admin-define, delete-attribute, no-value, not-settable, unknown, unsupported) have no value.
Values for other tags are delimited by the comma (",") character - escape commas using the "\" character.
Common attributes and values are listed in the IANA IPP registry - see references below.
<dt>ATTR collection attribute-name { MEMBER tag member-name value(s) ... } [ ... ,{ ... } ]
<dd style="margin-left: 5.0em">Adds a collection attribute to the test request.
Member attributes follow the same syntax as regular attributes and can themselves be nested collections.
Multiple collection values can be supplied as needed, separated by commas.
<dt>COMPRESSION deflate
<dd style="margin-left: 5.0em"><dt>COMPRESSION gzip
<dd style="margin-left: 5.0em"><dt>COMPRESSION none
<dd style="margin-left: 5.0em">Uses the specified compression on the document data following the attributes in a Print-Job or Send-Document request.
<dt>DELAY seconds[,repeat-seconds]
<dd style="margin-left: 5.0em">Specifies a delay in seconds before this test will be run.
If two values are specified, the second value is used as the delay between repeated tests.
<dt>DISPLAY attribute-name
<dd style="margin-left: 5.0em">Specifies that value of the named attribute should be output as part of the
test report.
<dt>EXPECT attribute-name [ predicate(s) ]
<dd style="margin-left: 5.0em"><dt>EXPECT ?attribute-name predicate(s)
<dd style="margin-left: 5.0em"><dt>EXPECT !attribute-name
<dd style="margin-left: 5.0em">Specifies that the response must/may/must not include the named attribute. Additional requirements can be added as predicates - see the "EXPECT PREDICATES" section for more information on predicates. Attribute names can specify member attributes by separating the attribute and member names with the forward slash, for example "media-col/media-size/x-dimension".
<dt>EXPECT-ALL attribute-name [ predicate(s) ]
<dd style="margin-left: 5.0em"><dt>EXPECT-ALL ?attribute-name predicate(s)
<dd style="margin-left: 5.0em">Specifies that the response must/may include the named attribute and that all occurrences of that attribute must match the given predicates.
<dt>FILE filename
<dd style="margin-left: 5.0em">Specifies a file to include at the end of the request. This is typically used when sending a test print file.
<dt>GROUP tag
<dd style="margin-left: 5.0em">Specifies the group tag for subsequent attributes in the request.
<dt>IGNORE-ERRORS yes
<dd style="margin-left: 5.0em"><dt>IGNORE-ERRORS no
<dd style="margin-left: 5.0em">Specifies whether
ipptool(8)
will ignore errors and continue with subsequent tests.
<dt>MONITOR-PRINTER-STATE [ printer-uri ] { EXPECT attribute-name [ predicate(s) ] }
<dd style="margin-left: 5.0em">Specifies printer state monitoring tests to run in parallel with the test operation.
The monitoring tests will run until all of the EXPECT conditions are satisfied or the primary test operation has completed, whichever occurs first.
<dt>NAME "literal string"
<dd style="margin-left: 5.0em">Specifies the human-readable name of the test.
<dt>OPERATION operation-code
<dd style="margin-left: 5.0em">Specifies the operation to be performed.
<dt>PASS-IF-DEFINED variable-name
<dd style="margin-left: 5.0em"><dt>PASS-IF-NOT-DEFINED variable-name
<dd style="margin-left: 5.0em">Specifies that the current test should be passed automatically when the variable is or is not defined.
<dt>PAUSE "message"
<dd style="margin-left: 5.0em">Displays the provided message and waits for the user to press a key to continue.
<dt>REQUEST-ID number
<dd style="margin-left: 5.0em"><dt>REQUEST-ID random
<dd style="margin-left: 5.0em">Specifies the request-id value to use in the request, either an integer or the word "random" to use a randomly generated value (the default).
<dt>RESOURCE path
<dd style="margin-left: 5.0em">Specifies an alternate resource path that is used for the HTTP POST request. The default is the resource from the URI provided to the
ipptool(8)
program.
<dt>SKIP-IF-DEFINED variable-name
<dd style="margin-left: 5.0em"><dt>SKIP-IF-NOT-DEFINED variable-name
<dd style="margin-left: 5.0em">Specifies that the current test should be skipped when the variable is or is not defined.
<dt>SKIP-PREVIOUS-ERROR yes
<dd style="margin-left: 5.0em"><dt>SKIP-PREVIOUS-ERROR no
<dd style="margin-left: 5.0em">Specifies whether
ipptool(8)
will skip the current test if the previous test resulted in an error/failure.
<dt>STATUS status-code [ predicate ]
<dd style="margin-left: 5.0em">Specifies an expected response status-code value. Additional requirements can be added as predicates - see the "STATUS PREDICATES" section for more information on predicates.
<dt>TEST-ID "identifier"
<dd style="margin-left: 5.0em">Specifies an identifier string for the current test.
<dt>TRANSFER auto
<dd style="margin-left: 5.0em">Specifies that this test will use "Transfer-Encoding: chunked" if it has an attached file or "Content-Length:" otherwise.
<dt>TRANSFER chunked
<dd style="margin-left: 5.0em">Specifies that this test will use the HTTP/1.1 "Transfer-Encoding: chunked" header.
<dt>TRANSFER length
<dd style="margin-left: 5.0em">Specifies that this test will use the HTTP/1.0 "Content-Length:" header.
<dt>VERSION 1.0
<dd style="margin-left: 5.0em"><dt>VERSION 1.1
<dd style="margin-left: 5.0em"><dt>VERSION 2.0
<dd style="margin-left: 5.0em"><dt>VERSION 2.1
<dd style="margin-left: 5.0em"><dt>VERSION 2.2
<dd style="margin-left: 5.0em">Specifies the IPP version number to use for this test.
</dl>
<h3><a name="EXPECT_PREDICATES">Expect Predicates</a></h3>
The following predicates are understood following the EXPECT test directive:
<dl class="man">
<dt>COUNT number
<dd style="margin-left: 5.0em">Requires the EXPECT attribute to have the specified number of values.
<dt>DEFINE-MATCH variable-name
<dd style="margin-left: 5.0em">Defines the variable to "1" when the EXPECT condition matches.
A side-effect of this predicate is that this EXPECT will never fail a test.
<dt>DEFINE-NO-MATCH variable-name
<dd style="margin-left: 5.0em">Defines the variable to "1" when the EXPECT condition does not match.
A side-effect of this predicate is that this EXPECT will never fail a test.
<dt>DEFINE-VALUE variable-name
<dd style="margin-left: 5.0em">Defines the variable to the value of the attribute when the EXPECT condition matches.
A side-effect of this predicate is that this EXPECT will never fail a test.
<dt>DISPLAY-MATCH "message"
<dd style="margin-left: 5.0em">Displays the specified message when the EXPECT condition matches.
<dt>IF-DEFINED variable-name
<dd style="margin-left: 5.0em">Makes the EXPECT conditions apply only if the specified variable is defined.
<dt>IF-NOT-DEFINED variable-name
<dd style="margin-left: 5.0em">Makes the EXPECT conditions apply only if the specified variable is not defined.
<dt>IN-GROUP tag
<dd style="margin-left: 5.0em">Requires the EXPECT attribute to be in the specified group tag.
<dt>OF-TYPE tag[(limits)|tag|...]
<dd style="margin-left: 5.0em">Requires the EXPECT attribute to use one of the specified value tag(s).
Most value tags also support the specification of limits in parenthesis, for example "name(42)" would allow nameWith/WithoutLanguage strings up to 42 octets in length, "name(4:MAX)" would allow nameWith/WithoutLanguage strings between 4 and 255 octets in length, and "integer(-273:MAX)" would allow integers between -273 and 2147483647.
<dt>REPEAT-LIMIT number
<dd style="margin-left: 5.0em"> 
Specifies the maximum number of times to repeat if the REPEAT-MATCH or REPEAT-NO-MATCH predicate is specified. The default value is 1000.
<dt>REPEAT-MATCH
<dd style="margin-left: 5.0em"><dt>REPEAT-NO-MATCH
<dd style="margin-left: 5.0em">Specifies that the current test should be repeated when the EXPECT condition matches or does not match.
<dt>SAME-COUNT-AS attribute-name
<dd style="margin-left: 5.0em">Requires the EXPECT attribute to have the same number of values as the specified parallel attribute.
<dt>WITH-ALL-HOSTNAMES "literal string"
<dd style="margin-left: 5.0em"><dt>WITH-ALL-HOSTNAMES "/regular expression/"
<dd style="margin-left: 5.0em">Requires that all URI values contain a matching hostname.
<dt>WITH-ALL-RESOURCES "literal string"
<dd style="margin-left: 5.0em"><dt>WITH-ALL-RESOURCES "/regular expression/"
<dd style="margin-left: 5.0em">Requires that all URI values contain a matching resource (including leading /).
<dt>WITH-ALL-SCHEMES "literal string"
<dd style="margin-left: 5.0em"><dt>WITH-ALL-SCHEMES "/regular expression/"
<dd style="margin-left: 5.0em">Requires that all URI values contain a matching scheme.
<dt>WITH-ALL-VALUES "literal string"
<dd style="margin-left: 5.0em">Requires that all values of the EXPECT attribute match the literal string. Comparisons are case-sensitive.
<dt>WITH-ALL-VALUES &lt;number
<dd style="margin-left: 5.0em"><dt>WITH-ALL-VALUES =number
<dd style="margin-left: 5.0em"><dt>WITH-ALL-VALUES >number
<dd style="margin-left: 5.0em"><dt>WITH-ALL-VALUES number[,...,number]
<dd style="margin-left: 5.0em">Requires that all values of the EXPECT attribute match the number(s) or numeric comparison. When comparing rangeOfInteger values, the "&lt;" and ">" operators only check the upper bound of the range.
<dt>WITH-ALL-VALUES "false"
<dd style="margin-left: 5.0em"><dt>WITH-ALL-VALUES "true"
<dd style="margin-left: 5.0em">Requires that all values of the EXPECT attribute match the boolean value given.
<dt>WITH-ALL-VALUES "/regular expression/"
<dd style="margin-left: 5.0em">Requires that all values of the EXPECT attribute match the regular expression, which must conform to the POSIX regular expression syntax.
Comparisons are case-sensitive.
<dt>WITH-DISTINCT-VALUES
<dd style="margin-left: 5.0em">Requires that all values of the EXPECT attribute are unique.
Comparisons are case-sensitive.
Only charset, collection, enum, integer, keyword, mimeMediaType, naturalLanguage, rangeOfInteger, resolution, uriScheme attributes support this predicate.
<dt>WITH-HOSTNAME "literal string"
<dd style="margin-left: 5.0em"><dt>WITH-HOSTNAME "/regular expression/"
<dd style="margin-left: 5.0em">Requires that at least one URI value contains a matching hostname.
<dt>WITH-RESOURCE "literal string"
<dd style="margin-left: 5.0em"><dt>WITH-RESOURCE "/regular expression/"
<dd style="margin-left: 5.0em">Requires that at least one URI value contains a matching resource (including leading /).
<dt>WITH-SCHEME "literal string"
<dd style="margin-left: 5.0em"><dt>WITH-SCHEME "/regular expression/"
<dd style="margin-left: 5.0em">Requires that at least one URI value contains a matching scheme.
<dt>WITH-VALUE "literal string"
<dd style="margin-left: 5.0em">Requires that at least one value of the EXPECT attribute matches the literal string. Comparisons are case-sensitive.
<dt>WITH-VALUE &lt;number
<dd style="margin-left: 5.0em"><dt>WITH-VALUE =number
<dd style="margin-left: 5.0em"><dt>WITH-VALUE >number
<dd style="margin-left: 5.0em"><dt>WITH-VALUE number[,...,number]
<dd style="margin-left: 5.0em">Requires that at least one value of the EXPECT attribute matches the number(s) or numeric comparison. When comparing rangeOfInteger values, the "&lt;" and ">" operators only check the upper bound of the range.
<dt>WITH-VALUE "false"
<dd style="margin-left: 5.0em"><dt>WITH-VALUE "true"
<dd style="margin-left: 5.0em">Requires that at least one value of the EXPECT attribute matches the boolean value given.
<dt>WITH-VALUE "/regular expression/"
<dd style="margin-left: 5.0em">Requires that at least one value of the EXPECT attribute matches the regular expression, which must conform to the POSIX regular expression syntax. Comparisons are case-sensitive.
<dt>WITH-VALUE-FROM attribute-name
<dd style="margin-left: 5.0em">Requires that the value(s) of the EXPECT attribute matches the value(s) in the specified attribute.
For example, "EXPECT job-sheets WITH-VALUE-FROM job-sheets-supported" requires that the "job-sheets" value is listed as a value of the "job-sheets-supported" attribute.
</dl>
<h3><a name="STATUS_PREDICATES">Status Predicates</a></h3>
The following predicates are understood following the STATUS test directive:
<dl class="man">
<dt>DEFINE-MATCH variable-name
<dd style="margin-left: 5.0em">Defines the variable to "1" when the STATUS matches. A side-effect of this predicate is that this STATUS will never fail a test.
<dt>DEFINE-NO-MATCH variable-name
<dd style="margin-left: 5.0em">Defines the variable to "1" when the STATUS does not match. A side-effect of this predicate is that this STATUS will never fail a test.
<dt>IF-DEFINED variable-name
<dd style="margin-left: 5.0em">Makes the STATUS apply only if the specified variable is defined.
<dt>IF-NOT-DEFINED variable-name
<dd style="margin-left: 5.0em">Makes the STATUS apply only if the specified variable is not defined.
<dt>REPEAT-LIMIT number
<dd style="margin-left: 5.0em"> 
Specifies the maximum number of times to repeat. The default value is 1000.
<dt>REPEAT-MATCH
<dd style="margin-left: 5.0em"><dt>REPEAT-NO-MATCH
<dd style="margin-left: 5.0em">Specifies that the current test should be repeated when the response status-code matches or does not match the value specified by the STATUS directive.
</dl>
<h3><a name="OPERATION_CODES">Operation Codes</a></h3>
Operation codes correspond to the hexadecimal numbers (0xHHHH) and names from RFC 8011 and other IPP extension specifications. Here is a complete list of names supported by
ipptool(8):
<pre class="man">
 Acknowledge-Document
 Acknowledge-Identify-Printer
 Acknowledge-Job
 Activate-Printer
 Add-Document-Images
 Allocate-Printer-Resources
 Cancel-Current-Job
 Cancel-Job
 Cancel-Jobs
 Cancel-My-Jobs
 Cancel-Resource
 Cancel-Subscription
 Close-Job
 Create-Job
 Create-Job-Subscriptions
 Create-Printer
 Create-Printer-Subscriptions
 Create-Resource
 Create-Resource-Subscriptions
 Create-System-Subscriptions
 CUPS-Accept-Jobs
 CUPS-Accept-Jobs
 CUPS-Add-Modify-Class
 CUPS-Add-Modify-Printer
 CUPS-Authenticate-Job
 CUPS-Create-Local-Printer
 CUPS-Delete-Class
 CUPS-Delete-Printer
 CUPS-Get-Classes
 CUPS-Get-Default
 CUPS-Get-Devices
 CUPS-Get-Document
 CUPS-Get-PPD
 CUPS-Get-PPDs
 CUPS-Get-Printers
 CUPS-Move-Job
 CUPS-Reject-Jobs
 CUPS-Set-Default
 Deactivate-Printer
 Deallocate-Printer-Resources
 Delete-Printer
 Deregister-Output-Device
 Disable-All-Printers
 Disable-Printer
 Enable-All-Printers
 Enable-Printer
 Fetch-Document
 Fetch-Job
 Get-Job-Attributes
 Get-Jobs
 Get-Next-Document-Data
 Get-Notifications
 Get-Output-Device-Attributes
 Get-Printer-Attributes
 Get-Printer-Support-Files
 Get-Printer-Supported-Values
 Get-Printers
 Get-Subscription-Attributes
 Get-Subscriptions
 Get-System-Attributes
 Get-System-Supported-Values
 Hold-Job
 Hold-New-Jobs
 Identify-Printer
 Install-Resource
 Pause-All-Printers
 Pause-All-Printers-After-Current-Job
 Pause-Printer
 Pause-Printer-After-Current-Job
 Print-Job
 Print-URI
 Promote-Job
 Purge-Jobs
 Register-Output-Device
 Release-Held-New-Jobs
 Release-Job
 Renew-Subscription
 Reprocess-Job
 Restart-Job
 Restart-Printer
 Restart-System
 Resubmit-Job
 Resume-All-Printers
 Resume-Job
 Resume-Printer
 Schedule-Job-After
 Send-Document
 Send-Hardcopy-Document
 Send-Notifications
 Send-Resource-Data
 Send-URI
 Set-Job-Attributes
 Set-Printer-Attributes
 Set-Resource-Attributes
 Set-System-Attributes
 Shutdown-All-Printers
 Shutdown-One-Printer
 Shutdown-Printer
 Startup-All-Printers
 Startup-One-Printer
 Startup-Printer
 Suspend-Current-Job
 Update-Active-Jobs
 Update-Document-Status
 Update-Job-Status
 Update-Output-Device-Attributes
 Validate-Document
 Validate-Job
</pre>
<h3><a name="STATUS_CODES">Status Codes</a></h3>
Status codes correspond to the hexadecimal numbers (0xHHHH) and names from RFC 8011 and other IPP extension specifications. Here is a complete list of the names supported by
ipptool(8):
<pre class="man">
 client-error-account-authorization-failed
 client-error-account-closed
 client-error-account-info-needed
 client-error-account-limit-reached
 client-error-attributes-not-settable
 client-error-attributes-or-values-not-supported
 client-error-bad-request
 client-error-charset-not-supported
 client-error-compression-error
 client-error-compression-not-supported
 client-error-conflicting-attributes
 client-error-document-access-error
 client-error-document-format-error
 client-error-document-format-not-supported
 client-error-document-password-error
 client-error-document-permission-error
 client-error-document-security-error
 client-error-document-unprintable-error
 client-error-forbidden
 client-error-gone
 client-error-ignored-all-notifications
 client-error-ignored-all-subscriptions
 client-error-not-authenticated
 client-error-not-authorized
 client-error-not-fetchable
 client-error-not-found
 client-error-not-possible
 client-error-print-support-file-not-found
 client-error-request-entity-too-large
 client-error-request-value-too-long
 client-error-timeout
 client-error-too-many-subscriptions
 client-error-uri-scheme-not-supported
 cups-error-account-authorization-failed
 cups-error-account-closed
 cups-error-account-info-needed
 cups-error-account-limit-reached
 cups-see-other
 redirection-other-site
 server-error-busy
 server-error-device-error
 server-error-internal-error
 server-error-job-canceled
 server-error-multiple-document-jobs-not-supported
 server-error-not-accepting-jobs
 server-error-operation-not-supported
 server-error-printer-is-deactivated
 server-error-service-unavailable
 server-error-temporary-error
 server-error-version-not-supported
 successful-ok
 successful-ok-but-cancel-subscription
 successful-ok-conflicting-attributes
 successful-ok-events-complete
 successful-ok-ignored-notifications
 successful-ok-ignored-or-substituted-attributes
 successful-ok-ignored-subscriptions
 successful-ok-too-many-events
</pre>
<h3><a name="TAGS">Tags</a></h3>
Value and group tags correspond to the names from RFC 8011 and other IPP extension specifications. Here are the group tags:
<pre class="man">
 document-attributes-tag
 event-notification-attributes-tag
 job | job-attributes-tag
 operation | operation-attributes-tag
 printer | printer-attributes-tag
 resource-attributes-tag
 subscription-attributes-tag
 system-attributes-tag
 unsupported-attributes-tag
</pre>
Here are the value tags:
<pre class="man">
 admin-define
 boolean
 charset
 collection | begCollection
 dateTime
 default
 delete-attribute
 enum
 integer
 keyword
 language | naturalLanguage
 mimetype | mimeMediaType
 name | nameWithLanguage | nameWithoutLanguage
 no-value
 not-settable
 octetString
 rangeOfInteger
 resolution
 text | textWithLanguage | textWithoutLanguage
 unknown
 unsupported
 uri
 uriScheme
</pre>
<h3><a name="VARIABLES">Variables</a></h3>
The
ipptool(8)
program maintains a list of variables that can be used in any literal string or attribute value by specifying "$variable-name". Aside from variables defined using the -d option or DEFINE directive, the following pre-defined variables are available:
<dl class="man">
<dt>$$
<dd style="margin-left: 5.0em">Inserts a single "$" character.
<dt>$ENV[name]
<dd style="margin-left: 5.0em">Inserts the value of the named environment variable, or an empty string if the environment variable is not defined.
<dt>$date-current
<dd style="margin-left: 5.0em">Inserts the current date and time using the ISO-8601 format ("yyyy-mm-ddThh:mm:ssZ").
<dt>$date-start
<dd style="margin-left: 5.0em">Inserts the starting date and time using the ISO-8601 format ("yyyy-mm-ddThh:mm:ssZ").
<dt>$filename
<dd style="margin-left: 5.0em">Inserts the filename provided to
ipptool(8)
with the -f option.
<dt>$filetype
<dd style="margin-left: 5.0em">Inserts the MIME media type for the filename provided to
ipptool(8)
with the -f option.
<dt>$hostname
<dd style="margin-left: 5.0em">Inserts the hostname from the URI provided to
ipptool(8).
<dt>$job-id
<dd style="margin-left: 5.0em">Inserts the last "job-id" attribute value returned in a test response or 0 if no "job-id" attribute has been seen.
<dt>$job-uri
<dd style="margin-left: 5.0em">Inserts the last "job-uri" attribute value returned in a test response or an empty string if no "job-uri" attribute has been seen.
<dt>$notify-subscription-id
<dd style="margin-left: 5.0em">Inserts the last "notify-subscription-id" attribute value returned in a test response or 0 if no "notify-subscription-id" attribute has been seen.
<dt>$port
<dd style="margin-left: 5.0em">Inserts the port number from the URI provided to
ipptool(8).
<dt>$resource
<dd style="margin-left: 5.0em">Inserts the resource path from the URI provided to
ipptool(8).
<dt>$scheme
<dd style="margin-left: 5.0em">Inserts the scheme from the URI provided to
ipptool(8).
<dt>$uri
<dd style="margin-left: 5.0em">Inserts the URI provided to
ipptool(8).
<dt>$uriuser
<dd style="margin-left: 5.0em">Inserts the username from the URI provided to
ipptool(8),
if any.
<dt>$user
<dd style="margin-left: 5.0em">Inserts the current user's login name.
</dl>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
<a href="man-ipptool.html?TOPIC=Man+Pages">ipptool(1),</a>
IANA IPP Registry (<a href="https://www.iana.org/assignments/ipp-registrations">https://www.iana.org/assignments/ipp-registrations</a>),
PWG Internet Printing Protocol Workgroup (<a href="https://www.pwg.org/ipp">https://www.pwg.org/ipp</a>),
RFC 8011 (<a href="https://datatracker.ietf.org/doc/html/rfc8011">https://datatracker.ietf.org/doc/html/rfc8011</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright &copy; 2021-2022 by OpenPrinting.

</body>
</html>

${this.title}

Code Editor : man-ipptoolfile.html