extern/sshuttle
1
1
Fork 0
mirror of https://github.com/sshuttle/sshuttle.git synced 2024-11-25 09:23:48 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update usage documentation

Browse Source
This commit is contained in:
Brian May 2016-01-20 21:19:44 +11:00
parent ee26157faa
commit 0392a779a2
2 changed files with 19 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/manpage.rst
View File

@ -37,6 +37,12 @@ Options
netmask), and 0/0 ('just route everything through the netmask), and 0/0 ('just route everything through the
VPN'). VPN').
.. option:: --method [auto|nat|tproxy|pf]
Which firewall method should sshuttle use? For auto, sshuttle attempts to
guess the appropriate method depending on what it can find in PATH. The
default value is auto.
.. option:: -l, --listen=[ip:]port .. option:: -l, --listen=[ip:]port
Use this ip address and port number as the transparent Use this ip address and port number as the transparent
@ -278,7 +284,6 @@ there is no need for congestion control to be shared
between the two separate streams, so a tcp-based tunnel is between the two separate streams, so a tcp-based tunnel is
fine. fine.
.. seealso::
See Also :manpage:`ssh(1)`, :manpage:`python(1)`
--------
:manpage:`ssh(1)`, :manpage:`python(1)`

19
docs/usage.rst
View File

@ -6,25 +6,28 @@ Usage
For information on usage with Windows, see the :doc:`windows` section. For information on usage with Windows, see the :doc:`windows` section.
For information on using the TProxy method, see the :doc:`tproxy` section. For information on using the TProxy method, see the :doc:`tproxy` section.
- Forward all traffic:: Forward all traffic::
sshuttle -r username@sshserver 0.0.0.0/0 sshuttle -r username@sshserver 0.0.0.0/0
- Use the :option:`sshuttle -r` parameter to specify a remote server.
- By default sshuttle will automatically choose a method to use. Override with - By default sshuttle will automatically choose a method to use. Override with
the ``--method=`` parameter. the :option:`sshuttle --method` parameter.
- There is a shortcut for 0.0.0.0/0 for those that value - There is a shortcut for 0.0.0.0/0 for those that value
their wrists:: their wrists::
sshuttle -r username@sshserver 0/0 sshuttle -r username@sshserver 0/0
- If you would also like your DNS queries to be proxied If you would also like your DNS queries to be proxied
through the DNS server of the server you are connect to:: through the DNS server of the server you are connect to::
sshuttle --dns -r username@sshserver 0/0 sshuttle --dns -r username@sshserver 0/0
The above is probably what you want to use to prevent The above is probably what you want to use to prevent
local network attacks such as Firesheep and friends. local network attacks such as Firesheep and friends.
See the documentation for the :option:`sshuttle --dns` parameter.
(You may be prompted for one or more passwords; first, the local password to (You may be prompted for one or more passwords; first, the local password to
become root using sudo, and then the remote ssh password. Or you might have become root using sudo, and then the remote ssh password. Or you might have