diff --git a/getting-started.md b/getting-started.md index c096ba90c3f2f1a8224248e1dcbe382724b39346..88fe73db4beac935616b0e1e368f46383512fe6f 100644 --- a/getting-started.md +++ b/getting-started.md @@ -223,18 +223,18 @@ Available for monado-service and OpenXR application: Available for monado-service: -* `XRT_COMPOSITOR_PRINT_DEBUG=1` - * Print debug information (selected GPU, driver, display mode, ...) +* `XRT_COMPOSITOR_LOG=debug` + * Print compositor related debug information (selected GPU, driver, display mode, ...). See [Logging](#loglevel). * `XRT_COMPOSITOR_PRINT_MODES=1` - * Like `XRT_COMPOSITOR_PRINT_DEBUG`, but only prints modes. Useful for `XRT_COMPOSITOR_DESIRED_MODE`. + * Like `XRT_COMPOSITOR_LOG=debug`, but only prints modes. Useful for `XRT_COMPOSITOR_DESIRED_MODE`. * `XRT_COMPOSITOR_DESIRED_MODE=<INDEX>` * By default Monado chooses the highest resolution with the highest refresh rate. See `XRT_COMPOSITOR_PRINT_MODES` for a list of modes supported by the HMD. * `XRT_COMPOSITOR_FORCE_GPU_INDEX=<INDEX>` - * See `XRT_COMPOSITOR_PRINT_DEBUG` for the index of available Vulkan devices. + * See `XRT_COMPOSITOR_LOG=debug` for the index of available Vulkan devices. * `XRT_COMPOSITOR_FORCE_XCB=1` * Do not use direct mode and run the Monado compositor in a window. * `XRT_COMPOSITOR_FORCE_NVIDIA=1` and `XRT_COMPOSITOR_FORCE_RANDR=1` - * Force the use of nvidia or mesa/amdvlk direct mode. This should never be necessary. + * Force the use of nvidia or mesa/amdvlk direct mode. Usually this should not be necessary. * `XRT_COMPOSITOR_SCALE_PERCENTAGE` * Scales the render target size recommended to applications to render at. Affects all applications connecting to this service. Defaults to 140% supersampling. @@ -245,18 +245,23 @@ Available for OpenXR applications ## Logging +{: #loglevel} -Available for monado-service: +Various components and drivers in Monado use a logging system with well known logging levels `trace`, `debug`, `info` `warn`, `error`. -A logging system with well known logging levels `trace`, `debug`, `info` `warn`, `error` levels is being implemented in Monado and can be used with some drivers: +At this time the log level can only be changed for components individually by using environment variables. +The default log level is `warn`. +Environment variables that make use of the log level system typically end with `_LOG`. Examples: * `VIVE_LOG=debug` +* `XRT_COMPOSITOR_LOG=debug` -Some drivers still use a simpler system that only differentiates between "DEBUG" messages and verbose "SPEW" messages. +Some components and drivers still use a simpler system that only differentiates between "DEBUG" messages and verbose "SPEW" messages. Examples: -* `PSVR_PRINT_DEBUG=1`, `PSVR_PRINT_SPEW=FALSE=1` +* `PSVR_PRINT_DEBUG=1` +* `PSVR_PRINT_SPEW=FALSE=1` -## Debugging +## Debug GUI Available for OpenXR applications: