diff options
Diffstat (limited to 'man/weston.ini.man')
| -rw-r--r-- | man/weston.ini.man | 174 |
1 files changed, 107 insertions, 67 deletions
diff --git a/man/weston.ini.man b/man/weston.ini.man index fe86bb6c..199b465c 100644 --- a/man/weston.ini.man +++ b/man/weston.ini.man @@ -73,7 +73,6 @@ The section headers are: .BR "libinput " "Input device configuration" .BR "shell " "Desktop customization" .BR "launcher " "Add launcher to the panel" -.BR "screensaver " "Screensaver selection" .BR "output " "Output configuration" .BR "input-method " "Onscreen keyboard input" .BR "keyboard " "Keyboard layouts" @@ -107,14 +106,17 @@ directory are: .fi .RE .TP 7 -.BI "modules=" xwayland.so,cms-colord.so +.BI "xwayland=" true +ask Weston to load the XWayland module (boolean). +.RE +.TP 7 +.BI "modules=" cms-colord.so,screen-share.so specifies the modules to load (string). Available modules in the .IR "__weston_modules_dir__" directory are: .PP .RS 10 .nf -.BR xwayland.so .BR cms-colord.so .BR screen-share.so .fi @@ -122,7 +124,7 @@ directory are: .TP 7 .BI "backend=" headless-backend.so overrides defaults backend. Available backend modules in the -.IR "__weston_modules_dir__" +.IR "__libweston_modules_dir__" directory are: .PP .RS 10 @@ -131,7 +133,6 @@ directory are: .BR fbdev-backend.so .BR headless-backend.so .BR rdp-backend.so -.BR rpi-backend.so .BR wayland-backend.so .BR x11-backend.so .fi @@ -160,10 +161,7 @@ By default, xrgb8888 is used. .BI "idle-time="seconds sets Weston's idle timeout in seconds. This idle timeout is the time after which Weston will enter an "inactive" mode and screen will fade to -black. Note that a screensaver may also start at this moment after fade-out -(if enabled in the SCREENSAVER section below), but the current idle-time -option has nothing to do with screensavers. A value of 0 disables the -timeout. +black. A value of 0 disables the timeout. .IR Important : This option may also be set via Weston's '-i' command @@ -173,6 +171,24 @@ time, the one specified in the command-line will be used. On the other hand, if none of these sets the value, default idle timeout will be set to 300 seconds. .RS +.PP +.RE +.TP 7 +.BI "require-input=" true +require an input device for launch +.TP 7 +.BI "pageflip-timeout="milliseconds +sets Weston's pageflip timeout in milliseconds. This sets a timer to exit +gracefully with a log message and an exit code of 1 in case the DRM driver is +non-responsive. Setting it to 0 disables this feature. +.TP 7 +.BI "wait-for-debugger=" true +Raises SIGSTOP before initializing the compositor. This allows the user to +attach with a debugger and continue execution by sending SIGCONT. This is +useful for debugging a crash on start-up when it would be inconvenient to +launch weston directly from a debugger. Boolean, defaults to +.BR false . +There is also a command line option to do the same. .SH "LIBINPUT SECTION" The @@ -184,8 +200,47 @@ Available configuration are: .TP 7 .BI "enable_tap=" true enables tap to click on touchpad devices +.TP 7 +.BI "touchscreen_calibrator=" true +Advertise the touchscreen calibrator interface to all clients. This is a +potential denial-of-service attack vector, so it should only be enabled on +trusted userspace. Boolean, defaults to +.BR false . + +The interface is required for running touchscreen calibrator applications. It +provides the application raw touch events, bypassing the normal touch handling. +It also allows the application to upload a new calibration into the compositor. + +Even though this option is listed in the libinput section, it does affect all +Weston configurations regardless of the used backend. If the backend does not +use libinput, the interface can still be advertised, but it will not list any +devices. +.TP 7 +.BI "calibration_helper=" /bin/echo +An optional calibration helper program to permanently save a new touchscreen +calibration. String, defaults to unset. + +The given program will be executed with seven arguments when a calibrator +application requests the server to take a new calibration matrix into use. +The program is executed synchronously and will therefore block Weston for its +duration. If the program exit status is non-zero, Weston will not apply the +new calibration. If the helper is unset or the program exit status is zero, +Weston will use the new calibration immediately. + +The program is invoked as: +.PP +.RS 10 +.I calibration_helper syspath m1 m2 m3 m4 m5 m6 +.RE .RS .PP +.RI "where " syspath +is the udev sys path for the device and +.IR m1 " through " m6 +are the calibration matrix elements in libinput's +.BR LIBINPUT_CALIBRATION_MATRIX " udev property format." +The sys path is an absolute path and starts with the sys mount point. +.RE .SH "SHELL SECTION" The @@ -216,6 +271,13 @@ output. Tile repeats the background image to fill the output. sets the color of the background (unsigned integer). The hexadecimal digit pairs are in order alpha, red, green, and blue. .TP 7 +.BI "clock-format=" format +sets the panel clock format (string). Can be +.BR "none" "," +.BR "minutes" "," +.BR "seconds" "." +By default, minutes format is used. +.TP 7 .BI "panel-color=" 0xAARRGGBB sets the color of the panel (unsigned integer). The hexadecimal digit pairs are in order transparency, red, green, and blue. Examples: @@ -229,9 +291,12 @@ digit pairs are in order transparency, red, green, and blue. Examples: .fi .RE .TP 7 -.BI "panel-location=" top -sets the location of the panel (string). Can be +.BI "panel-position=" top +sets the position of the panel (string). Can be .B top, +.B bottom, +.B left, +.B right, .B none. .TP 7 .BI "locking=" true @@ -262,11 +327,15 @@ sets the effect used with the focused and unfocused windows. Can be .B none. By default, no animation is used. .TP 7 +.BI "allow-zap=" true +whether the shell should quit when the Ctrl-Alt-Backspace key combination is +pressed +.TP 7 .BI "binding-modifier=" ctrl sets the modifier key used for common bindings (string), such as moving surfaces, resizing, rotating, switching, closing and setting the transparency for windows, controlling the backlight and zooming the desktop. Possible values: -ctrl, alt, super (default) +none, ctrl, alt, super (default) .TP 7 .BI "num-workspaces=" 6 defines the number of workspaces (unsigned integer). The user can switch @@ -305,26 +374,6 @@ path=GDK_BACKEND=wayland gnome-terminal --full-screen .in .fi .PP -.RE -.SH "SCREENSAVER SECTION" -The -.B screensaver -section is used to select and schedule a screensaver. -The -.B screensaver -section is optional, as are all of the entries that may be specified in -it. -.TP 7 -.BI "path=" /usr/libexec/weston-screensaver -This instructs the compositor to use the selected screensaver client on a given -path (string). If this line is missing or commented out, the screensaver in -.B "weston(1)" -is disabled. -.RE -.TP 7 -.BI "duration=" 600 -The time in seconds until the screensaver disappears in order to save power -(unsigned integer). .SH "OUTPUT SECTION" There can be multiple output sections, each corresponding to one output. It is currently only recognized by the drm and x11 backends. @@ -357,31 +406,11 @@ for more details. sets the output mode (string). The mode parameter is handled differently depending on the backend. On the X11 backend, it just sets the WIDTHxHEIGHT of the weston window. -The DRM backend accepts different modes: -.PP -.RS 10 -.nf -.BR "WIDTHxHEIGHT " "Resolution size width and height in pixels" -.BR "preferred " "Uses the preferred mode" -.BR "current " "Uses the current crt controller mode" -.BR "off " "Disables the output" -.fi -.RE -.RS -.PP -Optionally, an user may specify a modeline, such as: -.PP -.nf -.in +4n -.nf -173.00 1920 2048 2248 2576 1080 1083 1088 1120 -hsync +vsync -.fi -.in -.PP -It consists of the refresh rate in Hz, horizontal and vertical resolution, -options for horizontal and vertical synchronisation. The program -.B "cvt(1)" -can provide suitable modeline string. +The DRM backend accepts different modes, along with an option of a modeline string. + +See +.B "weston-drm(7)" +for examples of modes-formats supported by DRM backend. .RE .TP 7 .BI "transform=" normal @@ -402,19 +431,24 @@ be one of the following 8 strings: .RE .TP 7 .BI "scale=" factor -An integer, 1 by default, typically configured as 2 when needed, denoting -the scale factor of the output. Applications that support it render at the -appropriate scale. For other applications, weston will scale their output -by this factor. +The scaling multiplier applied to the entire output, in support of high +resolution ("HiDPI" or "retina") displays, that roughly corresponds to the +pixel ratio of the display's physical resolution to the logical resolution. +Applications that do not support high resolution displays typically appear tiny +and unreadable. Weston will scale the output of such applications by this +multiplier, to make them readable. Applications that do support their own output +scaling can draw their content in high resolution, in which case they avoid +compositor scaling. Weston will not scale the output of such applications, and +they are not affected by this multiplier. .RE .RS .PP -Use a value of 2 for outputs with high resolution. Such displays are often -called "HiDPI" or "retina" displays. +An integer, 1 by default, typically configured as 2 or higher when needed, +denoting the scaling multiplier for the output. .RE .TP 7 .BI "seat=" name -The logical seat name that that this output should be associated with. If this +The logical seat name that this output should be associated with. If this is set then the seat's input will be confined to the output that has the seat set on it. The expectation is that this functionality will be used in a multiheaded environment with a single compositor for multiple output and input @@ -423,7 +457,7 @@ present. This seat can be constrained like any other. .RE .SH "INPUT-METHOD SECTION" .TP 7 -.BI "path=" "/usr/libexec/weston-keyboard" +.BI "path=" "__weston_libexecdir__/weston-keyboard" sets the path of the on screen keyboard input method (string). .RE .RE @@ -479,6 +513,12 @@ sets the default state of the numlock on weston startup for the backends which support it. .RE .RE +.TP 7 +.BI "vt-switching=" "true" +Whether to allow the use of Ctrl+Alt+Fn key combinations to switch away from +the compositor's virtual console. +.RE +.RE .SH "TERMINAL SECTION" Contains settings for the weston terminal application (weston-terminal). It allows to customize the font and shell of the command line interface. @@ -500,13 +540,13 @@ The terminal shell (string). Sets the $TERM variable. .RE .SH "XWAYLAND SECTION" .TP 7 -.BI "path=" "/usr/bin/Xwayland" +.BI "path=" "__xserver_path__" sets the path to the xserver to run (string). .RE .RE .SH "SCREEN-SHARE SECTION" .TP 7 -.BI "command=" "/usr/bin/weston --backend=rdp-backend.so \ +.BI "command=" "__weston_bindir__/weston --backend=rdp-backend.so \ --shell=fullscreen-shell.so --no-clients-resize" sets the command to start a fullscreen-shell server for screen sharing (string). .RE |