gtk2/docs/reference/gtk/gtk4-broadwayd.xml

<?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="gtk4-broadwayd">

<refentryinfo>
  <title>gtk4-broadwayd</title>
  <productname>GTK+</productname>
  <authorgroup>
    <author>
      <contrib>Developer</contrib>
      <firstname>Alexander</firstname>
      <surname>Larsson</surname>
    </author>
  </authorgroup>
</refentryinfo>

<refmeta>
  <refentrytitle>gtk4-broadwayd</refentrytitle>
  <manvolnum>1</manvolnum>
  <refmiscinfo class="manual">User Commands</refmiscinfo>
</refmeta>

<refnamediv>
  <refname>gtk4-broadwayd</refname>
  <refpurpose>Broadway display server</refpurpose>
</refnamediv>

<refsynopsisdiv>
<cmdsynopsis>
<command>gtk4-broadwayd</command>
<arg choice="opt">--port <replaceable>PORT</replaceable></arg>
<arg choice="opt">--address <replaceable>ADDRESS</replaceable></arg>
<arg choice="opt">--unixsocket <replaceable>ADDRESS</replaceable></arg>
<arg choice="opt"><replaceable>:DISPLAY</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>

<refsect1><title>Description</title>
<para>
<command>gtk4-broadwayd</command> is a display server for the Broadway
GDK backend. It allows multiple GTK+ applications to display their
windows in the same web browser, by connecting to gtk4-broadwayd.
</para>
<para>
When using gtk4-broadwayd, specify the display number to use, prefixed
with a colon, similar to X. The default display number is 0.
<programlisting>
gtk4-broadwayd :5
</programlisting>
Then point your web browser at <literal>http://127.0.0.1:8085</literal>.
Start your applications like this:
<programlisting>
GDK_BACKEND=broadway BROADWAY_DISPLAY=:5 gtk3-demo
</programlisting>

You can add password protection for your session by creating a file in
<filename>$XDG_CONFIG_HOME/broadway.passwd</filename> or <filename>$HOME/.config/broadway.passwd</filename>
with a crypt(3) style password hash.

A simple way to generate it is with openssl:
<programlisting>
openssl passwd -1  > ~/.config/broadway.passwd
</programlisting>

</para>
</refsect1>

<refsect1><title>Options</title>
<variablelist>
  <varlistentry>
    <term>--port</term>
    <listitem><para>Use <replaceable>PORT</replaceable> as the HTTP
      port, instead of the default 8080 + (<replaceable>DISPLAY</replaceable> - 1).
      </para></listitem>
  </varlistentry>
  <varlistentry>
    <term>--address</term>
    <listitem><para>Use <replaceable>ADDRESS</replaceable> as the HTTP
      address, instead of the default <literal>http://127.0.0.1:<replaceable>PORT</replaceable></literal>.
      </para></listitem>
  </varlistentry>
  <varlistentry>
    <term>--unixsocket</term>
    <listitem><para>Use <replaceable>ADDRESS</replaceable> as the unix domain socket
      address. This option overrides <literal>--address</literal> and <literal>--port</literal>.
      It is available only on Unix-like systems.
      </para></listitem>
  </varlistentry>
</variablelist>
</refsect1>

</refentry>