.\"
.\" ipptoolfile man page.
.\"
.\" Copyright © 2020-2024 by OpenPrinting.
.\" Copyright © 2010-2021 by Apple Inc.
.\"
.\" Licensed under Apache License v2.0.  See the file "LICENSE" for more
.\" information.
.\"
.TH ipptoolfile 5 "CUPS" "2021-09-20" "OpenPrinting"
.SH "نام (NAME)"
ipptoolfile \- قالب فایل ipptool
.SH "توضیحات (DESCRIPTION)"
برنامه
.BR ipptool (1)
فایل‌های متنی ساده با قالب آزاد را که یک یا چند درخواست IPP را توصیف می‌کنند، می‌پذیرد.
کامنت‌ها با نویسه «#» آغاز می‌شوند و تا انتهای سطر ادامه دارند.
هر درخواست درون آکولاد قرار می‌گیرد، به عنوان مثال:
.nf

    # این یک کامنت است
    {
      # نام آزمون
      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
    }
.fi
.SS "دستورالعمل‌های سطح بالا (TOP-LEVEL DIRECTIVES)"
دستورالعمل‌های زیر می‌توانند خارج از یک
\fItest\fR
استفاده شوند:
.TP 5
\fB{ \fItest \fB}\fR
یک آزمون را تعریف می‌کند.
.TP 5
\fBDEFINE \fIvariable-name value\fR
متغیر نام‌برده را با مقدار داده‌شده تعریف می‌کند. این معادل مشخص کردن
\fI\-d variable-name=value\fR
در خط فرمان
.BR ipptool (8)
است.
.TP 5
\fBDEFINE\-DEFAULT \fIvariable-name value\fR
در صورتی که متغیر نام‌برده از قبل مقداری نداشته باشد، آن را با مقدار داده‌شده تعریف می‌کند.
.TP 5
\fBFILE\-ID "\fIidentifier\fB"\fR
یک رشته شناسه برای فایل جاری مشخص می‌کند.
.TP 5
\fBIGNORE\-ERRORS yes\fR
.TP 5
\fBIGNORE\-ERRORS no\fR
مشخص می‌کند که آیا به‌طور پیش‌فرض،
.BR ipptool (8)
از خطاها چشم‌پوشی کرده و آزمون‌های بعدی را ادامه دهد یا خیر.
.TP 5
\fBINCLUDE "\fIfilename\fB"\fR
.TP 5
\fBINCLUDE <\fIfilename\fB>\fR
فایل آزمون دیگری را درج می‌کند. شکل نخست، فایلی را به صورت نسبی نسبت به فایل آزمون جاری درج می‌کند، در حالی که شکل دوم، فایلی را از دایرکتوری include برنامه
.BR ipptool (8)
درج می‌نماید.
.TP 5
\fBINCLUDE\-IF\-DEFINED \fIname \fB"\fIfilename\fB"\fR
.TP 5
\fBINCLUDE\-IF\-DEFINED \fIname \fB<\fIfilename\fB>\fR
در صورت تعریف بودن متغیر نام‌برده، فایل آزمون دیگری را درج می‌کند. شکل نخست، فایلی را به صورت نسبی نسبت به فایل آزمون جاری درج می‌کند، در حالی که شکل دوم، فایلی را از دایرکتوری include برنامه
.BR ipptool (8)
درج می‌نماید.
.TP 5
\fBINCLUDE\-IF\-NOT\-DEFINED \fIname \fB"\fIfilename\fB"\fR
.TP 5
\fBINCLUDE\-IF\-NOT\-DEFINED \fIname \fB<\fIfilename\fB>\fR
در صورت تعریف نبودن متغیر نام‌برده، فایل آزمون دیگری را درج می‌کند. شکل نخست، فایلی را به صورت نسبی نسبت به فایل آزمون جاری درج می‌کند، در حالی که شکل دوم، فایلی را از دایرکتوری include برنامه
.BR ipptool (8)
درج می‌نماید.
.TP 5
\fBSKIP\-IF\-DEFINED \fIvariable-name\fR
.TP 5
\fBSKIP\-IF\-NOT\-DEFINED \fIvariable-name\fR
مشخص می‌کند که در صورت تعریف بودن یا نبودن متغیر، باقی‌مانده فایل آزمون نادیده گرفته شود.
.TP 5
\fBSTOP\-AFTER\-INCLUDE\-ERROR no\fR
.TP 5
\fBSTOP\-AFTER\-INCLUDE\-ERROR yes\fR
مشخص می‌کند که آیا آزمون‌ها پس از بروز خطا در یک فایل درج‌شده متوقف شوند یا خیر.
.TP 5
\fBTRANSFER auto\fR
مشخص می‌کند که آزمون‌ها به‌طور پیش‌فرض، برای درخواست‌های همراه با فایل ضمیمه از "Transfer-Encoding: chunked" و برای درخواست‌های بدون فایل ضمیمه از "Content-Length:" استفاده کنند.
.TP 5
\fBTRANSFER chunked\fR
مشخص می‌کند که آزمون‌ها به‌طور پیش‌فرض از سرآیند "Transfer-Encoding: chunked" در HTTP/1.1 استفاده کنند. این حالت پیش‌فرض است و معادل تعیین
\fI\-c\fR
در خط فرمان
.BR ipptool (8)
می‌باشد. پشتیبانی از درخواست‌های تکه‌تکه (chunked) برای سازگاری با تمامی نسخه‌های IPP الزامی است.
.TP 5
\fBTRANSFER length\fR
مشخص می‌کند که آزمون‌ها به‌طور پیش‌فرض از سرآیند "Content-Length:" در HTTP/1.0 استفاده کنند. این معادل تعیین
\fI\-l\fR
در خط فرمان
.BR ipptool (8)
است. پشتیبانی از درخواست‌های طول محتوا (content length) برای سازگاری با تمامی نسخه‌های IPP الزامی است.
.TP 5
\fBVERSION 1.0\fR
.TP 5
\fBVERSION 1.1\fR
.TP 5
\fBVERSION 2.0\fR
.TP 5
\fBVERSION 2.1\fR
.TP 5
\fBVERSION 2.2\fR
شماره نسخه پیش‌فرض IPP را برای استفاده در آزمون‌هایی که در ادامه می‌آیند، مشخص می‌کند.
.SS "دستورالعمل‌های آزمون (TEST DIRECTIVES)"
دستورالعمل‌های زیر در درون یک
\fItest\fR
شناخته می‌شوند:
.TP 5
\fBATTR \fIout-of-band-tag attribute-name\fR
.TP 5
\fBATTR \fItag attribute-name value(s)\fR
یک مشخصه به درخواست آزمون اضافه می‌کند.
برچسب‌های خارج از باند (admin-define، delete-attribute، no-value، not-settable، unknown، unsupported) فاقد مقدار هستند.
مقادیر مربوط به سایر برچسب‌ها با نویسه ویرگول (",") از یکدیگر جدا می‌شوند - ویرگول‌ها را با استفاده از نویسه "\\" اسکیپ کنید.
مشخصه‌ها و مقادیر متداول در رجیستری IPP در IANA فهرست شده‌اند - منابع زیر را ببینید.
.TP 5
\fBATTR collection \fIattribute-name \fB{ MEMBER \fItag member-name value(s) ... \fB}\fR [ \fI... \fB,{ \fI... \fB} \fR]
یک مشخصه مجموعه‌ای (collection) را به درخواست آزمون اضافه می‌کند.
مشخصه‌های عضو از همان ساختار نحوی مشخصه‌های عادی پیروی می‌کنند و خود می‌توانند مجموعه‌های تو در تو باشند.
در صورت نیاز می‌توان چندین مقدار مجموعه را به صورت جدا شده با ویرگول ارائه داد.
.TP 5
\fBCOMPRESSION deflate\fR
.TP 5
\fBCOMPRESSION gzip\fR
.TP 5
\fBCOMPRESSION none\fR
فشرده‌سازی مشخص‌شده را بر روی داده‌های سند که پس از مشخصه‌ها در یک درخواست Print-Job یا Send-Document می‌آیند، اعمال می‌کند.
.TP 5
\fBDELAY \fIseconds\fR[\fI,repeat-seconds\fR]
تاخیری را بر حسب ثانیه پیش از اجرای این آزمون مشخص می‌کند.
اگر دو مقدار مشخص شود، مقدار دوم به عنوان تاخیر میان آزمون‌های تکراری استفاده می‌شود.
اگر این دستورالعمل مشخص نشود، بازه تکرار پیش‌فرض ۵ ثانیه استفاده خواهد شد.
.TP 5
\fBDISPLAY \fIattribute-name\fR
مشخص می‌کند که مقدار مشخصه نام‌برده باید به عنوان بخشی از گزارش آزمون در خروجی نمایش داده شود.
.TP 5
\fBEXPECT \fIattribute-name \fR[ \fIpredicate(s) \fR]
.TP 5
\fBEXPECT ?\fIattribute-name predicate(s)\fR
.TP 5
\fBEXPECT !\fIattribute-name\fR
مشخص می‌کند که پاسخ باید/می‌تواند/نباید شامل مشخصه نام‌برده باشد. الزامات اضافی را می‌توان به عنوان گزاره افزود - برای اطلاعات بیشتر در مورد گزاره‌ها، بخش «گزاره‌های EXPECT» را ببینید. نام مشخصه‌ها می‌توانند با جدا کردن نام مشخصه و نام عضو توسط یک اسلش رو به جلو، مشخصه‌های عضو را تعیین کنند؛ برای نمونه "media\-col/media\-size/x\-dimension".
.TP 5
\fBEXPECT-ALL \fIattribute-name \fR[ \fIpredicate(s) \fR]
.TP 5
\fBEXPECT-ALL ?\fIattribute-name predicate(s)\fR
مشخص می‌کند که پاسخ باید/می‌تواند شامل مشخصه نام‌برده باشد و تمام رخدادهای آن مشخصه باید با گزاره‌های داده‌شده مطابقت داشته باشند.
.TP 5
\fBFILE filename\fR
فایلی را برای گنجاندن در انتهای درخواست مشخص می‌کند. این گزینه معمولاً هنگام ارسال یک فایل آزمایشی چاپ استفاده می‌شود.
.TP 5
\fBGROUP tag\fR
برچسب گروه را برای مشخصه‌های بعدی در درخواست مشخص می‌کند.
.TP 5
\fBIGNORE\-ERRORS yes\fR
.TP 5
\fBIGNORE\-ERRORS no\fR
مشخص می‌کند که آیا
.BR ipptool (8)
از خطاها چشم‌پوشی کرده و آزمون‌های بعدی را ادامه دهد یا خیر.
.TP 5
\fBMONITOR-PRINTER-STATE \fR[ \fIprinter-uri \fR] \fB{ EXPECT \fIattribute-name \fR[ \fIpredicate(s) \fR] \fB}\fR
آزمون‌های نظارت بر وضعیت چاپگر را برای اجرا به صورت موازی با عملیات آزمون مشخص می‌کند.
آزمون‌های نظارت تا زمانی اجرا خواهند شد که تمام شرایط
\fBEXPECT\fR
برآورده شوند یا عملیات آزمون اصلی تکمیل گردد، هر کدام که زودتر رخ دهد.
.TP 5
\fBNAME "\fIliteral string\fB"\fR
نام خوانا برای انسانِ آزمون را مشخص می‌کند.
.TP 5
\fBOPERATION \fIoperation-code\fR
عملیاتی را که باید انجام شود مشخص می‌کند.
.TP 5
\fBPASS\-IF\-DEFINED \fIvariable-name\fR
.TP 5
\fBPASS\-IF\-NOT\-DEFINED \fIvariable-name\fR
مشخص می‌کند که در صورت تعریف بودن یا نبودن متغیر، آزمون جاری باید به طور خودکار پذیرفته (pass) شود.
.TP 5
\fBPAUSE "\fImessage\fB"\fR
پیام ارائه‌شده را نمایش داده و منتظر می‌ماند تا کاربر کلیدی را برای ادامه فشار دهد.
.TP 5
\fBREQUEST\-ID \fInumber\fR\fR
.TP 5
\fBREQUEST\-ID random\fR
مقدار request-id مورد استفاده در درخواست را مشخص می‌کند؛ که می‌تواند یک عدد صحیح یا کلمه "random" برای استفاده از یک مقدار تولیدشده به صورت تصادفی (پیش‌فرض) باشد.
.TP 5
\fBRESOURCE \fIpath\fR
یک مسیر منبع جایگزین را مشخص می‌کند که برای درخواست HTTP POST استفاده می‌شود. حالت پیش‌فرض، منبعِ به دست آمده از URI ارائه‌شده به برنامه
.BR ipptool (8)
است.
.TP 5
\fBSKIP\-IF\-DEFINED \fIvariable-name\fR
.TP 5
\fBSKIP\-IF\-NOT\-DEFINED \fIvariable-name\fR
مشخص می‌کند که در صورت تعریف بودن یا نبودن متغیر، از آزمون جاری صرف‌نظر شود.
.TP 5
\fBSKIP\-PREVIOUS\-ERROR yes\fR
.TP 5
\fBSKIP\-PREVIOUS\-ERROR no\fR
مشخص می‌کند که آیا در صورت بروز خطا/شکست در آزمون پیشین،
.BR ipptool (8)
از آزمون جاری صرف‌نظر کند یا خیر.
.TP 5
\fBSTATUS \fIstatus-code \fR[ \fIpredicate\fR ]
یک مقدار کد وضعیت مورد انتظار در پاسخ را مشخص می‌کند. الزامات تکمیلی را می‌توان به عنوان گزاره اضافه کرد - برای اطلاعات بیشتر در مورد گزاره‌ها، بخش «گزاره‌های STATUS» را ببینید.
.TP 5
\fBTEST\-ID "\fIidentifier\fR"
یک رشته شناسه را برای آزمون جاری مشخص می‌کند.
.TP 5
\fBTRANSFER auto\fR
مشخص می‌کند که این آزمون در صورت داشتن فایل ضمیمه از "Transfer-Encoding: chunked" و در غیر این صورت از "Content-Length:" استفاده خواهد کرد.
.TP 5
\fBTRANSFER chunked\fR
مشخص می‌کند که این آزمون از سرآیند "Transfer-Encoding: chunked" در HTTP/1.1 استفاده خواهد کرد.
.TP 5
\fBTRANSFER length\fR
مشخص می‌کند که این آزمون از سرآیند "Content-Length:" در HTTP/1.0 استفاده خواهد کرد.
.TP 5
\fBVERSION 1.0\fR
.TP 5
\fBVERSION 1.1\fR
.TP 5
\fBVERSION 2.0\fR
.TP 5
\fBVERSION 2.1\fR
.TP 5
\fBVERSION 2.2\fR
شماره نسخه IPP مورد استفاده برای این آزمون را مشخص می‌کند.
.SS "گزاره‌های EXPECT (EXPECT PREDICATES)"
گزاره‌های زیر پس از دستورالعمل آزمون
\fBEXPECT\fR
شناخته می‌شوند:
.TP 5
\fBCOUNT \fInumber\fR
ایجاب می‌کند که مشخصه
\fBEXPECT\fR
دارای تعداد مقادیر مشخص‌شده باشد.
.TP 5
\fBDEFINE\-MATCH \fIvariable-name\fR
هنگامی که شرط
\fBEXPECT\fR
مطابقت داشته باشد، متغیر را به "1" تعریف می‌کند. یکی از آثار جانبی این گزاره این است که این
\fBEXPECT\fR
هرگز موجب شکست آزمون نخواهد شد.
.TP 5
\fBDEFINE\-NO\-MATCH \fIvariable-name\fR
هنگامی که شرط
\fBEXPECT\fR
مطابقت نداشته باشد، متغیر را به "1" تعریف می‌کند. یکی از آثار جانبی این گزاره این است که این
\fBEXPECT\fR
هرگز موجب شکست آزمون نخواهد شد.
.TP 5
\fBDEFINE\-VALUE \fIvariable-name\fR
هنگامی که شرط
\fBEXPECT\fR
مطابقت داشته باشد، متغیر را با مقدار مشخصه تعریف می‌کند. یکی از آثار جانبی این گزاره این است که این
\fBEXPECT\fR
هرگز موجب شکست آزمون نخواهد شد.
.TP 5
\fBDISPLAY\-MATCH \fI"message"\fR
هنگامی که شرط
\fBEXPECT\fR
مطابقت داشته باشد، پیام مشخص‌شده را نمایش می‌دهد.
.TP 5
\fBIF\-DEFINED \fIvariable-name\fR
باعث می‌شود که شرایط
\fBEXPECT\fR
تنها در صورت تعریف بودن متغیر مشخص‌شده اعمال شوند.
.TP 5
\fBIF\-NOT\-DEFINED \fIvariable-name\fR
باعث می‌شود که شرایط
\fBEXPECT\fR
تنها در صورت تعریف نبودن متغیر مشخص‌شده اعمال شوند.
.TP 5
\fBIN\-GROUP \fItag\fR
ایجاب می‌کند که مشخصه
\fBEXPECT\fR
در برچسب گروه مشخص‌شده قرار داشته باشد.
.TP 5
\fBOF\-TYPE \fItag[(limits)|tag|...]\fR
ایجاب می‌کند که مشخصه
\fBEXPECT\fR
از یکی از برچسب‌های مقدار مشخص‌شده استفاده کند. اکثر برچسب‌های مقدار همچنین از تعیین محدودیت‌ها درون پرانتز پشتیبانی می‌کنند؛ برای نمونه "name(42)" به رشته‌های nameWith/WithoutLanguage تا حداکثر ۴۲ بایت طول اجازه می‌دهد، "name(4:MAX)" به رشته‌های nameWith/WithoutLanguage با طول بین ۴ تا ۲۵۵ بایت اجازه می‌دهد، و "integer(-273:MAX)" به اعداد صحیح بین ‎-۲۷۳ تا ۲۱۴۷۴۸۳۶۴۷ اجازه می‌دهد.
.TP 5
\fBREPEAT\-LIMIT \fInumber\fR
.br
حداکثر تعداد دفعات تکرار را در صورت مشخص شدن گزاره
\fBREPEAT-MATCH\fR
یا
\fBREPEAT-NO-MATCH\fR
تعیین می‌کند. مقدار پیش‌فرض ۱۰۰۰ است.
.TP 5
\fBREPEAT\-MATCH\fR
.TP 5
\fBREPEAT\-NO\-MATCH\fR
مشخص می‌کند که آزمون جاری در صورت تطابق یا عدم تطابق شرط
\fBEXPECT\fR
باید تکرار شود.
.TP 5
\fBSAME\-COUNT\-AS \fIattribute-name\fR
ایجاب می‌کند که مشخصه
\fBEXPECT\fR
همان تعداد مقادیر مشخصه موازی مشخص‌شده را داشته باشد.
.TP 5
\fBWITH\-ALL\-HOSTNAMES "\fIliteral string\fB"\fR
.TP 5
\fBWITH\-ALL\-HOSTNAMES "/\fIregular expression\fB/"\fR
ایجاب می‌کند که تمام مقادیر URI حاوی یک نام میزبان منطبق باشند.
.TP 5
\fBWITH\-ALL\-RESOURCES "\fIliteral string\fB"\fR
.TP 5
\fBWITH\-ALL\-RESOURCES "/\fIregular expression\fB/"\fR
ایجاب می‌کند که تمام مقادیر URI حاوی یک منبع منطبق (شامل / ابتدایی) باشند.
.TP 5
\fBWITH\-ALL\-SCHEMES "\fIliteral string\fB"\fR
.TP 5
\fBWITH\-ALL-SCHEMES "/\fIregular expression\fB/"\fR
ایجاب می‌کند که تمام مقادیر URI حاوی یک طرحواره (scheme) منطبق باشند.
.TP 5
\fBWITH\-ALL\-VALUES "\fIliteral string\fB"\fR
ایجاب می‌کند که تمام مقادیر مشخصه
\fBEXPECT\fR
با رشته حرفی داده‌شده مطابقت داشته باشند. مقایسه‌ها حساس به حروف کوچک و بزرگ هستند.
.TP 5
\fBWITH\-ALL\-VALUES <\fInumber\fR
.TP 5
\fBWITH\-ALL\-VALUES =\fInumber\fR
.TP 5
\fBWITH\-ALL\-VALUES >\fInumber\fR
.TP 5
\fBWITH\-ALL\-VALUES \fInumber\fR[\fI,...,number\fR]
ایجاب می‌کند که تمام مقادیر مشخصه
\fBEXPECT\fR
با عدد (یا اعداد) یا مقایسه عددی مطابقت داشته باشند. هنگام مقایسه مقادیر rangeOfInteger، عملگرهای «<» و «>» فقط کران بالای بازه را بررسی می‌کنند.
.TP 5
\fBWITH\-ALL\-VALUES "false"\fR
.TP 5
\fBWITH\-ALL\-VALUES "true"\fR
ایجاب می‌کند که تمام مقادیر مشخصه
\fBEXPECT\fR
با مقدار بولی داده‌شده مطابقت داشته باشند.
.TP 5
\fBWITH\-ALL\-VALUES "/\fIregular expression\fB/"\fR
ایجاب می‌کند که تمام مقادیر مشخصه
\fBEXPECT\fR
با عبارت باقاعده مطابقت داشته باشند؛ این عبارت باید از ساختار نحوی عبارات باقاعده POSIX پیروی کند. مقایسه‌ها به حروف بزرگ و کوچک حساس هستند.
.TP 5
\fBWITH\-DISTINCT\-VALUES\fR
ایجاب می‌کند که تمام مقادیر مشخصه
\fBEXPECT\fR
یکتا و بدون تکرار باشند. مقایسه‌ها به حروف بزرگ و کوچک حساس هستند. تنها مشخصه‌های charset، collection، enum، integer، keyword، mimeMediaType، naturalLanguage، rangeOfInteger، resolution و uriScheme از این گزاره پشتیبانی می‌کنند.
.TP 5
\fBWITH\-HOSTNAME "\fIliteral string\fB"\fR
.TP 5
\fBWITH\-HOSTNAME "/\fIregular expression\fB/"\fR
ایجاب می‌کند که دست‌کم یکی از مقادیر URI حاوی یک نام میزبان منطبق باشد.
.TP 5
\fBWITH\-RESOURCE "\fIliteral string\fB"\fR
.TP 5
\fBWITH\-RESOURCE "/\fIregular expression\fB/"\fR
ایجاب می‌کند که دست‌کم یکی از مقادیر URI حاوی یک منبع منطبق (شامل / ابتدایی) باشد.
.TP 5
\fBWITH\-SCHEME "\fIliteral string\fB"\fR
.TP 5
\fBWITH\-SCHEME "/\fIregular expression\fB/"\fR
ایجاب می‌کند که دست‌کم یکی از مقادیر URI حاوی یک طرحواره منطبق باشد.
.TP 5
\fBWITH\-VALUE "\fIliteral string\fB"\fR
ایجاب می‌کند که دست‌کم یکی از مقادیر مشخصه
\fBEXPECT\fR
با رشته حرفی داده‌شده مطابقت داشته باشد. مقایسه‌ها به حروف بزرگ و کوچک حساس هستند.
.TP 5
\fBWITH\-VALUE <\fInumber\fR
.TP 5
\fBWITH\-VALUE =\fInumber\fR
.TP 5
\fBWITH\-VALUE >\fInumber\fR
.TP 5
\fBWITH\-VALUE \fInumber\fR[\fI,...,number\fR]
ایجاب می‌کند که دست‌کم یکی از مقادیر مشخصه
\fBEXPECT\fR
با عدد (یا اعداد) یا مقایسه عددی مطابقت داشته باشد. هنگام مقایسه مقادیر rangeOfInteger، عملگرهای «<» و «>» فقط کران بالای بازه را بررسی می‌کنند.
.TP 5
\fBWITH\-VALUE "false"\fR
.TP 5
\fBWITH\-VALUE "true"\fR
ایجاب می‌کند که دست‌کم یکی از مقادیر مشخصه
\fBEXPECT\fR
با مقدار بولی داده‌شده مطابقت داشته باشد.
.TP 5
\fBWITH\-VALUE "/\fIregular expression\fB/"\fR
ایجاب می‌کند که دست‌کم یکی از مقادیر مشخصه
\fBEXPECT\fR
با عبارت باقاعده مطابقت داشته باشد؛ این عبارت باید از ساختار نحوی عبارات باقاعده POSIX پیروی کند. مقایسه‌ها به حروف بزرگ و کوچک حساس هستند.
.TP 5
\fBWITH\-VALUE\-FROM \fIattribute-name\fR
ایجاب می‌کند که مقدار (یا مقادیر) مشخصه
\fBEXPECT\fR
با مقدار (یا مقادیر) موجود در مشخصه تعیین‌شده مطابقت داشته باشد. برای نمونه، دستور "EXPECT job\-sheets WITH\-VALUE\-FROM job\-sheets\-supported" ایجاب می‌کند که مقدار "job\-sheets" به عنوان مقداری از مشخصه "job\-sheets\-supported" فهرست شده باشد.
.SS "گزاره‌های STATUS (STATUS PREDICATES)"
گزاره‌های زیر پس از دستورالعمل آزمون
\fBSTATUS\fR
شناخته می‌شوند:
.TP 5
\fBDEFINE\-MATCH \fIvariable-name\fR
هنگامی که
\fBSTATUS\fR
مطابقت داشته باشد، متغیر را به "1" تعریف می‌کند. یکی از آثار جانبی این گزاره این است که این
\fBSTATUS\fR
هرگز موجب شکست آزمون نخواهد شد.
.TP 5
\fBDEFINE\-NO\-MATCH \fIvariable-name\fR
هنگامی که
\fBSTATUS\fR
مطابقت نداشته باشد، متغیر را به "1" تعریف می‌کند. یکی از آثار جانبی این گزاره این است که این
\fBSTATUS\fR
هرگز موجب شکست آزمون نخواهد شد.
.TP 5
\fBIF\-DEFINED \fIvariable-name\fR
باعث می‌شود که
\fBSTATUS\fR
تنها در صورت تعریف بودن متغیر مشخص‌شده اعمال شود.
.TP 5
\fBIF\-NOT\-DEFINED \fIvariable-name\fR
باعث می‌شود که
\fBSTATUS\fR
تنها در صورت تعریف نبودن متغیر مشخص‌شده اعمال شود.
.TP 5
\fBREPEAT\-LIMIT \fInumber\fR
.br
حداکثر تعداد دفعات تکرار را مشخص می‌کند. مقدار پیش‌فرض ۱۰۰۰ است.
.TP 5
\fBREPEAT\-MATCH\fR
.TP 5
\fBREPEAT\-NO\-MATCH\fR
مشخص می‌کند که در صورت مطابقت یا عدم مطابقت کد وضعیت پاسخ با مقدار تعیین‌شده توسط دستورالعمل STATUS، آزمون جاری باید تکرار شود.
.SS "کدهای عملیات (OPERATION CODES)"
کدهای عملیات متناظر با اعداد هگزادسیمال (0xHHHH) و نام‌های برگرفته از RFC 8011 و سایر مشخصات الحاقی IPP هستند. در اینجا فهرست کاملی از نام‌های پشتیبانی‌شده توسط
.BR ipptool (8)
آمده است:
.nf

    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
.fi
.SS "کدهای وضعیت (STATUS CODES)"
کدهای وضعیت متناظر با اعداد هگزادسیمال (0xHHHH) و نام‌های برگرفته از RFC 8011 و سایر مشخصات الحاقی IPP هستند. در اینجا فهرست کاملی از نام‌های پشتیبانی‌شده توسط
.BR ipptool (8)
آمده است:
.nf

    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
.fi
.SS "برچسب‌ها (TAGS)"
برچسب‌های مقدار و گروه متناظر با نام‌های برگرفته از RFC 8011 و سایر مشخصات الحاقی IPP هستند. در اینجا برچسب‌های گروه آورده شده‌اند:
.nf

    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
.fi
.LP
در اینجا برچسب‌های مقدار آورده شده‌اند:
.nf

    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
.fi
.SS "متغیرها (VARIABLES)"
برنامه
.BR ipptool (8)
فهرستی از متغیرها را نگهداری می‌کند که می‌توان با تعیین "\fI$variable-name\fR" در هر رشته حرفی یا مقدار مشخصه از آن‌ها استفاده کرد. به غیر از متغیرهای تعریف‌شده با گزینه
\fI-d\fR
یا دستورالعمل
\fBDEFINE\fR
، متغیرهای از پیش تعریف‌شده زیر در دسترس هستند:
.TP 5
\fB$$\fR
یک نویسه تک «$» درج می‌کند.
.TP 5
\fB$ENV[\fIname\fB]\fR
مقدار متغیر محیطی نام‌برده را درج می‌کند، یا در صورت تعریف نبودن متغیر محیطی، یک رشته خالی درج می‌نماید.
.TP 5
\fB$date-current\fR
تاریخ و زمان جاری را با استفاده از قالب ISO-8601 ("yyyy-mm-ddThh:mm:ssZ") درج می‌کند.
.TP 5
\fB$date-start\fR
تاریخ و زمان شروع را با استفاده از قالب ISO-8601 ("yyyy-mm-ddThh:mm:ssZ") درج می‌کند.
.TP 5
\fB$filename\fR
نام فایل ارائه‌شده به
.BR ipptool (8)
با گزینه
\fI-f\fR
را درج می‌کند.
.TP 5
\fB$filetype\fR
نوع رسانه MIME را برای نام فایل ارائه‌شده به
.BR ipptool (8)
با گزینه
\fI-f\fR
درج می‌کند.
.TP 5
\fB$hostname\fR
نام میزبان را از URI ارائه‌شده به
.BR ipptool (8)
درج می‌کند.
.TP 5
\fB$job\-id\fR
آخرین مقدار مشخصه "job\-id" بازگردانده‌شده در پاسخ آزمون، یا در صورت مشاهده نشدن مشخصه "job\-id"، مقدار 0 را درج می‌کند.
.TP 5
\fB$job\-uri\fR
آخرین مقدار مشخصه "job\-uri" بازگردانده‌شده در پاسخ آزمون، یا در صورت مشاهده نشدن مشخصه "job\-uri"، یک رشته خالی درج می‌کند.
.TP 5
\fB$notify\-subscription\-id\fR
آخرین مقدار مشخصه "notify\-subscription\-id" بازگردانده‌شده در پاسخ آزمون، یا در صورت مشاهده نشدن مشخصه "notify\-subscription\-id"، مقدار 0 را درج می‌کند.
.TP 5
\fB$port\fR
شماره درگاه (port) را از URI ارائه‌شده به
.BR ipptool (8)
درج می‌کند.
.TP 5
\fB$resource\fR
مسیر منبع را از URI ارائه‌شده به
.BR ipptool (8)
درج می‌کند.
.TP 5
\fB$scheme\fR
طرحواره (scheme) را از URI ارائه‌شده به
.BR ipptool (8)
درج می‌کند.
.TP 5
\fB$uri\fR
نشانی URI ارائه‌شده به
.BR ipptool (8)
را درج می‌کند.
.TP 5
\fB$uriuser\fR
نام کاربری را از URI ارائه‌شده به
.BR ipptool (8)
(در صورت وجود) درج می‌کند.
.TP 5
\fB$user\fR
نام ورود به سیستمِ کاربر جاری را درج می‌کند.
.SH "همچنین ببینید (SEE ALSO)"
.BR 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)
.SH "حق نشر (COPYRIGHT)"
Copyright \[co] 2020-2024 by OpenPrinting.