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 .B "weston/weston.ini in each"
28 .BR "\ \ \ \ $XDG_CONFIG_DIR " "(if $XDG_CONFIG_DIRS is set)"
29 .BR "/etc/xdg/weston/weston.ini " "(if $XDG_CONFIG_DIRS is not set)"
30 .BR "<current dir>/weston.ini " "(if no variables were set)"
34 where environment variable
36 is the user's home directory, and
38 is the user specific configuration directory, and
42 delimited listed of configuration base directories, such as
43 .BR /etc/xdg-foo:/etc/xdg .
47 file is composed of a number of sections which may be present in any order, or
48 omitted to use default configuration values. Each section has the form:
59 The spaces are significant.
60 Comment lines are ignored:
68 The section headers are:
72 .BR "core " "The core modules"
73 .BR "shell " "Desktop customization"
74 .BR "launcher " "Add launcher to the panel"
75 .BR "screensaver " "Screensaver selection"
76 .BR "output " "Output configuration"
77 .BR "input-method " "Onscreen keyboard input"
78 .BR "keyboard " "Keyboard layouts"
79 .BR "terminal " "Terminal application options"
83 Possible value types are string, signed and unsigned 32-bit
84 integer, and boolean. Strings must not be quoted, do not support any
85 escape sequences, and run till the end of the line. Integers can
86 be given in decimal (e.g. 123), octal (e.g. 0173), and hexadecimal
87 (e.g. 0x7b) form. Boolean values can be only 'true' or 'false'.
92 section is used to select the startup compositor modules.
94 .BI "modules=" desktop-shell.so,xwayland.so
95 specifies the modules to load (string). Available modules in the
96 .IR "__weston_modules_dir__"
112 section is used to customize the compositor. Some keys may not be handled by
113 different shell plugins.
115 The entries that can appear in this section are:
117 .BI "background-image=" file
118 sets the path for the background image file (string).
120 .BI "background-type=" tile
121 determines how the background image is drawn (string). Can be scale or
124 .BI "background-color=" 0xAARRGGBB
125 sets the color of the background (unsigned integer). The hexadecimal
126 digit pairs are in order alpha, red, green, and blue.
128 .BI "panel-color=" 0xAARRGGBB
129 sets the color of the panel (unsigned integer). The hexadecimal
130 digit pairs are in order transparency, red, green, and blue. Examples:
134 .BR "0xffff0000 " "Red"
135 .BR "0xff00ff00 " "Green"
136 .BR "0xff0000ff " "Blue"
137 .BR "0x00ffffff " "Fully transparent"
142 enables screen locking (boolean).
144 .BI "animation=" zoom
145 sets the effect used for opening new windows (string). Can be
148 Otherwise, no animation is used.
150 .BI "binding-modifier=" ctrl
151 sets the modifier key used for common bindings (string), such as moving
152 surfaces, resizing, rotating, switching, closing and setting the transparency
153 for windows, controlling the backlight and zooming the desktop. Possible values:
154 ctrl, alt, super (default)
156 .BI "num-workspaces=" 6
157 defines the number of workspaces (unsigned integer). The user can switch
158 workspaces by using the
159 binding+F1, F2 keys. If this key is not set, fall back to one workspace.
161 .BI "cursor-theme=" theme
162 sets the cursor theme (string).
164 .BI "cursor-size=" 24
165 sets the cursor size (unsigned integer).
167 .BI "lockscreen-icon=" path
168 sets the path to lock screen icon image (string). (tablet shell only)
170 .BI "lockscreen=" path
171 sets the path to lock screen background image (string). (tablet shell only)
173 .BI "homescreen=" path
174 sets the path to home screen background image (string). (tablet shell only)
176 .SH "LAUNCHER SECTION"
177 There can be multiple launcher sections, one for each launcher.
180 sets the path to icon image (string). Svg images are not currently supported.
183 sets the path to the program that is run by clicking on this launcher (string).
184 It is possible to pass arguments and environment variables to the program. For
189 path=GDK_BACKEND=wayland gnome-terminal --full-screen
194 .SH "SCREENSAVER SECTION"
197 section is used to select and schedule a screensaver.
200 section is optional, as are all of the entries that may be specified in
203 .BI "path=" /usr/libexec/weston-screensaver
204 This instructs the compositor to use the selected screensaver client on a given
205 path (string). If this line is missing or commented out, the screensaver in
211 The idle time in seconds until the screensaver disappears in order to save power
214 There can be multiple output sections, each corresponding to one output. It is
215 currently only recognized by the drm and x11 backends.
218 sets a name for the output (string). The backend uses the name to
219 identify the output. All X11 output names start with a letter X. The available
220 output names for DRM backend are listed in the
221 .B "weston-launch(1)"
227 .BR "LVDS1 " "DRM backend, Laptop internal panel no.1"
228 .BR "VGA1 " "DRM backend, VGA connector no.1"
229 .BR "X1 " "X11 backend, X window no.1"
240 sets the output mode (string). The mode parameter is handled differently
241 depending on the backend. On the X11 backend, it just sets the WIDTHxHEIGHT of
243 The DRM backend accepts different modes:
247 .BR "WIDTHxHEIGHT " "Resolution size width and height in pixels"
248 .BR "preferred " "Uses the preferred mode"
249 .BR "current " "Uses the current crt controller mode"
250 .BR "off " "Disables the output"
255 Optionally, an user may specify a modeline, such as:
260 173.00 1920 2048 2248 2576 1080 1083 1088 1120 -hsync +vsync
264 It consists of the refresh rate in Hz, horizontal and vertical resolution,
265 options for horizontal and vertical synchronisation. The program
267 can provide suitable modeline string.
270 .BI "transform=" normal
271 The transformation applied to screen output (string). The transform key can
272 be one of the following 8 strings:
276 .BR "normal " "Normal output."
277 .BR "90 " "90 degrees clockwise."
278 .BR "180 " "Upside down."
279 .BR "270 " "90 degrees counter clockwise."
280 .BR "flipped " "Horizontally flipped"
281 .BR "flipped-90 " "Flipped and 90 degrees clockwise"
282 .BR "flipped-180 " "Flipped upside down"
283 .BR "flipped-270 " "Flipped and 90 degrees counter clockwise"
286 .SH "INPUT-METHOD SECTION"
288 .BI "path=" "/usr/libexec/weston-keyboard"
289 sets the path of the on screen keyboard input method (string).
292 .SH "KEYBOARD SECTION"
293 This section contains the following keys:
295 .BI "keymap_rules=" "evdev"
296 sets the keymap rules file (string). Used to map layout and model to input
301 .BI "keymap_model=" "pc105"
302 sets the keymap model (string). See the Models section in
303 .B "xkeyboard-config(7)."
307 .BI "keymap_layout=" "us,de,gb"
308 sets the comma separated list of keyboard layout codes (string). See the
310 .B "xkeyboard-config(7)."
314 .BI "keymap_variant=" "euro,,intl"
315 sets the comma separated list of keyboard layout variants (string). The number
316 of variants must be the same as the number of layouts above. See the Layouts
318 .B "xkeyboard-config(7)."
322 .BI "keymap_options=" "grp:alt_shift_toggle,grp_led:scroll"
323 sets the keymap options (string). See the Options section in
324 .B "xkeyboard-config(7)."
327 .SH "TERMINAL SECTION"
328 Contains settings for the weston terminal application (weston-terminal). It
329 allows to customize the font and shell of the command line interface.
331 .BI "font=" "DejaVu Sans Mono"
332 sets the font of the terminal (string). For a good experience it is recommend
333 to use monospace fonts. In case the font is not found, the default one is used.
337 .BI "font-size=" "14"
338 sets the size of the terminal font (unsigned integer).
342 .BI "term=" "xterm-256color"
343 The terminal shell (string). Sets the $TERM variable.
348 .BR weston-launch (1),
350 .BR xkeyboard-config (7)