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 .BR "<current dir>/weston.ini      " "(if both variables were not set)"
  28 .fi
  29 .RE
  30 .PP
  31 where environment variable
  32 .B $HOME
  33 is the user's home directory, and
  34 .B $XDG_CONFIG_HOME
  35 is the user specific configuration directory.
  36 .PP
  37 The
  38 .I weston.ini
  39 file is composed of a number of sections which may be present in any order, or
  40 omitted to use default configuration values. Each section has the form:
  41 .PP
  42 .RS 4
  43 .nf
  44 .BI [ SectionHeader ]
  45 .RI Key1=Value1
  46 .RI Key2=Value2
  47     ...
  48 .fi
  49 .RE
  50 .PP
  51 The spaces are significant.
  52 Comment lines are ignored:
  53 .PP
  54 .RS 4
  55 .nf
  56 .IR "#comment"
  57 .fi
  58 .RE
  59 .PP
  60 The section headers are:
  61 .PP
  62 .RS 4
  63 .nf
  64 .BR "core           " "The core modules"
  65 .BR "shell          " "Desktop customization"
  66 .BR "launcher       " "Add launcher to the panel"
  67 .BR "screensaver    " "Screensaver selection"
  68 .BR "output         " "Output configuration"
  69 .BR "input-method   " "Onscreen keyboard input"
  70 .BR "keyboard       " "Keyboard layouts"
  71 .BR "terminal       " "Terminal application options"
  72 .fi
  73 .RE
  74 .PP
  75 Possible value types are string, signed and unsigned 32-bit
  76 integer, and boolean. Strings must not be quoted, do not support any
  77 escape sequences, and run till the end of the line. Integers can
  78 be given in decimal (e.g. 123), octal (e.g. 0173), and hexadecimal
  79 (e.g. 0x7b) form. Boolean values can be only 'true' or 'false'.
  80 .RE
  81 .SH "CORE SECTION"
  82 The
  83 .B core
  84 section is used to select the startup compositor modules.
  85 .TP 7
  86 .BI "modules=" desktop-shell.so,xwayland.so
  87 specifies the modules to load (string). Available modules in the
  88 .IR "__weston_modules_dir__"
  89 directory are:
  90 .PP
  91 .RS 10
  92 .nf
  93 .BR desktop-shell.so
  94 .BR tablet-shell.so
  95 .BR xwayland.so
  96 .fi
  97 .RE
  98 .RS
  99 .PP
 100
 101 .SH "SHELL SECTION"
 102 The
 103 .B shell
 104 section is used to customize the compositor. Some keys may not be handled by
 105 different shell plugins.
 106 .PP
 107 The entries that can appear in this section are:
 108 .TP 7
 109 .BI "background-image=" file
 110 sets the path for the background image file (string).
 111 .TP 7
 112 .BI "background-color=" 0xAARRGGBB
 113 sets the color of the background (unsigned integer). The hexadecimal
 114 digit pairs are in order alpha, red, green, and blue.
 115 .TP 7
 116 .BI "panel-color=" 0xAARRGGBB
 117 sets the color of the panel (unsigned integer). The hexadecimal
 118 digit pairs are in order transparency, red, green, and blue. Examples:
 119 .PP
 120 .RS 10
 121 .nf
 122 .BR "0xffff0000    " "Red"
 123 .BR "0xff00ff00    " "Green"
 124 .BR "0xff0000ff    " "Blue"
 125 .BR "0x00ffffff    " "Fully transparent"
 126 .fi
 127 .RE
 128 .TP 7
 129 .BI "locking=" true
 130 enables screen locking (boolean).
 131 .TP 7
 132 .BI "animation=" zoom
 133 sets the effect used for opening new windows (string). Can be
 134 .B zoom,
 135 .B fade.
 136 Otherwise, no animation is used.
 137 .TP 7
 138 .BI "binding-modifier=" ctrl
 139 sets the modifier key used for common bindings (string), such as moving
 140 surfaces, resizing, rotating, switching, closing and setting the transparency
 141 for windows, controlling the backlight and zooming the desktop. Possible values:
 142 ctrl, alt, super (default)
 143 .TP 7
 144 .BI "num-workspaces=" 6
 145 defines the number of workspaces (unsigned integer). The user can switch
 146 workspaces by using the
 147 binding+F1, F2 keys. If this key is not set, fall back to one workspace.
 148 .TP 7
 149 .BI "lockscreen-icon=" path
 150 sets the path to lock screen icon image (string). (tablet shell only)
 151 .TP 7
 152 .BI "lockscreen=" path
 153 sets the path to lock screen background image (string). (tablet shell only)
 154 .TP 7
 155 .BI "homescreen=" path
 156 sets the path to home screen background image (string). (tablet shell only)
 157 .RE
 158 .SH "LAUNCHER SECTION"
 159 There can be multiple launcher sections, one for each launcher.
 160 .TP 7
 161 .BI "icon=" icon
 162 sets the path to icon image (string). Svg images are not currently supported.
 163 .TP 7
 164 .BI "path=" program
 165 sets the path to the program that is run by clicking on this launcher (string).
 166 It is possible to pass arguments and environment variables to the program. For
 167 example:
 168 .nf
 169 .in +4n
 170
 171 path=GDK_BACKEND=wayland gnome-terminal --full-screen
 172 .in
 173 .fi
 174 .PP
 175 .RE
 176 .SH "SCREENSAVER SECTION"
 177 The
 178 .B screensaver
 179 section is used to select and schedule a screensaver.
 180 The
 181 .B screensaver
 182 section is optional, as are all of the entries that may be specified in
 183 it.
 184 .TP 7
 185 .BI "path=" /usr/libexec/weston-screensaver
 186 This instructs the compositor to use the selected screensaver client on a given
 187 path (string). If this line is missing or commented out, the screensaver in
 188 .B "weston(1)"
 189 is disabled.
 190 .RE
 191 .TP 7
 192 .BI "duration=" 600
 193 The idle time in seconds until the screensaver disappears in order to save power
 194 (unsigned integer).
 195 .SH "OUTPUT SECTION"
 196 There can be multiple output sections, each corresponding to one output. It is
 197 currently only recognized by the drm and x11 backends.
 198 .TP 7
 199 .BI "name=" name
 200 sets a name for the output (string). The backend uses the name to
 201 identify the output. All X11 output names start with a letter X. The available
 202 output names for DRM backend are listed in the
 203 .B "weston-launch(1)"
 204 output.
 205 Examples of usage:
 206 .PP
 207 .RS 10
 208 .nf
 209 .BR "LVDS1    " "DRM backend, Laptop internal panel no.1"
 210 .BR "VGA1     " "DRM backend, VGA connector no.1"
 211 .BR "X1       " "X11 backend, X window no.1"
 212 .fi
 213 .RE
 214 .RS
 215 .PP
 216 See
 217 .B "weston-drm(7)"
 218 for more details.
 219 .RE
 220 .TP 7
 221 .BI "mode=" mode
 222 sets the output mode (string). The mode parameter is handled differently
 223 depending on the backend. On the X11 backend, it just sets the WIDTHxHEIGHT of
 224 the weston window.
 225 The DRM backend accepts different modes:
 226 .PP
 227 .RS 10
 228 .nf
 229 .BR "WIDTHxHEIGHT    " "Resolution size width and height in pixels"
 230 .BR "preferred       " "Uses the preferred mode"
 231 .BR "current         " "Uses the current crt controller mode"
 232 .BR "off             " "Disables the output"
 233 .fi
 234 .RE
 235 .RS
 236 .PP
 237 Optionally, an user may specify a modeline, such as:
 238 .PP
 239 .nf
 240 .in +4n
 241 .nf
 242 173.00  1920 2048 2248 2576  1080 1083 1088 1120 -hsync +vsync
 243 .fi
 244 .in
 245 .PP
 246 It consists of the refresh rate in Hz, horizontal and vertical resolution,
 247 options for horizontal and vertical synchronisation. The program
 248 .B "cvt(1)"
 249 can provide suitable modeline string.
 250 .RE
 251 .TP 7
 252 .BI "transform=" normal
 253 The transformation applied to screen output (string). The transform key can
 254 be one of the following 8 strings:
 255 .PP
 256 .RS 10
 257 .nf
 258 .BR  "normal        " "Normal output."
 259 .BR  "90            " "90 degrees clockwise."
 260 .BR  "180           " "Upside down."
 261 .BR  "270           " "90 degrees counter clockwise."
 262 .BR  "flipped       " "Horizontally flipped"
 263 .BR  "flipped-90    " "Flipped and 90 degrees clockwise"
 264 .BR  "flipped-180   " "Flipped upside down"
 265 .BR  "flipped-270   " "Flipped and 90 degrees counter clockwise"
 266 .fi
 267 .RE
 268 .SH "INPUT-METHOD SECTION"
 269 .TP 7
 270 .BI "path=" "/usr/libexec/weston-keyboard"
 271 sets the path of the on screen keyboard input method (string).
 272 .RE
 273 .RE
 274 .SH "KEYBOARD SECTION"
 275 This section contains the following keys:
 276 .TP 7
 277 .BI "keymap_rules=" "evdev"
 278 sets the keymap rules file (string). Used to map layout and model to input
 279 device.
 280 .RE
 281 .RE
 282 .TP 7
 283 .BI "keymap_model=" "pc105"
 284 sets the keymap model (string). See the Models section in
 285 .B "xkeyboard-config(7)."
 286 .RE
 287 .RE
 288 .TP 7
 289 .BI "keymap_layout=" "us,de,gb"
 290 sets the comma separated list of keyboard layout codes (string). See the
 291 Layouts section in
 292 .B "xkeyboard-config(7)."
 293 .RE
 294 .RE
 295 .TP 7
 296 .BI "keymap_variant=" "euro,,intl"
 297 sets the comma separated list of keyboard layout variants (string). The number
 298 of variants must be the same as the number of layouts above. See the Layouts
 299 section in
 300 .B "xkeyboard-config(7)."
 301 .RE
 302 .RE
 303 .TP 7
 304 .BI "keymap_options=" "grp:alt_shift_toggle,grp_led:scroll"
 305 sets the keymap options (string). See the Options section in
 306 .B "xkeyboard-config(7)."
 307 .RE
 308 .RE
 309 .SH "TERMINAL SECTION"
 310 Contains settings for the weston terminal application (weston-terminal). It
 311 allows to customize the font and shell of the command line interface.
 312 .TP 7
 313 .BI "font=" "DejaVu Sans Mono"
 314 sets the font of the terminal (string). For a good experience it is recommend
 315 to use monospace fonts. In case the font is not found, the default one is used.
 316 .RE
 317 .RE
 318 .TP 7
 319 .BI "font-size=" "14"
 320 sets the size of the terminal font (unsigned integer).
 321 .RE
 322 .RE
 323 .TP 7
 324 .BI "term=" "xterm-256color"
 325 The terminal shell (string). Sets the $TERM variable.
 326 .RE
 327 .RE
 328 .SH "SEE ALSO"
 329 .BR weston (1),
 330 .BR weston-launch (1),
 331 .BR weston-drm (7),
 332 .BR xkeyboard-config (7)