summaryrefslogtreecommitdiffstats
path: root/system/waypipe/README
diff options
context:
space:
mode:
Diffstat (limited to 'system/waypipe/README')
-rw-r--r--system/waypipe/README20
1 files changed, 20 insertions, 0 deletions
diff --git a/system/waypipe/README b/system/waypipe/README
new file mode 100644
index 0000000000..a344915ec7
--- /dev/null
+++ b/system/waypipe/README
@@ -0,0 +1,20 @@
+Waypipe
+
+waypipe is a proxy for Wayland[0] clients. It forwards Wayland
+messages and serializes changes to shared memory buffers over a single
+socket. This makes application forwarding similar to ssh -X [1]
+feasible.
+
+aypipe should be installed on both the local and remote computers.
+There is a user-friendly command line pattern which prefixes a call to
+ssh and automatically sets up a reverse tunnel for protocol data. For
+example,
+
+waypipe ssh user@theserver weston-terminal
+
+
+will run ssh, connect to theserver, and remotely run weston-terminal,
+using local and remote waypipe processes to synchronize the shared
+memory buffers used by Wayland clients between both computers. Command
+line arguments before ssh apply only to waypipe; those after ssh
+belong to ssh.