Document that you need to preserve EDITOR and/or VISUAL for env_editor

to be useful.

diff --git a/doc/sudoers.cat b/doc/sudoers.cat
index a4bcdbe36411341ba6ae55c64e89a8916e1aefad..63e1ab3e4442c80ba844caf943355a2d6b35c6ae 100644 (file)
--- a/doc/sudoers.cat
+++ b/doc/sudoers.cat
@@ -942,7 +942,11 @@ S\bSU\bUD\bDO\bOE\bER\bRS\bS O\bOP\bPT\bTI\bIO\bON\bNS\bS
                        alternative is to place a colon-separated list of
                        editors in the editor variable.  v\bvi\bis\bsu\bud\bdo\bo will then only
                        use the EDITOR or VISUAL if they match a value
-                       specified in editor.  This flag is _\bo_\bf_\bf by default.
+                       specified in editor.  If the _\be_\bn_\bv_\b__\br_\be_\bs_\be_\bt flag is enabled,
+                       the EDITOR and/or VISUAL environment variables must be
+                       present in the _\be_\bn_\bv_\b__\bk_\be_\be_\bp list for the _\be_\bn_\bv_\b__\be_\bd_\bi_\bt_\bo_\br flag to
+                       function when v\bvi\bis\bsu\bud\bdo\bo is invoked via s\bsu\bud\bdo\bo.  This flag is
+                       _\bo_\bf_\bf by default.
 
      env_reset         If set, s\bsu\bud\bdo\bo will run the command in a minimal
                        environment containing the TERM, PATH, HOME, MAIL,
@@ -1413,9 +1417,12 @@ S\bSU\bUD\bDO\bOE\bER\bRS\bS O\bOP\bPT\bTI\bIO\bON\bNS\bS
 
      editor            A colon (`:') separated list of editors allowed to be
                        used with v\bvi\bis\bsu\bud\bdo\bo.  v\bvi\bis\bsu\bud\bdo\bo will choose the editor that
-                       matches the user's EDITOR environment variable if
-                       possible, or the first editor in the list that exists
-                       and is executable.  The default is _\bv_\bi.
+                       matches the user's EDITOR or VISUAL environment
+                       variable if possible, or the first editor in the list
+                       that exists and is executable.  Note that the EDITOR
+                       and VISUAL environment variables are not preserved by
+                       default when the _\be_\bn_\bv_\b__\br_\be_\bs_\be_\bt option is enabled.  The
+                       default is _\bv_\bi.
 
      iolog_dir         The top-level directory to use when constructing the
                        path name for the input/output log directory.  Only
@@ -2532,4 +2539,4 @@ D\bDI\bIS\bSC\bCL\bLA\bAI\bIM\bME\bER\bR
      file distributed with s\bsu\bud\bdo\bo or https://www.sudo.ws/license.html for
      complete details.
 
-Sudo 1.8.16                    January 20, 2016                    Sudo 1.8.16
+Sudo 1.8.17                    January 20, 2016                    Sudo 1.8.17

diff --git a/doc/sudoers.man.in b/doc/sudoers.man.in
index 1313d2838889f360518f9a270d0bf305c14f619b..1703faad7b691669d38330bbf417a9e610b81fb5 100644 (file)
--- a/doc/sudoers.man.in
+++ b/doc/sudoers.man.in
@@ -2015,6 +2015,20 @@ or
 \fRVISUAL\fR
 if they match a value specified in
 \fReditor\fR.
+If the
+\fIenv_reset\fR
+flag is enabled, the
+\fREDITOR\fR
+and/or
+\fRVISUAL\fR
+environment variables must be present in the
+\fIenv_keep\fR
+list for the
+\fIenv_editor\fR
+flag to function when
+\fBvisudo\fR
+is invoked via
+\fBsudo\fR.
 This flag is
 \fI@env_editor@\fR
 by default.
@@ -2975,8 +2989,17 @@ separated list of editors allowed to be used with
 \fBvisudo\fR
 will choose the editor that matches the user's
 \fREDITOR\fR
+or
+\fRVISUAL\fR
 environment variable if possible, or the first editor in the
 list that exists and is executable.
+Note that the
+\fREDITOR\fR
+and
+\fRVISUAL\fR
+environment variables are not preserved by default when the
+\fIenv_reset\fR
+option is enabled.
 The default is
 \fI@editor@\fR.
 .TP 18n

diff --git a/doc/sudoers.mdoc.in b/doc/sudoers.mdoc.in
index 0d33690d6ac4b2d8e56762d08739cc92c3c54386..de75b8ca3fec51ae853f40f5664c85abac1f646d 100644 (file)
--- a/doc/sudoers.mdoc.in
+++ b/doc/sudoers.mdoc.in
@@ -1884,6 +1884,20 @@ or
 .Ev VISUAL
 if they match a value specified in
 .Li editor .
+If the
+.Em env_reset
+flag is enabled, the 
+.Ev EDITOR
+and/or
+.Ev VISUAL
+environment variables must be present in the
+.Em env_keep
+list for the
+.Em env_editor
+flag to function when
+.Nm visudo
+is invoked via
+.Nm sudo .
 This flag is
 .Em @env_editor@
 by default.
@@ -2792,8 +2806,17 @@ separated list of editors allowed to be used with
 .Nm visudo
 will choose the editor that matches the user's
 .Ev EDITOR
+or
+.Ev VISUAL
 environment variable if possible, or the first editor in the
 list that exists and is executable.
+Note that the
+.Ev EDITOR
+and
+.Ev VISUAL
+environment variables are not preserved by default when the
+.Em env_reset
+option is enabled.
 The default is
 .Pa @editor@ .
 .It iolog_dir