-.TH WESTON 1 "2012-08-29" "Weston __version__"
+.TH WESTON 1 "2012-11-27" "Weston __version__"
.SH NAME
weston \- the reference Wayland server
.SH SYNOPSIS
.B weston-launch
to set up proper privileged access to devices.
-Weston also supports X clients by 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.
+Weston also supports X clients via
+.BR XWayland ", see below."
.
.\" ***************************************************************
.SH BACKENDS
.TP
.I drm-backend.so
The DRM backend uses Linux KMS for output and evdev devices for input.
-It supports multiple monitors in a unified desktop with DPMS.
+It supports multiple monitors in a unified desktop with DPMS. See
+.BR weston-drm (7),
+if installed.
.TP
.I wayland-backend.so
The Wayland backend runs on another Wayland server, a different Weston
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.
+
+It has also its own X window manager where cursor themes and sizes can be
+chosen using
+.BR XCURSOR_PATH
+and
+.BR XCURSOR_SIZE " environment variables. See " ENVIRONMENT .
+.
+.\" ***************************************************************
.SH OPTIONS
.
.SS Weston core options:
instead of the default backend. The file is searched for in
.IR "__weston_modules_dir__" ,
or you can pass an absolute path. The default backend is
-.I drm-backend.so
+.I __weston_native_backend__
unless the environment suggests otherwise, see
.IR DISPLAY " and " WAYLAND_DISPLAY .
.TP
+.BR \-\-version
+Print the program version.
+.TP
.BR \-\^h ", " \-\-help
-Print the program version and a summary of command line options, and quit.
+Print a summary of command line options, and quit.
.TP
\fB\-\^i\fR\fIN\fR, \fB\-\-idle\-time\fR=\fIN\fR
Set the idle timeout to
user input for the idle timeout, Weston enters an inactive mode. The
screen fades to black, and depending on the shell in use, a screensaver
may activate, monitors may switch off, and the shell may lock the session.
+A value of 0 effectively disables the timeout.
.TP
\fB\-\-log\fR=\fIfile.log\fR
Append log messages to the file
.IR "__weston_modules_dir__" ,
or you can pass an absolute path.
.TP
+.BR \-\-no-config
+Do not read
+.I weston.ini
+for the compositor. Avoids e.g. loading compositor modules via the
+configuration file, which is useful for unit tests.
+.TP
\fB\-\^S\fR\fIname\fR, \fB\-\-socket\fR=\fIname\fR
Weston will listen in the Wayland socket called
.IR name .
.B WAYLAND_DISPLAY
with this value in the environment for all child processes to allow them to
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:
-.TP
-\fB\-\-connector\fR=\fIconnectorid\fR
-.TP
-.B \-\-current\-mode
-.TP
-\fB\-\-seat\fR=\fIseatid\fR
-.TP
-\fB\-\-tty\fR=\fItty\fR
+See
+.BR weston-drm (7).
.
.SS Wayland backend options:
.TP
.I WAYLAND_DISPLAY
of the environment.
.TP
+.B \-\-fullscreen
+Create a single fullscreen output
+.TP
+\fB\-\-output\-count\fR=\fIN\fR
+Create
+.I N
+Wayland windows to emulate the same number of outputs.
+.TP
\fB\-\-width\fR=\fIW\fR, \fB\-\-height\fR=\fIH\fR
-Make the desktop size
+Make all outputs have a size of
.IR W x H " pixels."
+.TP
+.B \-\-scale\fR=\fIN\fR
+Give all outputs a scale factor of
+.I N.
+.TP
+.B \-\-use\-pixman
+Use the pixman renderer. By default, weston will try to use EGL and
+GLES2 for rendering and will fall back to the pixman-based renderer for
+software compositing if EGL cannot be used. Passing this option will force
+weston to use the pixman renderer.
.
.SS X11 backend options:
.TP
\fB\-\-width\fR=\fIW\fR, \fB\-\-height\fR=\fIH\fR
Make the default size of each X window
.IR W x H " pixels."
+.TP
+.B \-\-scale\fR=\fIN\fR
+Give all outputs a scale factor of
+.I N.
+.TP
+.B \-\-use\-pixman
+Use the pixman renderer. By default weston will try to use EGL and
+GLES2 for rendering. Passing this option will make weston use the
+pixman library for software compsiting.
.
.\" ***************************************************************
.SH FILES
.
+If the environment variable is set, the configuration file is read
+from the respective path, or the current directory if neither is set.
+.PP
+.BI $XDG_CONFIG_HOME /weston.ini
+.br
+.BI $HOME /.config/weston.ini
+.br
+.I ./weston.ini
+.br
+.
.\" ***************************************************************
.SH ENVIRONMENT
.
This allows launching Weston as a nested server.
.TP
.B WAYLAND_SOCKET
+For Wayland clients, holds the file descriptor of an open local socket
+to a Wayland server.
.TP
-.B WESTON_TTY_FD
-.TP
-.B WESTON_LAUNCHER_SOCK
+.B XCURSOR_PATH
+Set the list of paths to look for cursors in. It changes both
+libwayland-cursor and libXcursor, so it affects both Wayland and X11 based
+clients. See
+.B xcursor
+(3).
.TP
.B XCURSOR_SIZE
+This variable can be set for choosing an specific size of cursor. Affect
+Wayland and X11 clients. See
+.B xcursor
+(3).
.TP
.B XDG_CONFIG_HOME
+If set, specifies the directory where to look for
+.BR weston.ini .
.TP
.B XDG_RUNTIME_DIR
The directory for Weston's socket and lock files.
.
.\" ***************************************************************
.SH DIAGNOSTICS
+Weston has a segmentation fault handler, that attempts to restore
+the virtual console or ungrab X before raising
+.BR SIGTRAP .
+If you run
+.BR weston " under " gdb (1)
+from an X11 terminal or a different virtual terminal, and tell gdb
+.IP
+handle SIGSEGV nostop
+.PP
+This will allow weston to switch back to gdb on crash and then
+gdb will catch the crash with SIGTRAP.
.
.\" ***************************************************************
.SH BUGS
.
.\" ***************************************************************
.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
+.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)"
WAYLAND_DISPLAY=wayland-0 weston -Swayland-1
.IP "From an X terminal, launch Weston with the x11 backend"
weston
.
.\" ***************************************************************
-.\".SH "SEE ALSO"
+.SH "SEE ALSO"
+.BR weston-drm (7)
.\".BR weston-launch (1),
.\".BR weston.ini (5)
projects / profile / ivi / weston-ivi-shell.git / blobdiff