2018-05-03 12:30:48 +02:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								wlroots reads these environment variables
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							
								
									
										
										
										
											2019-02-22 13:58:52 -05:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								# wlroots specific
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							
								
									
										
										
										
											2018-05-15 22:10:51 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								* *WLR_BACKENDS*: comma-separated list of backends to use (available backends:
							 | 
						
					
						
							
								
									
										
										
										
											2021-09-30 10:53:18 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  libinput, drm, wayland, x11, headless)
							 | 
						
					
						
							
								
									
										
										
										
											2018-09-14 18:07:21 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								* *WLR_NO_HARDWARE_CURSORS*: set to 1 to use software cursors instead of
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  hardware cursors
							 | 
						
					
						
							
								
									
										
										
										
											2020-10-03 14:16:54 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								* *WLR_XWAYLAND*: specifies the path to an Xwayland binary to be used (instead
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  of following shell search semantics for "Xwayland")
							 | 
						
					
						
							
								
									
										
										
										
											2021-04-20 14:48:52 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								* *WLR_RENDERER*: forces the creation of a specified renderer (available
							 | 
						
					
						
							
								
									
										
										
										
											2021-11-18 23:06:13 -03:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  renderers: gles2, pixman, vulkan)
							 | 
						
					
						
							
								
									
										
										
										
											2021-11-24 10:52:39 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								* *WLR_RENDER_DRM_DEVICE*: specifies the DRM node to use for
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  hardware-accelerated renderers.
							 | 
						
					
						
							
								
									
										
										
										
											2022-10-19 11:22:14 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								* *WLR_EGL_NO_MODIFIERS*: set to 1 to disable format modifiers in EGL, this can
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  be used to understand and work around driver bugs.
							 | 
						
					
						
							
								
									
										
										
										
											2018-05-03 12:30:48 +02:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							
								
									
										
										
										
											2020-01-14 13:27:22 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								## 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
							 | 
						
					
						
							
								
									
										
										
										
											2020-01-24 19:31:39 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								* *WLR_DRM_NO_MODIFIERS*: set to 1 to always allocate planes without modifiers,
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  this can fix certain modeset failures because of bandwidth restrictions.
							 | 
						
					
						
							
								
									
										
										
										
											2022-08-18 19:17:33 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								* *WLR_DRM_FORCE_LIBLIFTOFF*: set to 1 to force libliftoff (by default,
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  libliftoff is never used)
							 | 
						
					
						
							
								
									
										
										
										
											2020-01-14 13:27:22 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								## Headless backend
							 | 
						
					
						
							
								
									
										
										
										
											2019-02-22 13:58:52 -05:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								* *WLR_HEADLESS_OUTPUTS*: when using the headless backend specifies the number
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  of outputs
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							
								
									
										
										
										
											2020-01-14 13:27:22 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								## libinput backend
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								* *WLR_LIBINPUT_NO_DEVICES*: set to 1 to not fail without any input devices
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								## Wayland backend
							 | 
						
					
						
							
								
									
										
										
										
											2019-02-22 13:58:52 -05:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								* *WLR_WL_OUTPUTS*: when using the wayland backend specifies the number of outputs
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							
								
									
										
										
										
											2020-01-14 13:27:22 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								## X11 backend
							 | 
						
					
						
							
								
									
										
										
										
											2019-02-22 13:58:52 -05:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								* *WLR_X11_OUTPUTS*: when using the X11 backend specifies the number of outputs
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							
								
									
										
										
										
											2021-01-26 21:13:28 -05:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								## gles2 renderer
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								* *WLR_RENDERER_ALLOW_SOFTWARE*: allows the gles2 renderer to use software
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  rendering
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							
								
									
										
										
										
											2022-05-20 18:28:08 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								## scenes
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								* *WLR_SCENE_DEBUG_DAMAGE*: specifies debug options for screen damage related
							 | 
						
					
						
							
								
									
										
										
										
											2022-05-27 20:15:00 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  tasks for compositors that use scenes (available options: none, rerender,
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  highlight)
							 | 
						
					
						
							
								
									
										
										
										
											2022-08-08 00:40:21 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								* *WLR_SCENE_DISABLE_DIRECT_SCANOUT*: disables direct scan-out for debugging.
							 | 
						
					
						
							
								
									
										
										
										
											2022-06-25 18:34:26 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								* *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
							 | 
						
					
						
							
								
									
										
										
										
											2024-05-11 11:59:36 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  be disabled. Note that direct scanout will not work for most cases when this
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  option is set as surfaces that don't contribute to the rendered output will now
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  bail direct scanout (desktop background / black rect underneath).
							 | 
						
					
						
							
								
									
										
										
										
											2024-05-04 19:03:36 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								* *WLR_SCENE_HIGHLIGHT_TRANSPARENT_REGION*: Highlights regions of scene buffers
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  that are advertised as transparent through wlr_scene_buffer_set_opaque_region().
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  This can be used to debug issues with clients advertizing bogus opaque regions
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  with scene based compositors.
							 | 
						
					
						
							
								
									
										
										
										
											2022-05-20 18:28:08 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							
								
									
										
										
										
											2019-02-22 13:58:52 -05:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								# Generic
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							
								
									
										
										
										
											2020-12-24 12:19:34 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								* *DISPLAY*: if set probe X11 backend in `wlr_backend_autocreate`
							 | 
						
					
						
							
								
									
										
										
										
											2020-12-24 12:17:31 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								* *WAYLAND_DISPLAY*, *WAYLAND_SOCKET*: if set probe Wayland backend in
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  `wlr_backend_autocreate`
							 | 
						
					
						
							
								
									
										
										
										
											2018-05-03 12:30:48 +02:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								* *XCURSOR_PATH*: directory where xcursors are located
							 | 
						
					
						
							
								
									
										
										
										
											2020-01-14 13:34:51 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								* *XDG_SESSION_ID*: if set, session ID used by the logind session
							 |