summaryrefslogtreecommitdiffstats
path: root/contrib/openpam/lib/openpam_ttyconv.c
diff options
context:
space:
mode:
Diffstat (limited to 'contrib/openpam/lib/openpam_ttyconv.c')
-rw-r--r--contrib/openpam/lib/openpam_ttyconv.c16
1 files changed, 15 insertions, 1 deletions
diff --git a/contrib/openpam/lib/openpam_ttyconv.c b/contrib/openpam/lib/openpam_ttyconv.c
index fc02405..b35a5f9 100644
--- a/contrib/openpam/lib/openpam_ttyconv.c
+++ b/contrib/openpam/lib/openpam_ttyconv.c
@@ -31,7 +31,7 @@
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
- * $P4: //depot/projects/openpam/lib/openpam_ttyconv.c#10 $
+ * $P4: //depot/projects/openpam/lib/openpam_ttyconv.c#11 $
*/
#include <sys/types.h>
@@ -192,3 +192,17 @@ openpam_ttyconv(int n,
* PAM_BUF_ERR
* PAM_CONV_ERR
*/
+
+/**
+ * The =openpam_ttyconv function is a standard conversation function
+ * suitable for use on TTY devices. It should be adequate for the needs
+ * of most text-based interactive programs.
+ *
+ * The =openpam_ttyconv function allows the application to specify a
+ * timeout for user input by setting the global variable
+ * :openpam_ttyconv_timeout to the length of the timeout in seconds.
+ *
+ * >openpam_nullconv
+ * >pam_prompt
+ * >pam_vprompt
+ */
OpenPOWER on IntegriCloud