From: Matthias Clasen Date: Tue, 19 May 2020 19:19:53 +0000 (-0400) Subject: docs: Refresh the build and backend sections X-Git-Tag: archive/raspbian/4.4.1+ds1-2+rpi1^2~18^2~16^2~146^2 X-Git-Url: https://dgit.raspbian.org/?a=commitdiff_plain;h=edf85cb1b3309367983138373c304a92ef93c1e4;p=gtk4.git docs: Refresh the build and backend sections Remove some outdated information from the sections about building and about particular backends. --- diff --git a/docs/reference/gtk/building.xml b/docs/reference/gtk/building.xml index b0df9ec4a1..49b45b1d65 100644 --- a/docs/reference/gtk/building.xml +++ b/docs/reference/gtk/building.xml @@ -47,7 +47,7 @@ How to compile GTK itself - meson --prefix /opt/gtk builddir + meson setup --prefix /opt/gtk builddir diff --git a/docs/reference/gtk/running.xml b/docs/reference/gtk/running.xml index fe6b7e6c70..1c4df5ad43 100644 --- a/docs/reference/gtk/running.xml +++ b/docs/reference/gtk/running.xml @@ -36,7 +36,7 @@ additional environment variables. <envar>GTK_DEBUG</envar> - Unless GTK has been configured with , + Unless GTK has been configured with , this variable can be set to a list of debug options, which cause GTK to print out different types of debugging information. @@ -237,7 +237,7 @@ nevertheless. <envar>GDK_DEBUG</envar> - If GTK has been configured with , + Unless GTK has been configured with , this variable can be set to a list of debug options, which cause GDK to print out different types of debugging information. @@ -327,7 +327,7 @@ nevertheless. <envar>GSK_DEBUG</envar> - If GTK has been configured with , + Unless GTK has been configured with , this variable can be set to a list of debug options, which cause GSK to print out different types of debugging information. @@ -432,11 +432,11 @@ nevertheless. - Since 3.10, this environment variable can contain a comma-separated list - of backend names, which are tried in order. The list may also contain - a *, which means: try all remaining backends. The special value "help" can - be used to make GDK print out a list of all available backends. - For more information about selecting backends, see the gdk_display_manager_get() function. + This environment variable can contain a comma-separated list of backend names, + which are tried in order. The list may also contain a *, which means: try all + remaining backends. The special value "help" can be used to make GDK print out + a list of all available backends. For more information about selecting backends, + see the gdk_display_manager_get() function. diff --git a/docs/reference/gtk/wayland.xml b/docs/reference/gtk/wayland.xml index caa6d1c4ff..7d38342ebd 100644 --- a/docs/reference/gtk/wayland.xml +++ b/docs/reference/gtk/wayland.xml @@ -21,18 +21,17 @@ Wayland-specific aspects of using GTK The GDK Wayland backend provides support for running GTK applications -under the Wayland display server. To run your application in this way, -select the Wayland backend by setting GDK_BACKEND=wayland. +under a Wayland compositor. To run your application in this way, select +the Wayland backend by setting GDK_BACKEND=wayland. -Currently, the Wayland backend does not use any additional commandline -options or environment variables. +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." -For up-to-date information about the current status of this backend, see -the project page. +Currently, the Wayland backend does not use any additional environment variables. diff --git a/docs/reference/gtk/windows.xml b/docs/reference/gtk/windows.xml index b936dbc2da..ca25b9c892 100644 --- a/docs/reference/gtk/windows.xml +++ b/docs/reference/gtk/windows.xml @@ -25,65 +25,19 @@ on top of the Win32 API. When compiling GTK on Windows, this backend is the default. - -Windows-specific commandline options - - -The Windows GDK backend can be influenced with some -additional command line arguments. - - - -<systemitem>--sync</systemitem> - - -Don't batch GDI requests. This might be a marginally useful option for -debugging. - - - - -<systemitem>--no-wintab</systemitem>, - <systemitem>--ignore-wintab</systemitem> - - -Don't use the Wintab API for tablet support. - - - - -<systemitem>--use-wintab</systemitem> - - -Use the Wintab API for tablet support. This is the default. - - - - -<systemitem>--max-colors <replaceable>number</replaceable></systemitem> - - -In 256 color mode, restrict the size of the color palette to -the specified number of colors. This option is obsolete. - - - - - Windows-specific environment variables -The Win32 GDK backend can be influenced with some -additional environment variables. +The Win32 GDK backend can be influenced with some additional environment +variables. <envar>GDK_IGNORE_WINTAB</envar> -If this variable is set, GTK doesn't use -the Wintab API for tablet support. +If this variable is set, GTK doesn't use the Wintab API for tablet support. @@ -91,17 +45,8 @@ the Wintab API for tablet support. <envar>GDK_USE_WINTAB</envar> -If this variable is set, GTK uses the Wintab API for -tablet support. This is the default. - - - - -<envar>GDK_WIN32_MAX_COLORS</envar> - - -Specifies the size of the color palette used -in 256 color mode. +If this variable is set, GTK uses the Wintab API for tablet support. +This is the default. @@ -120,7 +65,9 @@ When any other cursor theme is used, GTK will prefer cursors from that theme, falling back to Windows cursors and built-in X cursors. -Theme can be changed by setting gtk-cursor-theme-name GTK setting. Users can override GTK settings in the settings.ini file or at runtime in the GTK Inspector. +Theme can be changed by setting gtk-cursor-theme-name GTK +setting. Users 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: @@ -129,7 +76,8 @@ Themes are loaded from normal Windows variants of the XDG locations: RUNTIME_PREFIX/share/icons/THEME/cursors. -The gtk-cursor-theme-size setting is ignored, GTK will use the cursor size that Windows tells it to use. +The gtk-cursor-theme-size setting is ignored, GTK will use +the cursor size that Windows tells it to use. diff --git a/docs/reference/gtk/x11.xml b/docs/reference/gtk/x11.xml index 567357717d..c2f73e444f 100644 --- a/docs/reference/gtk/x11.xml +++ b/docs/reference/gtk/x11.xml @@ -20,35 +20,16 @@ X11-specific aspects of using GTK GTK for the X Window System -On UNIX, the X backend is the default build for GTK. -So you don't need to do anything special when compiling it, -and everything should "just work." +On UNIX, the X backend is enabled by default, so you don't need to do anything +special when compiling it, and everything should "just work." -To mix low-level Xlib routines into a GTK program, -see GDK X Window -System interaction in the GDK manual. +To mix low-level Xlib routines into a GTK program, see +GDK X Window System +interaction in the GDK manual. - -X11-specific commandline options - - -The X backend understands some additional command line arguments. - - - -<systemitem>--display <replaceable>display</replaceable></systemitem> - - -The name of the X display to open instead of the one specified -in the DISPLAY environment variable. - - - - - X11-specific environment variables @@ -129,9 +110,9 @@ The window manager is in charge of rendering the frame or borders around windows; it also has final say on the size of each window, and window states such as minimized, maximized, and so forth. On Windows and MacOS the application handles most of this. -On X11, if you wish to modify the window's state, or -change its frame, you must ask the window manager to do so on your -behalf, using an established convention. @@ -139,17 +120,11 @@ url="http://www.freedesktop.org/standards/">convention. GTK has functions for asking the window manager to do various things; see for example gtk_window_minimize() or gtk_window_maximize() or gtk_window_set_decorated(). +linkend="gtk-window-maximize">gtk_window_maximize(). Keep in mind that most window managers will ignore certain requests from time to time, in the interests of good user interface. - -