.\" Generated by scdoc 1.11.4
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "swaync" "5" "2026-03-23"
.PP
.SH "نام (NAME)"
.PP
swaync \- پرونده پیکربندی مرکز اعلان SwayNC
.PP
.SH "پیکربندی (CONFIGURATION)"
.PP
هنگام ویرایش پرونده پیکربندی، استفاده از یک ویرایشگر متن دارای کارساز زبان JSON جهت شناسایی خطاهای پیکربندی پیشنهاد می‌شود
.PP
\fBignore-gtk-theme\fR 
.br
type: bool 
.br
default: true 
.br
description: متغیر محیطی GTK_THEME را لغو می‌کند که بسیاری از مشکلات مربوط به تداخل تم‌های GTK با تم‌های سفارشی CSS کاربر را برطرف می‌سازد.\&
.PP
\fBpositionX\fR 
.br
type: string 
.br
default: right 
.br
values: left, right, center 
.br
description: موقعیت افقی مرکز کنترل و پنجره اعلان
.PP
\fBpositionY\fR 
.br
type: string 
.br
default: top 
.br
values: top, center, bottom 
.br
description: موقعیت عمودی مرکز کنترل و پنجره اعلان
.PP
\fBlayer\fR 
.br
type: string 
.br
default: overlay 
.br
values: background, bottom, top, overlay 
.br
description: لایه پنجره اعلان نسبت به پنجره‌های عادی.\& لایه background زیر تمام پنجره‌ها و overlay بالای تمام پنجره‌ها قرار می‌گیرد.\&
.PP
\fBlayer-shell\fR 
.br
type: bool 
.br
default: true 
.br
description: باز شدن یا نشدن پنجره‌ها به عنوان سطوح layer-shell.\& نکته: اعمال تغییرات نیازمند راه‌اندازی مجدد swaync است
.PP
\fBcssPriority\fR 
.br
type: string 
.br
default: application 
.br
values: application, user 
.br
description: اولویت GTK مورد استفاده هنگام بارگذاری پرونده‌های CSS پیش‌فرض و کاربر.\& مقدار "user" را برای جایگزینی BXDG_CONFIG_HOME/gtk-3.\&0/gtk.\&cssR انتخاب کنید
.PP
\fBcontrol-center-positionX\fR 
.br
type: string 
.br
default: right 
.br
values: left, right, center 
.br
description: اختیاری: موقعیت افقی مرکز کنترل.\& در صورت عدم تنظیم روی `none`، بر positionX اولویت دارد.\&
.PP
\fBcontrol-center-positionY\fR 
.br
type: string 
.br
default: top 
.br
values: top, center, bottom 
.br
description: اختیاری: موقعیت عمودی مرکز کنترل.\& در صورت عدم تنظیم روی `none`، بر positionY اولویت دارد.\&
.PP
\fBcontrol-center-margin-top\fR 
.br
type: integer 
.br
default: 0 
.br
description: حاشیه (بر حسب پیکسل) در بالای مرکز اعلان.\& 0 برای غیرفعال‌سازی
.PP
\fBcontrol-center-margin-bottom\fR 
.br
type: integer 
.br
default: 0 
.br
description: حاشیه (بر حسب پیکسل) در پایین مرکز اعلان.\& 0 برای غیرفعال‌سازی
.PP
\fBcontrol-center-margin-right\fR 
.br
type: integer 
.br
default: 0 
.br
description: حاشیه (بر حسب پیکسل) در سمت راست مرکز اعلان.\& 0 برای غیرفعال‌سازی
.PP
\fBcontrol-center-margin-left\fR 
.br
type: integer 
.br
default: 0 
.br
description: حاشیه (بر حسب پیکسل) در سمت چپ مرکز اعلان.\& 0 برای غیرفعال‌سازی
.PP
\fBcontrol-center-layer\fR 
.br
type: string 
.br
default: top 
.br
values: background, bottom, top, overlay 
.br
description: لایه پنجره مرکز کنترل نسبت به پنجره‌های عادی.\& لایه background زیر تمام پنجره‌ها و overlay بالای تمام پنجره‌ها قرار دارد.\&
.PP
\fBcontrol-center-exclusive-zone\fR 
.br
type: bool 
.br
default: true 
.br
description: پیروی یا عدم پیروی مرکز کنترل از مناطق اختصاصی (exclusive zones) کامپوزیتور.\& برای نمونه تنظیم آن روی BfalseR باعث پوشش دادن پنل/داک می‌شود.\&
.PP
\fBnotification-2fa-action\fR 
.br
type: bool 
.br
default: true 
.br
description: نمایش یا عدم نمایش اقدام \'\&COPY "1234"\'\& روی هر اعلان
.PP
\fBtimeout\fR 
.br
type: integer 
.br
default: 10 
.br
description: مدت زمان انقضای اعلان برای اعلان‌های با اولویت عادی
.PP
\fBtimeout-low\fR 
.br
type: integer 
.br
default: 5 
.br
description: مدت زمان انقضای اعلان برای اعلان‌های با اولویت پایین
.PP
\fBtimeout-critical\fR 
.br
type: integer 
.br
default: 0 
.br
description: مدت زمان انقضای اعلان برای اعلان‌های با اولویت بحرانی.\& 0 برای غیرفعال‌سازی
.PP
\fBnotification-window-width\fR 
.br
type: integer 
.br
default: 500 
.br
description: عرض پنجره اعلان بر حسب پیکسل
.PP
\fBnotification-window-height\fR 
.br
type: integer 
.br
default: -1 
.br
description: حداکثر ارتفاع اعلان بر حسب پیکسل.\& مقدار -1 برای استفاده از کل فضای ارائه‌شده توسط کامپوزیتور.\&
.PP
\fBnotification-window-preferred-output\fR 
.br
type: string 
.br
default: "" 
.br
description: خروجی ترجیحی برای باز کردن پنجره اعلان (اعلان‌های بازشو).\& می‌تواند نام درگاه نمایشگر (مانند "DP-1") یا نام کامل، سازنده، مدل و شماره سریال (مانند "Acer Technologies XV272U V 503023B314202") باشد.\& در صورت پیدا نشدن خروجی، خروجی فوکوس‌شده فعلی انتخاب می‌شود.\&
.PP
\fBkeyboard-shortcuts\fR 
.br
type: bool 
.br
default: true 
.br
description: استفاده یا عدم استفاده مرکز کنترل از میانبرهای صفحه‌کلید
.PP
\fBnotification-grouping\fR 
.br
type: bool 
.br
default: true 
.br
description: گروه‌بندی یا عدم گروه‌بندی اعلان‌ها بر اساس نام برنامه
.PP
\fBimage-visibility\fR 
.br
type: string 
.br
default: always 
.br
values: always, when-available, never 
.br
description: نمایانی تصویر: همیشه (always)، در صورت در دسترس بودن (when-available)، یا هرگز (never).\&
.PP
\fBtransition-time\fR 
.br
type: integer 
.br
default: 200 
.br
description: مدت زمان پویانمایی اعلان.\& 0 برای غیرفعال‌سازی
.PP
\fBhide-on-clear\fR 
.br
type: bool 
.br
default: false 
.br
description: پنهان‌سازی مرکز کنترل پس از فشردن دکمه "Clear All"
.PP
\fBhide-on-action\fR 
.br
type: bool 
.br
default: true 
.br
description: پنهان‌سازی مرکز کنترل هنگام کلیک روی یکی از اقدام‌های اعلان
.PP
\fBtext-empty\fR 
.br
type: string 
.br
default: "No Notifications" 
.br
description: متنی که هنگام نبود اعلان برای نمایش ظاهر می‌شود
.PP
\fBfit-to-screen\fR 
.br
type: bool 
.br
default: true 
.br
description: گسترش یا عدم گسترش عمودی مرکز کنترل برای پر کردن تمام صفحه
.PP
\fBrelative-timestamps\fR 
.br
type: bool 
.br
default: true 
.br
description: نمایش برچسب‌های زمانی اعلان‌ها به صورت نسبی نسبت به اکنون، مانند "26 minutes ago".\& در صورت false بودن، برچسب زمانی مطلق محلی در قالب iso8601 نمایش داده می‌شود.\&
.PP
\fBcontrol-center-height\fR 
.br
type: integer 
.br
default: 500 
.br
description: ارتفاع مرکز کنترل بر حسب پیکسل.\& 
.br
مقدار -1 به معنای هماهنگ شدن با اندازه محتوا است.\& 
.br
در صورت تنظیم '\&fit-to-screen'\& روی '\&true'\& نادیده گرفته می‌شود.\& 
.br
همچنین به ارتفاع نمایشگر محدود است، مگر اینکه 
.br
'\&layer-shell-cover-screen'\& روی false تنظیم شده باشد.\&
.PP
\fBcontrol-center-width\fR 
.br
type: integer 
.br
default: 500 
.br
description: عرض مرکز کنترل بر حسب پیکسل
.PP
\fBcontrol-center-preferred-output\fR 
.br
type: string 
.br
default: "" 
.br
description: خروجی ترجیحی برای باز کردن مرکز کنترل.\& می‌تواند نام درگاه نمایشگر (مانند "DP-1") یا نام کامل، سازنده، مدل و شماره سریال (مانند "Acer Technologies XV272U V 503023B314202") باشد.\& در صورت پیدا نشدن خروجی، خروجی فوکوس‌شده فعلی انتخاب می‌شود.\&
.PP
\fBnotification-action-filter\fR 
.br
type: object 
.br
visibility object properties: 
.br
\fBuse-regex\fR
.br
type: bool 
.br
optional: true 
.br
default: false 
.br
description: مشخص می‌کند که آیا تمام فیلدهای زیر باید از رجکس استفاده کنند یا خیر.\&
.br
\fBapp-name\fR
.br
type: string 
.br
optional: true 
.br
description: نام برنامه.\&
.br
\fBdesktop-entry\fR
.br
type: string 
.br
optional: true 
.br
description: مدخل دسکتاپ.\&
.br
\fBid-matcher\fR
.br
type: string 
.br
optional: true (نیازمند حداقل یک BmatcherR) 
.br
description: با شناسه اقدام تطبیق می‌یابد.\& با بررسی خروجی swaync هنگام اجرا با متغیر محیطی BG_MESSAGES_DEBUG=allR قابل یافتن است.\&
.br
\fBtext-matcher\fR
.br
type: string 
.br
optional: true (نیازمند حداقل یک BmatcherR) 
.br
description: با متن اقدام قابل مشاهده در اعلان تطبیق می‌یابد.\& 
.br
description: پنهان کردن اقدام(های) منطبق از اعلان‌های دارای تطابق.\& اگر اعلان شامل یکی از ویژگی‌ها نباشد، آن ویژگی نادیده گرفته خواهد شد.\& در صورت تطابق تمام ویژگی‌ها با اعلان مربوطه، اقدام‌های منطبق پنهان خواهند شد.\& 
.br
example:
.nf
.RS 4
{
	"notification-action-filter": {
		"hide-chromium-settings": {
			"desktop-entry": "chromium-browser",
			"use-regex": false,
			"id-matcher": "settings",
			"text-matcher": "Settings"
		}
	},
}
.fi
.RE
.PP
\fBnotification-visibility\fR 
.br
type: object 
.br
visibility object properties: 
.br
\fBstate\fR
.br
type: string 
.br
optional: false 
.br
default: enabled 
.br
values: ignored, muted, transient, enabled 
.br
description: وضعیت نمایانی اعلان.\& 
.br
\fBoverride-urgency\fR
.br
type: string 
.br
optional: true 
.br
default: unset 
.br
values: unset, low, normal, critical 
.br
description: میزان اضطرار و اولویت جدید اعلان در صورت تنظیم.\&
.br
\fBapp-name\fR
.br
type: string 
.br
optional: true 
.br
description: نام برنامه.\& از رجکس استفاده می‌کند.\&
.br
\fBdesktop-entry\fR
.br
type: string 
.br
optional: true 
.br
description: مدخل دسکتاپ.\& از رجکس استفاده می‌کند.\&
.br
\fBsummary\fR
.br
type: string 
.br
optional: true 
.br
description: خلاصه اعلان.\& از رجکس استفاده می‌کند.\&
.br
\fBbody\fR
.br
type: string 
.br
optional: true 
.br
description: بدنه اعلان.\& از رجکس استفاده می‌کند.\&
.br
\fBurgency\fR
.br
type: string 
.br
optional: true 
.br
default: Normal 
.br
values: Low, Normal, Critical 
.br
description: میزان اضطرار و اولویت اعلان.\&
.br
\fBcategory\fR
.br
type: string 
.br
optional: true 
.br
description: دسته‌ای که اعلان به آن تعلق دارد.\& از رجکس استفاده می‌کند.\&
.br
description: تنظیم نمایانی یا جایگزینی اولویت برای هر اعلان ورودی.\& اگر اعلان شامل یکی از ویژگی‌ها نباشد، آن ویژگی نادیده گرفته می‌شود.\& تمام ویژگی‌ها (به جز state) از رجکس استفاده می‌کنند.\& در صورت تطابق تمام ویژگی‌ها با اعلان مربوطه، اعلان از وضعیت ارائه‌شده پیروی خواهد کرد.\& تنها اولین شیء منطبق استفاده خواهد شد.\& 
.br
example:
.nf
.RS 4
{
	"notification-visibility": {
		"example-name": {
			"state": "The notification state",
			"app-name": "Notification app-name Regex",
			"summary": "Notification summary Regex",
			"body": "Notification body Regex",
			"urgency": "Low or Normal or Critical",
			"category": "Notification category Regex"
		}
	}
}
.fi
.RE
.PP
\fBwidgets\fR 
.br
type: array 
.br
Default values: ["title", "dnd", "notifications"] 
.br
مقادیر معتبر آرایه (برای اطلاعات بیشتر به Bwidget-configR مراجعه کنید): 
.br
\fBnotifications\fR
.br
الزامی: true 
.br
اختیاری: false 
.br
\fBtitle\fR
.br
optional: true 
.br
\fBdnd\fR
.br
optional: true 
.br
\fBlabel\fR
.br
optional: true 
.br
\fBmpris\fR
.br
optional: true 
.br
\fBmenubar\fR
.br
optional: true 
.br
\fBbuttons-grid\fR
.br
optional: true 
.br
\fBslider\fR
.br
optional: true 
.br
\fBvolume\fR
.br
optional: true 
.br
\fBbacklight\fR
.br
optional: true 
.br
\fBinhibitors\fR
.br
optional: true 
.br
description: 
.br
ترتیب و اینکه کدام ابزارک‌ها نمایش داده شوند.\& اگر ابزارک "notifications" مشخص نشود، در پایین قرار خواهد گرفت.\& چندین نمونه از یک ابزارک یکسان: افزودن یک # به همراه هر مقداری به انتهای نام ابزارک.\& مثال: "title#TheMainTitle".\& برای هدف‌گیری اختصاصی این ابزارک در پرونده css از کلاس css به صورت .\&TheMainTitle استفاده کنید 
.br
example:
.nf
.RS 4
{
	"widgets": [
		"inhibitors",
		"title",
		"dnd",
		"notifications"
	]
}
.fi
.RE
.PP
\fBwidget-config\fR 
.br
type: object 
.br
description: پیکربندی ویژگی‌های خاص هر ابزارک.\& چندین نمونه از یک ابزارک یکسان: افزودن یک # به همراه هر مقداری به انتهای نام ابزارک.\& مثال: "title#TheMainTitle".\& برای هدف‌گیری اختصاصی این ابزارک در پرونده css از کلاس css به صورت .\&TheMainTitle استفاده کنید 
.br
ابزارک‌های قابل شخصی‌سازی: 
.br
\fBnotifications\fR
.br
type: object 
.br
css class: widget-notifications 
.br
properties: 
.br
vexpand: 
.br
type: bool 
.br
optional: true 
.br
default: true 
.br
description: گسترش یا عدم گسترش عمودی ابزارک اعلان‌ها 
.br
description: ابزارک اعلان‌ها.\& 
.br
\fBtitle\fR
.br
type: object 
.br
css class: widget-title 
.br
properties: 
.br
text: 
.br
type: string 
.br
optional: true 
.br
default: "Notifications" 
.br
description: عنوان ابزارک 
.br
clear-all-button: 
.br
type: bool 
.br
optional: true 
.br
default: true 
.br
description: نمایش یا عدم نمایش دکمه "Clear All" 
.br
button-text: 
.br
type: string 
.br
optional: true 
.br
default: "Clear All" 
.br
description: متن دکمه "Clear All" 
.br
description: وضعیت نمایانی اعلان.\& 
.br
\fBdnd\fR
.br
type: object 
.br
css class: widget-dnd 
.br
properties: 
.br
text: 
.br
type: string 
.br
optional: true 
.br
default: "Do Not Disturb" 
.br
description: عنوان ابزارک 
.br
description: ابزارک حالت مزاحم نشوید (Do Not Disturb) مرکز کنترل.\& 
.br
\fBlabel\fR
.br
type: object 
.br
css class: widget-label 
.br
properties: 
.br
text: 
.br
type: string 
.br
optional: true 
.br
default: "Label Text" 
.br
description: متن محتوای ابزارک 
.br
clear-all-button: 
.br
type: integer 
.br
optional: true 
.br
default: 5 
.br
description: حداکثر تعداد خطوط 
.br
description: ابزارکی عمومی که به کاربر امکان افزودن متن سفارشی را می‌دهد.\& 
.br
\fBmpris\fR
.br
type: object 
.br
css classes: 
.br
widget-mpris 
.br
widget-mpris-player 
.br
widget-mpris-title 
.br
widget-mpris-subtitle 
.br
properties: 
.br
blacklist: 
.br
type: array 
.br
optional: true 
.br
default: [] 
.br
description: منابع صوتی که ابزارک mpris باید نادیده بگیرد.\& 
.br
مقادیر معتبر آرایه: 
.br
type: string 
.br
description: نام منبع صوتی/برنامه.\& رجکس مجاز است.\& راهنمایی: برای یافتن نام منابع از `$ qdbus | grep mpris` استفاده کنید.\& 
.br
autohide: 
.br
type: bool 
.br
optional: true 
.br
default: false 
.br
description: پنهان کردن ابزارک هنگامی که پخش‌کننده فاقد متاداده است.\& 
.br
show-album-art: 
.br
type: string 
.br
optional: true 
.br
default: "always" 
.br
description: آیا تصویر جلد آلبوم پنهان باشد، همیشه نمایش داده شود، یا تنها در صورت ارائه یک تصویر معتبر نمایان گردد.\& 
.br
enum: ["right", "left"] 
.br
loop-carousel: 
.br
type: bool 
.br
optional: true 
.br
default: false 
.br
description: چرخش حلقه‌ای در چرخ‌فلک پخش‌کننده‌های mpris.\& 
.br
description: ابزارکی که چندین پخش‌کننده موسیقی را نمایش می‌دهد.\& 
.br
\fBmenubar\fR
.br
type: object 
.br
css classes: 
.br
widget-menubar 
.br
.\&widget-menubar>box>.\&menu-button-bar 
.br
نام عنصر مشخص‌شده پس از menu یا buttons با علامت # 
.br
patternProperties: 
.br
menu#<name>: 
.br
type: object 
.br
properties: 
.br
label: 
.br
type: string 
.br
optional: true 
.br
default: "Menu" 
.br
description: برچسب دکمه جهت نمایش/پنهان‌سازی منوی کشویی 
.br
position: 
.br
type: string 
.br
optional: true 
.br
default: "right" 
.br
description: موقعیت افقی دکمه در نوار 
.br
enum: ["right", "left"] 
.br
animation-type: 
.br
type: string 
.br
optional: true 
.br
default: "slide_down" 
.br
description: نوع پویانمایی برای منو
.br
enum: ["slide_down", "slide_up", "none"] 
.br
animation-duration: 
.br
type: integer 
.br
optional: true 
.br
default: 250 
.br
description: مدت زمان پویانمایی بر حسب میلی‌ثانیه 
.br
actions: 
.br
type: array 
.br
Default values: [] 
.br
مقادیر معتبر آرایه: 
.br
type: object 
.br
properties: 
.br
label: 
.br
type: string 
.br
default: "label" 
.br
description: متنی که روی دکمه نمایش داده می‌شود 
.br
command: 
.br
type: string 
.br
default: "" 
.br
description: "دستوری که هنگام کلیک اجرا می‌شود" 
.br
type: 
.br
type: string 
.br
default: "normal" 
.br
description: نوع دکمه.\& 
.br
دکمه‌های تاگل کلاس css به صورت '\&.\&active'\& دریافت می‌کنند 
.br
enum: ["normal", "toggle"] 
.br
update-command: 
.br
type: string 
.br
default: "" 
.br
description: "دستوری که هنگام تغییر نمایانی مرکز کنترل جهت به‌روزرسانی وضعیت فعال دکمه تاگل اجرا می‌شود (باید true یا false خروجی دهد)" 
.br
active: 
.br
type: bool 
.br
default: false 
.br
description: فعال بودن یا نبودن دکمه تاگل به طور پیش‌فرض 
.br
description: فهرستی از اقدام‌ها شامل یک برچسب و یک دستور 
.br
description: دکمه‌ای برای آشکارسازی یک منوی کشویی دارای دکمه‌های اقدام 
.br
buttons#<name>: 
.br
type: object 
.br
properties: 
.br
position: 
.br
type: string 
.br
optional: true 
.br
default: "right" 
.br
description: موقعیت افقی دکمه‌ها در نوار 
.br
enum: ["right", "left"] 
.br
actions: 
.br
type: array 
.br
Default values: [] 
.br
مقادیر معتبر آرایه: 
.br
type: object 
.br
properties: 
.br
label: 
.br
type: string 
.br
default: "label" 
.br
description: متنی که روی دکمه نمایش داده می‌شود 
.br
command: 
.br
type: string 
.br
default: "" 
.br
description: "دستوری که هنگام کلیک اجرا می‌شود" 
.br
type: 
.br
type: string 
.br
default: "normal" 
.br
description: نوع دکمه 
.br
دکمه‌های تاگل کلاس css به صورت '\&.\&active'\& دریافت کرده و متغیر محیطی "SWAYNC_TOGGLE_STATE" تنظیم می‌شود.\& نمونه استفاده را در config.\&json پیش‌فرض ببینید 
.br
enum: ["normal", "toggle"] 
.br
update-command: 
.br
type: string 
.br
default: "" 
.br
description: "دستوری که هنگام تغییر نمایانی مرکز کنترل جهت به‌روزرسانی وضعیت فعال دکمه تاگل اجرا می‌شود (باید true یا false خروجی دهد)" 
.br
active: 
.br
type: bool 
.br
default: false 
.br
description: فعال بودن یا نبودن دکمه تاگل به طور پیش‌فرض 
.br
description: فهرستی از اقدام‌ها شامل یک برچسب و یک دستور 
.br
description: فهرستی از دکمه‌ها برای نمایش در نوار دکمه‌های منو 
.br
\fBbuttons-grid\fR
.br
type: object 
.br
css class: widget-buttons (دسترسی به دکمه‌ها با >flowbox>flowboxchild>button) 
.br
properties: 
.br
buttons-per-row: 
.br
type: number 
.br
actions: 
.br
type: array 
.br
Default values: [] 
.br
مقادیر معتبر آرایه: 
.br
type: object 
.br
properties: 
.br
label: 
.br
type: string 
.br
default: "label" 
.br
description: متنی که روی دکمه نمایش داده می‌شود 
.br
command: 
.br
type: string 
.br
default: "" 
.br
description: "دستوری که هنگام کلیک اجرا می‌شود" 
.br
type: 
.br
type: string 
.br
default: "normal" 
.br
description: نوع دکمه 
.br
دکمه‌های تاگل کلاس css به صورت '\&.\&active'\& دریافت کرده و متغیر محیطی "SWAYNC_TOGGLE_STATE" تنظیم می‌شود.\& نمونه استفاده را در config.\&json پیش‌فرض ببینید 
.br
enum: ["normal", "toggle"] 
.br
active: 
.br
type: bool 
.br
default: false 
.br
description: فعال بودن یا نبودن دکمه تاگل به طور پیش‌فرض 
.br
description: فهرستی از اقدام‌ها شامل یک برچسب و یک دستور 
.br
description: شبکه‌ای از دکمه‌ها که دستورات شل را اجرا می‌کنند 
.br
\fBslider\fR
.br
type: object 
.br
css class: widget-slider 
.br
properties: 
.br
label: 
.br
type: string 
.br
optional: true 
.br
default: "slider" 
.br
description: متن نمایش‌یافته در جلوی اسلایدر 
.br
cmd_setter: 
.br
type: string 
.br
optional: true 
.br
default: "" 
.br
description: دستور برای تنظیم مقدار.\& از $value برای دریافت مقدار فعلی استفاده کنید.\& 
.br
cmd_getter: 
.br
type: string 
.br
optional: true 
.br
default: "" 
.br
description: دستور برای دریافت مقدار واقعی.\& از $value برای دریافت مقدار فعلی استفاده کنید.\& 
.br
min: 
.br
type: integer 
.br
optional: true 
.br
default: 0 
.br
description: حداقل مقدار محدوده اسلایدر 
.br
max: 
.br
type: integer 
.br
optional: true 
.br
default: 100 
.br
description: حداکثر مقدار محدوده اسلایدر 
.br
min_limit: 
.br
type: integer 
.br
optional: true 
.br
default: 0 
.br
description: محدودسازی حداقل مقدار اسلایدر 
.br
max_limit: 
.br
type: integer 
.br
optional: true 
.br
default: 100 
.br
description: محدودسازی حداکثر مقدار اسلایدر 
.br
value_scale: 
.br
type: integer 
.br
optional: true 
.br
default: 0 
.br
description: مقیاس مقادیر کوچک، ارقام گرد کردن اسلایدر 
.br
description: کنترل‌کننده عمومی اسلایدر 
.br
\fBvolume\fR
.br
type: object 
.br
css class: 
.br
widget-volume 
.br
per-app-volume 
.br
properties: 
.br
label: 
.br
type: string 
.br
optional: true 
.br
default: "Volume" 
.br
description: متن نمایش‌یافته در جلوی اسلایدر صدا 
.br
show-per-app: 
.br
type: bool 
.br
optional: true 
.br
default: false 
.br
description: نمایش کنترل صدای جداگانه به ازای هر برنامه 
.br
show-per-app-icon: 
.br
type: bool 
.br
optional: true 
.br
default: false 
.br
description: نمایش نماد برنامه در کنترل صدای برنامه 
.br
show-per-app-label: 
.br
type: bool 
.br
optional: true 
.br
default: false 
.br
description: نمایش نام برنامه در کنترل صدای برنامه 
.br
expand-per-app: 
.br
type: bool 
.br
optional: true 
.br
default: false 
.br
description: گسترش‌یافته بودن بخش برنامه‌ها در شروع کار 
.br
empty-list-label: 
.br
type: string 
.br
optional: true 
.br
default: "No active sink input" 
.br
description: متن نمایشی هنگام نبود ورودی‌های سینک فعال 
.br
expand-button-label: 
.br
type: string 
.br
optional: true 
.br
default: "⇧" 
.br
description: برچسب نمایش‌یافته روی دکمه جهت نمایش کنترل صدای برنامه‌ها 
.br
collapse-button-label: 
.br
type: string 
.br
optional: true 
.br
default: "⇩" 
.br
description: برچسب نمایش‌یافته روی دکمه جهت پنهان‌سازی کنترل صدای برنامه‌ها 
.br
animation-type: 
.br
type: string 
.br
optional: true 
.br
default: "slide_down" 
.br
description: نوع پویانمایی برای کنترل صدای به ازای برنامه 
.br
enum: ["slide_down", "slide_up", "none"] 
.br
animation-duration: 
.br
type: integer 
.br
optional: true 
.br
default: 250 
.br
description: مدت زمان پویانمایی بر حسب میلی‌ثانیه 
.br
description: اسلایدر جهت کنترل صدای پالس (PulseAudio) 
.br
\fBbacklight\fR
.br
type: object 
.br
css class: widget-backlight 
.br
properties: 
.br
label: 
.br
type: string 
.br
optional: true 
.br
default: "Brightness" 
.br
description: متن نمایش‌یافته در جلوی اسلایدر روشنایی 
.br
device: 
.br
type: string 
.br
optional: true 
.br
default: "intel_backlight" 
.br
description: دستگاه در `/sys/class/backlight` یا `/sys/class/leds` 
.br
subsystem: 
.br
type: string 
.br
optional: true 
.br
default: "backlight" 
.br
description: زیرسیستم هسته جهت کنترل روشنایی 
.br
enum: ["backlight", "leds"] 
.br
min: 
.br
type: integer 
.br
optional: true 
.br
default: 0 
.br
description: کمترین مقدار ممکن برای روشنایی 
.br
description: اسلایدر جهت کنترل روشنایی صفحه 
.br
\fBinhibitors\fR
.br
type: object 
.br
css class: widget-inhibitors 
.br
properties: 
.br
text: 
.br
type: string 
.br
optional: true 
.br
default: "Inhibitors" 
.br
description: عنوان ابزارک 
.br
clear-all-button: 
.br
type: bool 
.br
optional: true 
.br
default: true 
.br
description: نمایش یا عدم نمایش دکمه "Clear All" 
.br
button-text: 
.br
type: string 
.br
optional: true 
.br
default: "Clear All" 
.br
description: متن دکمه "Clear All" 
.br
description: در صورت بازداری و مهار اعلان‌ها نمایش داده می‌شود.\&
.PP
.RS 4
example:
.RE
.nf
.RS 4
{
	"widget-config": {
		"title": {
			"text": "Notifications",
			"clear-all-button": true,
			"button-text": "Clear All"
		},
		"dnd": {
			"text": "Do Not Disturb"
		},
		"label": {
			"max-lines": 5,
			"text": "Label Text"
		},
		"mpris": {
			"blacklist": ["playerctld"],
			"autohide": true,
			"show-album-art": "always",
			"loop-carousel": false
		},
		"menubar": {
			"menu#power": {
				"label": "Power",
				"position": "right",
				"actions": [
					{
						"label": "Shut down",
						"command": "systemctl poweroff"
					},
					\&.\&.\&.
				]
			},
			"buttons#screenshot": {
				"position": "left",
				"actions": [
					{
						"label": "Screenshot",
						"command": "grim"
					},
					\&.\&.\&.
				]
			}
		},
		"buttons": {
			"actions": [
				{
					"label": "wifi",
					"command": "rofi-wifi-menu"
				},
				\&.\&.\&.
			]
		}
	}
}
.fi
.RE
.PP
.SH "اسکریپت‌ها (SCRIPTS)"
.PP
\fBscript-fail-notify\fR 
.br
type: bool 
.br
default: true 
.br
description: ارسال یک اعلان در صورت شکست در اجرای اسکریپت
.PP
\fBscripts\fR 
.br
type: object 
.br
ویژگی‌های شیء اسکریپت: 
.br
\fBexec\fR
.br
type: string 
.br
optional: false 
.br
description: اسکریپت برای اجرا.\& همچنین می‌تواند دستورات عادی شل را اجرا کند.\&
.br
\fBapp-name\fR
.br
type: string 
.br
optional: true 
.br
description: نام برنامه.\& از رجکس استفاده می‌کند.\&
.br
\fBdesktop-entry\fR
.br
type: string 
.br
optional: true 
.br
description: مدخل دسکتاپ.\& از رجکس استفاده می‌کند.\&
.br
\fBsummary\fR
.br
type: string 
.br
optional: true 
.br
description: خلاصه اعلان.\& از رجکس استفاده می‌کند.\&
.br
\fBbody\fR
.br
type: string 
.br
optional: true 
.br
description: بدنه اعلان.\& از رجکس استفاده می‌کند.\&
.br
\fBurgency\fR
.br
type: string 
.br
optional: true 
.br
default: Normal 
.br
values: Low, Normal, Critical 
.br
description: میزان اضطرار و اولویت اعلان.\&
.br
\fBcategory\fR
.br
type: string 
.br
optional: true 
.br
description: دسته‌ای که اعلان به آن تعلق دارد.\& از رجکس استفاده می‌کند.\&
.br
\fBsound-file\fR
.br
type: string 
.br
optional: true 
.br
description: پرونده صوتی درخواستی اعلان.\& از رجکس استفاده می‌کند.\&
.br
\fBsound-name\fR
.br
type: string 
.br
optional: true 
.br
description: نام صدای درخواستی اعلان.\& از رجکس استفاده می‌کند.\&
.br
\fBrun-on\fR
.br
type: string 
.br
optional: true 
.br
values: action, receive 
.br
default: receive 
.br
description: اجرای این اقدام هنگام دریافت اعلان، یا هنگام انجام عملی روی آن.\& 
.br
description: اسکریپت‌هایی که باید برای هر اعلان بررسی و در صورت لزوم اجرا شوند.\& اگر اعلان فاقد یکی از ویژگی‌ها باشد، آن ویژگی نادیده گرفته خواهد شد.\& تمام ویژگی‌ها (به جز exec) از رجکس استفاده می‌کنند.\& در صورت تطابق تمام ویژگی‌ها با اعلان مربوطه، اسکریپت اجرا خواهد شد.\& تنها اولین اسکریپت منطبق اجرا می‌شود.\& 
.br
example:
.nf
.RS 4
{
	"scripts": {
		"example-script": {
			"exec": "Your shell command or script here\&.\&.\&.",
			"app-name": "Notification app-name Regex",
			"summary": "Notification summary Regex",
			"body": "Notification body Regex",
			"urgency": "Low or Normal or Critical",
			"category": "Notification category Regex"
		}
	}
}
.fi
.RE
.PP
.RS 4
همچنین می‌توانید از این متغیرهای محیطی در اسکریپت خود استفاده کنید:
.RE
.nf
.RS 4
$SWAYNC_BODY="محتوای بدنه اعلان"
$SWAYNC_DESKTOP_ENTRY="مدخل دسکتاپ"
$SWAYNC_URGENCY="میزان اضطرار اعلان"
$SWAYNC_TIME="زمان اعلان"
$SWAYNC_APP_NAME="نام برنامه اعلان"
$SWAYNC_CATEGORY="دسته اعلان SwayNC"
$SWAYNC_REPLACES_ID="شناسه اعلانی که باید جایگزین شود"
$SWAYNC_ID="شناسه اعلان SwayNC"
$SWAYNC_SUMMARY="خلاصه اعلان"
$SWAYNC_HINT_[NAME]="مقدار اشاره‌گر [NAME]"
$SWAYNC_SOUND_NAME="نام صدای درخواستی"
$SWAYNC_SOUND_FILE="مسیر پرونده صدای درخواستی"
.fi
.RE