summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndré Draszik <git@andred.net>2018-01-03 11:51:09 +0000
committerBrian May <brian@linuxpenguins.xyz>2018-12-29 15:02:18 +1100
commit531a17c151aefd817158946c48aa1eec8dcf7994 (patch)
treedb84a127c71c804a49283c4cd08462322bae2e86
parentd43db80decebce2d3e072f3b0a6acb9d0f71d523 (diff)
docs: document --ns-hosts --to-ns and update --dns
--ns-hosts is available since commit d2ee34d71c0e ("dns: Added --ns-hosts to tunnel only some requests") (released as v0.72), but was never documented. --to-ns is available since commit be559fc78b88 ("Fix case where there is no --dns.") after several bugfixes, released as v0.78.4, but was never documented.
-rw-r--r--docs/manpage.rst25
1 files changed, 24 insertions, 1 deletions
diff --git a/docs/manpage.rst b/docs/manpage.rst
index 41339a9..f0703ca 100644
--- a/docs/manpage.rst
+++ b/docs/manpage.rst
@@ -94,7 +94,30 @@ Options
.. option:: --dns
Capture local DNS requests and forward to the remote DNS
- server.
+ server. All queries to any of the local system's DNS
+ servers (/etc/resolv.conf) will be intercepted and
+ resolved on the remote side of the tunnel instead, there
+ using the DNS specified via the :option:`--to-ns=` option,
+ if specified.
+
+.. option:: --ns-hosts=server1[,server2[,server3[...]]]
+
+ Capture local DNS requests to the specified server(s)
+ and forward to the remote DNS server. Contrary to the
+ :option:`--dns` option, this flag allows to specify the
+ DNS server(s) the queries to which to intercept,
+ instead of intercepting all DNS traffic on the local
+ machine. This can be useful when only certain DNS
+ requests should be resolved on the remote side of the
+ tunnel, e.g. in combination with dnsmasq.
+
+.. option:: --to-ns=server
+
+ The DNS to forward requests to when remote DNS
+ resolution is enabled. If not given, sshuttle will
+ simply resolve using the system configured resolver on
+ the remote side (via /etc/resolv.conf on the remote
+ side).
.. option:: --python