Skip to content

Commit 0392a77

Browse files
committed
Update usage documentation
1 parent ee26157 commit 0392a77

File tree

2 files changed

+19
-11
lines changed

2 files changed

+19
-11
lines changed

docs/manpage.rst

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,12 @@ Options
3737
netmask), and 0/0 ('just route everything through the
3838
VPN').
3939

40+
.. option:: --method [auto|nat|tproxy|pf]
41+
42+
Which firewall method should sshuttle use? For auto, sshuttle attempts to
43+
guess the appropriate method depending on what it can find in PATH. The
44+
default value is auto.
45+
4046
.. option:: -l, --listen=[ip:]port
4147

4248
Use this ip address and port number as the transparent
@@ -278,7 +284,6 @@ there is no need for congestion control to be shared
278284
between the two separate streams, so a tcp-based tunnel is
279285
fine.
280286

287+
.. seealso::
281288

282-
See Also
283-
--------
284-
:manpage:`ssh(1)`, :manpage:`python(1)`
289+
:manpage:`ssh(1)`, :manpage:`python(1)`

docs/usage.rst

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,28 @@ Usage
66
For information on usage with Windows, see the :doc:`windows` section.
77
For information on using the TProxy method, see the :doc:`tproxy` section.
88

9-
- Forward all traffic::
9+
Forward all traffic::
1010

11-
sshuttle -r username@sshserver 0.0.0.0/0
11+
sshuttle -r username@sshserver 0.0.0.0/0
12+
13+
- Use the :option:`sshuttle -r` parameter to specify a remote server.
1214

1315
- By default sshuttle will automatically choose a method to use. Override with
14-
the ``--method=`` parameter.
16+
the :option:`sshuttle --method` parameter.
1517

1618
- There is a shortcut for 0.0.0.0/0 for those that value
1719
their wrists::
1820

1921
sshuttle -r username@sshserver 0/0
2022

21-
- If you would also like your DNS queries to be proxied
22-
through the DNS server of the server you are connect to::
23+
If you would also like your DNS queries to be proxied
24+
through the DNS server of the server you are connect to::
2325

24-
sshuttle --dns -r username@sshserver 0/0
26+
sshuttle --dns -r username@sshserver 0/0
2527

26-
The above is probably what you want to use to prevent
27-
local network attacks such as Firesheep and friends.
28+
The above is probably what you want to use to prevent
29+
local network attacks such as Firesheep and friends.
30+
See the documentation for the :option:`sshuttle --dns` parameter.
2831

2932
(You may be prompted for one or more passwords; first, the local password to
3033
become root using sudo, and then the remote ssh password. Or you might have

0 commit comments

Comments
 (0)