xpra icon
Bug tracker and wiki

Changes between Version 5 and Version 6 of Usage/EnvironmentOptions


Ignore:
Timestamp:
09/08/15 07:27:38 (5 years ago)
Author:
Antoine Martin
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Usage/EnvironmentOptions

    v5 v6  
    66
    77There are also many environment variables which can be set for debugging, see [/wiki/Logging].
     8
     9Unless the environment value is specified as being a number, the possible values are:
     10* 0 to disable
     11* 1 to enable
     12No other values should be used (undefined behaviour).
    813[[BR]]
    914
    1015
    1116{{{#!div class="box"
    12 == Generic Environment Variables
     17== Generic System Environment Variables
     18
     19These variables may be defined by the system before xpra is launched.
    1320
    1421||HOME ||User UUID ||
     
    2128== Internal ==
    2229
    23 ||DEFAULT_XPRA_CONF_FILENAME||To change the default from: 'xpra.conf' ||
    24 ||DEFAULT_NET_WM_NAME||To change the default from 'Xpra' (see ticket:705#comment:10) ||
    25 ||NO_ROOT_WARNING ||Skip warning if running as root (defaults to 0) ||
    26 ||INITENV_COMMAND ||Defaults to "xpra initenv" ||
    27 ||XPRA_USE_PROCESS_POLLING ||Use process polling instead of relying on SIGCHLD ||XPRA_SKIP_UI ||Skip warnings, useful when running without a console (defaults to 0) ||
    28 ||XPRA_FORCE_COLOR_LOG ||Force enable the coloured logger (defaults to 0) ||
     30||Variable ||Meaning || Default Value||
     31||DEFAULT_XPRA_CONF_FILENAME||Configuration file name || 'xpra.conf'||
     32||DEFAULT_NET_WM_NAME||To change the window manager name, aka {{{_NET_WM_NAME}}} (see ticket:705#comment:10) || 'Xpra'||
     33||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"||
     35||XPRA_USE_PROCESS_POLLING ||Use process polling instead of relying on SIGCHLD || 0||
     36||XPRA_SKIP_UI ||Skip warnings, useful when running without a console || 0||
     37||XPRA_FORCE_COLOR_LOG ||Force enable the coloured logger || 0||
    2938
    3039
     
    3342== X11 ==
    3443
    35 ||XPRA_X11_PROPERTIES_IGNORED ||X11 properties we ignore as a CSV list, defaults to "_NET_WM_OPAQUE_REGION" ||
    36 ||XPRA_FORCE_REPLACE_WM ||Force an existing window manager to exit (defaults to 0) ||
    37 ||XPRA_LOG_MANAGE_FAILURES ||Log all failures to manage a window (defaults to 0) ||
    38 ||XPRA_NO_NET_SUPPORTED||CSV list of "_NET_SUPPORTED" items to remove from the default list we claim to support (default is empty) ||
    39 ||XPRA_X11_DEBUG_EVENTS ||CSV list of X11 events to debug (default is empty, typical values: "KeyPress,ClientMessage" ..) ||
    40 
     44||XPRA_X_SYNC ||Enable [https://tronche.com/gui/x/xlib/event-handling/protocol-errors/XSynchronize.html XSynchronize] || 0||
     45||XPRA_X11_PROPERTIES_IGNORED ||X11 properties we ignore as a CSV list || "_NET_WM_OPAQUE_REGION"||
     46||XPRA_FORCE_REPLACE_WM ||Force an existing window manager to exit || 0||
     47||XPRA_LOG_MANAGE_FAILURES ||Log all failures to manage a window || 0||
     48||XPRA_NO_NET_SUPPORTED||CSV list of "_NET_SUPPORTED" items to remove from the default list we claim to support || ||
     49||XPRA_X11_DEBUG_EVENTS ||CSV list of X11 events to debug - typical values: "KeyPress,ClientMessage" .. || ||
     50||XPRA_REPARENT_ROOT ||Reparent windows to the root window, see #770 || 0||
     51||XPRA_X11_XKB ||Enable Xkb || 1||
     52||XPRA_X11_XTEST ||Enable XTest || 1||
     53||XPRA_X11_XFIXES ||Enable XFixes || 1||
    4154
    4255
     
    4558== Network / Connection ==
    4659
    47 ||XPRA_SOCKET_HOSTNAME|| The name to use for the sockets, defaults to the hostname ||
    48 ||SOCKET_TIMEOUT||How long to wait before the initial connection times out (defaults to 10) ||
    49 ||TCP_NODELAY ||Use TCP no-delay (defaults to 1) ||
    50 ||XPRA_PASSWORD ||Override the password file option ||
    51 ||XPRA_ENCRYPTION_KEY ||Override the encryption key file option ||
    52 ||XPRA_XSHM ||Enable XShm (default to 1) ||
     60||XPRA_SOCKET_HOSTNAME||The name to use for the sockets || the hostname||
     61||SOCKET_TIMEOUT||How long to wait before the initial connection times out || 10||
     62||TCP_NODELAY ||Use TCP no-delay || 1||
     63||XPRA_PASSWORD ||Override the password file option || ||
     64||XPRA_ENCRYPTION_KEY ||Override the encryption key file option || ||
     65||XPRA_XSHM ||Enable XShm|| 1||
    5366
    5467[[BR]]
     
    5669== Fault Injection ==
    5770
    58 ||XPRA_PAINT_FAULT_INJECTION_RATE || Numeric value: how often to simulate paint errors (a value of 10 will cause 1 fault for every 10 paint events) ||
    59 ||XPRA_PAINT_FAULT_INJECTION_TELL || Whether paint faults are reported back to the server ||
     71||XPRA_PAINT_FAULT_INJECTION_RATE || Numeric value: how often to simulate paint errors (a value of 10 will cause 1 fault for every 10 paint events) || 0||
     72||XPRA_PAINT_FAULT_INJECTION_TELL || Whether paint faults are reported back to the server || 1||
    6073
    6174[[BR]]