summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
Diffstat (limited to 'man')
-rw-r--r--man/.gitignore1
-rw-r--r--man/Makefile.am11
-rw-r--r--man/weston-drm.man130
-rw-r--r--man/weston.man21
4 files changed, 147 insertions, 16 deletions
diff --git a/man/.gitignore b/man/.gitignore
index 52eaf2bc..dfabd622 100644
--- a/man/.gitignore
+++ b/man/.gitignore
@@ -1,2 +1,3 @@
weston.1
+weston-drm.7
diff --git a/man/Makefile.am b/man/Makefile.am
index 4ff6bc7d..8933f1c9 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -1,15 +1,22 @@
man_MANS = weston.1
+if ENABLE_DRM_COMPOSITOR
+man_MANS += weston-drm.7
+endif
+
MAN_SUBSTS = \
-e 's|__weston_native_backend__|$(WESTON_NATIVE_BACKEND)|g' \
-e 's|__weston_modules_dir__|$(pkglibdir)|g' \
-e 's|__version__|$(PACKAGE_VERSION)|g'
-SUFFIXES = .1 .man
+SUFFIXES = .1 .7 .man
.man.1:
$(AM_V_GEN)$(SED) $(MAN_SUBSTS) < $< > $@
-EXTRA_DIST = weston.man
+.man.7:
+ $(AM_V_GEN)$(SED) $(MAN_SUBSTS) < $< > $@
+
+EXTRA_DIST = weston.man weston-drm.man
CLEANFILES = $(man_MANS)
diff --git a/man/weston-drm.man b/man/weston-drm.man
new file mode 100644
index 00000000..35d62ae6
--- /dev/null
+++ b/man/weston-drm.man
@@ -0,0 +1,130 @@
+.TH WESTON-DRM 7 "2012-11-27" "Weston __version__"
+.SH NAME
+weston-drm \- the DRM backend for Weston
+.SH SYNOPSIS
+.B weston-launch
+.LP
+.B weston --backend=drm-backend.so
+.
+.\" ***************************************************************
+.SH DESCRIPTION
+The DRM backend is the native Weston backend for systems that support
+the Linux kernel DRM, kernel mode setting (KMS), and evdev input devices.
+It is the recommended backend for desktop PCs, and aims to provide
+the full Wayland experience with the "every frame is perfect" concept.
+It also relies on the Mesa GBM interface.
+
+With the DRM backend,
+.B weston
+runs without any underlying windowing system. The backend uses the
+Linux KMS API to detect connected monitors. Monitor hot-plugging is
+supported. Input devices are found automatically by
+.BR udev (7).
+Compositing happens mainly in GL\ ES\ 2, initialized through EGL. It
+is also possible to take advantage of hardware cursors and overlays,
+when they exist and are functional. Full-screen surfaces will be
+scanned out directly without compositing, when possible.
+Hardware accelerated clients are supported via EGL.
+
+The backend chooses the DRM graphics device first based on seat id.
+If seat identifiers are not set, it looks for the graphics device
+that was used in boot. If that is not found, it finally chooses
+the first DRM device returned by
+.BR udev (7).
+Combining multiple graphics devices are not supported yet.
+
+The DRM backend relies on
+.B weston-launch
+for managing input device access and DRM master status, so that
+.B weston
+can be run without root privileges. On switching away from the
+virtual terminal (VT) hosting Weston, all input devices are closed and
+the DRM master capability is dropped, so that other servers,
+including
+.BR Xorg (1),
+can run on other VTs. On switching back to Weston's VT, input devices
+and DRM master are re-acquired through the parent process
+.BR weston-launch .
+.
+.\" ***************************************************************
+.SH CONFIGURATION
+.
+The DRM backend uses the following entries from
+.BR weston.ini .
+.SS Section output
+.TP
+\fBname\fR=\fIconnector\fR
+The KMS connector name identifying the output, for instance
+.IR LVDS1 .
+.TP
+\fBmode\fR=\fImode\fR
+Specify the video mode for the output. The argument
+.I mode
+can be one of the words
+.BR off " to turn the output off, "
+.BR preferred " to use the monitor's preferred video mode, or "
+.BR current " to use the current video mode and avoid a mode switch."
+It can also be a resolution as
+\fIwidth\fBx\fIheight\fR, or a detailed mode line as below.
+.TP
+\fBmode\fR=\fIdotclock hdisp hsyncstart hsyncend htotal \
+vdisp vsyncstart vsyncend vtotal hflag vflag\fR
+Use the given detailed mode line as the video mode for this output.
+The definition is the same as in
+.BR xorg.conf "(5), and " cvt (1)
+can generate detailed mode lines.
+.TP
+\fBtransform\fR=\fItransform\fR
+Transform for the output, which can be rotated in 90-degree steps
+and possibly flipped. Possible values are
+.BR normal ", " 90 ", " 180 ", " 270 ", "
+.BR flipped ", " flipped-90 ", " flipped-180 ", and " flipped-270 .
+.
+.\" ***************************************************************
+.SH OPTIONS
+.
+When the DRM backend is loaded,
+.B weston
+will understand the following additional command line options.
+.TP
+\fB\-\-connector\fR=\fIconnectorid\fR
+Use the connector with id number
+.I connectorid
+as the only initial output.
+.TP
+.B \-\-current\-mode
+By default, use the current video mode of all outputs, instead of
+switching to the monitor preferred mode.
+.TP
+\fB\-\-seat\fR=\fIseatid\fR
+Use graphics and input devices designated for seat
+.I seatid
+instead of the default seat
+.BR seat0 .
+.TP
+\fB\-\-tty\fR=\fIx\fR
+Launch Weston on tty
+.I x
+instead of using the current tty.
+.
+.\" ***************************************************************
+.SH ENVIRONMENT
+.
+.TP
+.B WESTON_TTY_FD
+The file descriptor (integer) of the opened tty where
+.B weston
+will run. Set by
+.BR weston-launch .
+.TP
+.B WESTON_LAUNCHER_SOCK
+The file descriptor (integer) where
+.B weston-launch
+is listening. Automatically set by
+.BR weston-launch .
+.
+.\" ***************************************************************
+.SH "SEE ALSO"
+.BR weston (1)
+.\".BR weston-launch (1),
+.\".BR weston.ini (5)
diff --git a/man/weston.man b/man/weston.man
index efb6d2b4..1bf87d88 100644
--- a/man/weston.man
+++ b/man/weston.man
@@ -30,7 +30,9 @@ Weston also supports X clients via
.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
@@ -132,14 +134,8 @@ Weston will export
with this value in the environment for all child processes to allow them to
connect to the right server automatically.
.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
@@ -203,10 +199,6 @@ This allows launching Weston as a nested server.
.TP
.B WAYLAND_SOCKET
.TP
-.B WESTON_TTY_FD
-.TP
-.B WESTON_LAUNCHER_SOCK
-.TP
.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
@@ -251,6 +243,7 @@ WAYLAND_DISPLAY=wayland-0 weston -Swayland-1
weston
.
.\" ***************************************************************
-.\".SH "SEE ALSO"
+.SH "SEE ALSO"
+.BR weston-drm (7)
.\".BR weston-launch (1),
.\".BR weston.ini (5)