Add a short Broadway section to the docs

diff --git a/docs/reference/gtk/Makefile.am b/docs/reference/gtk/Makefile.am
index 8bde862a2724c18a7cf9ba5694579daf0477b38a..836ed4e23290e2ec7c75547ed0ce8cde612094fc 100644 (file)
--- a/docs/reference/gtk/Makefile.am
+++ b/docs/reference/gtk/Makefile.am
@@ -129,6 +129,7 @@ content_files =                                     \
        migrating-GtkStyleContext.xml           \
        objects_grouped.sgml                    \
        osx.sgml                                \
+       broadway.xml                            \
        question_index.sgml                     \
        resources.sgml                          \
        text_widget.sgml                        \

diff --git a/docs/reference/gtk/broadway.xml b/docs/reference/gtk/broadway.xml
new file mode 100644 (file)
index 0000000..64e6a85
--- /dev/null
+++ b/docs/reference/gtk/broadway.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-broadway">
+<refmeta>
+<refentrytitle>Using GTK+ with HTML5</refentrytitle>
+<manvolnum>3</manvolnum>
+<refmiscinfo>GTK Library</refmiscinfo>
+</refmeta>
+
+<refnamediv>
+<refname>Using GTK+ with HTML5</refname>
+<refpurpose>
+HTML-specific aspects of using GTK+
+</refpurpose>
+</refnamediv>
+
+<refsect1>
+<title>Using GTK+ with HTML5</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
+<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
+to enable web sockets in your web browser.
+</para>
+
+<para>
+You can choose a different port from the default 8080 by setting
+the <envar>BROADWAY_DISPLAY</envar> environment variable to the
+port that you want to use.
+</para>
+
+</refsect1>
+
+</refentry>

diff --git a/docs/reference/gtk/gtk-docs.sgml b/docs/reference/gtk/gtk-docs.sgml
index f3e744a2cad68a88688e6b630704310d798e1aea..70a34d78209df9a696e27e7d808fe8f7c6293cec 100644 (file)
--- a/docs/reference/gtk/gtk-docs.sgml
+++ b/docs/reference/gtk/gtk-docs.sgml
@@ -28,6 +28,7 @@
     <xi:include href="x11.sgml" />
     <xi:include href="windows.sgml" />
     <xi:include href="osx.sgml" />
+    <xi:include href="broadway.xml" />
     <xi:include href="resources.sgml" />
     <xi:include href="xml/question_index.sgml" />
     <xi:include href="drawing-model.xml" />