Merge pull request #483 from chrisburr/patch-1

Fix formatting typos in usage docs
This commit is contained in:
Brian May 2020-07-05 11:00:18 +10:00 committed by GitHub
commit 329b9cd0a0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -21,7 +21,7 @@ Forward all traffic::
sshuttle -r username@sshserver 0/0 sshuttle -r username@sshserver 0/0
- For 'My VPN broke and need a temporary solution FAST to access local IPv4 addresses': - For 'My VPN broke and need a temporary solution FAST to access local IPv4 addresses'::
sshuttle --dns -NHr username@sshserver 10.0.0.0/8 172.16.0.0/12 192.168.0.0/16 sshuttle --dns -NHr username@sshserver 10.0.0.0/8 172.16.0.0/12 192.168.0.0/16
@ -70,7 +70,7 @@ Sudoers File
sshuttle can auto-generate the proper sudoers.d file using the current user sshuttle can auto-generate the proper sudoers.d file using the current user
for Linux and OSX. Doing this will allow sshuttle to run without asking for for Linux and OSX. Doing this will allow sshuttle to run without asking for
the local sudo password and to give users who do not have sudo access the local sudo password and to give users who do not have sudo access
ability to run sshuttle. ability to run sshuttle::
sshuttle --sudoers sshuttle --sudoers
@ -82,14 +82,14 @@ option:`sshuttle --sudoers --sudoers-username {user_descriptor}` option. Valid
values for this vary based on how your system is configured. Values such as values for this vary based on how your system is configured. Values such as
usernames, groups pre-pended with `%` and sudoers user aliases will work. See usernames, groups pre-pended with `%` and sudoers user aliases will work. See
the sudoers manual for more information on valid user specif actions. the sudoers manual for more information on valid user specif actions.
The options must be used with `--sudoers` The options must be used with `--sudoers`::
sshuttle --sudoers --sudoers-user mike sshuttle --sudoers --sudoers-user mike
sshuttle --sudoers --sudoers-user %sudo sshuttle --sudoers --sudoers-user %sudo
The name of the file to be added to sudoers.d can be configured as well. This The name of the file to be added to sudoers.d can be configured as well. This
is mostly not necessary but can be useful for giving more than one user is mostly not necessary but can be useful for giving more than one user
access to sshuttle. The default is `sshuttle_auto` access to sshuttle. The default is `sshuttle_auto`::
sshuttle --sudoer --sudoers-filename sshuttle_auto_mike sshuttle --sudoer --sudoers-filename sshuttle_auto_mike
sshuttle --sudoer --sudoers-filename sshuttle_auto_tommy sshuttle --sudoer --sudoers-filename sshuttle_auto_tommy
@ -97,11 +97,11 @@ access to sshuttle. The default is `sshuttle_auto`
You can also see what configuration will be added to your system without You can also see what configuration will be added to your system without
modifying anything. This can be helpfull is the auto feature does not work, or modifying anything. This can be helpfull is the auto feature does not work, or
you want more control. This option also works with `--sudoers-username`. you want more control. This option also works with `--sudoers-username`.
`--sudoers-filename` has no effect with this option. `--sudoers-filename` has no effect with this option::
sshuttle --sudoers-no-modify sshuttle --sudoers-no-modify
This will simply sprint the generated configuration to STDOUT. Example This will simply sprint the generated configuration to STDOUT. Example::
08:40 PM william$ sshuttle --sudoers-no-modify 08:40 PM william$ sshuttle --sudoers-no-modify