.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.8.
.TH SSHTUNNEL "1" "February 2019" "sshtunnel 0.1.4" "User Commands"
.SH NAME
sshtunnel \- SSH tunnels to remote server
.SH DESCRIPTION
usage: sshtunnel [\-h] [\-U SSH_USERNAME] [\-p SSH_PORT] [\-P SSH_PASSWORD] \fB\-R\fR
.IP
IP:PORT [IP:PORT ...] [\-L [IP:PORT [IP:PORT ...]]]
[\-k SSH_HOST_KEY] [\-K KEY_FILE] [\-S KEY_PASSWORD] [\-t] [\-v]
[\-V] [\-x IP:PORT] [\-c SSH_CONFIG_FILE] [\-z] [\-n]
[\-d [FOLDER [FOLDER ...]]]
ssh_address
.PP
Pure python ssh tunnel utils
Version 0.1.4
.SS "positional arguments:"
.TP
ssh_address
SSH server IP address (GW for SSH tunnels)
set with "\-\- ssh_address" if immediately after \fB\-R\fR or \fB\-L\fR
.SS "optional arguments:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-U\fR SSH_USERNAME, \fB\-\-username\fR SSH_USERNAME
SSH server account username
.TP
\fB\-p\fR SSH_PORT, \fB\-\-server_port\fR SSH_PORT
SSH server TCP port (default: 22)
.TP
\fB\-P\fR SSH_PASSWORD, \fB\-\-password\fR SSH_PASSWORD
SSH server account password
.TP
\fB\-R\fR IP:PORT [IP:PORT ...], \fB\-\-remote_bind_address\fR IP:PORT [IP:PORT ...]
Remote bind address sequence: ip_1:port_1 ip_2:port_2 ... ip_n:port_n
Equivalent to ssh \fB\-Lxxxx\fR:IP_ADDRESS:PORT
If port is omitted, defaults to 22.
Example: \fB\-R\fR 10.10.10.10: 10.10.10.10:5900
.TP
\fB\-L\fR [IP:PORT [IP:PORT ...]], \fB\-\-local_bind_address\fR [IP:PORT [IP:PORT ...]]
Local bind address sequence: ip_1:port_1 ip_2:port_2 ... ip_n:port_n
Elements may also be valid UNIX socket domains:
\fI\,/tmp/foo.sock\/\fP /tmp/bar.sock ... \fI\,/tmp/baz.sock\/\fP
Equivalent to ssh \fB\-LPORT\fR:xxxxxxxxx:xxxx, being the local IP address optional.
By default it will listen in all interfaces (0.0.0.0) and choose a random port.
Example: \fB\-L\fR :40000
.TP
\fB\-k\fR SSH_HOST_KEY, \fB\-\-ssh_host_key\fR SSH_HOST_KEY
Gateway's host key
.TP
\fB\-K\fR KEY_FILE, \fB\-\-private_key_file\fR KEY_FILE
RSA/DSS/ECDSA private key file
.TP
\fB\-S\fR KEY_PASSWORD, \fB\-\-private_key_password\fR KEY_PASSWORD
RSA/DSS/ECDSA private key password
.TP
\fB\-t\fR, \fB\-\-threaded\fR
Allow concurrent connections to each tunnel
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Increase output verbosity (default: ERROR)
.TP
\fB\-V\fR, \fB\-\-version\fR
Show version number and quit
.TP
\fB\-x\fR IP:PORT, \fB\-\-proxy\fR IP:PORT
IP and port of SSH proxy to destination
.TP
\fB\-c\fR SSH_CONFIG_FILE, \fB\-\-config\fR SSH_CONFIG_FILE
SSH configuration file, defaults to ~/.ssh/config
.TP
\fB\-z\fR, \fB\-\-compress\fR
Request server for compression over SSH transport
.TP
\fB\-n\fR, \fB\-\-noagent\fR
Disable looking for keys from an SSH agent
.TP
\fB\-d\fR [FOLDER [FOLDER ...]], \fB\-\-host_pkey_directories\fR [FOLDER [FOLDER ...]]
List of directories where SSH pkeys (in the format `id_*`) may be found