XPRA(1) General Commands Manual XPRA(1)

xpra - نمایشگر برنامه‌های راه‌دور و پایدار X

xpra seamless [CONNECTIONSTRING] | xpra desktop [CONNECTIONSTRING] [OPTIONS..]

xpra attach [CONNECTIONSTRING] [OPTIONS..]

xpra shadow [CONNECTIONSTRING] [OPTIONS..]

xpra proxy [:DISPLAY] [OPTIONS..]

xpra stop | xpra exit | xpra detach | xpra screenshot filename | xpra version | xpra info [CONNECTIONSTRING] | xpra id [CONNECTIONSTRING] | xpra top [CONNECTIONSTRING] [OPTIONS..]

xpra control [CONNECTIONSTRING] command [arguments..] [--ssh=CMD] [--remote-xpra=CMD] [--socket-dir=DIR] [--socket-dirs=DIRS]

xpra displays [:DISPLAY]

xpra clean-displays [:DISPLAY]

xpra list [--socket-dir=DIR]

xpra list-sessions [--socket-dir=DIR]

xpra list-windows [--socket-dir=DIR]

xpra shell [CONNECTIONSTRING]

xpra showconfig [OPTIONS..]

xpra showsetting [SETTING1..]

xpra list-mdns

xpra docs

xpra html5

xpra upgrade [:DISPLAY] [...هر گزینه‌ای که توسط xpra seamless پذیرفته می‌شود...]

xpra upgrade-desktop [:DISPLAY] [...هر گزینه‌ای که توسط xpra desktop پذیرفته می‌شود...]

xpra recover [:DISPLAY] [...هر گزینه‌ای که توسط xpra seamless پذیرفته می‌شود...]

ابزار Xpra به شما امکان می‌دهد برنامه‌های X را — معمولاً روی یک میزبان راه‌دور — اجرا کرده و سپس نمایش آن‌ها را به رایانه محلی خود هدایت کنید، ارتباط خود را از این برنامه‌ها قطع کرده و بدون از دست رفتن هیچ وضعیتی، مجدداً از همان رایانه یا دستگاهی دیگر به آن‌ها متصل شوید. تفاوت آن با فورواردینگ استاندارد X در این است که امکان قطع و اتصال مجدد را بدون ایجاد اختلال در برنامه فوروارد شده فراهم می‌سازد؛ همچنین با VNC و فناوری‌های مشابه نمایش از راه‌دور متفاوت است زیرا xpra می‌تواند به‌صورت rootless اجرا شود: بدین معنا که برنامه‌های هدایت‌شده توسط xpra، به‌جای اینکه همگی «درون یک جعبه با یکدیگر محبوس باشند»، به‌صورت پنجره‌های معمولی که توسط مدیر پنجره شما مدیریت می‌شوند روی میزکار ظاهر خواهند شد. همچنین Xpra از یک پروتکل سفارشی استفاده می‌کند که خودتنظیم‌شونده است و حساسیت نسبتاً پایینی به تأخیر شبکه دارد، بنابراین روی اتصالات شبکه‌ای که برای فورواردینگ استاندارد X بیش از حد کند یا غیرقابل اطمینان هستند نیز قابل استفاده است. علاوه بر این، Xpra می‌تواند برای سایه‌اندازی (shadow) روی یک نمایشگر X11 موجود، یا در حالت desktop که رفتاری شبیه‌تر به VNC دارد، استفاده شود.

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

نمایشگرهای محلی: این ساده‌ترین حالت است و تنها برای نمایشگرهای محلی فعلیِ کاربر جاری معتبر است.

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

حالت SSL یک لایه سوکت امن را به حالت TCP اضافه می‌کند.

تقریباً مشابه حالت TCP است، اما از AF_VSOCK برای انتقال داده استفاده می‌کند.

اتصال با استفاده از پروتکل وب‌سوکت (websocket).

اتصال با استفاده از پروتکل وب‌سوکت امن (وب‌سوکت با SSL).

اتصال با استفاده از پوسته امن (SSH).

گزینه‌های بیشتر SSH را می‌توان با استفاده از گزینه خط فرمان --ssh تعیین کرد. از OPTIONS می‌توان برای تعیین یک پراکسی ssh استفاده کرد: ?proxy=ssh://[USERNAME[:PASSWORD]@]HOST[:SSH_PORT] سپس xpra یک اتصال SSH به میزبان «proxy» مشخص‌شده برقرار می‌کند، و از آن میزبان، xpra یک اتصال SSH به سرور xpra برقرار خواهد کرد.

برای سازگاری با نسخه‌های پیشین، حالت SSH از ساختار زیر نیز پشتیبانی می‌کند: ssh:[USERNAME[:PASSWORD]@]HOST:DISPLAY اما این ساختار از تعیین شماره درگاه SSH پشتیبانی نمی‌کند. نسخه‌های قدیمی‌تر همچنین از قالب protocol:host:port استفاده می‌کردند، اما به کاربران توصیه می‌شود به قالب استانداردترِ URI با استفاده از :// به عنوان جداکننده مهاجرت کنند.

گذرواژه تنها در صورتی نیاز به تعیین شدن دارد که پودمان احراز هویت سرور آن را الزامی کرده باشد.

اتصال با استفاده از پروتکل RFB (معروف به VNC). این حالت تنها در برابر سرورهای VNC یا یک سرور xpra در حالت desktop یا shadow کار می‌کند.

راه‌اندازی یک سرور xpra با استفاده از شماره نمایشگر :7. نکته: استفاده از DISPLAY=:7 xterm برای راه‌اندازی برنامه‌ها روی یک نمایشگر خاص توصیه نمی‌شود. همواره استفاده از گزینه خط فرمان --start= در xpra را ترجیح دهید. مثال بعدی را ببینید:
راه‌اندازی یک سرور xpra، انتخاب خودکار یک نمایشگر، و اجرای firefox روی آن نمایشگر مجازی. تا زمانی که با xpra attach متصل نشوید، هیچ پنجره‌ای ظاهر نخواهد شد. دستورهای فرزندِ آغازشده، محیطی متناسب با اجرا تحت xpra را به ارث خواهند برد.
راه‌اندازی یک سرور xpra روی bigbox به همراه یک xterm درون آن، و اتصال به آن.
راه‌اندازی یک نشست xfce در یک سرور X11 تودرتو (nested) روی شماره نمایشگری که به طور خودکار تخصیص داده شده است.
فهرست کردن تمام نمایشگرهایی که در حال حاضر روی سیستم در حال اجرا هستند. این شامل نشست‌های تعاملی میزکار و همچنین هر نمایشگر مجازی (xvfb) می‌شود، صرف‌نظر از اینکه توسط یک سرور xpra در حال استفاده باشند یا خیر. نمایشگرهای در وضعیت DEAD را می‌توان با استفاده از xpra recover بازیابی کرد.
خاتمه دادن به تمام نمایشگرهای رها شده در وضعیت DEAD.
حذف تمامی سوکت‌های سرور متعلق به سرورهای از کار افتاده (dead).
نمایش فهرستی از سرورهای xpra که بر روی میزبان فعلی در حال اجرا دارید. این دستور همچنین clean-sockets را اجرا خواهد کرد.
نمایش فهرستی از سرورهای xpra، به همراه اطلاعات اضافی درباره هر نشست در صورت امکان جمع‌آوری آن.
نمایش فهرستی از سرورهای xpra در حال اجرا روی میزبان فعلی، شامل نام نشست و فهرستی از پنجره‌ها. (تنها در صورتی که بتوان از نشست با استفاده از xpra info استعلام گرفت)
نمایش فهرستی از سرورهای xpra یافت‌شده از طریق mDNS (شبکه محلی).
باز کردن مستندات در یک مرورگر وب.
باز کردن کلاینت html5 در یک مرورگر وب.
راه‌اندازی یک پوسته تعاملی خطایابی.
نمایش پیکربندی‌ای که با دیگر زیردستورها استفاده خواهد شد، با در نظر گرفتن آرگومان‌های خط فرمان.
نمایش مقدار یک تنظیم پیکربندی خاص و اینکه کدام دایرکتوری پیکربندی این مقدار را تعیین کرده است.
اتصال به سرور xpra که از شماره نمایشگر محلی :7 استفاده می‌کند. هر برنامه‌ای که روی آن سرور در حال اجرا باشد بر روی صفحه نمایش شما ظاهر خواهد شد.
استفاده از ssh برای اتصال به سرور xpra که روی ماشین frodo به عنوان کاربر foo و با استفاده از نمایشگر :7 در حال اجراست. هر برنامه‌ای که روی آن سرور در حال اجرا باشد روی صفحه نمایش محلی شما ظاهر خواهد شد.
راه‌اندازی یک سرور xpra و یک نشست screen(1). اگر هر یک از برنامه‌های داخل screen تلاش کنند از X استفاده کنند، به سمت سرور xpra هدایت خواهند شد. درک مفهوم پایه‌ای نمایشگرها (displays) برای استفاده موفقیت‌آمیز از xpra حیاتی است.

این ایده از استاندارد X می‌آید. اگر چندین کارساز X در حال اجرا روی یک میزبان داشته باشید، باید راهی برای تمایز قائل شدن بین آن‌ها وجود داشته باشد. X این کار را با تخصیص یک عدد صحیح کوچک و یکتا به هر کارساز انجام می‌دهد که (شاید تا حدی گیج‌کننده) «display» نامیده می‌شود. در حالت معمول یک رایانه رومیزی که تنها یک کارساز X در حال اجرا دارد، آن کارساز از نمایشگر «:0» استفاده می‌کند (یا گاهی «:0.0» را می‌بینید که عملاً یکسان است). هنگامی که یک برنامه تحت X اجرا می‌شود، باید بداند چگونه کارساز X مناسب را پیدا کند؛ این کار را با بررسی متغیر محیطی $DISPLAY انجام می‌دهد.

ابزار Xpra با مشکل مشابهی روبرو است — ممکن است چندین کارساز xpra و همچنین چندین کارساز X بر روی یک میزبان در حال اجرا باشند. این مشکل را با استفاده مجدد از راهکار X حل می‌کند — به هر کارساز xpra یک نمایشگر اختصاص داده می‌شود. این نمایشگر هم به عنوان یک نمایشگر X (برای زمانی که xpra با برنامه‌های X ارتباط برقرار می‌کند) و هم به عنوان یک شناسه عمل می‌کند که کلاینت‌های xpra (مانند xpra attach) از طریق آن کارساز xpra را پیدا می‌کنند.

هنگام استفاده از xpra start می‌توانید از شماره نمایشگر صرف‌نظر کنید: یک نمایشگر به‌طور خودکار برای شما انتخاب خواهد شد. شماره نمایشگر انتخاب‌شده در خروجی لاگ نمایش داده می‌شود و همچنین با دستور xpra list قابل مشاهده است. در Microsoft Windows و Mac OSX، شماره نمایشگر باید حذف شود.

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

  • هر کارساز X یا xpra که روی یک ماشین اجرا می‌شود باید از نام نمایشگر متفاوتی استفاده کند. اگر شماره‌ای را انتخاب کنید که قبلاً استفاده شده است، xpra کار نخواهد کرد.
  • چند شماره اول (0، 1، 2) معمولاً توسط کارسازهای واقعی X استفاده می‌شوند.
  • هر کسی که با استفاده از ssh(1) با قابلیت فوروارد X به یک ماشین معین متصل شود نیز از یک شماره نمایشگر استفاده خواهد کرد؛ ssh عموماً اعدادی نزدیک به ده (10، 11، 12، ...) را انتخاب می‌کند.

هنگام مشخص کردن یک کارساز xpra برای یک برنامه کلاینت مانند xpra attach، xpra detach، xpra stop، xpra exit، xpra version، xpra info، xpra list یا xpra screenshot، می‌توانید از یک نمایشگر به فرم :DISPLAY برای اشاره به کارساز روی میزبان محلی، یا به فرم ssh://[USER@]HOST/DISPLAY برای اشاره به کارساز روی یک میزبان دوردست استفاده کنید؛ xpra به‌طور خودکار با استفاده از ssh(1) به میزبان دوردست متصل می‌شود. عموماً، اگر فقط یک نشست xpra بر روی یک ماشین در حال اجرا دارید (که می‌توانید با اجرای xpra list روی آن ماشین تأیید کنید)، می‌توانید شماره را کاملاً نادیده بگیرید؛ xpra attach به تنهایی به تک کارساز xpra موجود روی ماشین فعلی، صرف‌نظر از شماره آن، متصل می‌شود و به همین ترتیب xpra attach ssh://frodo به تک نشست xpra روی یک ماشین دوردست متصل خواهد شد.

اتصال با استفاده از شماره نمایشگر بر این فرض استوار است که کلاینت و کارساز از پیکربندی یکسانی برای دایرکتوری‌های سوکت استفاده می‌کنند، یا دست‌کم کلاینت می‌تواند حداقل یکی از دایرکتوری‌های مورد استفاده توسط سوکت‌های دامنه یونیکس (unix domain sockets) را پیدا کند (نگاه کنید به bind، socket-dir و socket-dirs).

اگر کارساز xpra در زمان شروع، گزینه --bind-tcp=[HOST]:PORT (یا --bind-ssl، --bind-ws، --bind-wss، --bind-vsock) را دریافت کرده باشد، می‌توانید با استفاده از نمایشگری به شکل tcp://HOST:PORT[/DISPLAY]، ssl://HOST:PORT[/DISPLAY]، ws://HOST:PORT[/DISPLAY]، wss://HOST:PORT[/DISPLAY] یا vsock://HOST:PORT[/DISPLAY] نیز به آن متصل شوید.

این دستور یک کارساز xpra جدید را همراه با تمام پیکربندی‌های لازم راه‌اندازی می‌کند. (هنگام راه‌اندازی یک کارساز از راه دور با ساختار نحوی ssh://HOST/DISPLAY، به نشست جدید نیز متصل خواهد شد.)

یک کارساز X11 تو‌در‌تو (nested) را راه‌اندازی می‌کند؛ تمام دستورهای فرزند در این کارساز X11 تو‌در‌تو اجرا خواهند شد.

این دستور به یک کارساز در حال اجرای xpra متصل می‌شود و هر برنامه‌ای را که از آن کارساز استفاده می‌کند بازمی‌فرستد (forward) تا روی صفحه نمایش فعلی شما ظاهر شود..SS xpra detach نمایشگر xpra مشخص‌شده را جدا می‌کند.

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

نسخهٔ سرور را جویا شده و آن را چاپ می‌کند. نکته: سرورهای قدیمی‌تر ممکن است از این قابلیت پشتیبانی نکنند.

تلاش می‌کند به یک سرور متصل شود تا زنده بودن آن را بررسی کند. این قابلیت معمولاً حتی پیش از احراز هویت نیز در دسترس است. در صورتی که سرور پاسخ دهد، این دستور 0 را برمی‌گرداند.

بسیار شبیه به connect-test است، اما این زیردستور اطلاعات پایه‌ای دریافت‌شده از سرور را نیز چاپ می‌کند: pid، uuid و غیره.

اطلاعات کامل نسخه، وضعیت و آمارها را از سرور جویا می‌شود.

ویژگی‌های کلیدی وضعیت سلامت سرور را نمایش می‌دهد.

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

این دستور داخلی، اسکریپت run-xpra مورد استفاده در اتصال‌های ssh را ایجاد می‌کند.

این دستور به یک سرور در حال اجرای xpra متصل می‌شود و درخواست خاتمهٔ فوری آن را می‌دهد. این کار عموماً باعث می‌شود برنامه‌هایی که از آن سرور استفاده می‌کنند نیز خاتمه یابند.

این دستور به یک سرور در حال اجرای xpra متصل می‌شود و درخواست خاتمهٔ فوری آن را می‌دهد. بر خلاف xpra stop، فرایند Xvfb و کلاینت‌های X11 آن (در صورت وجود) در حال اجرا باقی خواهند ماند.

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

این دستور تمامی سرورهای xpra را که توسط کاربر فعلی روی سیستم فعلی راه‌اندازی شده‌اند، یافته و آن‌ها را فهرست می‌کند.

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

مشابه upgrade است اما برای سرورهایی که با استفاده از desktop راه‌اندازی شده‌اند. امکان ارتقای یک سرور بدون درز (seamless) به یک سرور دسکتاپ (desktop) و بالعکس وجود دارد.

مشابه upgrade و upgrade-desktop است؛ اما بدون نیاز به مشخص کردن اینکه آیا سرور برای بازیابی یک سرور بدون درز (seamless) است یا یک سرور دسکتاپ (desktop). بر خلاف زیردستورهای upgrade، دستور recover همچنین می‌تواند تشخیص دهد کدام نمایشگرها به بازیابی نیاز دارند؛ یعنی نمایشگرهایی که پیش‌تر توسط یک سرور xpra استفاده می‌شدند اما این سرور اکنون ناپدید شده است.

این دستور یک نمایشگر موجود را بازتاب (shadow) می‌کند و روی بسترهای X11، MacOS و MS Windows پشتیبانی می‌شود. (این قابلیت هنوز روی Wayland پشتیبانی نمی‌شود)

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

توجه داشته باشید که این حالت عملیاتی از screenscraping استفاده می‌کند که چندان کارآمد نیست. انکودرهای ویدیو تا حدی این کاستی را جبران می‌کنند.

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

برای ارائهٔ تمام مانیتورهای متصل به نمایشگر :1 به‌صورت یک پنجرهٔ واحد،
از گزینهٔ multi-window استفاده کنید:
xpra shadow :1,multi-window=no
برای بازتاب یک خروجی خاص با استفاده از نام آن (مثلاً: DP-1):

xpra shadow :1,DP-1
یا به صورت صریح‌تر:
xpra shadow :1,plug=DP-1
برای ارائهٔ یک ناحیهٔ مستطیلی به اندازهٔ 1920x1080 به‌صورت یک پنجرهٔ واحد، استفاده کنید از:

xpra shadow :1,1920x1080
همچنین ممکن است بخواهید موقعیت این مستطیل را مشخص کنید (مثلاً: 1280x0):
xpra shadow :1,1920x1080@1280x0
یا با استفاده از نحو صریح‌تر:
xpra shadow :1,geometry=1920x1080@1280x0
می‌توان چندین ناحیه را با استفاده از / به‌عنوان جداکننده مشخص کرد، که هر یک به‌صورت یک پنجرهٔ جداگانه ارائه خواهند شد:
xpra shadow :1,1920x1080@1280x0/1280x600@0x400.SS xpra proxy این دستور به یک سرور منفرد اجازه می‌دهد تا اتصال‌ها را برای چندین سرور دیگر پروکسی کند و بالقوه به عنوان نقطه ورودی توازن بار (load balancing) یا احراز هویت برای نشست‌های متعددی عمل نماید. سرور پروکسی برای هر اتصال پروکسی، یک فرایند جدید ایجاد خواهد کرد؛ این فرایند پروکسی یک سوکت دامنه یونیکس جدیدِ بدون احراز هویت ایجاد می‌کند که می‌تواند همراه با زیردستورهای id، info، version و stop استفاده شود.

برخی پلتفرم‌ها و مدیر بسته‌ها ممکن است ترجیح دهند فقط کلاینت را بسازند و سرور را نسازند. در این حالت، تنها زیردستور attach در دسترس خواهد بود.

شماره نسخه xpra را نمایش می‌دهد.
خلاصه‌ای از نحوه استفاده در خط فرمان را نمایش می‌دهد.
تمام ویژگی‌های غیرضروری را غیرفعال می‌کند.
ثبت وقایع اشکال‌زدایی را فعال می‌کند. مقدار ویژه all تمام اشکال‌زدایی‌ها را فعال می‌سازد. برای دریافت فهرست کامل دسته‌های ثبت وقایع، دستور xpra -d help را اجرا کنید. برای هدف قرار دادن ثبات‌هایی (loggers) که از بیش از یک دسته ثبت وقایع استفاده می‌کنند (چرا که برخی دسته‌ها می‌توانند بسیار کلی باشند)، آن‌ها را با '+' به هم متصل کنید. برای مثال، جهت فعال‌سازی ثبت وقایع برای server و keyboard، از --debug server+keyboard استفاده کنید. همچنین می‌توانید یک دسته را با پیشوند '-' مستثنی کنید. برای مثال، جهت فعال‌سازی اشکال‌زدایی shadow و عدم فعال‌سازی clipboard، استفاده کنید از: --debug shadow,-clipboard.
امکان اجرای دستورات روی سرور را فعال یا غیرفعال می‌کند. عموماً کلاینت‌ها انتظار دارند بتوانند اجرای دستورات جدید توسط سرور را درخواست کنند، اما می‌توان این قابلیت را برای قفل و ایمن‌سازی سرور غیرفعال کرد.
امکان اتصال به سوکت xpra با استفاده از زیردستور shell را فعال یا غیرفعال می‌کند. این مورد برای اشکال‌زدایی مفید است و به طور پیش‌فرض فعال نیست. هنگام غیرفعال بودن، باز هم می‌توان با استفاده از گزینه‌های bind آن را برای هر سوکت به طور جداگانه فعال کرد.
کانال کنترلی سوکت‌های xpra را فعال یا غیرفعال می‌کند. این کانال با استفاده از زیردستور control برای برهم‌کنش با یک فرایند xpra در دسترس قرار می‌گیرد.
انتقال داده‌های پیکسلی به روش نگاشت حافظه (memory-mapped) را فعال یا غیرفعال می‌کند. به طور پیش‌فرض، اگر سرور و کلاینت در یک فضای نام سیستم‌فایل یکسان قرار داشته باشند، این قابلیت خودکار فعال می‌شود. این روش انتقال داده سربار بسیار کمتری داشته و هم مصرف پردازنده (CPU) و هم ترافیک شبکه محلی را کاهش می‌دهد. هنگام متصل شدن (attach)، می‌توانید یک مسیر مطلق را نیز تعیین کنید که فایل mmap در آن ایجاد شود. هنگام استفاده در سمت سرور، می‌توان نام دقیق فایلی را که کلاینت ایجاد خواهد کرد مشخص کرد، یا فقط دایرکتوری ایجاد فایل را تعیین نمود تا چندین کلاینت بتوانند هم‌زمان متصل شده و از mmap استفاده کنند.
شناسه گروه (gid) فایل mmap را روی گروه مشخص‌شده تنظیم کرده و مجوزهای دسترسی را روی 660 قرار می‌دهد. این کار برای به اشتراک گذاشتن فایل mmap میان حساب‌های کاربری گوناگون لازم است. همچنین می‌توانید از مقادیر ویژه GROUP زیر استفاده کنید:
غیرفعال‌سازی این قابلیت؛ فایل mmap از مجوزهای پیش‌فرض فایل و مالکیت گروهی پیش‌فرض استفاده خواهد کرد.
گروه مورد استفاده همان گروهی خواهد بود که روی فایل سوکت دامنه یونیکس متصل‌شده توسط کلاینت قرار دارد. بدیهی است که این مورد تنها هنگام اتصال به سوکت‌های دامنه یونیکس عمل می‌کند.
اگر کاربر عضو گروه 'xpra' باشد از آن استفاده می‌کند؛ در غیر این صورت رفتار مشابه با SOCKET را در پیش می‌گیرد.
هدایت (forwarding) پنجره‌ها را فعال یا غیرفعال می‌کند. این مورد معمولاً کاربرد اصلی xpra است و باید فعال باشد.
حداقل اندازه را برای تمام پنجره‌های دارای حاشیه و تزیینات (decorated) تنظیم می‌کند.
حداکثر اندازه را برای تمام پنجره‌ها تنظیم می‌کند.
حالت فقط-خواندنی تمام فعالیت‌های صفحه‌کلید و موشواره را نادیده می‌گیرد.
همگام‌سازی کلیپ‌بورد را فعال یا غیرفعال می‌کند. اگر روی سرور غیرفعال شود، هیچ کلاینتی قادر به استفاده از همگام‌سازی کلیپ‌بورد نخواهد بود. اگر در کلاینت خاموش باشد، تنها این اتصال خاص داده‌های کلیپ‌بورد را از سرور نادیده می‌گیرد. همچنین می‌تواند برای مشخص کردن یک پیاده‌سازی متفاوت کلیپ‌بورد به کار رود. انواع کلیپ‌بورد در دسترس از پلتفرمی به پلتفرم دیگر متغیر بوده و به محیط و گزینه‌های زمان ساخت نیز وابسته است، بنابراین بهتر است روی auto باقی بماند. انواع دیگر کلیپ‌بورد موجود ممکن است شامل موارد زیر باشد:
کلیپ‌بوردی که می‌تواند از یک نوع انتخاب (selection) به نوع دیگر تبدیل کند.
کامل‌ترین پیاده‌سازی کلیپ‌بورد، شامل پشتیبانی کامل از X11.
کلیپ‌بورد جایگزین (fallback)، با پشتیبانی محدود از X11.
کلیپ‌بورد ویژه OSX.
جهت همگام‌سازی کلیپ‌بورد را مشخص می‌کند.
راه‌اندازی سرور pulseaudio همراه با نشست را فعال یا غیرفعال می‌کند.
دستور pulseaudio مورد استفاده برای راه‌اندازی سرور pulseaudio را مشخص می‌کند، مگر اینکه با pulseaudio=no غیرفعال شده باشد.
نام این نشست را تنظیم می‌کند. این مقدار ممکن است در اعلان‌ها، ابزارهای کمکی، منوی سینی سامانه (tray menu) و غیره استفاده شود. تنظیم این مقدار روی سرور، مقداری پیش‌فرض فراهم می‌آورد که می‌تواند در سمت کلاینت بازنویسی (override) شود.
کدگذاری ترجیحی برای استفاده را مشخص می‌کند. برای مشاهده فهرست کدگذاری‌های در دسترس، از --encoding=help استفاده کنید. این گزینه می‌تواند برای انتخاب grayscale یا حالت‌های ۸ بیتی مانند png/P استفاده شود. روی اتصال‌های محلی یا پیوندهای شبکه بسیار سریع، rgb ساده نیز گزینه‌ای مناسب است. برای سایر موارد، مقدار پیش‌فرض auto بهترین کدگذاری را به صورت خودکار انتخاب می‌کند و باید در عوض از گزینه‌های min-speed و min-quality برای تنظیم دقیق استفاده کنید.
کدگذاری‌های تصویر فعال‌شده را مشخص می‌کند. این گزینه پرسوءاستفاده‌ترین گزینه خط فرمان است و بهتر است دست‌نخورده رها شود. موتور سرور برای عملکرد کارآمد به چندین کدگذاری در دسترس نیاز دارد.
میزان کاهش مقیاس (downscaling) خودکار ویدیو را از ۱ (به ندرت) تا ۱۰۰ (تهاجمی) مشخص می‌کند؛ ۰ برای غیرفعال‌سازی است. مقیاس‌بندی ویدیو معمولاً برای نواحی ویدیویی یا پنجره‌های بسیار بزرگ (به‌ویژه پنجره‌های تمام‌صفحه) جهت تلاش برای حفظ نرخ فریم مناسب استفاده می‌شود. کاهش مقیاس ویدیو اثر منفی بر کیفیت بصری داشته و باعث نوسازی خودکار (در صورت فعال بودن) خواهد شد؛ این ویژگی بیش از همه برای محتوای ویدیویی مفید است چرا که پهنای باند قابل‌توجهی را ذخیره می‌کند.
مسیری که فایل‌های سوکت Xpra در آن نوشته و جستجو می‌شوند. مکان پیش‌فرض از پلتفرمی به پلتفرم دیگر متفاوت است ("~/.xpra" و "$XDG_RUNTIME_DIR/xpra" در بیشتر سیستم‌های پوزیکس). در صورت نامشخص بودن، نخستین مقدار از socket-dirs استفاده خواهد شد. همچنین می‌توان آن را با استفاده از متغیر محیطی XPRA_SOCKET_DIR مشخص کرد.

هنگام استفاده از گزینه socket-dir، عموماً لازم است در تمام دستورات بعدی نیز socket-dir یا socket-dirs مشخص شود تا xpra بتواند با نشست‌های باز کار کند.

با تعیین یک دایرکتوری مشترک، این گزینه می‌تواند با گزینه‌های mmap-group و socket-permissions ترکیب شود تا امکان اتصال به نشست‌های Xpra میان حساب‌های کاربری مختلف همراه با شتاب‌دهی حافظه مشترک فراهم گردد..TP

--socket-dirs=DIR دایرکتوری‌هایی را مشخص می‌کند که در صورت عدم تنظیم یک مورد خاص با socket-dir، سوکت‌های موجود در آن‌ها جستجو شوند. می‌توانید هر دایرکتوری را با استفاده از یک آرگومان خط فرمان --socket-dirs جدید مشخص کنید، یا آن‌ها را با جداکننده مسیر (: در Posix) به یکدیگر متصل نمایید. مسیرها بسط داده خواهند شد. (مانند: --socket-dirs=~/.xpra:/tmp)

فعال‌سازی انتقال فایل.
این گزینه می‌تواند برای مجاز کردن طرف دوردست در باز کردن خودکار فایل‌ها پس از بارگذاری استفاده شود. اگر از xpra برای محدود کردن مواردی که کلاینت‌ها می‌توانند روی سرور اجرا کنند استفاده می‌کنید، این گزینه ممکن است یک مخاطره امنیتی باشد.
رهگیری اجرای xdg-open و ارسال درخواست به کلاینت.
دستوری که برای باز کردن فایل‌ها و URLها استفاده می‌شود.
محدود کردن مصرف پهنای باند به کمتر از مقدار تعیین‌شده. مقدار ارائه‌شده توسط کلاینت نمی‌تواند حد مجاز سرور را افزایش دهد. این مقدار را می‌توان با استفاده از واحدهای استاندارد مشخص کرد، مانند: 1Mbps یا 500K. در حالت auto، کلاینت مقدار محدودیت پهنای باند را روی ۸۰٪ حداکثر سرعت رابط شبکه‌ای که برای اتصال به سرور استفاده می‌کند، تنظیم خواهد کرد.

--splash=yes|no|auto نمایش یک صفحه آغازین (splash screen) در هنگام راه‌اندازی کلاینت یا سرور. با مقدار پیش‌فرض auto، صفحه آغازین تنها در صورتی نمایش داده می‌شود که یک رابط کاربری گرافیکی (GUI) در دسترس باشد - یعنی هنگامی که xpra از یک نشست SSH اجرا می‌شود، تلاشی برای نمایش صفحه آغازین صورت نخواهد گرفت.

به‌طور پیش‌فرض، سرور xpra به پس‌زمینه می‌رود (اصطلاحاً دیمن می‌شود) و خروجی خود را به یک فایل لاگ هدایت می‌کند. از این گزینه می‌توان برای جلوگیری از این رفتار استفاده کرد (عمدتاً برای عیب‌یابی مفید است).
تغییر اندازه نمایشگر مجازی برای تطابق با وضوح تصویر کلاینتی که در حال حاضر متصل است. این گزینه فقط برای زیردستورهای start و desktop اعمال می‌شود. اگر یک وضوح تصویر مشخص شود، این مقدار وضوح تصویر اولیه نمایشگر خواهد بود و نمایشگر قابل تغییر اندازه خواهد بود. همچنین می‌توان از مجموعه کوچکی از نام‌های مستعار از پیش تعریف‌شده استفاده کرد: QVGA، VGA، SVGA، XGA، 1080p، FHD، 4K.
رفتن به این دایرکتوری پس از دیمن شدن.
هنگام اجرای سرور با کاربر ریشه (root)، این گزینه‌ها می‌توانند برای کاهش سطح دسترسی به UID / GID داده‌شده استفاده شوند.
شناسه فرایند (PID) سرور را هنگام راه‌اندازی در این فایل می‌نویسد. اگر فایل جایگزین نشده باشد، با خروج سرور حذف خواهد شد.
پیکربندی می‌کند که کدام اداره‌کننده‌های چالش (challenge handlers) توسط کلاینت و با چه ترتیبی استفاده شوند. این گزینه ممکن است برای تعیین چندین اداره‌کننده تکرار شود، که در صورت ارسال بیش از یک چالش احراز هویت از سوی سرور مفید خواهد بود. مقدار پیش‌فرض all است که متناظر است با: uri,file,env,kerberos,gss,u2f,prompt.
استفاده از گذرواژه مشخص‌شده در رشته اتصال، در صورت وجود.
نام فایل استفاده‌شده برای ذخیره گذرواژه را می‌توان با گزینه filename مشخص کرد. اگر این گزینه مشخص نشود، به استفاده از فایل گذرواژه مشخص‌شده با سوئیچ password-file بازمی‌گردد.
استفاده از گذرواژه ارائه‌شده از طریق متغیر محیطی مشخص‌شده با گزینه name، که در صورت عدم تعیین، مقدار پیش‌فرض XPRA_PASSWORD خواهد بود.
درخواست یک توکن kerberos برای سرویس مشخص‌شده.
درخواست یک توکن gss برای سرویس مشخص‌شده.
درخواست یک توکن از یک دستگاه U2F.
درخواست مقدار از کاربر. کلاینت‌های ترمینال این درخواست را با ورودی متنی و کلاینت‌های گرافیکی با یک کادر محاوره‌ای نمایش می‌دهند.
حداقل شماره پورت مجاز هنگام ایجاد سوکت‌های TCP. می‌توانید از مقدار کمتری استفاده کنید تا به کاربران عادی اجازه داده شود هنگام شروع نشست‌ها از طریق سرور پراکسی سراسری سیستم، به پورت‌های ممتاز متصل شوند. مقدار پیش‌فرض 1024 است که مقدار استاندارد برای پورت‌های ممتاز به‌شمار می‌رود.
فعال یا غیرفعال کردن اعلان نشست‌های جدید از طریق mDNS.
شروع نشست در یک بستر dbus-launch؛ می‌توانید دستور اجرای dbus مورد نظر را تعیین کرده یا آن را کاملاً غیرفعال کنید. برخی از ویژگی‌ها ممکن است بدون یک بستر dbus در دسترس نباشند.
راه‌اندازی یک سرور dbus که می‌تواند برای تعامل با فرایند سرور استفاده شود..SS گزینه‌ها برای seamless، desktop، upgrade و listen: در نسخه‌های پیشین، احراز هویت برای هر نوع اتصال با استفاده از یک گزینهٔ خط فرمان جداگانه پیکربندی می‌شد که برای تمام اتصالات از همان نوع اعمال می‌گردید؛ مانند: tcp-auth برای bind-tcp. اگرچه این روش همچنان به عنوان یک سازوکار جایگزین (fallback) پشتیبانی می‌شود، روش توصیه‌شده تعیین گزینه‌های احراز هویت با استفاده از ویژگی‌های bind است؛ مانند: bind-tcp=0.0.0.0:14500,auth=file,filename=password.txt. این ویژگی‌ها همچنین می‌توانند گزینه‌های پیکربندی اضافی سوکت را تعریف کنند.

--bind=BIND_LOCATION[,PROPERTIES] ایجاد یک سوکت دامنهٔ یونیکس (Unix domain socket) محلی (در یونیکس) یا لولهٔ نام‌گذاری‌شده (named-pipe) (در MS Windows) به ازای هر گزینهٔ bind مشخص‌شده.

این گزینه می‌تواند چندین بار برای تعیین چندین مکان سوکت مشخص شود. این سوکت‌ها از اتصالات محلی با نشانی نمایش به سبک :7 و اتصالات از راه دور با نشانی نمایش به سبک ssh://frodo/7 پشتیبانی می‌کنند.

سوکت‌های محلی در صورت فعال بودن سوئیچ html ممکن است اتصالات HTTP / Websocket را نیز پردازش کنند.

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

هیچ سوکتی ایجاد نمی‌کند
پیش‌فرض سازگار با نسخه‌های قبلی که از socket-dir فعلی استفاده می‌کند
ایجاد یک سوکت در دایرکتوری مشخص‌شده؛ اگر دایرکتوری وجود نداشته باشد، ایجاد خواهد شد - برای جلوگیری از اشتباه گرفته شدن با قالب PATH باید اسلش انتهایی را لحاظ کنید:
ایجاد سوکت با استفاده از مسیر مشخص‌شده
ایجاد یک سوکت TCP به ازای هر گزینهٔ --bind-tcp مشخص‌شده. اگر بخش میزبان حذف شود، از 127.0.0.1 (localhost) استفاده خواهد شد. اگر می‌خواهید اتصالات را روی تمام رابط‌ها بپذیرید، مقدار 0.0.0.0 را برای بخش میزبان ارسال کنید.

استفاده از این سوئیچ بدون تنظیم گزینهٔ auth توصیه نمی‌شود و یک خطر امنیتی بزرگ است (به‌ویژه هنگام ارسال 0.0.0.0)! هر کسی می‌تواند به این پورت متصل شده و به نشست شما دسترسی پیدا کند.

سوکت‌های TCP در صورت فعال بودن سوئیچ html ممکن است اتصالات HTTP / Websocket را نیز پردازش کنند. سوکت‌های TCP در صورت فعال بودن سوئیچ ssl ممکن است به سوکت‌های SSL ارتقا یابند.

ایجاد یک شنوندهٔ HTTP / Websocket. برای محدودیت‌های میزبان به bind-tcp مراجعه کنید؛ باید از auth-ws برای ایمن‌سازی دسترسی استفاده نمایید.
ایجاد یک شنوندهٔ HTTPS / Websocket امن (WSS). برای محدودیت‌های میزبان به bind-tcp مراجعه کنید؛ باید از auth-wss برای ایمن‌سازی دسترسی استفاده نمایید.
دقیقاً مانند --bind-tcp اما برای سوکت‌های SSL. به ssl-auth و سایر گزینه‌های SSL مراجعه کنید.
گوش دادن به اتصالات RFB روی پورت ارائه‌شده. این سوکت‌ها تنها در حالت‌های desktop و shadow پشتیبانی می‌شوند.
ایجاد یک سوکت VSOCK به ازای هر گزینهٔ --bind-vsock مشخص‌شده.
ماژول احراز هویتی را مشخص می‌کند که باید برای تمام سوکت‌های دامنهٔ یونیکس ایجاد شده با سوئیچ bind استفاده شود. ماژول‌های احراز هویت می‌توانند نام کاربری و گذرواژه را در برابر انواع ماژول‌های پس‌زمینه (backend) اعتبارسنجی کنند:
همیشه احراز هویت را مجاز می‌داند - این کار خطرناک است و فقط باید برای آزمایش استفاده شود
همیشه احراز هویت را رد می‌کند؛ برای آزمایش مفید است
با متغیر محیطی مشخص‌شده توسط گزینهٔ name (که پیش‌فرض آن XPRA_PASSWORD است) مطابقت می‌دهد؛ مانند: --auth=env,name=SOME_OTHER_ENV_VAR_NAME.
با گذرواژهٔ مشخص‌شده با استفاده از گزینهٔ value مطابقت می‌دهد؛ مانند: --auth=password,value=YOURPASSWORD. نکته: این گزینهٔ خط فرمان ممکن است برای سایر فرایندهای موجود در همان سیستم قابل مشاهده باشد.
گذرواژه را با داده‌های گذرواژهٔ موجود در فایل مشخص‌شده توسط گزینهٔ filename بررسی می‌کند؛ مانند: --auth=file,filename=./password.txt.

محتوای این فایل به عنوان داده‌های باینری در نظر گرفته می‌شود؛ هیچ محدودیتی در مورد کدگذاری نویسه‌ها یا اندازهٔ فایل وجود ندارد. مراقب نویسه‌های خط جدید (newline) انتهایی باشید، زیرا در داده‌های گذرواژه لحاظ خواهند شد.

نام کاربری و گذرواژه را با فایل مشخص‌شده توسط گزینهٔ filename بررسی می‌کند. فایل باید شامل اعتبارنامه‌های هر کاربر در یک خط، به شکل زیر باشد:

username|password|uid|gid|displays|env_opts|session_opts

نام‌های کاربری یا گذرواژه‌ها نمی‌توانند شامل نویسه خط عمودی | (که به عنوان جداکننده استفاده می‌شود)، خط جدید یا بازگشت به ابتدای خط (carriage return) باشند. این ماژول منسوخ شده است و به‌جای آن باید از sqlite استفاده شود.

نام کاربری و گذرواژه را با فایل پایگاه داده sqlite مشخص‌شده توسط گزینهٔ filename (برای پس‌زمینهٔ sqlite)، یا پایگاه داده مشخص‌شده با گزینهٔ uri (برای پس‌زمینه‌های mysql و sql) بررسی می‌کند. احراز هویت با استفاده از پرس‌وجوی زیر پردازش خواهد شد (که با استفاده از گزینهٔ password_query قابل پیکربندی است): SELECT password FROM users WHERE username=(?) نشست‌های موجود برای هر کاربر با استفاده از پرس‌وجوی زیر دریافت خواهد شد: (این مقدار با استفاده از گزینهٔ sessions_query قابل پیکربندی است): SELECT uid, gid, displays, env_options, session_options FROM users WHERE username=(?) چند نمایشگر می‌توانند به صورت یک فهرست جداشده با کاما مشخص شوند.
میزبان را با استفاده از کتابخانهٔ tcp-wrappers سیستم بررسی می‌کند. (تنها در Posix، و در Mac OS در دسترس نیست) برای جزئیات به hosts.allow و hosts.deny مراجعه کنید.
دستوری را که با استفاده از ویژگی command مشخص شده است اجرا می‌کند؛ آرگومان‌های این دستور عبارتند از: شرحی از درخواست دسترسی و مقدار timeout (همچنین قابل پیکربندی). اگر دستور مشخص نشده باشد، سیستم تلاش خواهد کرد ابزار کمکی auth_dialog را که به همراه xpra عرضه می‌شود، پیدا کرده و استفاده کند. این دستور برای مجاز دانستن دسترسی باید 0 را برگرداند؛ هر مقدار دیگری دسترسی را رد خواهد کرد.
اعتبارنامه‌های همتای سوکت دامنهٔ یونیکس را با استفاده از SO_PEERCRED بررسی می‌کند. این ماژول احراز هویت تنها در برخی از سیستم‌عامل‌های منطبق با Posix در دسترس است. این ماژول بررسی می‌کند که آیا سیستم‌عامل uid و gid فرایندی را که اتصال را آغاز کرده است ارائه می‌دهد یا خیر. دسترسی را می‌توان با ارائهٔ فهرستی از uidها و gidهای معتبر و جداشده با دونقطه (:) که اجازهٔ اتصال دارند، محدود کرد. این مقادیر شناسه را می‌توان با استفاده از مقادیر عددی یا نام‌های کاربری / نام‌های گروه مشخص کرد. تفاوت این ماژول با بقیه در این است که نیازی به ارائهٔ نام کاربری یا گذرواژه توسط کلاینت ندارد، زیرا آن‌ها نادیده گرفته می‌شوند. متغیرهای محیطی و شبه‌متغیرهای محیطی نیز می‌توانند به عنوان مقادیر استفاده شوند؛ مانند: --auth=peercred,uid=\$UID:fred,gid=xpra.
اعتبارسنجی نام کاربری و گذرواژه با استفاده از سامانهٔ PAM
اعتبارسنجی نام کاربری و گذرواژه با استفاده از احراز هویت Microsoft Windows (تنها در این پلتفرم موجود است)
ماژول احراز هویت مناسب سیستم را به‌طور خودکار انتخاب می‌کند (یا pam یا win32)
اعتبارسنجی نام کاربری و گذرواژه با استفاده از احراز هویت kerberos. هشدار: این ماژول از بلیت‌های کربروس استفاده نمی‌کند و گذرواژه به صورت متن ساده (plain text) به کارساز فرستاده خواهد شد. این گزینه تنها باید برای آزمایش استفاده شود.
اعتبارسنجی یک بلیت kerberos دریافت‌شده توسط کلاینت.
اعتبارسنجی یک بلیت GSS دریافت‌شده توسط کلاینت.
درخواست یک توکن U2F از کلاینت..IP ldap نام کاربری و گذرواژه را با استفاده از کتابخانهٔ python-ldap در برابر یک کارساز LDAP اعتبارسنجی می‌کند.
نام کاربری و گذرواژه را با استفاده از کتابخانهٔ پایتون ldap3 در برابر یک کارساز LDAP اعتبارسنجی می‌کند.
مشابه گزینهٔ auth است، با این تفاوت که تنها برای سوکت‌های TCP (سوکت‌های تعریف‌شده با استفاده از گزینهٔ bind-tcp) اعمال می‌شود. منسوخ شده است؛ از گزینه‌های احراز هویت به ازای هر سوکت استفاده کنید.
مشابه گزینهٔ auth است، با این تفاوت که تنها برای سوکت‌های ws اعمال می‌شود: سوکت‌های تعریف‌شده با استفاده از گزینهٔ bind-ws، یا سوکت‌های TCP ارتقایافته به وب‌سوکت (در صورتی که گزینهٔ html فعال باشد). منسوخ شده است؛ از گزینه‌های احراز هویت به ازای هر سوکت استفاده کنید.
مشابه گزینهٔ auth است، با این تفاوت که تنها برای سوکت‌های wss اعمال می‌شود: سوکت‌های تعریف‌شده با استفاده از گزینهٔ bind-wss، سوکت‌های ws ارتقایافته به SSL (در صورتی که گزینهٔ ssl فعال باشد) یا سوکت‌های TCP ارتقایافته به SSL و سپس به wss (در صورتی که هر دو گزینهٔ ssl و html فعال باشند). منسوخ شده است؛ از گزینه‌های احراز هویت به ازای هر سوکت استفاده کنید.
مشابه گزینهٔ auth است، با این تفاوت که تنها برای سوکت‌های SSL اعمال می‌شود: سوکت‌های تعریف‌شده با استفاده از گزینهٔ bind-ssl، یا سوکت‌های TCP ارتقایافته توسط ssl=auto یا ssl=on. منسوخ شده است؛ از گزینه‌های احراز هویت به ازای هر سوکت استفاده کنید.
پودمان احراز هویت برای استفاده در سوکت‌های bind-rfb. منسوخ شده است؛ از گزینه‌های احراز هویت به ازای هر سوکت استفاده کنید.
مشابه گزینهٔ auth است، با این تفاوت که تنها برای سوکت‌های VSOCK (سوکت‌های تعریف‌شده با استفاده از گزینهٔ bind-vsock) اعمال می‌شود. منسوخ شده است؛ از گزینه‌های احراز هویت به ازای هر سوکت استفاده کنید.

دستور پوشاننده‌ای که به ابتدای تمامی دستورهای راه‌اندازی افزوده می‌شود. معمولاً این گزینه برای راه‌اندازی همهٔ زیردستورها از طریق VirtualGL استفاده می‌شود.
پس از راه‌اندازی کارساز، دستور CMD را با استفاده از پوسته پیش‌فرض اجرا می‌کند. این دستور در حالی اجرا می‌شود که مقدار $DISPLAY آن روی کارساز تازه راه‌اندازی‌شده تنظیم شده است. برای اجرای چندین دستور می‌توان این گزینه را چندین بار مشخص کرد.
مشابه --start است، با این تفاوت که این دستورها توسط --exit-with-children در نظر گرفته می‌شوند.
پیش از اجرای دستور، منتظر اتصال نخستین کلاینت می‌ماند.
پیش از اجرای دستور فرزند، منتظر اتصال نخستین کلاینت می‌ماند. گزینهٔ start-child را ببینید.
این دستور را با هر بار اتصال یک کلاینت اجرا می‌کند.
این دستور فرزند را با هر بار اتصال یک کلاینت اجرا می‌کند. گزینهٔ start-child را ببینید.
این دستور را هر بار که کلاینتی قطع اتصال می‌کند و هیچ کلاینت دیگری باقی نمانده است، اجرا می‌کند.
این دستور فرزند را هر بار که کلاینتی قطع اتصال می‌کند و هیچ کلاینت دیگری باقی نمانده است، اجرا می‌کند. گزینهٔ start-child را ببینید.
هنگام متوقف شدن (stop) کارساز، تمام دستورهای فرزندی را که توسط کارساز راه‌اندازی شده‌اند خاتمه می‌دهد. این امر بر خروج (exit) کارساز تأثیری ندارد. اکثر دستورهای فرزند به نمایشگر وابسته هستند، بنابراین معمولاً در هر صورت به اجبار متوقف می‌شوند، اما این گزینه به آن‌ها زمان بیشتری برای پاک‌سازی صحیح می‌دهد و می‌تواند برای متوقف کردن دستورهای پس‌زمینه‌ای که به نمایشگر متصل نیستند استفاده شود.
این گزینه تنها زمانی قابل استفاده است که --start-child نیز داده شده باشد. در صورت تعیین، کارساز xpra وضعیت فرزندان راه‌اندازی‌شده توسط --start-child را زیر نظر می‌گیرد و با خارج شدن آخرین مورد، خودبه‌خود به کار خود پایان می‌دهد.
هنگامی که دیگر هیچ پنجره یا سینی سیستمی برای بازارسال وجود نداشته باشد، کارساز به طور خودکار خاتمه می‌یابد. این گزینه فقط برای کارسازهای بی‌وقفه (seamless) کاربرد دارد.
کارساز با قطع اتصال آخرین کلاینت خاتمه خواهد یافت.
متغیرهای محیطی اضافی که تنها بر دستورهای راه‌اندازی‌شده از طریق --start یا --start-child تأثیر می‌گذارند.
به کلاینت‌ها اجازه می‌دهد تا از کارساز تقاضای اجرای دستورهای جدید را داشته باشند. (از این قابلیت می‌توان از طریق کانال کنترلی نیز بهره برد)
در صورت فعال بودن، زیردستورهای seamless و desktop به نمونهٔ کارساز پروکسی سراسری سیستم واگذار خواهند شد. در حالت auto، این واگذاری تنها در صورتی رخ می‌دهد که کارساز پروکسی سراسری سیستم پیدا شود.
دستورهای راه‌اندازی کارساز را درون systemd-run کپسوله‌سازی می‌کند.
آرگومان‌های خط فرمانی که به systemd-run ارسال می‌شوند.
به جای شروع یک نمایشگر با xvfb، از یک نمایشگر موجود استفاده می‌کند. مسئولیت راه‌اندازی نمایشگر بر عهدهٔ خود شماست. از این گزینه همچنین می‌توان برای بازیابی نمایشگر موجودی که نمونهٔ کارساز xpra آن با فروپاشی مواجه شده، یا برای اجرای xpra روی یک کارساز X11 شتاب‌یافته استفاده کرد. در صورت استفاده از auto، برنامهٔ xpra اگر نمایشگر موجود را پیدا کند از آن بهره خواهد برد.
کارساز xpra شمارهٔ نمایشگر را به عنوان یک رشتهٔ پایان‌یافته با خط جدید روی این توصیف‌گر فایل می‌نویسد. این گزینه بیشترین کاربرد را زمانی دارد که شمارهٔ نمایشگر در زیردستورهای seamless یا desktop برنامهٔ xpra مشخص نشده باشد.
هنگام راه‌اندازی یک کارساز بی‌وقفه، xpra یک کارساز مجازی X را برای اجرای کلاینت‌ها روی آن راه‌اندازی می‌کند. اگر Xvfb شما در مسیری نامتعارف نصب شده است یا می‌خواهید از کارساز مجازی X دیگری استفاده کنید، این گزینه امکان تعیین نحوهٔ اجرای فایل اجرایی کارساز X دلخواهتان را فراهم می‌کند. مقدار پیش‌فرض استفاده‌شده به بستر شما بستگی دارد. دستور توصیه‌شده برای استفاده در اینجا Xorg به همراه درایور dummy است که به عنوان Xdummy نیز شناخته می‌شود. ببینید: https://github.com/Xpra-org/xpra/blob/master/docs/Usage/Xdummy.md برخی توزیع‌ها قادر به پیکربندی درست آن نیستند و در عوض از Xvfb استفاده خواهند کرد.
پنجره‌ها معمولاً فقط در کلاینت(ها) نمایش داده می‌شوند و روی نمایشگر مجازی رسم نمی‌شوند. برخی برنامه‌ها مانند نرم‌افزارهای ضبط صفحه ممکن است نیاز به ضبط محتوای پنجره داشته باشند؛ می‌توانید از این گزینه برای فعال‌سازی ترسیم با یک تأخیر قابل تنظیم (به میلی‌ثانیه) استفاده کنید. هشدار: این ترسیم اضافی سنگین و بسیار کند است، به همین دلیل به صورت پیش‌فرض فعال نیست.
پس از راه‌اندازی کارساز، بلافاصله یک کلاینت را به آن متصل می‌کند. با مقدار auto، کلاینت فقط برای کارسازهای راه‌دور (کارسازهایی که با یک نشانی شبکه مشخص شده‌اند) راه‌اندازی می‌شود. اگر یک نمایشگر مشخص شده باشد و کارساز از پیش در حال اجرا باشد، xpra تلاشی برای راه‌اندازی کارساز جدید نمی‌کند و صرفاً به آن متصل می‌شود.
پاسخ‌گویی به درخواست‌های HTTP روی درگاه(های) TCP و سوکت‌های محلی. این امر نیازمند آن است که حداقل یک درگاه TCP یا سوکت محلی با استفاده از گزینهٔ منطبق bind پیکربندی شده باشد.
دسترسی به کلاینت html5 را از طریق http فعال می‌کند. حالت auto در صورت یافتن پشتیبانی، آن را فعال خواهد کرد. همچنین می‌توانید مسیر ریشهٔ وب (web root) مورد نظر خود را به عنوان آرگومان مشخص کنید.
فعال‌سازی اسکریپت‌های توکار وب‌سرور که وضعیت سرور، نشست‌ها و نمایشگرهای فعال کنونی و فهرست برنامه‌ها و نشست‌های میزکار نصب‌شده را ارائه می‌دهند. این موارد می‌توانند توسط رابط کاربری کلاینت استفاده شوند.
به کلاینت‌های RFB (مانند: VNC) اجازه می‌دهد به یک سوکت سادهٔ TCP متصل شوند. اگر پس از DELAY ثانیه هیچ داده‌ای دریافت نشود، سرور یک مصافحهٔ RFB ارسال خواهد کرد. این گزینه فقط برای سرورهایی که در حالت‌های desktop یا shadow راه‌اندازی شده‌اند کاربرد دارد.
رمزگذارهای ویدیویی را که باید برای بارگذاری تلاش شود، مشخص می‌کند. به‌طور پیش‌فرض، همهٔ آن‌ها بارگذاری می‌شوند، اما می‌توان فهرست محدودتری از رمزگذارها را تعیین کرد. برای دریافت فهرستی از گزینه‌ها، از مقدار ویژهٔ 'help' استفاده کنید. برای بارگذاری نکردن هیچ رمزگذار ویدیویی، از مقدار 'none' استفاده کنید.
پیمانه‌های تبدیل فضای رنگ (colourspace conversion) را برای بارگذاری مشخص می‌کند. به‌طور پیش‌فرض، همهٔ آن‌ها بارگذاری می‌شوند، اما می‌توان فهرست محدودتری از پیمانه‌ها را تعیین کرد. برای دریافت فهرستی از گزینه‌ها، از مقدار ویژهٔ 'help' استفاده کنید. برای بارگذاری نکردن هیچ پیمانهٔ تبدیل فضای رنگی، از مقدار 'none' استفاده کنید.
مجوزهای فایل را روی سوکت‌های دامنهٔ یونیکس سرور مشخص می‌کند. پیش‌فرض 600 است. در صورت فعال بودن mmap-group، این مقدار نادیده گرفته می‌شود.

رمزنگار (cipher) مورد استفاده برای ایمن‌سازی اتصال در برابر دسترسی‌های غیرمجاز را مشخص می‌کند. این گزینه نیازمند استفاده از گزینهٔ --encryption-keyfile است. در حال حاضر تنها رمزنگارهای پشتیبانی‌شده عبارتند از:
برای سرورها، به کلاینت اجازه می‌دهد هر یک از حالت‌هایی را که مایل است انتخاب کند. برای کلاینت‌ها، این یک نام مستعار برای AES-CBC است و ترجیح بر این است که از یک حالت مشخص‌تر استفاده شود.
AES در حالت cipher block chaining
AES در حالت galois/counter mode
AES در حالت cipher feedback
AES در حالت counter

اگر کلاینت درخواست رمزنگاری دهد، پس از راستی‌آزمایی اولیهٔ گذرواژه، هم توسط کلاینت و هم سرور برای تمامی ارتباطات استفاده خواهد شد، البته تنها در صورتی که سرور نیز از این قابلیت پشتیبانی کند. نکته: این ویژگی به‌طور گسترده بازبینی نشده است و در وضعیت کنونی نباید در برابر مهاجمان مصمم ایمن تلقی شود.

دقیقاً مانند گزینهٔ encryption، با این تفاوت که فقط بر روی سوکت‌های TCP اعمال می‌شود (سوکت‌هایی که با استفاده از سوئیچ bind-tcp تعریف شده‌اند).
کلید مورد استفاده با رمزنگار مشخص‌شده با --encryption را تعیین می‌کند. کلاینت و سرور باید از محتوای یکسان در فایل کلید استفاده کنند.
دقیقاً مانند گزینهٔ encryption-keyfile، با این تفاوت که فقط بر روی سوکت‌های TCP اعمال می‌شود (سوکت‌هایی که با استفاده از سوئیچ bind-tcp تعریف شده‌اند).
در صورتی که برای مدت زمان مشخص‌شده (به ثانیه) هیچ فعالیتی از سوی کاربر (کلیک ماوس یا فشردن کلیدها) وجود نداشته باشد، اتصال قطع خواهد شد. برای غیرفعال کردن این مهلت زمانی، از مقدار 0 استفاده کنید.
اگر برای مدت زمان مشخص‌شده (به ثانیه) هیچ اتصال فعالی وجود نداشته باشد، سرور خارج خواهد شد. برای غیرفعال کردن این مهلت زمانی، از مقدار 0 استفاده کنید.
نام فایلی حاوی عبارت‌های باقاعده (regular expressions)؛ هر داده‌ای از کلیپ‌بورد که با یکی از این عبارت‌های باقاعده مطابقت داشته باشد دور ریخته می‌شود. نکته: در حال حاضر این مورد تنها برای رونوشت‌برداری (کپی) از دستگاهی که این گزینه در آن استفاده می‌شود اعمال می‌گردد، نه به سوی آن.
مقدار «نقطه در اینچ» (DPI) که برنامه‌های کلاینت باید سعی کنند از آن پیروی کنند. این مقدار عددی برای مفید بودن باید در بازهٔ 10 تا 500 باشد. بسیاری از برنامه‌ها این مقدار را تنها در زمان راه‌اندازی می‌خوانند، بنابراین اتصال به یک نشست موجود که با مقدار DPI متفاوتی راه‌اندازی شده است ممکن است نتیجهٔ دلخواه را در بر نداشته باشد.
هنگام راه‌اندازی سرور، این سوئیچ بیت بر پیکسل بافر فریم مجازی (virtual framebuffer) را کنترل می‌کند. مقادیر ممکن: 0 (خودکار)، 16، 24، 30. هنگام راه‌اندازی کلاینت، این سوئیچ رندر تصویر را با بک‌اند opengl کنترل می‌کند: مقادیر بالاتر از 24 ویژگی رنگ عمیق (deep color) را فعال می‌کنند، مقدار 24 رندر رنگ واقعی معمولی (true color) را فعال می‌کند. از مقدار 0 استفاده کنید تا کلاینت تصمیم بگیرد که آیا رندر از رنگ عمیق بهره‌مند خواهد شد یا خیر. (این مورد تنها روی برخی از کلاینت‌های پوزیکس پشتیبانی می‌شود) سایر مقادیر نباید استفاده شوند.
فعال یا غیرفعال کردن هدایت مکان‌نماهای سفارشی ماوس برنامه‌ها. برنامه‌های کلاینت ممکن است در هر زمان مکان‌نمای ماوس را تغییر دهند، که این امر موجب می‌شود هر بار پیکسل‌های مکان‌نمای جدید به کلاینت فرستاده شود. این گزینه قابلیت مذکور را غیرفعال می‌کند.
فعال یا غیرفعال کردن هدایت اعلان‌های سیستم. اعلان‌های سیستم نیازمند این هستند که سرور xpra نمونهٔ مستقلی از دیمن dbus داشته باشد؛ در صورت نبود آن، در زمان راه‌اندازی یک هشدار چاپ خواهد شد. این سوئیچ این قابلیت را کاملاً غیرفعال کرده و از نمایش هشدار جلوگیری می‌کند.
روش ورودی (input method) مورد نظر برای پیکربندی را مشخص می‌کند. این گزینه تعدادی از متغیرهای محیطی را تنظیم می‌کند که باید توسط برنامه‌های راه‌اندازی‌شده با گزینهٔ start-child رعایت شوند.

روش‌های (METHOD) زیر در حال حاضر پشتیبانی می‌شوند:

غیرفعال‌سازی کامل روش‌های ورودی و جلوگیری از تداخل آن‌ها با ورودی صفحه‌کلید. این حالت پیش‌فرض است.
محیط را بدون تغییر حفظ می‌کند. مسئولیت اطمینان از درستی آن بر عهدهٔ شماست.
روش ورودی اکس (X Input Method) را فعال می‌کند.
روش Intelligent Input Bus را فعال می‌کند.
روش Smart Common Input Method را فعال می‌کند.
روش Universal Input Method را فعال می‌کند.

هر مقدار دیگری نیز تنظیم خواهد شد، اما یک هشدار ایجاد می‌کند.

فعال یا غیرفعال کردن همگام‌سازی xsettings. تنظیمات xsettings فقط از کلاینت‌های پوزیکس که به سرورهای پوزیکس واقعی (نه shadow) متصل هستند هدایت می‌شوند. در حالت 'auto'، تنها سرورهای seamless همگام‌سازی xsettings را فعال می‌کنند.
فعال یا غیرفعال کردن هدایت شمایل‌های سینی سیستم (system tray). این قابلیت نیازمند پشتیبانی کلاینت است و ممکن است در تمام پلتفرم‌ها در دسترس نباشد.
فعال یا غیرفعال کردن هدایت زنگ سیستم.
فعال یا غیرفعال کردن هدایت وب‌کم.
مدیریت چرخ ماوس: می‌توان با استفاده از مقدار no هدایت چرخ ماوس را غیرفعال کرد، یا برخی یا تمام محورها را معکوس نمود: invert-all، invert-x، invert-y، invert-z..TP --remote-logging=both|all|send|receive|no
ثبت گزارش از راه دور همیشه توسط کلاینت آغاز می‌شود، اما سرور می‌تواند جهتی را که پیام‌های گزارش در آن مجاز به ارسال هستند محدود کند.
خروجی گزارش هم بازفرستاده می‌شود و هم به صورت محلی فرستاده می‌شود (به stdout، stderr یا یک فایل گزارش).
توسط سرور برای مجاز کردن هر دو حالت send و receive استفاده می‌شود؛ هنگام ارسال خروجی گزارش، دیگر به صورت محلی ذخیره نخواهد شد.
توسط کلاینت برای ارسال خروجی گزارش خود به سرور استفاده می‌شود. توسط سرور برای اجازه دادن به کلاینت‌ها جهت درخواست بازفرستادن گزارش استفاده می‌شود.
توسط کلاینت برای درخواست از سرور جهت ارسال خروجی گزارش به کلاینت استفاده می‌شود. توسط سرور برای اجازه دادن به کلاینت‌ها جهت بازفرستادن گزارش‌هایشان استفاده می‌شود.
ثبت گزارش از راه دور غیرفعال می‌شود.
همگام‌سازی صدا و تصویر را فعال یا غیرفعال می‌کند. داده‌های ویدیویی با تأخیر ارسال می‌شوند تا همگام با صدا نمایش داده شوند. نکته: این مورد فقط بر نواحی ویدیویی اعمال می‌شود، چه به طور خودکار از طریق روش‌های اکتشافی (heuristics) داخلی شناسایی شده باشند و چه با استفاده از رابط dbus مشخص شده باشند.

پنجره‌های مودال (modal windows) را رعایت می‌کند. این امر ممکن است زمانی که چندین برنامه از طریق یک سرور xpra یکسان بازفرستاده می‌شوند عوارض نامطلوبی داشته باشد: پنجره‌های مودال به جای این که تنها برای برنامه‌ای که مالک آن پنجره است مودال شوند، برای تمامی برنامه‌های بازفرستاده‌شده توسط xpra مودال خواهند شد.
نوار عنوان استاندارد پنجره را با یک نوار سفارشی جایگزین می‌کند که برای دسترسی به کنترل‌های پنجره مختص به xpra به کار می‌رود. این ویژگی می‌تواند عوارض جانبی داشته باشد و با شتاب‌دهنده OpenGL در MS Windows ناسازگار است.
گذرواژه مورد استفاده برای اتصال به سروری که از احراز هویت استفاده می‌کند را ارائه می‌دهد. منسوخ شده است، از گزینه‌های احراز هویت به ازای هر سوکت (per-socket) استفاده کنید.
از رندرینگ دارای شتاب‌دهنده OpenGL در سمت کلاینت استفاده می‌کند. حالت پیش‌فرض، بررسی پشتیبانی کارت گرافیک و درایورها است (حالت auto)، اما می‌توان OpenGL را غیرفعال کرد (no) یا فعال‌سازی آن را اجبار نمود (yes). در برخی پلتفرم‌ها همچنین می‌توان مشخص کرد که کدام Backendها استفاده شوند؛ در حال حاضر فقط gtk و native و تنها در پلتفرم‌های X11 پشتیبانی می‌شوند. برای نمونه: opengl=yes:native، یا opengl=auto:gtk,native.
بازفرستادن وب‌کم را فعال یا غیرفعال می‌کند. همچنین می‌توان دستگاه وب‌کم مورد استفاده را تعیین کرد.
سطح فشرده‌سازی مورد استفاده توسط xpra هنگام انتقال داده‌ها از طریق شبکه را تعیین می‌کند. تنها دو مقدار ممکن وجود دارد: 0 (به معنای عدم فشرده‌سازی) و 1 (فشرده‌سازی فعال).

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

این گزینه کیفیت فشرده‌سازی تصویر ثابتی را برای کدگذاری‌های اتلافی (lossy) تنظیم می‌کند (jpeg، webp، h264/h265 و vp8/vp9). ابتدا باید یکی از آن کدگذاری‌های اتلافی با استفاده از --encoding یا با استفاده از حالت پیش‌فرض auto فعال شده باشد. محدوده مقادیر از 1 (پایین‌ترین کیفیت، فشرده‌سازی بالا - به طور کلی غیرقابل استفاده) تا 100 (بالاترین کیفیت، فشرده‌سازی پایین) است. مقدار صفر را تعیین کنید تا به سیستم اجازه داده شود کیفیت را به صورت پویا برای دستیابی به بهترین استفاده ممکن از پهنای باند تنظیم کند. معمولاً بهتر است از این گزینه استفاده نکنید و به جای آن از min-quality بهره ببرید.
این گزینه حداقل کیفیت کدگذاری مجاز را هنگامی که گزینه کیفیت روی حالت خودکار تنظیم شده است، تعیین می‌کند. به quality در بالا مراجعه کنید.
این گزینه سرعت کدگذاری را از 1 (کندترین) تا 100 (سریع‌ترین) تنظیم می‌کند. سرعت کندتر بهتر فشرده می‌کند و پهنای باند کمتری مصرف خواهد کرد، و سرعت سریع‌تر تا زمانی که پهنای باند کافی وجود داشته باشد تاخیر (latency) بهتری فراهم می‌کند. سیستم به طور معمول از یک سرعت متغیر استفاده می‌کند؛ این گزینه اجبار می‌کند که به جای آن از یک تنظیم سرعت ثابت استفاده شود. معمولاً بهتر است از این گزینه استفاده نکنید و در عوض از min-speed استفاده نمایید.
این گزینه حداقل سرعت کدگذاری مجاز را در حالتی که گزینه سرعت روی حالت خودکار تنظیم شده است، تعیین می‌کند. به speed در بالا مراجعه کنید.
این گزینه تاخیری را تنظیم می‌کند که پس از آن، چنانچه محتوای پنجره‌ها قبلاً با استفاده از یک کدگذاری اتلافی به‌روزرسانی شده باشد، پنجره‌ها به طور خودکار با استفاده از یک فریم غیراتلافی (lossless) تازه‌سازی می‌شوند. این تاخیر یک عدد ممیز شناور بر حسب ثانیه است. این گزینه به صورت پیش‌فرض با تاخیر 0.25 ثانیه فعال است. این گزینه فقط هنگام استفاده از یک کدگذاری اتلافی کاربرد دارد.
کلیدهای تغییردهنده (modifiers) پیش‌فرض میانبر مورد نیاز برای key-shortcuts را تعریف می‌کند؛ سپس می‌توان به این کلیدهای تغییردهنده با عنوان # اشاره کرد. مقدار پیش‌فرض 'auto' است که در بیشتر پلتفرم‌ها به Meta+Shift ارزیابی می‌شود.
می‌تواند چندین بار برای افزودن چندین میانبر کلید مشخص شود. این کلیدها توسط کلاینت ضبط می‌شوند و کنش (action) تعیین‌شده را اجرا می‌کنند و فشرده شدن کلیدها به سرور منتقل نخواهد شد.

مشخصه KEY ممکن است شامل کلیدهای تغییردهنده صفحه‌کلید به فرم [modifier+]*key باشد، برای مثال: Shift+F10 یا Shift+Control+B. می‌توانید با استفاده از # به مقدار گزینه shorcut-modifers اشاره کنید، یعنی: #+F1.

میانبرهای تعریف‌شده در خط فرمان به میانبرهای پیش‌فرض داخلی افزوده می‌شوند. برای پاک کردن فهرست میانبرها، از key-shortcut=clear استفاده کنید و میانبرهای خود را پس از آن تعریف نمایید.

برخی از کنش‌ها ممکن است آرگومان بپذیرند (مانند کنش log)، که در این حالت با نحو معمول در سبک برنامه‌نویسی مشخص می‌شوند: ACTION(ARG1, ARG2, etc)
آرگومان‌های رشته‌ای باید داخل علامت نقل‌قول قرار گیرند (هر دو نوع نقل‌قول تکی و دوتایی پشتیبانی می‌شوند) و آرگومان‌های عددی نباید داخل نقل‌قول باشند. توجه داشته باشید که پرانتزها و علامت‌های نقل‌قول معمولاً هنگام استفاده از طریق خط فرمان شل باید گریز داده شوند (escaped). مثال: --key-shortcut=Meta+Shift+F7:log\(\'hello\'\)

در حال حاضر ACTIONهای زیر تعریف شده‌اند:

کلاینت xpra را قطع اتصال می‌کند.
مقدار MESSAGE را به گزارش ارسال می‌کند.
پنجره اطلاعات نشست را نشان می‌دهد. بخش اختیاری TabName اجازه می‌دهد زبانه اطلاعات نمایش‌داده‌شده انتخاب شود. برای دریافت فهرست گزینه‌ها از مقدار help استفاده کنید.
منویی را که معمولاً در سینی سیستم (system tray) قرار دارد نمایش می‌دهد.
کادر گفتگوی شروع دستور جدید را نمایش می‌دهد.
فهرست میانبرها را نشان می‌دهد.
مستندات را در یک پنجره مرورگر نمایش می‌دهد.
یک جانگهدارنده (placeholder) که می‌تواند توسط برخی جعبه‌ابزارهای (toolkits) کلاینت استفاده شود.
هیچ کاری انجام نمی‌دهد و بنابراین می‌تواند برای جلوگیری از ارسال ترکیب‌های کلیدی خاصی به سرور استفاده شود.
هیچ کاری انجام نمی‌دهد. با این حال برخلاف void، رویداد کلید به سرور بازفرستاده می‌شود.
-
یک میانبر کلید موجود را در صورت وجود حذف می‌کند.
پنجره‌ای را که در حال حاضر دارای فوکوس است وادار به تازه‌سازی می‌کند.
همه پنجره‌ها را وادار به تازه‌سازی می‌کند.
صفحه‌کلید توسط پنجره جاری تسخیر / آزاد (grab / ungrab) می‌شود.
نشانگر ماوس تسخیر شده و به پنجره جاری محدود می‌شود.
پنجره جاری را تمام‌صفحه / غیر تمام‌صفحه می‌کند..IP toggle_debug روشن یا خاموش کردن اشکال‌زدایی.
افزایش مقدار فعلی desktop-scaling.
کاهش مقدار فعلی desktop-scaling.
بازنشانی desktop-scaling به مقدار اولیه آن.
خاموش کردن desktop-scaling.
افزایش تنظیم min-quality یا quality (هر کدام که در حال حاضر فعال است).
کاهش تنظیم min-quality یا quality (هر کدام که در حال حاضر فعال است).
افزایش تنظیم min-speed یا speed (هر کدام که در حال حاضر فعال است).
کاهش تنظیم min-speed یا speed (هر کدام که در حال حاضر فعال است).
اشتراک‌گذاری اجازه می‌دهد بیش از یک کلاینت به یک نشست یکسان متصل شوند. برای کارکرد صحیح، این گزینه باید هم در سمت کارگزار و هم در تمام کلاینت‌های مشارکت‌کننده فعال باشد. هنگامی که در سمت کارگزار استفاده شود، مقدار پیش‌فرض auto به کلاینت‌ها اجازه می‌دهد تعیین کنند که آیا مایل به اشتراک‌گذاری نشست هستند یا خیر. هنگامی که در سمت کلاینت استفاده شود، مقدار پیش‌فرض auto برابر با no در نظر گرفته می‌شود. برای اینکه اشتراک‌گذاری با سوکت‌های دامنه یونیکس (خواه از طریق اتصالات محلی یا با ssh) کار کند، باید حداقل یک سوکت در دایرکتوری با دسترسی گروهی ایجاد کنید. در سیستم‌های پوزیکس با پیکربندی پیش‌فرض، عضویت در گروه xpra برای ایجاد یک سوکت در /run/xpra کافی خواهد بود. همچنین باید مطمئن شوید که مجوزهای دسترسی این فایل سوکت اجازه دسترسی گروهی را می‌دهد؛ به socket-permissions مراجعه کنید.
قفل کردن به کلاینت اجازه می‌دهد از واگذاری نشست به یک کلاینت جدید خودداری کند. نشست همچنان می‌تواند با چندین کلاینت به اشتراک گذاشته شود (گزینه sharing را ببینید)، اما در غیر این صورت کارگزار کلاینت‌های جدید را رد خواهد کرد. هنگامی که در سمت کارگزار استفاده شود، مقدار پیش‌فرض auto به کلاینت‌ها اجازه می‌دهد تصمیم بگیرند که آیا می‌خواهند نشست را قفل کنند یا خیر. هنگامی که در سمت کلاینت استفاده شود، مقدار پیش‌فرض auto برابر با no خواهد بود.
در حالت عادی، رویدادهای فشرده شدن و رها شدن کلیدها به همان صورت که رخ می‌دهند به کارگزار ارسال می‌شوند تا کارگزار بتواند وضعیت صفحه‌کلید را پایدار و یکپارچه نگه دارد. غیرفعال کردن همگام‌سازی می‌تواند از تکرار غیرمنتظره کلیدها در اتصالات با تأخیر بالا جلوگیری کند، اما ممکن است عملکرد برنامه‌هایی را که مستقیماً به صفحه‌کلید دسترسی دارند (مانند بازی‌ها و غیره) مختل کند.
به کارگزار اعلام می‌کند که تمام ورودی‌های صفحه‌کلید را به صورت خام و ترجمه‌نشده پردازش کند. کلاینت و کارگزار هر دو باید از یک نوع رابط صفحه‌کلید استفاده کنند (مثلاً هر دو از X11 استفاده کنند).
پس‌زمینه (backend) صفحه‌کلید معمولاً به صورت خودکار شناسایی می‌شود. این گزینه مقدار شناسایی‌شده را لغو می‌کند.
طرح‌بندی صفحه‌کلید معمولاً به صورت خودکار شناسایی می‌شود. این گزینه مقدار شناسایی‌شده را لغو می‌کند.
فهرستی از طرح‌بندی‌های صفحه‌کلید که باید فعال شوند.
جایگزینی برای گونه (variant) طرح‌بندی صفحه‌کلید.
جایگزینی برای گونه‌های طرح‌بندی صفحه‌کلید.
جایگزینی برای گزینه‌های صفحه‌کلید که به کارگزار ارسال می‌شوند.
این گزینه فقط برای کلاینت‌های MacOS کاربرد دارد؛ این گزینه جای کلیدهای command و control را عوض می‌کند و به طور پیش‌فرض فعال است.
پلاگین صوتی GStreamer مورد استفاده برای ضبط جریان صوتی را مشخص می‌کند. این گزینه بر «بازارسال بلندگو» در سمت کارگزار، و بازارسال «میکروفون» در سمت کلاینت تأثیر می‌گذارد. برای دریافت فهرستی از گزینه‌ها، از مقدار ویژه 'help' استفاده کنید. همچنین امکان مشخص کردن گزینه‌های افزونه با ساختاری مشابه زیر وجود دارد: --audio-source= pulsedevice=device.alsa_input.pci-0000_00_14.2.analog-stereo
پشتیبانی از بازارسال ورودی و خروجی صدا: مقدار on بازارسال را به محض برقراری اتصال آغاز می‌کند، مقدار off کاربر را ملزم می‌کند آن را از طریق منو فعال کند، و disabled از استفاده از آن جلوگیری کرده و گزینه آن را در منو غیرفعال می‌کند. در بازارسال میکروفون، همچنین می‌توانید دستگاه مورد استفاده را تعیین کنید.
کدک(های) مورد استفاده برای خروجی صوتی (بلندگو) یا ورودی صوتی (میکروفون) را مشخص می‌کند. این پارامتر را می‌توان چندین بار تعیین کرد و ترتیبی که در آن کدک‌ها ذکر می‌شوند، اولویت آن‌ها را مشخص می‌کند. از مقدار ویژه 'help' برای دریافت فهرستی از گزینه‌ها استفاده کنید. در صورت عدم تعیین، تمامی کدک‌های موجود مجاز شمرده شده و اولین مورد استفاده می‌شود.
متنی را که به عنوان عنوان پنجره نمایش داده می‌شود تنظیم می‌کند. رشته ارائه‌شده می‌تواند از متغیرهای جایگزین فراداده دوردست استفاده کند که در زمان اجرا با مقادیر کارگزار دوردست پر می‌شوند. مقدار پیش‌فرض استفاده‌شده "@title@ on @client-machine@" است.

متغیرهای جایگزین زیر تعریف شده‌اند:

@title@
با عنوان پنجره دوردست جایگزین می‌شود.
@client-machine@
با نام میزبان (hostname) سیستمی که برنامه روی آن اجرا می‌شود (در صورت ارائه) و در غیر این صورت با نام میزبان کارگزار xpra جایگزین خواهد شد.
@server-machine@
با نام میزبان کارگزار xpra جایگزین می‌شود.
@server-display@
با نام نمایشگری (display) که برنامه روی آن در حال اجرا است جایگزین می‌شود.
رنگ و اندازه حاشیه‌ای را که درون هر پنجره xpra کشیده می‌شود تعیین می‌کند. این قابلیت می‌تواند برای تشخیص آسان پنجره‌های xpra در حال اجرا روی میزبان‌های دوردست از پنجره‌های محلی استفاده شود. مقدار BORDER را می‌توان با نام‌های استاندارد رنگ‌ها (مانند red یا orange) یا با استفاده از نحو هگزادسیمال وب (مانند #F00 یا #FF8C00) مشخص کرد. نام رنگ ویژه "auto" رنگ را از نشانی مقصد کارگزار (رشته اتصال) مشتق می‌کند تا اتصال به یک مقصد یکسان همواره رنگ ثابتی ارائه دهد. همچنین می‌توانید اندازه حاشیه را بر حسب پیکسل مشخص کنید، مانند: --border=yellow,10.
مسیر تصویر پیش‌فرضی که برای تمامی پنجره‌ها استفاده خواهد شد. این آیکون ممکن است در نوار پنجره، حالت کمینه‌شده، یا تعویض‌کننده‌های برنامه‌ها نمایش داده شود. این موضوع به سیستم‌عامل و مدیر پنجره بستگی دارد و خود برنامه نیز ممکن است آن را تغییر دهد.
اقدامی که هنگام بسته شدن پنجره توسط کلاینت باید انجام شود را انتخاب می‌کند. اقدامات زیر قابل استفاده هستند:
کلاینت بر اساس نوع پنجره بهترین اقدام را تعیین خواهد کرد. این حالت پیش‌فرض است. به عنوان مثال: از disconnect برای نشست‌های سایه (shadow) و از forward برای پنجره‌های یکپارچه (seamless) استفاده خواهد کرد.
رویداد به کارگزار بازارسال می‌شود.
هیچ کاری انجام نده.
قطع اتصال از کارگزار.
خاموش کردن کارگزار.
مقیاس‌بندی میزکار امکان تغییر مقیاس پنجره‌ها را توسط کلاینت فراهم می‌کند. کاهش مقیاس (downscaling) غالباً باعث هدر رفتن پهنای باند می‌شود، اما افزایش مقیاس (upscaling) به پیکسل‌های پنجره اجازه می‌دهد تا با وضوح کمتری از طریق شبکه ارسال شوند که در نتیجه در پهنای باند و زمان پردازنده (CPU) صرفه‌جویی می‌شود. این گزینه می‌تواند برای درخواست یک مقدار مقیاس‌بندی خاص نیز استفاده شود. برای بهترین نتیجه، از رندر سمت کلاینت opengl استفاده کنید؛ سایر پس‌زمینه‌های نمایشگر ممکن است هنگام مقیاس‌بندی ناهنجاری‌های بصری نمایش دهند. نکته: در صورت پیکربندی میان‌برهای صفحه‌کلید، مقدار مقیاس‌بندی می‌تواند در حین اجرا نیز تغییر کند.

مقدار desktop-scaling می‌تواند به صورت‌های زیر باشد: مقیاس‌بندی غیرفعال خواهد شد.

مقیاس‌بندی مجاز خواهد بود، اما بدون مقیاس‌بندی آغاز می‌شود.
مقیاس‌بندی مجاز خواهد بود و در صورتی که میزکار کلاینت بزرگ باشد، مقدار مقیاس‌بندی به‌طور خودکار انتخاب می‌شود (میزکارهای بزرگ‌تر از مقادیر مقیاس‌بندی بالاتری استفاده خواهند کرد).
مقیاس‌بندی فعال شده و از مقدار داده‌شده استفاده می‌کند که به‌صورت یک عدد، کسر یا درصد مشخص می‌شود؛ مانند: 2، 3/2 یا 150%.
مقیاس‌بندی فعال شده و از مقدار متفاوتی برای محورهای X و Y استفاده خواهد کرد؛ مانند: 3x2 یا 3/2x4/3.
مقیاس‌بندی فعال شده و سرور خروجی را با اندازه داده‌شده رندر خواهد کرد؛ مانند: 1600x1200.

--tray=yes|no فعال یا غیرفعال کردن منوی سینی سامانه اختصاصی xpra. در MacOS، نمی‌توان آیکون dock را غیرفعال کرد.

پیش از نمایش سینی سامانه، منتظر ظاهر شدن اولین پنجره یا اعلان می‌ماند. (فقط در posix)
آیکون نمایش‌داده‌شده در dock/سینی سامانه را مشخص می‌کند. به‌طور پیش‌فرض از یک آیکون ساده پیش‌فرض 'xpra' استفاده می‌کند. (در Microsoft Windows، آیکون باید در قالب ico باشد.)
کلاینت و سرور بسته‌های ping و echo را مبادله می‌کنند که برای جمع‌آوری آمار تاخیر استفاده می‌شوند. این آمار را می‌توان با استفاده از دستور xpra info مشاهده کرد.

هنگامی که از یک نشانی ssh: برای اتصال به یک نمایشگر دوردست استفاده می‌کنید، xpra برنامه ssh(1) را برای برقراری اتصال زیرین اجرا می‌کند. اکثر نصب‌ها اکنون باید از paramiko به عنوان دستور پیش‌فرض بک‌اند (backend) استفاده کنند. مقدار رایج دیگر برای CMD برنامه ssh یا در Microsoft Windows برنامه plink است. اگر برنامه ssh شما در مکانی غیرمعمول قرار دارد، نام غیرمعمولی دارد، یا می‌خواهید گزینه‌های خاصی را برای تغییر رفتار ssh ارسال کنید، می‌توانید از سوئیچ --ssh استفاده کنید تا به xpra بگویید چگونه ssh را اجرا کند.

برای نمونه، اگر می‌خواهید از رمزنگاری arcfour استفاده کنید، باید دستور زیر را اجرا نمایید:

xpra attach --ssh="ssh -c arcfour"; ssh://frodo/7
نکته: زحمت فعال کردن فشرده‌سازی ssh را به خود ندهید؛ این کار با فشرده‌سازی خود xpra هم‌پوشانی داشته و تنها پردازنده (CPU) شما را تلف خواهد کرد.

در MS Windows، جایی که از بک‌اسلش برای جداسازی بخش‌های مسیر استفاده می‌شود و فاصله‌ها اغلب بخشی از مسیرها هستند، لازم است مسیرها را در نقل‌قول قرار دهید. (مانند: ssh="C:\Program Files\Xpra\Plink.exe" -ssh -agent)

انتخاب اینکه آیا با قطع اتصال xpra از سرور، فرآیند کلاینت SSH باید به‌طور اجباری خاتمه یابد یا خیر. اگر از اشتراک‌گذاری اتصال SSH استفاده می‌کنید، ممکن است بخواهید از متوقف کردن نمونه فرآیند اصلی (master) SSH که توسط xpra ایجاد شده است خودداری کنید، زیرا ممکن است توسط سایر نشست‌های SSH مورد استفاده قرار گیرد. نکته: مقدار exit-ssh=no فرآیند SSH را از ترمینال جدا می‌کند که مانع از تعامل فرآیند SSH با ورودی ترمینال می‌شود؛ این کار تعامل صفحه‌کلید را که برای وارد کردن گذرواژه، تایید کلید میزبان و غیره لازم است غیرفعال می‌کند.
هنگام اتصال به یک سرور دوردست از طریق ssh، xpra باید بتواند فایل اجرایی xpra را در میزبان دوردست یافته و اجرا کند. اگر این فایل اجرایی در مکانی غیر استاندارد باشد، یا پیش از اجرا نیازمند تنظیم متغیرهای محیطی خاصی باشد، انجام این کار ممکن است چندان ساده نباشد. اگر اجرای xpra attach ssh:something به دلیل نیافتن xpra دوردست با شکست مواجه شود، می‌توانید از این گزینه برای تعیین نحوه اجرای xpra در میزبان دوردست استفاده کنید.

با این حال، در استفاده‌های عادی نباید به این گزینه نیازی باشد، زیرا xpra تلاش زیادی می‌کند تا مشکلات فوق را برطرف کند. اگر متوجه شدید که به دفعات به آن نیاز پیدا می‌کنید، ممکن است نشان‌دهنده یک باگ باشد که خوشحال می‌شویم آن را با ما در میان بگذارید..SS "گزینه‌های SSL (SSL Options)"

تعیین فعال بودن یا نبودن SSL روی سوکت‌های TCP و هدف از فعال‌سازی آن. سوکت‌های TCP با دریافت بسته‌های SSL به‌طور خودکار به SSL ارتقا داده می‌شوند.
سرور تلاش می‌کند پروتکل مورد استفاده برای هر اتصال SSL جدید را حدس بزند: پروتکل بومی xpra یا https / websocket (wss).
سوکت‌های SSL فقط برای پروتکل بومی xpra استفاده خواهند شد.
سوکت‌های SSL فقط برای https و websocket (wss) استفاده خواهند شد.

در صورت فعال بودن SSL، ارائه ssl-cert الزامی است.

سایر گزینه‌ها بازتاب‌دهنده مشخصه‌های ماژول ssl در Python هستند. لطفاً به مستندات آن مراجعه نمایید و در نظر داشته باشید که پیکربندی SSL برای امنیت کاری پیش‌پاافتاده نبوده و قطعاً صرفاً به معنای فعال‌سازی SSL نیست. ببینید: https://docs.python.org/2/library/ssl.html برخی از گزینه‌ها ممکن است در نسخه‌های قدیمی‌تر Python در دسترس نباشند.

خلاصه: --ssl-key=KEYFILE فایل کلید مورد استفاده.

فایل گواهی، برای پشتیبانی SSL سرور الزامی است.
مشخص می‌کند از کدام نسخه پروتکل SSL استفاده شود.
فایل ca_certs شامل مجموعه‌ای از گواهی‌های به‌هم‌پیوسته «مرجع صدور گواهی» (CA) است. اگر یک دایرکتوری مشخص شود، باید حاوی گواهی‌ها باشد.
داده‌های گواهی.
رمزهای در دسترس را تنظیم می‌کند؛ این مقدار باید رشته‌ای در قالب فهرست رمزهای OpenSSL باشد.
مشخص می‌کند که آیا برای اعتبارسنجی گواهی‌های کلاینت تلاش شود و در صورت شکست اعتبارسنجی چه رفتاری صورت گیرد.
مشخص می‌کند که آیا برای اعتبارسنجی گواهی‌های سرور تلاش شود و در صورت شکست اعتبارسنجی چه رفتاری صورت گیرد.
پرچم‌ها برای عملیات اعتبارسنجی گواهی.
مشخص می‌کند که آیا نام میزبان گواهی طرف مقابل مطابقت داده شود یا خیر.
مجموعه گزینه‌های SSL فعال روی این بافت (context).

دستور xpra start --start-child=... این متغیر را در محیط فرآیند فرزند تنظیم می‌کند تا به نمایشگر xpra اشاره کند.

از سوی دیگر، xpra attach از این متغیر استفاده می‌کند تا مشخص کند برنامه‌های دوردست باید روی کدام نمایشگر نشان داده شوند.

متغیر XPRA_PASSWORD می‌تواند به جای گزینه password-file به همراه xpra attach استفاده شود.

فایل xpra.conf مقادیر پیش‌فرض اکثر گزینه‌ها را ذخیره می‌کند. یک فایل پیکربندی سراسری در /etc یا /usr/local/etc وجود دارد و هر کاربر می‌تواند با ایجاد فایل .xpra/xpra.conf آن مقادیر پیش‌فرض را بازنویسی کند. همچنین می‌توانید با قرار دادن گزینه‌ها در یک دایرکتوری conf.d با پسوند .conf، آن‌ها را به چندین فایل تقسیم کنید. بسته به سیستم‌عامل و نسخه، xpra از دایرکتوری ~/.xpra یا /run/<uid>/xpra برای ذخیره تعدادی از فایل‌ها استفاده می‌کند. (مثال‌های زیر برای نمایشگر :7 ارائه شده‌اند.)

~/.xpra/:7
سوکت دامنه یونیکس که کلاینت‌ها برای برقراری ارتباط با سرور xpra استفاده می‌کنند، در صورتی که پیکربندی سیستم از این دایرکتوری استفاده کند.
~/.xpra/:7.log
هنگام اجرا در حالت دیمن (حالت پیش‌فرض)، سرور xpra تمام خروجی را به این فایل هدایت می‌کند. در صورت فعال بودن اشکال‌زدایی، این شامل تمامی خروجی‌های اشکال‌زدایی نیز می‌شود.
~/.xpra/run-xpra
یک اسکریپت شل که هنگام اجرا، xpra را با مفسر پایتون صحیح، PYTHONPATH ،PATH، مکان اسکریپت اصلی xpra و غیره راه‌اندازی می‌کند. این فایل به‌طور خودکار توسط xpra initenv و xpra start ایجاد می‌شود و توسط xpra attach مورد استفاده قرار می‌گیرد (همچنین به توضیحات مربوط به --remote-xpra مراجعه کنید). برنامه Xpra تمام جنبه‌های پروتکل X را به‌طور کامل مدیریت نمی‌کند؛ برای نمونه، ویژگی‌های ورودی پیشرفته مانند حساسیت به فشار در تبلت‌ها، برخی نشانه‌های مدیر پنجره (window manager hints) و احتمالاً بخش‌های ناشناخته‌تر دیگری از پروتکل X. با این حال، برنامه این موارد را به نرمی مدیریت می‌کند (degrades gracefully) و از وصله‌ها برای هر ویژگی با کمال میل استقبال می‌شود.

سرور xpra هنگام استفاده از Xvfb یک framebuffer بیش از حد بزرگ تخصیص می‌دهد؛ این امر باعث هدررفت حافظه می‌شود. اگر Xvfb از RandR پشتیبانی نکند، این مورد می‌تواند موجب رفتار نادرست برنامه‌ها نیز بشود (برای مثال، خارج شدن منوها از صفحه نمایش). این موضوع هنگام استفاده از Xdummy مشکلی ایجاد نمی‌کند؛ برای جزئیات به گزینهٔ --xvfb= مراجعه کنید. در مقابل، چنانچه framebuffer به اندازه کافی بزرگ نباشد، کلاینت‌ها به اشکال دیگری دچار اختلال در عملکرد می‌شوند (مثلاً رویدادهای ورودی به مسیرهای اشتباه هدایت خواهند شد).

هرگونه پرسش یا گزارش باگ را به نشانی زیر ارسال کنید: https://github.com/Xpra-org/xpra/issues

screen(1),