SETXKBMAP(1) General Commands Manual SETXKBMAP(1)

setxkbmap — تنظیم نگاشت کلیدها و چیدمان‌ها از طریق افزونه صفحه‌کلید X

setxkbmap [options] [layout [variant [option ...]]]

ابزار setxkbmap صفحه‌کلید را برای استفاده از چیدمان مشخص‌شده در یک نشست X(7) نگاشت می‌کند. برای مشاهده جدول چیدمان‌ها و گزینه‌های موجود، xkeyboard-config(7) را ببینید.

گزینه‌ها به شرح زیر هستند:

-?, -help
چاپ پیامی برای توصیف ورودی‌های معتبر برای setxkbmap.
name
نام مؤلفهٔ نگاشت سازگاری (compatibility map) مورد استفاده برای ساخت یک چیدمان صفحه‌کلید را مشخص می‌کند.
file
نام یک فایل پیکربندی XKB را مشخص می‌کند که صفحه‌کلید مورد استفاده را توصیف می‌کند.
deviceid
شناسه عددی دستگاه (device id) ورودی را برای به‌روزرسانی با چیدمان صفحه‌کلید جدید مشخص می‌کند. در صورت عدم تعیین، دستگاه صفحه‌کلید اصلی کارساز Xorg(1) به‌روزرسانی می‌شود.
display
نمایشگری (display) را مشخص می‌کند که باید با چیدمان جدید صفحه‌کلید به‌روزرسانی شود.
name
نام مؤلفهٔ هندسه (geometry) مورد استفاده برای ساخت یک چیدمان صفحه‌کلید را مشخص می‌کند.
directory
یک دایرکتوری را به فهرست دایرکتوری‌های مورد استفاده برای جستجوی فایل‌های چیدمان یا قوانین (rules) مشخص‌شده اضافه می‌کند.
name
نام مؤلفهٔ کدهای کلید (keycodes) مورد استفاده برای ساخت یک چیدمان صفحه‌کلید را مشخص می‌کند.
name
نام توصیف نگاشت کلید (keymap) مورد استفاده برای ساخت یک چیدمان صفحه‌کلید را مشخص می‌کند.
name
نام چیدمان مورد استفاده برای تعیین مؤلفه‌های سازنده توصیف صفحه‌کلید را مشخص می‌کند. گزینه -layout تنها یک بار می‌تواند استفاده شود. چندین چیدمان را می‌توان به صورت یک فهرست جداشده با کاما تعیین کرد.
name
نام مدل صفحه‌کلید مورد استفاده برای تعیین مؤلفه‌های سازنده توصیف صفحه‌کلید را مشخص می‌کند. تنها یک مدل می‌تواند در خط فرمان تعیین شود.
name
نام یک گزینه را برای تعیین مؤلفه‌های سازنده توصیف صفحه‌کلید مشخص می‌کند؛ می‌توان چندین گزینه را مشخص کرد، به ازای هر پرچم -option یک مورد. توجه داشته باشید که setxkbmap گزینه‌های مشخص‌شده در خط فرمان را به گزینه‌هایی که پیش‌تر تنظیم شده بودند (طبق آنچه در ویژگی‌های پنجره ریشه ذخیره شده است) اضافه می‌کند. اگر می‌خواهید تمام گزینه‌های از پیش تعیین‌شده را جایگزین کنید، ابتدا از پرچم -option با یک آرگومان خالی استفاده کنید.
نام‌های مؤلفه‌ها را در قالبی قابل قبول برای کامپایلر نگاشت کلید xkbcomp(1) چاپ کرده و خارج می‌شود. این گزینه می‌تواند برای آزمودن به‌جای گزینه پرگویی (verbose) و در مواردی که نیاز است هر دو ابزار setxkbmap و xkbcomp(1) به‌صورت زنجیره‌ای اجرا شوند (به پایین مراجعه کنید) استفاده شود.
قوانین، مدل، چیدمان، متغیر (variant) و گزینه‌های فعلی را چاپ کرده و سپس خارج می‌شود.
file
نام فایل قوانینی را مشخص می‌کند که برای حل و تبدیل چیدمان و مدل درخواستی به مجموعه‌ای از نام‌های مؤلفه به کار می‌رود.
name
نام مؤلفهٔ نمادها (symbols) مورد استفاده برای ساخت یک چیدمان صفحه‌کلید را مشخص می‌کند.
همگام‌سازی اجباری را برای درخواست‌های X اعمال می‌کند.
name
نام مؤلفهٔ انواع (types) مورد استفاده برای ساخت یک چیدمان صفحه‌کلید را مشخص می‌کند.
name
مشخص می‌کند کدام متغیر (variant) از چیدمان صفحه‌کلید باید برای تعیین مؤلفه‌های سازنده توصیف صفحه‌کلید استفاده شود. گزینه -variant تنها یک بار می‌تواند استفاده شود. چندین متغیر را می‌توان به صورت یک فهرست جداشده با کاما مشخص کرد که با چیدمان‌های مشخص‌شده با -layout تطبیق داده خواهند شد.
[] [level]
سطح پرگویی (verbosity) در پیام‌های خروجی را مشخص می‌کند. سطوح معتبر از 0 (کمترین پرگویی) تا 10 (بیشترین پرگویی) است. پیش‌فرض: 5. در صورتی که هیچ سطحی تعیین نشود، هر پرچم -v یا -verbose سطح را 1 واحد افزایش می‌دهد.
شماره نسخه ابزار را چاپ کرده و خارج می‌شود.

یک نگاشت کلید XKB از چندین مؤلفه تشکیل شده است که تنها در صورت نیاز، با تبدیل آرگومان‌ها به نام‌های فایل‌های پیکربندی XKB در /usr/share/X11/xkb روی کلاینت X(7) کامپایل می‌شوند. این نام‌فایل‌ها سپس به کارساز Xorg(1) ارسال می‌شوند، مگر اینکه با -print در stdout(4) چاپ شوند.

/usr/share/X11/xkb
منبع تمامی مؤلفه‌های XKB

The setxkbmap utility exits 0 on success, and >0 if an error occurs.

تغییر کاربری کلید Caps Lock به عنوان یک Control چپ اضافی:

setxkbmap -option ctrl:nocaps

تنظیم چیدمان به us و سرهم‌بندی نگاشت کلید روی کلاینت برای شرایطی که ممکن است فایل‌های مؤلفه XKB میان Xserver(1) و کلاینت تفاوت داشته باشند:

setxkbmap us -print | xkbcomp - $DISPLAY

بازنشانی گزینه‌های XKB:

setxkbmap -option

Cannot open display "default display"
محیط شل از نشست در حال اجرای X(7) آگاه نیست. پیش از استفاده از این ابزار X(7) را شروع کنید، یا متغیر محیطی DISPLAY را تنظیم کنید.
Running setxkbmap against an Xwayland server
این ابزار در یک نشست Xwayland(1) اجرا نخواهد شد. به‌جای آن از روش پیکربندی بومی XKB کامپوزیتور Wayland استفاده کنید.

xkbcomp(1), X(7), xkeyboard-config(7)

setxkbmap نخستین بار در XFree86 3.2 ظاهر شد.

March 29, 2025 Linux 6.12.107+deb13-amd64