/usr/bin/waypipe

A proxy to remotely use Wayland protocol applications
Example: waypipe ssh user@server weston-terminal
See `man 1 waypipe` for detailed help.

Usage: waypipe [OPTIONS] <MODE>

Modes:
  ssh     Wrap an ssh invocation to run Waypipe on both ends of the connection, and
          automatically forward Wayland applications
  server  Run remotely to run a process and forward application data through a socket
          to a matching `waypipe client` instance
  client  Run locally to set up a Unix socket that `waypipe server` can connect to
  bench   Estimate the best compression level used to send data, for each bandwidth

Options:
  -c, --compress <comp>       Choose compression method: lz4[=#], zstd[=#], none [default: lz4]
  -d, --debug                 Print debug messages
  -n, --no-gpu                Block protocols using GPU memory transfers (via DMABUFs)
  -o, --oneshot               Only permit one connected application
  -s, --socket <path>         Set the socket path to either create or connect to.
                              - server default: /tmp/waypipe-server.sock
                              - client default: /tmp/waypipe-client.sock
                              - ssh: sets the prefix for client and server socket paths
                              - vsock: [[s]CID:]port
      --display <display>     server,ssh: Set the Wayland display name or path
      --drm-node <path>       Set preferred DRM node (may be ignored in ssh/client modes)
      --remote-node <path>    ssh: Set the preferred remote DRM node
      --ssh-bin <path>        ssh: Set the ssh binary to use [default: ssh]
      --remote-bin <path>     ssh: Set the remote Waypipe binary to use [default: waypipe]
      --remote-socket <path>  ssh: sets prefix of the remote server socket path
      --login-shell           server: If server command is empty, run a login shell
      --threads <threads>     Number of worker threads to use: 0 ⇒ hardware threads/2 [default: 0]
      --title-prefix <str>    Prepend string to all window titles [default: ]
      --unlink-socket         server: Unlink the socket that Waypipe connects to
      --video <options>       Video-encode DMABUFs when possible
                              option format: (none|h264|vp9|av1)[,bpf=<X>] [default: none]
      --vsock                 Connect over vsock-type socket instead of unix socket
      --secctx <str>          client,ssh: Use security-context protocol with application ID
      --xwls                  server,ssh: Run xwayland-satellite to handle X11 clients
  -h, --help                  Print help
  -V, --version               Print version