diff options
| author | Brian May <brian@linuxpenguins.xyz> | 2020-07-05 11:00:18 +1000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-07-05 11:00:18 +1000 |
| commit | 329b9cd0a0fbe59cf1632d10747e694a66f272e7 (patch) | |
| tree | c5d430669a99e3c079236bd9d72f7d776390588c | |
| parent | 636e0442e52c25b037243dadb3d55cfb9a69eeb6 (diff) | |
| parent | 5537a90338ffc18687bf62ea6f990c5ab9398983 (diff) | |
Merge pull request #483 from chrisburr/patch-1
Fix formatting typos in usage docs
| -rw-r--r-- | docs/usage.rst | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/usage.rst b/docs/usage.rst index b625dc9..646c968 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -21,7 +21,7 @@ Forward all traffic:: 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 @@ -70,7 +70,7 @@ Sudoers File 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 the local sudo password and to give users who do not have sudo access -ability to run sshuttle. +ability to run sshuttle:: 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 usernames, groups pre-pended with `%` and sudoers user aliases will work. See 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 %sudo 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 -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_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 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`. -`--sudoers-filename` has no effect with this option. +`--sudoers-filename` has no effect with this option:: 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 |