extern/sshuttle
1
1
Fork 0
mirror of https://github.com/sshuttle/sshuttle.git synced 2025-06-19 08:17:45 +02:00
Code Issues Packages Projects Releases Wiki Activity

sshuttle.md: fix whitespace issues.

Browse Source
This commit is contained in:
Tim D. Smith 2014-11-27 21:08:31 -08:00 committed by Brian May
parent c576682caf
commit 6121a6dca3
1 changed files with 15 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
src/sshuttle.md
View File

@ -47,7 +47,7 @@ entire subnet to the VPN.
not from outside machines. If you want to accept not from outside machines. If you want to accept
connections from other machines on your network (ie. to connections from other machines on your network (ie. to
run sshuttle on a router) try enabling IP Forwarding in run sshuttle on a router) try enabling IP Forwarding in
your kernel, then using `--listen 0.0.0.0:0`. your kernel, then using `--listen 0.0.0.0:0`.
-H, --auto-hosts -H, --auto-hosts
: scan for remote hostnames and update the local /etc/hosts : scan for remote hostnames and update the local /etc/hosts
@ -63,26 +63,26 @@ entire subnet to the VPN.
all running copies. Third, if you're only routing a all running copies. Third, if you're only routing a
few subnets over the VPN, you probably would prefer to few subnets over the VPN, you probably would prefer to
keep using your local DNS server for everything else. keep using your local DNS server for everything else.
-N, --auto-nets -N, --auto-nets
: in addition to the subnets provided on the command : in addition to the subnets provided on the command
line, ask the server which subnets it thinks we should line, ask the server which subnets it thinks we should
route, and route those automatically. The suggestions route, and route those automatically. The suggestions
are taken automatically from the server's routing are taken automatically from the server's routing
table. table.
--dns --dns
: capture local DNS requests and forward to the remote DNS : capture local DNS requests and forward to the remote DNS
server. server.
--python --python
: specify the name/path of the remote python interpreter. : specify the name/path of the remote python interpreter.
The default is just `python`, which means to use the The default is just `python`, which means to use the
default python interpreter on the remote system's PATH. default python interpreter on the remote system's PATH.
-r, --remote=*[username@]sshserver[:port]* -r, --remote=*[username@]sshserver[:port]*
: the remote hostname and optional username and ssh : the remote hostname and optional username and ssh
port number to use for connecting to the remote server. port number to use for connecting to the remote server.
For example, example.com, testuser@example.com, For example, example.com, testuser@example.com,
testuser@example.com:2222, or example.com:2244. testuser@example.com:2222, or example.com:2244.
@ -102,7 +102,7 @@ entire subnet to the VPN.
: print more information about the session. This option : print more information about the session. This option
can be used more than once for increased verbosity. By can be used more than once for increased verbosity. By
default, sshuttle prints only error messages. default, sshuttle prints only error messages.
-e, --ssh-cmd -e, --ssh-cmd
: the command to use to connect to the remote server. The : the command to use to connect to the remote server. The
default is just `ssh`. Use this if your ssh client is default is just `ssh`. Use this if your ssh client is
@ -111,12 +111,12 @@ entire subnet to the VPN.
--seed-hosts --seed-hosts
: a comma-separated list of hostnames to use to : a comma-separated list of hostnames to use to
initialize the `--auto-hosts` scan algorithm. initialize the `--auto-hosts` scan algorithm.
`--auto-hosts` does things like poll local SMB servers `--auto-hosts` does things like poll local SMB servers
for lists of local hostnames, but can speed things up for lists of local hostnames, but can speed things up
if you use this option to give it a few names to start if you use this option to give it a few names to start
from. from.
--no-latency-control --no-latency-control
: sacrifice latency to improve bandwidth benchmarks. ssh : sacrifice latency to improve bandwidth benchmarks. ssh
uses really big socket buffers, which can overload the uses really big socket buffers, which can overload the
@ -132,16 +132,16 @@ entire subnet to the VPN.
trying to control). This option disables the latency trying to control). This option disables the latency
control feature, maximizing bandwidth usage. Use at control feature, maximizing bandwidth usage. Use at
your own risk. your own risk.
-D, --daemon -D, --daemon
: automatically fork into the background after connecting : automatically fork into the background after connecting
to the remote server. Implies `--syslog`. to the remote server. Implies `--syslog`.
--syslog --syslog
: after connecting, send all log messages to the : after connecting, send all log messages to the
`syslog`(3) service instead of stderr. This is `syslog`(3) service instead of stderr. This is
implicit if you use `--daemon`. implicit if you use `--daemon`.
--pidfile=*pidfilename* --pidfile=*pidfilename*
: when using `--daemon`, save sshuttle's pid to : when using `--daemon`, save sshuttle's pid to
*pidfilename*. The default is `sshuttle.pid` in the *pidfilename*. The default is `sshuttle.pid` in the
@ -159,7 +159,7 @@ entire subnet to the VPN.
automatically run `sudo` or `su` to start the firewall automatically run `sudo` or `su` to start the firewall
manager, but the core of sshuttle still runs as a manager, but the core of sshuttle still runs as a
normal user. normal user.
--hostwatch --hostwatch
: (internal use only) run the hostwatch daemon. This : (internal use only) run the hostwatch daemon. This
process runs on the server side and collects hostnames for process runs on the server side and collects hostnames for
@ -176,7 +176,7 @@ Test locally by proxying all local connections, without using ssh:
Starting sshuttle proxy. Starting sshuttle proxy.
Listening on ('0.0.0.0', 12300). Listening on ('0.0.0.0', 12300).
[local sudo] Password: [local sudo] Password:
firewall manager ready. firewall manager ready.
c : connecting to server... c : connecting to server...
s: available routes: s: available routes:
@ -230,7 +230,7 @@ there. Thus, you don't need to install sshuttle on the
remote server, and there are never sshuttle version remote server, and there are never sshuttle version
conflicts between client and server. conflicts between client and server.
Unlike most VPNs, sshuttle forwards sessions, not packets. Unlike most VPNs, sshuttle forwards sessions, not packets.
That is, it uses kernel transparent proxying (`iptables That is, it uses kernel transparent proxying (`iptables
REDIRECT` rules on Linux, or `ipfw fwd` rules on BSD) to REDIRECT` rules on Linux, or `ipfw fwd` rules on BSD) to
capture outgoing TCP sessions, then creates entirely capture outgoing TCP sessions, then creates entirely
@ -282,4 +282,3 @@ and reboot.
# SEE ALSO # SEE ALSO
`ssh`(1), `python`(1) `ssh`(1), `python`(1)