PAM_ECHO(8)

  .SH "NAME" pam_echo - PAM module for printing text messages
  .SH "SYNOPSIS"
    .HP u
      pam_echo.so
       [file=/path/message]

  .SH "DESCRIPTION"

    .PP 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:

      .PP %H

              The name of the remote host (PAM_RHOST).

          .RE
          .PP %h

                  The name of the local host.

              .RE
              .PP %s

                      The service name (PAM_SERVICE).

                  .RE
                  .PP %t

                          The name of the controlling terminal (PAM_TTY).

                      .RE
                      .PP %U

                              The remote user name (PAM_RUSER).

                          .RE
                          .PP %u

                                  The local user name (PAM_USER).

                              .RE

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

                          .SH "OPTIONS"

                              .PP file=/path/message

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

                                  .RE

                              .SH "MODULE TYPES PROVIDED"

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

                              .SH "RETURN VALUES"

                                  .PP PAM_BUF_ERR

                                           Memory buffer error.

                                      .RE
                                      .PP PAM_SUCCESS

                                               Message was successful printed.

                                          .RE
                                              .PP PAM_IGNORE

                                                   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 information about good passwords:

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

                                          .SH "SEE ALSO"
                                          .PP pam.conf(8), pam.d(5), pam(8)

                                          .SH "AUTHOR"

                                            .PP Thorsten Kukuk <kukuk@thkukuk.de>