diff options
author | Emmanuele Bassi <ebassi@gnome.org> | 2021-03-31 20:06:54 +0100 |
---|---|---|
committer | Emmanuele Bassi <ebassi@gnome.org> | 2021-03-31 20:06:54 +0100 |
commit | 3fdedce8f690081a746e360b4da5ee7a6ba525ef (patch) | |
tree | 0a4af9905e5dd415d1ae78582bca3dcb05d6cded | |
parent | 5f0fe09423051dec65b6af4156ac9b7258ddc45d (diff) | |
download | gtk+-ebassi/broadway-docs.tar.gz |
docs: Update the Broadway instructionsebassi/broadway-docs
The Broadway server binary is now versioned, and it's not compatible
with the GTK3 server.
-rw-r--r-- | docs/reference/gtk/broadway.md | 42 |
1 files changed, 24 insertions, 18 deletions
diff --git a/docs/reference/gtk/broadway.md b/docs/reference/gtk/broadway.md index 8bf24c43c1..99987845cf 100644 --- a/docs/reference/gtk/broadway.md +++ b/docs/reference/gtk/broadway.md @@ -3,27 +3,29 @@ Slug: broadway ## Using GTK with Broadway -The GDK Broadway backend provides support for displaying GTK -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 to enable web sockets in your web browser. +The GDK Broadway backend provides support for displaying GTK applications in +a web browser, using HTML5 and web sockets. -You can choose a different port from the default 8080 by setting -the `BROADWAY_DISPLAY` environment variable to the port that you -want to use. +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 to +enable web sockets in your web browser. -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: +You can choose a different port from the default 8080 by setting 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, `gtk4-broadwayd`, that ships with GTK. +To start the Broadway server use: ``` -broadwayd :5 +gtk4-broadwayd :5 ``` Then point your web browser at `http://127.0.0.1:8085`. -Start your applications like this: + +Once the Broadway server is running, you can start your applications like +this: ``` GDK_BACKEND=broadway BROADWAY_DISPLAY=:5 gtk4-demo @@ -31,9 +33,13 @@ GDK_BACKEND=broadway BROADWAY_DISPLAY=:5 gtk4-demo ## Broadway-specific environment variables -### BROADWAY\_DISPLAY +### `BROADWAY_DISPLAY` Specifies the Broadway display number. The default display is 0. -The display number determines the port to use when connecting -to a Broadway application via the following formula: -`port = 8080 + display` + +The display number determines the port to use when connecting to a Broadway +application via the following formula: + +``` +port = 8080 + display +``` |