diff options
author | Matthias Clasen <mclasen@redhat.com> | 2020-05-19 15:19:53 -0400 |
---|---|---|
committer | Matthias Clasen <mclasen@redhat.com> | 2020-05-19 15:19:53 -0400 |
commit | edf85cb1b3309367983138373c304a92ef93c1e4 (patch) | |
tree | 3ba9282d9bf96f89a88b1ff8ae6e57b57f839e98 | |
parent | 841e9b3f0e4903f0c28022a9d67dc0f2290dbac3 (diff) | |
download | gtk+-edf85cb1b3309367983138373c304a92ef93c1e4.tar.gz |
docs: Refresh the build and backend sections
Remove some outdated information from the sections
about building and about particular backends.
-rw-r--r-- | docs/reference/gtk/building.xml | 2 | ||||
-rw-r--r-- | docs/reference/gtk/running.xml | 16 | ||||
-rw-r--r-- | docs/reference/gtk/wayland.xml | 11 | ||||
-rw-r--r-- | docs/reference/gtk/windows.xml | 72 | ||||
-rw-r--r-- | docs/reference/gtk/x11.xml | 43 |
5 files changed, 33 insertions, 111 deletions
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 </para> <informalexample> <programlisting> - meson --prefix /opt/gtk builddir + meson setup --prefix /opt/gtk builddir </programlisting> </informalexample> <para> 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. <title><envar>GTK_DEBUG</envar></title> <para> - Unless GTK has been configured with <option>--enable-debug=no</option>, + Unless GTK has been configured with <option>-Ddebug=false</option>, this variable can be set to a list of debug options, which cause GTK to print out different types of debugging information. <variablelist> @@ -237,7 +237,7 @@ nevertheless. <title><envar>GDK_DEBUG</envar></title> <para> - If GTK has been configured with <option>--enable-debug=yes</option>, + Unless GTK has been configured with <option>-Ddebug=false</option>, this variable can be set to a list of debug options, which cause GDK to print out different types of debugging information. <variablelist> @@ -327,7 +327,7 @@ nevertheless. <title><envar>GSK_DEBUG</envar></title> <para> - If GTK has been configured with <option>--enable-debug=yes</option>, + Unless GTK has been configured with <option>-Ddebug=false</option>, this variable can be set to a list of debug options, which cause GSK to print out different types of debugging information. <variablelist> @@ -432,11 +432,11 @@ nevertheless. </varlistentry> </variablelist> - 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. </para> </formalpara> 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 <para> 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 <literal>GDK_BACKEND=wayland</literal>. +under a Wayland compositor. To run your application in this way, select +the Wayland backend by setting <literal>GDK_BACKEND=wayland</literal>. </para> <para> -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." </para> <para> -For up-to-date information about the current status of this backend, see -the <ulink url="https://wiki.gnome.org/Initiatives/Wayland/GTK%2B">project page</ulink>. +Currently, the Wayland backend does not use any additional environment variables. </para> </refsect1> 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. </para> -<refsect2 id="win32-cmdline"> -<title>Windows-specific commandline options</title> - -<para> -The Windows GDK backend can be influenced with some -additional command line arguments. -</para> - -<formalpara> -<title><systemitem>--sync</systemitem></title> - -<para> -Don't batch GDI requests. This might be a marginally useful option for -debugging. -</para> -</formalpara> - -<formalpara> -<title><systemitem>--no-wintab</systemitem>, - <systemitem>--ignore-wintab</systemitem></title> - -<para> -Don't use the Wintab API for tablet support. -</para> -</formalpara> - -<formalpara> -<title><systemitem>--use-wintab</systemitem></title> - -<para> -Use the Wintab API for tablet support. This is the default. -</para> -</formalpara> - -<formalpara> -<title><systemitem>--max-colors <replaceable>number</replaceable></systemitem></title> - -<para> -In 256 color mode, restrict the size of the color palette to -the specified number of colors. This option is obsolete. -</para> -</formalpara> - -</refsect2> - <refsect2 id="win32-envar"> <title>Windows-specific environment variables</title> <para> -The Win32 GDK backend can be influenced with some -additional environment variables. +The Win32 GDK backend can be influenced with some additional environment +variables. </para> <formalpara> <title><envar>GDK_IGNORE_WINTAB</envar></title> <para> -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. </para> </formalpara> @@ -91,17 +45,8 @@ the Wintab API for tablet support. <title><envar>GDK_USE_WINTAB</envar></title> <para> -If this variable is set, GTK uses the Wintab API for -tablet support. This is the default. -</para> -</formalpara> - -<formalpara> -<title><envar>GDK_WIN32_MAX_COLORS</envar></title> - -<para> -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. </para> </formalpara> @@ -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. </para> <para> -Theme can be changed by setting <literal>gtk-cursor-theme-name</literal> GTK setting. Users can override GTK settings in the <filename>settings.ini</filename> file or at runtime in the GTK Inspector. +Theme can be changed by setting <literal>gtk-cursor-theme-name</literal> GTK +setting. Users can override GTK settings in the <filename>settings.ini</filename> +file or at runtime in the GTK Inspector. </para> <para> 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: <filename>RUNTIME_PREFIX/share/icons/THEME/cursors</filename>. </para> <para> -The <literal>gtk-cursor-theme-size</literal> setting is ignored, GTK will use the cursor size that Windows tells it to use. +The <literal>gtk-cursor-theme-size</literal> setting is ignored, GTK will use +the cursor size that Windows tells it to use. </para> </refsect2> 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 <title>GTK for the X Window System</title> <para> -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." </para> <para> -To mix low-level Xlib routines into a GTK program, -see <link linkend="gdk-X-Window-System-Interaction">GDK X Window -System interaction</link> in the GDK manual. +To mix low-level Xlib routines into a GTK program, see +<link linkend="gdk-X-Window-System-Interaction">GDK X Window System +interaction</link> in the GDK manual. </para> -<refsect2 id="x11-cmdline"> -<title>X11-specific commandline options</title> - -<para> -The X backend understands some additional command line arguments. -</para> - -<formalpara> -<title><systemitem>--display <replaceable>display</replaceable></systemitem></title> - -<para> -The name of the X display to open instead of the one specified -in the <envar>DISPLAY</envar> environment variable. -</para> -</formalpara> - -</refsect2> - <refsect2 id="x11-envar"> <title>X11-specific environment variables</title> @@ -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 <ulink +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 <ulink url="http://www.freedesktop.org/standards/">convention</ulink>. </para> @@ -139,17 +120,11 @@ url="http://www.freedesktop.org/standards/">convention</ulink>. GTK has functions for asking the window manager to do various things; see for example <link linkend="gtk-window-minimize">gtk_window_minimize()</link> or <link -linkend="gtk-window-maximize">gtk_window_maximize()</link> or <link -linkend="gtk-window-set-decorated">gtk_window_set_decorated()</link>. +linkend="gtk-window-maximize">gtk_window_maximize()</link>. Keep in mind that most window managers <emphasis>will</emphasis> ignore certain requests from time to time, in the interests of good user interface. </para> -<!-- -May also want to explain DESKTOP_STARTUP_ID here. -http://www.freedesktop.org/Standards/startup-notification-spec ---> - </refsect2> </refsect1> |