compositor: add --no-config command line option

[profile/ivi/weston-ivi-shell.git] / man / weston.man

diff --git a/man/weston.man b/man/weston.man
index 1bf87d8..735235f 100644 (file)
--- a/man/weston.man
+++ b/man/weston.man
@@ -1,4 +1,4 @@
-.TH WESTON 1 "2012-09-13" "Weston __version__"
+.TH WESTON 1 "2012-11-27" "Weston __version__"
 .SH NAME
 weston \- the reference Wayland server
 .SH SYNOPSIS
@@ -104,8 +104,11 @@ or you can pass an absolute path. The default backend is
 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
@@ -114,6 +117,7 @@ seconds. The default timeout is 300 seconds. When there has not been any
 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
@@ -126,6 +130,12 @@ suite. The file is searched for in
 .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 .
@@ -144,9 +154,27 @@ Name of the Wayland display to connect to, see also
 .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
@@ -163,10 +191,29 @@ X windows to emulate the same number of outputs.
 \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
 .
@@ -198,6 +245,8 @@ is already set, the default backend becomes
 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 XCURSOR_PATH
 Set the list of paths to look for cursors in. It changes both
@@ -213,6 +262,8 @@ Wayland and X11 clients. See
 (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.
@@ -220,6 +271,17 @@ Wayland clients will automatically use this.
 .
 .\" ***************************************************************
 .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