---
name: "pam_echo"
section: "8"
platform: "linux"
package: "pam"
version: "1.7.3-1"
release: "Arch Linux 2026-11-01"
platforms: ["linux", "freebsd"]
url: "https://new.carta.tech/pam_echo"
---

# pam\_echo(8)

PAM module for printing text messages

## NAME

pam\_echo - PAM module for printing text messages

## SYNOPSIS

**pam\_echo.so** \[file=*/path/message*\]

## DESCRIPTION

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

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

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

## RETURN VALUES

PAM\_BUF\_ERR

Memory buffer error.

PAM\_SUCCESS

Message was successfully printed.

PAM\_IGNORE

PAM\_SILENT flag was given or message file does not exist, no message printed.

## EXAMPLES

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

[**pam.conf**(8)](/pam.conf/8.md), [**pam.d**(5)](/pam.d/5.md), [**pam**(8)](/pam/8.md)

## AUTHOR

Thorsten Kukuk \<kukuk@thkukuk.de\>