.\" 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\-battery" "5" "2026\-08\-31"
.PP
.SH "نام (NAME)"
.PP
waybar\-battery \- ماژول باتری (battery) در waybar
.PP
.SH "توضیحات (DESCRIPTION)"
.PP
ماژول \fBbattery\fR ظرفیت فعلی و وضعیت (مانند در حال شارژ) باتری شما را نمایش می‌دهد.\&
.PP
.SH "پیکربندی (CONFIGURATION)"
.PP
\fBbat\fR: 
.br
نوع: string 
.br
باتری مورد نظر برای پایش، همان‌طور که در مسیر /sys/class/power_supply/ نام‌گذاری شده، به جای تشخیص خودکار.\&
.PP
\fBadapter\fR: 
.br
نوع: string 
.br
آداپتور مورد نظر برای پایش، همان‌طور که در مسیر /sys/class/power_supply/ نام‌گذاری شده، به جای تشخیص خودکار.\&
.PP
\fBfull\-at\fR: 
.br
نوع: integer 
.br
تعیین حداکثر درصد باتری، برای زمانی که جهت حفظ سلامت و طول عمر باتری، آن را طوری تنظیم کرده‌اید که در سطح پایین‌تری شارژ متوقف شود.\& به عنوان مثال، اگر باتری را برای توقف در ۸۰٪ تنظیم کرده باشید، آن مقدار به عنوان ۱۰۰٪ جدید در نظر گرفته می‌شود.\&
.PP
\fBdesign\-capacity\fR: 
.br
نوع: bool 
.br
پیش‌فرض: false 
.br
گزینه‌ای برای استفاده از ظرفیت اسمی طراحی‌شده باتری به جای ظرفیت بیشینه فعلی آن.\&
.PP
\fBinterval\fR: 
.br
نوع: integer 
.br
پیش‌فرض: 60 
.br
فاصله زمانی (به ثانیه) که اطلاعات در آن دریافت و پایش می‌شود.\&
.PP
\fBstates\fR: 
.br
نوع: object 
.br
تعدادی از وضعیت‌های باتری که در سطوح ظرفیت مشخصی فعال می‌شوند.\& صفحه \fBwaybar\-states(5)\fR را ببینید.\&
.PP
\fBformat\fR: 
.br
نوع: string 
.br
پیش‌فرض: {capacity}% 
.br
قالب نحوه نمایش اطلاعات.\&
.PP
\fBformat\-time\fR: 
.br
نوع: string 
.br
پیش‌فرض: {H} h {M} min 
.br
قالب نحوه نمایش زمان.\&
.PP
\fBformat\-icons\fR: 
.br
نوع: array/object 
.br
بر اساس ظرفیت فعلی، آیکون متناظر انتخاب می‌شود.\& 
.br
ترتیب از \fBlow\fR (کم) به \fBhigh\fR (زیاد) است.\& یا در صورتی که یک شیء باشد، بر اساس وضعیت انتخاب می‌شود.\&
.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
\fBrotate\fR: 
.br
نوع: integer
.br
مقدار مثبت برای چرخش برچسب متنی (با گام‌های ۹۰ درجه).\&
.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\-update\fR: 
.br
نوع: string 
.br
دستوری که هنگام به‌روزرسانی ماژول اجرا می‌شود.\&
.PP
\fBon\-scroll\-up\fR: 
.br
نوع: string 
.br
دستوری که هنگام پیمایش به بالا (اسکرول) روی ماژول اجرا می‌شود.\&
.PP
\fBweighted\-average\fR: 
.br
نوع: bool 
.br
پیش‌فرض: true 
.br
گزینه‌ای برای ترکیب چند باتری با ظرفیت‌های مختلف بر اساس میانگین وزنی.\&
.PP
\fBon\-scroll\-down\fR: 
.br
نوع: string 
.br
دستوری که هنگام پیمایش به پایین (اسکرول) روی ماژول اجرا می‌شود.\&
.PP
\fBsmooth\-scrolling\-threshold\fR: 
.br
نوع: double 
.br
آستانه مورد استفاده هنگام پیمایش روان.\&
.PP
\fBtooltip\fR: 
.br
نوع: bool 
.br
پیش‌فرض: true 
.br
گزینه‌ای برای غیرفعال کردن راهنمای شناور (tooltip) هنگام رفتن نشانگر روی آن.\&
.PP
\fBbat\-compatibility\fR: 
.br
نوع: bool 
.br
پیش‌فرض: false 
.br
گزینه‌ای برای فعال‌سازی سازگاری باتری در صورت عدم شناسایی آن.\&
.PP
\fBmenu\fR: 
.br
نوع: string 
.br
عملیاتی که منو را نمایان می‌سازد (popup).\&
.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
\fBevents\fR: 
.br
نوع: object 
.br
دستوراتی را برای اجرا در وضعیت‌های خاص باتری تعیین می‌کند.\& بخش \fBرویدادها (EVENTS)\fR در زیر را ببینید.\&
.PP
.SH "جایگزین‌های قالب (FORMAT REPLACEMENTS)"
.PP
\fB{capacity}\fR: ظرفیت به درصد
.PP
\fB{power}\fR: توان بر حسب وات
.PP
\fB{icon}\fR: آیکون، طبق تعریف‌شده در \fBformat\-icons\fR.\&
.PP
\fB{time}\fR: تخمین زمان تا پر یا خالی شدن.\& توجه داشته باشید که این مقدار بر اساس مصرف توان در آخرین زمان نوسازی است، نه میانگین.\&
.PP
\fB{cycles}\fR: تعداد چرخه‌های شارژی که باتری با بیشترین ظرفیت پشت سر گذاشته است.\& \fB(فقط لینوکس)\fR
.PP
\fB{health}\fR: درصد شارژ بیشینه اولیه باتری با بیشترین ظرفیت که هنوز می‌تواند نگه دارد.\&
.PP
.SH "قالب زمان (TIME FORMAT)"
.PP
ماژول \fBbattery\fR به شما امکان می‌دهد نحوه قالب‌بندی زمان را از طریق \fBformat\-time\fR مشخص کنید.\&
.PP
سه آرگومان عبارتند از:
\fB{H}\fR: ساعت
\fB{M}\fR: دقیقه
\fB{m}\fR: دقیقه با صفر پیش‌رو
.PP
.SH "قالب‌های سفارشی (CUSTOM FORMATS)"
.PP
ماژول \fBbattery\fR امکان تعریف قالب‌های سفارشی بر اساس حداکثر دو عامل را فراهم می‌کند.\& قالبی که بهترین تطابق را دارد انتخاب خواهد شد.\&
.PP
\fBformat\-<state>\fR: به همراه \fBstates\fR، یک قالب سفارشی را می‌توان بسته به ظرفیت باتری تعیین کرد.\&
.PP
\fBformat\-<status>\fR: با وضعیت (status)، می‌توان یک قالب سفارشی بسته به وضعیت موجود در /sys/class/power_supply/<bat>/status (با حروف کوچک) تعیین کرد.\&
.PP
\fBformat\-<status>\-<state>\fR: همچنین می‌توانید قالبی سفارشی وابسته به هر دو مقدار تعیین کنید.\&
.PP
.SH "وضعیت‌ها (STATES)"
.PP
.PD 0
.IP \(bu 4
هر مدخل (\fBstate\fR) شامل یک \fB<name>\fR (نوع: \fBstring\fR) و یک \fB<value>\fR (نوع: \fBinteger\fR) است.\&
.IP \(bu 4
این وضعیت می‌تواند به عنوان یک کلاس CSS در \fBstyle.\&css\fR آدرس‌دهی شود.\& نام کلاس CSS همان \fB<name>\fR وضعیت است.\& هر کلاس زمانی فعال می‌شود که ظرفیت فعلی کمتر یا مساوی با مقدار \fB<value>\fR پیکربندی‌شده باشد.\&
.IP \(bu 4
همچنین هر وضعیت می‌تواند \fBformat\fR اختصاصی خود را داشته باشد.\& این قالب‌ها را می‌توان از طریق \fBformat\-<name>\fR یا حتی برای تفکیک بیشتر به صورت \fBformat\-<status>\-<state>\fR پیکربندی کرد.\& برای اطلاعات بیشتر \fBقالب‌های سفارشی (custom\-formats)\fR را ببینید.\&
.PD
.PP
.SH "رویدادها (EVENTS)"
.PP
هر مدخل در شیء \fBevents\fR شامل یک \fB<event\-name>\fR (نوع: \fBstring\fR) و یک \fB<command>\fR (نوع: \fBstring\fR) است.\& 
.br
\fB<event\-name>\fR می‌تواند در یکی از قالب‌های زیر باشد:
.PP
.PD 0
.IP \(bu 4
\fBon\-<status>\-<state>\fR
.IP \(bu 4
\fBon\-<status>\-<capacity>\fR
.PD
.PP
که در آن:
.PP
.PD 0
.IP \(bu 4
\fB<status>\fR یکی از مقادیر \fBcharging\fR یا \fBdischarging\fR است،
.IP \(bu 4
\fB<state>\fR نام یکی از وضعیت‌های مشخص‌شده در شیء \fBstates\fR است،
.IP \(bu 4
\fB<capacity>\fR مقدار سطح شارژ باتری است (بین \fB0\-100\fR).\&
.PD
.PP
.PP
.SH "مثال‌ها (EXAMPLES)"
.PP
.nf
.RS 4
"battery": {
	"bat": "BAT2",
	"interval": 60,
	"states": {
		"warning": 30,
		"critical": 15
	},
	"events": {
		"on\-discharging\-warning": "notify\-send \-u normal \&'Low Battery\&'",
		"on\-discharging\-critical": "notify\-send \-u critical \&'Very Low Battery\&'",
		"on\-charging\-100": "notify\-send \-u normal \&'Battery Full!\&'"
	},
	"format": "{capacity}% {icon}",
	"format\-icons": ["", "", "", "", ""],
	"max\-length": 25
}
.fi
.RE
.PP
.SH "استایل (STYLE)"
.PP
.PD 0
.IP \(bu 4
\fB#battery\fR
.IP \(bu 4
\fB#battery.\&<status>\fR
.RS 4
.IP \(bu 4
\fB<status>\fR مقدار /sys/class/power_supply/<bat>/status با حروف کوچک است.\&
.RE
.IP \(bu 4
\fB#battery.\&<state>\fR
.RS 4
.IP \(bu 4
\fB<state>\fR را می‌توان در \fBconfig\fR تعریف کرد.\& برای اطلاعات بیشتر \fBوضعیت‌ها (states)\fR را ببینید.\&
.RE
.IP \(bu 4
\fB#battery.\&<status>.\&<state>\fR
.RS 4
.IP \(bu 4
ترکیب هر دو مورد \fB<status>\fR و \fB<state>\fR.\&
.PD
.PP
.RE
کلاس‌های زیر به جای فقط ابزارک باتری، بر کل Waybar اعمال می‌شوند:
.PP
.PD 0
.IP \(bu 4
\fBwindow#waybar.\&battery\-<state>\fR
.RS 4
.IP \(bu 4
\fB<state>\fR را می‌توان همان‌طور که پیش‌تر ذکر شد در \fBconfig\fR تعریف کرد.\&
.PD
.PP
.RE