XPRA(1) General Commands Manual XPRA(1) (NAME) xpra - X (SYNOPSIS) 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 ...] (DESCRIPTION) Xpra X -- -- . X VNC xpra rootless : xpra << >> . Xpra X . Xpra (shadow) X11 desktop VNC . Xpra ( ) mDNS . mdns=no . xpra ( ): :DISPLAY[,OPTIONS] : . tcp://[[USERNAME][:PASSWORD]@]HOST:PORT[/DISPLAY][?OPTIONS] TCP . TCP ( : ) . ssl://[[USERNAME][:PASSWORD]@]HOST:PORT[/DISPLAY][?OPTIONS] SSL TCP . vsock://[[USERNAME][:PASSWORD]@]HOST:PORT[/?OPTIONS] TCP AF_VSOCK . ws://[[USERNAME][:PASSWORD]@]HOST:PORT/[DISPLAY][?OPTIONS] (websocket). wss://[[USERNAME][:PASSWORD]@]HOST:PORT/[DISPLAY][?OPTIONS] ( SSL). ssh://[[USERNAME][:PASSWORD]@]HOST[:SSH_PORT]/[DISPLAY][?OPTIONS] (SSH). SSH --ssh . OPTIONS ssh : ?proxy=ssh://[USERNAME[:PASSWORD]@]HOST[:SSH_PORT] xpra SSH <> xpra SSH xpra . SSH : ssh:[USERNAME[:PASSWORD]@]HOST:DISPLAY SSH . protocol:host:port URI :// . . vnc://[[USERNAME][:PASSWORD]@]HOST[:VNC_PORT]/ RFB ( VNC). VNC xpra desktop shadow . (EXAMPLES) xpra start :7 xpra :7. : DISPLAY=:7 xterm . --start= xpra . : xpra start --start=firefox xpra firefox . xpra attach . xpra . xpra start ssh://bigbox/7 --start=xterm xpra bigbox xterm . xpra desktop --start=xfce4-session xfce X11 (nested) . xpra displays . (xvfb) xpra . DEAD xpra recover . xpra clean-displays DEAD. xpra clean-sockets (dead). xpra list xpra . clean-sockets . xpra list-sessions xpra . xpra list-windows xpra . ( xpra info ) xpra list-mdns xpra mDNS ( ). xpra docs . xpra html5 html5 . xpra shell . xpra showconfig . xpra showsetting [SETTING1..] . xpra attach :7 xpra :7 . . xpra attach ssh://foo@frodo/7 ssh xpra frodo foo :7 . . xpra start :7 --start=screen xpra screen(1). screen X xpra . (displays) xpra . X . X . X ( ) <> . 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 . : o X xpra . xpra . o (0 1 2) X . o 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] . (SUBCOMMANDS) xpra start xpra . ( ssh://HOST/DISPLAY .) xpra desktop X11 (nested) X11 . xpra attach xpra (forward) ..SS xpra detach xpra . xpra screenshot . : . xpra version . : . xpra connect-test . . 0 . xpra id connect-test : pid uuid . xpra info . xpra top . xpra control . <> . <> . xpra initenv run- xpra ssh . xpra stop xpra . . xpra exit xpra . xpra stop Xvfb X11 ( ) . xpra showconfig . all . xpra list xpra . xpra upgrade xpra . xpra . xpra attach . xpra upgrade-desktop upgrade desktop . (seamless) (desktop) . xpra recover upgrade upgrade-desktop (seamless) (desktop). upgrade recover xpra . xpra shadow (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 . (Important Note) . attach . (OPTIONS) (General options) --version xpra . -h, --help . --minimal . -d FILTER1,FILTER2,..., --debug=FILTER1,FILTER2,... . all . xpra -d help . (loggers) ( ) '+' . server keyboard --debug server+keyboard . '-' . shadow clipboard : --debug shadow,-clipboard. --commands=yes|no . . --shell=yes|no xpra shell . . bind . --control=yes|no xpra . control xpra . --mmap=yes|no|ABSOLUTEFILENAME|DIRECTORY (memory-mapped) . . (CPU) . (attach) mmap . mmap . --mmap-group=GROUP (gid) mmap 660 . mmap . GROUP : no mmap . SOCKET . . auto 'xpra' SOCKET . --windows=yes|no (forwarding) . xpra . --min-size=WIDTHxHEIGHT (decorated) . --max-size=WIDTHxHEIGHT . --readonly=yes|no - . --clipboard=yes|no|clipboard-type . . . . auto . : translated (selection) . GDK X11. default (fallback) X11. OSX OSX. --clipboard-direction=to-server|to-client|both|disabled . --pulseaudio=yes|no pulseaudio . --pulseaudio-command=SERVER-START-COMMAND pulseaudio pulseaudio pulseaudio=no . --session-name=VALUE . (tray menu) . (override) . --encoding=ENCODING . --encoding=help . grayscale png/P . rgb . auto min-speed min-quality . --encodings=ENCODING . . . --video-scaling=on|off|SCALING (downscaling) ( ) () . ( ) . ( ) . --socket-dir=DIR 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) --file-transfer=on|off . --open-files=on|off . xpra . --forward-xdg-open=on|off|auto xdg-open . --open-command=COMMAND URL . --bandwidth-limit=BITSPERSECOND . . : 1Mbps 500K. auto . --splash=yes|no|auto (splash screen) . auto (GUI) - xpra SSH . seamless desktop upgrade proxy shadow --daemon=yes|no xpra ( ) . ( ). --resize-display=yes|no|WIDTHxHEIGHT . start desktop . . : QVGA VGA SVGA XGA 1080p FHD 4K. --chdir=DIR . --uid=UID --gid=GID (root) UID / GID . --pidfile=FILENAME (PID) . . --challenge-handlers=MODULE:options (challenge handlers) . . all : uri,file,env,kerberos,gss,u2f,prompt. uri . file filename . password-file . env name XPRA_PASSWORD . kerberos kerberos . gss gss . u2f U2F. prompt . . --min-port=PORT TCP. . 1024 . --mdns=yes|no mDNS. --dbus-launch=COMMAND|no dbus- launch dbus . dbus . --dbus-control=yes|no 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 . : none auto socket-dir DIRECTORY/ - PATH : PATH --bind-tcp=[HOST]:PORT[,PROPERTIES] TCP --bind-tcp . 127.0.0.1 (localhost) . 0.0.0.0 . auth ( 0.0.0.0)! . TCP html HTTP / Websocket . TCP ssl SSL . --bind-ws=[HOST]:PORT[,PROPERTIES] HTTP / Websocket. bind-tcp auth-ws . --bind-wss=[HOST]:PORT[,PROPERTIES] HTTPS / Websocket (WSS). bind-tcp auth-wss . --bind-ssl=[HOST]:PORT[,PROPERTIES] --bind-tcp SSL. ssl-auth SSL . --bind-rfb=[HOST]:PORT[,PROPERTIES] RFB . desktop shadow . --bind-vsock=CID:PORT[,PROPERTIES] VSOCK --bind-vsock . --auth=MODULE[:OPTION=VALUE] bind . (backend) : allow - fail env name ( XPRA_PASSWORD ) : --auth=env,name=SOME_OTHER_ENV_VAR_NAME. password value : --auth=password,value=YOURPASSWORD. : . file filename : --auth=file,filename=./password.txt. . (newline) . multifile filename . : username|password|uid|gid|displays|env_opts|session_opts | ( ) (carriage return) . sqlite . sqlite mysql sql 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=(?) . hosts tcp-wrappers . ( Posix Mac OS ) hosts.allow hosts.deny . exec command : timeout ( ). auth_dialog xpra . 0 . peercred SO_PEERCRED . Posix . uid gid . uid gid (:) . / . . : --auth=peercred,uid=\$UID:fred,gid=xpra. pam PAM win32 Microsoft Windows ( ) sys ( pam win32) kerberos-password kerberos. : (plain text) . . kerberos-ticket kerberos . gss GSS . u2f U2F ..IP ldap python-ldap LDAP . ldap3 ldap3 LDAP . --tcp-auth=MODULE auth TCP ( bind-tcp) . . --ws-auth=MODULE auth ws : bind-ws TCP ( html ). . --wss-auth=MODULE auth wss : bind-wss ws SSL ( ssl ) TCP SSL wss ( ssl html ). . --ssl-auth=MODULE auth SSL : bind-ssl TCP ssl=auto ssl=on. . --rfb-auth=MODULE bind-rfb. . --vsock-auth=MODULE auth VSOCK ( bind-vsock) . . seamless desktop upgrade --exec-wrapper=CMD . VirtualGL . --start=CMD CMD . $DISPLAY . . --start-child=CMD --start --exit-with-children . --start-after-connect=CMD . --start-child-after-connect=CMD . start-child . --start-on-connect=CMD . --start-child-on-connect=CMD . start-child . --start-on-last-client-exit=CMD . --start-child-on-last-client-exit=CMD . start-child . --terminate-children=yes|no (stop) . (exit) . . --exit-with-children=yes|no --start-child . xpra --start-child . --exit-with-windows=yes|no . (seamless) . --exit-with-client=yes|no . --env=KEY=VALUE --start --start-child . --start-new-commands=yes|no . ( ) --start-via-proxy=yes|no|auto seamless desktop . auto . --systemd-run=yes|no|auto systemd-run . --systemd-run-args=ARGS systemd-run . --use-display=yes|no|auto xvfb . . xpra xpra X11 . auto xpra . --displayfd=FD xpra . seamless desktop xpra . --xvfb=CMD xpra X . Xvfb X X . . Xorg dummy Xdummy . : https://github.com/Xpra-org/xpra/blob/master/docs/Usage/Xdummy.md Xvfb . --sync-xvfb=DELAY () . ( ) . : . --attach=yes|no|auto . auto ( ) . xpra . --http=on|off HTTP () TCP . TCP bind . --html=on|off|auto|webrootpath html5 http . auto . (web root) . --http-scripts=off|all|SCRIPTS . . --rfb-upgrade=DELAY RFB (: VNC) TCP . DELAY RFB . desktop shadow . --video-encoders=ENCODERS . . 'help' . 'none' . --csc-modules=MODULES (colourspace conversion) . . 'help' . 'none' . --socket-permissions=ACCESS-MODE . 600 . mmap-group . seamless desktop upgrade attach --encryption=CIPHER (cipher) . --encryption-keyfile . : AES . AES-CBC . AES-CBC AES cipher block chaining AES-GCM AES galois/counter mode AES-CFB AES cipher feedback AES-CTR AES counter . : . --tcp-encryption=CIPHER encryption TCP ( bind-tcp ). --encryption-keyfile=FILENAME --encryption . . --tcp-encryption-keyfile=FILENAME encryption-keyfile TCP ( bind- tcp ). --idle-timeout=IDLETIMEOUT ( ) ( ) . 0 . --server-idle-timeout=IDLETIMEOUT ( ) . 0 . --clipboard-filter-file=FILENAME (regular expressions) . : () . --dpi=VALUE << >> (DPI) . 10 500 . DPI . --pixel-depth=VALUE (virtual framebuffer) . : 0 () 16 24 30. opengl : 24 (deep color) 24 (true color) . 0 . ( ) . --cursors=yes|no . . . --notifications=yes|no . xpra dbus . . --input-method=METHOD (input method) . start-child . (METHOD) : none . . keep . . xim (X Input Method) . IBus Intelligent Input Bus . SCIM Smart Common Input Method . uim Universal Input Method . . --xsettings=auto|yes|no xsettings. xsettings ( shadow) . 'auto' seamless xsettings . --system-tray=yes|no (system tray). . --bell=yes|no . --webcam=yes|no . --mousewheel=on|off|invert|invert-x|invert-y|invert-z : no : invert-all invert-x invert-y invert-z..TP --remote-logging=both|all|send|receive|no . both ( stdout stderr ). allow send receive . send . . receive . . no . --av-sync=yes|no . . : (heuristics) dbus . attach --modal-windows=yes|no (modal windows) . xpra : xpra . --headerbar=auto|no|force xpra . OpenGL MS Windows . --password-file=FILENAME . (per-socket) . --opengl=(yes|no|auto)[:backend] OpenGL . ( auto) OpenGL (no) (yes). Backend gtk native X11 . : opengl=yes:native opengl=auto:gtk,native. --webcam=yes|no|/dev/deviceXXX|DEVICEID . . -zLEVEL, --compress=LEVEL xpra . : 0 ( ) 1 ( ). ( rgb). --quality=VALUE (lossy) (jpeg webp h264/h265 vp8/vp9). --encoding auto . 1 ( - ) 100 ( ) . . min-quality . --min-quality=MIN-QUALITY . quality . --speed=SPEED 1 () 100 () . (latency) . . min-speed . --min-speed=MIN-SPEED . speed . --auto-refresh-delay=DELAY (lossless) . . 0.25 . . --shortcut-modifiers=MODIFIERS (modifiers) key-shortcuts # . 'auto' Meta+Shift . --key-shortcut=KEY:ACTION . (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 : quit xpra . log("MESSAGE") MESSAGE . show_session_info[("TabName")] . TabName . help . show_menu (system tray) . show_start_new_command . show_shortcuts . show_docs . magic_key (placeholder) (toolkits) . void . pass . void . - . refresh_window . refresh_all_windows . toggle_keyboard_grab / (grab / ungrab) . toggle_pointer_grab . toggle_fullscreen / ..IP toggle_debug . scaleup desktop- scaling. scaledown desktop- scaling. scalereset desktop-scaling . scalingoff desktop-scaling. increase_quality min-quality quality ( ). decrease_quality min-quality quality ( ). increase_speed min-speed speed ( ). decrease_speed min-speed speed ( ). --sharing=yes|no|auto . . auto . auto no . ( ssh) . xpra /run/xpra . socket-permissions . --lock=yes|no|auto . ( sharing ) . auto . auto no . --keyboard-sync=yes|no . ( ) . --keyboard-raw=yes|no . ( X11 ). --keyboard-backend=BACKEND (backend) . . --keyboard-layout=LAYOUTSTRING . . --keyboard-layouts=LAYOUTS . --keyboard-variant=VARIANT (variant) . --keyboard-variants=VARIANTS . --keyboard-options=OPTIONS . --swap-keys=YES|NO MacOS command control . --audio-source=PLUGIN GStreamer . << >> <<>> . 'help' . : --audio-source= pulse device=device.alsa_input.pci-0000_00_14.2.analog-stereo --speaker=on|off|disabled --microphone=on|off|disabled|on:DEVICE|off:DEVICE : on off disabled . . --speaker-codec=CODEC --microphone-codec=CODEC () () () . . 'help' . . --title=VALUE . . "@title@ on @client-machine@" . : @title@ . @client-machine@ (hostname) ( ) xpra . @server-machine@ xpra . @server-display@ (display) . --border=BORDER xpra . xpra . BORDER ( red orange) ( #F00 #FF8C00) . "auto" ( ) . : --border=yellow,10. --window-icon=FILENAME . . . --window-close=ACTION . : auto . . : disconnect (shadow) forward (seamless) . forward . ignore . disconnect . shutdown . --desktop-scaling=off|on|auto|VALUE . (downscaling) (upscaling) (CPU) . . opengl . : . desktop-scaling : . on . auto ( ). scaling-value : 2 3/2 150%. pair X Y : 3x2 3/2x4/3. desktop-size : 1600x1200. --tray=yes|no xpra. MacOS dock . --delay-tray . ( posix) --tray-icon=FILENAME dock/ . 'xpra' . ( Microsoft Windows ico .) --enable-pings ping echo . xpra info . attach stop info screenshot version --ssh=CMD 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) --exit-ssh=yes|no xpra SSH . SSH (master) SSH xpra SSH . : exit- ssh=no SSH SSH . --remote-xpra=CMD ssh xpra xpra . . xpra attach ssh:something xpra xpra . xpra . ..SS " SSL (SSL Options)" --ssl=on|auto|off|tcp|www SSL TCP . TCP SSL SSL . auto SSL : xpra https / websocket (wss). tcp SSL xpra . www SSL https websocket (wss) . SSL ssl-cert . ssl Python . SSL SSL . : https://docs.python.org/2/library/ssl.html Python . : --ssl-key=KEYFILE . --ssl-cert=CERTFILEORDIR SSL . --ssl-protocol=PROTOCOLVERSION SSL . --ssl-ca-certs=CACERTSFILE ca_certs << >> (CA) . . --ssl-ca-data=CERTDATA . --ssl-ciphers=CIPHERS OpenSSL . --ssl-client-verify-mode=none|optional|required . --ssl-server-verify-mode=none|optional|required . --ssl-verify-flags=FLAGS . --ssl-check-hostname=yes|no . --ssl-options=options SSL (context). (ENVIRONMENT) DISPLAY xpra start --start-child=... xpra . xpra attach . XPRA_PASSWORD password-file xpra attach . (FILES) xpra.conf . /etc /usr/local/etc .xpra/xpra.conf . conf.d .conf . xpra ~/.xpra /run//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 ( ). (REPORTING BUGS) : https://github.com/Xpra-org/xpra/issues (SEE ALSO) screen(1), XPRA(1)