man/weston.ini.man

   1 .\" shorthand for double quote that works everywhere.
   2 .ds q \N'34'
   3 .TH weston.ini 5 "2013-01-17" "Weston __version__"
   4 .SH NAME
   5 weston.ini \- configuration file for
   6 .B Weston
   7 \- the reference Wayland
   8 compositor
   9 .SH INTRODUCTION
  10 .B Weston
  11 obtains configuration from its command line parameters and the configuration
  12 file described here.
  13 .SH DESCRIPTION
  14 .B Weston
  15 uses a configuration file called
  16 .I weston.ini
  17 for its setup.
  18 The
  19 .I weston.ini
  20 configuration file is searched for in one of the following places when the
  21 server is started:
  22 .PP
  23 .RS 4
  24 .nf
  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)"
  31 .fi
  32 .RE
  33 .PP
  34 where environment variable
  35 .B $HOME
  36 is the user's home directory, and
  37 .B $XDG_CONFIG_HOME
  38 is the user specific configuration directory, and
  39 .B $XDG_CONFIG_DIRS
  40 is a colon
  41 .B ':'
  42 delimited listed of configuration base directories, such as
  43 .BR /etc/xdg-foo:/etc/xdg .
  44 .PP
  45 The
  46 .I weston.ini
  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:
  49 .PP
  50 .RS 4
  51 .nf
  52 .BI [ SectionHeader ]
  53 .RI Key1=Value1
  54 .RI Key2=Value2
  55     ...
  56 .fi
  57 .RE
  58 .PP
  59 The spaces are significant.
  60 Comment lines are ignored:
  61 .PP
  62 .RS 4
  63 .nf
  64 .IR "#comment"
  65 .fi
  66 .RE
  67 .PP
  68 The section headers are:
  69 .PP
  70 .RS 4
  71 .nf
  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"
  80 .fi
  81 .RE
  82 .PP
  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'.
  88 .RE
  89 .SH "CORE SECTION"
  90 The
  91 .B core
  92 section is used to select the startup compositor modules.
  93 .TP 7
  94 .BI "modules=" desktop-shell.so,xwayland.so
  95 specifies the modules to load (string). Available modules in the
  96 .IR "__weston_modules_dir__"
  97 directory are:
  98 .PP
  99 .RS 10
 100 .nf
 101 .BR desktop-shell.so
 102 .BR tablet-shell.so
 103 .BR xwayland.so
 104 .fi
 105 .RE
 106 .RS
 107 .PP
 108
 109 .SH "SHELL SECTION"
 110 The
 111 .B shell
 112 section is used to customize the compositor. Some keys may not be handled by
 113 different shell plugins.
 114 .PP
 115 The entries that can appear in this section are:
 116 .TP 7
 117 .BI "background-image=" file
 118 sets the path for the background image file (string).
 119 .TP 7
 120 .BI "background-type=" tile
 121 determines how the background image is drawn (string). Can be scale or
 122 tile (default).
 123 .TP 7
 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.
 127 .TP 7
 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:
 131 .PP
 132 .RS 10
 133 .nf
 134 .BR "0xffff0000    " "Red"
 135 .BR "0xff00ff00    " "Green"
 136 .BR "0xff0000ff    " "Blue"
 137 .BR "0x00ffffff    " "Fully transparent"
 138 .fi
 139 .RE
 140 .TP 7
 141 .BI "locking=" true
 142 enables screen locking (boolean).
 143 .TP 7
 144 .BI "animation=" zoom
 145 sets the effect used for opening new windows (string). Can be
 146 .B zoom,
 147 .B fade.
 148 Otherwise, no animation is used.
 149 .TP 7
 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)
 155 .TP 7
 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.
 160 .TP 7
 161 .BI "cursor-theme=" theme
 162 sets the cursor theme (string).
 163 .TP 7
 164 .BI "cursor-size=" 24
 165 sets the cursor size (unsigned integer).
 166 .TP 7
 167 .BI "lockscreen-icon=" path
 168 sets the path to lock screen icon image (string). (tablet shell only)
 169 .TP 7
 170 .BI "lockscreen=" path
 171 sets the path to lock screen background image (string). (tablet shell only)
 172 .TP 7
 173 .BI "homescreen=" path
 174 sets the path to home screen background image (string). (tablet shell only)
 175 .RE
 176 .SH "LAUNCHER SECTION"
 177 There can be multiple launcher sections, one for each launcher.
 178 .TP 7
 179 .BI "icon=" icon
 180 sets the path to icon image (string). Svg images are not currently supported.
 181 .TP 7
 182 .BI "path=" program
 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
 185 example:
 186 .nf
 187 .in +4n
 188
 189 path=GDK_BACKEND=wayland gnome-terminal --full-screen
 190 .in
 191 .fi
 192 .PP
 193 .RE
 194 .SH "SCREENSAVER SECTION"
 195 The
 196 .B screensaver
 197 section is used to select and schedule a screensaver.
 198 The
 199 .B screensaver
 200 section is optional, as are all of the entries that may be specified in
 201 it.
 202 .TP 7
 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
 206 .B "weston(1)"
 207 is disabled.
 208 .RE
 209 .TP 7
 210 .BI "duration=" 600
 211 The idle time in seconds until the screensaver disappears in order to save power
 212 (unsigned integer).
 213 .SH "OUTPUT SECTION"
 214 There can be multiple output sections, each corresponding to one output. It is
 215 currently only recognized by the drm and x11 backends.
 216 .TP 7
 217 .BI "name=" name
 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)"
 222 output.
 223 Examples of usage:
 224 .PP
 225 .RS 10
 226 .nf
 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"
 230 .fi
 231 .RE
 232 .RS
 233 .PP
 234 See
 235 .B "weston-drm(7)"
 236 for more details.
 237 .RE
 238 .TP 7
 239 .BI "mode=" mode
 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
 242 the weston window.
 243 The DRM backend accepts different modes:
 244 .PP
 245 .RS 10
 246 .nf
 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"
 251 .fi
 252 .RE
 253 .RS
 254 .PP
 255 Optionally, an user may specify a modeline, such as:
 256 .PP
 257 .nf
 258 .in +4n
 259 .nf
 260 173.00  1920 2048 2248 2576  1080 1083 1088 1120 -hsync +vsync
 261 .fi
 262 .in
 263 .PP
 264 It consists of the refresh rate in Hz, horizontal and vertical resolution,
 265 options for horizontal and vertical synchronisation. The program
 266 .B "cvt(1)"
 267 can provide suitable modeline string.
 268 .RE
 269 .TP 7
 270 .BI "transform=" normal
 271 The transformation applied to screen output (string). The transform key can
 272 be one of the following 8 strings:
 273 .PP
 274 .RS 10
 275 .nf
 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"
 284 .fi
 285 .RE
 286 .SH "INPUT-METHOD SECTION"
 287 .TP 7
 288 .BI "path=" "/usr/libexec/weston-keyboard"
 289 sets the path of the on screen keyboard input method (string).
 290 .RE
 291 .RE
 292 .SH "KEYBOARD SECTION"
 293 This section contains the following keys:
 294 .TP 7
 295 .BI "keymap_rules=" "evdev"
 296 sets the keymap rules file (string). Used to map layout and model to input
 297 device.
 298 .RE
 299 .RE
 300 .TP 7
 301 .BI "keymap_model=" "pc105"
 302 sets the keymap model (string). See the Models section in
 303 .B "xkeyboard-config(7)."
 304 .RE
 305 .RE
 306 .TP 7
 307 .BI "keymap_layout=" "us,de,gb"
 308 sets the comma separated list of keyboard layout codes (string). See the
 309 Layouts section in
 310 .B "xkeyboard-config(7)."
 311 .RE
 312 .RE
 313 .TP 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
 317 section in
 318 .B "xkeyboard-config(7)."
 319 .RE
 320 .RE
 321 .TP 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)."
 325 .RE
 326 .RE
 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.
 330 .TP 7
 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.
 334 .RE
 335 .RE
 336 .TP 7
 337 .BI "font-size=" "14"
 338 sets the size of the terminal font (unsigned integer).
 339 .RE
 340 .RE
 341 .TP 7
 342 .BI "term=" "xterm-256color"
 343 The terminal shell (string). Sets the $TERM variable.
 344 .RE
 345 .RE
 346 .SH "SEE ALSO"
 347 .BR weston (1),
 348 .BR weston-launch (1),
 349 .BR weston-drm (7),
 350 .BR xkeyboard-config (7)