fyi(1) General Commands Manual fyi(1)

fyi - ارسال اعلان‌های میزکار

fyi [OPTION]... TITLE [MESSAGE]
fyi --close=ID
fyi --server-info
fyi --server-capabilities

fyi یک ابزار خط فرمانی برای ارسال اعلان‌های میزکار به کاربر از طریق یک دیمن اعلان پیاده‌سازی‌کنندهٔ اعلان‌های میزکار XDG است.

این ابزار شبیه به ابزار شناخته‌شدهٔ notify-send(1) است. در واقع، بیشتر گزینه‌ها یکسان هستند.

هنگامی که بدون هیچ گزینه‌ای استفاده شود، fyi اعلان را ارسال کرده و بدون چاپ هیچ چیزی در خروجی استاندارد (stdout)، بلافاصله خارج می‌شود.

از --print-id استفاده کنید تا fyi شناسهٔ اعلان تخصیص‌یافته توسط دیمن را در خروجی استاندارد و در قالب زیر چاپ کند:

id=ID

برای دیدن دلیل بسته شدن اعلان، از --print-reason استفاده کنید. دلیل در خروجی استاندارد و در قالب زیر چاپ می‌شود:

reason=REASON

fyi همچنین می‌تواند با استفاده از گزینهٔ --wait تا زمان بسته شدن اعلان متوقف (block) بماند. ارسال سیگنال SIGINT به فرایند fyi اعلان را به صورت اجباری خواهد بست.

fyi همچنین در صورتی که اعلان دارای کنش‌هایی (actions) باشد متوقف خواهد ماند. هنگامی که کنشی برانگیخته شود، fyi نام آن کنش را در خروجی استاندارد و در قالب زیر چاپ می‌کند:

action=NAME

برخی از دیمن‌های اعلان می‌توانند یک «توکن فعال‌سازی» (activation token) ارسال کنند. این کار معمولاً زمانی انجام می‌شود که کاربر روی اعلان کلیک کند یا کنش پیش‌فرض را به اجرا درآورد. این توکن می‌تواند برای فوکوس کردن (فعال‌سازی) یک پنجره استفاده شود. برای مشاهدهٔ توکن، از --print-token استفاده کنید. توکن در خروجی استاندارد و در قالب زیر چاپ می‌شود:

xdgtoken=TOKEN

-a,--app-name=NAME

نام برنامه. دیمن‌های اعلان یا آن را به عنوان متن نمایش می‌دهند، یا برای انتخاب آیکونی جهت نمایش از آن استفاده می‌کنند (مگر اینکه از --icon استفاده شده باشد). پیش‌فرض: fyi

-i,--icon=ICON

آیکون برای نمایش، یا به صورت نام نمادین آیکون (مانند firefox) یا یک نام فایل. پیش‌فرض: none

-u,--urgency=low|normal|critical

میزان فوریت اعلان. میان‌بری برای --hint=byte:urgency:0|1|2. پیش‌فرض: normal.

-c,--category=CATEGORY

دسته‌بندی اعلان. میان‌بری برای --hint=string:category:CATEGORY. پیش‌فرض: none.

-A,--action=NAME:LABEL

کنشی را برای نمایش تعریف می‌کند (برای نمونه به صورت یک دکمه یا در یک فهرست، بسته به دیمن اعلان). LABEL متنی است که دیمن اعلان برای کاربر نمایش خواهد داد. هنگامی که کاربر کنشی را اجرا کند، fyi مقدار NAME متناظر را در قالب زیر چاپ خواهد کرد:
action=NAME

این گزینه می‌تواند چندین بار مشخص شود تا چندین کنش تعریف گردند.

استفاده از این گزینه مستلزم --wait است.

-H,--hint=TYPE:NAME:VALUE

یک هینت (hint) سفارشی تعریف می‌کند. نحوهٔ تفسیر این هینت‌ها به دیمن اعلان بستگی دارد. یک کاربرد رایج، نمایش نوعی نوار پیشرفت است؛ بیشتر دیمن‌های اعلان int:value:<percent> را می‌شناسند.

هینت رایج دیگر string:x-canonical-private-synchronous:<name> است. بسیاری از دیمن‌های اعلان هر اعلان موجود با همان name را جایگزین خواهند کرد. این شبیه به --replaces است، با این تفاوت که به شناسهٔ اعلان نیازی ندارید.

fyi انواع زیر را می‌شناسد:

  • boolean
  • byte
  • int
  • double
  • string

-r,--replaces=ID

اگر اعلانی با شناسهٔ مشخص‌شده از قبل وجود داشته باشد، آن را جایگزین می‌کند. در غیر این صورت، یک اعلان جدید ایجاد می‌کند.

-t,--expire-time=TIME

اعلان پس از TIME میلی‌ثانیه به طور خودکار بسته خواهد شد.

--transient

قابلیت ماندگاری کارگزار را (در صورت وجود) دور می‌زند. میان‌بری برای --hint=boolean:transient=true.

-C,--close=ID

اگر اعلانی با شناسهٔ مشخص‌شده از قبل وجود داشته باشد، آن را می‌بندد.

-p,--print-id

شناسهٔ اعلان تخصیص‌یافته توسط دیمن را در قالب id=ID چاپ می‌کند.

-R,--print-reason

دلیل بسته شدن اعلان را در قالب زیر چاپ می‌کند:
  • reason=expired
  • reason=dismissed
  • reason=force-closed
  • reason=unknown

استفاده از این گزینه مستلزم --wait است.

-T,--print-token

توکن فعال‌سازی را (در صورت وجود) در قالب زیر چاپ می‌کند:
xdgtoken=TOKEN

برخی از دیمن‌های اعلان هنگام رد کردن اعلان یک توکن فعال‌سازی ارسال می‌کنند؛ چه زمانی که روی اعلان کلیک شود، یا کنش پیش‌فرض فراخوانی گردد. دیمن‌های دیگر صرف‌نظر از اینکه کدام کنش فراخوانی شده است آن را ارسال می‌کنند. برخی تنها زمانی که کنشی فراخوانی شود آن را می‌فرستند، در حالی که برخی دیگر هنگام رد شدن اعلان، صرف‌نظر از چگونگی آن، توکن را ارسال می‌کنند.

این توکن می‌تواند برای فوکوس کردن (فعال‌سازی، بالا آوردن) یک پنجره به کار رود. این توکن مستقیماً توسط fyi قابل استفاده نیست، اما برنامه‌هایی که از fyi به عنوان ابزار کمکی برای نمایش اعلان‌ها بهره می‌برند می‌توانند از آن استفاده کنند.

استفاده از این گزینه مستلزم --wait است.

-w,--wait

پیش از خروج، منتظر بسته شدن اعلان می‌ماند. اگر کاربر کنشی را فعال کرده باشد، نام آن کنش چاپ خواهد شد (به -A,--action مراجعه کنید).

در صورت استفاده از هر یک از گزینه‌های زیر، این گزینه به طور ضمنی فعال می‌شود:

  • -A,--action
  • -R,--print-reason
  • -T,--print-token

--image-data=FILE

هینت image-data را در اعلان با داده‌های خام پیکسل از FILE تنظیم می‌کند. فرض می‌شود داده‌ها از نوع داده‌های خام RGBA هستند. همچنین باید اندازهٔ تصویر را مشخص کنید؛ به --image-size مراجعه نمایید.

--image-size=WIDTHxHEIGHT

ابعاد تصویری که توسط --image-data بارگذاری می‌شود.

--server-info

نام و نگارش دیمن اعلان را نمایش می‌دهد.

--server-capabilities

قابلیت‌های دیمن اعلان را نمایش می‌دهد.

-v,--version

شمارهٔ نگارش را نمایش داده و خارج می‌شود.

2024-09-05