compositor-drm: Support configuring the framebuffer format from weston.ini

[profile/ivi/weston-ivi-shell.git] / man / weston.ini.man

diff --git a/man/weston.ini.man b/man/weston.ini.man
index 7699e35..d252419 100644 (file)
--- a/man/weston.ini.man
+++ b/man/weston.ini.man
@@ -24,7 +24,10 @@ server is started:
 .nf
 .BR "$XDG_CONFIG_HOME/weston.ini   " "(if $XDG_CONFIG_HOME is set)"
 .BR "$HOME/.config/weston.ini      " "(if $HOME is set)"
-.BR "<current dir>/weston.ini      " "(if both variables were not set)"
+.B  "weston/weston.ini in each"
+.BR "\ \ \ \ $XDG_CONFIG_DIR           " "(if $XDG_CONFIG_DIRS is set)"
+.BR "/etc/xdg/weston/weston.ini    " "(if $XDG_CONFIG_DIRS is not set)"
+.BR "<current dir>/weston.ini      " "(if no variables were set)"
 .fi
 .RE
 .PP
@@ -32,7 +35,12 @@ where environment variable
 .B $HOME
 is the user's home directory, and
 .B $XDG_CONFIG_HOME
-is the user specific configuration directory.
+is the user specific configuration directory, and
+.B $XDG_CONFIG_DIRS
+is a colon
+.B ':'
+delimited listed of configuration base directories, such as
+.BR /etc/xdg-foo:/etc/xdg .
 .PP
 The
 .I weston.ini
@@ -69,6 +77,7 @@ The section headers are:
 .BR "input-method   " "Onscreen keyboard input"
 .BR "keyboard       " "Keyboard layouts"
 .BR "terminal       " "Terminal application options"
+.BR "xwayland       " "XWayland options"
 .fi
 .RE
 .PP
@@ -95,6 +104,13 @@ directory are:
 .BR xwayland.so
 .fi
 .RE
+.TP 7
+.BI "gbm-format="format
+sets the GBM format used for the framebuffer for the GBM backend. Can be
+.B xrgb8888,
+.B xrgb2101010,
+.B rgb565.
+By default, xrgb8888 is used.
 .RS
 .PP
 
@@ -109,6 +125,15 @@ The entries that can appear in this section are:
 .BI "background-image=" file
 sets the path for the background image file (string).
 .TP 7
+.BI "background-type=" tile
+determines how the background image is drawn (string). Can be
+.BR scale ", " scale-crop " or " tile " (default)."
+Scale means scaled to fit the output precisely, not preserving aspect ratio.
+Scale-crop preserves aspect ratio, scales the background image just big
+enough to cover the output, and centers it. The image ends up cropped from
+left and right, or top and bottom, if the aspect ratio does not match the
+output. Tile repeats the background image to fill the output.
+.TP 7
 .BI "background-color=" 0xAARRGGBB
 sets the color of the background (unsigned integer). The hexadecimal
 digit pairs are in order alpha, red, green, and blue.
@@ -132,8 +157,15 @@ enables screen locking (boolean).
 .BI "animation=" zoom
 sets the effect used for opening new windows (string). Can be
 .B zoom,
-.B fade.
-Otherwise, no animation is used.
+.B fade,
+.B none.
+By default, no animation is used.
+.TP 7
+.BI "startup-animation=" fade
+sets the effect used for opening new windows (string). Can be
+.B fade,
+.B none.
+By default, the fade animation is used.
 .TP 7
 .BI "binding-modifier=" ctrl
 sets the modifier key used for common bindings (string), such as moving
@@ -146,6 +178,12 @@ defines the number of workspaces (unsigned integer). The user can switch
 workspaces by using the
 binding+F1, F2 keys. If this key is not set, fall back to one workspace.
 .TP 7
+.BI "cursor-theme=" theme
+sets the cursor theme (string).
+.TP 7
+.BI "cursor-size=" 24
+sets the cursor size (unsigned integer).
+.TP 7
 .BI "lockscreen-icon=" path
 sets the path to lock screen icon image (string). (tablet shell only)
 .TP 7
@@ -265,6 +303,15 @@ be one of the following 8 strings:
 .BR  "flipped-270   " "Flipped and 90 degrees counter clockwise"
 .fi
 .RE
+.TP 7
+.BI "seat=" name
+The logical seat name that that this output should be associated with. If this
+is set then the seat's input will be confined to the output that has the seat
+set on it. The expectation is that this functionality will be used in a
+multiheaded environment with a single compositor for multiple output and input
+configurations. The default seat is called "default" and will always be
+present. This seat can be constrained like any other.
+.RE
 .SH "INPUT-METHOD SECTION"
 .TP 7
 .BI "path=" "/usr/libexec/weston-keyboard"
@@ -325,6 +372,12 @@ sets the size of the terminal font (unsigned integer).
 The terminal shell (string). Sets the $TERM variable.
 .RE
 .RE
+.SH "XWAYLAND SECTION"
+.TP 7
+.BI "path=" "/usr/bin/Xorg"
+sets the path to the xserver to run (string).
+.RE
+.RE
 .SH "SEE ALSO"
 .BR weston (1),
 .BR weston-launch (1),