diff --git a/doc/sphinx/toc/kiosk-shell.rst b/doc/sphinx/toc/kiosk-shell.rst index dedf6a9c..37895d63 100644 --- a/doc/sphinx/toc/kiosk-shell.rst +++ b/doc/sphinx/toc/kiosk-shell.rst @@ -12,6 +12,13 @@ example: [output] name=screen0 app-ids=org.domain.app1,com.domain.app2 + x11-wm-name=xterm,Mozilla Firefox + x11-wm-class=Navigator + +Xwayland windows can be specified either using ``x11-wm-name=``, which matches +the ``WM_NAME`` X11 property and ``x11-wm-class=``, which matches `WM_CLASS` +one. If the Xwayland window has both a ``WM_CLASS`` or a ``WM_NAME`` set, then +it will be checked in both ``x11-wm-name`` and in ``x11-wm-class`` list entry. To run weston with kiosk-shell set ``shell=kiosk-shell.so`` in weston.ini, or use the ``--shell=kiosk-shell.so`` command-line option.