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 .BR "xwayland       " "XWayland options"
  81 .fi
  82 .RE
  83 .PP
  84 Possible value types are string, signed and unsigned 32-bit
  85 integer, and boolean. Strings must not be quoted, do not support any
  86 escape sequences, and run till the end of the line. Integers can
  87 be given in decimal (e.g. 123), octal (e.g. 0173), and hexadecimal
  88 (e.g. 0x7b) form. Boolean values can be only 'true' or 'false'.
  89 .RE
  90 .SH "CORE SECTION"
  91 The
  92 .B core
  93 section is used to select the startup compositor modules.
  94 .TP 7
  95 .BI "shell=" desktop-shell.so
  96 specifies a shell to load (string). This can be used to load your own
  97 implemented shell or one with Weston as default. Available shells
  98 in the
  99 .IR "__weston_modules_dir__"
 100 directory are:
 101 .PP
 102 .RS 10
 103 .nf
 104 .BR desktop-shell.so
 105 .fi
 106 .RE
 107 .TP 7
 108 .TP 7
 109 .BI "modules=" xwayland.so,cms-colord.so
 110 specifies the modules to load (string). Available modules in the
 111 .IR "__weston_modules_dir__"
 112 directory are:
 113 .PP
 114 .RS 10
 115 .nf
 116 .BR xwayland.so
 117 .BR cms-colord.so
 118 .fi
 119 .RE
 120 .TP 7
 121 .TP 7
 122 .BI "backend=" headless-backend.so
 123 overrides defaults backend. Available backend modules in the
 124 .IR "__weston_modules_dir__"
 125 directory are:
 126 .PP
 127 .RS 10
 128 .nf
 129 .BR drm-backend.so
 130 .BR fbdev-backend.so
 131 .BR headless-backend.so
 132 .BR rdp-backend.so
 133 .BR rpi-backend.so
 134 .BR wayland-backend.so
 135 .BR x11-backend.so
 136 .fi
 137 .RE
 138 .BI "gbm-format="format
 139 sets the GBM format used for the framebuffer for the GBM backend. Can be
 140 .B xrgb8888,
 141 .B xrgb2101010,
 142 .B rgb565.
 143 By default, xrgb8888 is used.
 144 .RS
 145 .PP
 146
 147 .SH "SHELL SECTION"
 148 The
 149 .B shell
 150 section is used to customize the compositor. Some keys may not be handled by
 151 different shell plugins.
 152 .PP
 153 The entries that can appear in this section are:
 154 .TP 7
 155 .BI "client=" file
 156 sets the path for the shell client to run. If not specified
 157 .I __weston_shell_client__
 158 is launched (string).
 159 .TP 7
 160 .BI "background-image=" file
 161 sets the path for the background image file (string).
 162 .TP 7
 163 .BI "background-type=" tile
 164 determines how the background image is drawn (string). Can be
 165 .BR scale ", " scale-crop " or " tile " (default)."
 166 Scale means scaled to fit the output precisely, not preserving aspect ratio.
 167 Scale-crop preserves aspect ratio, scales the background image just big
 168 enough to cover the output, and centers it. The image ends up cropped from
 169 left and right, or top and bottom, if the aspect ratio does not match the
 170 output. Tile repeats the background image to fill the output.
 171 .TP 7
 172 .BI "background-color=" 0xAARRGGBB
 173 sets the color of the background (unsigned integer). The hexadecimal
 174 digit pairs are in order alpha, red, green, and blue.
 175 .TP 7
 176 .BI "panel-color=" 0xAARRGGBB
 177 sets the color of the panel (unsigned integer). The hexadecimal
 178 digit pairs are in order transparency, red, green, and blue. Examples:
 179 .PP
 180 .RS 10
 181 .nf
 182 .BR "0xffff0000    " "Red"
 183 .BR "0xff00ff00    " "Green"
 184 .BR "0xff0000ff    " "Blue"
 185 .BR "0x00ffffff    " "Fully transparent"
 186 .fi
 187 .RE
 188 .TP 7
 189 .BI "panel-location=" top
 190 sets the location of the panel (string). Can be
 191 .B top,
 192 .B none.
 193 .TP 7
 194 .BI "locking=" true
 195 enables screen locking (boolean).
 196 .TP 7
 197 .BI "animation=" zoom
 198 sets the effect used for opening new windows (string). Can be
 199 .B zoom,
 200 .B fade,
 201 .B none.
 202 By default, no animation is used.
 203 .TP 7
 204 .BI "startup-animation=" fade
 205 sets the effect used for opening new windows (string). Can be
 206 .B fade,
 207 .B none.
 208 By default, the fade animation is used.
 209 .TP 7
 210 .BI "focus-animation=" dim-layer
 211 sets the effect used with the focused and unfocused windows. Can be
 212 .B dim-layer,
 213 .B none.
 214 By default, no animation is used.
 215 .TP 7
 216 .BI "binding-modifier=" ctrl
 217 sets the modifier key used for common bindings (string), such as moving
 218 surfaces, resizing, rotating, switching, closing and setting the transparency
 219 for windows, controlling the backlight and zooming the desktop. Possible values:
 220 ctrl, alt, super (default)
 221 .TP 7
 222 .BI "num-workspaces=" 6
 223 defines the number of workspaces (unsigned integer). The user can switch
 224 workspaces by using the
 225 binding+F1, F2 keys. If this key is not set, fall back to one workspace.
 226 .TP 7
 227 .BI "cursor-theme=" theme
 228 sets the cursor theme (string).
 229 .TP 7
 230 .BI "cursor-size=" 24
 231 sets the cursor size (unsigned integer).
 232 .TP 7
 233 .BI "lockscreen-icon=" path
 234 sets the path to lock screen icon image (string). (tablet shell only)
 235 .TP 7
 236 .BI "lockscreen=" path
 237 sets the path to lock screen background image (string). (tablet shell only)
 238 .TP 7
 239 .BI "homescreen=" path
 240 sets the path to home screen background image (string). (tablet shell only)
 241 .RE
 242 .SH "LAUNCHER SECTION"
 243 There can be multiple launcher sections, one for each launcher.
 244 .TP 7
 245 .BI "icon=" icon
 246 sets the path to icon image (string). Svg images are not currently supported.
 247 .TP 7
 248 .BI "path=" program
 249 sets the path to the program that is run by clicking on this launcher (string).
 250 It is possible to pass arguments and environment variables to the program. For
 251 example:
 252 .nf
 253 .in +4n
 254
 255 path=GDK_BACKEND=wayland gnome-terminal --full-screen
 256 .in
 257 .fi
 258 .PP
 259 .RE
 260 .SH "SCREENSAVER SECTION"
 261 The
 262 .B screensaver
 263 section is used to select and schedule a screensaver.
 264 The
 265 .B screensaver
 266 section is optional, as are all of the entries that may be specified in
 267 it.
 268 .TP 7
 269 .BI "path=" /usr/libexec/weston-screensaver
 270 This instructs the compositor to use the selected screensaver client on a given
 271 path (string). If this line is missing or commented out, the screensaver in
 272 .B "weston(1)"
 273 is disabled.
 274 .RE
 275 .TP 7
 276 .BI "duration=" 600
 277 The idle time in seconds until the screensaver disappears in order to save power
 278 (unsigned integer).
 279 .SH "OUTPUT SECTION"
 280 There can be multiple output sections, each corresponding to one output. It is
 281 currently only recognized by the drm and x11 backends.
 282 .TP 7
 283 .BI "name=" name
 284 sets a name for the output (string). The backend uses the name to
 285 identify the output. All X11 output names start with a letter X.  All
 286 Wayland output names start with the letters WL.  The available
 287 output names for DRM backend are listed in the
 288 .B "weston-launch(1)"
 289 output.
 290 Examples of usage:
 291 .PP
 292 .RS 10
 293 .nf
 294 .BR "LVDS1    " "DRM backend, Laptop internal panel no.1"
 295 .BR "VGA1     " "DRM backend, VGA connector no.1"
 296 .BR "X1       " "X11 backend, X window no.1"
 297 .BR "WL1      " "Wayland backend, Wayland window no.1"
 298 .fi
 299 .RE
 300 .RS
 301 .PP
 302 See
 303 .B "weston-drm(7)"
 304 for more details.
 305 .RE
 306 .TP 7
 307 .BI "mode=" mode
 308 sets the output mode (string). The mode parameter is handled differently
 309 depending on the backend. On the X11 backend, it just sets the WIDTHxHEIGHT of
 310 the weston window.
 311 The DRM backend accepts different modes:
 312 .PP
 313 .RS 10
 314 .nf
 315 .BR "WIDTHxHEIGHT    " "Resolution size width and height in pixels"
 316 .BR "preferred       " "Uses the preferred mode"
 317 .BR "current         " "Uses the current crt controller mode"
 318 .BR "off             " "Disables the output"
 319 .fi
 320 .RE
 321 .RS
 322 .PP
 323 Optionally, an user may specify a modeline, such as:
 324 .PP
 325 .nf
 326 .in +4n
 327 .nf
 328 173.00  1920 2048 2248 2576  1080 1083 1088 1120 -hsync +vsync
 329 .fi
 330 .in
 331 .PP
 332 It consists of the refresh rate in Hz, horizontal and vertical resolution,
 333 options for horizontal and vertical synchronisation. The program
 334 .B "cvt(1)"
 335 can provide suitable modeline string.
 336 .RE
 337 .TP 7
 338 .BI "transform=" normal
 339 The transformation applied to screen output (string). The transform key can
 340 be one of the following 8 strings:
 341 .PP
 342 .RS 10
 343 .nf
 344 .BR  "normal        " "Normal output."
 345 .BR  "90            " "90 degrees clockwise."
 346 .BR  "180           " "Upside down."
 347 .BR  "270           " "90 degrees counter clockwise."
 348 .BR  "flipped       " "Horizontally flipped"
 349 .BR  "flipped-90    " "Flipped and 90 degrees clockwise"
 350 .BR  "flipped-180   " "Flipped upside down"
 351 .BR  "flipped-270   " "Flipped and 90 degrees counter clockwise"
 352 .fi
 353 .RE
 354 .TP 7
 355 .BI "seat=" name
 356 The logical seat name that that this output should be associated with. If this
 357 is set then the seat's input will be confined to the output that has the seat
 358 set on it. The expectation is that this functionality will be used in a
 359 multiheaded environment with a single compositor for multiple output and input
 360 configurations. The default seat is called "default" and will always be
 361 present. This seat can be constrained like any other.
 362 .RE
 363 .SH "INPUT-METHOD SECTION"
 364 .TP 7
 365 .BI "path=" "/usr/libexec/weston-keyboard"
 366 sets the path of the on screen keyboard input method (string).
 367 .RE
 368 .RE
 369 .SH "KEYBOARD SECTION"
 370 This section contains the following keys:
 371 .TP 7
 372 .BI "keymap_rules=" "evdev"
 373 sets the keymap rules file (string). Used to map layout and model to input
 374 device.
 375 .RE
 376 .RE
 377 .TP 7
 378 .BI "keymap_model=" "pc105"
 379 sets the keymap model (string). See the Models section in
 380 .B "xkeyboard-config(7)."
 381 .RE
 382 .RE
 383 .TP 7
 384 .BI "keymap_layout=" "us,de,gb"
 385 sets the comma separated list of keyboard layout codes (string). See the
 386 Layouts section in
 387 .B "xkeyboard-config(7)."
 388 .RE
 389 .RE
 390 .TP 7
 391 .BI "keymap_variant=" "euro,,intl"
 392 sets the comma separated list of keyboard layout variants (string). The number
 393 of variants must be the same as the number of layouts above. See the Layouts
 394 section in
 395 .B "xkeyboard-config(7)."
 396 .RE
 397 .RE
 398 .TP 7
 399 .BI "keymap_options=" "grp:alt_shift_toggle,grp_led:scroll"
 400 sets the keymap options (string). See the Options section in
 401 .B "xkeyboard-config(7)."
 402 .RE
 403 .RE
 404 .TP 7
 405 .BI "repeat-rate=" "40"
 406 sets the rate of repeating keys in characters per second (unsigned integer)
 407 .RE
 408 .RE
 409 .TP 7
 410 .BI "repeat-delay=" "400"
 411 sets the delay in milliseconds since key down until repeating starts (unsigned
 412 integer)
 413 .RE
 414 .RE
 415 .SH "TERMINAL SECTION"
 416 Contains settings for the weston terminal application (weston-terminal). It
 417 allows to customize the font and shell of the command line interface.
 418 .TP 7
 419 .BI "font=" "DejaVu Sans Mono"
 420 sets the font of the terminal (string). For a good experience it is recommended
 421 to use monospace fonts. In case the font is not found, the default one is used.
 422 .RE
 423 .RE
 424 .TP 7
 425 .BI "font-size=" "14"
 426 sets the size of the terminal font (unsigned integer).
 427 .RE
 428 .RE
 429 .TP 7
 430 .BI "term=" "xterm-256color"
 431 The terminal shell (string). Sets the $TERM variable.
 432 .RE
 433 .RE
 434 .SH "XWAYLAND SECTION"
 435 .TP 7
 436 .BI "path=" "/usr/bin/Xorg"
 437 sets the path to the xserver to run (string).
 438 .RE
 439 .RE
 440 .SH "SEE ALSO"
 441 .BR weston (1),
 442 .BR weston-launch (1),
 443 .BR weston-drm (7),
 444 .BR xkeyboard-config (7)