xpra icon
Bug tracker and wiki

Changes between Version 9 and Version 10 of Usage/EnvironmentOptions


Ignore:
Timestamp:
09/08/15 12:17:43 (5 years ago)
Author:
Antoine Martin
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Usage/EnvironmentOptions

    v9 v10  
    1919These variables may be defined by the system before xpra is launched.
    2020
    21 ||HOME ||User UUID ||
    22 ||XDG_CURRENT_DESKTOP ||Detect the Ubuntu 'Unity' desktop ||
    23 ||LD_LIBRARY_PATH ||Locate [/wiki/FakeXinerama] and other libraries ||
    24 ||DBUS_SESSION_BUS_ADDRESS ||Locate the dbus session server ||
     21||=Variable=||=Purpose=||=Platforms=||
     22||PATH ||Locating executables || All||
     23||HOME ||User UUID || Posix||
     24||XDG_CURRENT_DESKTOP ||Detect the Ubuntu 'Unity' desktop || Posix||
     25||LD_LIBRARY_PATH ||Locate [/wiki/FakeXinerama] and other libraries || Posix||
     26||DBUS_SESSION_BUS_ADDRESS ||Locate the dbus session server || Posix||
     27||APPDATA ||Locate path to log files || MS Windows||
     28||USERPROFILE ||Fallback code for locating download directory || MS Windows||
    2529
    2630[[BR]]
     
    2933
    3034||Variable ||Meaning || Default Value||
    31 ||DEFAULT_XPRA_CONF_FILENAME||Configuration file name || 'xpra.conf'||
    3235||DEFAULT_NET_WM_NAME||To change the window manager name, aka {{{_NET_WM_NAME}}} (see ticket:705#comment:10) || 'Xpra'||
    3336||NO_ROOT_WARNING ||Skip warning if running as root || 0||
    34 ||INITENV_COMMAND ||The command we run via ssh to ensure the environment is ready || "xpra initenv"||
    3537||XPRA_USE_PROCESS_POLLING ||Use process polling instead of relying on SIGCHLD || 0||
     38||XPRA_POLL_DELAY ||When using process polling, how often do we schedule it (in seconds) || 2||
    3639||XPRA_SKIP_UI ||Skip warnings, useful when running without a console || 0||
    3740||XPRA_FORCE_COLOR_LOG ||Force enable the coloured logger || 0||
    3841||XPRA_DETECT_MEMLEAKS ||Run memory leak detection code (expensive) || 0||
    3942||XPRA_DETECT_FDLEAKS ||Run file descriptor leak detection code (expensive) || 0||
    40 
    41 
    42 [[BR]]
    43 
     43||XPRA_GRACE_PERCENT ||Percentage of the idle timeout before we enter the "grace" period || 90||
     44||XPRA_LOG_PREFIX ||Prefix which is prepended to all log messages || ||
     45||XPRA_LOG_FORMAT ||Format used for all log messages || %(asctime)s %(message)s||
     46||XPRA_PRINTER_RAW ||Allow "raw" printing || 0||
     47||XPRA_PRINTING_PREFERRED_MIMETYPE ||Override the default order for mimetypes (normally "application/pdf" ahead of "application/postscript") || ||
     48||XPRA_UI_THREAD_POLLING ||How often to poll the UI thread || (platform specific)||
     49||XPRA_MESSAGEBOX ||Show early command info and error messages using a dialog box on MS Windows || 1||
     50||XPRA_WIN32_SEAMLESS ||Enable the experimental MS Windows seamless shadow server code || 0||
     51
     52[[BR]]
     53
     54
     55== Printing ==
     56
     57||XPRA_ADD_LOCAL_PRINTERS ||Allow local printers to be re-added (for testing) || 0||
     58||XPRA_PRINTER_PREFIX ||Prefix prepended to printer names || "Xpra:" when adding local printers only||
     59||XPRA_CUPS_DBUS ||Listen for cups event via dbus || 1 (0 on OSX)||
     60||XPRA_CUPS_POLLING_DELAY ||How often to poll for cups printer changes (when not using dbus), in seconds || 60||
     61||XPRA_SKIPPED_PRINTERS ||CSV list of MS Windows printer names which are not forwarded || Microsoft XPS Document Writer,Fax||
     62
     63
     64[[BR]]
     65
     66== Paths ==
     67
     68||Variable ||Meaning || Default Value||
     69||DEFAULT_XPRA_CONF_FILENAME||Configuration file name || 'xpra.conf'||
     70||INITENV_COMMAND ||The command we run via ssh to ensure the environment is ready || "xpra initenv"||
     71||XPRA_SYSCONF_DIR ||System configuration directory || [*]||
     72||XPRA_SYSCONF_DIRS ||System configuration directories || [*]||
     73||XPRA_USER_CONF_DIR ||User configuration directory || [*]||
     74||XPRA_INSTALL_PREFIX ||Installation prefix || [*]||
     75||XPRA_SOUND_COMMAND ||The command used for running the sound subprocess || [*]||
     76||XPRA_FORWARDER_TMPDIR ||Temporary directory used by the xpraforwarder cups backend || $TMPDIR or /tmp||
     77||XPRA_POSTSCRIPT_PPD ||PPD file to use for Postscript printing || ||
     78||XPRA_PDF_PPD ||PPD file to use for PDF printing || ||
     79
     80[*] the default is platform specific
     81
     82[[BR]]
    4483== Specific Encodings ==
    4584
     85||Variable ||Meaning || Default Value||
    4686||XPRA_NVENC_VERSIONS ||Which versions of NVENC to try to load and in which order || 4,5||
    4787||XPRA_IGNORE_NVIDIA_DRIVER_BLACKLIST ||Ignore the builtin driver version blacklist || 0||
     
    82122== Encoding ==
    83123
     124||Variable ||Meaning || Default Value||
    84125||XPRA_FORCE_CSC_MODE ||Force the video pipeline to use a specific csc mode (ie: YUV420P) || ||
    85126||XPRA_FORCE_CSC ||Force the video pipeline to use a csc step || 0||
     
    103144||XPRA_MERGE_REGIONS ||Try to merge paint regions to save CPU / bandwidth || 1||
    104145||XPRA_INTEGRITY_HASH ||Include an integrity hash with pixel packets|| 0||
     146||XPRA_SOUND_CODEC_ENABLE_$$$$$ ||Force enable a specific sound codec || ||
     147||XPRA_MUXER_OPTIONS||Specify which muxers are enabled as a CSV list || gdp,ogg||
     148||XPRA_SOUND_SINK ||Default sound output plugin || (platform dependent)||
     149||XPRA_SOUND_GRACE_PERIOD ||Ignore overruns and underruns during this grace period after startup (in milliseconds) || 2000||
     150||XPRA_SOUND_MARGIN ||How much extra margin to keep in the sound buffer level (in milliseconds) || 50||
     151
     152[[BR]]
     153
     154== Sound ==
     155
     156||Variable ||Meaning || Default Value||
     157||XPRA_ALLOW_SOUND_LOOP ||Allow sound forwarding to/from the same system || 0||
     158||XPRA_GSTREAMER1 ||Use GStreamer 1.x by default || 1 (0 on win32 and osx)||
     159||XPRA_MONITOR_DEVICE_NAME ||Use a specific sound monitor device || ||
     160||XPRA_SOURCE_APPSINK ||The GStreamer sound capture element || appsink name=sink emit-signals=true max-buffers=10 drop=true sync=false async=false qos=false||
     161||XPRA_SOUND_QUEUE_LEAK ||Controls if/how the queue element leaks (0=no leak, 1=leak upsteam, 2=leak downstream) || 2||
     162||XPRA_SOUND_DEBUG ||Enable debugging for the sound subprocess wrapper || 0||
     163||XPRA_SOUND_SUBPROCESS_DEBUG ||CSV list of debug flags to pass to the sound wrapper subprocess (ie {{{network,util}}}) || ||
     164
    105165
    106166[[BR]]
     
    108168== X11 ==
    109169
     170||Variable ||Meaning || Default Value||
    110171||XPRA_X_SYNC ||Enable [https://tronche.com/gui/x/xlib/event-handling/protocol-errors/XSynchronize.html XSynchronize] || 0||
    111172||XPRA_X11_PROPERTIES_IGNORED ||X11 properties we ignore as a CSV list || "_NET_WM_OPAQUE_REGION"||
     
    120181||XPRA_DEBUG_KEYSYMS ||Debug the key mapping for specific keys || ||
    121182||XPRA_XSETTINGS_DEBUG ||Debug XSettings|| 0||
     183||XPRA_SHAPE_DEBUG ||Enable XShape debugging || 0||
    122184
    123185
     
    126188== Network / Connection ==
    127189
     190||Variable ||Meaning || Default Value||
    128191||XPRA_SOCKET_HOSTNAME ||The name to use for the sockets || the hostname||
    129192||SOCKET_TIMEOUT ||How long to wait before the initial connection times out || 10||
     
    152215== Crypto ==
    153216
     217||Variable ||Meaning || Default Value||
    154218||XPRA_ENABLE_CRYPTO ||Enable encryption layer || 1||
    155219||XPRA_ENCRYPT_FIRST_PACKET ||Send the first packet encrypted (see #951) || 0||
     
    164228== Proxy Server ==
    165229
     230||Variable ||Meaning || Default Value||
    166231||XPRA_PROXY_SOCKET_TIMEOUT ||Temporary socket timeout used by the proxy server during handover (in seconds) || 0.1||
    167232||XPRA_PROXY_QUEUE_SIZE ||Size of the internal queue buffers of each proxy instance || 10||
     
    175240For "rate" types of settings, the value is a number and specifies how often we simulate errors: a value of 10 will cause 1 error for every 10 events.
    176241
     242||Variable ||Meaning || Default Value||
    177243||XPRA_PAINT_FAULT_INJECTION_RATE ||Simulate errors in paint events || 0||
    178244||XPRA_PAINT_FAULT_INJECTION_TELL ||Whether paint errors are reported back to the server || 1||
     
    181247||XPRA_FAKE_JITTER ||Introduce jitter in the network layer (value in milliseconds)|| 0||
    182248||XPRA_SIMULATE_SERVER_HELLO_ERROR ||Simulate errors in the server's hello packet handlers || 0||
     249||XPRA_SOUND_FAULT_INJECTION_RATE ||Injects invalid data into the sound subprocess's "info" packet output || 0||
     250||XPRA_SOUND_FAKE_START_FAILURE ||Causes the sound subprocess to fail to start|| 0||
     251||XPRA_SOUND_FAKE_EXIT ||Causes the sound subprocess to exit cleanly after the given delay (in seconds) || 0 (disabled)||
     252||XPRA_SOUND_FAKE_CRASH ||Causes the sound subprocess to crash after the given delay (in seconds) || 0 (disabled)||
     253||XPRA_FAKE_UI_LOCKUPS ||Simulate UI thread lockups for the given number of seconds, every 10 seconds || 0 (disabled)||
    183254
    184255
     
    187258== Clipboard ==
    188259
     260||Variable ||Meaning || Default Value||
    189261||XPRA_DISCARD_TARGETS ||List of clipboard targets which are discarded ||
    190 ||XPRA_TRANSLATEDCLIPBOARD_LOCAL_SELECTION ||Default local selection for translated clipboard ||
    191 ||XPRA_TRANSLATEDCLIPBOARD_REMOTE_SELECTION ||Default remote selection for translated clipboard ||
     262||XPRA_TRANSLATEDCLIPBOARD_LOCAL_SELECTION ||Default local selection for translated clipboard || ||
     263||XPRA_TRANSLATEDCLIPBOARD_REMOTE_SELECTION ||Default remote selection for translated clipboard || ||
     264||XPRA_CLIPBOARD_LIMIT ||Maximum number of clipboard transfers per second, clipboard will be disabled automatically beyond that || 20||
     265
    192266}}}