man/weston.man

   1 .TH WESTON 1 "2012-08-29" "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 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
  29 stack.
  30 .
  31 .\" ***************************************************************
  32 .SH BACKENDS
  33 .TP
  34 .I drm-backend.so
  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.
  37 .TP
  38 .I wayland-backend.so
  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
  41 the parent server.
  42 .TP
  43 .I x11-backend.so
  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.
  47 .
  48 .\" ***************************************************************
  49 .SH SHELLS
  50 .TP
  51 Desktop shell
  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
  55 shell plugin
  56 .I desktop-shell.so
  57 and the special client
  58 .B weston-desktop-shell
  59 which provides the wallpaper, panel, and screen locking dialog.
  60 .TP
  61 Tablet shell
  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
  67 .I tablet-shell.so
  68 and the special client
  69 .B weston-tablet-shell
  70 which provides the basic user interface.
  71 .
  72 .\" ***************************************************************
  73 .SH OPTIONS
  74 .
  75 .SS Weston core options:
  76 .TP
  77 \fB\-\^B\fR\fIbackend.so\fR, \fB\-\-backend\fR=\fIbackend.so\fR
  78 Load
  79 .I backend.so
  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
  83 .I drm-backend.so
  84 unless the environment suggests otherwise, see
  85 .IR DISPLAY " and " WAYLAND_DISPLAY .
  86 .TP
  87 .BR \-\^h ", " \-\-help
  88 Print the program version and a summary of command line options, and quit.
  89 .TP
  90 \fB\-\^i\fR\fIN\fR, \fB\-\-idle\-time\fR=\fIN\fR
  91 Set the idle timeout to
  92 .I N
  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.
  97 .TP
  98 \fB\-\-log\fR=\fIfile.log\fR
  99 Append log messages to the file
 100 .I file.log
 101 instead of writing them to stderr.
 102 .TP
 103 \fB\-\-module\fR=\fImodule.so\fR
 104 Load a generic plugin module \fImodule.so\fR. 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.
 108 .TP
 109 \fB\-\^S\fR\fIname\fR, \fB\-\-socket\fR=\fIname\fR
 110 Weston will listen in the Wayland socket called
 111 .IR name .
 112 Weston will export
 113 .B WAYLAND_DISPLAY
 114 with this value in the environment for all child processes to allow them to
 115 connect to the right server automatically.
 116 .TP
 117 .B \-\-xserver
 118 Activate XWayland. Weston starts listening on a new X display socket, and
 119 exports it in the environment variable
 120 .BR DISPLAY .
 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.
 123 .
 124 .SS DRM backend options:
 125 .TP
 126 \fB\-\-connector\fR=\fIconnectorid\fR
 127 .TP
 128 .B \-\-current\-mode
 129 .TP
 130 \fB\-\-seat\fR=\fIseatid\fR
 131 .TP
 132 \fB\-\-tty\fR=\fItty\fR
 133 .
 134 .SS Wayland backend options:
 135 .TP
 136 \fB\-\-display\fR=\fIdisplay\fR
 137 Name of the Wayland display to connect to, see also
 138 .I WAYLAND_DISPLAY
 139 of the environment.
 140 .TP
 141 \fB\-\-width\fR=\fIW\fR, \fB\-\-height\fR=\fIH\fR
 142 Make the desktop size
 143 .IR W x H " pixels."
 144 .
 145 .SS X11 backend options:
 146 .TP
 147 .B \-\-fullscreen
 148 .TP
 149 .B \-\-no\-input
 150 Do not provide any input devices. Used for testing input-less Weston.
 151 .TP
 152 \fB\-\-output\-count\fR=\fIN\fR
 153 Create
 154 .I N
 155 X windows to emulate the same number of outputs.
 156 .TP
 157 \fB\-\-width\fR=\fIW\fR, \fB\-\-height\fR=\fIH\fR
 158 Make the default size of each X window
 159 .IR W x H " pixels."
 160 .
 161 .\" ***************************************************************
 162 .SH FILES
 163 .
 164 .\" ***************************************************************
 165 .SH ENVIRONMENT
 166 .
 167 .TP
 168 .B DISPLAY
 169 The X display. If
 170 .B DISPLAY
 171 is set, and
 172 .B WAYLAND_DISPLAY
 173 is not set, the default backend becomes
 174 .IR x11-backend.so .
 175 .TP
 176 .B WAYLAND_DEBUG
 177 If set to any value, causes libwayland to print the live protocol
 178 to stderr.
 179 .TP
 180 .B WAYLAND_DISPLAY
 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 .
 184 If
 185 .B WAYLAND_DISPLAY
 186 is not set, the socket name is "wayland-0".
 187
 188 If
 189 .B WAYLAND_DISPLAY
 190 is already set, the default backend becomes
 191 .IR wayland-backend.so .
 192 This allows launching Weston as a nested server.
 193 .TP
 194 .B WAYLAND_SOCKET
 195 .TP
 196 .B WESTON_TTY_FD
 197 .TP
 198 .B WESTON_LAUNCHER_SOCK
 199 .TP
 200 .B XCURSOR_SIZE
 201 .TP
 202 .B XDG_CONFIG_HOME
 203 .TP
 204 .B XDG_RUNTIME_DIR
 205 The directory for Weston's socket and lock files.
 206 Wayland clients will automatically use this.
 207 .
 208 .\" ***************************************************************
 209 .SH DIAGNOSTICS
 210 .
 211 .\" ***************************************************************
 212 .SH BUGS
 213 Bugs should be reported to the freedesktop.org bugzilla at
 214 https://bugs.freedesktop.org with product "Wayland" and
 215 component "weston".
 216 .
 217 .\" ***************************************************************
 218 .SH WWW
 219 http://wayland.freedesktop.org/
 220 .
 221 .\" ***************************************************************
 222 .SH EXAMPLES
 223 .IP "Launch Weston with the DRM backend, directly on a VT"
 224 weston-launch
 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"
 228 weston
 229 .
 230 .\" ***************************************************************
 231 .\".SH "SEE ALSO"
 232 .\".BR weston-launch (1),
 233 .\".BR weston.ini (5)