.Dd March 29, 2025
.Dt SETXKBMAP 1
.Os
.Sh "نام (NAME)"
.Nm setxkbmap
.Nd تنظیم نگاشت کلیدها و چیدمان‌ها از طریق افزونه صفحه‌کلید X
.Sh "خلاصه دستور (SYNOPSIS)"
.Nm
.Op Ar options
.Op Ar layout Op Ar variant Op Ar option Ar ...
.Sh "توضیحات (DESCRIPTION)"
ابزار
.Nm
صفحه‌کلید را برای استفاده از چیدمان مشخص‌شده در یک نشست
.Xr X 7
نگاشت می‌کند.
برای مشاهده جدول چیدمان‌ها و گزینه‌های موجود،
.Xr xkeyboard-config 7
را ببینید.
.Pp
گزینه‌ها به شرح زیر هستند:
.Bl -tag -width indent
.It Fl ? , Fl help
چاپ پیامی برای توصیف ورودی‌های معتبر برای
.Nm .
.It Fl compat Ar name
نام مؤلفهٔ نگاشت سازگاری (compatibility map) مورد استفاده برای ساخت یک چیدمان صفحه‌کلید را مشخص می‌کند.
.It Fl config Ar file
نام یک فایل پیکربندی XKB را مشخص می‌کند که صفحه‌کلید مورد استفاده را توصیف می‌کند.
.It Fl device Ar deviceid
شناسه عددی دستگاه (device id) ورودی را برای به‌روزرسانی با چیدمان صفحه‌کلید جدید مشخص می‌کند.
در صورت عدم تعیین، دستگاه صفحه‌کلید اصلی کارساز
.Xr Xorg 1
به‌روزرسانی می‌شود.
.It Fl display Ar display
نمایشگری (display) را مشخص می‌کند که باید با چیدمان جدید صفحه‌کلید به‌روزرسانی شود.
.It Fl geometry Ar name
نام مؤلفهٔ هندسه (geometry) مورد استفاده برای ساخت یک چیدمان صفحه‌کلید را مشخص می‌کند.
.It Fl I Ar directory
یک دایرکتوری را به فهرست دایرکتوری‌های مورد استفاده برای جستجوی فایل‌های چیدمان یا قوانین (rules) مشخص‌شده اضافه می‌کند.
.It Fl keycodes Ar name
نام مؤلفهٔ کدهای کلید (keycodes) مورد استفاده برای ساخت یک چیدمان صفحه‌کلید را مشخص می‌کند.
.It Fl keymap Ar name
نام توصیف نگاشت کلید (keymap) مورد استفاده برای ساخت یک چیدمان صفحه‌کلید را مشخص می‌کند.
.It Fl layout Ar name
نام چیدمان مورد استفاده برای تعیین مؤلفه‌های سازنده توصیف صفحه‌کلید را مشخص می‌کند.
گزینه
.Fl layout
تنها یک بار می‌تواند استفاده شود.
چندین چیدمان را می‌توان به صورت یک فهرست جداشده با کاما تعیین کرد.
.It Fl model Ar name
نام مدل صفحه‌کلید مورد استفاده برای تعیین مؤلفه‌های سازنده توصیف صفحه‌کلید را مشخص می‌کند.
تنها یک مدل می‌تواند در خط فرمان تعیین شود.
.It Fl option Ar name
نام یک گزینه را برای تعیین مؤلفه‌های سازنده توصیف صفحه‌کلید مشخص می‌کند؛
می‌توان چندین گزینه را مشخص کرد، به ازای هر پرچم
.Fl option
یک مورد.
توجه داشته باشید که
.Nm
گزینه‌های مشخص‌شده در خط فرمان را به گزینه‌هایی که پیش‌تر تنظیم شده بودند
.Pq طبق آنچه در ویژگی‌های پنجره ریشه ذخیره شده است
اضافه می‌کند.
اگر می‌خواهید تمام گزینه‌های از پیش تعیین‌شده را جایگزین کنید، ابتدا از پرچم
.Fl option
با یک آرگومان خالی استفاده کنید.
.It Fl print
نام‌های مؤلفه‌ها را در قالبی قابل قبول برای کامپایلر نگاشت کلید
.Xr xkbcomp 1
چاپ کرده و خارج می‌شود.
این گزینه می‌تواند برای آزمودن به‌جای گزینه پرگویی (verbose) و در مواردی که نیاز است هر دو ابزار
.Nm
و
.Xr xkbcomp 1
به‌صورت زنجیره‌ای اجرا شوند
.Pq به پایین مراجعه کنید
استفاده شود.
.It Fl query
قوانین، مدل، چیدمان، متغیر (variant) و گزینه‌های فعلی را چاپ کرده و سپس خارج می‌شود.
.It Fl rules Ar file
نام فایل قوانینی را مشخص می‌کند که برای حل و تبدیل چیدمان و مدل درخواستی به مجموعه‌ای از نام‌های مؤلفه به کار می‌رود.
.It Fl symbols Ar name
نام مؤلفهٔ نمادها (symbols) مورد استفاده برای ساخت یک چیدمان صفحه‌کلید را مشخص می‌کند.
.It Fl synch
همگام‌سازی اجباری را برای درخواست‌های X اعمال می‌کند.
.It Fl types Ar name
نام مؤلفهٔ انواع (types) مورد استفاده برای ساخت یک چیدمان صفحه‌کلید را مشخص می‌کند.
.It Fl variant Ar name
مشخص می‌کند کدام متغیر (variant) از چیدمان صفحه‌کلید باید برای تعیین مؤلفه‌های سازنده توصیف صفحه‌کلید استفاده شود.
گزینه
.Fl variant
تنها یک بار می‌تواند استفاده شود.
چندین متغیر را می‌توان به صورت یک فهرست جداشده با کاما مشخص کرد که با چیدمان‌های مشخص‌شده با
.Fl layout
تطبیق داده خواهند شد.
.It Fl v Ns Oo Sy erbose Oc Op Ar level
سطح پرگویی (verbosity) در پیام‌های خروجی را مشخص می‌کند.
سطوح معتبر از 0
.Pq کمترین پرگویی
تا 10
.Pq بیشترین پرگویی
است.
پیش‌فرض: 5.
در صورتی که هیچ سطحی تعیین نشود، هر پرچم
.Fl v
یا
.Fl verbose
سطح را 1 واحد افزایش می‌دهد.
.It Fl version
شماره نسخه ابزار را چاپ کرده و خارج می‌شود.
.El
.Sh "نکات پیاده‌سازی (IMPLEMENTATION NOTES)"
یک نگاشت کلید XKB از چندین مؤلفه تشکیل شده است که تنها در صورت نیاز، با تبدیل آرگومان‌ها به نام‌های فایل‌های پیکربندی XKB در
.Pa "/usr/share/X11/xkb"
روی کلاینت
.Xr X 7
کامپایل می‌شوند.
این نام‌فایل‌ها سپس به کارساز
.Xr Xorg 1
ارسال می‌شوند، مگر اینکه با
.Fl print
در
.Xr stdout 4
چاپ شوند.
.Sh "فایل‌ها (FILES)"
.Bl -tag -width "/usr/share/X11/xkb"
.It Pa "/usr/share/X11/xkb"
منبع تمامی مؤلفه‌های XKB
.El
.Sh "وضعیت خروج (EXIT STATUS)"
.Ex -std
.Sh "مثال‌ها (EXAMPLES)"
تغییر کاربری کلید Caps Lock به عنوان یک Control چپ اضافی:
.Pp
.Dl setxkbmap -option ctrl:nocaps
.Pp
تنظیم چیدمان به us و سرهم‌بندی نگاشت کلید روی کلاینت برای شرایطی که ممکن است فایل‌های مؤلفه XKB میان
.Xr Xserver 1
و کلاینت تفاوت داشته باشند:
.Pp
.Dl setxkbmap us -print | xkbcomp - $DISPLAY
.Pp
بازنشانی گزینه‌های XKB:
.Pp
.Dl setxkbmap -option
.Sh "خطاها (DIAGNOSTICS)"
.Bl -diag
.It Cannot open display \&"default display\&"
محیط شل از نشست در حال اجرای
.Xr X 7
آگاه نیست.
پیش از استفاده از این ابزار
.Xr X 7
را شروع کنید، یا متغیر محیطی
.Ev DISPLAY
را تنظیم کنید.
.It Running setxkbmap against an Xwayland server
این ابزار در یک نشست
.Xr Xwayland 1
اجرا نخواهد شد.
به‌جای آن از روش پیکربندی بومی XKB کامپوزیتور Wayland استفاده کنید.
.El
.Sh "همچنین ببینید (SEE ALSO)"
.Xr xkbcomp 1 ,
.Xr X 7 ,
.Xr xkeyboard-config 7
.Sh "تاریخچه (HISTORY)"
.Nm
نخستین بار در XFree86 3.2 ظاهر شد.