xpra icon
Bug tracker and wiki

Changes between Version 6 and Version 7 of Usage/EnvironmentOptions


Ignore:
Timestamp:
09/08/15 08:00:59 (5 years ago)
Author:
Antoine Martin
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Usage/EnvironmentOptions

    v6 v7  
    77There are also many environment variables which can be set for debugging, see [/wiki/Logging].
    88
    9 Unless the environment value is specified as being a number, the possible values are:
     9Unless the environment value is specified as being a number or a list, the possible values are:
    1010* 0 to disable
    1111* 1 to enable
     
    3737||XPRA_FORCE_COLOR_LOG ||Force enable the coloured logger || 0||
    3838
     39[[BR]]
     40
     41== Encodings ==
     42
     43||XPRA_NVENC_VERSIONS ||Which versions of NVENC to try to load and in which order || 4,5||
     44||XPRA_IGNORE_NVIDIA_DRIVER_BLACKLIST ||Ignore the builtin driver version blacklist || 0||
     45||XPRA_NVENC_CLIENT_KEY ||Provide a client key for NVENC || ||
     46||XPRA_NVENC_PRESET ||Prefer a specific preset || ||
     47||XPRA_NVENC_YUV444_THRESHOLD ||Quality above which YUV444 mode is preferred || 85||
     48||XPRA_NVENC_LOSSLESS_THRESHOLD ||Quality above which lossless mode is used || 100||
     49||XPRA_NVENC_DEBUG_API ||Debug NVENC API calls || 0||
     50||XPRA_CUDA_DEVICE ||Cuda Device ID to use || -1 (first available)||
     51||XPRA_CUDA_DEVICE_NAME ||Cuda device name to use (ie: "GTX 970") || ||
     52||PIL_DEBUG ||Enable Python Pillow debugging || 0||
     53||XPRA_CODEC_SELFTEST ||Run self tests on start || 1||
     54||XPRA_CODEC_FULL_SELFTEST ||Run full self tests on start (expensive) || 0||
     55||XPRA_OPENCL_DEVICE_TYPE ||The type of device to use || GPU||
     56||XPRA_OPENCL_DEVICE_NAME ||Select a specific device by name || ||
     57||XPRA_OPENCL_PLATFORM ||Select a specific OpenCL platform || ||
     58||XPRA_OPENCL_YUV2RGB ||Support YUV to RGB via OpenCL|| 0||
     59||XPRA_AMD_WARNING ||Show warning if the AMD OpenCL ICD is loaded || 1||
     60||XPRA_CSC_CYTHON_$$$$$$$_COLORSPACES ||Restrict which format conversions are supported with the cython csc module (see ticket:937#comment:21) || ||
     61||XPRA_CSC_CYTHON_DEBUG_POINTS ||Debug colour for specific pixels with the csc cython module || ||
     62||XPRA_VP9_YUV444 ||Enable YUV444 mode with VP9 if available || 1||
     63||XPRA_VP9_TILING ||Enable VP9 tiling support || 0||
     64||XPRA_VPX_THREADS ||Number of threads to use with VP9|| number of CPUs-1||
     65||XPRA_FORCE_SWSCALE ||Enable swscale with blacklisted versions || 0||
     66||XPRA_X264_THREADS ||Number of threads to use with x264 || 0 (auto)||
     67||XPRA_X264_LOGGING ||x264 API logging level, supported values: ERROR,WARNING,INFO || WARNING||
     68||XPRA_X264_LOG_NALS ||Log x264 NALs || 0||
     69||XPRA_X264_OPENCL ||Use OpenCL if present || 0||
     70||XPRA_X264_$$$$$$_PROFILE ||Profile to use for a given csc mode || ||
     71||XPRA_WEBP_LOG_CONFIG ||Log webp config used || 0||
     72||XPRA_WEBP_THREADING ||Enable webp threading || 1||
     73||XPRA_WEBP_IMAGE_HINT ||Default webp image hint || graph||
     74||XPRA_WEBP_PRESET ||Default webp preset || text||
     75||XPRA_WEBP_PRESET_SMALL ||Default webp preset for small areas || icon||
     76
     77
    3978
    4079[[BR]]
     
    4786||XPRA_LOG_MANAGE_FAILURES ||Log all failures to manage a window || 0||
    4887||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" .. || ||
     88||XPRA_X11_DEBUG_EVENTS ||CSV list of X11 events to debug - typical values: {{{KeyPress,ClientMessage}}} .. || ||
    5089||XPRA_REPARENT_ROOT ||Reparent windows to the root window, see #770 || 0||
    5190||XPRA_X11_XKB ||Enable Xkb || 1||
    5291||XPRA_X11_XTEST ||Enable XTest || 1||
    5392||XPRA_X11_XFIXES ||Enable XFixes || 1||
     93||XPRA_DEBUG_KEYSYMS ||Debug the key mapping for specific keys || ||
     94||XPRA_XSETTINGS_DEBUG ||Debug XSettings|| 0||
    5495
    5596
     
    64105||XPRA_ENCRYPTION_KEY ||Override the encryption key file option || ||
    65106||XPRA_XSHM ||Enable XShm|| 1||
     107||XPRA_WRAPPER_DEBUG ||Debug the process wrapper || 0||
     108||XPRA_HEXLIFY_PACKETS ||Dump the process wrapper's packets in hex form || 0||
     109||XPRA_WIN32_SHOWWINDOW ||Run the process wrapper in a shell window on MS Windows || 0||
     110||XPRA_USE_RENCODER ||Use rencode if available || 1||
     111||XPRA_USE_BENCODER ||Use bencode if available || 1||
     112||XPRA_USE_YAML ||Use yaml if available || 1||
     113||USE_CYTHON_BENCODE ||Use the Cython version of the bencoder || 1||
     114||XPRA_USE_ALIASES ||Use aliases for packet headers || 1||
     115||XPRA_READ_BUFFER_SIZE ||Size of the network packet read buffer || 65536||
     116||XPRA_PACKET_JOIN_SIZE ||Size below which packets and headers are joined up together || same as read buffer size||
     117||LARGE_PACKET_SIZE ||Size above which uncompressed data in packets triggers a warning || 4096||
     118||XPRA_INLINE_SIZE ||Size below which compressed data is sent inlined in the main packet || 32768||
     119||XPRA_MIN_COMPRESS_SIZE ||Size below which we don't try to compress the packet || 378||
     120||XPRA_ENABLE_CRYPTO ||Enable encryption layer || 1||
     121||XPRA_ENCRYPT_FIRST_PACKET ||Send the first packet encrypted (see #951) || 0||
     122||XPRA_CRYPTO_DEFAULT_IV ||Override the crypto iv || (default is random)||
     123||XPRA_CRYPTO_DEFAULT_SALT ||Override the crypto salt || (default is random)||
     124||XPRA_CRYPTO_DEFAULT_ITERATIONS ||Override number of iterations || 1000||
     125||XPRA_CRYPTO_INITIAL_PADDING ||Padding used in the initial packet (see #933) || legacy||
     126||XPRA_CRYPTO_PREFERRED_PADDING ||Padding used (if supported) || PKCS#7||
     127
    66128
    67129[[BR]]
     
    69131== Fault Injection ==
    70132
    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||
     133For "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.
     134
     135||XPRA_PAINT_FAULT_INJECTION_RATE ||Simulate errors in paint events || 0||
     136||XPRA_PAINT_FAULT_INJECTION_TELL ||Whether paint errors are reported back to the server || 1||
     137||XPRA_WRAPPER_FAULT_INJECTION_RATE ||Simulate communication errors in the process wrapper || 0||
     138||XPRA_PROTOCOL_FAULT_INJECTION_RATE ||Simulate network packet errors|| 0||
     139||XPRA_FAKE_JITTER ||Introduce jitter in the network layer (value in milliseconds)|| 0||
     140
    73141
    74142[[BR]]