summaryrefslogtreecommitdiffstats
path: root/docs/usage.rst
diff options
context:
space:
mode:
authorScott Kuhl <kuhl@mtu.edu>2020-10-21 01:05:21 -0400
committerScott Kuhl <kuhl@mtu.edu>2021-05-29 21:54:47 -0400
commit851b26cb13080d0897561240302b84adad4a4071 (patch)
tree5e9e17088fe9d8bcba037e21d66478b53fe35951 /docs/usage.rst
parentbc54ffe398db54379f74ec0262f077e59ddde802 (diff)
Update documentation
The output in the examples provided in the man page hadn't been updated as sshuttle changed its output over time. The example of testing sshuttle without a remote host was removed. It was the first example previously and it is something that is unlikely users will wish to do. Also: - Update some --help messages. - Manpage: Fix a typo. - Manpage: Mention that host specified with -r can be an ssh alias. - Eliminate variable only used once.
Diffstat (limited to 'docs/usage.rst')
-rw-r--r--docs/usage.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/usage.rst b/docs/usage.rst
index 646c968..3fd63a1 100644
--- a/docs/usage.rst
+++ b/docs/usage.rst
@@ -11,6 +11,10 @@ Forward all traffic::
sshuttle -r username@sshserver 0.0.0.0/0
- Use the :option:`sshuttle -r` parameter to specify a remote server.
+ One some systems, you may also need to use the :option:`sshuttle -x`
+ parameter to exclude sshserver or sshserver:22 so that your local
+ machine can communicate directly to sshserver without it being
+ redirected by sshuttle.
- By default sshuttle will automatically choose a method to use. Override with
the :option:`sshuttle --method` parameter.