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