summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2020-06-28 13:41:15 -0400
committerMatthias Clasen <mclasen@redhat.com>2020-06-28 13:42:01 -0400
commit6819c7c792bdec43ffab361df78cd2d7c4219eae (patch)
treefed5fcc9ed1e5bee82a11e6816ea3726adde7091 /docs
parent5d9bcfb64a754de4f54da2958b4056a80d0ecfc0 (diff)
downloadgtk+-6819c7c792bdec43ffab361df78cd2d7c4219eae.tar.gz
docs: Update environment sections
Fix links in markdown, and add details about Wayland environment variables.
Diffstat (limited to 'docs')
-rw-r--r--docs/reference/gtk/running.md7
-rw-r--r--docs/reference/gtk/wayland.md11
-rw-r--r--docs/reference/gtk/windows.md7
3 files changed, 17 insertions, 8 deletions
diff --git a/docs/reference/gtk/running.md b/docs/reference/gtk/running.md
index 7ac5c811f0..6bed8abe13 100644
--- a/docs/reference/gtk/running.md
+++ b/docs/reference/gtk/running.md
@@ -4,9 +4,10 @@
GTK inspects a number of environment variables in addition to
standard variables like `LANG`, `PATH`, `HOME` or `DISPLAY`; mostly
-to determine paths to look for certain files. The [X11]{#x11-envar},
-[Windows]{#win32-envar} and [Broadway]{#broadway-envar} GDK backends
-use some additional environment variables.
+to determine paths to look for certain files. The [X11](#x11-envar),
+[Wayland](#wayland-envar), [Windows](#win32-envar) and
+[Broadway](#broadway-envar) GDK backends use some additional
+environment variables.
### GTK_DEBUG {#GTK_Debug-Options}
diff --git a/docs/reference/gtk/wayland.md b/docs/reference/gtk/wayland.md
index 7c3f708cfe..0c99fc4952 100644
--- a/docs/reference/gtk/wayland.md
+++ b/docs/reference/gtk/wayland.md
@@ -7,4 +7,13 @@ the Wayland backend by setting `GDK_BACKEND=wayland`.
On UNIX, the Wayland backend is enabled by default, so you don't need to
do anything special when compiling it, and everything should "just work."
-Currently, the Wayland backend does not use any additional environment variables.
+## Wayland-specific environment variables {#wayland-envar}
+
+### WAYLAND_DISPLAY
+
+Specifies the name of the Wayland display to use. Typically, wayland-0
+or wayland-1.
+
+### XDG_RUNTIME_DIR
+
+Used to locate the Wayland socket to use.
diff --git a/docs/reference/gtk/windows.md b/docs/reference/gtk/windows.md
index b432175094..a5c14205e9 100644
--- a/docs/reference/gtk/windows.md
+++ b/docs/reference/gtk/windows.md
@@ -16,7 +16,6 @@ variables.
### GDK_IGNORE_WINTAB
If this variable is set, GTK doesn't use the Wintab API for tablet support.
-</para>
### GDK_USE_WINTAB
@@ -37,10 +36,10 @@ can override GTK settings in the `settings.ini` file or at runtime in the
GTK Inspector.
Themes are loaded from normal Windows variants of the XDG locations:
-`%HOME%/icons/THEME/cursors`,
-`%APPDATA%/icons/THEME/cursors`,
+`%HOME%/icons/THEME/cursors`,
+`%APPDATA%/icons/THEME/cursors`,
`RUNTIME_PREFIX/share/icons/THEME/cursors`
-The `gtk-cursor-theme-size`> setting is ignored, GTK will use
+The `gtk-cursor-theme-size` setting is ignored, GTK will use
the cursor size that Windows tells it to use.