Debian Codegraph @

doc/sphinx/configuring/reference/options.md.include

raw
1 ## Options
2
3 (global-arw-file)=
4 ### `arw-file`
5
6 Make server Wayland socket readable and writeable by all users. For debugging purposes only.
7
8 (global-composite-delay)=
9 ### `composite-delay`
10
11 Number of milliseconds to wait for new frames from clients before compositing. Higher values result in higher latency but risk causing frame skipping.
12
13 Defaults to `0`.
14
15 (global-compositor-report)=
16 ### `compositor-report`
17
18 Configure compositor reporting. [{off,log,lttng}]
19
20 Defaults to `off`.
21
22 (global-console-provider)=
23 ### `console-provider`
24
25 Method used to handle console-related tasks (device handling, VT switching, etc):
26 - `logind`: use logind.
27 - `vt`: use the Linux VT subsystem. Requires root.
28 - `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.
29 - `auto`: detect the appropriate provider.
30
31 Defaults to `auto`.
32
33 (global-cursor)=
34 ### `cursor`
35
36 Cursor type:
37 - `auto`: use hardware if available, or fallback to software.
38 - `null`: cursor disabled.
39 - `software`: always use software cursor.
40
41 Defaults to `auto`.
42
43 (global-debug)=
44 ### `debug`
45
46 Enable debugging information. Useful when developing Mir servers.
47
48 (global-display-report)=
49 ### `display-report`
50
51 Configure display reporting. [{off,log,lttng}]
52
53 Defaults to `off`.
54
55 (global-enable-input)=
56 ### `enable-input`
57
58 Enable input.
59
60 Defaults to `1`.
61
62 (global-enable-key-repeat)=
63 ### `enable-key-repeat`
64
65 Enable server generated key repeat.
66
67 Defaults to `1`.
68
69 (global-enable-touchspots)=
70 ### `enable-touchspots`
71
72 Enable visual feedback of touch events. Useful for screencasting.
73
74 (global-env-hacks)=
75 ### `env-hacks`
76
77 Colon separated list of environment variable settings.
78
79 (global-help)=
80 ### `help`
81
82 Show command line help.
83
84 (global-help-markdown)=
85 ### `help-markdown`
86
87 Show command line options in markdown format suitable for including into a document.
88
89 (global-idle-timeout)=
90 ### `idle-timeout`
91
92 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.
93
94 Defaults to `0`.
95
96 (global-idle-timeout-when-locked)=
97 ### `idle-timeout-when-locked`
98
99 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.
100
101 Defaults to `0`.
102
103 (global-input-report)=
104 ### `input-report`
105
106 Configure input reporting. [{off,log,lttng}]
107
108 Defaults to `off`.
109
110 (global-key-repeat-delay)=
111 ### `key-repeat-delay`
112
113 Number of milliseconds to hold down a key before generating repeat events.
114
115 Defaults to `600`.
116
117 (global-key-repeat-rate)=
118 ### `key-repeat-rate`
119
120 Rate of repeating keys in characters per second.
121
122 Defaults to `25`.
123
124 (global-mouse-cursor-acceleration)=
125 ### `mouse-cursor-acceleration`
126
127 Acceleration profile for mice and trackballs:
128 - `none`: no acceleration.
129 - `adaptive`: cursor is accelerated.
130
131 (global-mouse-cursor-acceleration-bias)=
132 ### `mouse-cursor-acceleration-bias`
133
134 Pointer acceleration speed of mice. Must be within range of [-1.0, 1.0].
135
136 (global-mouse-handedness)=
137 ### `mouse-handedness`
138
139 Mouse laterality:
140 - `right`: left button is primary.
141 - `left`: right button is primary.
142
143 (global-mouse-horizontal-scroll-speed-override)=
144 ### `mouse-horizontal-scroll-speed-override`
145
146 Mouse horizontal scroll speed scaling factor. Use negative values for natural scrolling.
147
148 (global-mouse-scroll-speed)=
149 ### `mouse-scroll-speed`
150
151 Mouse scroll speed scaling factor. Use negative values for natural scrolling.
152
153 (global-mouse-vertical-scroll-speed-override)=
154 ### `mouse-vertical-scroll-speed-override`
155
156 Mouse vertical scroll speed scaling factor. Use negative values for natural scrolling.
157
158 (global-on-fatal-error-except)=
159 ### `on-fatal-error-except`
160
161 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.
162
163 (global-platform-display-libs)=
164 ### `platform-display-libs`
165
166 Comma separated list of libraries to use for platform output support, e.g. `mir:x11,mir:wayland`. If not provided the libraries are autodetected.
167
168 (global-platform-input-lib)=
169 ### `platform-input-lib`
170
171 Library to use for platform input support, e.g. `mir:stub-input`. If not provided this is autodetected.
172
173 (global-platform-path)=
174 ### `platform-path`
175
176 Directory to look for platform libraries.
177
178 Defaults to `<LIBDIR>/mir/server-platform`.
179
180 (global-platform-rendering-libs)=
181 ### `platform-rendering-libs`
182
183 Comma separated list of libraries to use for platform rendering support, e.g. `mir:egl-generic`. If not provided the libraries are autodetected.
184
185 (global-scene-report)=
186 ### `scene-report`
187
188 Configure scene reporting. [{off,log,lttng}]
189
190 Defaults to `off`.
191
192 (global-seat-report)=
193 ### `seat-report`
194
195 Configure seat reporting. [{off,log}]
196
197 Defaults to `off`.
198
199 (global-shared-library-prober-report)=
200 ### `shared-library-prober-report`
201
202 Configure shared library prober reporting. [{log,off,lttng}]
203
204 Defaults to `log`.
205
206 (global-shell-report)=
207 ### `shell-report`
208
209 Configure shell reporting. [{off,log}]
210
211 Defaults to `off`.
212
213 (global-touchpad-click-mode)=
214 ### `touchpad-click-mode`
215
216 Click mode for touchpad. Left, middle and right button click events generated when:
217 - `none`: no events generated.
218 - `area`: single finger tap on left, middle or right area.
219 - `clickfinger`: one, two or three fingers present when touchpad pushed down.
220
221 (global-touchpad-cursor-acceleration)=
222 ### `touchpad-cursor-acceleration`
223
224 Acceleration profile for touchpads:
225 - `none`: no acceleration.
226 - `adaptive`: cursor accelerates.
227
228 (global-touchpad-cursor-acceleration-bias)=
229 ### `touchpad-cursor-acceleration-bias`
230
231 Pointer acceleration speed scaling factor for touchpads. Must be within range of [-1.0, 1.0].
232
233 (global-touchpad-disable-while-typing)=
234 ### `touchpad-disable-while-typing`
235
236 Disable touchpad while typing on keyboard. [true, false]
237
238 (global-touchpad-disable-with-external-mouse)=
239 ### `touchpad-disable-with-external-mouse`
240
241 Disable touchpad if an external pointer device is plugged in. [true, false]
242
243 (global-touchpad-horizontal-scroll-speed-override)=
244 ### `touchpad-horizontal-scroll-speed-override`
245
246 Touchpad horizontal scroll scaling factor. Use negative values for natural scrolling.
247
248 (global-touchpad-middle-mouse-button-emulation)=
249 ### `touchpad-middle-mouse-button-emulation`
250
251 Generate middle mouse button click from a simultaneous left and right button click.
252
253 (global-touchpad-scroll-mode)=
254 ### `touchpad-scroll-mode`
255
256 Scroll mode for touchpads. Generates scroll events when:
257 - `edge`: single finger moves on right or bottom edges of touchpad.
258 - `two-finger`: two fingers move horizontally or vertically.
259 - `button-down`: mouse button held down.
260
261 (global-touchpad-scroll-speed)=
262 ### `touchpad-scroll-speed`
263
264 Touchpad scroll scaling factor. Use negative values for natural scrolling.
265
266 (global-touchpad-tap-to-click)=
267 ### `touchpad-tap-to-click`
268
269 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]
270
271 (global-touchpad-vertical-scroll-speed-override)=
272 ### `touchpad-vertical-scroll-speed-override`
273
274 Touchpad vertical scroll scaling factor. Use negative values for natural scrolling.
275
276 (global-version)=
277 ### `version`
278
279 Display Mir version and exit.
280
281 (global-vt)=
282 ### `vt`
283
284 VT to run on or 0 to use current. Only used when `--console-provider=vt`.
285
286 Defaults to `0`.
287
288 (global-vt-switching)=
289 ### `vt-switching`
290
291 Enable VT switching on Ctrl+Alt+F*. Only used when `--console-provider=vt|logind`.
292
293 Defaults to `1`.
294
295 (global-window-management-trace)=
296 ### `window-management-trace`
297
298 Log trace message
299 ## Options for mir:atomic-kms platform
300
301 (mir-atomic-kms-bypass)=
302 ### `bypass`
303
304 Enable bypass optimization for fullscreen surfaces.
305
306 Defaults to `0`.
307
308 (mir-atomic-kms-driver-quirks)=
309 ### `driver-quirks`
310
311 Driver quirks to apply. May be specified multiple times; multiple quirks are combined.
312 ## Options for mir:gbm-kms platform
313
314 (mir-gbm-kms-bypass)=
315 ### `bypass`
316
317 Enable bypass optimization for fullscreen surfaces.
318
319 Defaults to `0`.
320
321 (mir-gbm-kms-driver-quirks)=
322 ### `driver-quirks`
323
324 Driver quirks to apply. May be specified multiple times; multiple quirks are combined.
325 ## Options for mir:virtual platform
326
327 (mir-virtual-virtual-output)=
328 ### `virtual-output`
329
330 Colon separated list of outputs to use. Dimensions are in the form `WIDTHxHEIGHT`, e.g. `1920x1080:3840x2160`.
331 ## Options for mir:wayland platform
332
333 (mir-wayland-wayland-host)=
334 ### `wayland-host`
335
336 Display name for host compositor, e.g. `wayland-0`.
337
338 (mir-wayland-wayland-surface-app-id)=
339 ### `wayland-surface-app-id`
340
341 Application ID for the window containing the Mir output.
342
343 (mir-wayland-wayland-surface-title)=
344 ### `wayland-surface-title`
345
346 Title of the window containing the Mir output.
347 ## Options for mir:x11 platform
348
349 (mir-x11-x11-output)=
350 ### `x11-output`
351
352 Colon separated list of outputs to use. Dimensions are in the form `WIDTHxHEIGHT[^SCALE]`, e.g. `1920x1080:3840x2160^2`.
353
354 Defaults to `1280x1024`.
355
356 (mir-x11-x11-window-title)=
357 ### `x11-window-title`
358
359 Title of the window containing the Mir output.
360
361 Defaults to `Mir on X`.