1 .TH WESTON 1 "2012-08-29" "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 by XWayland. XWayland requires a special
26 X.org server to be installed. This X server will connect to a Wayland
27 server as a Wayland client, and X clients will connect to the X server.
28 XWayland provides backwards compatibility to X applications in a Wayland
31 .\" ***************************************************************
35 The DRM backend uses Linux KMS for output and evdev devices for input.
36 It supports multiple monitors in a unified desktop with DPMS.
39 The Wayland backend runs on another Wayland server, a different Weston
40 instance, for example. Weston shows up as a single desktop window on
44 The X11 backend runs on an X server. Each Weston output becomes an
45 X window. This is a cheap way to test multi-monitor support of a
46 Wayland shell, desktop, or applications.
48 .\" ***************************************************************
52 Desktop shell is like a modern X desktop environment, concentrating
53 on traditional keyboard and mouse user interfaces and the familiar
54 desktop-like window management. Desktop shell consists of the
57 and the special client
58 .B weston-desktop-shell
59 which provides the wallpaper, panel, and screen locking dialog.
62 Tablet shell is a graphical user interface aimed for tablet-like
63 devices, where usually the only input method is a touch screen.
64 It does not support freely floating windows or many other desktop
65 features, but intends to provide a natural interface on tablets.
66 Tablet shell consists of the shell plugin
68 and the special client
69 .B weston-tablet-shell
70 which provides the basic user interface.
72 .\" ***************************************************************
75 .SS Weston core options:
77 \fB\-\^B\fR\fIbackend.so\fR, \fB\-\-backend\fR=\fIbackend.so\fR
80 instead of the default backend. The file is searched for in
81 .IR "__weston_modules_dir__" ,
82 or you can pass an absolute path. The default backend is
84 unless the environment suggests otherwise, see
85 .IR DISPLAY " and " WAYLAND_DISPLAY .
87 .BR \-\^h ", " \-\-help
88 Print the program version and a summary of command line options, and quit.
90 \fB\-\^i\fR\fIN\fR, \fB\-\-idle\-time\fR=\fIN\fR
91 Set the idle timeout to
93 seconds. The default timeout is 300 seconds. When there has not been any
94 user input for the idle timeout, Weston enters an inactive mode. The
95 screen fades to black, and depending on the shell in use, a screensaver
96 may activate, monitors may switch off, and the shell may lock the session.
98 \fB\-\-log\fR=\fIfile.log\fR
99 Append log messages to the file
101 instead of writing them to stderr.
103 \fB\-\-modules\fR=\fImodule1.so,module2.so\fR
104 Load the comma-separated list of modules. Only used by the test
105 suite. The file is searched for in
106 .IR "__weston_modules_dir__" ,
107 or you can pass an absolute path.
109 \fB\-\^S\fR\fIname\fR, \fB\-\-socket\fR=\fIname\fR
110 Weston will listen in the Wayland socket called
114 with this value in the environment for all child processes to allow them to
115 connect to the right server automatically.
118 Activate XWayland. Weston starts listening on a new X display socket, and
119 exports it in the environment variable
121 When the first X client connects, Weston launches a special X server as a
122 Wayland client to handle the X client and all future X clients.
124 .SS DRM backend options:
126 \fB\-\-connector\fR=\fIconnectorid\fR
130 \fB\-\-seat\fR=\fIseatid\fR
132 \fB\-\-tty\fR=\fItty\fR
134 .SS Wayland backend options:
136 \fB\-\-display\fR=\fIdisplay\fR
137 Name of the Wayland display to connect to, see also
141 \fB\-\-width\fR=\fIW\fR, \fB\-\-height\fR=\fIH\fR
142 Make the desktop size
145 .SS X11 backend options:
150 Do not provide any input devices. Used for testing input-less Weston.
152 \fB\-\-output\-count\fR=\fIN\fR
155 X windows to emulate the same number of outputs.
157 \fB\-\-width\fR=\fIW\fR, \fB\-\-height\fR=\fIH\fR
158 Make the default size of each X window
161 .\" ***************************************************************
164 .\" ***************************************************************
173 is not set, the default backend becomes
177 If set to any value, causes libwayland to print the live protocol
181 The name of the display (socket) of an already running Wayland server, without
182 the path. The directory path is always taken from
183 .BR XDG_RUNTIME_DIR .
186 is not set, the socket name is "wayland-0".
190 is already set, the default backend becomes
191 .IR wayland-backend.so .
192 This allows launching Weston as a nested server.
198 .B WESTON_LAUNCHER_SOCK
205 The directory for Weston's socket and lock files.
206 Wayland clients will automatically use this.
208 .\" ***************************************************************
211 .\" ***************************************************************
213 Bugs should be reported to the freedesktop.org bugzilla at
214 https://bugs.freedesktop.org with product "Wayland" and
217 .\" ***************************************************************
219 http://wayland.freedesktop.org/
221 .\" ***************************************************************
223 .IP "Launch Weston with the DRM backend, directly on a VT"
225 .IP "Launch Weston (wayland-1) nested in another Weston instance (wayland-0)"
226 WAYLAND_DISPLAY=wayland-0 weston -Swayland-1
227 .IP "From an X terminal, launch Weston with the x11 backend"
230 .\" ***************************************************************
232 .\".BR weston-launch (1),
233 .\".BR weston.ini (5)