Skip to content

Commit dee8bc6

Browse files
adombecksquell
authored andcommitted
Fix character escaping in sudoers man page
The `*` character was not escaped, resulting in it not being displayed in the man page and the italic formatting being messed up.
1 parent 54a8fae commit dee8bc6

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

docs/man/sudoers.5.man

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -70,11 +70,11 @@ Environment variables with a value beginning with \f[CR]()\f[R] are
7070
removed, as they may be interpreted as functions by the bash shell.
7171
.PP
7272
Environment variables specified by \f[I]env_check\f[R] or
73-
\f[I]env_keep\f[R] may include one or more \[cq]\f[I]\[cq] characters
74-
which will match zero or more characters.
73+
\f[I]env_keep\f[R] may include one or more `*' characters which will
74+
match zero or more characters.
7575
No other wildcard characters are supported.
7676
Other sudoers options may influence the command environment, such as
77-
\f[R]secure_path*.
77+
\f[I]secure_path\f[R].
7878
.PP
7979
Variables in the PAM environment may be merged in to the environment.
8080
If a variable in the PAM environment is already present in the
@@ -487,9 +487,9 @@ setting the group to operator or system.
487487
The working directory that the command will be run in can be specified
488488
using the CWD setting.
489489
The directory must be a fully\-qualified path name beginning with a `/'
490-
or `\[ti]' character, or the special value \[lq]\f[I]\[rq].
491-
A value of \[lq]\f[R]\[rq] indicates that the user may specify the
492-
working directory by running sudo with the \-D option.
490+
or `\[ti]' character, or the special value \[lq]*\[rq].
491+
A value of \[lq]*\[rq] indicates that the user may specify the working
492+
directory by running sudo with the \-D option.
493493
By default, commands are run from the invoking user\[cq]s current
494494
working directory, unless the \-i option is given.
495495
Path names of the form \[ti]user/path/name are interpreted as being

docs/man/sudoers.5.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The `HOME`, `MAIL`, `SHELL`, `LOGNAME` and `USER` environment variables are init
3131
If `LOGNAME` and `USER` are to be preserved but only one of them is present in the user's environment, the other will be set to the same value. This avoids an inconsistent environment where one of the variables describing the user name is set to the invoking user and one is set to the target user.
3232
Environment variables with a value beginning with `()` are removed, as they may be interpreted as functions by the bash shell.
3333

34-
Environment variables specified by *env_check* or *env_keep* may include one or more ‘*’ characters which will match zero or more characters.
34+
Environment variables specified by *env_check* or *env_keep* may include one or more ‘\*’ characters which will match zero or more characters.
3535
No other wildcard characters are supported. Other sudoers options may influence the command environment, such as *secure_path*.
3636

3737
Variables in the PAM environment may be merged in to the environment. If a variable in the PAM environment is already present in the user's environment, the value will only be overridden if the variable was not preserved by `sudo-rs`. Variables preserved from the invoking user's environment by the *env_keep* list take precedence over those in the PAM environment.
@@ -263,7 +263,7 @@ user alan may run any command as either user root or bin, optionally setting the
263263

264264
## Chdir_Spec
265265

266-
The working directory that the command will be run in can be specified using the CWD setting. The directory must be a fully-qualified path name beginning with a ‘/’ or ‘~’ character, or the special value “*”. A value of “*” indicates that the user may specify the working directory by running sudo with the -D option. By default, commands are run from the invoking user's current working directory, unless the -i option is given. Path names of the form ~user/path/name are interpreted as being relative to the named user's home directory. If the user name is omitted, the path will be relative to the runas user's home directory.
266+
The working directory that the command will be run in can be specified using the CWD setting. The directory must be a fully-qualified path name beginning with a ‘/’ or ‘~’ character, or the special value “\*”. A value of “\*” indicates that the user may specify the working directory by running sudo with the -D option. By default, commands are run from the invoking user's current working directory, unless the -i option is given. Path names of the form ~user/path/name are interpreted as being relative to the named user's home directory. If the user name is omitted, the path will be relative to the runas user's home directory.
267267

268268
## Tag_Spec
269269

0 commit comments

Comments
 (0)