diff options
Diffstat (limited to 'Linux-PAM/modules/pam_echo/pam_echo.8')
-rw-r--r-- | Linux-PAM/modules/pam_echo/pam_echo.8 | 108 |
1 files changed, 108 insertions, 0 deletions
diff --git a/Linux-PAM/modules/pam_echo/pam_echo.8 b/Linux-PAM/modules/pam_echo/pam_echo.8 new file mode 100644 index 00000000..7c996d89 --- /dev/null +++ b/Linux-PAM/modules/pam_echo/pam_echo.8 @@ -0,0 +1,108 @@ +.\" Title: pam_echo +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/> +.\" Date: 01/08/2008 +.\" Manual: Linux-PAM Manual +.\" Source: Linux-PAM Manual +.\" +.TH "PAM_ECHO" "8" "01/08/2008" "Linux-PAM Manual" "Linux-PAM Manual" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +pam_echo - PAM module for printing text messages +.SH "SYNOPSIS" +.HP 12 +\fBpam_echo\.so\fR [file=\fI/path/message\fR] +.SH "DESCRIPTION" +.PP +The +\fIpam_echo\fR +PAM module is for printing text messages to inform user about special things\. Sequences starting with the +\fI%\fR +character are interpreted in the following way: +.PP +\fI%H\fR +.RS 4 +The name of the remote host (PAM_RHOST)\. +.RE +.PP +\fB%h\fR +.RS 4 +The name of the local host\. +.RE +.PP +\fI%s\fR +.RS 4 +The service name (PAM_SERVICE)\. +.RE +.PP +\fI%t\fR +.RS 4 +The name of the controlling terminal (PAM_TTY)\. +.RE +.PP +\fI%U\fR +.RS 4 +The remote user name (PAM_RUSER)\. +.RE +.PP +\fI%u\fR +.RS 4 +The local user name (PAM_USER)\. +.RE +.PP +All other sequences beginning with +\fI%\fR +expands to the characters following the +\fI%\fR +character\. +.SH "OPTIONS" +.PP +\fBfile=\fR\fB\fI/path/message\fR\fR +.RS 4 +The content of the file +\fI/path/message\fR +will be printed with the PAM conversion function as PAM_TEXT_INFO\. +.RE +.SH "MODULE SERVICES PROVIDED" +.PP +All services are supported\. +.SH "RETURN VALUES" +.PP +PAM_BUF_ERR +.RS 4 +Memory buffer error\. +.RE +.PP +PAM_SUCCESS +.RS 4 +Message was successful printed\. +.RE +.PP +PAM_IGNORE +.RS 4 +PAM_SILENT flag was given or message file does not exist, no message printed\. +.RE +.SH "EXAMPLES" +.PP +For an example of the use of this module, we show how it may be used to print informations about good passwords: +.sp +.RS 4 +.nf +password optional pam_echo\.so file=/usr/share/doc/good\-password\.txt +password required pam_unix\.so + +.fi +.RE +.sp +.SH "SEE ALSO" +.PP + +\fBpam.conf\fR(8), +\fBpam.d\fR(8), +\fBpam\fR(8) +.SH "AUTHOR" +.PP +Thorsten Kukuk <kukuk@thkukuk\.de> |