Document lines/cols in user_info

diff --git a/doc/sudo_plugin.cat b/doc/sudo_plugin.cat
index b2d1c00cb9ea1ece808785e952fc9db52fa82991..883257579c906293cb8586016e686851e7e06a00 100644 (file)
--- a/doc/sudo_plugin.cat
+++ b/doc/sudo_plugin.cat
@@ -61,7 +61,7 @@ S\bSu\bud\bdo\bo P\bPl\blu\bug\bgi\bin\bn A\bAP\bPI\bI
 
 
 
-1.8.0a1                   March 11, 2010                        1
+1.8.0a1                   March 17, 2010                        1
 
 
 
@@ -127,7 +127,7 @@ SUDO_PLUGIN(1m)        MAINTENANCE COMMANDS       SUDO_PLUGIN(1m)
 
 
 
-1.8.0a1                   March 11, 2010                        2
+1.8.0a1                   March 17, 2010                        2
 
 
 
@@ -193,7 +193,7 @@ SUDO_PLUGIN(1m)        MAINTENANCE COMMANDS       SUDO_PLUGIN(1m)
 
 
 
-1.8.0a1                   March 11, 2010                        3
+1.8.0a1                   March 17, 2010                        3
 
 
 
@@ -247,26 +247,34 @@ SUDO_PLUGIN(1m)        MAINTENANCE COMMANDS       SUDO_PLUGIN(1m)
                    The local machine's hostname as returned by the
                    gethostname() system call.
 
-           user_env
-               The user's environment in the form of a NULL-terminated vector
-               of "name=value" strings.
+               lines=int
+                   The number of lines the user's terminal supports.  If there
+                   is no terminal device available, a default value of 24 is
+                   used.
 
-               When parsing _\bu_\bs_\be_\br_\b__\be_\bn_\bv, the plugin should split on the f\bfi\bir\brs\bst\bt
-               equal sign ('=') since the _\bn_\ba_\bm_\be field will never include one
-               itself but the _\bv_\ba_\bl_\bu_\be might.
+               cols=int
+                   The number of columns the user's terminal supports.  If
+                   there is no terminal device available, a default value of
+                   80 is used.
 
 
 
+1.8.0a1                   March 17, 2010                        4
 
 
-1.8.0a1                   March 11, 2010                        4
 
 
 
+SUDO_PLUGIN(1m)        MAINTENANCE COMMANDS       SUDO_PLUGIN(1m)
 
 
-SUDO_PLUGIN(1m)        MAINTENANCE COMMANDS       SUDO_PLUGIN(1m)
+           user_env
+               The user's environment in the form of a NULL-terminated vector
+               of "name=value" strings.
 
+               When parsing _\bu_\bs_\be_\br_\b__\be_\bn_\bv, the plugin should split on the f\bfi\bir\brs\bst\bt
+               equal sign ('=') since the _\bn_\ba_\bm_\be field will never include one
+               itself but the _\bv_\ba_\bl_\bu_\be might.
 
        close
             void (*close)(int exit_status, int error);
@@ -315,17 +323,9 @@ SUDO_PLUGIN(1m)        MAINTENANCE COMMANDS       SUDO_PLUGIN(1m)
                The number of elements in _\ba_\br_\bg_\bv, not counting the final NULL
                pointer.
 
-           argv
-               The argument vector describing the command the user wishes to
-               run, in the same form as what would be passed to the _\be_\bx_\be_\bc_\bv_\be_\b(_\b)
-               system call.  The vector is terminated by a NULL pointer.
-
-           env_add
-               Additional environment variables specified by the user on the
-
 
 
-1.8.0a1                   March 11, 2010                        5
+1.8.0a1                   March 17, 2010                        5
 
 
 
@@ -334,6 +334,13 @@ SUDO_PLUGIN(1m)        MAINTENANCE COMMANDS       SUDO_PLUGIN(1m)
 SUDO_PLUGIN(1m)        MAINTENANCE COMMANDS       SUDO_PLUGIN(1m)
 
 
+           argv
+               The argument vector describing the command the user wishes to
+               run, in the same form as what would be passed to the _\be_\bx_\be_\bc_\bv_\be_\b(_\b)
+               system call.  The vector is terminated by a NULL pointer.
+
+           env_add
+               Additional environment variables specified by the user on the
                command line in the form of a NULL-terminated vector of
                "name=value" strings.  The plugin may reject the command if one
                or more variables are not allowed to be set, or it may silently
@@ -382,23 +389,23 @@ SUDO_PLUGIN(1m)        MAINTENANCE COMMANDS       SUDO_PLUGIN(1m)
                    If set, s\bsu\bud\bdo\bo will preserve the user's group vector instead
                    of initializing the group vector based on runas_user.
 
-               cwd=string
-                   The current working directory to change to when executing
-                   the command.
 
-               noexec=bool
-                   If set, prevent the command from executing other programs.
 
+1.8.0a1                   March 17, 2010                        6
 
 
-1.8.0a1                   March 11, 2010                        6
 
 
 
+SUDO_PLUGIN(1m)        MAINTENANCE COMMANDS       SUDO_PLUGIN(1m)
 
 
-SUDO_PLUGIN(1m)        MAINTENANCE COMMANDS       SUDO_PLUGIN(1m)
+               cwd=string
+                   The current working directory to change to when executing
+                   the command.
 
+               noexec=bool
+                   If set, prevent the command from executing other programs.
 
                chroot=string
                    The root directory to use when running the command.
@@ -448,16 +455,9 @@ SUDO_PLUGIN(1m)        MAINTENANCE COMMANDS       SUDO_PLUGIN(1m)
            verbose
                Flag indicating whether to list in verbose mode or not.
 
-           list_user
-               The name of a different user to list privileges for if the
-               policy allows it.  If NULL, the plugin should list the
-               privileges of the invoking user.
-
-
-
 
 
-1.8.0a1                   March 11, 2010                        7
+1.8.0a1                   March 17, 2010                        7
 
 
 
@@ -466,6 +466,11 @@ SUDO_PLUGIN(1m)        MAINTENANCE COMMANDS       SUDO_PLUGIN(1m)
 SUDO_PLUGIN(1m)        MAINTENANCE COMMANDS       SUDO_PLUGIN(1m)
 
 
+           list_user
+               The name of a different user to list privileges for if the
+               policy allows it.  If NULL, the plugin should list the
+               privileges of the invoking user.
+
            argc
                The number of elements in _\ba_\br_\bg_\bv, not counting the final NULL
                pointer.
@@ -518,12 +523,7 @@ SUDO_PLUGIN(1m)        MAINTENANCE COMMANDS       SUDO_PLUGIN(1m)
 
 
 
-
-
-
-
-
-1.8.0a1                   March 11, 2010                        8
+1.8.0a1                   March 17, 2010                        8
 
 
 
@@ -589,7 +589,7 @@ SUDO_PLUGIN(1m)        MAINTENANCE COMMANDS       SUDO_PLUGIN(1m)
 
 
 
-1.8.0a1                   March 11, 2010                        9
+1.8.0a1                   March 17, 2010                        9
 
 
 
@@ -655,7 +655,7 @@ SUDO_PLUGIN(1m)        MAINTENANCE COMMANDS       SUDO_PLUGIN(1m)
 
 
 
-1.8.0a1                   March 11, 2010                       10
+1.8.0a1                   March 17, 2010                       10
 
 
 
@@ -721,7 +721,7 @@ SUDO_PLUGIN(1m)        MAINTENANCE COMMANDS       SUDO_PLUGIN(1m)
 
 
 
-1.8.0a1                   March 11, 2010                       11
+1.8.0a1                   March 17, 2010                       11
 
 
 
@@ -787,6 +787,6 @@ SUDO_PLUGIN(1m)        MAINTENANCE COMMANDS       SUDO_PLUGIN(1m)
 
 
 
-1.8.0a1                   March 11, 2010                       12
+1.8.0a1                   March 17, 2010                       12
 
 

diff --git a/doc/sudo_plugin.man.in b/doc/sudo_plugin.man.in
index 4b7d5227751a0eef584d9ab25b9e27e96e59862e..4173e931b498a6d91f8fb344ad19cf93376114ac 100644 (file)
--- a/doc/sudo_plugin.man.in
+++ b/doc/sudo_plugin.man.in
@@ -139,7 +139,7 @@
 .\" ========================================================================
 .\"
 .IX Title "SUDO_PLUGIN @mansectsu@"
-.TH SUDO_PLUGIN @mansectsu@ "March 11, 2010" "1.8.0a1" "MAINTENANCE COMMANDS"
+.TH SUDO_PLUGIN @mansectsu@ "March 17, 2010" "1.8.0a1" "MAINTENANCE COMMANDS"
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
@@ -361,6 +361,14 @@ device associated with the session, the value will be empty, as in
 .IX Item "host=string"
 The local machine's hostname as returned by the \f(CW\*(C`gethostname()\*(C'\fR
 system call.
+.IP "lines=int" 4
+.IX Item "lines=int"
+The number of lines the user's terminal supports.  If there is
+no terminal device available, a default value of 24 is used.
+.IP "cols=int" 4
+.IX Item "cols=int"
+The number of columns the user's terminal supports.  If there is
+no terminal device available, a default value of 80 is used.
 .RE
 .RS 4
 .RE

diff --git a/doc/sudo_plugin.pod b/doc/sudo_plugin.pod
index b5ad09a7e35a7d36bc1f953b8dffa57400cbc67c..2cfe58cec50f1fc37ee432f7181f64d90b32d822 100644 (file)
--- a/doc/sudo_plugin.pod
+++ b/doc/sudo_plugin.pod
@@ -260,6 +260,16 @@ C<tty=>.
 The local machine's hostname as returned by the C<gethostname()>
 system call.
 
+=item lines=int
+
+The number of lines the user's terminal supports.  If there is
+no terminal device available, a default value of 24 is used.
+
+=item cols=int
+
+The number of columns the user's terminal supports.  If there is
+no terminal device available, a default value of 80 is used.
+
 =back
 
 =item user_env