1 .\" shorthand for double quote that works everywhere.
3 .TH weston.ini 5 "2013-01-17" "Weston __version__"
5 weston.ini \- configuration file for
7 \- the reference Wayland
11 obtains configuration from its command line parameters and the configuration
15 uses a configuration file called
20 configuration file is searched for in one of the following places when the
25 .BR "$XDG_CONFIG_HOME/weston.ini " "(if $XDG_CONFIG_HOME is set)"
26 .BR "$HOME/.config/weston.ini " "(if $HOME is set)"
27 .BR "<current dir>/weston.ini " "(if both variables were not set)"
31 where environment variable
33 is the user's home directory, and
35 is the user specific configuration directory.
39 file is composed of a number of sections which may be present in any order, or
40 omitted to use default configuration values. Each section has the form:
51 The spaces are significant.
52 Comment lines are ignored:
60 The section headers are:
64 .BR "core " "The core modules"
65 .BR "shell " "Desktop customization"
66 .BR "launcher " "Add launcher to the panel"
67 .BR "screensaver " "Screensaver selection"
68 .BR "output " "Output configuration"
69 .BR "input-method " "Onscreen keyboard input"
70 .BR "keyboard " "Keyboard layouts"
71 .BR "terminal " "Terminal application options"
75 Possible value types are string, signed and unsigned 32-bit
76 integer, and boolean. Strings must not be quoted, do not support any
77 escape sequences, and run till the end of the line. Integers can
78 be given in decimal (e.g. 123), octal (e.g. 0173), and hexadecimal
79 (e.g. 0x7b) form. Boolean values can be only 'true' or 'false'.
84 section is used to select the startup compositor modules.
86 .BI "modules=" desktop-shell.so,xwayland.so
87 specifies the modules to load (string). Available modules in the
88 .IR "__weston_modules_dir__"
104 section is used to customize the compositor. Some keys may not be handled by
105 different shell plugins.
107 The entries that can appear in this section are:
109 .BI "background-image=" file
110 sets the path for the background image file (string).
112 .BI "background-type=" tile
113 determines how the background image is drawn (string). Can be scale or
116 .BI "background-color=" 0xAARRGGBB
117 sets the color of the background (unsigned integer). The hexadecimal
118 digit pairs are in order alpha, red, green, and blue.
120 .BI "panel-color=" 0xAARRGGBB
121 sets the color of the panel (unsigned integer). The hexadecimal
122 digit pairs are in order transparency, red, green, and blue. Examples:
126 .BR "0xffff0000 " "Red"
127 .BR "0xff00ff00 " "Green"
128 .BR "0xff0000ff " "Blue"
129 .BR "0x00ffffff " "Fully transparent"
134 enables screen locking (boolean).
136 .BI "animation=" zoom
137 sets the effect used for opening new windows (string). Can be
140 Otherwise, no animation is used.
142 .BI "binding-modifier=" ctrl
143 sets the modifier key used for common bindings (string), such as moving
144 surfaces, resizing, rotating, switching, closing and setting the transparency
145 for windows, controlling the backlight and zooming the desktop. Possible values:
146 ctrl, alt, super (default)
148 .BI "num-workspaces=" 6
149 defines the number of workspaces (unsigned integer). The user can switch
150 workspaces by using the
151 binding+F1, F2 keys. If this key is not set, fall back to one workspace.
153 .BI "cursor-theme=" theme
154 sets the cursor theme (string).
156 .BI "cursor-size=" 24
157 sets the cursor size (unsigned integer).
159 .BI "lockscreen-icon=" path
160 sets the path to lock screen icon image (string). (tablet shell only)
162 .BI "lockscreen=" path
163 sets the path to lock screen background image (string). (tablet shell only)
165 .BI "homescreen=" path
166 sets the path to home screen background image (string). (tablet shell only)
168 .SH "LAUNCHER SECTION"
169 There can be multiple launcher sections, one for each launcher.
172 sets the path to icon image (string). Svg images are not currently supported.
175 sets the path to the program that is run by clicking on this launcher (string).
176 It is possible to pass arguments and environment variables to the program. For
181 path=GDK_BACKEND=wayland gnome-terminal --full-screen
186 .SH "SCREENSAVER SECTION"
189 section is used to select and schedule a screensaver.
192 section is optional, as are all of the entries that may be specified in
195 .BI "path=" /usr/libexec/weston-screensaver
196 This instructs the compositor to use the selected screensaver client on a given
197 path (string). If this line is missing or commented out, the screensaver in
203 The idle time in seconds until the screensaver disappears in order to save power
206 There can be multiple output sections, each corresponding to one output. It is
207 currently only recognized by the drm and x11 backends.
210 sets a name for the output (string). The backend uses the name to
211 identify the output. All X11 output names start with a letter X. The available
212 output names for DRM backend are listed in the
213 .B "weston-launch(1)"
219 .BR "LVDS1 " "DRM backend, Laptop internal panel no.1"
220 .BR "VGA1 " "DRM backend, VGA connector no.1"
221 .BR "X1 " "X11 backend, X window no.1"
232 sets the output mode (string). The mode parameter is handled differently
233 depending on the backend. On the X11 backend, it just sets the WIDTHxHEIGHT of
235 The DRM backend accepts different modes:
239 .BR "WIDTHxHEIGHT " "Resolution size width and height in pixels"
240 .BR "preferred " "Uses the preferred mode"
241 .BR "current " "Uses the current crt controller mode"
242 .BR "off " "Disables the output"
247 Optionally, an user may specify a modeline, such as:
252 173.00 1920 2048 2248 2576 1080 1083 1088 1120 -hsync +vsync
256 It consists of the refresh rate in Hz, horizontal and vertical resolution,
257 options for horizontal and vertical synchronisation. The program
259 can provide suitable modeline string.
262 .BI "transform=" normal
263 The transformation applied to screen output (string). The transform key can
264 be one of the following 8 strings:
268 .BR "normal " "Normal output."
269 .BR "90 " "90 degrees clockwise."
270 .BR "180 " "Upside down."
271 .BR "270 " "90 degrees counter clockwise."
272 .BR "flipped " "Horizontally flipped"
273 .BR "flipped-90 " "Flipped and 90 degrees clockwise"
274 .BR "flipped-180 " "Flipped upside down"
275 .BR "flipped-270 " "Flipped and 90 degrees counter clockwise"
278 .SH "INPUT-METHOD SECTION"
280 .BI "path=" "/usr/libexec/weston-keyboard"
281 sets the path of the on screen keyboard input method (string).
284 .SH "KEYBOARD SECTION"
285 This section contains the following keys:
287 .BI "keymap_rules=" "evdev"
288 sets the keymap rules file (string). Used to map layout and model to input
293 .BI "keymap_model=" "pc105"
294 sets the keymap model (string). See the Models section in
295 .B "xkeyboard-config(7)."
299 .BI "keymap_layout=" "us,de,gb"
300 sets the comma separated list of keyboard layout codes (string). See the
302 .B "xkeyboard-config(7)."
306 .BI "keymap_variant=" "euro,,intl"
307 sets the comma separated list of keyboard layout variants (string). The number
308 of variants must be the same as the number of layouts above. See the Layouts
310 .B "xkeyboard-config(7)."
314 .BI "keymap_options=" "grp:alt_shift_toggle,grp_led:scroll"
315 sets the keymap options (string). See the Options section in
316 .B "xkeyboard-config(7)."
319 .SH "TERMINAL SECTION"
320 Contains settings for the weston terminal application (weston-terminal). It
321 allows to customize the font and shell of the command line interface.
323 .BI "font=" "DejaVu Sans Mono"
324 sets the font of the terminal (string). For a good experience it is recommend
325 to use monospace fonts. In case the font is not found, the default one is used.
329 .BI "font-size=" "14"
330 sets the size of the terminal font (unsigned integer).
334 .BI "term=" "xterm-256color"
335 The terminal shell (string). Sets the $TERM variable.
340 .BR weston-launch (1),
342 .BR xkeyboard-config (7)