Thank to pq for the feedback, here is the second version of weston.ini man page I am not sure how to change configure sed scripts to autofill values. Another unclear thing is whether the [shell] type=desktop-shell.so options actually works, since the shell plugin seems to be hardcoded in src/compositor.c:3059 main().
Thanks. --- man/weston.ini.5 | 268 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 268 insertions(+) create mode 100644 man/weston.ini.5 diff --git a/man/weston.ini.5 b/man/weston.ini.5 new file mode 100644 index 0000000..2f98612 --- /dev/null +++ b/man/weston.ini.5 @@ -0,0 +1,268 @@ +.\" shorthand for double quote that works everywhere. +.ds q \N'34' +.TH weston.ini 5 "weston 0.95.0" "Wayland " +.SH NAME +weston.ini \- configuration file for +.B Weston +\- the reference Wayland +compositor +.SH INTRODUCTION +.B Weston +obtains configuration from its command line parameters and the configuration +file described here. +.SH DESCRIPTION +.B Weston +uses a configuration file called +.I weston.ini +for its setup. +The +.I weston.ini +configuration file is searched for in one of the following places when the +server is started: +.PP +.RS 4 +.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)" +.fi +.RE +.PP +where enviroment variable +.B $HOME +is the user's home directory, and +.B $XDG_CONFIG_HOME +is the user specific configuration directory. +.PP +The +.I weston.ini +file is composed of a number of sections which may be present in any order, or +omitted to use default configuration values. Each section has the form: +.PP +.RS 4 +.nf +.BI [ SectionHeader ] +.RI Option1=Value1 +.RI Option2=Value2 + ... +.fi +.RE +.PP +Comment lines are ignored: +.PP +.RS 4 +.nf +.IR "#comment" +.fi +.RE +.PP +The section headers are: +.PP +.RS 4 +.nf +.BR "shell " "Desktop customisation" +.BR "launcher " "Add launcher to the panel" +.BR "screensaver " "Screensaver selection" +.BR "output " "Monitors setup" +.BR "keyboard " "Keyboard layouts" +.BR "terminal " "Terminal application options" +.fi +.RE +.PP +Values are: string, integer (signed or unsigned) and boolean. +.SH "SHELL SECTION" +The +.B shell +section is used to customise the compositor. +.PP +The entries that can appear in this section are: +.TP 7 +.BI "type=" desktop-shell.so +sets the file name of the desired shell plugin. The shell user inteface plugin +provides the basic user enviroment displayed when the compositor starts. +Available shells in the +.IR /lib/weston/ +directory are: +.PP +.RS 11 +.nf +.IR desktop-shell.so +.fi +.IR tablet-shell.so +.TP 7 +.RE +.TP 7 +.BI "background-image=" file +sets the path for the background image file. +.TP 7 +.BI "background-color=" 0xAARRGGBB +sets the color of the background. The hexadecimal +digit pairs are in order alpha, red, green, and blue. +.TP 7 +.BI "panel-color=" 0xAARRGGBB +sets the color of the panel. The hexadecimal +digit pairs are in order opacity, red, green, and blue. Examples: +.PP +.RS 10 +.nf +.BR "0xffff0000 " "Red" +.BR "0xff00ff00 " "Green" +.BR "0xff0000ff " "Blue" +.BR "0x00ffffff " "Fully opaque" +.fi +.RE +.TP 7 +.BI "locking=" true +enables screen locking. +.TP 7 +.BI "animation=" zoom +sets the effect used for switching workspaces. Can be either zoom or fade +.TP 7 +.BI "binding-modifier=" ctrl +sets the compositor binding modifier hot key. This key is used for moving, +resizing, rotating, switching, closing and setting the opacity for windows, +controlling the backlight and zooming the desktop. Users running under Unity +desktop may want to use something else than the default. Possible values: +ctrl, alt, super (default) +.TP 7 +.BI "num-workspaces=" 6 +defines the number of workspaces. The user can switch workspaces by using the +binding+F1, F2 keys. If this option is not set, fall back to one workspace. +.TP 7 +.BI "lockscreen-icon=" path +sets the path to lock screen icon image. (tablet shell only) +.TP 7 +.BI "lockscreen=" path +sets the path to lock screen background image. (tablet shell only) +.TP 7 +.BI "homescreen=" path +sets the path to home screen background image. (tablet shell only) +.RE +.SH "LAUNCHER SECTION" +.TP 7 +.BI "icon=" icon +sets the path to icon image. Svg images are not supported. +.TP 7 +.BI "path=" program +sets the path to the program that is run by clicking on this launcher. +.SH "SCREENSAVER SECTION" +The +.B screensaver +section is used to select and schedule a screensaver. +The +.B screensaver +section is optional, as are all of the entries that may be specified in +it. +.TP 7 +.BI "path=" /usr/libexec/weston-screensaver +This instructs the compositor to use the selected screensaver client on a given +path. If this line is missing or commented out, the screensaver in +.B weston +is disabled. +.RE +.TP 7 +.BI "duration=" 600 +The idle time in seconds until the screensaver disappears in order to save power. +.SH "OUTPUT SECTION" +There can be multiple output sections, one for each computer screen. +.TP 7 +.BI "name=" name +sets a name for the screen. A backend recognizes these names and uses the whole +screen section for its screen. Examples of usage: +.PP +.RS 10 +.nf +.BR "LVDS1 " "LVDS mode, DRM backend" +.BR "VGA1 " "VGA mode, DRM backend" +.BR "X1 " "X11 backend (running weston on X server)" +.fi +.RE +.TP 7 +.BI "mode=" "173.00 1920 2048 2248 2576 1080 1083 1088 1120 -hsync +vsync" +sets the resolution and the configuration of the monitor. Consists of the +refresh rate in Hz, horizontal and vertical resolution, options to for +horizontal and vertical synchronisation. The program +.B cvt +can provide suitable modeline string. Alternative formats: +.PP +.RS 10 +.nf +.BR "WIDTHxHEIGHT " "Resolution size width and height in pixels" +.BR "preferred " "Uses the preferred mode" +.BR "current " "Uses the current crt controller mode" +.BR "off " "Disables the output" +.fi +.RE +.TP 7 +.BI "transform=" normal +The transformation applied to screen output. The transform key can be one of +the following 8 strings: +.PP +.RS 10 +.nf +.BR "normal " "Normal output." +.BR "90 " "90 degrees clockwise." +.BR "180 " "Upside down." +.BR "270 " "90 degrees counter clockwise." +.BR "flipped " "Horizontally flipped" +.BR "flipped-90 " "Flipped and 90 degrees clockwise" +.BR "flipped-180 " "Flipped upside down" +.BR "flipped-270 " "Flipped and 90 degrees counter clockwise" +.fi +.RE +.SH "KEYBOARD SECTION" +This section contains the following options: +.TP 7 +.BI "keymap_rules=" "base" +sets the keymap rules file. Used to map layout and model to input device. +.RE +.RE +.TP 7 +.BI "keymap_model=" "pc105" +sets the keymap model. See the Models section in +.B "xkeyboard-config(7)." +.RE +.RE +.TP 7 +.BI "keymap_layout=" "us, de" +sets the comma separated list of keyboard layout codes. See the Layouts section +in +.B "xkeyboard-config(7)." +.RE +.RE +.TP 7 +.BI "keymap_variant=" "dvp, dvorak" +sets the comma separated list of keyboard layout variants. The selected layout +may have one or several variants to choose from. See the Layouts section in +.B "xkeyboard-config(7)." +.RE +.RE +.TP 7 +.BI "keymap_options=" "grp:alt_shift_toggle,grp_led:scroll" +sets the keymap options. See the Options section in +.B "xkeyboard-config(7)." +.RE +.RE +.SH "TERMINAL SECTION" +Contains settings for the weston terminal application (weston-terminal). It +allows to customize the font and shell of the command line interface. +.TP 7 +.BI "font=" "DejaVu Sans Mono" +sets the font of the terminal. For a good experience it is recommend to use +monospace fonts. In case the font is not found, the default one is used. +.RE +.RE +.TP 7 +.BI "font-size=" "14" +sets the size of the terminal font. +.RE +.RE +.TP 7 +.BI "term=" "term" +The terminal shell. Sets the $TERM variable. +.RE +.RE +.SH "SEE ALSO" +.BR weston (1), +.BR weston-launch (1) +.BR xkeyboard-config (7) -- 1.7.10.4 _______________________________________________ wayland-devel mailing list [email protected] http://lists.freedesktop.org/mailman/listinfo/wayland-devel
