.\" Generated by scdoc 1.11.5
.\" 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 "waybar\-bluetooth" "5" "2026\-08\-31"
.PP
.SH "نام (NAME)"
.PP
waybar\-bluetooth \- ماژول بلوتوث در waybar
.PP
.SH "توضیحات (DESCRIPTION)"
.PP
ماژول \fBbluetooth\fR اطلاعات مربوط به کنترل‌کننده بلوتوث و اتصالات آن را نمایش می‌دهد.\&
.PP
.SH "پیکربندی (CONFIGURATION)"
.PP
با \fBbluetooth\fR فراخوانی می‌شود
.PP
\fBcontroller\fR:
.br
نوع: رشته (string)
.br
استفاده از کنترل‌کننده با نام مستعار (alias) تعریف‌شده.\& در غیر این صورت، یک کنترل‌کننده به‌صورت تصادفی استفاده می‌شود.\& توصیه می‌شود در صورتی که بیش از ۱ کنترل‌کننده در سیستم موجود است، تعریف شود.\&
.PP
\fBformat\-device\-preference\fR:
.br
نوع: آرایه (array)
.br
رتبه‌بندی دستگاه‌های بلوتوث، آدرس‌دهی شده با نام مستعار آن‌ها.\& ترتیب از \fBنخستین نمایش داده‌شده\fR تا \fBآخرین نمایش داده‌شده\fR است.\&
.br
اگر این گزینه پیکربندی تعریف نشده باشد یا هیچ‌یک از دستگاه‌های موجود در فهرست متصل نباشند، به نمایش آخرین دستگاه متصل بازمی‌گردد.\&
.PP
\fBformat\fR:
.br
نوع: رشته (string)
.br
پیش‌فرض: \fB {status}\fR
.br
قالب نحوه نمایش اطلاعات.\& این قالب زمانی استفاده می‌شود که سایر قالب‌ها مشخص نشده باشند.\&
.PP
\fBformat\-disabled\fR:
.br
نوع: رشته (string)
.br
این قالب زمانی استفاده می‌شود که کنترل‌کننده نمایش داده‌شده غیرفعال باشد.\&
.PP
\fBformat\-off\fR:
.br
نوع: رشته (string)
.br
این قالب زمانی استفاده می‌شود که کنترل‌کننده نمایش داده‌شده خاموش باشد.\&
.PP
\fBformat\-on\fR:
.br
نوع: رشته (string)
.br
این قالب زمانی استفاده می‌شود که کنترل‌کننده نمایش داده‌شده روشن باشد اما هیچ دستگاهی متصل نباشد.\&
.PP
\fBformat\-connected\fR:
.br
نوع: رشته (string)
.br
این قالب زمانی استفاده می‌شود که کنترل‌کننده نمایش داده‌شده حداقل به ۱ دستگاه متصل باشد.\&
.PP
\fBformat\-no\-controller\fR:
.br
نوع: رشته (string)
.br
این قالب زمانی استفاده می‌شود که هیچ کنترل‌کننده بلوتوثی یافت نشود.\&
.PP
\fBformat\-icons\fR:
.br
نوع: آرایه/شیء (array/object)
.br
بر اساس درصد کنونی باتری (بخش \fBویژگی آزمایشی درصد باتری (EXPERIMENTAL BATTERY PERCENTAGE FEATURE)\fR را ببینید)، آیکون مربوطه انتخاب می‌شود.\&
.br
ترتیب از \fBlow\fR (کم) به \fBhigh\fR (زیاد) است.\& آیکون درصد کنونی باتری فقط در گزینه‌های پیکربندی \fB*\-connected\-battery\fR نمایش داده خواهد شد.\&
.br
یا بر اساس وضعیت در صورتی که یک شیء باشد.\& اگر مشتقات آن (on، off، connected) تعریف نشده باشند، به وضعیت فعال (enabled) بازمی‌گردد.\&
.PP
\fBrotate\fR:
.br
نوع: عدد صحیح (integer)
.br
مقدار مثبت برای چرخاندن برچسب متنی (در گام‌های ۹۰ درجه).\&
.PP
\fBmax\-length\fR:
.br
نوع: عدد صحیح (integer)
.br
حداکثر طول بر حسب کاراکتر که ماژول باید نمایش دهد.\&
.PP
\fBmin\-length\fR:
.br
نوع: عدد صحیح (integer)
.br
حداقل طول بر حسب کاراکتر که ماژول باید بپذیرد.\&
.PP
\fBalign\fR:
.br
نوع: ممیز شناور (float)
.br
تراز برچسب درون ماژول، که در آن 0 چپ‌چین و 1 راست‌چین است.\& اگر ماژول چرخانده شود، از جهت متن پیروی می‌کند.\&
.PP
\fBjustify\fR:
.br
نوع: رشته (string)
.br
تراز متن درون برچسب ماژول، که گزینه‌های '\&left'\& (چپ)، '\&right'\& (راست) یا '\&center'\& (وسط) را برای تعیین موقعیت می‌پذیرد.\&
.PP
\fBon\-click\fR:
.br
نوع: رشته (string)
.br
دستوری که هنگام کلیک روی ماژول اجرا می‌شود.\&
.PP
\fBon\-click\-middle\fR:
.br
نوع: رشته (string)
.br
دستوری که هنگام کلیک میانی با چرخ ماوس روی ماژول اجرا می‌شود.\&
.PP
\fBon\-click\-right\fR:
.br
نوع: رشته (string)
.br
دستوری که هنگام راست‌کلیک روی ماژول اجرا می‌شود.\&
.PP
\fBon\-scroll\-up\fR:
.br
نوع: رشته (string)
.br
دستوری که هنگام اسکرول به بالا روی ماژول اجرا می‌شود.\&
.PP
\fBon\-scroll\-down\fR:
.br
نوع: رشته (string)
.br
دستوری که هنگام اسکرول به پایین روی ماژول اجرا می‌شود.\&
.PP
\fBsmooth\-scrolling\-threshold\fR:
.br
نوع: ممیز شناور با دقت مضاعف (double)
.br
آستانه مورد استفاده هنگام اسکرول.\&
.PP
\fBtooltip\fR:
.br
نوع: بولی (bool)
.br
پیش‌فرض: \fBtrue\fR
.br
گزینه‌ای برای غیرفعال کردن راهنمای شناور (tooltip) در هنگام نگه داشتن ماوس.\&
.PP
\fBtooltip\-format\fR:
.br
نوع: رشته (string)
.br
قالب نحوه نمایش اطلاعات در راهنمای شناور.\& این قالب زمانی استفاده می‌شود که سایر قالب‌ها مشخص نشده باشند.\&
.PP
\fBtooltip\-format\-disabled\fR:
.br
نوع: رشته (string)
.br
این قالب زمانی استفاده می‌شود که کنترل‌کننده نمایش داده‌شده غیرفعال باشد.\&
.PP
\fBtooltip\-format\-off\fR:
.br
نوع: رشته (string)
.br
این قالب زمانی استفاده می‌شود که کنترل‌کننده نمایش داده‌شده خاموش باشد.\&
.PP
\fBtooltip\-format\-on\fR:
.br
نوع: رشته (string)
.br
این قالب زمانی استفاده می‌شود که کنترل‌کننده نمایش داده‌شده روشن باشد اما هیچ دستگاهی متصل نباشد.\&
.PP
\fBtooltip\-format\-connected\fR:
.br
نوع: رشته (string)
.br
این قالب زمانی استفاده می‌شود که کنترل‌کننده نمایش داده‌شده حداقل به ۱ دستگاه متصل باشد.\&
.PP
\fBtooltip\-format\-no\-controller\fR:
.br
نوع: رشته (string)
.br
این قالب زمانی استفاده می‌شود که هیچ کنترل‌کننده بلوتوثی یافت نشود.\&
.PP
\fBtooltip\-format\-enumerate\-connected\fR:
.br
نوع: رشته (string)
.br
این قالب برای تعیین نحوه نمایش هر دستگاه متصل در جایگزین قالب \fBdevice_enumerate\fR در منوی راهنمای شناور استفاده می‌شود.\&
.PP
\fBmenu\fR:
.br
نوع: رشته (string)
.br
عملیاتی که منو را باز می‌کند.\&
.PP
\fBmenu\-file\fR:
.br
نوع: رشته (string)
.br
محل فایل توصیف‌کننده منو.\& باید عنصری از نوع
.RS 4
GtkMenu با شناسه \fBmenu\fR وجود داشته باشد
.PP
.RE
\fBmenu\-actions\fR:
.br
نوع: آرایه (array)
.br
عملیات متناظر با دکمه‌های منو.\&
.PP
\fBexpand\fR:
.br
نوع: بولی (bool)
.br
پیش‌فرض: false
.br
امکان مصرف پویای تمامی فضای باقی‌مانده توسط این ماژول را فعال می‌کند.\&
.PP
.SH "جایگزین‌های قالب‌بندی (FORMAT REPLACEMENTS)"
.PP
\fB{status}\fR: وضعیت دستگاه بلوتوث.\&
.PP
\fB{icon}\fR: آیکون، مطابق با تعریف در \fBformat\-icons\fR.\&
.PP
\fB{num_connections}\fR: تعداد اتصالات کنترل‌کننده نمایش داده‌شده.\&
.PP
\fB{controller_address}\fR: نشانی کنترل‌کننده نمایش داده‌شده.\&
.PP
\fB{controller_address_type}\fR: نوع نشانی کنترل‌کننده نمایش داده‌شده.\&
.PP
\fB{controller_alias}\fR: نام مستعار (alias) کنترل‌کننده نمایش داده‌شده.\&
.PP
\fB{device_address}\fR: نشانی دستگاه نمایش داده‌شده.\&
.PP
\fB{device_address_type}\fR: نوع نشانی دستگاه نمایش داده‌شده.\&
.PP
\fB{device_alias}\fR: نام مستعار (alias) دستگاه نمایش داده‌شده.\&
.PP
\fB{device_enumerate}\fR: نمایش فهرستی از تمام دستگاه‌های متصل، هر کدام در یک خط جداگانه.\& قالب هر دستگاه را با گزینه‌های پیکربندی \fBtooltip\-format\-enumerate\-connected\fR
.br
و/یا \fBtooltip\-format\-enumerate\-connected\-battery\fR تعیین کنید.\& فقط در گزینه‌های قالب مربوط به راهنمای شناور (tooltip) قابل استفاده است.\&
.PP
.SH "ویژگی آزمایشی درصد باتری (EXPERIMENTAL BATTERY PERCENTAGE FEATURE)"
.PP
در زمان نگارش، ویژگی‌های آزمایشی BlueZ باید برای کارکرد گزینه‌های درصد باتری ذکر شده در زیر، فعال باشند.\&
.PP
.SS "جایگزین قالب (FORMAT REPLACEMENT)"
.PP
\fB{device_battery_percentage}\fR: درصد باتری دستگاه نمایش داده‌شده در صورت در دسترس بودن.\& فقط در گزینه‌های پیکربندی تعریف‌شده در زیر استفاده شود.\&
.PP
.SS "پیکربندی (CONFIGURATION)"
.PP
\fBformat\-connected\-battery\fR:
.br
نوع: رشته (string)
.br
این قالب زمانی استفاده می‌شود که دستگاه نمایش داده‌شده درصد باتری خود را ارائه دهد.\&
.PP
\fBtooltip\-format\-connected\-battery\fR:
.br
نوع: رشته (string)
.br
این قالب زمانی استفاده می‌شود که دستگاه نمایش داده‌شده درصد باتری خود را ارائه دهد.\&
.PP
\fBtooltip\-format\-enumerate\-connected\-battery\fR:
.br
نوع: رشته (string)
.br
این قالب برای تعیین نحوه نمایش هر دستگاه متصل دارای باتری در گزینه جایگزین قالب \fBdevice_enumerate\fR استفاده می‌شود.\&
.br
در صورتی که این گزینه پیکربندی تعریف نشده باشد، به گزینه پیکربندی \fBtooltip\-format\-enumerate\-connected\fR بازمی‌گردد.\&
.PP
.SH "مثال‌ها (EXAMPLES)"
.PP
.nf
.RS 4
"bluetooth": {
	// "controller": "controller1", // در صورت وجود بیش از ۱ کنترل‌کننده در سیستم، نام مستعار آن را مشخص کنید
	"format": " {status}",
	"format\-disabled": "", // یک قالب خالی ماژول را پنهان می‌کند
	"format\-connected": " {num_connections} connected",
	"tooltip\-format": "{controller_alias}\\t{controller_address}",
	"tooltip\-format\-connected": "{controller_alias}\\t{controller_address}\\n\\n{device_enumerate}",
	"tooltip\-format\-enumerate\-connected": "{device_alias}\\t{device_address}"
}
.fi
.RE
.PP
.nf
.RS 4
"bluetooth": {
	"format": " {status}",
	"format\-connected": " {device_alias}",
	"format\-connected\-battery": " {device_alias} {device_battery_percentage}%",
	// "format\-device\-preference": [ "device1", "device2" ], // فهرست اولویت برای تعیین دستگاه نمایش داده‌شده
	"tooltip\-format": "{controller_alias}\\t{controller_address}\\n\\n{num_connections} connected",
	"tooltip\-format\-connected": "{controller_alias}\\t{controller_address}\\n\\n{num_connections} connected\\n\\n{device_enumerate}",
	"tooltip\-format\-enumerate\-connected": "{device_alias}\\t{device_address}",
	"tooltip\-format\-enumerate\-connected\-battery": "{device_alias}\\t{device_address}\\t{device_battery_percentage}%"
}
.fi
.RE
.PP
.SH "استایل (STYLE)"
.PP
.PD 0
.IP \(bu 4
\fB#bluetooth\fR
.IP \(bu 4
\fB#bluetooth.\&disabled\fR
.IP \(bu 4
\fB#bluetooth.\&off\fR
.IP \(bu 4
\fB#bluetooth.\&on\fR
.IP \(bu 4
\fB#bluetooth.\&connected\fR
.IP \(bu 4
\fB#bluetooth.\&discoverable\fR
.IP \(bu 4
\fB#bluetooth.\&discovering\fR
.IP \(bu 4
\fB#bluetooth.\&pairable\fR