نام (NAME)

weston.ini - فایل پیکربندی برای Weston - یک کامپوزیتور Wayland

مقدمه (INTRODUCTION)

Weston پیکربندی خود را از پارامترهای خط فرمان و فایل پیکربندی شرح داده‌شده در اینجا دریافت می‌کند.

توضیحات (DESCRIPTION)

Weston برای راه‌اندازی و برپایی خود از یک فایل پیکربندی به نام weston.ini استفاده می‌کند. هنگام راه‌اندازی سرور، فایل پیکربندی weston.ini در یکی از مکان‌های زیر جستجو می‌شود:

$XDG_CONFIG_HOME/weston.ini   (در صورت تنظیم بودن $XDG_CONFIG_HOME)
$HOME/.config/weston.ini      (در صورت تنظیم بودن $HOME)
weston/weston.ini در هر یک از
    $XDG_CONFIG_DIR           (در صورت تنظیم بودن $XDG_CONFIG_DIRS)
/etc/xdg/weston/weston.ini    (در صورت تنظیم نبودن $XDG_CONFIG_DIRS)

که در آن، متغیر محیطی $HOME دایرکتوری خانگی کاربر است، $XDG_CONFIG_HOME دایرکتوری پیکربندی مخصوص کاربر است، و $XDG_CONFIG_DIRS فهرستی از دایرکتوری‌های پایه پیکربندی جداشده با دونقطه ':' است، مانند /etc/xdg-foo:/etc/xdg.

فایل weston.ini از چندین بخش تشکیل شده است که ممکن است به هر ترتیبی حضور داشته باشند، یا برای استفاده از مقادیر پیکربندی پیش‌فرض حذف شوند. هر بخش ساختاری به شکل زیر دارد:

[SectionHeader]
Key1=Value1
Key2=Value2
    ...

فاصله‌ها مهم هستند و در نظر گرفته می‌شوند. خطوط توضیحات (کامنت) نادیده گرفته می‌شوند:

#comment

سرآیندهای بخش‌ها عبارتند از:

core           ماژول‌ها و گزینه‌های اصلی
libinput       پیکربندی دستگاه ورودی
shell          سفارشی‌سازی میزکار
launcher       افزودن راه‌انداز به پنل
output         پیکربندی خروجی
input-method   ورودی صفحه‌کلید روی صفحه
keyboard       چیدمان‌های صفحه‌کلید
terminal       گزینه‌های برنامه ترمینال
xwayland       گزینه‌های XWayland
screen-share   گزینه‌های اشتراک‌گذاری صفحه (منسوخ‌شده)
autolaunch     گزینه‌های اجرای خودکار

انواع مقادیر ممکن عبارتند از رشته (string)، عدد صحیح ۳۲ بیتی علامت‌دار و بدون علامت (signed and unsigned 32-bit integer)، و بولی (boolean). رشته‌ها نباید درون نقل‌قول قرار گیرند، از هیچ توالی گریزی پشتیبانی نمی‌کنند و تا انتهای خط ادامه می‌یابند. اعداد صحیح می‌توانند در قالب‌های ده‌دهی (مانند 123)، هشت‌هشتی (مانند 0173) و شانزده‌شانزدهی (مانند 0x7b) مشخص شوند. مقادیر بولی تنها می‌توانند 'true' یا 'false' باشند.

بخش هسته (CORE SECTION)

بخش core برای انتخاب ماژول‌های کامپوزیتور در زمان راه‌اندازی و گزینه‌های عمومی به کار می‌رود.

shell=desktop

پوستهٔ بارگذاری‌شونده را مشخص می‌کند (رشته). این گزینه می‌تواند برای بارگذاری پوستهٔ پیاده‌سازی‌شده توسط خودتان یا یکی از پوسته‌های پیش‌فرض وستون به کار رود. پوسته‌های موجود در دایرکتوری /usr/lib/weston عبارتند از:

desktop
fullscreen (منسوخ‌شده)
ivi
kiosk
lua

xwayland=true

از وستون می‌خواهد که ماژول XWayland را بارگذاری کند (بولی).

modules=screen-share.so

ماژول‌های مورد نظر برای بارگذاری را مشخص می‌کند (رشته، جداشده با کاما). ماژول‌های موجود در دایرکتوری /usr/lib/weston عبارتند از:

screen-share.so (منسوخ‌شده)

backend=headless

بک‌اند پیش‌فرض را لغو و جایگزین می‌کند. بک‌اندهای موجود عبارتند از:

drm
headless
rdp
pipewire
vnc
wayland
x11

repaint-window=N

طول تقریبی پنجرهٔ بازطراحی را بر حسب میلی‌ثانیه تنظیم می‌کند. پنجرهٔ بازطراحی برای کنترل و کاهش تأخیر خروجی کلاینت‌ها استفاده می‌شود. اگر طول پنجره از دورهٔ نوسازی خروجی طولانی‌تر باشد، بازطراحی بلافاصله پس از پایان بازطراحی قبلی انجام خواهد شد و در این بین درخواست‌های کلاینت پردازش نمی‌شوند. اگر پنجرهٔ بازطراحی بیش از حد کوتاه باشد، ممکن است کامپوزیتور بازهٔ محوشدگی عمودی هدف را از دست بدهد که موجب افزایش تأخیر خروجی می‌شود. مقدار پیش‌فرض ۷ میلی‌ثانیه است. بازهٔ مجاز از ۱ تا ۱۰۰۰ میلی‌ثانیه است، اما کامپوزیتور مقادیر بزرگ را به ۱ میلی‌ثانیه کمتر از نرخ نوسازی جاری کاهش می‌دهد.

idle-time=seconds

زمان وقفهٔ بیکاری وستون را بر حسب ثانیه تنظیم می‌کند. این زمان وقفه، مدتی است که پس از آن وستون وارد حالت «غیرفعال» شده و صفحه به سیاهی می‌رود. مقدار ۰ این وقفه را غیرفعال می‌کند.

مهم: این گزینه را می‌توان از طریق گزینهٔ خط فرمان -i وستون نیز تنظیم کرد و نسبت به گزینهٔ فایل ‎.ini فعلی اولویت خواهد داشت. بدین معنا که اگر هم در weston.ini و هم در خط فرمان این زمان وقفهٔ بیکاری تعریف شده باشد، مقدار مشخص‌شده در خط فرمان اعمال خواهد شد. از سوی دیگر، چنانچه هیچ‌یک از آن‌ها مقداری تعیین نکنند، وقفهٔ بیکاری پیش‌فرض روی ۳۰۰ ثانیه تنظیم می‌شود.

require-input=true

برای راه‌اندازی نیازمند یک دستگاه ورودی است.

require-outputs=any

رفتار وستون را در صورتی که نتواند خروجی‌ها را پیکربندی و فعال کند، تعیین می‌نماید.

بسته به مورد استفاده، ممکن است ترجیح داده شود اطمینان حاصل شود که وستون تنها در صورتی شروع به کار می‌کند که بتواند تمام خروجی‌های موجود را فعال کند، یا این‌که خروجی‌های ناموفق را نادیده بگیرد. گزینه‌های ممکن عبارتند از:

all-found    تمام خروجی‌های موجود باید فعال شوند
any          در صورت امکان فعال‌سازی هر یک از خروجی‌ها شروع شود
none         حتی اگر هیچ خروجی فعال نشد شروع شود

wait-for-debugger=true

پیش از مقداردهی اولیهٔ کامپوزیتور، سیگنال SIGSTOP ارسال می‌کند. این کار به کاربر اجازه می‌دهد دیباگر را متصل کرده و با ارسال SIGCONT به اجرای برنامه ادامه دهد. این امکان برای اشکال‌زدایی کرش در هنگام راه‌اندازی، زمانی که اجرای مستقیم وستون از درون دیباگر دشوار یا نامناسب است، مفید خواهد بود. مقدار بولی، پیش‌فرض false است. گزینهٔ خط فرمانی نیز برای انجام همین کار وجود دارد.

remoting=remoting-plugin.so

پلاگینی را برای خروجی از راه دور جهت بارگذاری مشخص می‌کند (رشته). این گزینه می‌تواند برای بارگذاری پلاگین ریموت پیاده‌سازی‌شده توسط خودتان یا یکی از پلاگین‌های پیش‌فرض وستون به کار رود. پلاگین‌های ریموت موجود در دایرکتوری __libweston_modules_dir__ عبارتند از:

remoting-plugin.so

renderer=auto

رندرر مورد استفاده برای ترکیب‌بندی داخلی (composition) را در صورت نیاز انتخاب می‌کند، یا auto را برای برگزیدن مناسب‌ترین رندرر تعیین می‌نماید. رندررهای موجود عبارتند از:

auto
gl
noop
pixman

use-pixman=true

به نفع گزینهٔ renderer= منسوخ شده است. رندرینگ مبتنی بر pixman را برای تمام خروجی‌ها در بک‌اندهایی که از آن پشتیبانی می‌کنند، فعال می‌سازد. بولی، مقدار پیش‌فرض false است. گزینهٔ خط فرمانی نیز برای انجام همین کار وجود دارد.

color-management=true

مدیریت رنگ را فعال می‌کند و نیازمند استفاده از GL-renderer است. بولی، مقدار پیش‌فرض false است.

موقتی، آزمایشی و در دست توسعه: مدیریت رنگ استفاده از فایل‌های ICC را برای توصیف رفتار رنگی مانیتور، افزونه‌های پروتکل ویلند را برای کلاینت‌ها جهت توصیف فضاهای رنگی خود و انجام پروفایل‌بندی مانیتور، و نگاشت تن (tone mapping) مورد نیاز برای فعال‌سازی حالت‌های ویدیویی HDR ممکن می‌سازد. این قابلیت‌های گسترش‌یافته به بهای پردازش تصویر سنگین‌تر و در مواردی از دست رفتن برخی ویژگی‌های تخلیه بار سخت‌افزاری (hardware off-loading) مانند composite-bypass تمام می‌شود.

output-decorations=true

فقط برای headless-backend به همراه GL-renderer: تزئینات پنجرهٔ خروجی را رسم می‌کند، مشابه کاری که wayland-backend برای پنجره‌های خروجی شناور انجام می‌دهد. بولی، مقدار پیش‌فرض false است. معمولاً نمی‌توان از این تزئینات اسکرین‌شات گرفت. این گزینه تنها برای مجموعه آزمون‌های وستون مفید است.

placeholder-color=0xRRGGBB

رنگ جای‌نگهدار (placeholder) را تنظیم می‌کند (عدد صحیح بدون علامت). جفت‌رقم‌های هگزادسیمال به ترتیب قرمز، سبز و آبی هستند. این جای‌نگهدار برای حفاظت از محتوا (content-protection) یا هنگامی که قادر به انتقال سطح/نما در صفحهٔ سخت‌افزاری (HW plane) نیستیم اما به اسکن مستقیم (direct scan-out) بافرها نیاز داریم، استفاده می‌شود. مقدار پیش‌فرض 0x660000 (قرمز گرنادیر) است.

بخش LIBINPUT (LIBINPUT SECTION)

بخش libinput برای پیکربندی دستگاه‌های ورودی هنگام استفاده از بک‌اند دستگاه ورودی libinput به کار می‌رود. مقادیر پیش‌فرض توسط libinput تعیین می‌شوند و بسته به منطقی‌ترین حالت برای هر دستگاه داده‌شده، متغیر هستند.

پیکربندی‌های موجود عبارتند از:

enable-tap=false

زدن روی صفحه (تپ) برای کلیک کردن روی دستگاه‌های تاچ‌پد را فعال می‌کند.

tap-and-drag=false

برای دستگاه‌های تاچ‌پد با enable-tap فعال. اگر کاربر تپ کند و سپس بار دوم تپ کرده و نگه دارد، دکمه مجازی ماوس تا زمانی که کاربر انگشت خود را روی تاچ‌پد نگه دارد فشرده می‌ماند و امکان کلیک و کشیدن را تنها با تپ فراهم می‌سازد.

tap-and-drag-lock=false

برای دستگاه‌های تاچ‌پد با enable-tap و tap-and-drag فعال. در حین یک عمل کلیک و کشیدن با تپ، اگر کاربر تاچ‌پد را کمتر از تعداد معینی میلی‌ثانیه رها کرده و سپس مجدداً لمس کند، دکمه مجازی ماوس فشرده باقی می‌ماند و کشیدن می‌تواند ادامه یابد.

disable-while-typing=true

برای دستگاه‌هایی که ممکن است هنگام تایپ با صفحه‌کلید به‌طور تصادفی فعال شوند و موجب اختلال در تایپ گردند. این دستگاه‌ها را در حین استفاده از صفحه‌کلید غیرفعال می‌کند.

middle-button-emulation=false

برای دستگاه‌های اشاره‌گر با دکمه‌های چپ و راست، اما بدون دکمه میانی. در صورت فعال بودن، با فشرده شدن هم‌زمان دکمه‌های چپ و راست، یک رویداد دکمه میانی صادر می‌شود.

left-handed=false

دستگاه را برای استفاده افراد چپ‌دست پیکربندی می‌کند. عملکرد دقیق این گزینه به دستگاه بستگی دارد. برای اشاره‌گرهای دارای دکمه چپ و راست، جای دکمه‌ها جا‌به‌جا می‌شود. در تبلت‌ها، تبلت از نظر منطقی وارونه می‌شود، زیرا از نظر فیزیکی وارونه خواهد شد.

rotation=n

جهت شمال منطقی را تغییر می‌دهد و آن را به‌میزان n درجه در جهت عقربه‌های ساعت از جهت‌گیری پیش‌فرض می‌چرخاند؛ که در آن n یک عدد صحیح بین 0 تا 359 (شامل هر دو) است. عمدتاً برای ترک‌بال‌ها (trackballs) مورد نیاز است. برای مثال به کاربر اجازه می‌دهد ترک‌بال را به پهلو جهت‌دهی کند.

accel-profile={flat,adaptive}

پروفایل شتاب اشاره‌گر را تنظیم می‌کند. سرعت اشاره‌گر روی صفحه متناسب با سرعت فیزیکی با یک ضریب تناسب ثابت است. آن ضریب ثابت را آلفا (alpha) در نظر بگیرید. مقدار flat آلفا را ثابت نگه می‌دارد. گزینه accel-speed را ببینید. مقدار adaptive باعث می‌شود آلفا با سرعت فیزیکی افزایش یابد و هنگام سرعت پایین، کنترل بیشتر و هنگام سرعت بالا، پیمایش و دسترسی بیشتری در اختیار کاربر بگذارد. مقدار پیش‌فرض adaptive است.

accel-speed=v

اگر accel-profile بر روی flat تنظیم شده باشد، صرفاً مقدار آلفا را تعیین می‌کند. اگر accel-profile روی adaptive تنظیم شده باشد، اثر آن پیچیده‌تر است، اما به‌طور کلی سرعت اشاره‌گر را تغییر می‌دهد. v نرمال‌سازی شده است و باید در بازه [-1, 1] قرار داشته باشد. نگاشت دقیق میان v و آلفا به سخت‌افزار وابسته است، اما مقادیر بزرگ‌تر موجب سرعت‌های بالاتر مکان‌نما می‌شوند.

natural-scroll=false

پیمایش طبیعی را فعال می‌کند و رفتار پیمایش صفحه لمسی را شبیه‌سازی می‌نماید. یعنی اگر چرخ ماوس، انگشت یا انگشتان به سمت پایین حرکت داده شوند، صفحه به‌جای پایین به بالا پیمایش می‌شود، مثل اینکه انگشت یا انگشتان با صفحه‌ای که پیمایش می‌شود در تماس مستقیم باشند.

scroll-method={two-finger,edge,button,none}

روش پیمایش را تعیین می‌کند. مقدار two-finger با دو انگشت روی تاچ‌پد پیمایش می‌کند. مقدار edge با یک انگشت روی لبه سمت راست تاچ‌پد پیمایش می‌کند. مقدار button زمانی پیمایش می‌کند که با نگه داشتن یک دکمه معین، اشاره‌گر حرکت داده شود. گزینه scroll-button را ببینید. مقدار none پیمایش را به‌طور کامل غیرفعال می‌کند.

scroll-button={BTN_LEFT,BTN_RIGHT,BTN_MIDDLE,...}

برای دستگاه‌هایی که scroll-method آن‌ها روی button تنظیم شده است. دکمه‌ای که پیمایش را فعال می‌کند مشخص می‌سازد. برای فهرست کامل مقادیر ممکن، فایل /usr/include/linux/input-event-codes.h را ببینید.

disable-input=false

نادیده گرفتن تمام دستگاه‌های ورودی مبتنی بر libinput.

touchscreen_calibrator=true

اعلان واسط کالیبراتور صفحه لمسی به همه کلاینت‌ها. این یک بردار احتمالی برای حمله محروم‌سازی از سرویس (DoS) است، بنابراین فقط باید در فضای کاربری قابل‌اعتماد فعال شود. بولی، پیش‌فرض false.

این واسط برای اجرای برنامه‌های کالیبراتور صفحه لمسی مورد نیاز است. رویدادهای خام لمسی را در اختیار برنامه می‌گذارد و پردازش عادی لمس را دور می‌زند. همچنین به برنامه اجازه می‌دهد کالیبراسیون جدیدی را در کامپوزیتور بارگذاری کند.

اگرچه این گزینه در بخش libinput فهرست شده است، اما بر تمام پیکربندی‌های وستون صرف‌نظر از بک‌اند مورد استفاده اثر می‌گذارد. اگر بک‌اند از libinput استفاده نکند، واسط همچنان می‌تواند اعلان شود، اما هیچ دستگاهی را فهرست نخواهد کرد.

calibration_helper=/bin/echo

یک برنامه کمکی کالیبراسیون اختیاری برای ذخیره دائمی کالیبراسیون جدید صفحه لمسی. رشته، پیش‌فرض تنظیم‌نشده (unset).

برنامه داده‌شده با هفت آرگومان اجرا خواهد شد هنگامی که یک برنامه کالیبراتور از سرور بخواهد ماتریس کالیبراسیون جدیدی را به کار گیرد. برنامه به‌صورت همگام اجرا می‌شود و بنابراین در طول مدت خود وستون را مسدود خواهد کرد. اگر وضعیت خروج برنامه غیرصفر باشد، وستون کالیبراسیون جدید را اعمال نخواهد کرد. اگر این برنامه کمکی تنظیم نشده باشد یا وضعیت خروج برنامه صفر باشد، وستون کالیبراسیون جدید را بلافاصله استفاده خواهد کرد.

این برنامه به این صورت فراخوانی می‌شود:

calibration_helper syspath m1 m2 m3 m4 m5 m6

که در آن syspath مسیر sys در udev برای دستگاه است و m1 تا m6 عناصر ماتریس کالیبراسیون در قالب ویژگی udev با عنوان LIBINPUT_CALIBRATION_MATRIX در libinput هستند. مسیر sys یک مسیر مطلق است و با نقطه اتصال sys آغاز می‌شود.

بخش پوسته (SHELL SECTION)

بخش shell برای سفارشی‌سازی کامپوزیتور استفاده می‌شود. برخی از کلیدها ممکن است توسط افزونه‌های پوسته مختلف پشتیبانی یا پردازش نشوند.

ورودی‌هایی که می‌توانند در این بخش قرار گیرند عبارتند از:

client=/usr/lib/weston/weston-desktop-shell

مسیر کلاینت پوسته را برای اجرا مشخص می‌کند. امکان ارسال آرگومان‌ها و متغیرهای محیطی به برنامه وجود دارد، برای مثال: 'ENVFOO=bar ENVBAR=baz /path/to/program --arg anotherarg' که ورودی‌ها با فاصله جدا می‌شوند اما از نقل‌قول (quoting) پشتیبانی نمی‌شود. اگر هیچ کلاینتی مشخص نشده باشد، weston-desktop-shell اجرا می‌شود (رشته).

background-image=file

مسیر فایل تصویر پس‌زمینه را مشخص می‌کند (رشته).

background-type=tile

نحوه ترسیم تصویر پس‌زمینه را تعیین می‌کند (رشته). می‌تواند شامل centered، scale، scale-crop، scale-fit یا tile (پیش‌فرض) باشد. حالت centered تصویر را یک‌بار در مرکز نمایش می‌دهد. اگر تصویر از خروجی کوچک‌تر باشد، باقی سطح به رنگ پس‌زمینه خواهد بود. اگر اندازه تصویر متناسب با خروجی نباشد (بزرگ‌تر باشد)، از چپ و راست یا بالا و پایین بریده می‌شود. حالت scale تصویر را برای جا گرفتن دقیق در خروجی مقیاس‌بندی می‌کند، بدون حفظ نسبت ابعاد. حالت scale-crop نسبت ابعاد را حفظ می‌کند، تصویر پس‌زمینه را به اندازه‌ای بزرگ می‌کند که تمام خروجی را بپوشاند و آن را در مرکز قرار می‌دهد. اگر نسبت ابعاد با خروجی همخوانی نداشته باشد، تصویر از چپ و راست یا بالا و پایین بریده می‌شود. حالت scale-fit مشابه scale-crop است اما اندازه تصویر را طوری با خروجی تطبیق می‌دهد که بریده نشود. حالت tile تصویر پس‌زمینه را برای پر کردن خروجی تکرار می‌کند.

background-color=0xRRGGBB

رنگ پس‌زمینه را مشخص می‌کند (عدد صحیح بدون علامت). جفت ارقام شانزده‌شانزدهی (هگزادسیمال) به ترتیب قرمز، سبز و آبی هستند. جهت حفظ سازگاری با نسخه‌های گذشته، مقادیر در قالب 0xAARRGGBB نیز مجاز هستند، اما AA نادیده گرفته می‌شود و پس‌زمینه همیشه یکدست و توپر است. از آنجا که رنگ پس‌زمینه 0 به معنی نبود رنگ پس‌زمینه است، یک پس‌زمینه سیاه را می‌توان به صورت 0xff000000 مشخص کرد.

clock-format=format

قالب ساعت پنل را مشخص می‌کند (رشته). می‌تواند شامل none، minutes، seconds، minutes-24h، seconds-24h باشد. به‌طور پیش‌فرض، از قالب minutes استفاده می‌شود.

panel-color=0xAARRGGBB

رنگ پنل را مشخص می‌کند (عدد صحیح بدون علامت). جفت ارقام شانزده‌شانزدهی به ترتیب شفافیت، قرمز، سبز و آبی هستند. مثال‌ها:

0xffff0000    قرمز
0xff00ff00    سبز
0xff0000ff    آبی
0x00ffffff    کاملاً شفاف

panel-position=top

موقعیت پنل را تنظیم می‌کند (رشته). می‌تواند شامل top، bottom، left، right یا none باشد.

locking=true

قفل شدن صفحه را فعال می‌کند (بولی).

animation=zoom

جلوه (انیمیشن) مورد استفاده برای باز کردن پنجره‌های جدید را تعیین می‌کند (رشته). می‌تواند شامل zoom، fade یا none باشد. به‌طور پیش‌فرض، هیچ جلوه‌ای استفاده نمی‌شود.

close-animation=fade

جلوه مورد استفاده هنگام بستن پنجره‌ها را تعیین می‌کند (رشته). می‌تواند شامل fade یا none باشد. به‌طور پیش‌فرض، از جلوه fade استفاده می‌شود.

startup-animation=fade

جلوه مورد استفاده توسط desktop-shell هنگام راه‌اندازی را تعیین می‌کند (رشته). می‌تواند شامل fade یا none باشد. به‌طور پیش‌فرض، از جلوه fade استفاده می‌شود.

focus-animation=dim-layer

جلوه مورد استفاده برای پنجره‌های فوکوس‌شده و بدون فوکوس را تعیین می‌کند. می‌تواند شامل dim-layer یا none باشد. به‌طور پیش‌فرض، هیچ جلوه‌ای استفاده نمی‌شود.

allow-zap=true

مشخص می‌کند که آیا با فشردن ترکیب کلیدهای Ctrl-Alt-Backspace پوسته باید خارج شود یا خیر.

disallow-output-changed-move=false

مشخص می‌کند که آیا پوسته باید پنجره کلاینت را به خروجی متفاوتی نسبت به آنچه در ابتدا تخصیص داده شده و دیگر در دسترس/فعال/متصل نیست منتقل کند یا خیر.

binding-modifier=ctrl

کلید تبدیل‌کننده (modifier) مورد استفاده برای کلیدهای میانبر رایج را تعیین می‌کند (رشته)، مانند جابه‌جایی سطوح، تغییر اندازه، چرخش، جابه‌جایی بین پنجره‌ها، بستن پنجره‌ها، تنظیم شفافیت پنجره‌ها، کنترل نور پس‌زمینه و بزرگ‌نمایی میزکار. به weston-bindings(7) مراجعه کنید. مقادیر ممکن: none، ctrl، alt، super (پیش‌فرض).

cursor-theme=theme

تم مکان‌نما (نشانگر ماوس) را تعیین می‌کند (رشته).

cursor-size=24

اندازه مکان‌نما را مشخص می‌کند (عدد صحیح بدون علامت).

lua-script=script

اسکریپت Lua را که هنگام راه‌اندازی lua-shell تفسیر و اجرا خواهد شد مشخص می‌کند. مسیر می‌تواند به صورت مطلق یا نسبی با استفاده از دایرکتوری کاری جاری باشد.

بخش راه‌انداز (LAUNCHER SECTION)

می‌توان چندین بخش راه‌انداز داشت، یکی برای هر راه‌انداز.

icon=icon

مسیر تصویر آیکون را مشخص می‌کند (رشته). تصاویر Svg در حال حاضر پشتیبانی نمی‌شوند.

displayname=displayname

نام نمایشی راه‌انداز را که در تول‌تیپ (tooltip) ظاهر می‌شود مشخص می‌کند.

path=program

مسیر برنامه‌ای را که با کلیک روی این راه‌انداز اجرا می‌شود مشخص می‌کند (رشته). امکان ارسال آرگومان‌ها و متغیرهای محیطی به برنامه وجود دارد. برای مثال:

path=GDK_BACKEND=wayland gnome-terminal --full-screen

بخش خروجی (OUTPUT SECTION)

می‌تواند چندین بخش خروجی وجود داشته باشد که هر کدام متناظر با یک خروجی است. این بخش در حال حاضر فقط توسط بک‌اند‌های drm و x11 شناخته می‌شود.

name=name

نامی را برای خروجی تعیین می‌کند (رشته). بک‌اند از این نام برای شناسایی خروجی استفاده می‌کند. تمامی نام‌های خروجی X11 با حرف X آغاز می‌شوند. تمامی نام‌های خروجی Wayland با حروف WL آغاز می‌شوند. مثال‌هایی از کاربرد:

LVDS1    بک‌اند DRM، پنل داخلی لپ‌تاپ شماره ۱
VGA1     بک‌اند DRM، رابط VGA شماره ۱
X1       بک‌اند X11، پنجره X شماره ۱
WL1      بک‌اند Wayland، پنجره Wayland شماره ۱

برای جزئیات بیشتر به weston-drm(7) مراجعه کنید.

mode=mode

حالت خروجی را تعیین می‌کند (رشته). پارامتر حالت بسته به بک‌اند به‌طور متفاوتی مدیریت می‌شود. در بک‌اند X11، فقط مقدار WIDTHxHEIGHT پنجره weston را تنظیم می‌کند. بک‌اند DRM حالت‌های مختلفی را به همراه گزینه‌ای برای رشته modeline می‌پذیرد.

برای نمونه‌هایی از قالب‌های حالت پشتیبانی‌شده توسط بک‌اند DRM به weston-drm(7) مراجعه کنید.

transform=normal

نحوه چرخش مانیتور نسبت به جهت عادی آن (رشته). کلید transform می‌تواند یکی از ۸ رشته زیر باشد:

normal               خروجی عادی.
rotate-90            ۹۰ درجه در جهت عقربه‌های ساعت.
rotate-180           وارونه.
rotate-270           ۹۰ درجه خلاف جهت عقربه‌های ساعت.
flipped              معکوس‌شده افقی.
flipped-rotate-90    معکوس‌شده و ۹۰ درجه در جهت عقربه‌های ساعت.
flipped-rotate-180   معکوس‌شده و وارونه.
flipped-rotate-270   معکوس‌شده و ۹۰ درجه خلاف جهت عقربه‌های ساعت.

scale=factor

ضریب مقیاس‌بندی اعمال‌شده به کل خروجی، برای پشتیبانی از نمایشگرهای با وضوح بالا («HiDPI» یا «رتینا»)، که تقریباً با نسبت پیکسلی وضوح فیزیکی نمایشگر به وضوح منطقی مطابقت دارد. برنامه‌هایی که از نمایشگرهای با وضوح بالا پشتیبانی نمی‌کنند معمولاً بسیار ریز و ناخوانا به نظر می‌رسند. وستون خروجی چنین برنامه‌هایی را با این ضریب مقیاس‌بندی می‌کند تا خوانا شوند. برنامه‌هایی که خود از مقیاس‌بندی خروجی پشتیبانی می‌کنند می‌توانند محتوای خود را با وضوح بالا ترسیم کنند، که در این حالت از مقیاس‌بندی کامپوزیتور اجتناب می‌کنند. وستون خروجی چنین برنامه‌هایی را مقیاس‌بندی نخواهد کرد و آن‌ها تحت تأثیر این ضریب قرار نمی‌گیرند.

یک عدد صحیح، به‌طور پیش‌فرض ۱، که در صورت نیاز معمولاً ۲ یا بالاتر پیکربندی می‌شود و نشان‌دهنده ضریب مقیاس‌بندی برای خروجی است.

icc_profile=file

اگر گزینه color-management برابر با true باشد، فایل ICC داده‌شده را به عنوان نمایه رنگی خروجی بارگذاری می‌کند. این گزینه فقط در بک‌اند‌های DRM، headless، wayland و x11، و برای خروجی‌های remoting و pipewire کار می‌کند.

color-profile=name

نکته (NOTE): این ویژگی هنوز به طور کامل پیاده‌سازی نشده است و بنابراین انتظار نمی‌رود کار کند.

نمایه‌های رنگی چگونگی رفتار فرضی نمایشگر را توصیف می‌کنند. وستون با آگاهی از رفتار رنگی نمایشگر، می‌تواند محتوای پنجره‌ها را برای ایجاد ظاهر فرضی مورد انتظار تطبیق دهد. گزینه color-management برای کارکرد این قابلیت باید روی true تنظیم شده باشد. این قابلیت فقط در بک‌اند‌های DRM، headless، wayland و x11، و برای خروجی‌های remoting و pipewire کار می‌کند. اگر icc_profile نیز تنظیم شده باشد، به جای آن استفاده می‌شود.

این کلید یک نمایه پارامتری ایجاد می‌کند تا به عنوان نمایه رنگی خروجی استفاده شود. نمایه می‌تواند از پارامترهای ثبت‌شده در یک بخش color-profile با ارجاع به مقدار name آن ایجاد شود. متناوباً این کلید می‌تواند از یکی از نام‌های ویژه نمایه که شامل دونقطه (:) هستند استفاده کند.

مقدار پیش‌فرض، پس از پیاده‌سازی، color-profile=auto: خواهد بود.

نام‌های ویژه زیر پذیرفته می‌شوند:

نمایه‌های رنگی پارامتری خودکار بر اساس کلیدهای پیکربندی eotf-mode و colorimetry-mode در بخش output مربوطه، و به صورت اختیاری با استفاده از EDID گزارش‌شده توسط مانیتور ایجاد می‌شوند (فقط بک‌اند DRM). چندین فلگ باید با فاصله از یکدیگر جدا شوند. فلگ‌های موجود عبارتند از:

مثال‌ها:

color-profile=srgb:
color-profile=auto:
color-profile=auto:edid-tf edid-dr
color-profile=auto: edid-primaries
color-profile=my-awesome-display

مثال آخر باعث می‌شود وستون بخش color-profile را بخواند که دارای name=my-awesome-display است.

به طور ویژه، تنظیم

eotf-mode=sdr
colorimetry-mode=default
color-profile=auto:

همان نمایه رنگی color-profile=srgb: را تولید می‌کند.

color-effect=name

اعمال جلوه رنگ مشخص‌شده برای خروجی. در حال حاضر فقط جلوه‌های رنگی برای اختلالات بینایی رنگ (CVD) ارائه شده است. تنها زمانی کار می‌کند که گزینه color-management برابر false باشد.

جلوه می‌تواند یکی از رشته‌های زیر باشد:

seat=name

نام سیت (seat) منطقی که این خروجی باید با آن مرتبط شود. اگر این مقدار تنظیم شود، ورودی‌های سیت به خروجی‌ای که سیت روی آن تنظیم شده محدود خواهد شد. انتظار می‌رود این قابلیت در یک محیط چندنمایشگره با یک کامپوزیتور واحد برای پیکربندی‌های خروجی و ورودی چندگانه استفاده شود. سیت پیش‌فرض "default" نامیده می‌شود و همیشه وجود خواهد داشت. این سیت را نیز می‌توان مانند هر سیت دیگری محدود کرد.

allow_hdcp=true

پشتیبانی از HDCP را برای این خروجی مجاز می‌سازد. اگر روی true تنظیم شود، می‌توان از قابلیت HDCP ارائه‌شده توسط بک‌اندها برای حفاظت از محتوا (content-protection) روی این خروجی استفاده کرد. به طور پیش‌فرض، پشتیبانی از HDCP همیشه برای یک خروجی مجاز است. حفاظت از محتوا تنها در صورتی عملاً محقق می‌شود که سخت‌افزار (منبع و نمایشگر مقصد) از HDCP پشتیبانی کرده و بک‌اند نیز پیاده‌سازی پروتکل حفاظت از محتوا را داشته باشد. در حال حاضر، HDCP توسط drm-backend پشتیبانی می‌شود.

content-type=content_type

نوع محتوایی که عمدتاً روی این خروجی نمایش داده می‌شود. می‌تواند "nodata" (پیش‌فرض)، "graphics"، "photo"، "cinema" یا "game" باشد.

app-ids=app-id[,app_id]*

فهرستی جداشده با کاما از شناسه‌های برنامه‌ها برای قرار دادن روی این خروجی. این شناسه‌ها باید با شناسه‌های برنامه‌ای که از طریق درخواست xdg_shell.set_app_id تنظیم شده‌اند مطابقت داشته باشند. در حال حاضر، این گزینه توسط kiosk-shell پشتیبانی می‌شود.

colorimetry-mode=default

حالت کالریمتری (سنجش رنگ) را روی خروجی تنظیم می‌کند. حالت کالریمتری همراه با حالت EOTF در زیر، کدگذاری رنگ مورداستفاده در سیگنال ویدیویی را مشخص می‌کنند. حالت کالریمتری برای انتخاب میان کالریمتری پیش‌فرض تعریف‌شده توسط نمایشگر مقصد (که معمولاً توسط EDID توصیف می‌شود) و سایر کدگذاری‌های استاندارد با پشتیبانی از گستره رنگ گسترده (WCG) استفاده می‌شود.

درایور نمایشگر، کارت گرافیک و دریافت‌کننده ویدیو (نمایشگر) باید از حالت انتخابی پشتیبانی کنند، در غیر این صورت نتیجه نامشخص است یا با شکست مواجه می‌شود.

این حالت می‌تواند یکی از رشته‌های زیر باشد:

default              کالریمتری پیش‌فرض (RGB)، وابسته به دریافت‌کننده ویدیو
bt2020cycc           درخشندگی ثابت YCbCr بر اساس Rec. ITU-R BT.2020
bt2020ycc            درخشندگی غیرثابت YCbCr بر اساس Rec. ITU-R BT.2020
bt2020rgb            Rec. ITU-R BT.2020 RGB
p3d65                SMPTE ST 2113 DCI-P3 RGB D65
p3dci                SMPTE ST 2113 DCI-P3 RGB Theater
ictcp                Rec. ITU-R BT.2100 ICtCp

پیش‌فرض default است. حالت‌های غیرپیش‌فرض به color-management=true نیاز دارند.

نکته: ممکن است سیستم‌عامل انتخاب میان RGB و YCbCr را رعایت نکند؛ این انتخاب ممکن است به صورت خودکار توسط درایور نمایشگر لینوکس تعیین شود.

eotf-mode=sdr

حالت EOTF را روی خروجی تنظیم می‌کند. این گزینه برای انتخاب میان حالت دامنه دینامیکی استاندارد (SDR) و حالت‌های گوناگون دامنه دینامیکی بالا (HDR) استفاده می‌شود. درایور نمایشگر، کارت گرافیک و دریافت‌کننده ویدیو (نمایشگر) باید از حالت انتخابی پشتیبانی کنند، در غیر این صورت نتیجه تعریف‌نشده خواهد بود. این حالت می‌تواند یکی از رشته‌های زیر باشد:

sdr                  گامای سنتی، SDR
hdr-gamma            گامای سنتی، HDR
st2084               SMPTE ST 2084، معروف به Perceptual Quantizer
hlg                  Hybrid Log-Gamma (ITU-R BT.2100)

پیش‌فرض sdr است. حالت‌های غیر SDR به color-management=true نیاز دارند.

color_characteristics=name

ویژگی‌های رنگی پایه‌ای خروجی را با بارگذاری پارامترها از بخش color_characteristics با کلید name=name تنظیم می‌کند. اگر نمایه ICC نیز تنظیم شده باشد، نمایه ICC اولویت خواهد داشت.

mirror-of=ouput_name

باعث همپوشانی (آینه‌کاری / mirror) خروجی ریموت با خروجی محلیِ (native) مشخص‌شده با مقدار mirror-of می‌شود. این قابلیت برای اشتراک‌گذاری یا آینه‌کاری یک خروجی محلی DRM کاربرد دارد. خروجی‌ای که خروجی محلی DRM را آینه‌کاری می‌کند، همان modeline ویدیویی خروجی محلی DRM را به ارث خواهد برد، شامل نرخ نوسازی و مقیاس خروجی محلی. توجه داشته باشید که بسته به بک‌اند ریموت، در صورت فعال بودن آینه‌کاری، تغییر اندازه خودکار خروجی غیرفعال خواهد شد. آینه‌کاری یک خروجی محلی DRM روی یک خروجی محلی DRM دیگر هنوز پشتیبانی نمی‌شود و تنها برای خروجی‌های ریموت در نظر گرفته شده است.

نکته: خروجی‌های محلی ایجادشده توسط بک‌اند DRM با استفاده از clone-of برای کلون کردن خروجی‌ها هستند و نه اشتراک‌گذاری یا آینه‌کاری. همچنین ببینید: weston-drm(7).

vrr-mode=mode

حالت نرخ نوسازی متغیر (VRR) نمایشگر را تنظیم می‌کند. این حالت می‌تواند یکی از رشته‌های زیر باشد:

none                 نرخ نوسازی متغیر غیرفعال است
game                 نرخ نوسازی متغیر بازی (game)

پیش‌فرض "none" است.

بخش روش ورودی (INPUT-METHOD SECTION)

path=/usr/lib/weston/weston-keyboard

مسیر روش ورودی صفحه‌کلید مجازی (روی صفحه) را تعیین می‌کند (رشته). امکان ارسال آرگومان‌ها و متغیرهای محیطی به برنامه وجود دارد، برای مثال: با مدخل‌هایی که با فاصله از هم جدا شده‌اند اما بدون پشتیبانی از نقل‌قول (کوتیشن).

overlay-keyboard=false

برنامهٔ weston-keyboard را به عنوان یک پنل روکش (overlay) تنظیم می‌کند.

بخش صفحه‌کلید (KEYBOARD SECTION)

این بخش شامل کلیدهای زیر است:

keymap_rules=evdev

فایل قواعد نگاشت کلید را تعیین می‌کند (رشته). برای نگاشت چیدمان و مدل به دستگاه ورودی استفاده می‌شود.

keymap_model=pc105

مدل نگاشت کلید را تعیین می‌کند (رشته). بخش Models را در xkeyboard-config(7) ببینید.

keymap_layout=us,de,gb

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

keymap_variant=euro,,intl

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

keymap_options=grp:alt_shift_toggle,grp_led:scroll

گزینه‌های نگاشت کلید را تعیین می‌کند (رشته). بخش Options را در xkeyboard-config(7) ببینید.

repeat-rate=40

نرخ تکرار کلیدها را بر حسب نویسه در ثانیه تعیین می‌کند (عدد صحیح بدون علامت).

repeat-delay=400

تأخیر بر حسب میلی‌ثانیه از زمان فشرده شدن کلید تا آغاز تکرار را تعیین می‌کند (عدد صحیح بدون علامت).

numlock-on=false

وضعیت پیش‌فرض numlock را هنگام راه‌اندازی وستون برای بک‌اندهایی که از آن پشتیبانی می‌کنند، تعیین می‌کند.

vt-switching=true

تعیین می‌کند که آیا استفاده از کلیدهای ترکیبی Ctrl+Alt+Fn برای سوییچ کردن از کنسول مجازی کامپوزیتور مجاز باشد یا خیر.

بخش ترمینال (TERMINAL SECTION)

شامل تنظیمات برنامهٔ ترمینال وستون (weston-terminal) است. این بخش امکان سفارشی‌سازی فونت و پوستهٔ رابط خط فرمان را فراهم می‌کند.

font=DejaVu Sans Mono

فونت ترمینال را تعیین می‌کند (رشته). برای یک تجربهٔ خوب توصیه می‌شود از فونت‌های تک‌فاصله (monospace) استفاده شود. در صورتی که فونت پیدا نشود، از فونت پیش‌فرض استفاده می‌شود.

font-size=14

اندازهٔ فونت ترمینال را تعیین می‌کند (عدد صحیح بدون علامت).

term=xterm-256color

پوستهٔ ترمینال (رشته). متغیر محیطی $TERM را تنظیم می‌کند.

بخش XWAYLAND (XWAYLAND SECTION)

path=/usr/bin/Xwayland

مسیر فایل اجرایی xserver را برای اجرا تعیین می‌کند (رشته).

بخش اشتراک صفحه (SCREEN-SHARE SECTION)

منسوخ‌شده: ماژول screen-share به صورت پیش‌فرض ساخته نمی‌شود و منسوخ شده است (DEPRECATED)

برای ساخت آن از گزینهٔ deprecated-screenshare=true استفاده کنید. توجه داشته باشید که قابلیت آینه‌سازی (mirroring) برای جایگزینی این ماژول منسوخ‌شدهٔ اشتراک صفحه اضافه شده است. برای نحوهٔ پیکربندی آن، مدخل کلید mirror-of را در بخش خروجی (output) ببینید.

command=/usr/bin/weston --backend=rdp --shell=fullscreen --no-resizeable --no-config

دستور لازم برای راه‌اندازی سرور fullscreen-shell جهت اشتراک‌گذاری صفحه را تعیین می‌کند (رشته).

start-on-startup=false

در صورت تنظیم روی true، اشتراک‌گذاری تمامی خروجی‌های موجود را هنگام راه‌اندازی وستون آغاز می‌کند. به صورت پیش‌فرض روی false تنظیم شده است. به صورت پیش‌فرض روی false تنظیم شده است. هنگام استفاده از این گزینه، مطمئن شوید که --no-config را فعال کرده‌اید تا از بارگذاری مجدد ماژول screen-share و راه‌اندازی ضمنی اشتراک صفحه برای خروجی RDP که از قبل در حال انجام اشتراک صفحه است، جلوگیری شود. به عنوان راهکار جایگزین، می‌توانید یک فایل پیکربندی متفاوت را با استفاده از --config /path/to/config/file ارائه دهید و مطمئن شوید که آن فایل پیکربندی، ماژول screen-share را بارگذاری نمی‌کند.

بخش راه‌اندازی خودکار (AUTOLAUNCH SECTION)

path=/usr/bin/echo

مسیر یک فایل اجرایی برای اجرا پس از راه‌اندازی. این فایل به صورت موازی با وستون اجرا می‌شود، بنابراین نیازی به خروج فوری آن نیست. مقدار پیش‌فرض خالی است.

watch=false

در صورت تنظیم روی true، پس از خروج فایل اجرایی راه‌اندازی‌شده به صورت خودکار، وستون خارج می‌شود (خاتمه می‌یابد). به صورت پیش‌فرض روی false تنظیم شده است.

بخش مشخصات رنگ (COLOR_CHARACTERISTICS SECTION)

هر بخش color_characteristics یک مجموعه از پارامترهای پایه‌ای مشخصات رنگ نمایشگر یا مانیتور را ثبت می‌کند. این پارامترها در مشخصات CTA-861-H تحت عنوان Static Metadata Type 1 تعریف شده‌اند و همچنین در EDID نیز یافت می‌شوند. پارامترها به چندین گروه تقسیم شده‌اند. هر گروه باید یا به‌طور کامل تعیین شود یا اصلاً مشخص نگردد.

هر بخش باید با کلید name نام‌گذاری شود که از طریق آن بتوان از سایر بخش‌ها به آن ارجاع داد. یک بخش متاداده صرفاً مجموعه‌ای از مقادیر پارامترها است و به خودی خود کاری انجام نمی‌دهد؛ تنها زمانی تأثیرگذار خواهد بود که از جای دیگری به آن ارجاع داده شود.

کلید color_characteristics در بخش output را ببینید.

name=name

نامی دلخواه برای این بخش. تا زمانی که نام شامل نویسهٔ دونقطه (:) نباشد، می‌توانید هر نامی را انتخاب کنید. نام‌هایی که حداقل یک دونقطه دارند، رزرو شده‌اند.

بخش پروفایل رنگ (COLOR-PROFILE SECTION)

هر بخش color-profile مجموعه‌ای از پارامترهای پایه‌ای توصیف مشخصات رنگ نمایشگر را ثبت می‌کند. برخی از پارامترها در قالب گروه‌ها گردآوری شده‌اند. هر گروه باید یا به‌طور کامل مشخص شود یا اصلاً مشخص نشود. یک بخش قابل استفاده باید دست‌کم شامل رنگ‌های اصلی سیگنال‌دهی (Signaling primaries group یا prim_named) و تابع انتقال (tf_named یا tf_power) باشد.

هر بخش باید با کلید name نام‌گذاری شود که از طریق آن بتوان از سایر بخش‌ها به آن ارجاع داد. یک بخش color-profile تنها مجموعه‌ای از مقادیر پارامترها است و به‌خودی‌خود کاری انجام نمی‌دهد. این بخش تنها هنگامی تأثیرگذار خواهد بود که از جای دیگری به آن ارجاع داده شود.

کلید color-profile در بخش output را ببینید.

name=name

یک نام دلخواه برای این بخش. تا زمانی که نام شامل نویسهٔ دونقطه (:) نباشد، می‌توانید هر نامی را که می‌خواهید انتخاب کنید. نام‌های دارای دست‌کم یک دونقطه رزرو شده‌اند.

prim_named=name

مجموعه‌ای استاندارد از رنگ‌های اصلی و نقطهٔ سفید برای سیگنال‌دهی. نام‌های زیر شناخته‌شده هستند:

با گروه Signaling primaries group که می‌توان با آن رنگ‌های اصلی و نقطهٔ سفید سفارشی را تعریف کرد، ناسازگار است (همزمان قابل استفاده نیستند).

target_named=name

مجموعه‌ای استاندارد از رنگ‌های اصلی و نقطهٔ سفید برای حجم رنگ هدف. همان نام‌های معرفی‌شده برای prim_named شناخته‌شده هستند.

با گروه Target primaries group که می‌توان با آن رنگ‌های اصلی و نقطهٔ سفید سفارشی را تعریف کرد، ناسازگار است (همزمان قابل استفاده نیستند).

tf_named=name

یک تابع یا مشخصهٔ انتقال استاندارد. نام‌های زیر شناخته‌شده هستند:

مگر در مواردی که در بالا به‌گونهٔ دیگری ذکر شده باشد، مقادیر پیش‌فرض درخشندگی سیگنال‌دهی عبارتند از: min_lum=0.2، ref_lum=80، max_lum=80. گروه Signaling luminances group را ببینید.

با tf_power ناسازگار است (همزمان قابل استفاده نیستند).

tf_power=E

با tf_named ناسازگار است (همزمان قابل استفاده نیستند). تابع انتقال را به‌صورت منحنی قانون توان با توان داده‌شدهٔ E تنظیم می‌کند؛ یک عدد حقیقی در محدودهٔ [1.0, 10.0]. مقادیر پیش‌فرض عبارتند از: min_lum=0.2، ref_lum=80، max_lum=80.

max_fall=L

حداکثر سطح روشنایی میانگین فریم (Frame-Average Light Level) مورد نظر نمایشگر L cd/m². در صورت تنظیم نشدن، تعریف‌نشده است.

max_cll=L

حداکثر سطح روشنایی محتوا (Content Light Level) برای نمایشگر L cd/m². در صورت تنظیم نشدن، تعریف‌نشده است.

همچنین ببینید (SEE ALSO)

weston(1), weston-bindings(7), weston-drm(7), xkeyboard-config(7)