xpra v0.17.6

Usage: xpra start [DISPLAY] xpra stop [DISPLAY] xpra exit [DISPLAY] xpra list xpra upgrade [DISPLAY] xpra attach [DISPLAY] xpra detach [DISPLAY] xpra screenshot filename [DISPLAY] xpra info [DISPLAY] xpra control DISPLAY command [arg1] [arg2].. xpra print DISPLAY filename xpra version [DISPLAY] xpra showconfig xpra shadow [DISPLAY] Options: --version show program's version number and exit -h, --help show this help message and exit Server Options: These options are only relevant on the server when using the 'start' or 'upgrade' or 'shadow' mode. --start=CMD program to spawn in new server (may be repeated). Default: ['/etc/X11/Xsession true']. --start-child=CMD program to spawn in new server, taken into account by the exit-with-children option (may be repeated to run multiple commands). Default: []. --start-after-connect=START_AFTER_CONNECT program to spawn in new server after the first client has connected (may be repeated). Default: []. --start-child-after-connect=START_CHILD_AFTER_CONNECT program to spawn in new server after the first client has connected, taken into account by the exit-with- children option (may be repeated to run multiple commands). Default: []. --start-on-connect=START_ON_CONNECT program to spawn in new server every time a client connects (may be repeated). Default: []. --start-child-on-connect=START_CHILD_ON_CONNECT program to spawn in new server every time a client connects, taken into account by the exit-with-children option (may be repeated). Default: []. --exec-wrapper=CMD Wrapper for executing commands. Default: . --exit-with-children Terminate the server when the last --start-child command(s) exit --start-new-commands=yes|no Allows clients to execute new commands on the server. Default: no. --dbus-launch=CMD Start the session within a dbus-launch context, leave empty to turn off. Default: dbus-launch --close- stderr. --env=ENV Define environment variables used with 'start-child' and 'start', can be specified multiple times. Default: 'UBUNTU_MENUPROXY=', 'QT_X11_NO_NATIVE_MENUBAR=1', 'MWNOCAPTURE=true', 'MWNO_RIT=true', 'MWWM=allwm', 'GDK_BACKEND=x11'. --tcp-proxy=HOST:PORT The address to which non-xpra packets will be forwarded. Default: ''. --html=on|off|[HOST:]PORT Enable the web server and the html5 client. Default: ''. --daemon=yes|no Daemonize when running as a server (default: yes) --log-dir=LOG_DIR The directory where log files are placed --log-file=LOG_FILE When daemonizing, this is where the log messages will go. Default: '$DISPLAY.log'. If a relative filename is specified the it is relative to --log-dir, the value of '$DISPLAY' will be substituted with the actual display used --file-transfer=yes|no Support file transfers. Default: yes. --printing=yes|no Support printing. Default: yes. --lpadmin=COMMAND Specify the lpadmin command to use. Default: '/usr/sbin/lpadmin'. --lpinfo=COMMAND Specify the lpinfo command to use. Default: '/usr/sbin/lpinfo'. --exit-with-client=yes|no Terminate the server when the last client disconnects. Default: no --idle-timeout=IDLE_TIMEOUT Disconnects the client when idle (0 to disable). Default: 0 seconds --server-idle-timeout=SERVER_IDLE_TIMEOUT Exits the server when idle (0 to disable). Default: 0 seconds --use-display Use an existing display rather than starting one with xvfb --xvfb=CMD How to run the headless X server. Default: 'Xorg -noreset -nolisten tcp +extension GLX +extension RANDR +extension RENDER -auth $XAUTHORITY -logfile ${HOME}/.xpra/Xorg.${DISPLAY}.log -configdir ${HOME}/.xpra/xorg.conf.d -config /etc/xpra/xorg.conf'. --fake-xinerama=yes|no Setup fake xinerama support for the session. Default: yes. --resize-display=yes|no Whether the server display should be resized to match the client resolution. Default: yes. --bind=SOCKET Listen for connections over unix domain sockets. You may specify this option multiple times to listen on different locations. --bind-tcp=[HOST]:PORT Listen for connections over TCP (use --tcp-auth to secure it). You may specify this option multiple times with different host and port combinations --bind-vsock=[CID]:[PORT] Listen for connections over VSOCK. You may specify this option multiple times with different CID and port combinations --mdns=yes|no Publish the session information via mDNS. Default: yes. --pulseaudio=yes|no Start a pulseaudio server for the session. Default: yes. --pulseaudio-command=PULSEAUDIO_COMMAND The command used to start the pulseaudio server. Default: 'pulseaudio --start -n --daemonize=false --system=false --exit-idle-time=-1 --load=module- suspend-on-idle '--load=module-null-sink sink_name ="Xpra-Speaker" sink_properties=device.description="Xpra\ Speaker"' ' --load=module-null-sink sink_name="Xpra-Microphone" sink_properties=device.description="Xpra\ Microphone"' --load=module-native-protocol-unix --load=module-dbus- protocol --log-level=2 --log-target=stderr'. --pulseaudio-configure-commands=PULSEAUDIO_CONFIGURE_COMMANDS The commands used to configure the pulseaudio server. Default: '['pactl set-default-sink Xpra-Speaker', 'pactl set-default-source Xpra-Microphone.monitor']'. --dbus-proxy=yes|no Forward dbus calls from the client. Default: yes. --dbus-control=yes|no Allows the server to be controlled via its dbus interface. Default: yes. Server Controlled Features: These options can be used to turn certain features on or off, they can be specified on the client or on the server, but the client cannot enable them if they are disabled on the server. --clipboard=yes|no|clipboard-type Enable clipboard support. Default: yes. --notifications=yes|no Forwarding of system notifications. Default: yes. --system-tray=yes|no Forward of system tray icons. Default: yes. --cursors=yes|no Forward custom application mouse cursors. Default: yes. --bell=yes|no Forward the system bell. Default: yes. --webcam=WEBCAM Webcam forwarding, can be used to specify a device. Default: auto. --global-menus=yes|no Forward application global menus. Default: yes. --xsettings=yes|no xsettings synchronization. Default: yes. --mmap=yes|no Use memory mapped transfers for local connections. Default: yes. --readonly=yes|no Disable keyboard input and mouse events from the clients. Default: no. --sharing=yes|no Allow more than one client to connect to the same session. Default: no. --remote-logging=yes|no|both Forward all the client's log output to the server. Default: yes. --speaker=on|off|disabled Forward sound output to the client(s). Default: off. --speaker-codec=SPEAKER_CODEC Specify the codec(s) to use for forwarding the speaker sound output. This parameter can be specified multiple times and the order in which the codecs are specified defines the preferred codec order. Use the special value 'help' to get a list of options. When unspecified, all the available codecs are allowed and the first one is used. --microphone=on|off|disabled Forward sound input to the server. Default: off. --microphone-codec=MICROPHONE_CODEC Specify the codec(s) to use for forwarding the microphone sound output. This parameter can be specified multiple times and the order in which the codecs are specified defines the preferred codec order. Use the special value 'help' to get a list of options. When unspecified, all the available codecs are allowed and the first one is used. --sound-source=SOUND_SOURCE Specifies which sound system to use to capture the sound stream (use 'help' for options) --av-sync=AV_SYNC Try to synchronize sound and video. Default: yes. Encoding and Compression Options: These options are used by the client to specify the desired picture and network data compression.They may also be specified on the server as default values for those clients that do not set them. --encodings=ENCODINGS Specify which encodings are allowed. Default: all. --encoding=ENCODING Which image compression algorithm to use, specify 'help' to get a list of options. Default: . --video-encoders=VIDEO_ENCODERS Specify which video encoders to enable, to get a list of all the options specify 'help' --csc-modules=CSC_MODULES Specify which colourspace conversion modules to enable, to get a list of all the options specify 'help'. Default: ['all']. --video-decoders=VIDEO_DECODERS Specify which video decoders to enable, to get a list of all the options specify 'help' --video-scaling=SCALING How much automatic video downscaling should be used, from 1 (rarely) to 100 (aggressively), 0 to disable. Default: 1. --min-quality=MIN-LEVEL Sets the minimum encoding quality allowed in automatic quality setting, from 1 to 100, 0 to leave unset. Default: 30. --quality=LEVEL Use a fixed image compression quality - only relevant to lossy encodings, from 1 to 100, 0 to use automatic setting. Default: 0. --min-speed=SPEED Sets the minimum encoding speed allowed in automatic speed setting, from 1 to 100, 0 to leave unset. Default: 30. --speed=SPEED Use image compression with the given encoding speed, from 1 to 100, 0 to use automatic setting. Default: 0. --auto-refresh-delay=DELAY Idle delay in seconds before doing an automatic lossless refresh. 0.0 to disable. Default: 0.15. --compressors=COMPRESSORS The packet compressors to enable. Default: lz4, lzo, zlib. --packet-encoders=PACKET_ENCODERS The packet encoders to enable. Default: rencode, bencode, yaml. -z LEVEL, --compress=LEVEL How hard to work on compressing data. You generally do not need to use this option, the default value should be adequate, picture data is compressed separately (see --encoding). 0 to disable compression, 9 for maximal (slowest) compression. Default: 1. Client Features Options: These options control client features that affect the appearance or the keyboard. --opengl=yes|no|auto Use OpenGL accelerated rendering. Default: auto. --windows=yes|no Forward windows. Default: yes. --session-name=SESSION_NAME The name of this session, which may be used in notifications, menus, etc. Default: 'Xpra'. --max-size=MAX_SIZE The maximum size for all windows, ie: 800x600. Default: ''. --desktop-scaling=SCALING How much to scale the client desktop by. This value can be specified in the form of absolute pixels: "WIDTHxHEIGHT" as a fraction: "3/2" or just as a decimal number: "1.5". You can also specify each dimension individually: "2x1.5". Default: 'auto'. --shadow-fullscreen=SHADOW_FULLSCREEN Make the window fullscreen if it is from a shadow server, scaling it to fit the screen. Default: 'False'. --border=BORDER The border to draw inside xpra windows to distinguish them from local windows.Format: color[,size]. Default: 'auto,5:off' --title=TITLE Text which is shown as window title, may use remote metadata variables. Default: '@title@ on @client- machine@'. --window-icon=WINDOW_ICON Path to the default image which will be used for all windows (the application may override this) --window-close=WINDOW_CLOSE The action to take when a window is closed by the client. Valid options are: 'forward', 'ignore', 'disconnect'. Default: 'auto'. --tray=yes|no Enable Xpra's own system tray applet. Default: yes --delay-tray=yes|no Waits for the first events before showing the system tray. Default: no --tray-icon=TRAY_ICON Path to the image which will be used as icon for the system-tray or dock --key-shortcut=KEY_SHORTCUT Define key shortcuts that will trigger specific actions.If no shortcuts are defined, it defaults to: Meta+Shift+F1:show_menu Meta+Shift+F2:show_start_new_command Meta+Shift+F3:show_bug_report Meta+Shift+F4:quit Meta+Shift+F5:increase_quality Meta+Shift+F6:decrease_quality Meta+Shift+F7:increase_speed Meta+Shift+F8:decrease_speed Meta+Shift+F10:magic_key Meta+Shift+F11:show_session_info Meta+Shift+F12:toggle_debug Meta+Shift+plus:scaleup Meta+Shift+minus:scaledown Meta+Shift+underscore:scaledown Meta+Shift+KP_Add:scaleup Meta+Shift+KP_Subtract:scaledown Meta+Shift+KP_Multiply:scalereset Meta+Shift+bar:scalereset Meta+Shift+question:scalingoff --keyboard-sync=yes|no Synchronize keyboard state. Default: yes. Advanced Options: These options apply to both client and server. Please refer to the man page for details. --password-file=PASSWORD_FILE The file containing the password required to connect (useful to secure TCP mode). Default: ''. --input-method=INPUT_METHOD Which X11 input method to configure for client applications started with start or start-child (default: 'none', options: none, keep, xim, IBus, SCIM, uim) --dpi=DPI The 'dots per inch' value that client applications should try to honour, from 10 to 1000 or 0 for automatic setting. Default: auto. --sync-xvfb=SYNC_XVFB How often to synchronize the virtual framebuffer used for X11 seamless servers (0 to disable). Default: 0. --socket-dirs=SOCKET_DIRS Directories to look for the socket files in. Default: '~/.xpra'. --socket-dir=SOCKET_DIR Directory to place/look for the socket files in. Default: '$XPRA_SOCKET_DIR or the first valid directory in socket-dirs'. -d FILTER1,FILTER2,..., --debug=FILTER1,FILTER2,... List of categories to enable debugging for (you can also use "all" or "help", default: '') --ssh=CMD How to run ssh. Default: 'ssh -x'. --exit-ssh=yes|no|auto Terminate SSH when disconnecting. Default: True. --username=USERNAME The username supplied by the client for authentication. Default: 'root'. --auth=AUTH The authentication module to use (default: '') --tcp-auth=TCP_AUTH The authentication module to use for TCP sockets (default: '') --vsock-auth=VSOCK_AUTH The authentication module to use for vsock sockets (default: '') --mmap-group When creating the mmap file with the client, set the group permission on the mmap file to the same value as the owner of the server socket file we connect to (default: 'False') --socket-permissions=SOCKET_PERMISSIONS When creating the server unix domain socket, what file access mode to use (default: '600') --pings=yes|no Send ping packets every second to gather latency statistics. Default: no. --clipboard-filter-file=CLIPBOARD_FILTER_FILE Name of a file containing regular expressions of clipboard contents that must be filtered out --local-clipboard=SELECTION Name of the local clipboard selection to be synchronized when using the translated clipboard (default: CLIPBOARD) --remote-clipboard=SELECTION Name of the remote clipboard selection to be synchronized when using the translated clipboard (default: CLIPBOARD) --remote-xpra=CMD How to run xpra on the remote host (default: ~/.xpra /run-xpra or $XDG_RUNTIME_DIR/xpra/run-xpra or xpra) --encryption=ALGO Specifies the encryption cipher to use, specify 'help' to get a list of options. (default: None) --encryption-keyfile=FILE Specifies the file containing the encryption key. (default: '') --tcp-encryption=ALGO Specifies the encryption cipher to use for TCP sockets, specify 'help' to get a list of options. (default: None) --tcp-encryption-keyfile=FILE Specifies the file containing the encryption key to use for TCP sockets. (default: '')