413 lines
13 KiB
Groff
413 lines
13 KiB
Groff
.TH WESTON 1 "2019-03-23" "Weston @version@"
|
|
.SH NAME
|
|
weston \- the reference Wayland server
|
|
.SH SYNOPSIS
|
|
.B weston
|
|
.
|
|
.\" ***************************************************************
|
|
.SH DESCRIPTION
|
|
.B weston
|
|
is the reference implementation of a Wayland server. A Wayland server is a
|
|
display server, a window manager, and a compositor all in one. Weston has
|
|
several backends as loadable modules: it can run on Linux KMS (kernel
|
|
modesetting via DRM), as an X client, or inside another Wayland server
|
|
instance.
|
|
|
|
Weston supports fundamentally different graphical user interface paradigms via
|
|
shell plugins. Two plugins are provided: the desktop shell, and the kiosk
|
|
shell.
|
|
|
|
Weston also supports X clients via
|
|
.BR Xwayland ", see below."
|
|
.
|
|
.\" ***************************************************************
|
|
.SH BACKENDS
|
|
.TP
|
|
.I drm
|
|
The DRM backend uses Linux KMS for output and evdev devices for input.
|
|
It supports multiple monitors in a unified desktop with DPMS. See
|
|
.BR weston-drm (7),
|
|
if installed.
|
|
.TP
|
|
.I wayland
|
|
The Wayland backend runs on another Wayland server, a different Weston
|
|
instance, for example. Weston shows up as a single desktop window on
|
|
the parent server.
|
|
.TP
|
|
.I x11
|
|
The X11 backend runs on an X server. Each Weston output becomes an
|
|
X window. This is a cheap way to test multi-monitor support of a
|
|
Wayland shell, desktop, or applications.
|
|
.TP
|
|
.I rdp
|
|
The RDP backend runs in memory without the need of graphical hardware. Access
|
|
to the desktop is done by using the RDP protocol. Each connecting
|
|
client has its own seat making it a cheap way to test multi-seat support. See
|
|
.BR weston-rdp (7),
|
|
if installed.
|
|
.TP
|
|
.I vnc
|
|
The VNC backend runs in memory without the need of graphical hardware. Access
|
|
to the desktop is done by using the RFB protocol. Currently only one
|
|
connecting client is supported. See
|
|
.BR weston-vnc (7),
|
|
if installed.
|
|
.TP
|
|
.I pipewire
|
|
The PipeWire backend runs in memory without the need of graphical hardware and
|
|
creates a PipeWire node for each output. It can be used to capture Weston
|
|
outputs for processing with another application.
|
|
.
|
|
.\" ***************************************************************
|
|
.SH SHELLS
|
|
Weston's user interface is implemented by individual 'shell' plugins.
|
|
A number of shells are provided for different usecases.
|
|
.TP
|
|
.I desktop
|
|
The desktop shell is Weston's default mode. It provides an example of a
|
|
desktop-like environment, featuring a panel with launchers and a clock,
|
|
a background, and an interactive task switcher. Whilst not intended to be
|
|
a full-fledged desktop environment in and of itself, it is an example of
|
|
how such an environment can be built.
|
|
.TP
|
|
.I kiosk
|
|
The kiosk shell is intended for environments which want to run a single
|
|
application at a time. Applications will be made full screen and
|
|
activated as they are started.
|
|
.TP
|
|
.I fullscreen
|
|
The fullscreen shell is a deprecated implementation of the ideas behind
|
|
the kiosk shell. It requires specific client support for the
|
|
.I zwp_fullscreen_shell_v1
|
|
interface.
|
|
.TP
|
|
.I ivi
|
|
The IVI shell is a special-purpose shell which exposes an API compatible
|
|
with the GENIVI Layer Manager to user-provided HMI controller modules.
|
|
It is intended for use in automotive environments.
|
|
.
|
|
.\" ***************************************************************
|
|
.SH XWAYLAND
|
|
Weston can support X11 clients running within a Weston session via an
|
|
X server called
|
|
.BR Xwayland "."
|
|
Xwayland is built as a separate executable, provided by X.Org. Once built
|
|
and installed, it can be activated with the
|
|
.BR \-\-xwayland
|
|
option. Weston will listen on a new X11 display socket and export it
|
|
through the
|
|
.BR DISPLAY
|
|
environment variable.
|
|
|
|
It has also its own X window manager where cursor themes and sizes can be
|
|
chosen using
|
|
.BR XCURSOR_PATH
|
|
and
|
|
.BR XCURSOR_SIZE " environment variables. See " ENVIRONMENT .
|
|
.
|
|
.\" ***************************************************************
|
|
.SH OPTIONS
|
|
.
|
|
.SS Weston core options:
|
|
.TP
|
|
\fB\-\^B\fR\fIbackend1,backend2\fR, \fB\-\-backend\fR=\fIbackend1,backend2\fR
|
|
Load the comma-separated list of backends instead of the default backend, see
|
|
.IR BACKENDS .
|
|
The backend modules are searched for in
|
|
.IR "@weston_modules_dir@" .
|
|
The default backend is
|
|
.I @weston_native_backend@
|
|
unless the environment suggests otherwise, see
|
|
.IR DISPLAY " and " WAYLAND_DISPLAY .
|
|
The first backend is the primary backend, and it provides the renderer. Not all
|
|
backends support being loaded as secondary backends, which reuse the primary
|
|
backend's renderer.
|
|
.TP
|
|
\fB\-\^c\fR\fIconfig.ini\fR, \fB\-\-config\fR=\fIconfig.ini\fR
|
|
Load
|
|
.IR config.ini " instead of " weston.ini .
|
|
The argument can also be an absolute path starting with a
|
|
.IR / .
|
|
If the path is not absolute, it will be searched in the normal config
|
|
paths, see
|
|
.BR weston.ini (5).
|
|
This option is ignored if the
|
|
.B --no-config
|
|
option is passed.
|
|
.TP
|
|
.BR \-\-debug
|
|
Enable debug protocol extension
|
|
.I weston_debug_v1
|
|
which any client can use to receive debugging messages from the compositor.
|
|
|
|
.B WARNING:
|
|
This is risky for two reasons. First, a client may cause a denial-of-service
|
|
blocking the compositor by providing an unsuitable file descriptor, and
|
|
second, the debug messages may expose sensitive information.
|
|
Additionally this will expose weston-screenshooter interface allowing the user
|
|
to take screenshots of the outputs using weston-screenshooter application,
|
|
which can lead to silently leaking the output contents. This option should
|
|
not be used in production.
|
|
.TP
|
|
\fB\-\^f\fIscope1,scope2\fR, \fB\-\-flight-rec-scopes\fR=\fIscope1,scope2\fR
|
|
Specify to which scopes should subscribe to. Useful to control which streams to
|
|
write data into the flight recorder. Flight recorder has limited space, once
|
|
the flight recorder is full new data will overwrite the old data. Without any
|
|
scopes specified, it subscribes to 'log' and 'drm-backend' scopes. Passing
|
|
an empty value would disable the flight recorder entirely.
|
|
.TP
|
|
.BR \-\^h ", " \-\-help
|
|
Print a summary of command line options, and quit.
|
|
.TP
|
|
\fB\-\^i\fR\fIN\fR, \fB\-\-idle\-time\fR=\fIN\fR
|
|
Set the idle timeout to
|
|
.I N
|
|
seconds. The default timeout is 300 seconds. When there has not been any
|
|
user input for the idle timeout, Weston enters an inactive mode. The
|
|
screen fades to black, monitors may switch off, and the shell may lock
|
|
the session.
|
|
A value of 0 effectively disables the timeout.
|
|
.TP
|
|
\fB\-\-log\fR=\fIfile.log\fR
|
|
Append log messages to the file
|
|
.I file.log
|
|
instead of writing them to stderr.
|
|
.TP
|
|
\fB\-\^l\fIscope1,scope2\fR, \fB\-\-logger-scopes\fR=\fIscope1,scope2\fR
|
|
Specify to which log scopes should subscribe to. When no scopes are supplied,
|
|
the log "log" scope will be subscribed by default. Useful to control which
|
|
streams to write data into the logger and can be helpful in diagnosing early
|
|
start-up code.
|
|
.TP
|
|
\fB\-\-modules\fR=\fImodule1.so,module2.so\fR
|
|
Load the comma-separated list of modules. Only used by the test
|
|
suite. The file is searched for in
|
|
.IR "@weston_modules_dir@" ,
|
|
or you can pass an absolute path.
|
|
.TP
|
|
.BR \-\-no-config
|
|
Do not read
|
|
.I weston.ini
|
|
for the compositor. Avoids e.g. loading compositor modules via the
|
|
configuration file, which is useful for unit tests.
|
|
.TP
|
|
\fB\-\-renderer\fR=\fIrenderer\fR
|
|
Select which renderer to use for Weston's internal composition. Defaults to
|
|
automatic selection.
|
|
.TP
|
|
\fB\-\-shell\fR=\fIshell\fR
|
|
Select which shell to load to provide Weston's user interface. See
|
|
.BR ENVIRONMENT "."
|
|
.TP
|
|
\fB\-\^S\fR\fIname\fR, \fB\-\-socket\fR=\fIname\fR
|
|
Weston will listen in the Wayland socket called
|
|
.IR name .
|
|
Weston will export
|
|
.B WAYLAND_DISPLAY
|
|
with this value in the environment for all child processes to allow them to
|
|
connect to the right server automatically.
|
|
.BR \-\-version
|
|
Print the program version.
|
|
.TP
|
|
\fB\-\-wait-for-debugger\fR
|
|
Raises SIGSTOP before initializing the compositor. This allows the user to
|
|
attach with a debugger and continue execution by sending SIGCONT. This is
|
|
useful for debugging a crash on start-up when it would be inconvenient to
|
|
launch weston directly from a debugger. There is also a
|
|
.IR weston.ini " option to do the same."
|
|
.TP
|
|
\fB\-\-xwayland\fR
|
|
Support X11 clients through the Xwayland server.
|
|
.
|
|
.SS DRM backend options:
|
|
See
|
|
.BR weston-drm (7).
|
|
.
|
|
.SS Wayland backend options:
|
|
.TP
|
|
\fB\-\-display\fR=\fIdisplay\fR
|
|
Name of the Wayland display to connect to, see also
|
|
.I WAYLAND_DISPLAY
|
|
of the environment.
|
|
.TP
|
|
.B \-\-fullscreen
|
|
Create a single fullscreen output
|
|
.TP
|
|
\fB\-\-output\-count\fR=\fIN\fR
|
|
Create
|
|
.I N
|
|
Wayland windows to emulate the same number of outputs.
|
|
.TP
|
|
\fB\-\-width\fR=\fIW\fR, \fB\-\-height\fR=\fIH\fR
|
|
Make all outputs have a size of
|
|
.IR W x H " pixels."
|
|
.TP
|
|
.B \-\-scale\fR=\fIN\fR
|
|
Give all outputs a scale factor of
|
|
.I N.
|
|
.TP
|
|
.B \-\-use\-pixman
|
|
Deprecated in favour of the
|
|
.BI \-\-renderer
|
|
option. Use the pixman renderer. By default weston will try to use EGL and
|
|
GLES2 for rendering and will fall back to the pixman-based renderer for
|
|
software compositing if EGL cannot be used. Passing this option will force
|
|
weston to use the pixman renderer.
|
|
.
|
|
.SS X11 backend options:
|
|
.TP
|
|
.B \-\-fullscreen
|
|
.TP
|
|
.B \-\-no\-input
|
|
Do not provide any input devices. Used for testing input-less Weston.
|
|
.TP
|
|
\fB\-\-output\-count\fR=\fIN\fR
|
|
Create
|
|
.I N
|
|
X windows to emulate the same number of outputs.
|
|
.TP
|
|
\fB\-\-width\fR=\fIW\fR, \fB\-\-height\fR=\fIH\fR
|
|
Make the default size of each X window
|
|
.IR W x H " pixels."
|
|
.TP
|
|
.B \-\-scale\fR=\fIN\fR
|
|
Give all outputs a scale factor of
|
|
.I N.
|
|
.TP
|
|
.B \-\-use\-pixman
|
|
Deprecated in favour of the
|
|
.BI \-\-renderer
|
|
option. Use the pixman renderer. By default weston will try to use EGL and
|
|
GLES2 for rendering. Passing this option will make weston use the
|
|
pixman library for software compsiting.
|
|
.
|
|
.SS RDP backend options:
|
|
See
|
|
.BR weston-rdp (7).
|
|
.
|
|
.SS VNC backend options:
|
|
See
|
|
.BR weston-vnc (7).
|
|
.
|
|
.
|
|
.\" ***************************************************************
|
|
.SH FILES
|
|
.
|
|
If the environment variable is set, the configuration file is read
|
|
from the respective path.
|
|
.PP
|
|
.BI $XDG_CONFIG_HOME /weston.ini
|
|
.br
|
|
.BI $HOME /.config/weston.ini
|
|
.br
|
|
.
|
|
.\" ***************************************************************
|
|
.SH ENVIRONMENT
|
|
.
|
|
.TP
|
|
.B DISPLAY
|
|
The X display. If
|
|
.B DISPLAY
|
|
is set, and
|
|
.B WAYLAND_DISPLAY
|
|
is not set, the default backend becomes
|
|
.IR x11 .
|
|
.TP
|
|
.B WAYLAND_DEBUG
|
|
If set to any value, causes libwayland to print the live protocol
|
|
to stderr.
|
|
.TP
|
|
.B WAYLAND_DISPLAY
|
|
The name of the display (socket) of an already running Wayland server, without
|
|
the path. The directory path is always taken from
|
|
.BR XDG_RUNTIME_DIR .
|
|
If
|
|
.B WAYLAND_DISPLAY
|
|
is not set, the socket name is "wayland-0".
|
|
|
|
If
|
|
.B WAYLAND_DISPLAY
|
|
is already set, the default backend becomes
|
|
.IR wayland .
|
|
This allows launching Weston as a nested server.
|
|
.TP
|
|
.B WAYLAND_SOCKET
|
|
For Wayland clients, holds the file descriptor of an open local socket
|
|
to a Wayland server.
|
|
.TP
|
|
.B WESTON_CONFIG_FILE
|
|
Weston sets this variable to the absolute path of the configuration file
|
|
it loads, or to the empty string if no file is used. Programs that use
|
|
.I weston.ini
|
|
will read the file specified by this variable instead, or do not read any
|
|
file if it is empty. Unset variable causes falling back to the default
|
|
name
|
|
.IR weston.ini .
|
|
.TP
|
|
.B XCURSOR_PATH
|
|
Set the list of paths to look for cursors in. It changes both
|
|
libwayland-cursor and libXcursor, so it affects both Wayland and X11 based
|
|
clients. See
|
|
.B xcursor
|
|
(3).
|
|
.TP
|
|
.B XCURSOR_SIZE
|
|
This variable can be set for choosing an specific size of cursor. Affect
|
|
Wayland and X11 clients. See
|
|
.B xcursor
|
|
(3).
|
|
.TP
|
|
.B XDG_CONFIG_HOME
|
|
If set, specifies the directory where to look for
|
|
.BR weston.ini .
|
|
.TP
|
|
.B XDG_RUNTIME_DIR
|
|
The directory for Weston's socket and lock files.
|
|
Wayland clients will automatically use this.
|
|
.
|
|
.\" ***************************************************************
|
|
.SH PROGRAM EXECUTION
|
|
It is possible to execute a program that will be run by Weston.
|
|
.TP
|
|
By using this syntax :
|
|
weston [options] -- [program [arguments]]
|
|
.PP
|
|
The '--' here is mandatory to execute a program. There are examples in the
|
|
.BR EXAMPLES
|
|
section.
|
|
.
|
|
.\" ***************************************************************
|
|
.SH BUGS
|
|
Bugs should be reported to
|
|
.BR https://gitlab.freedesktop.org/wayland/weston/ "."
|
|
.
|
|
.\" ***************************************************************
|
|
.SH WWW
|
|
https://wayland.freedesktop.org/
|
|
.
|
|
.\" ***************************************************************
|
|
.SH EXAMPLES
|
|
.IP "Launch Weston with the DRM backend on a VT"
|
|
weston
|
|
.IP "Launch Weston with the DRM backend and XWayland support"
|
|
weston --xwayland
|
|
.IP "Launch Weston (wayland-1) nested in another Weston instance (wayland-0)"
|
|
WAYLAND_DISPLAY=wayland-0 weston -Swayland-1
|
|
.IP "From an X terminal, launch Weston with the x11 backend"
|
|
weston
|
|
.IP "Launch Weston and make it start weston-terminal"
|
|
weston -- /usr/local/bin/weston-terminal
|
|
.IP "Launch Weston with the kiosk shell and make it start weston-simple-egl"
|
|
weston --shell=kiosk-shell.so -- /usr/local/bin/weston-simple-egl
|
|
.IP "Launch Weston with the kiosk shell and open a pdf document with mupdf"
|
|
weston --shell=kiosk-shell.so -- mupdf /home/user/Documents/krh/wayland.pdf
|
|
.
|
|
.\" ***************************************************************
|
|
.SH "SEE ALSO"
|
|
.BR weston-bindings (7),
|
|
.BR weston-debug (1),
|
|
.BR weston-drm (7),
|
|
.BR weston-rdp (7),
|
|
.BR weston-vnc (7),
|
|
.BR weston.ini (5)
|