2
0
mirror of https://github.com/sudo-project/sudo.git synced 2025-09-03 15:55:40 +00:00

Document that the editor setting is also used by sudoedit.

This commit is contained in:
Todd C. Miller
2018-04-18 09:40:48 -06:00
parent 18e06825fb
commit 3194a00e9e
3 changed files with 77 additions and 18 deletions

View File

@@ -1623,13 +1623,18 @@ SSUUDDOOEERRSS OOPPTTIIOONNSS
password. The default is Sorry, try again. unless password. The default is Sorry, try again. unless
insults are enabled. insults are enabled.
editor A colon (`:') separated list of editors allowed to be editor A colon (`:') separated list of editors path names used
used with vviissuuddoo. vviissuuddoo will choose the editor that by ssuuddooeeddiitt and vviissuuddoo. For ssuuddooeeddiitt, this list is
matches the user's SUDO_EDITOR, VISUAL or EDITOR used to find an editor when none of the SUDO_EDITOR,
environment variable if possible, or the first editor VISUAL or EDITOR environment variables are set to an
in the list that exists and is executable. Note that editor that exists and is executable. For vviissuuddoo, it
the SUDO_EDITOR, VISUAL and EDITOR environment is used as a white list of allowed editors; vviissuuddoo will
variables are not preserved by default when the choose the editor that matches the user's SUDO_EDITOR,
VISUAL or EDITOR environment variable if possible, or
the first editor in the list that exists and is
executable if not. Unless invoked as ssuuddooeeddiitt, ssuuddoo
does not preserve the SUDO_EDITOR, VISUAL and EDITOR
environment variables by default, even when the
_e_n_v___r_e_s_e_t option is enabled. The default is _v_i. _e_n_v___r_e_s_e_t option is enabled. The default is _v_i.
iolog_dir The top-level directory to use when constructing the iolog_dir The top-level directory to use when constructing the
@@ -2908,4 +2913,4 @@ DDIISSCCLLAAIIMMEERR
file distributed with ssuuddoo or https://www.sudo.ws/license.html for file distributed with ssuuddoo or https://www.sudo.ws/license.html for
complete details. complete details.
Sudo 1.8.23 March 21, 2018 Sudo 1.8.23 Sudo 1.8.23 April 17, 2018 Sudo 1.8.23

View File

@@ -21,7 +21,29 @@
.\" Agency (DARPA) and Air Force Research Laboratory, Air Force .\" Agency (DARPA) and Air Force Research Laboratory, Air Force
.\" Materiel Command, USAF, under agreement number F39502-99-1-0512. .\" Materiel Command, USAF, under agreement number F39502-99-1-0512.
.\" .\"
.TH "SUDOERS" "5" "March 21, 2018" "Sudo @PACKAGE_VERSION@" "File Formats Manual" .\" Automatically generated from an mdoc input file. Do not edit.
.\"
.\" Copyright (c) 1994-1996, 1998-2005, 2007-2018
.\" Todd C. Miller <Todd.Miller@sudo.ws>
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
.\" copyright notice and this permission notice appear in all copies.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" Sponsored in part by the Defense Advanced Research Projects
.\" Agency (DARPA) and Air Force Research Laboratory, Air Force
.\" Materiel Command, USAF, under agreement number F39502-99-1-0512.
.\"
.TH "SUDOERS" "5" "April 17, 2018" "Sudo @PACKAGE_VERSION@" "File Formats Manual"
.nh .nh
.if n .ad l .if n .ad l
.SH "NAME" .SH "NAME"
@@ -3327,8 +3349,21 @@ unless insults are enabled.
editor editor
A colon A colon
(\(oq:\&\(cq) (\(oq:\&\(cq)
separated list of editors allowed to be used with separated list of editors path names used by
\fBsudoedit\fR
and
\fBvisudo\fR. \fBvisudo\fR.
For
\fBsudoedit\fR,
this list is used to find an editor when none of the
\fRSUDO_EDITOR\fR,
\fRVISUAL\fR
or
\fREDITOR\fR
environment variables are set to an editor that exists and is executable.
For
\fBvisudo\fR,
it is used as a white list of allowed editors;
\fBvisudo\fR \fBvisudo\fR
will choose the editor that matches the user's will choose the editor that matches the user's
\fRSUDO_EDITOR\fR, \fRSUDO_EDITOR\fR,
@@ -3336,13 +3371,16 @@ will choose the editor that matches the user's
or or
\fREDITOR\fR \fREDITOR\fR
environment variable if possible, or the first editor in the environment variable if possible, or the first editor in the
list that exists and is executable. list that exists and is executable if not.
Note that the Unless invoked as
\fBsudoedit\fR,
\fBsudo\fR
does not preserve the
\fRSUDO_EDITOR\fR, \fRSUDO_EDITOR\fR,
\fRVISUAL\fR \fRVISUAL\fR
and and
\fREDITOR\fR \fREDITOR\fR
environment variables are not preserved by default when the environment variables by default, even when the
\fIenv_reset\fR \fIenv_reset\fR
option is enabled. option is enabled.
The default is The default is

View File

@@ -19,7 +19,7 @@
.\" Agency (DARPA) and Air Force Research Laboratory, Air Force .\" Agency (DARPA) and Air Force Research Laboratory, Air Force
.\" Materiel Command, USAF, under agreement number F39502-99-1-0512. .\" Materiel Command, USAF, under agreement number F39502-99-1-0512.
.\" .\"
.Dd March 21, 2018 .Dd April 17, 2018
.Dt SUDOERS @mansectform@ .Dt SUDOERS @mansectform@
.Os Sudo @PACKAGE_VERSION@ .Os Sudo @PACKAGE_VERSION@
.Sh NAME .Sh NAME
@@ -3129,8 +3129,21 @@ unless insults are enabled.
.It editor .It editor
A colon A colon
.Pq Ql :\& .Pq Ql :\&
separated list of editors allowed to be used with separated list of editors path names used by
.Nm sudoedit
and
.Nm visudo . .Nm visudo .
For
.Nm sudoedit ,
this list is used to find an editor when none of the
.Ev SUDO_EDITOR ,
.Ev VISUAL
or
.Ev EDITOR
environment variables are set to an editor that exists and is executable.
For
.Nm visudo ,
it is used as a white list of allowed editors;
.Nm visudo .Nm visudo
will choose the editor that matches the user's will choose the editor that matches the user's
.Ev SUDO_EDITOR , .Ev SUDO_EDITOR ,
@@ -3138,13 +3151,16 @@ will choose the editor that matches the user's
or or
.Ev EDITOR .Ev EDITOR
environment variable if possible, or the first editor in the environment variable if possible, or the first editor in the
list that exists and is executable. list that exists and is executable if not.
Note that the Unless invoked as
.Nm sudoedit ,
.Nm sudo
does not preserve the
.Ev SUDO_EDITOR , .Ev SUDO_EDITOR ,
.Ev VISUAL .Ev VISUAL
and and
.Ev EDITOR .Ev EDITOR
environment variables are not preserved by default when the environment variables by default, even when the
.Em env_reset .Em env_reset
option is enabled. option is enabled.
The default is The default is