SHYPIPE(1)

2024-05-07

NAME

shypipe - a pipe that transfers data over the network

SYNOPSIS

shypipe [-C path] [-c path] [-k path] [-p port] [-t type] [-v] [host]

DESCRIPTION

shypipe acts like a pipe but transfers data over the network using TCP and (at your option) TLS. Therefore, the sending and receiving end can run on different hosts. For the sender, the address of the receiver can be supplied using the first non-option argument. If unset, it defaults to "localhost".

To use TLS, the CA must be set on the sending end and the certificate and private key must be set on the receiving side. Leave the options unset otherwise.

The options are as follows:

-C path

Set the path to the certificate of the CA. If unset, TLS will not be used. This option only has an effect on the sending end.

-c path

Set the path to the certificate to use. If unset, TLS will not be used. This option only has an effect on the receiving end.

-k path

Set the path to the private key to use. If unset, TLS will not be used. This option only has an effect on the receiving end.

-p port

Set the port for the receiver to listen on and for the sender connect to. This option defaults to 4222.

-t type

Set the pipe type of the process. Only "tx" (sender) and "rx" (receiver) are valid. This option defaults to "rx".

-v

Print the version information and exit.

EXIT STATUS

shypipe exits with 0 on success and with 1 otherwise.

AUTHORS

Created and maintained by Hannes Braun <hannes@hannesbraun.net>. Up-to-date sources can be found at https://git.sr.ht/~hannes/shypipe. Bugs and patches can be submitted by email to ~hannes/public-inbox@lists.sr.ht.