From 36d34b18da7752c0e2593fc7851846a60250945c Mon Sep 17 00:00:00 2001 From: Brian May Date: Fri, 13 Dec 2019 15:53:55 +1100 Subject: [PATCH] Fix various errors in documentation --- docs/manpage.rst | 24 ++++++++++++------------ docs/openwrt.rst | 3 ++- docs/platform.rst | 1 + 3 files changed, 15 insertions(+), 13 deletions(-) diff --git a/docs/manpage.rst b/docs/manpage.rst index 02a669e..8a5b09a 100644 --- a/docs/manpage.rst +++ b/docs/manpage.rst @@ -28,7 +28,7 @@ Options ------- .. program:: sshuttle -.. option:: subnets +.. option:: A list of subnets to route over the VPN, in the form ``a.b.c.d[/width][port[-port]]``. Valid examples are 1.2.3.4 (a @@ -44,13 +44,13 @@ Options to during startup will be routed over the VPN. Valid examples are example.com, example.com:8000 and example.com:8000-9000. -.. option:: --method [auto|nat|nft|tproxy|pf] +.. option:: --method 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 <[ip:]port>, --listen=<[ip:]port> Use this ip address and port number as the transparent proxy port. By default :program:`sshuttle` finds an available @@ -97,10 +97,10 @@ Options 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, + using the DNS specified via the :option:`--to-ns` option, if specified. -.. option:: --ns-hosts=server1[,server2[,server3[...]]] +.. option:: --ns-hosts= Capture local DNS requests to the specified server(s) and forward to the remote DNS server. Contrary to the @@ -111,7 +111,7 @@ Options requests should be resolved on the remote side of the tunnel, e.g. in combination with dnsmasq. -.. option:: --to-ns=server +.. option:: --to-ns= The DNS to forward requests to when remote DNS resolution is enabled. If not given, sshuttle will @@ -125,14 +125,14 @@ Options The default is just ``python``, which means to use the default python interpreter on the remote system's PATH. -.. option:: -r, --remote=[username@]sshserver[:port] +.. option:: -r <[username@]sshserver[:port]>, --remote=<[username@]sshserver[:port]> The remote hostname and optional username and ssh port number to use for connecting to the remote server. For example, example.com, testuser@example.com, testuser@example.com:2222, or example.com:2244. -.. option:: -x, --exclude=subnet +.. option:: -x , --exclude= Explicitly exclude this subnet from forwarding. The format of this option is the same as the ```` @@ -141,7 +141,7 @@ Options ``0/0 -x 1.2.3.0/24`` to forward everything except the local subnet over the VPN, for example. -.. option:: -X, --exclude-from=file +.. option:: -X , --exclude-from= Exclude the subnets specified in a file, one subnet per line. Useful when you have lots of subnets to exclude. @@ -207,7 +207,7 @@ Options :manpage:`syslog(3)` service instead of stderr. This is implicit if you use :option:`--daemon`. -.. option:: --pidfile=pidfilename +.. option:: --pidfile= when using :option:`--daemon`, save :program:`sshuttle`'s pid to *pidfilename*. The default is ``sshuttle.pid`` in the @@ -252,7 +252,7 @@ Options Default is the current user.set ALL for all users. Only works with --sudoers or --sudoers-no-modify option. ---option:: --sudoers-filename +.. option:: --sudoers-filename Set the file name for the sudoers.d file to be added. Default is "sshuttle_auto". Only works with --sudoers. @@ -269,7 +269,7 @@ file. To run :program:`sshuttle` with options defined in, e.g., `/etc/sshuttle.conf` just pass the path to the file preceded by the `@` character, e.g. -:option:`@/etc/sshuttle.conf`. +`@/etc/sshuttle.conf`. When running :program:`sshuttle` with options defined in a configuration file, options can still be passed via the command line in addition to what is diff --git a/docs/openwrt.rst b/docs/openwrt.rst index 27db58f..46c6614 100644 --- a/docs/openwrt.rst +++ b/docs/openwrt.rst @@ -1,7 +1,8 @@ OpenWRT ======== -Run: +Run:: + opkg install python3 python3-pip iptables-mod-nat-extra iptables-mod-ipopt python3 /usr/bin/pip3 install sshuttle sshuttle -l 0.0.0.0 -r -x 192.168.1.1 0/0 diff --git a/docs/platform.rst b/docs/platform.rst index 856ddf2..0ec53ab 100644 --- a/docs/platform.rst +++ b/docs/platform.rst @@ -9,3 +9,4 @@ Contents: chromeos tproxy windows + openwrt