.\" 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\-keyboard\-state" "5" "2026\-08\-31"
.PP
.SH "نام (NAME)"
waybar\-keyboard\-state \- ماژول وضعیت صفحه‌کلید برای waybar
.PP
.SH "توضیحات (DESCRIPTION)"
.PP
ماژول \fBkeyboard\-state\fR وضعیت کلیدهای قفل اعداد (Num Lock)، قفل حروف بزرگ (Caps Lock) و قفل پیمایش (Scroll Lock) را نمایش می‌دهد.\&
.PP
برای استفاده از این ماژول باید عضو گروه input باشید.\&
.PP
.SH "پیکربندی (CONFIGURATION)"
.PP
\fBinterval\fR:
.br
منسوخ شده؛ این ماژول اکنون از حلقه رویداد (event loop) استفاده می‌کند و بازه زمانی تاثیری ندارد.\&
.RS 4
نوع: integer
.br
پیش‌فرض: 1
.br
بازه زمانی بر حسب ثانیه جهت بررسی وضعیت صفحه‌کلید.\&
.PP
.RE
\fBformat\fR:
.br
نوع: string|object
.br
پیش‌فرض: {name} {icon}
.br
قالب نحوه نمایش اطلاعات.\& اگر از نوع رشته باشد، قالب یکسانی برای تمام وضعیت‌های صفحه‌کلید استفاده می‌شود.\& اگر از نوع شیء باشد، فیلدهای «numlock»، «capslock» و «scrolllock» هر کدام قالب متناظر با آن وضعیت را مشخص می‌کنند.\& هر وضعیتی که مشخص نشده باشد از قالب پیش‌فرض استفاده خواهد کرد.\&
.PP
\fBformat\-icons\fR:
.br
نوع: object
.br
پیش‌فرض: {"locked": "locked", "unlocked": "unlocked"}
.br
بر اساس وضعیت صفحه‌کلید، آیکون متناظر انتخاب می‌شود.\& مجموعه آیکون‌های یکسانی برای قفل اعداد، حروف بزرگ و پیمایش استفاده می‌شود، اما آیکون از میان این مجموعه به‌طور مستقل برای هر یک انتخاب می‌گردد.\& بخش \fBآیکون‌ها (ICONS)\fR را ببینید.\&
.PP
\fBnumlock\fR:
.br
نوع: bool
.br
پیش‌فرض: false
.br
نمایش وضعیت قفل اعداد (Num Lock).\&
.PP
\fBcapslock\fR:
.br
نوع: bool
.br
پیش‌فرض: false
.br
نمایش وضعیت قفل حروف بزرگ (Caps Lock).\&
.PP
\fBscrolllock\fR:
.br
نوع: bool
.br
پیش‌فرض: false
.br
نمایش وضعیت قفل پیمایش (Scroll Lock).\&
.PP
\fBdevice\-path\fR:
.br
نوع: string
.br
پیش‌فرض: اولین دستگاه ورودی معتبر را انتخاب می‌کند
.br
مشخص می‌کند وضعیت کدام دستگاه ورودی libevdev نمایش داده شود.\& دستگاه‌های libevdev را می‌توان در dev/input/ یافت.\& دستگاه باید از رویدادهای قفل اعداد، قفل حروف بزرگ و قفل پیمایش پشتیبانی کند.\&
.PP
\fBbinding\-keys\fR:
.br
نوع: array
.br
پیش‌فرض: [58, 69, 70]
.br
شخصی‌سازی کلید راه‌انداز این ماژول؛ شماره کلید را می‌توان در usr/include/linux/input\-event\-codes.h/ یا با اجرای دستور sudo libinput debug\-events \-\-show\-keycodes پیدا کرد.\&
.PP
\fBexpand\fR:
.br
نوع: bool
.br
پیش‌فرض: false
.br
به این ماژول امکان می‌دهد تمام فضای باقی‌مانده را به‌طور پویا مصرف کند.\&
.PP
.SH "جایگزین‌های قالب‌بندی (FORMAT REPLACEMENTS)"
.PP
\fB{name}\fR: Caps، Num یا Scroll.\&
.PP
\fB{icon}\fR: آیکون، طبق تعریف در \fBformat\-icons\fR.\&
.PP
.SH "آیکون‌ها (ICONS)"
.PP
موارد زیر در \fBformat\-icons\fR قابل تنظیم هستند.\&
.PP
.PD 0
.IP \(bu 4
\fBlocked\fR: زمانی که وضعیت صفحه‌کلید قفل باشد نمایش داده می‌شود.\& پیش‌فرض "locked".\&
.IP \(bu 4
\fBunlocked\fR: زمانی که وضعیت صفحه‌کلید قفل نباشد نمایش داده می‌شود.\& پیش‌فرض "unlocked"
.PD
.PP
.SH "مثال (EXAMPLE)"
.PP
.nf
.RS 4
"keyboard\-state": {
	"numlock": true,
	"capslock": true,
	"format": "{name} {icon}",
	"format\-icons": {
		"locked": "",
		"unlocked": ""
	}
}
.fi
.RE
.PP
.SH "شیوه‌نامه (STYLE)"
.PP
.PD 0
.IP \(bu 4
\fB#keyboard\-state\fR
.IP \(bu 4
\fB#keyboard\-state label\fR
.IP \(bu 4
\fB#keyboard\-state label.\&locked\fR
.IP \(bu 4
\fB#keyboard\-state label.\&numlock\fR
.IP \(bu 4
\fB#keyboard\-state label.\&numlock.\&locked\fR
.IP \(bu 4
\fB#keyboard\-state label.\&capslock\fR
.IP \(bu 4
\fB#keyboard\-state label.\&capslock.\&locked\fR
.IP \(bu 4
\fB#keyboard\-state label.\&scrolllock\fR
.IP \(bu 4
\fB#keyboard\-state label.\&scrolllock.\&locked\fR