man: clean up weston.ini mark-up

Try to reduce the cargo-culted directives that do not seem to have any
effect on the output.

I verified that are no changes by doing before this patch

	$ man -Tpdf man/weston.ini.5 > ref.pdf

and then after this patch

	$ ninja && man -Tpdf man/weston.ini.5 > test.pdf

and looking at

	$ diffpdf ref.pdf test.pdf

I used PDF as the format for comparisons, because it can express much
more typesetting features than plain text.

Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.com>
dev
Pekka Paalanen 3 years ago committed by Marius Vlad
parent 924e79f4f2
commit 9203910b9a
  1. 65
      man/weston.ini.man

@ -87,7 +87,6 @@ integer, and boolean. Strings must not be quoted, do not support any
escape sequences, and run till the end of the line. Integers can escape sequences, and run till the end of the line. Integers can
be given in decimal (e.g. 123), octal (e.g. 0173), and hexadecimal be given in decimal (e.g. 123), octal (e.g. 0173), and hexadecimal
(e.g. 0x7b) form. Boolean values can be only 'true' or 'false'. (e.g. 0x7b) form. Boolean values can be only 'true' or 'false'.
.RE
.SH "CORE SECTION" .SH "CORE SECTION"
The The
.B core .B core
@ -108,7 +107,6 @@ directory are:
.TP 7 .TP 7
.BI "xwayland=" true .BI "xwayland=" true
ask Weston to load the XWayland module (boolean). ask Weston to load the XWayland module (boolean).
.RE
.TP 7 .TP 7
.BI "modules=" cms-colord.so,screen-share.so .BI "modules=" cms-colord.so,screen-share.so
specifies the modules to load (string). Available modules in the specifies the modules to load (string). Available modules in the
@ -159,9 +157,6 @@ means that if both weston.ini and command line define this idle-timeout
time, the one specified in the command-line will be used. On the other time, the one specified in the command-line will be used. On the other
hand, if none of these sets the value, default idle timeout will be hand, if none of these sets the value, default idle timeout will be
set to 300 seconds. set to 300 seconds.
.RS
.PP
.RE
.TP 7 .TP 7
.BI "require-input=" true .BI "require-input=" true
require an input device for launch require an input device for launch
@ -192,7 +187,6 @@ Enables pixman-based rendering for all outputs on backends that support it.
Boolean, defaults to Boolean, defaults to
.BR false . .BR false .
There is also a command line option to do the same. There is also a command line option to do the same.
.RE
.TP 7 .TP 7
.BI "color-management=" true .BI "color-management=" true
Enables color management and requires using GL-renderer. Enables color management and requires using GL-renderer.
@ -315,17 +309,17 @@ Weston will use the new calibration immediately.
The program is invoked as: The program is invoked as:
.PP .PP
.RS 10 .RS 10
.nf
.I calibration_helper syspath m1 m2 m3 m4 m5 m6 .I calibration_helper syspath m1 m2 m3 m4 m5 m6
.fi
.RE .RE
.RS .IP
.PP
.RI "where " syspath .RI "where " syspath
is the udev sys path for the device and is the udev sys path for the device and
.IR m1 " through " m6 .IR m1 " through " m6
are the calibration matrix elements in libinput's are the calibration matrix elements in libinput's
.BR LIBINPUT_CALIBRATION_MATRIX " udev property format." .BR LIBINPUT_CALIBRATION_MATRIX " udev property format."
The sys path is an absolute path and starts with the sys mount point. The sys path is an absolute path and starts with the sys mount point.
.RE
.SH "SHELL SECTION" .SH "SHELL SECTION"
The The
@ -438,7 +432,6 @@ sets the cursor theme (string).
.TP 7 .TP 7
.BI "cursor-size=" 24 .BI "cursor-size=" 24
sets the cursor size (unsigned integer). sets the cursor size (unsigned integer).
.RE
.SH "LAUNCHER SECTION" .SH "LAUNCHER SECTION"
There can be multiple launcher sections, one for each launcher. There can be multiple launcher sections, one for each launcher.
.TP 7 .TP 7
@ -458,7 +451,6 @@ example:
path=GDK_BACKEND=wayland gnome-terminal --full-screen path=GDK_BACKEND=wayland gnome-terminal --full-screen
.in .in
.fi .fi
.PP
.SH "OUTPUT SECTION" .SH "OUTPUT SECTION"
There can be multiple output sections, each corresponding to one output. It is There can be multiple output sections, each corresponding to one output. It is
currently only recognized by the drm and x11 backends. currently only recognized by the drm and x11 backends.
@ -477,12 +469,10 @@ Examples of usage:
.BR "WL1 " "Wayland backend, Wayland window no.1" .BR "WL1 " "Wayland backend, Wayland window no.1"
.fi .fi
.RE .RE
.RS .IP
.PP
See See
.B "weston-drm(7)" .B "weston-drm(7)"
for more details. for more details.
.RE
.TP 7 .TP 7
.BI "mode=" mode .BI "mode=" mode
sets the output mode (string). The mode parameter is handled differently sets the output mode (string). The mode parameter is handled differently
@ -493,7 +483,6 @@ The DRM backend accepts different modes, along with an option of a modeline stri
See See
.B "weston-drm(7)" .B "weston-drm(7)"
for examples of modes-formats supported by DRM backend. for examples of modes-formats supported by DRM backend.
.RE
.TP 7 .TP 7
.BI "transform=" normal .BI "transform=" normal
How you have rotated your monitor from its normal orientation (string). How you have rotated your monitor from its normal orientation (string).
@ -522,12 +511,9 @@ multiplier, to make them readable. Applications that do support their own output
scaling can draw their content in high resolution, in which case they avoid scaling can draw their content in high resolution, in which case they avoid
compositor scaling. Weston will not scale the output of such applications, and compositor scaling. Weston will not scale the output of such applications, and
they are not affected by this multiplier. they are not affected by this multiplier.
.RE .IP
.RS
.PP
An integer, 1 by default, typically configured as 2 or higher when needed, An integer, 1 by default, typically configured as 2 or higher when needed,
denoting the scaling multiplier for the output. denoting the scaling multiplier for the output.
.RE
.TP 7 .TP 7
.BI "icc_profile=" file .BI "icc_profile=" file
If option If option
@ -535,7 +521,6 @@ If option
is true, load the given ICC file as the output color profile. This works only is true, load the given ICC file as the output color profile. This works only
on DRM, headless, wayland, and x11 backends, and for remoting and pipewire on DRM, headless, wayland, and x11 backends, and for remoting and pipewire
outputs. outputs.
.RE
.TP 7 .TP 7
.BI "seat=" name .BI "seat=" name
The logical seat name that this output should be associated with. If this The logical seat name that this output should be associated with. If this
@ -544,7 +529,6 @@ 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 multiheaded environment with a single compositor for multiple output and input
configurations. The default seat is called "default" and will always be configurations. The default seat is called "default" and will always be
present. This seat can be constrained like any other. present. This seat can be constrained like any other.
.RE
.TP 7 .TP 7
.BI "allow_hdcp=" true .BI "allow_hdcp=" true
Allows HDCP support for this output. If set to true, HDCP can be tried for the Allows HDCP support for this output. If set to true, HDCP can be tried for the
@ -553,82 +537,58 @@ default, HDCP support is always allowed for an output. The
content-protection can actually be realized, only if the hardware content-protection can actually be realized, only if the hardware
(source and sink) support HDCP, and the backend has the implementation (source and sink) support HDCP, and the backend has the implementation
of content-protection protocol. Currently, HDCP is supported by drm-backend. of content-protection protocol. Currently, HDCP is supported by drm-backend.
.RE
.TP 7 .TP 7
.BI "app-ids=" app-id[,app_id]* .BI "app-ids=" app-id[,app_id]*
A comma separated list of the IDs of applications to place on this output. A comma separated list of the IDs of applications to place on this output.
These IDs should match the application IDs as set with the xdg_shell.set_app_id These IDs should match the application IDs as set with the xdg_shell.set_app_id
request. Currently, this option is supported by kiosk-shell. request. Currently, this option is supported by kiosk-shell.
.RE
.SH "INPUT-METHOD SECTION" .SH "INPUT-METHOD SECTION"
.TP 7 .TP 7
.BI "path=" "@weston_libexecdir@/weston-keyboard" .BI "path=" "@weston_libexecdir@/weston-keyboard"
sets the path of the on screen keyboard input method (string). sets the path of the on screen keyboard input method (string).
.RE
.RE
.TP 7 .TP 7
.BI "overlay-keyboard=" false .BI "overlay-keyboard=" false
sets weston-keyboard as overlay panel. sets weston-keyboard as overlay panel.
.RE
.RE
.SH "KEYBOARD SECTION" .SH "KEYBOARD SECTION"
This section contains the following keys: This section contains the following keys:
.TP 7 .TP 7
.BI "keymap_rules=" "evdev" .BI "keymap_rules=" "evdev"
sets the keymap rules file (string). Used to map layout and model to input sets the keymap rules file (string). Used to map layout and model to input
device. device.
.RE
.RE
.TP 7 .TP 7
.BI "keymap_model=" "pc105" .BI "keymap_model=" "pc105"
sets the keymap model (string). See the Models section in sets the keymap model (string). See the Models section in
.B "xkeyboard-config(7)." .B "xkeyboard-config(7)."
.RE
.RE
.TP 7 .TP 7
.BI "keymap_layout=" "us,de,gb" .BI "keymap_layout=" "us,de,gb"
sets the comma separated list of keyboard layout codes (string). See the sets the comma separated list of keyboard layout codes (string). See the
Layouts section in Layouts section in
.B "xkeyboard-config(7)." .B "xkeyboard-config(7)."
.RE
.RE
.TP 7 .TP 7
.BI "keymap_variant=" "euro,,intl" .BI "keymap_variant=" "euro,,intl"
sets the comma separated list of keyboard layout variants (string). The number sets the comma separated list of keyboard layout variants (string). The number
of variants must be the same as the number of layouts above. See the Layouts of variants must be the same as the number of layouts above. See the Layouts
section in section in
.B "xkeyboard-config(7)." .B "xkeyboard-config(7)."
.RE
.RE
.TP 7 .TP 7
.BI "keymap_options=" "grp:alt_shift_toggle,grp_led:scroll" .BI "keymap_options=" "grp:alt_shift_toggle,grp_led:scroll"
sets the keymap options (string). See the Options section in sets the keymap options (string). See the Options section in
.B "xkeyboard-config(7)." .B "xkeyboard-config(7)."
.RE
.RE
.TP 7 .TP 7
.BI "repeat-rate=" "40" .BI "repeat-rate=" "40"
sets the rate of repeating keys in characters per second (unsigned integer) sets the rate of repeating keys in characters per second (unsigned integer)
.RE
.RE
.TP 7 .TP 7
.BI "repeat-delay=" "400" .BI "repeat-delay=" "400"
sets the delay in milliseconds since key down until repeating starts (unsigned sets the delay in milliseconds since key down until repeating starts (unsigned
integer) integer)
.RE
.RE
.TP 7 .TP 7
.BI "numlock-on=" "false" .BI "numlock-on=" "false"
sets the default state of the numlock on weston startup for the backends which sets the default state of the numlock on weston startup for the backends which
support it. support it.
.RE
.RE
.TP 7 .TP 7
.BI "vt-switching=" "true" .BI "vt-switching=" "true"
Whether to allow the use of Ctrl+Alt+Fn key combinations to switch away from Whether to allow the use of Ctrl+Alt+Fn key combinations to switch away from
the compositor's virtual console. the compositor's virtual console.
.RE
.RE
.SH "TERMINAL SECTION" .SH "TERMINAL SECTION"
Contains settings for the weston terminal application (weston-terminal). It Contains settings for the weston terminal application (weston-terminal). It
allows to customize the font and shell of the command line interface. allows to customize the font and shell of the command line interface.
@ -636,49 +596,34 @@ allows to customize the font and shell of the command line interface.
.BI "font=" "DejaVu Sans Mono" .BI "font=" "DejaVu Sans Mono"
sets the font of the terminal (string). For a good experience it is recommended sets the font of the terminal (string). For a good experience it is recommended
to use monospace fonts. In case the font is not found, the default one is used. to use monospace fonts. In case the font is not found, the default one is used.
.RE
.RE
.TP 7 .TP 7
.BI "font-size=" "14" .BI "font-size=" "14"
sets the size of the terminal font (unsigned integer). sets the size of the terminal font (unsigned integer).
.RE
.RE
.TP 7 .TP 7
.BI "term=" "xterm-256color" .BI "term=" "xterm-256color"
The terminal shell (string). Sets the $TERM variable. The terminal shell (string). Sets the $TERM variable.
.RE
.RE
.SH "XWAYLAND SECTION" .SH "XWAYLAND SECTION"
.TP 7 .TP 7
.BI "path=" "@xserver_path@" .BI "path=" "@xserver_path@"
sets the path to the xserver to run (string). sets the path to the xserver to run (string).
.RE
.RE
.SH "SCREEN-SHARE SECTION" .SH "SCREEN-SHARE SECTION"
.TP 7 .TP 7
.BI "command=" "@weston_bindir@/weston --backend=rdp-backend.so \ .BI "command=" "@weston_bindir@/weston --backend=rdp-backend.so \
--shell=fullscreen-shell.so --no-clients-resize" --shell=fullscreen-shell.so --no-clients-resize"
sets the command to start a fullscreen-shell server for screen sharing (string). sets the command to start a fullscreen-shell server for screen sharing (string).
.RE
.RE
.TP 7 .TP 7
.BI "start-on-startup=" "false" .BI "start-on-startup=" "false"
If set to true, start screen sharing of all outputs available on Weston startup. If set to true, start screen sharing of all outputs available on Weston startup.
Set to false by default. Set to false by default.
.RE
.RE
.SH "AUTOLAUNCH SECTION" .SH "AUTOLAUNCH SECTION"
.TP 7 .TP 7
.BI "path=" "/usr/bin/echo" .BI "path=" "/usr/bin/echo"
Path to an executable file to run after startup. This file is executed in Path to an executable file to run after startup. This file is executed in
parallel to Weston, so it does not have to immediately exit. Defaults to empty. parallel to Weston, so it does not have to immediately exit. Defaults to empty.
.RE
.TP 7 .TP 7
.BI "watch=" "false" .BI "watch=" "false"
If set to true, quit Weston after the auto-launched executable exits. Set to false If set to true, quit Weston after the auto-launched executable exits. Set to false
by default. by default.
.RE
.RE
.SH "SEE ALSO" .SH "SEE ALSO"
.BR weston (1), .BR weston (1),
.BR weston-bindings (7), .BR weston-bindings (7),

Loading…
Cancel
Save