Skip to content

Commit 17316a3

Browse files
committed
Update documentation for new URI content validation predicates (Issue #22)
1 parent 4697a86 commit 17316a3

8 files changed

Lines changed: 216 additions & 182 deletions

File tree

CHANGES.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,9 @@ libcups v3.0b1 (Month DD, YYYY)
2222
- Added a roll to the default color ippeveprinter printer.
2323
- Added new DNS-SD API (Issue #19)
2424
- Added new PWG media sizes.
25-
- Added new `EXPECT-ALL-VALUES-FROM` predicate for ipptool files (Issue #20)
25+
- Added new `WITH-ALL-VALUES-FROM` predicate for ipptool files (Issue #20)
26+
- Added new `SAVE-ALL-CONTENT`, `WITH-ALL-CONTENT`, and `WITH-ALL-MIME-TYPES`
27+
predicates for ipptool files (Issue #22)
2628
- Added, modernized, and promoted the localization interfaces to public API
2729
(Issue #24)
2830
- Added public JSON API (Issue #31)

doc/ippevepcl.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
text-align: justify;
1717
}
1818
--></style>
19-
<meta name="creator" content="mantohtml v2.0">
19+
<meta name="creator" content="mantohtml v2022.1005">
2020
<title>Documentation</title>
2121
</head>
2222
<body>
@@ -47,7 +47,7 @@ <h2 id="ippevepclps-7.description">Description</h2>
4747
Status and progress messages are sent to the standard error.
4848
</p>
4949
<p><strong>ippevepcl</strong>
50-
prints to B&amp;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.
50+
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.
5151
</p>
5252
<p><strong>ippeveps</strong>
5353
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.

doc/ippeveprinter.html

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
text-align: justify;
1717
}
1818
--></style>
19-
<meta name="creator" content="mantohtml v2.0">
19+
<meta name="creator" content="mantohtml v2022.1005">
2020
<title>Documentation</title>
2121
</head>
2222
<body>
@@ -113,7 +113,7 @@ <h2 id="ippeveprinter-1.options">Options</h2>
113113
</p>
114114
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>--pam-service </strong><em>service</em><br>
115115
Set the PAM service name.
116-
The default service is &quot;cups&quot;.
116+
The default service is "cups".
117117
</p>
118118
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>--version</strong><br>
119119
Show the CUPS version.
@@ -128,25 +128,25 @@ <h2 id="ippeveprinter-1.options">Options</h2>
128128
</p>
129129
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>-D </strong><em>device-uri</em><br>
130130
Set the device URI for print output.
131-
The URI can be a filename, directory, or a network socket URI of the form &quot;socket://ADDRESS[:PORT]&quot; (where the default port number is 9100).
131+
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).
132132
When specifying a directory,
133133
<strong>ippeveprinter</strong>
134134
will create an output file using the job ID and name.
135135
</p>
136136
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>-F </strong><em>output-type/subtype[,...]</em><br>
137137
Specifies the output MIME media type.
138-
The default is &quot;application/postscript&quot; when the <strong>-P</strong> option is specified.
138+
The default is "application/postscript" when the <strong>-P</strong> option is specified.
139139
</p>
140140
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>-M </strong><em>manufacturer</em><br>
141141
Set the manufacturer of the printer.
142-
The default is &quot;Example&quot;.
142+
The default is "Example".
143143
</p>
144144
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>-P </strong><em>filename.ppd</em><br>
145145
Load printer attributes from the specified PPD file.
146146
This option is typically used in conjunction with the
147147
<strong>ippeveps</strong>(7)
148148

149-
printer command (&quot;-c ippeveps&quot;).
149+
printer command ("-c ippeveps").
150150
</p>
151151
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>-V 1.1</strong><br>
152152
</p>
@@ -156,13 +156,13 @@ <h2 id="ippeveprinter-1.options">Options</h2>
156156
</p>
157157
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>-c </strong><em>command</em><br>
158158
Run the specified command for each document that is printed.
159-
If &quot;command&quot; is not an absolute path (&quot;/path/to/command&quot;),
159+
If "command" is not an absolute path ("/path/to/command"),
160160
<strong>ippeveprinter</strong>
161-
looks for the command in the &quot;command&quot; subdirectory of the CUPS binary directory, typically /usr/lib/cups/command or /usr/libexec/cups/command.
161+
looks for the command in the "command" subdirectory of the CUPS binary directory, typically /usr/lib/cups/command or /usr/libexec/cups/command.
162162
The
163163
<strong>cups-config</strong>(1)
164164

165-
command can be used to discover the correct binary directory (&quot;cups-config --serverbin&quot;).
165+
command can be used to discover the correct binary directory ("cups-config --serverbin").
166166
In addition, the CUPS_SERVERBIN environment variable can be used to override the default location of this directory - see the
167167
<strong>cups</strong>(1)
168168

@@ -190,7 +190,7 @@ <h2 id="ippeveprinter-1.options">Options</h2>
190190
</p>
191191
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>-m </strong><em>model</em><br>
192192
Specifies the model name of the printer.
193-
The default is &quot;Printer&quot;.
193+
The default is "Printer".
194194
</p>
195195
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>-n </strong><em>hostname</em><br>
196196
Specifies the hostname that is reported by the server.
@@ -209,12 +209,12 @@ <h2 id="ippeveprinter-1.options">Options</h2>
209209
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>-r </strong><em>subtype[,subtype]</em><br>
210210
Specifies the DNS-SD subtype(s) to advertise.
211211
Separate multiple subtypes with a comma.
212-
The default is &quot;_print&quot;.
212+
The default is "_print".
213213
</p>
214214
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>-s </strong><em>speed[,color-speed]</em><br>
215215
Specifies the printer speed in pages per minute.
216216
If two numbers are specified and the second number is greater than zero, the server will report support for color printing.
217-
The default is &quot;10,0&quot;.
217+
The default is "10,0".
218218
</p>
219219
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>-v[vvv]</strong><br>
220220
Be (very) verbose when logging activity to standard error.
@@ -234,17 +234,17 @@ <h2 id="ippeveprinter-1.conforming-to">Conforming To</h2>
234234
</p>
235235
<h2 id="ippeveprinter-1.environment">Environment</h2>
236236
<p><strong>ippeveprinter</strong>
237-
adds environment variables starting with &quot;IPP_&quot; for all IPP Job attributes in the print request.
238-
For example, when executing a command for an IPP Job containing the &quot;media&quot; Job Template attribute, the &quot;IPP_MEDIA&quot; environment variable will be set to the value of that attribute.
237+
adds environment variables starting with "IPP_" for all IPP Job attributes in the print request.
238+
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.
239239
</p>
240-
<p>In addition, all IPP &quot;xxx-default&quot; and &quot;pwg-xxx&quot; Printer Description attributes are added to the environment.
241-
For example, the &quot;IPP_MEDIA_DEFAULT&quot; environment variable will be set to the default value for the &quot;media&quot; Job Template attribute.
240+
<p>In addition, all IPP "xxx-default" and "pwg-xxx" Printer Description attributes are added to the environment.
241+
For example, the "IPP_MEDIA_DEFAULT" environment variable will be set to the default value for the "media" Job Template attribute.
242242
</p>
243243
<p>Enumerated values are converted to their keyword equivalents.
244-
For example, a &quot;print-quality&quot; Job Template attribute with a enum value of 3 will become the &quot;IPP_PRINT_QUALITY&quot; environment variable with a value of &quot;draft&quot;.
245-
This string conversion only happens for standard Job Template attributes, currently &quot;finishings&quot;, &quot;orientation-requested&quot;, and &quot;print-quality&quot;.
244+
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".
245+
This string conversion only happens for standard Job Template attributes, currently "finishings", "orientation-requested", and "print-quality".
246246
</p>
247-
<p>Finally, the &quot;CONTENT_TYPE&quot; environment variable contains the MIME media type of the document being printed, the &quot;DEVICE_URI&quot; environment variable contains the device URI as specified with the &quot;-D&quot; option, the &quot;OUTPUT_FORMAT&quot; environment variable contains the output MIME media type, and the &quot;PPD&quot; environment variable contains the PPD filename as specified with the &quot;-P&quot; option.
247+
<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, the "OUTPUT_FORMAT" environment variable contains the output MIME media type, and the "PPD" environment variable contains the PPD filename as specified with the "-P" option.
248248
</p>
249249
<h2 id="ippeveprinter-1.command-output">Command Output</h2>
250250
<p>Unless they communicate directly with a printer, print commands send printer-ready data to the standard output.
@@ -255,41 +255,41 @@ <h2 id="ippeveprinter-1.command-output">Command Output</h2>
255255
</p>
256256
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>ATTR: </strong><em>attribute=value[ attribute=value]</em><br>
257257
Sets the named attribute(s) to the given values.
258-
Currently only the &quot;job-impressions&quot; and &quot;job-impressions-completed&quot; Job Status attributes and the &quot;marker-xxx&quot;, &quot;printer-alert&quot;, &quot;printer-alert-description&quot;, &quot;printer-supply&quot;, and &quot;printer-supply-description&quot; Printer Status attributes can be set.
258+
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.
259259
</p>
260260
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>DEBUG: </strong><em>Debugging message</em><br>
261261
Logs a debugging message if at least two -v's have been specified.
262262
</p>
263263
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>ERROR: </strong><em>Error message</em><br>
264-
Logs an error message and copies the message to the &quot;job-state-message&quot; attribute.
264+
Logs an error message and copies the message to the "job-state-message" attribute.
265265
</p>
266266
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>INFO: </strong><em>Informational message</em><br>
267-
Logs an informational/progress message if -v has been specified and copies the message to the &quot;job-state-message&quot; attribute unless an error has been reported.
267+
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.
268268
</p>
269269
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>STATE: </strong><em>keyword[,keyword,...]</em><br>
270-
Sets the printer's &quot;printer-state-reasons&quot; attribute to the listed keywords.
270+
Sets the printer's "printer-state-reasons" attribute to the listed keywords.
271271
</p>
272272
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>STATE: -</strong><em>keyword[,keyword,...]</em><br>
273-
Removes the listed keywords from the printer's &quot;printer-state-reasons&quot; attribute.
273+
Removes the listed keywords from the printer's "printer-state-reasons" attribute.
274274
</p>
275275
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>STATE: +</strong><em>keyword[,keyword,...]</em><br>
276-
Adds the listed keywords to the printer's &quot;printer-state-reasons&quot; attribute.
276+
Adds the listed keywords to the printer's "printer-state-reasons" attribute.
277277
</p>
278278
<h2 id="ippeveprinter-1.examples">Examples</h2>
279279
<p>Run
280280
<strong>ippeveprinter</strong>
281281
with a service name of My Cool Printer:
282282
</p>
283283
<pre>
284-
ippeveprinter &quot;My Cool Printer&quot;
284+
ippeveprinter "My Cool Printer"
285285
</pre>
286286
<p>Run the
287287
<strong>file</strong>(1)
288288

289289
command whenever a job is sent to the server:
290290
</p>
291291
<pre>
292-
ippeveprinter -c /usr/bin/file &quot;My Cool Printer&quot;
292+
ippeveprinter -c /usr/bin/file "My Cool Printer"
293293
</pre>
294294
<h2 id="ippeveprinter-1.see-also">See Also</h2>
295295
<p><strong>ippevepcl</strong>(7),

doc/ippfind.html

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
text-align: justify;
1717
}
1818
--></style>
19-
<meta name="creator" content="mantohtml v2.0">
19+
<meta name="creator" content="mantohtml v2022.1005">
2020
<title>Documentation</title>
2121
</head>
2222
<body>
@@ -95,7 +95,7 @@ <h3 id="ippfind-1.description.expressions">Expressions</h3>
9595
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>-l</strong><br>
9696
</p>
9797
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>--ls</strong><br>
98-
Lists attributes returned by Get-Printer-Attributes for IPP printers and traditional <em>find</em> &quot;-ls&quot; output for HTTP URLs.
98+
Lists attributes returned by Get-Printer-Attributes for IPP printers and traditional <em>find</em> "-ls" output for HTTP URLs.
9999
The result is true if the URI is accessible, false otherwise.
100100
</p>
101101
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>--local</strong><br>
@@ -161,7 +161,7 @@ <h3 id="ippfind-1.description.expressions">Expressions</h3>
161161
</p>
162162
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>--exec </strong><em>utility </em>[ <em>argument </em>... ] <strong>;</strong><br>
163163
Executes the specified program if the current result is true.
164-
&quot;{foo}&quot; arguments are replaced with the corresponding value - see SUBSTITUTIONS below.
164+
"{foo}" arguments are replaced with the corresponding value - see SUBSTITUTIONS below.
165165
</p>
166166
<p>Expressions may also contain modifiers:
167167
</p>
@@ -182,30 +182,30 @@ <h3 id="ippfind-1.description.expressions">Expressions</h3>
182182
Logical OR of expressions.
183183
</p>
184184
<h3 id="ippfind-1.description.substitutions">Substitutions</h3>
185-
<p>The substitutions for &quot;{foo}&quot; in <em>-e</em> and <em>--exec</em> are:
185+
<p>The substitutions for "{foo}" in <em>-e</em> and <em>--exec</em> are:
186186
</p>
187187
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>{service_domain}</strong><br>
188-
Domain name, e.g., &quot;example.com.&quot;, &quot;local.&quot;, etc.
188+
Domain name, e.g., "example.com.", "local.", etc.
189189
</p>
190190
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>{service_hostname}</strong><br>
191-
Fully-qualified domain name, e.g., &quot;printer.example.com.&quot;, &quot;printer.local.&quot;, etc.
191+
Fully-qualified domain name, e.g., "printer.example.com.", "printer.local.", etc.
192192
</p>
193193
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>{service_name}</strong><br>
194-
Service instance name, e.g., &quot;My Fine Printer&quot;.
194+
Service instance name, e.g., "My Fine Printer".
195195
</p>
196196
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>{service_port}</strong><br>
197197
Port number for server, typically 631 for IPP and 80 for HTTP.
198198
</p>
199199
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>{service_regtype}</strong><br>
200-
DNS-SD registration type, e.g., &quot;_ipp._tcp&quot;, &quot;_http._tcp&quot;, etc.
200+
DNS-SD registration type, e.g., "_ipp._tcp", "_http._tcp", etc.
201201
</p>
202202
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>{service_scheme}</strong><br>
203-
URI scheme for DNS-SD registration type, e.g., &quot;ipp&quot;, &quot;http&quot;, etc.
203+
URI scheme for DNS-SD registration type, e.g., "ipp", "http", etc.
204204
</p>
205205
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>{}</strong><br>
206206
</p>
207207
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>{service_uri}</strong><br>
208-
URI for service, e.g., &quot;ipp://printer.local./ipp/print&quot;, &quot;<a href="http://printer.local./&quot;">http://printer.local./&quot;</a>, etc.
208+
URI for service, e.g., "ipp://printer.local./ipp/print", "<a href="http://printer.local./&quot;">http://printer.local./&quot;</a>, etc.
209209
</p>
210210
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>{txt_</strong><em>key</em><strong>}</strong><br>
211211
Value of TXT record <em>key</em> (lowercase).
@@ -232,7 +232,7 @@ <h2 id="ippfind-1.options">Options</h2>
232232
</p>
233233
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>-V </strong><em>version</em><br>
234234
Specifies the IPP version when listing.
235-
Supported values are &quot;1.1&quot;, &quot;2.0&quot;, &quot;2.1&quot;, and &quot;2.2&quot;.
235+
Supported values are "1.1", "2.0", "2.1", and "2.2".
236236
</p>
237237
<h2 id="ippfind-1.exit-status">Exit Status</h2>
238238
<p><strong>ippfind</strong> returns 0 if the result for all processed expressions is true, 1 if the result of any processed expression is false, 2 if browsing or any query or resolution failed, 3 if an undefined option or invalid expression was specified, and 4 if it ran out of memory.
@@ -241,25 +241,25 @@ <h2 id="ippfind-1.environment">Environment</h2>
241241
<p>When executing a program, <strong>ippfind</strong> sets the following environment variables for the matching service registration:
242242
</p>
243243
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>IPPFIND_SERVICE_DOMAIN</strong><br>
244-
Domain name, e.g., &quot;example.com.&quot;, &quot;local.&quot;, etc.
244+
Domain name, e.g., "example.com.", "local.", etc.
245245
</p>
246246
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>IPPFIND_SERVICE_HOSTNAME</strong><br>
247-
Fully-qualified domain name, e.g., &quot;printer.example.com.&quot;, &quot;printer.local.&quot;, etc.
247+
Fully-qualified domain name, e.g., "printer.example.com.", "printer.local.", etc.
248248
</p>
249249
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>IPPFIND_SERVICE_NAME</strong><br>
250-
Service instance name, e.g., &quot;My Fine Printer&quot;.
250+
Service instance name, e.g., "My Fine Printer".
251251
</p>
252252
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>IPPFIND_SERVICE_PORT</strong><br>
253253
Port number for server, typically 631 for IPP and 80 for HTTP.
254254
</p>
255255
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>IPPFIND_SERVICE_REGTYPE</strong><br>
256-
DNS-SD registration type, e.g., &quot;_ipp._tcp&quot;, &quot;_http._tcp&quot;, etc.
256+
DNS-SD registration type, e.g., "_ipp._tcp", "_http._tcp", etc.
257257
</p>
258258
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>IPPFIND_SERVICE_SCHEME</strong><br>
259-
URI scheme for DNS-SD registration type, e.g., &quot;ipp&quot;, &quot;http&quot;, etc.
259+
URI scheme for DNS-SD registration type, e.g., "ipp", "http", etc.
260260
</p>
261261
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>IPPFIND_SERVICE_URI</strong><br>
262-
URI for service, e.g., &quot;ipp://printer.local./ipp/print&quot;, &quot;<a href="http://printer.local./&quot;">http://printer.local./&quot;</a>, etc.
262+
URI for service, e.g., "ipp://printer.local./ipp/print", "<a href="http://printer.local./&quot;">http://printer.local./&quot;</a>, etc.
263263
</p>
264264
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>IPPFIND_TXT_</strong><em>KEY</em><br>
265265
Values of TXT record <em>KEY</em> (uppercase).

0 commit comments

Comments
 (0)