Skip to content

Commit

Permalink
Encourage running 'vpn-slice --help' to see all options for routing c…
Browse files Browse the repository at this point in the history
…ustomization

#99 (comment)
  • Loading branch information
dlenski committed Nov 10, 2021
1 parent 7f9db25 commit ec32183
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,16 @@ interfaces.

`vpn-slice` makes it easy to set up a split-tunnel VPN:

* It only routes traffic for **specific hosts or subnets** through the VPN.
* By default, it only routes traffic for **specific hosts or subnets**
through the VPN.
* It automatically looks up named hosts, using the VPN's DNS servers,
and adds entries for them to your `/etc/hosts` (which it cleans up
after VPN disconnection), however it **does not otherwise alter your
`/etc/resolv.conf` at all**.
* It has many additional options to customize routing and lookup (for
example, `--route-splits` to additionally route traffic for specific
subnets requested *by the server*). Run `vpn-slice --help` to see
them all.

## Who this is for

Expand Down
2 changes: 1 addition & 1 deletion vpn_slice/__main__.py
Original file line number Diff line number Diff line change
Expand Up @@ -454,7 +454,7 @@ def parse_args_and_env(args=None, environ=os.environ):
g.add_argument('--domains-vpn-dns', dest='vpn_domains', default=None, help="comma separated domains to query with vpn dns")
g = p.add_argument_group('Debugging options')
g.add_argument('--self-test', action='store_true', help='Stop after verifying that environment variables and providers are configured properly.')
g.add_argument('-v', '--verbose', default=0, action='count', help="Explain what %(prog)s is doing")
g.add_argument('-v', '--verbose', default=0, action='count', help="Explain what %(prog)s is doing. Specify repeatedly to increase the level of detail.")
p.add_argument('-V', '--version', action='version', version='%(prog)s ' + __version__)
g.add_argument('-D', '--dump', action='store_true', help='Dump environment variables passed by caller')
g.add_argument('--no-fork', action='store_false', dest='fork', help="Don't fork and continue in background on connect")
Expand Down

0 comments on commit ec32183

Please sign in to comment.