1 .TH WESTON 1 "2012-09-13" "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.
36 The Wayland backend runs on another Wayland server, a different Weston
37 instance, for example. Weston shows up as a single desktop window on
41 The X11 backend runs on an X server. Each Weston output becomes an
42 X window. This is a cheap way to test multi-monitor support of a
43 Wayland shell, desktop, or applications.
45 .\" ***************************************************************
49 Desktop shell is like a modern X desktop environment, concentrating
50 on traditional keyboard and mouse user interfaces and the familiar
51 desktop-like window management. Desktop shell consists of the
54 and the special client
55 .B weston-desktop-shell
56 which provides the wallpaper, panel, and screen locking dialog.
59 Tablet shell is a graphical user interface aimed for tablet-like
60 devices, where usually the only input method is a touch screen.
61 It does not support freely floating windows or many other desktop
62 features, but intends to provide a natural interface on tablets.
63 Tablet shell consists of the shell plugin
65 and the special client
66 .B weston-tablet-shell
67 which provides the basic user interface.
69 .\" ***************************************************************
71 XWayland requires a special X.org server to be installed. This X server will
72 connect to a Wayland server as a Wayland client, and X clients will connect to
73 the X server. XWayland provides backwards compatibility to X applications in a
76 XWayland is activated by instructing
77 .BR weston " to load " xwayland.so " module, see " EXAMPLES .
78 Weston starts listening on a new X display socket, and exports it in the
81 When the first X client connects, Weston launches a special X server as a
82 Wayland client to handle the X client and all future X clients.
84 It has also its own X window manager where cursor themes and sizes can be
88 .BR XCURSOR_SIZE " environment variables. See " ENVIRONMENT .
90 .\" ***************************************************************
93 .SS Weston core options:
95 \fB\-\^B\fR\fIbackend.so\fR, \fB\-\-backend\fR=\fIbackend.so\fR
98 instead of the default backend. The file is searched for in
99 .IR "__weston_modules_dir__" ,
100 or you can pass an absolute path. The default backend is
102 unless the environment suggests otherwise, see
103 .IR DISPLAY " and " WAYLAND_DISPLAY .
105 .BR \-\^h ", " \-\-help
106 Print the program version and a summary of command line options, and quit.
108 \fB\-\^i\fR\fIN\fR, \fB\-\-idle\-time\fR=\fIN\fR
109 Set the idle timeout to
111 seconds. The default timeout is 300 seconds. When there has not been any
112 user input for the idle timeout, Weston enters an inactive mode. The
113 screen fades to black, and depending on the shell in use, a screensaver
114 may activate, monitors may switch off, and the shell may lock the session.
116 \fB\-\-log\fR=\fIfile.log\fR
117 Append log messages to the file
119 instead of writing them to stderr.
121 \fB\-\-modules\fR=\fImodule1.so,module2.so\fR
122 Load the comma-separated list of modules. Only used by the test
123 suite. The file is searched for in
124 .IR "__weston_modules_dir__" ,
125 or you can pass an absolute path.
127 \fB\-\^S\fR\fIname\fR, \fB\-\-socket\fR=\fIname\fR
128 Weston will listen in the Wayland socket called
132 with this value in the environment for all child processes to allow them to
133 connect to the right server automatically.
134 .SS DRM backend options:
136 \fB\-\-connector\fR=\fIconnectorid\fR
140 \fB\-\-seat\fR=\fIseatid\fR
142 \fB\-\-tty\fR=\fItty\fR
144 .SS Wayland backend options:
146 \fB\-\-display\fR=\fIdisplay\fR
147 Name of the Wayland display to connect to, see also
151 \fB\-\-width\fR=\fIW\fR, \fB\-\-height\fR=\fIH\fR
152 Make the desktop size
155 .SS X11 backend options:
160 Do not provide any input devices. Used for testing input-less Weston.
162 \fB\-\-output\-count\fR=\fIN\fR
165 X windows to emulate the same number of outputs.
167 \fB\-\-width\fR=\fIW\fR, \fB\-\-height\fR=\fIH\fR
168 Make the default size of each X window
171 .\" ***************************************************************
174 .\" ***************************************************************
183 is not set, the default backend becomes
187 If set to any value, causes libwayland to print the live protocol
191 The name of the display (socket) of an already running Wayland server, without
192 the path. The directory path is always taken from
193 .BR XDG_RUNTIME_DIR .
196 is not set, the socket name is "wayland-0".
200 is already set, the default backend becomes
201 .IR wayland-backend.so .
202 This allows launching Weston as a nested server.
208 .B WESTON_LAUNCHER_SOCK
211 Set the list of paths to look for cursors in. It changes both
212 libwayland-cursor and libXcursor, so it affects both Wayland and X11 based
218 This variable can be set for choosing an specific size of cursor. Affect
219 Wayland and X11 clients. See
226 The directory for Weston's socket and lock files.
227 Wayland clients will automatically use this.
229 .\" ***************************************************************
232 .\" ***************************************************************
234 Bugs should be reported to the freedesktop.org bugzilla at
235 https://bugs.freedesktop.org with product "Wayland" and
238 .\" ***************************************************************
240 http://wayland.freedesktop.org/
242 .\" ***************************************************************
244 .IP "Launch Weston with the DRM backend on a VT"
246 .IP "Launch Weston with the DRM backend and XWayland support"
247 weston-launch -- --modules=xwayland.so
248 .IP "Launch Weston (wayland-1) nested in another Weston instance (wayland-0)"
249 WAYLAND_DISPLAY=wayland-0 weston -Swayland-1
250 .IP "From an X terminal, launch Weston with the x11 backend"
253 .\" ***************************************************************
255 .\".BR weston-launch (1),
256 .\".BR weston.ini (5)