]> granicus.if.org Git - sudo/commitdiff
SUDO_CONV_DEBUG_MSG is no longer supported.
authorTodd C. Miller <Todd.Miller@courtesan.com>
Mon, 8 Sep 2014 22:34:47 +0000 (16:34 -0600)
committerTodd C. Miller <Todd.Miller@courtesan.com>
Mon, 8 Sep 2014 22:34:47 +0000 (16:34 -0600)
doc/sudo_plugin.cat
doc/sudo_plugin.man.in
doc/sudo_plugin.mdoc.in
include/sudo_plugin.h

index 36d52d0a83d77805cc5959fcf10a5a9e8c3741d6..7276395a1649ad998d517bb5174da0d6223d58e6 100644 (file)
@@ -1,4 +1,4 @@
-SUDO_PLUGIN(4)                Programmer's Manual               SUDO_PLUGIN(4)
+SUDO_PLUGIN(4)                File Formats Manual               SUDO_PLUGIN(4)
 
 N\bNA\bAM\bME\bE
      s\bsu\bud\bdo\bo_\b_p\bpl\blu\bug\bgi\bin\bn - Sudo Plugin API
@@ -1267,7 +1267,6 @@ D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
      #define SUDO_CONV_ERROR_MSG        0x0003 /* error message */
      #define SUDO_CONV_INFO_MSG         0x0004 /* informational message */
      #define SUDO_CONV_PROMPT_MASK      0x0005 /* mask user input */
-     #define SUDO_CONV_DEBUG_MSG        0x0006 /* debugging message */
      #define SUDO_CONV_PROMPT_ECHO_OK   0x1000 /* flag: allow echo if no tty */
          int msg_type;
          int timeout;
@@ -1301,17 +1300,10 @@ D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
      conversation function.
 
      The p\bpr\bri\bin\bnt\btf\bf()-style function uses the same underlying mechanism as the
-     c\bco\bon\bnv\bve\ber\brs\bsa\bat\bti\bio\bon\bn() function but only supports SUDO_CONV_INFO_MSG,
-     SUDO_CONV_ERROR_MSG and SUDO_CONV_DEBUG_MSG for the _\bm_\bs_\bg_\b__\bt_\by_\bp_\be parameter.
-     It can be more convenient than using the c\bco\bon\bnv\bve\ber\brs\bsa\bat\bti\bio\bon\bn() function if no
-     user reply is needed and supports standard p\bpr\bri\bin\bnt\btf\bf() escape sequences.
-
-     Unlike, SUDO_CONV_INFO_MSG and Dv SUDO_CONV_ERROR_MSG , messages sent
-     with the SUDO_CONV_DEBUG_MSG _\bm_\bs_\bg_\b__\bt_\by_\bp_\be are not directly user-visible.
-     Instead, they are logged to the file specified in the Debug statement (if
-     any) in the sudo.conf(4).  file.  This allows a plugin to log debugging
-     information and is intended to be used in conjunction with the
-     _\bd_\be_\bb_\bu_\bg_\b__\bf_\bl_\ba_\bg_\bs setting.
+     c\bco\bon\bnv\bve\ber\brs\bsa\bat\bti\bio\bon\bn() function but only supports SUDO_CONV_INFO_MSG and
+     SUDO_CONV_ERROR_MSG for the _\bm_\bs_\bg_\b__\bt_\by_\bp_\be parameter.  It can be more
+     convenient than using the c\bco\bon\bnv\bve\ber\brs\bsa\bat\bti\bio\bon\bn() function if no user reply is
+     needed and supports standard p\bpr\bri\bin\bnt\btf\bf() escape sequences.
 
      See the sample plugin for an example of the c\bco\bon\bnv\bve\ber\brs\bsa\bat\bti\bio\bon\bn() function
      usage.
@@ -1489,4 +1481,4 @@ D\bDI\bIS\bSC\bCL\bLA\bAI\bIM\bME\bER\bR
      file distributed with s\bsu\bud\bdo\bo or http://www.sudo.ws/sudo/license.html for
      complete details.
 
-Sudo 1.8.11                     August 25, 2014                    Sudo 1.8.11
+Sudo 1.8.11                    September 8, 2014                   Sudo 1.8.11
index 3cdea1c58aa3e1ded156ae76d30038102a2d7efc..343b23ad4abb275f17d61702d41903e5a10795a2 100644 (file)
@@ -16,7 +16,7 @@
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
-.TH "SUDO_PLUGIN" "5" "August 25, 2014" "Sudo @PACKAGE_VERSION@" "OpenBSD Programmer's Manual"
+.TH "SUDO_PLUGIN" "5" "September 8, 2014" "Sudo @PACKAGE_VERSION@" "File Formats Manual"
 .nh
 .if n .ad l
 .SH "NAME"
@@ -2247,7 +2247,6 @@ struct sudo_conv_message {
 #define SUDO_CONV_ERROR_MSG        0x0003 /* error message */
 #define SUDO_CONV_INFO_MSG         0x0004 /* informational message */
 #define SUDO_CONV_PROMPT_MASK      0x0005 /* mask user input */
-#define SUDO_CONV_DEBUG_MSG        0x0006 /* debugging message */
 #define SUDO_CONV_PROMPT_ECHO_OK   0x1000 /* flag: allow echo if no tty */
     int msg_type;
     int timeout;
@@ -2309,10 +2308,9 @@ The
 function uses the same underlying mechanism as the
 \fBconversation\fR()
 function but only supports
-\fRSUDO_CONV_INFO_MSG\fR,
-\fRSUDO_CONV_ERROR_MSG\fR
+\fRSUDO_CONV_INFO_MSG\fR
 and
-\fRSUDO_CONV_DEBUG_MSG\fR
+\fRSUDO_CONV_ERROR_MSG\fR
 for the
 \fImsg_type\fR
 parameter.
@@ -2322,26 +2320,6 @@ function if no user reply is needed and supports standard
 \fBprintf\fR()
 escape sequences.
 .PP
-Unlike,
-\fRSUDO_CONV_INFO_MSG\fR
-and
-Dv SUDO_CONV_ERROR_MSG ,
-messages
-sent with the
-\fRSUDO_CONV_DEBUG_MSG\fR
-\fImsg_type\fR
-are not directly
-user-visible.
-Instead, they are logged to the file specified in the
-\fRDebug\fR
-statement (if any) in the
-sudo.conf(@mansectform@).
-file.
-This allows a plugin to log debugging information and is intended
-to be used in conjunction with the
-\fIdebug_flags\fR
-setting.
-.PP
 See the sample plugin for an example of the
 \fBconversation\fR()
 function usage.
index 3452e4bbe7edc51a95a9ccbf3582ccc2e2e26838..0a8e20919e1a74f975c15bbe2233f60bb26a964b 100644 (file)
@@ -14,7 +14,7 @@
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd August 25, 2014
+.Dd September 8, 2014
 .Dt SUDO_PLUGIN @mansectform@
 .Os Sudo @PACKAGE_VERSION@
 .Sh NAME
@@ -1955,7 +1955,6 @@ struct sudo_conv_message {
 #define SUDO_CONV_ERROR_MSG        0x0003 /* error message */
 #define SUDO_CONV_INFO_MSG         0x0004 /* informational message */
 #define SUDO_CONV_PROMPT_MASK      0x0005 /* mask user input */
-#define SUDO_CONV_DEBUG_MSG        0x0006 /* debugging message */
 #define SUDO_CONV_PROMPT_ECHO_OK   0x1000 /* flag: allow echo if no tty */
     int msg_type;
     int timeout;
@@ -2016,10 +2015,9 @@ The
 function uses the same underlying mechanism as the
 .Fn conversation
 function but only supports
-.Dv SUDO_CONV_INFO_MSG ,
-.Dv SUDO_CONV_ERROR_MSG
+.Dv SUDO_CONV_INFO_MSG
 and
-.Dv SUDO_CONV_DEBUG_MSG
+.Dv SUDO_CONV_ERROR_MSG
 for the
 .Em msg_type
 parameter.
@@ -2029,26 +2027,6 @@ function if no user reply is needed and supports standard
 .Fn printf
 escape sequences.
 .Pp
-Unlike,
-.Dv SUDO_CONV_INFO_MSG
-and
-Dv SUDO_CONV_ERROR_MSG ,
-messages
-sent with the
-.Dv SUDO_CONV_DEBUG_MSG
-.Em msg_type
-are not directly
-user-visible.
-Instead, they are logged to the file specified in the
-.Li Debug
-statement (if any) in the
-.Xr sudo.conf @mansectform@ .
-file.
-This allows a plugin to log debugging information and is intended
-to be used in conjunction with the
-.Em debug_flags
-setting.
-.Pp
 See the sample plugin for an example of the
 .Fn conversation
 function usage.
index 5e95df66fee68a3083fbbccca05813d7068b43db..b4300222b21bf19f87c65f0878d3a1daef39ea48 100644 (file)
@@ -40,7 +40,6 @@ struct sudo_conv_message {
 #define SUDO_CONV_ERROR_MSG        0x0003  /* error message */
 #define SUDO_CONV_INFO_MSG         0x0004  /* informational message */
 #define SUDO_CONV_PROMPT_MASK      0x0005  /* mask user input */
-#define SUDO_CONV_DEBUG_MSG        0x0006  /* debugging message */
 #define SUDO_CONV_PROMPT_ECHO_OK    0x1000  /* flag: allow echo if no tty */
     int msg_type;
     int timeout;