mirrors/wlroots
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wlroots/wlroots.git synced 2026-04-14 08:22:25 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
wlroots/docs/env_vars.md
Chris P 444f5eb4c8 doc: Add information about rapid hotplug detection 
This commit appends information about the WLR_RAPID_HOTPLUG_PREVENT enviroment
variable from the previous commit to the documentation page on envrionment variables,
namely what its purpose is and that the user should be aware of a delay in the event
that a rapid hotplug occurs.
2024-04-03 05:34:39 -04:00

2.8 KiB
Raw Blame History

wlroots reads these environment variables

wlroots specific

  • WLR_BACKENDS: comma-separated list of backends to use (available backends: libinput, drm, wayland, x11, headless)
  • WLR_NO_HARDWARE_CURSORS: set to 1 to use software cursors instead of hardware cursors
  • WLR_XWAYLAND: specifies the path to an Xwayland binary to be used (instead of following shell search semantics for "Xwayland")
  • WLR_RENDERER: forces the creation of a specified renderer (available renderers: gles2, pixman, vulkan)
  • WLR_RENDER_DRM_DEVICE: specifies the DRM node to use for hardware-accelerated renderers.
  • WLR_EGL_NO_MODIFIERS: set to 1 to disable format modifiers in EGL, this can be used to understand and work around driver bugs.
  • WLR_RAPID_HOTPLUG_PREVENT: set to 1 to wait after an output device hotplug in case another occurs immediately after, and if so, ignore both. This is to work around monitors that implement DisplayPort's "deep sleep" feature, but causes a second delay for each change event due to waiting.

DRM backend

  • WLR_DRM_DEVICES: specifies the DRM devices (as a colon separated list) instead of auto probing them. The first existing device in this list is considered the primary DRM device.
  • WLR_DRM_NO_ATOMIC: set to 1 to use legacy DRM interface instead of atomic mode setting
  • WLR_DRM_NO_MODIFIERS: set to 1 to always allocate planes without modifiers, this can fix certain modeset failures because of bandwidth restrictions.
  • WLR_DRM_FORCE_LIBLIFTOFF: set to 1 to force libliftoff (by default, libliftoff is never used)

Headless backend

  • WLR_HEADLESS_OUTPUTS: when using the headless backend specifies the number of outputs

libinput backend

  • WLR_LIBINPUT_NO_DEVICES: set to 1 to not fail without any input devices

Wayland backend

  • WLR_WL_OUTPUTS: when using the wayland backend specifies the number of outputs

X11 backend

  • WLR_X11_OUTPUTS: when using the X11 backend specifies the number of outputs

gles2 renderer

  • WLR_RENDERER_ALLOW_SOFTWARE: allows the gles2 renderer to use software rendering

scenes

  • WLR_SCENE_DEBUG_DAMAGE: specifies debug options for screen damage related tasks for compositors that use scenes (available options: none, rerender, highlight)
  • WLR_SCENE_DISABLE_DIRECT_SCANOUT: disables direct scan-out for debugging.
  • WLR_SCENE_DISABLE_VISIBILITY: If set to 1, the visibility of all scene nodes will be considered to be the full node. Intelligent visibility canculations will be disabled.

Generic

  • DISPLAY: if set probe X11 backend in wlr_backend_autocreate
  • WAYLAND_DISPLAY, WAYLAND_SOCKET: if set probe Wayland backend in wlr_backend_autocreate
  • XCURSOR_PATH: directory where xcursors are located
  • XDG_SESSION_ID: if set, session ID used by the logind session