@ -1,4 +1,4 @@
.TH WESTON 1 "2012-08-2 9" "Weston __version__"
.TH WESTON 1 "2012-09-13 " "Weston __version__"
.SH NAME
.SH NAME
weston \- the reference Wayland server
weston \- the reference Wayland server
.SH SYNOPSIS
.SH SYNOPSIS
@ -22,11 +22,8 @@ under another Wayland server), it should be done with the command
.B weston-launch
.B weston-launch
to set up proper privileged access to devices.
to set up proper privileged access to devices.
Weston also supports X clients by XWayland. XWayland requires a special
Weston also supports X clients via
X.org server to be installed. This X server will connect to a Wayland
.BR XWayland ", see below."
server as a Wayland client, and X clients will connect to the X server.
XWayland provides backwards compatibility to X applications in a Wayland
stack.
.
.
. \" ***************************************************************
. \" ***************************************************************
.SH BACKENDS
.SH BACKENDS
@ -70,6 +67,21 @@ and the special client
which provides the basic user interface.
which provides the basic user interface.
.
.
. \" ***************************************************************
. \" ***************************************************************
.SH XWAYLAND
XWayland requires a special X.org server to be installed. This X server will
connect to a Wayland server as a Wayland client, and X clients will connect to
the X server. XWayland provides backwards compatibility to X applications in a
Wayland stack.
XWayland is activated by instructing
.BR weston " to load " xwayland.so " module, see " EXAMPLES .
Weston starts listening on a new X display socket, and exports it in the
environment variable
.BR DISPLAY .
When the first X client connects, Weston launches a special X server as a
Wayland client to handle the X client and all future X clients.
.
. \" ***************************************************************
.SH OPTIONS
.SH OPTIONS
.
.
.SS Weston core options:
.SS Weston core options:
@ -113,14 +125,6 @@ Weston will export
.B WAYLAND_DISPLAY
.B WAYLAND_DISPLAY
with this value in the environment for all child processes to allow them to
with this value in the environment for all child processes to allow them to
connect to the right server automatically.
connect to the right server automatically.
.TP
.B \- \- xserver
Activate XWayland. Weston starts listening on a new X display socket, and
exports it in the environment variable
.BR DISPLAY .
When the first X client connects, Weston launches a special X server as a
Wayland client to handle the X client and all future X clients.
.
.SS DRM backend options:
.SS DRM backend options:
.TP
.TP
\fB \- \- connector\fR =\fI connectorid\fR
\fB \- \- connector\fR =\fI connectorid\fR
@ -220,8 +224,10 @@ http://wayland.freedesktop.org/
.
.
. \" ***************************************************************
. \" ***************************************************************
.SH EXAMPLES
.SH EXAMPLES
.IP "Launch Weston with the DRM backend, directly on a VT"
.IP "Launch Weston with the DRM backend on a VT"
weston-launch
weston-launch
.IP "Launch Weston with the DRM backend and XWayland support"
weston-launch -- --modules=xwayland.so
.IP "Launch Weston (wayland-1) nested in another Weston instance (wayland-0)"
.IP "Launch Weston (wayland-1) nested in another Weston instance (wayland-0)"
WAYLAND_DISPLAY=wayland-0 weston -Swayland-1
WAYLAND_DISPLAY=wayland-0 weston -Swayland-1
.IP "From an X terminal, launch Weston with the x11 backend"
.IP "From an X terminal, launch Weston with the x11 backend"