نام (NAME)

ipptoolfile - قالب فایل ipptool

توضیحات (DESCRIPTION)

برنامه ipptool(1) فایل‌های متنی ساده با قالب آزاد را که یک یا چند درخواست IPP را توصیف می‌کنند، می‌پذیرد. کامنت‌ها با نویسه «#» آغاز می‌شوند و تا انتهای سطر ادامه دارند. هر درخواست درون آکولاد قرار می‌گیرد، به عنوان مثال:

# این یک کامنت است
{
  # نام آزمون
  NAME "Print PDF File"
  # درخواستی که ارسال می‌شود
  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 از سینی «main»
    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
  # پاسخی که مورد انتظار است
  STATUS successful-ok
  EXPECT job-id OF-TYPE integer WITH-VALUE >0
  EXPECT job-uri OF-TYPE uri
}
{
  # نام آزمون
  NAME "Wait for Job to Complete"
  # درخواستی که ارسال می‌شود
  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
  # پاسخی که مورد انتظار است
  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"
  # نمایش وضعیت کار تا زمان تکمیل...
  DISPLAY job-state
  DISPLAY job-state-reasons
}

دستورالعمل‌های سطح بالا (TOP-LEVEL DIRECTIVES)

دستورالعمل‌های زیر می‌توانند خارج از یک test استفاده شوند:

{ test }: یک آزمون را تعریف می‌کند.
DEFINE variable-name value: متغیر نام‌برده را با مقدار داده‌شده تعریف می‌کند. این معادل مشخص کردن -d variable-name=value در خط فرمان ipptool(8) است.
DEFINE-DEFAULT variable-name value: در صورتی که متغیر نام‌برده از قبل مقداری نداشته باشد، آن را با مقدار داده‌شده تعریف می‌کند.
FILE-ID "identifier": یک رشته شناسه برای فایل جاری مشخص می‌کند.
IGNORE-ERRORS yes
IGNORE-ERRORS no: مشخص می‌کند که آیا به‌طور پیش‌فرض، ipptool(8) از خطاها چشم‌پوشی کرده و آزمون‌های بعدی را ادامه دهد یا خیر.
INCLUDE "filename"
INCLUDE <filename>: فایل آزمون دیگری را درج می‌کند. شکل نخست، فایلی را به صورت نسبی نسبت به فایل آزمون جاری درج می‌کند، در حالی که شکل دوم، فایلی را از دایرکتوری include برنامه ipptool(8) درج می‌نماید.
INCLUDE-IF-DEFINED name "filename"
INCLUDE-IF-DEFINED name <filename>: در صورت تعریف بودن متغیر نام‌برده، فایل آزمون دیگری را درج می‌کند. شکل نخست، فایلی را به صورت نسبی نسبت به فایل آزمون جاری درج می‌کند، در حالی که شکل دوم، فایلی را از دایرکتوری include برنامه ipptool(8) درج می‌نماید.
INCLUDE-IF-NOT-DEFINED name "filename"
INCLUDE-IF-NOT-DEFINED name <filename>: در صورت تعریف نبودن متغیر نام‌برده، فایل آزمون دیگری را درج می‌کند. شکل نخست، فایلی را به صورت نسبی نسبت به فایل آزمون جاری درج می‌کند، در حالی که شکل دوم، فایلی را از دایرکتوری include برنامه ipptool(8) درج می‌نماید.
SKIP-IF-DEFINED variable-name
SKIP-IF-NOT-DEFINED variable-name: مشخص می‌کند که در صورت تعریف بودن یا نبودن متغیر، باقی‌مانده فایل آزمون نادیده گرفته شود.
STOP-AFTER-INCLUDE-ERROR no
STOP-AFTER-INCLUDE-ERROR yes: مشخص می‌کند که آیا آزمون‌ها پس از بروز خطا در یک فایل درج‌شده متوقف شوند یا خیر.
TRANSFER auto: مشخص می‌کند که آزمون‌ها به‌طور پیش‌فرض، برای درخواست‌های همراه با فایل ضمیمه از "Transfer-Encoding: chunked" و برای درخواست‌های بدون فایل ضمیمه از "Content-Length:" استفاده کنند.
TRANSFER chunked: مشخص می‌کند که آزمون‌ها به‌طور پیش‌فرض از سرآیند "Transfer-Encoding: chunked" در HTTP/1.1 استفاده کنند. این حالت پیش‌فرض است و معادل تعیین -c در خط فرمان ipptool(8) می‌باشد. پشتیبانی از درخواست‌های تکه‌تکه (chunked) برای سازگاری با تمامی نسخه‌های IPP الزامی است.
TRANSFER length: مشخص می‌کند که آزمون‌ها به‌طور پیش‌فرض از سرآیند "Content-Length:" در HTTP/1.0 استفاده کنند. این معادل تعیین -l در خط فرمان ipptool(8) است. پشتیبانی از درخواست‌های طول محتوا (content length) برای سازگاری با تمامی نسخه‌های IPP الزامی است.
VERSION 1.0
VERSION 1.1
VERSION 2.0
VERSION 2.1
VERSION 2.2: شماره نسخه پیش‌فرض IPP را برای استفاده در آزمون‌هایی که در ادامه می‌آیند، مشخص می‌کند.

دستورالعمل‌های آزمون (TEST DIRECTIVES)

دستورالعمل‌های زیر در درون یک test شناخته می‌شوند:

ATTR out-of-band-tag attribute-name
ATTR tag attribute-name value(s): یک مشخصه به درخواست آزمون اضافه می‌کند. برچسب‌های خارج از باند (admin-define، delete-attribute، no-value، not-settable، unknown، unsupported) فاقد مقدار هستند. مقادیر مربوط به سایر برچسب‌ها با نویسه ویرگول (",") از یکدیگر جدا می‌شوند - ویرگول‌ها را با استفاده از نویسه "\" اسکیپ کنید. مشخصه‌ها و مقادیر متداول در رجیستری IPP در IANA فهرست شده‌اند - منابع زیر را ببینید.
ATTR collection attribute-name { MEMBER tag member-name value(s) ... } [ ... ,{ ... } ]: یک مشخصه مجموعه‌ای (collection) را به درخواست آزمون اضافه می‌کند. مشخصه‌های عضو از همان ساختار نحوی مشخصه‌های عادی پیروی می‌کنند و خود می‌توانند مجموعه‌های تو در تو باشند. در صورت نیاز می‌توان چندین مقدار مجموعه را به صورت جدا شده با ویرگول ارائه داد.
COMPRESSION deflate
COMPRESSION gzip
COMPRESSION none: فشرده‌سازی مشخص‌شده را بر روی داده‌های سند که پس از مشخصه‌ها در یک درخواست Print-Job یا Send-Document می‌آیند، اعمال می‌کند.
DELAY seconds[,repeat-seconds]: تاخیری را بر حسب ثانیه پیش از اجرای این آزمون مشخص می‌کند. اگر دو مقدار مشخص شود، مقدار دوم به عنوان تاخیر میان آزمون‌های تکراری استفاده می‌شود. اگر این دستورالعمل مشخص نشود، بازه تکرار پیش‌فرض ۵ ثانیه استفاده خواهد شد.
DISPLAY attribute-name: مشخص می‌کند که مقدار مشخصه نام‌برده باید به عنوان بخشی از گزارش آزمون در خروجی نمایش داده شود.
EXPECT attribute-name [ predicate(s) ]
EXPECT ?attribute-name predicate(s)
EXPECT !attribute-name: مشخص می‌کند که پاسخ باید/می‌تواند/نباید شامل مشخصه نام‌برده باشد. الزامات اضافی را می‌توان به عنوان گزاره افزود - برای اطلاعات بیشتر در مورد گزاره‌ها، بخش «گزاره‌های EXPECT» را ببینید. نام مشخصه‌ها می‌توانند با جدا کردن نام مشخصه و نام عضو توسط یک اسلش رو به جلو، مشخصه‌های عضو را تعیین کنند؛ برای نمونه "media-col/media-size/x-dimension".
EXPECT-ALL attribute-name [ predicate(s) ]
EXPECT-ALL ?attribute-name predicate(s): مشخص می‌کند که پاسخ باید/می‌تواند شامل مشخصه نام‌برده باشد و تمام رخدادهای آن مشخصه باید با گزاره‌های داده‌شده مطابقت داشته باشند.
FILE filename: فایلی را برای گنجاندن در انتهای درخواست مشخص می‌کند. این گزینه معمولاً هنگام ارسال یک فایل آزمایشی چاپ استفاده می‌شود.
GROUP tag: برچسب گروه را برای مشخصه‌های بعدی در درخواست مشخص می‌کند.
IGNORE-ERRORS yes
IGNORE-ERRORS no: مشخص می‌کند که آیا ipptool(8) از خطاها چشم‌پوشی کرده و آزمون‌های بعدی را ادامه دهد یا خیر.
MONITOR-PRINTER-STATE [ printer-uri ] { EXPECT attribute-name [ predicate(s) ] }: آزمون‌های نظارت بر وضعیت چاپگر را برای اجرا به صورت موازی با عملیات آزمون مشخص می‌کند. آزمون‌های نظارت تا زمانی اجرا خواهند شد که تمام شرایط EXPECT برآورده شوند یا عملیات آزمون اصلی تکمیل گردد، هر کدام که زودتر رخ دهد.
NAME "literal string": نام خوانا برای انسانِ آزمون را مشخص می‌کند.
OPERATION operation-code: عملیاتی را که باید انجام شود مشخص می‌کند.
PASS-IF-DEFINED variable-name
PASS-IF-NOT-DEFINED variable-name: مشخص می‌کند که در صورت تعریف بودن یا نبودن متغیر، آزمون جاری باید به طور خودکار پذیرفته (pass) شود.
PAUSE "message": پیام ارائه‌شده را نمایش داده و منتظر می‌ماند تا کاربر کلیدی را برای ادامه فشار دهد.
REQUEST-ID number
REQUEST-ID random: مقدار request-id مورد استفاده در درخواست را مشخص می‌کند؛ که می‌تواند یک عدد صحیح یا کلمه "random" برای استفاده از یک مقدار تولیدشده به صورت تصادفی (پیش‌فرض) باشد.
RESOURCE path: یک مسیر منبع جایگزین را مشخص می‌کند که برای درخواست HTTP POST استفاده می‌شود. حالت پیش‌فرض، منبعِ به دست آمده از URI ارائه‌شده به برنامه ipptool(8) است.
SKIP-IF-DEFINED variable-name
SKIP-IF-NOT-DEFINED variable-name: مشخص می‌کند که در صورت تعریف بودن یا نبودن متغیر، از آزمون جاری صرف‌نظر شود.
SKIP-PREVIOUS-ERROR yes
SKIP-PREVIOUS-ERROR no: مشخص می‌کند که آیا در صورت بروز خطا/شکست در آزمون پیشین، ipptool(8) از آزمون جاری صرف‌نظر کند یا خیر.
STATUS status-code [ predicate ]: یک مقدار کد وضعیت مورد انتظار در پاسخ را مشخص می‌کند. الزامات تکمیلی را می‌توان به عنوان گزاره اضافه کرد - برای اطلاعات بیشتر در مورد گزاره‌ها، بخش «گزاره‌های STATUS» را ببینید.
TEST-ID "identifier": یک رشته شناسه را برای آزمون جاری مشخص می‌کند.
TRANSFER auto: مشخص می‌کند که این آزمون در صورت داشتن فایل ضمیمه از "Transfer-Encoding: chunked" و در غیر این صورت از "Content-Length:" استفاده خواهد کرد.
TRANSFER chunked: مشخص می‌کند که این آزمون از سرآیند "Transfer-Encoding: chunked" در HTTP/1.1 استفاده خواهد کرد.
TRANSFER length: مشخص می‌کند که این آزمون از سرآیند "Content-Length:" در HTTP/1.0 استفاده خواهد کرد.
VERSION 1.0
VERSION 1.1
VERSION 2.0
VERSION 2.1
VERSION 2.2: شماره نسخه IPP مورد استفاده برای این آزمون را مشخص می‌کند.

گزاره‌های EXPECT (EXPECT PREDICATES)

گزاره‌های زیر پس از دستورالعمل آزمون EXPECT شناخته می‌شوند:

COUNT number: ایجاب می‌کند که مشخصه EXPECT دارای تعداد مقادیر مشخص‌شده باشد.
DEFINE-MATCH variable-name: هنگامی که شرط EXPECT مطابقت داشته باشد، متغیر را به "1" تعریف می‌کند. یکی از آثار جانبی این گزاره این است که این EXPECT هرگز موجب شکست آزمون نخواهد شد.
DEFINE-NO-MATCH variable-name: هنگامی که شرط EXPECT مطابقت نداشته باشد، متغیر را به "1" تعریف می‌کند. یکی از آثار جانبی این گزاره این است که این EXPECT هرگز موجب شکست آزمون نخواهد شد.
DEFINE-VALUE variable-name: هنگامی که شرط EXPECT مطابقت داشته باشد، متغیر را با مقدار مشخصه تعریف می‌کند. یکی از آثار جانبی این گزاره این است که این EXPECT هرگز موجب شکست آزمون نخواهد شد.
DISPLAY-MATCH "message": هنگامی که شرط EXPECT مطابقت داشته باشد، پیام مشخص‌شده را نمایش می‌دهد.
IF-DEFINED variable-name: باعث می‌شود که شرایط EXPECT تنها در صورت تعریف بودن متغیر مشخص‌شده اعمال شوند.
IF-NOT-DEFINED variable-name: باعث می‌شود که شرایط EXPECT تنها در صورت تعریف نبودن متغیر مشخص‌شده اعمال شوند.
IN-GROUP tag: ایجاب می‌کند که مشخصه EXPECT در برچسب گروه مشخص‌شده قرار داشته باشد.
OF-TYPE tag[(limits)|tag|...]: ایجاب می‌کند که مشخصه EXPECT از یکی از برچسب‌های مقدار مشخص‌شده استفاده کند. اکثر برچسب‌های مقدار همچنین از تعیین محدودیت‌ها درون پرانتز پشتیبانی می‌کنند؛ برای نمونه "name(42)" به رشته‌های nameWith/WithoutLanguage تا حداکثر ۴۲ بایت طول اجازه می‌دهد، "name(4:MAX)" به رشته‌های nameWith/WithoutLanguage با طول بین ۴ تا ۲۵۵ بایت اجازه می‌دهد، و "integer(-273:MAX)" به اعداد صحیح بین ‎-۲۷۳ تا ۲۱۴۷۴۸۳۶۴۷ اجازه می‌دهد.
REPEAT-LIMIT number: حداکثر تعداد دفعات تکرار را در صورت مشخص شدن گزاره REPEAT-MATCH یا REPEAT-NO-MATCH تعیین می‌کند. مقدار پیش‌فرض ۱۰۰۰ است.
REPEAT-MATCH
REPEAT-NO-MATCH: مشخص می‌کند که آزمون جاری در صورت تطابق یا عدم تطابق شرط EXPECT باید تکرار شود.
SAME-COUNT-AS attribute-name: ایجاب می‌کند که مشخصه EXPECT همان تعداد مقادیر مشخصه موازی مشخص‌شده را داشته باشد.
WITH-ALL-HOSTNAMES "literal string"
WITH-ALL-HOSTNAMES "/regular expression/": ایجاب می‌کند که تمام مقادیر URI حاوی یک نام میزبان منطبق باشند.
WITH-ALL-RESOURCES "literal string"
WITH-ALL-RESOURCES "/regular expression/": ایجاب می‌کند که تمام مقادیر URI حاوی یک منبع منطبق (شامل / ابتدایی) باشند.
WITH-ALL-SCHEMES "literal string"
WITH-ALL-SCHEMES "/regular expression/": ایجاب می‌کند که تمام مقادیر URI حاوی یک طرحواره (scheme) منطبق باشند.
WITH-ALL-VALUES "literal string": ایجاب می‌کند که تمام مقادیر مشخصه EXPECT با رشته حرفی داده‌شده مطابقت داشته باشند. مقایسه‌ها حساس به حروف کوچک و بزرگ هستند.
WITH-ALL-VALUES <number
WITH-ALL-VALUES =number
WITH-ALL-VALUES >number
WITH-ALL-VALUES number[,...,number]: ایجاب می‌کند که تمام مقادیر مشخصه EXPECT با عدد (یا اعداد) یا مقایسه عددی مطابقت داشته باشند. هنگام مقایسه مقادیر rangeOfInteger، عملگرهای «<» و «>» فقط کران بالای بازه را بررسی می‌کنند.
WITH-ALL-VALUES "false"
WITH-ALL-VALUES "true": ایجاب می‌کند که تمام مقادیر مشخصه EXPECT با مقدار بولی داده‌شده مطابقت داشته باشند.
WITH-ALL-VALUES "/regular expression/": ایجاب می‌کند که تمام مقادیر مشخصه EXPECT با عبارت باقاعده مطابقت داشته باشند؛ این عبارت باید از ساختار نحوی عبارات باقاعده POSIX پیروی کند. مقایسه‌ها به حروف بزرگ و کوچک حساس هستند.
WITH-DISTINCT-VALUES: ایجاب می‌کند که تمام مقادیر مشخصه EXPECT یکتا و بدون تکرار باشند. مقایسه‌ها به حروف بزرگ و کوچک حساس هستند. تنها مشخصه‌های charset، collection، enum، integer، keyword، mimeMediaType، naturalLanguage، rangeOfInteger، resolution و uriScheme از این گزاره پشتیبانی می‌کنند.
WITH-HOSTNAME "literal string"
WITH-HOSTNAME "/regular expression/": ایجاب می‌کند که دست‌کم یکی از مقادیر URI حاوی یک نام میزبان منطبق باشد.
WITH-RESOURCE "literal string"
WITH-RESOURCE "/regular expression/": ایجاب می‌کند که دست‌کم یکی از مقادیر URI حاوی یک منبع منطبق (شامل / ابتدایی) باشد.
WITH-SCHEME "literal string"
WITH-SCHEME "/regular expression/": ایجاب می‌کند که دست‌کم یکی از مقادیر URI حاوی یک طرحواره منطبق باشد.
WITH-VALUE "literal string": ایجاب می‌کند که دست‌کم یکی از مقادیر مشخصه EXPECT با رشته حرفی داده‌شده مطابقت داشته باشد. مقایسه‌ها به حروف بزرگ و کوچک حساس هستند.
WITH-VALUE <number
WITH-VALUE =number
WITH-VALUE >number
WITH-VALUE number[,...,number]: ایجاب می‌کند که دست‌کم یکی از مقادیر مشخصه EXPECT با عدد (یا اعداد) یا مقایسه عددی مطابقت داشته باشد. هنگام مقایسه مقادیر rangeOfInteger، عملگرهای «<» و «>» فقط کران بالای بازه را بررسی می‌کنند.
WITH-VALUE "false"
WITH-VALUE "true": ایجاب می‌کند که دست‌کم یکی از مقادیر مشخصه EXPECT با مقدار بولی داده‌شده مطابقت داشته باشد.
WITH-VALUE "/regular expression/": ایجاب می‌کند که دست‌کم یکی از مقادیر مشخصه EXPECT با عبارت باقاعده مطابقت داشته باشد؛ این عبارت باید از ساختار نحوی عبارات باقاعده POSIX پیروی کند. مقایسه‌ها به حروف بزرگ و کوچک حساس هستند.
WITH-VALUE-FROM attribute-name: ایجاب می‌کند که مقدار (یا مقادیر) مشخصه EXPECT با مقدار (یا مقادیر) موجود در مشخصه تعیین‌شده مطابقت داشته باشد. برای نمونه، دستور "EXPECT job-sheets WITH-VALUE-FROM job-sheets-supported" ایجاب می‌کند که مقدار "job-sheets" به عنوان مقداری از مشخصه "job-sheets-supported" فهرست شده باشد.

گزاره‌های STATUS (STATUS PREDICATES)

گزاره‌های زیر پس از دستورالعمل آزمون STATUS شناخته می‌شوند:

DEFINE-MATCH variable-name: هنگامی که STATUS مطابقت داشته باشد، متغیر را به "1" تعریف می‌کند. یکی از آثار جانبی این گزاره این است که این STATUS هرگز موجب شکست آزمون نخواهد شد.
DEFINE-NO-MATCH variable-name: هنگامی که STATUS مطابقت نداشته باشد، متغیر را به "1" تعریف می‌کند. یکی از آثار جانبی این گزاره این است که این STATUS هرگز موجب شکست آزمون نخواهد شد.
IF-DEFINED variable-name: باعث می‌شود که STATUS تنها در صورت تعریف بودن متغیر مشخص‌شده اعمال شود.
IF-NOT-DEFINED variable-name: باعث می‌شود که STATUS تنها در صورت تعریف نبودن متغیر مشخص‌شده اعمال شود.
REPEAT-LIMIT number: حداکثر تعداد دفعات تکرار را مشخص می‌کند. مقدار پیش‌فرض ۱۰۰۰ است.
REPEAT-MATCH
REPEAT-NO-MATCH: مشخص می‌کند که در صورت مطابقت یا عدم مطابقت کد وضعیت پاسخ با مقدار تعیین‌شده توسط دستورالعمل STATUS، آزمون جاری باید تکرار شود.

کدهای عملیات (OPERATION CODES)

کدهای عملیات متناظر با اعداد هگزادسیمال (0xHHHH) و نام‌های برگرفته از RFC 8011 و سایر مشخصات الحاقی IPP هستند. در اینجا فهرست کاملی از نام‌های پشتیبانی‌شده توسط ipptool(8) آمده است:

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

کدهای وضعیت (STATUS CODES)

کدهای وضعیت متناظر با اعداد هگزادسیمال (0xHHHH) و نام‌های برگرفته از RFC 8011 و سایر مشخصات الحاقی IPP هستند. در اینجا فهرست کاملی از نام‌های پشتیبانی‌شده توسط ipptool(8) آمده است:

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

برچسب‌ها (TAGS)

برچسب‌های مقدار و گروه متناظر با نام‌های برگرفته از RFC 8011 و سایر مشخصات الحاقی IPP هستند. در اینجا برچسب‌های گروه آورده شده‌اند:

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

در اینجا برچسب‌های مقدار آورده شده‌اند:

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

متغیرها (VARIABLES)

برنامه ipptool(8) فهرستی از متغیرها را نگهداری می‌کند که می‌توان با تعیین "$variable-name" در هر رشته حرفی یا مقدار مشخصه از آن‌ها استفاده کرد. به غیر از متغیرهای تعریف‌شده با گزینه -d یا دستورالعمل DEFINE ، متغیرهای از پیش تعریف‌شده زیر در دسترس هستند:

$$: یک نویسه تک «$» درج می‌کند.
$ENV[name]: مقدار متغیر محیطی نام‌برده را درج می‌کند، یا در صورت تعریف نبودن متغیر محیطی، یک رشته خالی درج می‌نماید.
$date-current: تاریخ و زمان جاری را با استفاده از قالب ISO-8601 ("yyyy-mm-ddThh:mm:ssZ") درج می‌کند.
$date-start: تاریخ و زمان شروع را با استفاده از قالب ISO-8601 ("yyyy-mm-ddThh:mm:ssZ") درج می‌کند.
$filename: نام فایل ارائه‌شده به ipptool(8) با گزینه -f را درج می‌کند.
$filetype: نوع رسانه MIME را برای نام فایل ارائه‌شده به ipptool(8) با گزینه -f درج می‌کند.
$hostname: نام میزبان را از URI ارائه‌شده به ipptool(8) درج می‌کند.
$job-id: آخرین مقدار مشخصه "job-id" بازگردانده‌شده در پاسخ آزمون، یا در صورت مشاهده نشدن مشخصه "job-id"، مقدار 0 را درج می‌کند.
$job-uri: آخرین مقدار مشخصه "job-uri" بازگردانده‌شده در پاسخ آزمون، یا در صورت مشاهده نشدن مشخصه "job-uri"، یک رشته خالی درج می‌کند.
$notify-subscription-id: آخرین مقدار مشخصه "notify-subscription-id" بازگردانده‌شده در پاسخ آزمون، یا در صورت مشاهده نشدن مشخصه "notify-subscription-id"، مقدار 0 را درج می‌کند.
$port: شماره درگاه (port) را از URI ارائه‌شده به ipptool(8) درج می‌کند.
$resource: مسیر منبع را از URI ارائه‌شده به ipptool(8) درج می‌کند.
$scheme: طرحواره (scheme) را از URI ارائه‌شده به ipptool(8) درج می‌کند.
$uri: نشانی URI ارائه‌شده به ipptool(8) را درج می‌کند.
$uriuser: نام کاربری را از URI ارائه‌شده به ipptool(8) (در صورت وجود) درج می‌کند.
$user: نام ورود به سیستمِ کاربر جاری را درج می‌کند.

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

ipptool(1), 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)

حق نشر (COPYRIGHT)

CUPS	2021-09-20