AuroraMiddleware/gtk
1
0
Fork 1
mirror of https://gitlab.gnome.org/GNOME/gtk.git synced 2024-11-09 18:30:08 +00:00
Code Issues Projects Releases Wiki Activity

Merge branch 'ebassi/broadway-docs' into 'master'

Browse Source 
docs: Update the Broadway instructions

See merge request GNOME/gtk!3380
This commit is contained in:
Matthias Clasen 2021-03-31 21:42:59 +00:00
commit 65a061f3c2
1 changed files with 24 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
docs/reference/gtk/broadway.md
View File

@ -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
```