diff --git a/docs/reference/gtk/Makefile.am b/docs/reference/gtk/Makefile.am index 9e15b11e9f..ade28bbb74 100644 --- 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 64e6a85d67..80bafbe318 100644 --- a/docs/reference/gtk/broadway.xml +++ b/docs/reference/gtk/broadway.xml @@ -4,25 +4,25 @@ ]> -Using GTK+ with HTML5 +Using GTK+ with Broadway 3 GTK Library -Using GTK+ with HTML5 +Using GTK+ with Broadway HTML-specific aspects of using GTK+ -Using GTK+ with HTML5 +Using GTK+ with Broadway 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 GDK_BACKEND=broadway. Then you can make your application appear in a web browser by pointing it at http://127.0.0.1:8080. Note that you need @@ -35,6 +35,37 @@ the BROADWAY_DISPLAY environment variable to the port that you want to use. + +It is also possible to use multiple GTK+ applications in the same +web browser window, by using the Broadway server, +broadwayd, that ships with GTK+. +To use broadwayd, start it like this: + +broadwayd :5 + +Then point your web browser at http://127.0.0.1:8084. +Start your applications like this: + +BROADWAY_DISPLAY=:5 gtk3-demo + + + + +Broadway-specific environment variables + + + + <envar>BROADWAY_DISPLAY</envar> + + + 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: + + port = 8080 + (display - 1) + + + diff --git a/docs/reference/gtk/building.sgml b/docs/reference/gtk/building.sgml index 9e47fda5f9..542782c310 100644 --- a/docs/reference/gtk/building.sgml +++ b/docs/reference/gtk/building.sgml @@ -317,8 +317,8 @@ How to compile GTK+ itself configure - --disable-modules - --enable-modules + --disable-modules + --enable-modules @@ -330,52 +330,68 @@ How to compile GTK+ itself - --disable-Bsymbolic - --enable-Bsymbolic + --disable-Bsymbolic + --enable-Bsymbolic - --disable-xkb - --enable-xkb + --disable-xkb + --enable-xkb - --disable-xinerama - --enable-xinerama + --disable-xinerama + --enable-xinerama - --disable-gtk-doc - --enable-gtk-doc + --disable-gtk-doc + --enable-gtk-doc - --disable-cups - --enable-cups + --disable-cups + --enable-cups - --disable-papi - --enable-papi + --disable-papi + --enable-papi - --enable-xinput - --disable-xinput + --enable-xinput + --disable-xinput - --enable-packagekit - --disable-packagekit + --enable-packagekit + --disable-packagekit - --enable-x11-backend - --disable-x11-backend - --enable-win32-backend - --disable-win32-backend - --enable-quartz-backend - --disable-quartz-backend + --enable-x11-backend + --disable-x11-backend + + + + --enable-win32-backend + --disable-win32-backend + + + + --enable-quartz-backend + --disable-quartz-backend + + + + --enable-broadway-backend + --disable-broadway-backend + + + + --enable-wayland-backend + --disable-wayland-backend @@ -383,8 +399,8 @@ How to compile GTK+ itself - --enable-gtk2-dependency - --disable-gtk2-dependency + --enable-gtk2-dependency + --disable-gtk2-dependency @@ -571,7 +587,11 @@ How to compile GTK+ itself --enable-win32-backend, --disable-win32-backend, --enable-quartz-backend, - and --disable-quartz-backend + --disable-quartz-backend, + --enable-broadway-backend, + --disable-broadway-backend, + --enable-wayland-backend, and + --disable-wayland-backend 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 56de8e287c..6260fb8cfc 100644 --- a/docs/reference/gtk/gtk-docs.sgml +++ b/docs/reference/gtk/gtk-docs.sgml @@ -383,6 +383,7 @@ + diff --git a/docs/reference/gtk/running.sgml b/docs/reference/gtk/running.sgml index 3e4966af0e..576f83f25f 100644 --- a/docs/reference/gtk/running.sgml +++ b/docs/reference/gtk/running.sgml @@ -126,7 +126,7 @@ variables like LANG, PATH, HOME or DISPLAY; mostly to determine paths to look for certain files. The X11, Windows and -Framebuffer GDK backends use some +Broadway GDK backends use some additional environment variables. @@ -452,12 +452,12 @@ nevertheless. broadway - Selects the HTML5 backend. + Selects the Broadway backend for display in web browsers wayland - Selects the Wayland backend for connecting to Wayland display servers. + Selects the Wayland backend for connecting to Wayland display servers @@ -465,15 +465,6 @@ nevertheless. - - <envar>GDK_SYNCHRONIZE</envar> - - - If set, GDK makes all X requests synchronously. This is a useful - option for debugging, but it will slow down the performance considerably. - - - <envar>XDG_DATA_HOME</envar>, <envar>XDG_DATA_DIRS</envar> diff --git a/docs/reference/gtk/x11.sgml b/docs/reference/gtk/x11.sgml index 7a8bcfc90d..bb588b1163 100644 --- a/docs/reference/gtk/x11.sgml +++ b/docs/reference/gtk/x11.sgml @@ -56,6 +56,33 @@ in the DISPLAY environment variable. + +X11-specific environment variables + + +The X11 GDK backend can be influenced with some additional environment variables. + + + + <envar>GDK_SYNCHRONIZE</envar> + + + If set, GDK makes all X requests synchronously. This is a useful + option for debugging, but it will slow down the performance considerably. + + + + + <envar>GDK_CORE_DEVICE_EVENTS</envar> + + + If set, GDK makes does not use the XInput extension, and only reacts + to core X input events. + + + + +