|
|
|
@ -1,11 +1,11 @@
|
|
|
|
.\" Generated by scdoc 1.11.1
|
|
|
|
.\" Generated by scdoc 1.11.2
|
|
|
|
.\" Complete documentation for this program is not available as a GNU info page
|
|
|
|
.\" Complete documentation for this program is not available as a GNU info page
|
|
|
|
.ie \n(.g .ds Aq \(aq
|
|
|
|
.ie \n(.g .ds Aq \(aq
|
|
|
|
.el .ds Aq '
|
|
|
|
.el .ds Aq '
|
|
|
|
.nh
|
|
|
|
.nh
|
|
|
|
.ad l
|
|
|
|
.ad l
|
|
|
|
.\" Begin generated content:
|
|
|
|
.\" Begin generated content:
|
|
|
|
.TH "waypipe" "1" "2021-04-03"
|
|
|
|
.TH "waypipe" "1" "2022-04-05"
|
|
|
|
.P
|
|
|
|
.P
|
|
|
|
.SH NAME
|
|
|
|
.SH NAME
|
|
|
|
.P
|
|
|
|
.P
|
|
|
|
@ -67,10 +67,12 @@ compressible as images containing pictures.\&
|
|
|
|
.RS 4
|
|
|
|
.RS 4
|
|
|
|
Select the compression method applied to data transfers.\& Options are
|
|
|
|
Select the compression method applied to data transfers.\& Options are
|
|
|
|
\fInone\fR (for high-bandwidth networks), \fIlz4\fR (intermediate), \fIzstd\fR
|
|
|
|
\fInone\fR (for high-bandwidth networks), \fIlz4\fR (intermediate), \fIzstd\fR
|
|
|
|
(slow connection).\& The default compression is \fInone\fR.\& The compression
|
|
|
|
(slow connection).\& The default compression is \fInone\fR.\&† The compression
|
|
|
|
level can be chosen by appending = followed by a number.\& For example,
|
|
|
|
level can be chosen by appending = followed by a number.\& For example,
|
|
|
|
if \fBC\fR is \fIzstd=7\fR, waypipe will use level 7 Zstd compression.\&
|
|
|
|
if \fBC\fR is \fIzstd=7\fR, waypipe will use level 7 Zstd compression.\&
|
|
|
|
.P
|
|
|
|
.P
|
|
|
|
|
|
|
|
† In a future version, the default will change to \fIlz4\fR.\&
|
|
|
|
|
|
|
|
.P
|
|
|
|
.RE
|
|
|
|
.RE
|
|
|
|
\fB-d, --debug\fR
|
|
|
|
\fB-d, --debug\fR
|
|
|
|
.RS 4
|
|
|
|
.RS 4
|
|
|
|
@ -103,7 +105,10 @@ both the client and the server for their socket paths.\&
|
|
|
|
.RE
|
|
|
|
.RE
|
|
|
|
\fB--version\fR
|
|
|
|
\fB--version\fR
|
|
|
|
.RS 4
|
|
|
|
.RS 4
|
|
|
|
Print the version number and quit.\&
|
|
|
|
Briefly describe Waypipe'\&s version and the features it was built with,
|
|
|
|
|
|
|
|
then quit.\& Possible features: LZ4 compression support, ZSTD compression
|
|
|
|
|
|
|
|
support, ability to transfer DMABUFs, video compression support, VAAPI
|
|
|
|
|
|
|
|
hardware video de/encoding support.\&
|
|
|
|
.P
|
|
|
|
.P
|
|
|
|
.RE
|
|
|
|
.RE
|
|
|
|
\fB--allow-tiled\fR
|
|
|
|
\fB--allow-tiled\fR
|
|
|
|
@ -119,7 +124,7 @@ when they are available.\&
|
|
|
|
.RS 4
|
|
|
|
.RS 4
|
|
|
|
For server or ssh mode, provide the path to the "control pipe" that will
|
|
|
|
For server or ssh mode, provide the path to the "control pipe" that will
|
|
|
|
be created the the server.\& Writing (with \fBwaypipe recon C T\fR, or
|
|
|
|
be created the the server.\& Writing (with \fBwaypipe recon C T\fR, or
|
|
|
|
'echo -n T > C') a new socket path to this pipe will make the server
|
|
|
|
\&'\&echo -n T > C'\&) a new socket path to this pipe will make the server
|
|
|
|
instance replace all running connections with connections to the new
|
|
|
|
instance replace all running connections with connections to the new
|
|
|
|
Unix socket.\& The new socket should ultimately forward data to the same
|
|
|
|
Unix socket.\& The new socket should ultimately forward data to the same
|
|
|
|
waypipe client that the server was connected to before.\&
|
|
|
|
waypipe client that the server was connected to before.\&
|
|
|
|
@ -254,10 +259,10 @@ to connect to \fIremote\fR from computer \fIlocal\fR:
|
|
|
|
.nf
|
|
|
|
.nf
|
|
|
|
.RS 4
|
|
|
|
.RS 4
|
|
|
|
$ waypipe --socket /tmp/waypipe-remote\&.sock client &
|
|
|
|
$ waypipe --socket /tmp/waypipe-remote\&.sock client &
|
|
|
|
$ ncat --ssl -lk 12345 --sh-exec 'ncat -U /tmp/waypipe-remote\&.sock' &
|
|
|
|
$ ncat --ssl -lk 12345 --sh-exec \&'ncat -U /tmp/waypipe-remote\&.sock\&' &
|
|
|
|
$ ssh user@remote
|
|
|
|
$ ssh user@remote
|
|
|
|
|
|
|
|
|
|
|
|
> ncat -lkU /tmp/waypipe-local\&.sock --sh-exec 'ncat --ssl local 12345' &
|
|
|
|
> ncat -lkU /tmp/waypipe-local\&.sock --sh-exec \&'ncat --ssl local 12345\&' &
|
|
|
|
> waypipe --display wayland-local \\
|
|
|
|
> waypipe --display wayland-local \\
|
|
|
|
--socket /tmp/waypipe-local\&.sock server -- sleep inf &
|
|
|
|
--socket /tmp/waypipe-local\&.sock server -- sleep inf &
|
|
|
|
> WAYLAND_DISPLAY=wayland-local application
|
|
|
|
> WAYLAND_DISPLAY=wayland-local application
|
|
|
|
@ -265,7 +270,7 @@ to connect to \fIremote\fR from computer \fIlocal\fR:
|
|
|
|
.RE
|
|
|
|
.RE
|
|
|
|
.P
|
|
|
|
.P
|
|
|
|
Given a certificate file, socat can also provide an encrypted connection
|
|
|
|
Given a certificate file, socat can also provide an encrypted connection
|
|
|
|
(remove 'verify=0' to check certificates):
|
|
|
|
(remove '\&verify=0'\& to check certificates):
|
|
|
|
.P
|
|
|
|
.P
|
|
|
|
.nf
|
|
|
|
.nf
|
|
|
|
.RS 4
|
|
|
|
.RS 4
|
|
|
|
@ -281,7 +286,7 @@ Given a certificate file, socat can also provide an encrypted connection
|
|
|
|
.RE
|
|
|
|
.RE
|
|
|
|
.P
|
|
|
|
.P
|
|
|
|
Many applications require specific environment variables to use Wayland instead
|
|
|
|
Many applications require specific environment variables to use Wayland instead
|
|
|
|
of X11.\& If ssh isn't configured to support loading \fI~/.\&ssh/environment\fR,
|
|
|
|
of X11.\& If ssh isn'\&t configured to support loading \fI~/.\&ssh/environment\fR,
|
|
|
|
one can use \fIenv\fR to set the needed variables each time; or run waypipe without
|
|
|
|
one can use \fIenv\fR to set the needed variables each time; or run waypipe without
|
|
|
|
a command, to use the login shell environment.\&
|
|
|
|
a command, to use the login shell environment.\&
|
|
|
|
.P
|
|
|
|
.P
|
|
|
|
|
