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