نام (NAME)

ipptool - اجرای درخواست‌های پروتکل چاپ اینترنتی (IPP)

خلاصه دستور (SYNOPSIS)

ipptool [ --help ] [ --ippserver filename ] [ --stop-after-include-error ] [ --version ] [ -4 ] [ -6 ] [ -C ] [ -E ] [ -I ] [ -L ] [ -P filename.plist ] [ -S ] [ -T seconds ] [ -V version ] [ -X ] [ -c ] [ -d name=value ] [ -f filename ] [ -h ] [ -i seconds ] [ -j ] [ -n repeat-count ] [ -q ] [ -t ] [ -v ] printer-uri testfile [ ... testfile ]

توضیحات (DESCRIPTION)

دستور ipptool درخواست‌های IPP را به printer-uri مشخص‌شده ارسال کرده و نتایج را آزمایش و/یا نمایش می‌دهد. هر testfile نام‌برده، یک یا چند درخواست را به همراه وضعیت پاسخ مورد انتظار، ویژگی‌ها (attributes) و مقادیر تعریف می‌کند. خروجی می‌تواند گزارشی به صورت متن ساده، متن قالب‌بندی‌شده، CSV یا XML در خروجی استاندارد باشد، و وضعیت خروج غیرصفر نشان‌دهنده شکست یک یا چند آزمایش است. قالب testfile در ipptoolfile(5) شرح داده شده است.

گزینه‌ها (OPTIONS)

گزینه‌های زیر توسط ipptool شناسایی می‌شوند:

--help: راهنمای برنامه را نمایش می‌دهد.
--ippserver filename: مشخص می‌کند که نتایج آزمایش باید در فایل ویژگی‌های (attributes) ippserver نام‌برده نوشته شوند.
--stop-after-include-error: به ipptool اعلام می‌کند در صورت وقوع خطا در یک فایل گنجانده‌شده (included)، متوقف شود. در حالت عادی ipptool پس از دستورالعمل INCLUDE با آزمایش‌های بعدی ادامه می‌دهد.
--version: نسخه در حال استفاده از ipptool را نمایش می‌دهد.
-4: مشخص می‌کند که ipptool باید با استفاده از IPv4 به چاپگر یا سرور متصل شود.
-6: مشخص می‌کند که ipptool باید با استفاده از IPv6 به چاپگر یا سرور متصل شود.
-C: مشخص می‌کند که درخواست‌ها باید با استفاده از هدر HTTP/1.1 با مقدار "Transfer-Encoding: chunked" ارسال شوند، که برای انطباق در تمامی نسخه‌های IPP الزامی است. حالت پیش‌فرض برای درخواست‌های دارای فایل پیوست، استفاده از "Transfer-Encoding: chunked" و برای درخواست‌های بدون فایل پیوست، استفاده از "Content-Length:" است.
-E: هنگام اتصال به سرور با استفاده از هدر HTTP با عنوان "Upgrade"، رمزنگاری TLS را اجباری می‌کند.
-I: مشخص می‌کند که ipptool با وجود خطاها به کار خود ادامه دهد.
-L: مشخص می‌کند که درخواست‌ها باید با استفاده از هدر HTTP/1.0 با مقدار "Content-Length:" ارسال شوند، که برای انطباق در تمامی نسخه‌های IPP الزامی است. حالت پیش‌فرض برای درخواست‌های دارای فایل پیوست، استفاده از "Transfer-Encoding: chunked" و برای درخواست‌های بدون فایل پیوست، استفاده از "Content-Length:" است.
-P filename.plist: مشخص می‌کند که نتایج آزمایش علاوه بر گزارش آزمایشی معمول (-t)، باید در فایل XML (Apple plist) نام‌برده نیز نوشته شود. این گزینه با گزینه‌های -i (فاصله زمانی) و -n (تعداد تکرار) ناسازگار است.
-S: رمزنگاری اختصاصی TLS را هنگام اتصال به سرور اجباری می‌کند.
-T seconds: مهلت زمانی (تایم‌اوت) درخواست‌های IPP را بر حسب ثانیه مشخص می‌کند.
-V version: نسخه پیش‌فرض IPP مورد استفاده را تعیین می‌کند: 1.0، 1.1، 2.0، 2.1 یا 2.2. اگر مشخص نشود، از نسخه 1.1 استفاده می‌شود.
-X: مشخص می‌کند که خروجی XML (Apple plist) به‌جای گزارش متنی ساده مد نظر است. این گزینه با گزینه‌های -i (فاصله زمانی) و -n (تعداد تکرار) ناسازگار است.
-c: مشخص می‌کند که خروجی CSV (مقادیر جداشده با کاما) به‌جای خروجی متنی ساده مد نظر است.
-d name=value: متغیر نام‌برده را تعریف می‌کند.
-f filename: نام فایل پیش‌فرض درخواست را برای آزمایش‌ها تعریف می‌کند.
-h: اعتبارسنجی هدرهای پاسخ HTTP.
-i seconds: مشخص می‌کند که (آخرین) testfile باید در فاصله زمانی مشخص‌شده تکرار شود. این گزینه با گزینه -X (خروجی XML plist) ناسازگار است.
-j: مشخص می‌کند که ipptool خروجی JSON تولید خواهد کرد.
-l: مشخص می‌کند که خروجی متنی ساده مورد نظر است.
-n repeat-count: مشخص می‌کند که (آخرین) testfile باید به تعداد دفعات مشخص‌شده تکرار شود. این گزینه با گزینه -X (خروجی XML plist) ناسازگار است.
-q: بی‌صدا کار کند و هیچ خروجی تولید نکند.
-t: مشخص می‌کند که خروجی گزارش آزمایشی CUPS به‌جای خروجی متنی ساده مورد نظر است.
-v: مشخص می‌کند که تمامی ویژگی‌های (attributes) درخواست و پاسخ باید در حالت آزمایشی CUPS (-t) در خروجی درج شوند. این حالت پیش‌فرض برای خروجی XML است.

وضعیت خروج (EXIT STATUS)

برنامه ipptool در صورت موفقیت‌آمیز بودن تمام آزمایش‌ها مقدار 0 و در غیر این صورت مقدار 1 را برمی‌گرداند.

فایل‌ها (FILES)

فایل‌های استاندارد زیر در دسترس هستند:

color.jpg
create-printer-subscription.test
document-a4.pdf
document-a4.ps
document-letter.pdf
document-letter.ps
get-completed-jobs.test
get-jobs.test
get-notifications.test
get-printer-attributes.test
get-subscriptions.test
gray.jpg
ipp-1.1.test
ipp-2.0.test
ipp-2.1.test
ipp-2.2.test
ipp-everywhere.test
onepage-a4.pdf
onepage-a4.ps
onepage-letter.pdf
onepage-letter.ps
print-job.test
print-job-deflate.test
print-job-gzip.test
testfile.jpg
testfile.pcl
testfile.pdf
testfile.ps
testfile.txt
validate-job.test

سازگاری با استانداردها (CONFORMING TO)

برنامه ipptool منحصراً متعلق به CUPS است و تا نسخه 2.2 با پروتکل چاپ اینترنتی (Internet Printing Protocol) سازگاری دارد.

مثال‌ها (EXAMPLES)

دریافت فهرستی از کارهای تکمیل‌شده برای «myprinter»:

ipptool ipp://localhost/printers/myprinter get-completed-jobs.test

ارسال اعلان‌های ایمیل به «user@example.com» هنگام تغییر در «myprinter»:

ipptool -d recipient=mailto:user@example.com \
    ipp://localhost/printers/myprinter create-printer-subscription.test

همچنین ببینید (SEE ALSO)

ipptoolfile(5), ثبت‌نام‌های IPP در IANA (https://www.iana.org/assignments/ipp-registrations), کارگروه پروتکل چاپ اینترنتی PWG (https://www.pwg.org/ipp), RFC 8011 (https://datatracker.ietf.org/doc/html/rfc8011)