From 20cc061d167627b68ba7906d0aef186510bcdc21 Mon Sep 17 00:00:00 2001 From: Randolph Sapp Date: Wed, 22 Oct 2025 12:58:57 -0500 Subject: [PATCH 1/2] feat(weston): describe the weston session entry Outline the weston session entry so that users know what to modify to add additional command line arguments. Signed-off-by: Randolph Sapp --- .../Foundational_Components/Graphics/Common/Weston.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/source/linux/Foundational_Components/Graphics/Common/Weston.rst b/source/linux/Foundational_Components/Graphics/Common/Weston.rst index 1334e97f9..39332aea2 100644 --- a/source/linux/Foundational_Components/Graphics/Common/Weston.rst +++ b/source/linux/Foundational_Components/Graphics/Common/Weston.rst @@ -54,6 +54,14 @@ manager that coordinates the loading of devices with the initialization of any specified graphical environment. By default it will automatically start ``weston`` under the weston user on device startup. +The definition of the session, including the command used to start it is in +:file:`/usr/share/wayland-sessions/weston.desktop`. This follows the desktop +entry initialization (INI) format. Some have argued that session entries do not +fully meet the `Desktop Entry Specification`_ due to the addition of some new +keys and silent disregard of other keys. + +.. _Desktop Entry Specification: https://specifications.freedesktop.org/desktop-entry-spec + If you need to interact with this instance with any other user, then make sure that user is capable of interacting with the wayland socket. This will be :file:`wayland-1` under the ``weston`` user's ``XDG_RUNTIME_DIR``, From a07f2e4127371dd8cdb24dff519dd8045a6103e2 Mon Sep 17 00:00:00 2001 From: Randolph Sapp Date: Wed, 22 Oct 2025 13:00:20 -0500 Subject: [PATCH 2/2] feat(weston): describe how to take screenshots Describe how to take screenshots and the required configuration steps beforehand. Signed-off-by: Randolph Sapp --- .../Graphics/Common/Weston.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/source/linux/Foundational_Components/Graphics/Common/Weston.rst b/source/linux/Foundational_Components/Graphics/Common/Weston.rst index 39332aea2..e295b8832 100644 --- a/source/linux/Foundational_Components/Graphics/Common/Weston.rst +++ b/source/linux/Foundational_Components/Graphics/Common/Weston.rst @@ -253,3 +253,19 @@ See the following for more information about the Weston IVI-shell: - ``_ +*********** +Screenshots +*********** + +The :command:`weston-screenshooter` utility allows for fast, full-screen +screenshots. It behaves similarly to any other weston client utility and +requires the ``WAYLAND_DISPLAY`` environment variable to point to a valid +Wayland socket. See :ref:`running-weston-clients` for more information. + +For most Wayland compositors this would be enough, but Weston requires +additional configuration. Weston does not support the `screen capture +protocol`_, and instead uses an internal helper to fetch and dump active display +contents. Weston only exposes this helper when launched in debug mode. To do +this, add the ``--debug`` argument when starting Weston. + +.. _screen capture protocol: https://gitlab.freedesktop.org/wayland/wayland-protocols/-/blob/main/staging/ext-image-copy-capture/ext-image-copy-capture-v1.xml