Mir configuration options¶
Mir compositors can usually be configured (in the order of precedence) on the command line, in the environment, or in a configuration file.
Different compositors will expose different options, but here’s a list of those available by default:
Options¶
arw-file¶
Make server Wayland socket readable and writeable by all users. For debugging purposes only.
composite-delay¶
Number of milliseconds to wait for new frames from clients before compositing. Higher values result in lower latency but risk causing frame skipping.
Defaults to 0.
compositor-report¶
Configure compositor reporting. [{off,log,lttng}]
Defaults to off.
console-provider¶
Method used to handle console-related tasks (device handling, VT switching, etc):
logind: use logind.vt: use the Linux VT subsystem. Requires root.none: support no console-related tasks. Useful for nested platforms which do not need raw device access and which don’t have a VT concept.auto: detect the appropriate provider.
Defaults to auto.
cursor¶
Cursor type:
auto: use hardware if available, or fallback to software.null: cursor disabled.software: always use software cursor.
Defaults to auto.
debug¶
Enable debugging information. Useful when developing Mir servers.
display-report¶
Configure display reporting. [{off,log,lttng}]
Defaults to off.
enable-input¶
Enable input.
Defaults to 1.
enable-key-repeat¶
Enable server generated key repeat.
Defaults to 1.
enable-touchspots¶
Enable visual feedback of touch events. Useful for screencasting.
env-hacks¶
Colon separated list of environment variable settings.
help¶
Show command line help.
help-markdown¶
Show command line options in markdown format suitable for including into a document.
idle-timeout¶
Number of seconds Mir will remain idle before turning off the display when the session is not locked, or 0 to keep display on forever.
Defaults to 0.
idle-timeout-when-locked¶
Number of seconds Mir will remain idle before turning off the display when the session is locked, or 0 to keep the display on forever.
Defaults to 0.
input-report¶
Configure input reporting. [{off,log,lttng}]
Defaults to off.
key-repeat-delay¶
Number of millisecond to hold down a key before generating repeat events.
Defaults to 600.
key-repeat-rate¶
Number of milliseconds between generated key repeat events.
Defaults to 25.
mouse-cursor-acceleration¶
Acceleration profile for mice and trackballs:
none: no acceleration.adaptive: cursor is accelerated.
mouse-cursor-acceleration-bias¶
Pointer acceleration speed of mice. Must be within range of [-1.0, 1.0].
mouse-handedness¶
Mouse laterality:
right: left button is primary.left: right button is primary.
mouse-horizontal-scroll-speed-override¶
Mouse horizontal scroll speed scaling factor. Use negative values for natural scrolling.
mouse-scroll-speed¶
Mouse scroll speed scaling factor. Use negative values for natural scrolling.
mouse-vertical-scroll-speed-override¶
Mouse vertical scroll speed scaling factor. Use negative values for natural scrolling.
on-fatal-error-except¶
Throw an exception when a fatal error condition occurs. This replaces the default behaviour of dumping core and can make it easier to diagnose issues.
platform-display-libs¶
Comma separated list of libraries to use for platform output support, e.g. mir:x11,mir:wayland. If not provided the libraries are autodetected.
platform-input-lib¶
Library to use for platform input support, e.g. mir:stub-input. If not provided this is autodetected.
platform-path¶
Directory to look for platform libraries.
Defaults to <LIBDIR>/mir/server-platform.
platform-rendering-libs¶
Comma separated list of libraries to use for platform rendering support, e.g. mir:egl-generic. If not provided the libraries are autodetected.
scene-report¶
Configure scene reporting. [{off,log,lttng}]
Defaults to off.
seat-report¶
Configure seat reporting. [{off,log}]
Defaults to off.
shell-report¶
Configure shell reporting. [{off,log}]
Defaults to off.
touchpad-click-mode¶
Click mode for touchpad. Left, middle and right button click events generated when:
none: no events generated.area: single finger tap on left, middle or right area.clickfinger: one, two or three fingers present when touchpad pushed down.
touchpad-cursor-acceleration¶
Acceleration profile for touchpads:
none: no acceleration.adaptive: cursor accelerates.
touchpad-cursor-acceleration-bias¶
Pointer acceleration speed scaling factor for touchpads. Must be within range of [-1.0, 1.0].
touchpad-disable-while-typing¶
Disable touchpad while typing on keyboard. [true, false]
touchpad-disable-with-external-mouse¶
Disable touchpad if an external pointer device is plugged in. [true, false]
touchpad-horizontal-scroll-speed-override¶
Touchpad horizontal scroll scaling factor. Use negative values for natural scrolling.
touchpad-scroll-mode¶
Scroll mode for touchpads. Generates scroll events when:
edge: single finger moves on right or bottom edges of touchpad.two-finger: two fingers move horizontally or vertically.button-down: mouse button held down.
touchpad-scroll-speed¶
Touchpad scroll scaling factor. Use negative values for natural scrolling.
touchpad-tap-to-click¶
Enable or disable tap-to-click on this device. If enabled 1, 2, and 3 finger taps are mapped to left, right, middle click events. [true, false]
touchpad-vertical-scroll-speed-override¶
Touchpad vertical scroll scaling factor. Use negative values for natural scrolling.
version¶
Display Mir version and exit.
vt¶
VT to run on or 0 to use current. Only used when --console-provider=vt.
Defaults to 0.
vt-switching¶
Enable VT switching on Ctrl+Alt+F*. Only used when --console-provider=vt|logind.
Defaults to 1.
window-management-trace¶
Log trace message
Options for mir:atomic-kms platform¶
bypass¶
Enable bypass optimization for fullscreen surfaces.
Defaults to 0.
driver-quirks¶
Driver quirks to apply. May be specified multiple times; multiple quirks are combined.
Options for mir:gbm-kms platform¶
bypass¶
Enable bypass optimization for fullscreen surfaces.
Defaults to 0.
driver-quirks¶
Driver quirks to apply. May be specified multiple times; multiple quirks are combined.
Options for mir:virtual platform¶
virtual-output¶
Colon separated list of outputs to use. Dimensions are in the form WIDTHxHEIGHT, e.g. 1920x1080:3840x2160.
Options for mir:wayland platform¶
wayland-host¶
Display name for host compositor, e.g. wayland-0.
wayland-surface-app-id¶
Application ID for the window containing the Mir output.
wayland-surface-title¶
Title of the window containing the Mir output.
Options for mir:x11 platform¶
x11-output¶
Colon separated list of outputs to use. Dimensions are in the form WIDTHxHEIGHT[^SCALE], e.g. 1920x1080:3840x2160^2.
Defaults to 1280x1024.
x11-window-title¶
Title of the window containing the Mir output.
Defaults to Mir on X.