Add some more Broadway documentation

Among other things, introduce a broadwayd man page.

diff --git a/docs/reference/gtk/Makefile.am b/docs/reference/gtk/Makefile.am
index 9e15b11e9f56102bc8f8fb3a1499569cd23922e5..ade28bbb741b45ea83b0cb8044c4edf6213b06df 100644 (file)
--- a/docs/reference/gtk/Makefile.am
+++ b/docs/reference/gtk/Makefile.am
@@ -154,6 +154,7 @@ content_files =                                     \
        gtk-query-immodules-3.0.xml             \
        gtk-update-icon-cache.xml               \
        gtk-launch.xml                          \
+       broadwayd.xml                           \
        visual_index.xml                        \
        getting_started.xml                     \
        overview.xml
@@ -427,7 +428,8 @@ EXTRA_DIST += version.xml.in gtk3.types.in
 man_MANS =                             \
        gtk-query-immodules-3.0.1       \
        gtk-update-icon-cache.1         \
-       gtk-launch.1
+       gtk-launch.1                    \
+       broadwayd.1
 
 if ENABLE_MAN
 

diff --git a/docs/reference/gtk/broadway.xml b/docs/reference/gtk/broadway.xml
index 64e6a85d672b9adae7f9d7797dc06e8d4fe1a644..80bafbe318ceb18406023592c14903e3e81d6882 100644 (file)
--- a/docs/reference/gtk/broadway.xml
+++ b/docs/reference/gtk/broadway.xml
@@ -4,25 +4,25 @@
 ]>
 <refentry id="gtk-broadway">
 <refmeta>
-<refentrytitle>Using GTK+ with HTML5</refentrytitle>
+<refentrytitle>Using GTK+ with Broadway</refentrytitle>
 <manvolnum>3</manvolnum>
 <refmiscinfo>GTK Library</refmiscinfo>
 </refmeta>
 
 <refnamediv>
-<refname>Using GTK+ with HTML5</refname>
+<refname>Using GTK+ with Broadway</refname>
 <refpurpose>
 HTML-specific aspects of using GTK+
 </refpurpose>
 </refnamediv>
 
 <refsect1>
-<title>Using GTK+ with HTML5</title>
+<title>Using GTK+ with Broadway</title>
 
 <para>
 The GDK Broadway backend provides support for displaying GTK+
-applications using HTML5 and Web sockets. To run your application
-in this way, select the Broadway backend by setting
+applications in a web browser, using HTML5 and web sockets. To run
+your application in this way, select the Broadway backend by setting
 <literal>GDK_BACKEND=broadway</literal>. Then you can make
 your application appear in a web browser by pointing it at
 <literal>http://127.0.0.1:8080</literal>. Note that you need
@@ -35,6 +35,37 @@ the <envar>BROADWAY_DISPLAY</envar> environment variable to the
 port that you want to use.
 </para>
 
+<para>
+It is also possible to use multiple GTK+ applications in the same
+web browser window, by using the Broadway server,
+<command>broadwayd</command>, that ships with GTK+.
+To use broadwayd, start it like this:
+<programlisting>
+broadwayd :5
+</programlisting>
+Then point your web browser at <literal>http://127.0.0.1:8084</literal>.
+Start your applications like this:
+<programlisting>
+BROADWAY_DISPLAY=:5 gtk3-demo
+</programlisting>
+</para>
+
+<refsect2 id="broadway-envar">
+<title>Broadway-specific environment variables</title>
+
+</refsect2>
+  <formalpara>
+    <title><envar>BROADWAY_DISPLAY</envar></title>
+
+    <para>
+      Specifies the Broadway display number. The default display is 1.
+      The display number determines the port to use when connecting
+      to a Broadway application via the following formula:
+      <programlisting>
+        <replaceable>port</replaceable> = 8080 + (<replaceable>display</replaceable> - 1)
+      </programlisting>
+    </para>
+  </formalpara>
 </refsect1>
 
 </refentry>

diff --git a/docs/reference/gtk/building.sgml b/docs/reference/gtk/building.sgml
index 9e47fda5f9991fede3cfd1e853fa57c152710cc7..542782c31083ef9ed165e5977b890b73aa3662c1 100644 (file)
--- a/docs/reference/gtk/building.sgml
+++ b/docs/reference/gtk/building.sgml
@@ -317,8 +317,8 @@ How to compile GTK+ itself
           <command>configure</command>
           <sbr/>
           <group>
-            <arg>--disable-modules</arg>
-            <arg>--enable-modules</arg>
+            <arg choice="plain">--disable-modules</arg>
+            <arg choice="plain">--enable-modules</arg>
           </group>
           <sbr/>
           <group>
@@ -330,52 +330,68 @@ How to compile GTK+ itself
           </group>
           <sbr/>
           <group>
-            <arg>--disable-Bsymbolic</arg>
-            <arg>--enable-Bsymbolic</arg>
+            <arg choice="plain">--disable-Bsymbolic</arg>
+            <arg choice="plain">--enable-Bsymbolic</arg>
           </group>
           <sbr/>
           <group>
-            <arg>--disable-xkb</arg>
-            <arg>--enable-xkb</arg>
+            <arg choice="plain">--disable-xkb</arg>
+            <arg choice="plain">--enable-xkb</arg>
           </group>
           <sbr/>
           <group>
-            <arg>--disable-xinerama</arg>
-            <arg>--enable-xinerama</arg>
+            <arg choice="plain">--disable-xinerama</arg>
+            <arg choice="plain">--enable-xinerama</arg>
           </group>
           <sbr/>
           <group>
-            <arg>--disable-gtk-doc</arg>
-            <arg>--enable-gtk-doc</arg>
+            <arg choice="plain">--disable-gtk-doc</arg>
+            <arg choice="plain">--enable-gtk-doc</arg>
           </group>
           <sbr/>
           <group>
-            <arg>--disable-cups</arg>
-            <arg>--enable-cups</arg>
+            <arg choice="plain">--disable-cups</arg>
+            <arg choice="plain">--enable-cups</arg>
           </group>
           <sbr/>
           <group>
-            <arg>--disable-papi</arg>
-            <arg>--enable-papi</arg>
+            <arg choice="plain">--disable-papi</arg>
+            <arg choice="plain">--enable-papi</arg>
           </group>
           <sbr/>
           <group>
-            <arg>--enable-xinput</arg>
-            <arg>--disable-xinput</arg>
+            <arg choice="plain">--enable-xinput</arg>
+            <arg choice="plain">--disable-xinput</arg>
           </group>
           <sbr/>
           <group>
-            <arg>--enable-packagekit</arg>
-            <arg>--disable-packagekit</arg>
+            <arg choice="plain">--enable-packagekit</arg>
+            <arg choice="plain">--disable-packagekit</arg>
           </group>
           <sbr/>
           <group>
-            <arg>--enable-x11-backend</arg>
-            <arg>--disable-x11-backend</arg>
-            <arg>--enable-win32-backend</arg>
-            <arg>--disable-win32-backend</arg>
-            <arg>--enable-quartz-backend</arg>
-            <arg>--disable-quartz-backend</arg>
+            <arg choice="plain">--enable-x11-backend</arg>
+            <arg choice="plain">--disable-x11-backend</arg>
+          </group>
+          <sbr/>
+          <group>
+            <arg choice="plain">--enable-win32-backend</arg>
+            <arg choice="plain">--disable-win32-backend</arg>
+          </group>
+          <sbr/>
+          <group>
+            <arg choice="plain">--enable-quartz-backend</arg>
+            <arg choice="plain">--disable-quartz-backend</arg>
+          </group>
+          <sbr/>
+          <group>
+            <arg choice="plain">--enable-broadway-backend</arg>
+            <arg choice="plain">--disable-broadway-backend</arg>
+          </group>
+          <sbr/>
+          <group>
+            <arg choice="plain">--enable-wayland-backend</arg>
+            <arg choice="plain">--disable-wayland-backend</arg>
           </group>
           <sbr/>
           <group>
@@ -383,8 +399,8 @@ How to compile GTK+ itself
           </group>
           <sbr/>
           <group>
-            <arg>--enable-gtk2-dependency</arg>
-            <arg>--disable-gtk2-dependency</arg>
+            <arg choice="plain">--enable-gtk2-dependency</arg>
+            <arg choice="plain">--disable-gtk2-dependency</arg>
           </group>
         </cmdsynopsis>
       </para>
@@ -571,7 +587,11 @@ How to compile GTK+ itself
           <systemitem>--enable-win32-backend</systemitem>,
           <systemitem>--disable-win32-backend</systemitem>,
           <systemitem>--enable-quartz-backend</systemitem>,
-          and <systemitem>--disable-quartz-backend</systemitem></title>
+          <systemitem>--disable-quartz-backend</systemitem>,
+          <systemitem>--enable-broadway-backend</systemitem>,
+          <systemitem>--disable-broadway-backend</systemitem>,
+          <systemitem>--enable-wayland-backend</systemitem>, and
+          <systemitem>--disable-wayland-backend</systemitem></title>
 
         <para>
           Enables specific backends for GDK.  If none of these options

diff --git a/docs/reference/gtk/gtk-docs.sgml b/docs/reference/gtk/gtk-docs.sgml
index 56de8e287c7aee18a847371e009a00ebefe9d108..6260fb8cfc8cdfd67722dcadbccfa4013e8e4ca0 100644 (file)
--- a/docs/reference/gtk/gtk-docs.sgml
+++ b/docs/reference/gtk/gtk-docs.sgml
@@ -383,6 +383,7 @@
     <xi:include href="gtk-query-immodules-3.0.xml" />
     <xi:include href="gtk-update-icon-cache.xml" />
     <xi:include href="gtk-launch.xml" />
+    <xi:include href="broadwayd.xml" />
   </part>
 
   <xi:include href="glossary.xml" />

diff --git a/docs/reference/gtk/running.sgml b/docs/reference/gtk/running.sgml
index 3e4966af0e8539ce907646999d48beb3dead4063..576f83f25fe84145278b0ba5a4aad9b5edf68413 100644 (file)
--- a/docs/reference/gtk/running.sgml
+++ b/docs/reference/gtk/running.sgml
@@ -126,7 +126,7 @@ variables like <envar>LANG</envar>, <envar>PATH</envar>, <envar>HOME</envar>
 or <envar>DISPLAY</envar>; mostly to determine paths to look for certain
 files. The <link linkend="x11-envar">X11</link>,
 <link linkend="win32-envar">Windows</link> and
-<link linkend="fb-envar">Framebuffer</link> GDK backends use some
+<link linkend="broadway-envar">Broadway</link> GDK backends use some
 additional environment variables.
 </para>
 
@@ -452,12 +452,12 @@ nevertheless.
 
       <varlistentry>
         <term>broadway</term>
-        <listitem><para>Selects the HTML5 backend.</para></listitem>
+        <listitem><para>Selects the Broadway backend for display in web browsers</para></listitem>
       </varlistentry>
 
       <varlistentry>
         <term>wayland</term>
-        <listitem><para>Selects the Wayland backend for connecting to Wayland display servers.</para></listitem>
+        <listitem><para>Selects the Wayland backend for connecting to Wayland display servers</para></listitem>
       </varlistentry>
 
     </variablelist>
@@ -465,15 +465,6 @@ nevertheless.
   </para>
 </formalpara>
 
-<formalpara>
-  <title><envar>GDK_SYNCHRONIZE</envar></title>
-
-  <para>
-    If set, GDK makes all X requests synchronously. This is a useful
-    option for debugging, but it will slow down the performance considerably.
-  </para>
-</formalpara>
-
 <formalpara>
   <title><envar>XDG_DATA_HOME</envar>, <envar>XDG_DATA_DIRS</envar></title>
 

diff --git a/docs/reference/gtk/x11.sgml b/docs/reference/gtk/x11.sgml
index 7a8bcfc90de123f0d1b81b9a997d0d718165c757..bb588b1163d77f50991532fcef7c737c96151ae6 100644 (file)
--- a/docs/reference/gtk/x11.sgml
+++ b/docs/reference/gtk/x11.sgml
@@ -56,6 +56,33 @@ in the <envar>DISPLAY</envar> environment variable.
 
 </refsect2>
 
+<refsect2 id="x11-envar">
+<title>X11-specific environment variables</title>
+
+<para>
+The X11 GDK backend can be influenced with some additional environment variables.
+</para>
+
+<formalpara>
+  <title><envar>GDK_SYNCHRONIZE</envar></title>
+
+  <para>
+    If set, GDK makes all X requests synchronously. This is a useful
+    option for debugging, but it will slow down the performance considerably.
+  </para>
+</formalpara>
+
+<formalpara>
+  <title><envar>GDK_CORE_DEVICE_EVENTS</envar></title>
+
+  <para>
+    If set, GDK makes does not use the XInput extension, and only reacts
+    to core X input events.
+  </para>
+</formalpara>
+
+</refsect2>
+
 </refsect1>
 
 <refsect1 id="gtk-X11-arch">