[gtk+] Add some docs for the wayland backend
- From: Matthias Clasen <matthiasc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk+] Add some docs for the wayland backend
- Date: Sun, 11 Mar 2012 18:24:32 +0000 (UTC)
commit 8b7cfa448a59f7b44806a31515fce5e4f5d324cf
Author: Matthias Clasen <mclasen redhat com>
Date: Sun Mar 11 14:23:53 2012 -0400
Add some docs for the wayland backend
This commit also includes some tweaks to the other backend-specific
docs.
docs/reference/gtk/Makefile.am | 1 +
docs/reference/gtk/gtk-docs.sgml | 1 +
docs/reference/gtk/osx.sgml | 4 +-
docs/reference/gtk/running.sgml | 15 ++++++++++++-
docs/reference/gtk/wayland.xml | 40 ++++++++++++++++++++++++++++++++++++++
docs/reference/gtk/windows.sgml | 5 ++-
6 files changed, 60 insertions(+), 6 deletions(-)
---
diff --git a/docs/reference/gtk/Makefile.am b/docs/reference/gtk/Makefile.am
index 836ed4e..47bc96d 100644
--- a/docs/reference/gtk/Makefile.am
+++ b/docs/reference/gtk/Makefile.am
@@ -130,6 +130,7 @@ content_files = \
objects_grouped.sgml \
osx.sgml \
broadway.xml \
+ wayland.xml \
question_index.sgml \
resources.sgml \
text_widget.sgml \
diff --git a/docs/reference/gtk/gtk-docs.sgml b/docs/reference/gtk/gtk-docs.sgml
index 70a34d7..76881b1 100644
--- a/docs/reference/gtk/gtk-docs.sgml
+++ b/docs/reference/gtk/gtk-docs.sgml
@@ -29,6 +29,7 @@
<xi:include href="windows.sgml" />
<xi:include href="osx.sgml" />
<xi:include href="broadway.xml" />
+ <xi:include href="wayland.xml" />
<xi:include href="resources.sgml" />
<xi:include href="xml/question_index.sgml" />
<xi:include href="drawing-model.xml" />
diff --git a/docs/reference/gtk/osx.sgml b/docs/reference/gtk/osx.sgml
index 0f09097..41c6d87 100644
--- a/docs/reference/gtk/osx.sgml
+++ b/docs/reference/gtk/osx.sgml
@@ -20,13 +20,13 @@ OS X-specific aspects of using GTK+
<title>Using GTK+ on Mac OS X</title>
<para>
-The Mac OS X port of GTK+ is an implementation of GDK (and therefore GTK+)
+The Mac OS X port of GTK+ is an implementation of GDK (and therefore GTK+)
on top of the Quarz API.
</para>
<para>
Currently, the Mac OS X port does not use any additional commandline options
-or environment variables.
+or environment variables.
</para>
<para>
diff --git a/docs/reference/gtk/running.sgml b/docs/reference/gtk/running.sgml
index 190234e..147637e 100644
--- a/docs/reference/gtk/running.sgml
+++ b/docs/reference/gtk/running.sgml
@@ -422,8 +422,9 @@ nevertheless.
<title><envar>GDK_BACKEND</envar></title>
<para>
- If set, selects the GDK backend to use. Selecting a backend requires that GTK is compiled
- with support for that backend. The following backends can be selected:
+ If set, selects the GDK backend to use. Selecting a backend requires that
+ GTK+ is compiled with support for that backend. The following backends can
+ be selected:
<variablelist>
<varlistentry>
@@ -441,6 +442,16 @@ nevertheless.
<listitem><para>Selects the native backend for connecting to X11 servers.</para></listitem>
</varlistentry>
+ <varlistentry>
+ <term>broadway</term>
+ <listitem><para>Selects the HTML5 backend.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>wayland</term>
+ <listitem><para>Selects the Wayland backend for connecting to Wayland display servers.</para></listitem>
+ </varlistentry>
+
</variablelist>
For more information about selecting backends, see the gdk_display_manager_get() function.
</para>
diff --git a/docs/reference/gtk/wayland.xml b/docs/reference/gtk/wayland.xml
new file mode 100644
index 0000000..19fbcb5
--- /dev/null
+++ b/docs/reference/gtk/wayland.xml
@@ -0,0 +1,40 @@
+<?xml version="1.0"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+ "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+]>
+<refentry id="gtk-osx">
+<refmeta>
+<refentrytitle>Using GTK+ with Wayland</refentrytitle>
+<manvolnum>3</manvolnum>
+<refmiscinfo>GTK Library</refmiscinfo>
+</refmeta>
+
+<refnamediv>
+<refname>Using GTK+ with Wayland</refname>
+<refpurpose>
+Wayland-specific aspects of using GTK+
+</refpurpose>
+</refnamediv>
+
+<refsect1>
+<title>Using GTK+ with Wayland</title>
+
+<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>.
+</para>
+
+<para>
+Currently, the Wayland backend does not use any additional commandline
+options or environment variables.
+</para>
+
+<para>
+For up-to-date information about the current status of this backend, see
+the <ulink url="http://wayland.freedesktop.org/gtk.html">project page</ulink>.
+</para>
+
+</refsect1>
+
+</refentry>
diff --git a/docs/reference/gtk/windows.sgml b/docs/reference/gtk/windows.sgml
index 3de34ad..bea2fbe 100644
--- a/docs/reference/gtk/windows.sgml
+++ b/docs/reference/gtk/windows.sgml
@@ -20,8 +20,9 @@ Windows-specific aspects of using GTK+
<title>Using GTK+ on Windows</title>
<para>
-The Windows port of GTK+ is an implementation of GDK (and therefore GTK+)
-on top of the Win32 API.
+The Windows port of GTK+ is an implementation of GDK (and therefore GTK+)
+on top of the Win32 API. When compiling GTK+ on Windows, this backend is
+the default.
</para>
<refsect2 id="win32-cmdline">
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]