pam_echo(8)

1PAM_ECHO(8)                    Linux-PAM Manual                    PAM_ECHO(8)
2
3
4

NAME

6       pam_echo - PAM module for printing text messages
7

SYNOPSIS

9       pam_echo.so [file=/path/message]
10

DESCRIPTION

12       The pam_echo PAM module is for printing text messages to inform user
13       about special things. Sequences starting with the % character are
14       interpreted in the following way:
15
16       %H The name of the remote host (PAM_RHOST).
17
18       %h The name of the local host.
19
20       %s The service name (PAM_SERVICE).
21
22       %t The name of the controlling terminal (PAM_TTY).
23
24       %U The remote user name (PAM_RUSER).
25
26       %u The local user name (PAM_USER).
27
28       All other sequences beginning with % expands to the characters
29       following the % character.
30

OPTIONS

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

MODULE SERVICES PROVIDED

37       All services are supported.
38

RETURN VALUES

40       PAM_BUF_ERR
41          Memory buffer error.
42
43       PAM_SUCCESS
44          Message was successful printed.
45
46       PAM_IGNORE
47          PAM_SILENT flag was given or message file does not exist, no message
48          printed.
49

EXAMPLES

51       For an example of the use of this module, we show how it may be used to
52       print informations about good passwords:
53
54          password optional pam_echo.so file=/usr/share/doc/good-password.txt
55          password required pam_unix.so
56
57
58

AUTHOR

63       Thorsten Kukuk <kukuk@thkukuk.de>
64
65
66
67Linux-PAM Manual                  06/21/2006                       PAM_ECHO(8)