diff --git a/doc/conf.py b/doc/conf.py index 1469681f..636efd76 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -27,6 +27,7 @@ author = 'Geoffrey McRae and the Looking Glass team' rst_prolog = """ .. |license| replace:: GPLv2 +.. |debian_stable| replace:: trixie """ # -- General configuration --------------------------------------------------- diff --git a/doc/faq.rst b/doc/faq.rst index 0992d9c6..f2f45970 100644 --- a/doc/faq.rst +++ b/doc/faq.rst @@ -90,9 +90,8 @@ protocol. Build Looking Glass with libdecor support: cmake -DENABLE_LIBDECOR=ON ../ -Install ``libdecor-0-dev`` first on Debian-based systems. Alternatively, hold -the Super key and right-click the window to use the compositor's move and -resize menu. +Install ``libdecor-0-dev`` first. Alternatively, hold the Super key and +right-click the window to use the compositor's move and resize menu. .. _the_mouse_is_jumpy_slow_laggy_when_using_spice: diff --git a/doc/obs.rst b/doc/obs.rst index 028bc017..365717cf 100644 --- a/doc/obs.rst +++ b/doc/obs.rst @@ -18,7 +18,7 @@ connect. Build and install ----------------- -On Debian-based systems, install the OBS headers and the small set of build +Install the OBS headers and the small set of build dependencies used by the plugin: .. code:: bash diff --git a/doc/overview.rst b/doc/overview.rst index 6f5bedbf..2a293d1f 100644 --- a/doc/overview.rst +++ b/doc/overview.rst @@ -9,7 +9,30 @@ compressed video over a network. The current IDD provides video and direct input through LGMP, while SPICE normally provides audio, clipboard and fallback services. -The names used throughout this guide are: +.. _documentation: + +Documentation +------------- + +.. _docs_distro: + +Linux distribution +~~~~~~~~~~~~~~~~~~ + +The documentation is targeted at Debian users on the stable release channel +(currently |debian_stable|). Newer unstable release channels and +Debian-derivative distributions should also be well served, but some specifics +may be different. Looking Glass is supported on any distribution that provides +the :ref:`required dependencies ` and meets the +:ref:`minimum requirements `, but specific package names within +the documentation may not apply. + +.. _docs_terms: + +Terms +~~~~~ + +The terms used throughout the documentation are: Linux host The physical machine running KVM/QEMU and the Looking Glass Client.