man/weston.man

   1 .TH WESTON 1 "2012-09-13" "Weston __version__"
   2 .SH NAME
   3 weston \- the reference Wayland server
   4 .SH SYNOPSIS
   5 .B weston
   6 .
   7 .\" ***************************************************************
   8 .SH DESCRIPTION
   9 .B weston
  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
  14 instance.
  15
  16 Weston supports fundamentally different graphical user interface paradigms via
  17 shell plugins. Two plugins are provided: the desktop shell, and the tablet
  18 shell.
  19
  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
  22 .B weston-launch
  23 to set up proper privileged access to devices.
  24
  25 Weston also supports X clients via
  26 .BR XWayland ", see below."
  27 .
  28 .\" ***************************************************************
  29 .SH BACKENDS
  30 .TP
  31 .I drm-backend.so
  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.
  34 .TP
  35 .I wayland-backend.so
  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
  38 the parent server.
  39 .TP
  40 .I x11-backend.so
  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.
  44 .
  45 .\" ***************************************************************
  46 .SH SHELLS
  47 .TP
  48 Desktop shell
  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
  52 shell plugin
  53 .I desktop-shell.so
  54 and the special client
  55 .B weston-desktop-shell
  56 which provides the wallpaper, panel, and screen locking dialog.
  57 .TP
  58 Tablet shell
  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
  64 .I tablet-shell.so
  65 and the special client
  66 .B weston-tablet-shell
  67 which provides the basic user interface.
  68 .
  69 .\" ***************************************************************
  70 .SH XWAYLAND
  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
  74 Wayland stack.
  75
  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
  79 environment variable
  80 .BR DISPLAY .
  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.
  83 .
  84 .\" ***************************************************************
  85 .SH OPTIONS
  86 .
  87 .SS Weston core options:
  88 .TP
  89 \fB\-\^B\fR\fIbackend.so\fR, \fB\-\-backend\fR=\fIbackend.so\fR
  90 Load
  91 .I backend.so
  92 instead of the default backend. The file is searched for in
  93 .IR "__weston_modules_dir__" ,
  94 or you can pass an absolute path. The default backend is
  95 .I drm-backend.so
  96 unless the environment suggests otherwise, see
  97 .IR DISPLAY " and " WAYLAND_DISPLAY .
  98 .TP
  99 .BR \-\^h ", " \-\-help
 100 Print the program version and a summary of command line options, and quit.
 101 .TP
 102 \fB\-\^i\fR\fIN\fR, \fB\-\-idle\-time\fR=\fIN\fR
 103 Set the idle timeout to
 104 .I N
 105 seconds. The default timeout is 300 seconds. When there has not been any
 106 user input for the idle timeout, Weston enters an inactive mode. The
 107 screen fades to black, and depending on the shell in use, a screensaver
 108 may activate, monitors may switch off, and the shell may lock the session.
 109 .TP
 110 \fB\-\-log\fR=\fIfile.log\fR
 111 Append log messages to the file
 112 .I file.log
 113 instead of writing them to stderr.
 114 .TP
 115 \fB\-\-modules\fR=\fImodule1.so,module2.so\fR
 116 Load the comma-separated list of modules. Only used by the test
 117 suite. The file is searched for in
 118 .IR "__weston_modules_dir__" ,
 119 or you can pass an absolute path.
 120 .TP
 121 \fB\-\^S\fR\fIname\fR, \fB\-\-socket\fR=\fIname\fR
 122 Weston will listen in the Wayland socket called
 123 .IR name .
 124 Weston will export
 125 .B WAYLAND_DISPLAY
 126 with this value in the environment for all child processes to allow them to
 127 connect to the right server automatically.
 128 .SS DRM backend options:
 129 .TP
 130 \fB\-\-connector\fR=\fIconnectorid\fR
 131 .TP
 132 .B \-\-current\-mode
 133 .TP
 134 \fB\-\-seat\fR=\fIseatid\fR
 135 .TP
 136 \fB\-\-tty\fR=\fItty\fR
 137 .
 138 .SS Wayland backend options:
 139 .TP
 140 \fB\-\-display\fR=\fIdisplay\fR
 141 Name of the Wayland display to connect to, see also
 142 .I WAYLAND_DISPLAY
 143 of the environment.
 144 .TP
 145 \fB\-\-width\fR=\fIW\fR, \fB\-\-height\fR=\fIH\fR
 146 Make the desktop size
 147 .IR W x H " pixels."
 148 .
 149 .SS X11 backend options:
 150 .TP
 151 .B \-\-fullscreen
 152 .TP
 153 .B \-\-no\-input
 154 Do not provide any input devices. Used for testing input-less Weston.
 155 .TP
 156 \fB\-\-output\-count\fR=\fIN\fR
 157 Create
 158 .I N
 159 X windows to emulate the same number of outputs.
 160 .TP
 161 \fB\-\-width\fR=\fIW\fR, \fB\-\-height\fR=\fIH\fR
 162 Make the default size of each X window
 163 .IR W x H " pixels."
 164 .
 165 .\" ***************************************************************
 166 .SH FILES
 167 .
 168 .\" ***************************************************************
 169 .SH ENVIRONMENT
 170 .
 171 .TP
 172 .B DISPLAY
 173 The X display. If
 174 .B DISPLAY
 175 is set, and
 176 .B WAYLAND_DISPLAY
 177 is not set, the default backend becomes
 178 .IR x11-backend.so .
 179 .TP
 180 .B WAYLAND_DEBUG
 181 If set to any value, causes libwayland to print the live protocol
 182 to stderr.
 183 .TP
 184 .B WAYLAND_DISPLAY
 185 The name of the display (socket) of an already running Wayland server, without
 186 the path. The directory path is always taken from
 187 .BR XDG_RUNTIME_DIR .
 188 If
 189 .B WAYLAND_DISPLAY
 190 is not set, the socket name is "wayland-0".
 191
 192 If
 193 .B WAYLAND_DISPLAY
 194 is already set, the default backend becomes
 195 .IR wayland-backend.so .
 196 This allows launching Weston as a nested server.
 197 .TP
 198 .B WAYLAND_SOCKET
 199 .TP
 200 .B WESTON_TTY_FD
 201 .TP
 202 .B WESTON_LAUNCHER_SOCK
 203 .TP
 204 .B XCURSOR_SIZE
 205 .TP
 206 .B XDG_CONFIG_HOME
 207 .TP
 208 .B XDG_RUNTIME_DIR
 209 The directory for Weston's socket and lock files.
 210 Wayland clients will automatically use this.
 211 .
 212 .\" ***************************************************************
 213 .SH DIAGNOSTICS
 214 .
 215 .\" ***************************************************************
 216 .SH BUGS
 217 Bugs should be reported to the freedesktop.org bugzilla at
 218 https://bugs.freedesktop.org with product "Wayland" and
 219 component "weston".
 220 .
 221 .\" ***************************************************************
 222 .SH WWW
 223 http://wayland.freedesktop.org/
 224 .
 225 .\" ***************************************************************
 226 .SH EXAMPLES
 227 .IP "Launch Weston with the DRM backend on a VT"
 228 weston-launch
 229 .IP "Launch Weston with the DRM backend and XWayland support"
 230 weston-launch -- --modules=xwayland.so
 231 .IP "Launch Weston (wayland-1) nested in another Weston instance (wayland-0)"
 232 WAYLAND_DISPLAY=wayland-0 weston -Swayland-1
 233 .IP "From an X terminal, launch Weston with the x11 backend"
 234 weston
 235 .
 236 .\" ***************************************************************
 237 .\".SH "SEE ALSO"
 238 .\".BR weston-launch (1),
 239 .\".BR weston.ini (5)