/
niceSOFT
/
cups
Обзор
Документация
Войти
/
niceSOFT
/
cups
Код
Задачи
Вики
Пакеты
0
Релизы
0
Аналитика
Безопасность
master
man/ipptool.1
317 строк
10 KB
Michael R Sweet
Add a --user-agent option to the ipptool command.
18 сен 2025, 18:14
Не верифицирован
18 сен 2025, 18:14
23dec7f
Код
Авторство
О чём код?
.\" .\" ipptool man page. .\" .\" Copyright © 2021-2025 by OpenPrinting. .\" Copyright © 2010-2019 by Apple Inc. .\" .\" Licensed under Apache License v2.0. See the file "LICENSE" for more .\" information. .\" .TH ipptool 1 "CUPS" "2025-09-18" "OpenPrinting" .SH NAME ipptool \- perform internet printing protocol requests .SH SYNOPSIS .B ipptool [ .B \-\-help ] [ .B \-\-bearer\-token .I BEARER-TOKEN ] [ .B \-\-client\-name .I CLIENT-NAME ] [ .B \-\-ippfile .I FILENAME ] [ .B \-\-stop\-after\-include\-error ] [ .B \-\-user\-agent .I USER-AGENT ] [ .B \-\-version ] [ .B \-4 ] [ .B \-6 ] [ .B \-c ] [ .B \-C ] [ .B \-d .I NAME=VALUE ] [ .B \-E ] [ .B \-f .I FILENAME ] [ .B \-h ] [ .B \-i .I SECONDS ] [ .B \-I ] [ .B \-j ] [ .B \-L ] [ .B \-n .I REPEAT-COUNT ] [ .B \-P .I FILENAME.plist ] [ .B \-q ] [ .B \-R ] [ .B \-S ] [ .B \-t ] [ .B \-T .I SECONDS ] [ .B \-v ] [ .B \-V .I VERSION ] [ .B \-X ] .I PRINTER-URI .I TESTFILE [ ... .I TESTFILE ] .SH DESCRIPTION .B ipptool sends IPP requests to the specified .I printer-uri and tests and/or displays the results. Each named .I testfile defines one or more requests, including the expected response status, attributes, and values. Output is either a plain text, formatted text, CSV, JSON, or XML report on the standard output, with a non-zero exit status indicating that one or more tests have failed. The .I testfile format is described in .BR ipptoolfile (5). .SH OPTIONS The following options are recognized by .B ipptool: .TP 5 \fB\-\-bearer\-token \fIBEARER-TOKEN\fR Specifies the OAuth 2.0 token to use for HTTP Bearer authentication (RFC 6750). .TP 5 \fB\-\-client\-name \fICLIENT-NAME\fR Specifies the client name to use for the TLS client certificate. If not specified, no client certificate is used during negotiation. .TP 5 .B \-\-help Shows program help. .TP 5 \fB\-\-ippfile \fIFILENAME\fR Specifies that the test results should be written to the named IPP file. These files can be used with programs like .BR ippeveprinter (1). .TP 5 .B \-\-stop-after-include-error Tells .B ipptool to stop if an error occurs in an included file. Normally .B ipptool will continue with subsequent tests after the INCLUDE directive. .TP 5 \fB\-\-user\-agent \fIUSER-AGENT\fR Specifies the HTTP User-Agent string to use. The default is based on the .B UserAgentTokens value in the .BR client.conf (5) file. .TP 5 .B \-\-version Shows the version of .B ipptool being used. .TP 5 .B \-4 Specifies that .B ipptool must connect to the printer or server using IPv4. .TP 5 .B \-6 Specifies that .B ipptool must connect to the printer or server using IPv6. .TP 5 .B \-c Specifies that CSV (comma\-separated values) output is desired instead of the plain text output. .TP 5 .B \-C Specifies that requests should be sent using the HTTP/1.1 "Transfer\-Encoding: chunked" header, which is required for conformance by all versions of IPP. The default is to use "Transfer\-Encoding: chunked" for requests with attached files and "Content\-Length:" for requests without attached files. .TP 5 .BI \-d \ NAME=VALUE Defines the named variable. .TP 5 .B \-E Forces TLS encryption when connecting to the server using the HTTP "Upgrade" header. .TP 5 .BI \-f \ FILENAME Defines the default request filename for tests. .TP 5 .B \-h Validate HTTP response headers. .TP 5 .BI \-i \ SECONDS Specifies that the (last) .I testfile should be repeated at the specified interval. This option is incompatible with the \fB\-\-ippfile\fR (IPP file output) and \fI\-P\fR or \fB\-X\fR (XML plist output) options. .TP 5 .B \-I Specifies that .B ipptool will continue past errors. .TP 5 .B \-j Specifies that .B ipptool will produce JSON output. .TP 5 .B \-l Specifies that plain text output is desired. .TP 5 .B \-L Specifies that requests should be sent using the HTTP/1.0 "Content\-Length:" header, which is required for conformance by all versions of IPP. The default is to use "Transfer\-Encoding: chunked" for requests with attached files and "Content\-Length:" for requests without attached files. .TP 5 .BI \-n \ REPEAT\-COUNT Specifies that the (last) .I testfile should be repeated the specified number of times. This option is incompatible with the \fI\-\-ippfile\fR (IPP file output) and \fI\-P\fR or \fI\-X\fR (XML plist output) options. .TP 5 .BI \-P \ FILENAME.plist Specifies that the test results should be written to the named XML (Apple plist) file in addition to the regular test report (\fB\-t\fR). This option is incompatible with the \fB\-i\fR (interval) and \fB\-n\fR (repeat-count) options. .TP 5 .B \-q Be quiet and produce no output. .TP 5 .B \-S Forces (dedicated) TLS encryption when connecting to the server. .TP 5 .B \-t Specifies that CUPS test report output is desired instead of the plain text output. .TP 5 .BI \-T \ SECONDS Specifies a timeout for IPP requests in SECONDS. .TP 5 .B \-v Specifies that all request and response attributes should be output in CUPS test mode (\fB\-t\fR). This is the default for CSV, JSON, and XML output. .TP 5 .BI \-V \ VERSION Specifies the default IPP version to use: 1.0, 1.1, 2.0, 2.1, or 2.2. If not specified, version 1.1 is used. .TP 5 .B \-X Specifies that XML (Apple plist) output is desired instead of the plain text report. This option is incompatible with the \fB\-i\fR (interval) and \fB\-n\fR (repeat\-count) options. .SH EXIT STATUS The .B ipptool program returns 0 if all tests were successful and 1 otherwise. .SH FILES The following standard test files are available: .nf cancel\-current\-job.test - Cancel the current job create\-job.test - Create a job and send a document create\-job\-sheets.test - "" with banner create\-job\-timeout.test - "" with timeout create\-printer\-subscription.test - Create a printer subscription cups\-create\-local\-printer.test - Create a local print queue fax\-job.test - Fax a file (for fax queues) get\-completed\-jobs.test - Get a list of completed jobs get\-job\-attributes.test - Get attributes for a job get\-job\-template\-attributes.test - Get job ticket attributes for a printer get\-jobs.test - Get a list of not-completed jobs get\-notifications.test - Get notifications for a subscription get\-printer\-attributes.test - Get attributes for a printer get\-printer\-attributes\-suite.test - Test Get-Printer-Attributes conformance get\-printers.test - Get a list of printers get\-subscriptions.test - Get a list of subscriptions identify\-printer.test - Identify a printer identify\-printer\-display.test - Identify a printer via the display ipp\-1.1.test - Run IPP/1.1 conformance tests ipp\-2.0.test - Run IPP/2.0 conformance tests ipp\-2.1.test - Run IPP/2.1 conformance tests ipp\-2.2.test - Run IPP/2.2 conformance tests print\-job.test - Print a file print\-job\-and\-wait.test - Print a file and wait for completion print\-job\-deflate.test - Print a file with deflate compression print\-job\-gzip.test - Print a file with gzip compression print\-job\-hold.test - Print a file and hold print\-job\-letter.test - Print a file on US Letter media print\-job\-manual.test - Print a file with manual feed print\-job\-media\-col.test - Print a file using "media-col" print\-job\-media\-needed.test - Print a file and test for "media-needed" print\-job\-password.test - Print a file with a password/PIN print\-job\-raster.test - Print a generated raster file print\-uri.test - Print a URI/URL set\-attrs\-hold.test - Test setting job-hold-until to hold a job validate\-job.test - Validate a job ticket .fi .PP The following standard document files are available: .nf color.jpg - A color photo of a flower document\-a4.pdf - A 4-page A4 PDF document document\-a4.ps - A 4-page A4 PostScript document document\-letter.pdf - A 4-page US Letter PDF document document\-letter.ps - A 4-page US Letter PostScript document gray.jpg - A grayscale photo of an Alcatraz doorway onepage\-a4\-300\-black\-1.pwg - A one page A4 PWG Raster document onepage\-a4.pdf - A one page A4 PDF document onepage\-a4.ps - A one page A4 PostScript document onepage\-letter\-300\-black\-1.pwg - A one page US Letter PWG Raster document onepage\-letter.pdf - A one page US Letter PDF document onepage\-letter.ps - A one page US Letter PostScript document testfile.jpg - A color photo collage testfile.pcl - A HP-PCL homage to "The Shining" testfile.pdf - A historical CUPS PDF document testfile.ps - A historical CUPS PostScript document testfile.txt - A plain text homage to "The Shining" .fi .SH CONFORMING TO The .B ipptool program is unique to CUPS and conforms to the Internet Printing Protocol up to version 2.2. .SH EXAMPLES Get a list of completed jobs for "myprinter": .nf ipptool ipp://localhost/printers/myprinter get\-completed\-jobs.test .fi .LP Send email notifications to "user@example.com" when "myprinter" changes: .nf ipptool \-d recipient=mailto:user@example.com \\ ipp://localhost/printers/myprinter create\-printer\-subscription.test .fi .SH SEE ALSO .BR client.conf (5), .BR ipptoolfile (5), IANA IPP Registry (https://www.iana.org/assignments/ipp\-registrations), PWG Internet Printing Protocol Workgroup (https://www.pwg.org/ipp), RFC 8011 (https://datatracker.ietf.org/doc/html/rfc8011) .SH COPYRIGHT Copyright \[co] 2021-2025 by OpenPrinting.