1 .TH WESTON 1 "2012-11-27" "Weston __version__"
3 weston \- the reference Wayland server
7 .\" ***************************************************************
10 is the reference implementation of a Wayland server. A Wayland server is a
11 display server, a window manager, and a compositor all in one. Weston has
12 several backends as loadable modules: it can run on Linux KMS (kernel
13 modesetting via DRM), as an X client, or inside another Wayland server
16 Weston supports fundamentally different graphical user interface paradigms via
17 shell plugins. Two plugins are provided: the desktop shell, and the tablet
20 When weston is started as the first windowing system (i.e. not under X nor
21 under another Wayland server), it should be done with the command
23 to set up proper privileged access to devices.
25 Weston also supports X clients via
26 .BR XWayland ", see below."
28 .\" ***************************************************************
32 The DRM backend uses Linux KMS for output and evdev devices for input.
33 It supports multiple monitors in a unified desktop with DPMS. See
38 The Wayland backend runs on another Wayland server, a different Weston
39 instance, for example. Weston shows up as a single desktop window on
43 The X11 backend runs on an X server. Each Weston output becomes an
44 X window. This is a cheap way to test multi-monitor support of a
45 Wayland shell, desktop, or applications.
47 .\" ***************************************************************
51 Desktop shell is like a modern X desktop environment, concentrating
52 on traditional keyboard and mouse user interfaces and the familiar
53 desktop-like window management. Desktop shell consists of the
56 and the special client
57 .B weston-desktop-shell
58 which provides the wallpaper, panel, and screen locking dialog.
61 Tablet shell is a graphical user interface aimed for tablet-like
62 devices, where usually the only input method is a touch screen.
63 It does not support freely floating windows or many other desktop
64 features, but intends to provide a natural interface on tablets.
65 Tablet shell consists of the shell plugin
67 and the special client
68 .B weston-tablet-shell
69 which provides the basic user interface.
71 .\" ***************************************************************
73 XWayland requires a special X.org server to be installed. This X server will
74 connect to a Wayland server as a Wayland client, and X clients will connect to
75 the X server. XWayland provides backwards compatibility to X applications in a
78 XWayland is activated by instructing
79 .BR weston " to load " xwayland.so " module, see " EXAMPLES .
80 Weston starts listening on a new X display socket, and exports it in the
83 When the first X client connects, Weston launches a special X server as a
84 Wayland client to handle the X client and all future X clients.
86 It has also its own X window manager where cursor themes and sizes can be
90 .BR XCURSOR_SIZE " environment variables. See " ENVIRONMENT .
92 .\" ***************************************************************
95 .SS Weston core options:
97 \fB\-\^B\fR\fIbackend.so\fR, \fB\-\-backend\fR=\fIbackend.so\fR
100 instead of the default backend. The file is searched for in
101 .IR "__weston_modules_dir__" ,
102 or you can pass an absolute path. The default backend is
103 .I __weston_native_backend__
104 unless the environment suggests otherwise, see
105 .IR DISPLAY " and " WAYLAND_DISPLAY .
107 .BR \-\^h ", " \-\-help
108 Print the program version and a summary of command line options, and quit.
110 \fB\-\^i\fR\fIN\fR, \fB\-\-idle\-time\fR=\fIN\fR
111 Set the idle timeout to
113 seconds. The default timeout is 300 seconds. When there has not been any
114 user input for the idle timeout, Weston enters an inactive mode. The
115 screen fades to black, and depending on the shell in use, a screensaver
116 may activate, monitors may switch off, and the shell may lock the session.
118 \fB\-\-log\fR=\fIfile.log\fR
119 Append log messages to the file
121 instead of writing them to stderr.
123 \fB\-\-modules\fR=\fImodule1.so,module2.so\fR
124 Load the comma-separated list of modules. Only used by the test
125 suite. The file is searched for in
126 .IR "__weston_modules_dir__" ,
127 or you can pass an absolute path.
129 \fB\-\^S\fR\fIname\fR, \fB\-\-socket\fR=\fIname\fR
130 Weston will listen in the Wayland socket called
134 with this value in the environment for all child processes to allow them to
135 connect to the right server automatically.
136 .SS DRM backend options:
140 .SS Wayland backend options:
142 \fB\-\-display\fR=\fIdisplay\fR
143 Name of the Wayland display to connect to, see also
147 \fB\-\-width\fR=\fIW\fR, \fB\-\-height\fR=\fIH\fR
148 Make the desktop size
151 .SS X11 backend options:
156 Do not provide any input devices. Used for testing input-less Weston.
158 \fB\-\-output\-count\fR=\fIN\fR
161 X windows to emulate the same number of outputs.
163 \fB\-\-width\fR=\fIW\fR, \fB\-\-height\fR=\fIH\fR
164 Make the default size of each X window
167 .\" ***************************************************************
170 If the environment variable is set, the configuration file is read
171 from the respective path, or the current directory if neither is set.
173 .BI $XDG_CONFIG_HOME /weston.ini
175 .BI $HOME /.config/weston.ini
180 .\" ***************************************************************
189 is not set, the default backend becomes
193 If set to any value, causes libwayland to print the live protocol
197 The name of the display (socket) of an already running Wayland server, without
198 the path. The directory path is always taken from
199 .BR XDG_RUNTIME_DIR .
202 is not set, the socket name is "wayland-0".
206 is already set, the default backend becomes
207 .IR wayland-backend.so .
208 This allows launching Weston as a nested server.
211 For Wayland clients, holds the file descriptor of an open local socket
215 Set the list of paths to look for cursors in. It changes both
216 libwayland-cursor and libXcursor, so it affects both Wayland and X11 based
222 This variable can be set for choosing an specific size of cursor. Affect
223 Wayland and X11 clients. See
228 If set, specifies the directory where to look for
232 The directory for Weston's socket and lock files.
233 Wayland clients will automatically use this.
235 .\" ***************************************************************
237 Weston has a segmentation fault handler, that attempts to restore
238 the virtual console or ungrab X before raising
241 .BR weston " under " gdb (1)
242 from an X11 terminal or a different virtual terminal, and tell gdb
244 handle SIGSEGV nostop
246 This will allow weston to switch back to gdb on crash and then
247 gdb will catch the crash with SIGTRAP.
249 .\" ***************************************************************
251 Bugs should be reported to the freedesktop.org bugzilla at
252 https://bugs.freedesktop.org with product "Wayland" and
255 .\" ***************************************************************
257 http://wayland.freedesktop.org/
259 .\" ***************************************************************
261 .IP "Launch Weston with the DRM backend on a VT"
263 .IP "Launch Weston with the DRM backend and XWayland support"
264 weston-launch -- --modules=xwayland.so
265 .IP "Launch Weston (wayland-1) nested in another Weston instance (wayland-0)"
266 WAYLAND_DISPLAY=wayland-0 weston -Swayland-1
267 .IP "From an X terminal, launch Weston with the x11 backend"
270 .\" ***************************************************************
273 .\".BR weston-launch (1),
274 .\".BR weston.ini (5)