NAME | SYNOPSIS | DESCRIPTION | OPTIONS | MODULE TYPES PROVIDED | RETURN VALUES | EXAMPLES | SEE ALSO | AUTHOR | COLOPHON

PAM_ECHO(8)                   Linux-PAM Manual                   PAM_ECHO(8)

NAME         top

       pam_echo - PAM module for printing text messages

SYNOPSIS         top

       pam_echo.so [file=/path/message]

DESCRIPTION         top

       The pam_echo PAM module is for printing text messages to inform user
       about special things. Sequences starting with the % character are
       interpreted in the following way:

       %H
           The name of the remote host (PAM_RHOST).

       %h
           The name of the local host.

       %s
           The service name (PAM_SERVICE).

       %t
           The name of the controlling terminal (PAM_TTY).

       %U
           The remote user name (PAM_RUSER).

       %u
           The local user name (PAM_USER).

       All other sequences beginning with % expands to the characters
       following the % character.

OPTIONS         top

       file=/path/message
           The content of the file /path/message will be printed with the
           PAM conversion function as PAM_TEXT_INFO.

MODULE TYPES PROVIDED         top

       All module types (auth, account, password and session) are provided.

RETURN VALUES         top

       PAM_BUF_ERR
           Memory buffer error.

       PAM_SUCCESS
           Message was successful printed.

       PAM_IGNORE
           PAM_SILENT flag was given or message file does not exist, no
           message printed.

EXAMPLES         top

       For an example of the use of this module, we show how it may be used
       to print information about good passwords:

           password optional pam_echo.so file=/usr/share/doc/good-password.txt
           password required pam_unix.so

SEE ALSO         top

       pam.conf(8), pam.d(5), pam(8)

AUTHOR         top

       Thorsten Kukuk <kukuk@thkukuk.de>

COLOPHON         top

       This page is part of the linux-pam (Pluggable Authentication Modules
       for Linux) project.  Information about the project can be found at 
       ⟨http://www.linux-pam.org/⟩.  If you have a bug report for this manual
       page, see ⟨//www.linux-pam.org/⟩.  This page was obtained from the
       tarball Linux-PAM-1.3.0.tar.gz fetched from
       ⟨http://www.linux-pam.org/library/⟩ on 2017-11-25.  If you discover
       any rendering problems in this HTML version of the page, or you
       believe there is a better or more up-to-date source for the page, or
       you have corrections or improvements to the information in this
       COLOPHON (which is not part of the original manual page), send a mail
       to man-pages@man7.org

Linux-PAM Manual                 04/01/2016                      PAM_ECHO(8)