man/weston-drm.man

   1 .TH WESTON-DRM 7 "2012-11-27" "Weston __version__"
   2 .SH NAME
   3 weston-drm \- the DRM backend for Weston
   4 .SH SYNOPSIS
   5 .B weston-launch
   6 .LP
   7 .B weston --backend=drm-backend.so
   8 .
   9 .\" ***************************************************************
  10 .SH DESCRIPTION
  11 The DRM backend is the native Weston backend for systems that support
  12 the Linux kernel DRM, kernel mode setting (KMS), and evdev input devices.
  13 It is the recommended backend for desktop PCs, and aims to provide
  14 the full Wayland experience with the "every frame is perfect" concept.
  15 It also relies on the Mesa GBM interface.
  16
  17 With the DRM backend,
  18 .B weston
  19 runs without any underlying windowing system. The backend uses the
  20 Linux KMS API to detect connected monitors. Monitor hot-plugging is
  21 supported. Input devices are found automatically by
  22 .BR udev (7).
  23 Compositing happens mainly in GL\ ES\ 2, initialized through EGL. It
  24 is also possible to take advantage of hardware cursors and overlays,
  25 when they exist and are functional. Full-screen surfaces will be
  26 scanned out directly without compositing, when possible.
  27 Hardware accelerated clients are supported via EGL.
  28
  29 The backend chooses the DRM graphics device first based on seat id.
  30 If seat identifiers are not set, it looks for the graphics device
  31 that was used in boot. If that is not found, it finally chooses
  32 the first DRM device returned by
  33 .BR udev (7).
  34 Combining multiple graphics devices are not supported yet.
  35
  36 The DRM backend relies on
  37 .B weston-launch
  38 for managing input device access and DRM master status, so that
  39 .B weston
  40 can be run without root privileges. On switching away from the
  41 virtual terminal (VT) hosting Weston, all input devices are closed and
  42 the DRM master capability is dropped, so that other servers,
  43 including
  44 .BR Xorg (1),
  45 can run on other VTs. On switching back to Weston's VT, input devices
  46 and DRM master are re-acquired through the parent process
  47 .BR weston-launch .
  48 .
  49 .\" ***************************************************************
  50 .SH CONFIGURATION
  51 .
  52 The DRM backend uses the following entries from
  53 .BR weston.ini .
  54 .SS Section output
  55 .TP
  56 \fBname\fR=\fIconnector\fR
  57 The KMS connector name identifying the output, for instance
  58 .IR LVDS1 .
  59 .TP
  60 \fBmode\fR=\fImode\fR
  61 Specify the video mode for the output. The argument
  62 .I mode
  63 can be one of the words
  64 .BR off " to turn the output off, "
  65 .BR preferred " to use the monitor's preferred video mode, or "
  66 .BR current " to use the current video mode and avoid a mode switch."
  67 It can also be a resolution as
  68 \fIwidth\fBx\fIheight\fR, or a detailed mode line as below.
  69 .TP
  70 \fBmode\fR=\fIdotclock hdisp hsyncstart hsyncend htotal \
  71 vdisp vsyncstart vsyncend vtotal hflag vflag\fR
  72 Use the given detailed mode line as the video mode for this output.
  73 The definition is the same as in
  74 .BR xorg.conf "(5), and " cvt (1)
  75 can generate detailed mode lines.
  76 .TP
  77 \fBtransform\fR=\fItransform\fR
  78 Transform for the output, which can be rotated in 90-degree steps
  79 and possibly flipped. Possible values are
  80 .BR normal ", " 90 ", " 180 ", " 270 ", "
  81 .BR flipped ", " flipped-90 ", " flipped-180 ", and " flipped-270 .
  82 .
  83 .\" ***************************************************************
  84 .SH OPTIONS
  85 .
  86 When the DRM backend is loaded,
  87 .B weston
  88 will understand the following additional command line options.
  89 .TP
  90 \fB\-\-connector\fR=\fIconnectorid\fR
  91 Use the connector with id number
  92 .I connectorid
  93 as the only initial output.
  94 .TP
  95 .B \-\-current\-mode
  96 By default, use the current video mode of all outputs, instead of
  97 switching to the monitor preferred mode.
  98 .TP
  99 \fB\-\-seat\fR=\fIseatid\fR
 100 Use graphics and input devices designated for seat
 101 .I seatid
 102 instead of the default seat
 103 .BR seat0 .
 104 .TP
 105 \fB\-\-tty\fR=\fIx\fR
 106 Launch Weston on tty
 107 .I x
 108 instead of using the current tty.
 109 .
 110 .\" ***************************************************************
 111 .SH ENVIRONMENT
 112 .
 113 .TP
 114 .B WESTON_TTY_FD
 115 The file descriptor (integer) of the opened tty where
 116 .B weston
 117 will run. Set by
 118 .BR weston-launch .
 119 .TP
 120 .B WESTON_LAUNCHER_SOCK
 121 The file descriptor (integer) where
 122 .B weston-launch
 123 is listening. Automatically set by
 124 .BR weston-launch .
 125 .
 126 .\" ***************************************************************
 127 .SH "SEE ALSO"
 128 .BR weston (1)
 129 .\".BR weston-launch (1),
 130 .\".BR weston.ini (5)