Add a chapter on "UI Scaling" to the User Manual, but it still seems to need modification v1 APPLIED

Cris.Q: 1
 Add a chapter on "UI Scaling" to the User Manual, but it still seems to need modification

 1 files changed, 39 insertions(+), 0 deletions(-)

[PATCH] Add a chapter on "UI Scaling" to the User Manual, but it still seems to need modification Export this patch

Signed-off-by: Cris.Q <qygw@outlook.com>
---
 doc/user/configuration/ui-scaling.rst | 39 +++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 doc/user/configuration/ui-scaling.rst

diff --git a/doc/user/configuration/ui-scaling.rst b/doc/user/configuration/ui-scaling.rst
new file mode 100644
index 000000000..78251272b
--- /dev/null
+++ b/doc/user/configuration/ui-scaling.rst
@@ -0,0 +1,39 @@
+.. SPDX-FileCopyrightText: © 2019-2022 Cris Cao <qygw@outlook.com>
+   SPDX-License-Identifier: GFDL-1.3-invariants-or-later
+.. This is part of the Zrythm Manual.
+   See the file index.rst for copying conditions.
+
+UI Scaling
+===========
+
+Run from Terminal
+--------------
+If you are using Wayland and your window manager already has the correct scaling settings, you may be able to get the user interface scaled correctly by having Zrythm running entirely in Wayland.
+
+For example, you can run these commands to start Zrythm manually on your Terminal:
+
+.. code-block:: bash
+
+   $ export GDK_BACKEND=Wayland
+
+   $ zrythm
+
+Edit the launch script
+-------------------------
+If you wish to access Zrythm directly by clicking on the icon, you can edit the Desktop Entry for Zrythm, e.g:
+.. code-block:: diff
+   \- Exec=/usr/bin/zrythm
+
+   + Exec=env GDK_BACKEND=wayland /usr/bin/zrythm 
+
+Set the Environment Variable
+----------------------------
+If you are an Xorg user or can't use the approach mentioned in "Run from Terminal" Section, perhaps you can scale the interface by setting ``GDK_SCALE`` Environment Variable:
+.. code-block:: bash
+   $ export GDK_SCALE=2
+
+   $ zrythm
+
+.. attention:: GTK3/4 does not support fractional scaling currently, so fractional factors will be ignored. This environment variable is also ignored in mutter wayland sessions. 
+
+
-- 
2.40.1

Alexandros Theodotou <alex@zrythm.org>

1 year, 3 months ago

Merged with a few changes:
https://manual.zrythm.org/en/configuration/ui-scaling-and-wayland.html

Thanks!