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