summaryrefslogtreecommitdiffstats
path: root/src/compositor/doc/src/qtwaylandcompositor-overview.qdoc
diff options
context:
space:
mode:
authorLiang Qi <liang.qi@qt.io>2016-08-28 10:09:27 +0200
committerPaul Olav Tvete <paul.tvete@gmail.com>2016-08-28 10:12:09 +0200
commitb0c416dede8b6ca596eb2a13361d98613e8c9533 (patch)
treeadddaa3622e0013858355ad6994c8e6e892ce254 /src/compositor/doc/src/qtwaylandcompositor-overview.qdoc
parent9610eccdf237c5ffc21630cee9c364d0fe871901 (diff)
parentae9bfd29b42156fb8f04dfa60b9e48ce10ebacb8 (diff)
Merge remote-tracking branch 'qt/5.7' into 5.8v5.8.0-alpha1
Conflicts: src/compositor/compositor_api/qwaylandseat.cpp src/compositor/compositor_api/qwaylandview.cpp tests/auto/compositor/compositor.pro tests/auto/compositor/compositor/testinputdevice.cpp tests/auto/compositor/compositor/testinputdevice.h tests/auto/compositor/testinputdevice.cpp tests/auto/compositor/testinputdevice.h tests/auto/compositor/testseat.cpp tests/auto/compositor/testseat.h Change-Id: I98e045908dd964e5d4120bd35e71b8839c0d923a
Diffstat (limited to 'src/compositor/doc/src/qtwaylandcompositor-overview.qdoc')
-rw-r--r--src/compositor/doc/src/qtwaylandcompositor-overview.qdoc34
1 files changed, 20 insertions, 14 deletions
diff --git a/src/compositor/doc/src/qtwaylandcompositor-overview.qdoc b/src/compositor/doc/src/qtwaylandcompositor-overview.qdoc
index 9811d5205..d2f0f6f40 100644
--- a/src/compositor/doc/src/qtwaylandcompositor-overview.qdoc
+++ b/src/compositor/doc/src/qtwaylandcompositor-overview.qdoc
@@ -30,25 +30,31 @@
\title Qt Wayland Compositor
\brief An API to develop display servers supporting the Wayland protocol
- Qt Wayland Compositor is a module consisting of QML and C++ APIs for developing
- custom display servers based on the \l{http://wayland.freedesktop.org}{Wayland protocol}.
- The server displays content from client applications that support the Wayland protocol.
+ Qt Wayland Compositor is a module that provides QML and C++ APIs for
+ developing custom display servers based on the
+ \l{http://wayland.freedesktop.org}{Wayland protocol}. The server displays
+ content from client applications that support the Wayland protocol.
\section1 Environment Variables and Command-line Arguments
- The Qt Wayland Compositor API recognizes some environment variables and command-line arguments
- that can be used to customize its behavior.
+ The Qt Wayland Compositor API recognizes some environment variables and
+ command-line arguments that can be used to customize its behavior.
- The environment variables:
\list
- \li QT_WAYLAND_HARDWARE_INTEGRATION Selects which hardware integration plugin to use.
- \li QT_WAYLAND_CLIENT_BUFFER_INTEGRATION Selects which client buffer integration plugin to use.
- \li QT_WAYLAND_SERVER_BUFFER_INTEGRATION Selects which server integration plugin to use.
- \endlist
-
- The command-line arguments:
- \list
- \li --wayland-socket-name Overrides the default socket name used for communicating with clients.
+ \li Environment variables:
+ \list
+ \li \b QT_WAYLAND_HARDWARE_INTEGRATION Selects the hardware integration
+ plugin to use.
+ \li \b QT_WAYLAND_CLIENT_BUFFER_INTEGRATION Selects the client buffer
+ integration plugin to use.
+ \li \b QT_WAYLAND_SERVER_BUFFER_INTEGRATION Selects the server
+ integration plugin to use.
+ \endlist
+ \li Command-line arguments:
+ \list
+ \li \c{--wayland-socket-name} Overrides the default socket name used for
+ communicating with clients.
+ \endlist
\endlist
\section1 Examples