diff options
| author | Brian May <brian@linuxpenguins.xyz> | 2016-01-20 21:19:44 +1100 |
|---|---|---|
| committer | Brian May <brian@linuxpenguins.xyz> | 2016-01-20 21:19:44 +1100 |
| commit | 0392a779a2a2e3bdaef976354c335fca92900419 (patch) | |
| tree | b56c9e7624d19efa500f64e61d5a92de8b7e732f | |
| parent | ee26157faacd15047f1707648792805619e541ea (diff) | |
Update usage documentation
| -rw-r--r-- | docs/manpage.rst | 11 | ||||
| -rw-r--r-- | docs/usage.rst | 19 |
2 files changed, 19 insertions, 11 deletions
diff --git a/docs/manpage.rst b/docs/manpage.rst index 9cfd8a7..434fe17 100644 --- a/docs/manpage.rst +++ b/docs/manpage.rst @@ -37,6 +37,12 @@ Options netmask), and 0/0 ('just route everything through the 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 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 fine. +.. seealso:: -See Also --------- -:manpage:`ssh(1)`, :manpage:`python(1)` + :manpage:`ssh(1)`, :manpage:`python(1)` diff --git a/docs/usage.rst b/docs/usage.rst index bf387c6..d782a95 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -6,25 +6,28 @@ Usage For information on usage with Windows, see the :doc:`windows` 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 - the ``--method=`` parameter. + the :option:`sshuttle --method` parameter. - There is a shortcut for 0.0.0.0/0 for those that value their wrists:: sshuttle -r username@sshserver 0/0 -- If you would also like your DNS queries to be proxied - through the DNS server of the server you are connect to:: +If you would also like your DNS queries to be proxied +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 - local network attacks such as Firesheep and friends. +The above is probably what you want to use to prevent +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 become root using sudo, and then the remote ssh password. Or you might have |