Debian Codegraph @

upstream/debian-unstable/man8/pam_echo.8

raw
1 '\" t
2 .\" Title: pam_echo
3 .\" Author: [see the "AUTHOR" section]
4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
5 .\" Date: 06/29/2025
6 .\" Manual: Linux-PAM Manual
7 .\" Source: Linux-PAM
8 .\" Language: English
9 .\"
10 .TH "PAM_ECHO" "8" "06/29/2025" "Linux\-PAM" "Linux\-PAM Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 pam_echo \- PAM module for printing text messages
32 .SH "SYNOPSIS"
33 .HP \w'\fBpam_echo\&.so\fR\ 'u
34 \fBpam_echo\&.so\fR [file=\fI/path/message\fR]
35 .SH "DESCRIPTION"
36 .PP
37 The
38 \fIpam_echo\fR
39 PAM module is for printing text messages to inform user about special things\&. Sequences starting with the
40 \fI%\fR
41 character are interpreted in the following way:
42 .PP
43 %H
44 .RS 4
45 The name of the remote host (PAM_RHOST)\&.
46 .RE
47 .PP
48 %h
49 .RS 4
50 The name of the local host\&.
51 .RE
52 .PP
53 %s
54 .RS 4
55 The service name (PAM_SERVICE)\&.
56 .RE
57 .PP
58 %t
59 .RS 4
60 The name of the controlling terminal (PAM_TTY)\&.
61 .RE
62 .PP
63 %U
64 .RS 4
65 The remote user name (PAM_RUSER)\&.
66 .RE
67 .PP
68 %u
69 .RS 4
70 The local user name (PAM_USER)\&.
71 .RE
72 .PP
73 All other sequences beginning with
74 \fI%\fR
75 expands to the characters following the
76 \fI%\fR
77 character\&.
78 .SH "OPTIONS"
79 .PP
80 file=/path/message
81 .RS 4
82 The content of the file
83 /path/message
84 will be printed with the PAM conversion function as PAM_TEXT_INFO\&.
85 .RE
86 .SH "MODULE TYPES PROVIDED"
87 .PP
88 All module types (\fBauth\fR,
89 \fBaccount\fR,
90 \fBpassword\fR
91 and
92 \fBsession\fR) are provided\&.
93 .SH "RETURN VALUES"
94 .PP
95 PAM_BUF_ERR
96 .RS 4
97 Memory buffer error\&.
98 .RE
99 .PP
100 PAM_SUCCESS
101 .RS 4
102 Message was successful printed\&.
103 .RE
104 .PP
105 PAM_IGNORE
106 .RS 4
107 PAM_SILENT flag was given or message file does not exist, no message printed\&.
108 .RE
109 .SH "EXAMPLES"
110 .PP
111 For an example of the use of this module, we show how it may be used to print information about good passwords:
112 .sp
113 .if n \{\
114 .RS 4
115 .\}
116 .nf
117 password optional pam_echo\&.so file=/usr/share/doc/good\-password\&.txt
118 password required pam_unix\&.so
119
120 .fi
121 .if n \{\
122 .RE
123 .\}
124 .sp
125 .SH "SEE ALSO"
126 .PP
127 \fBpam.conf\fR(8),
128 \fBpam.d\fR(5),
129 \fBpam\fR(7)
130 .SH "AUTHOR"
131 .PP
132 Thorsten Kukuk <kukuk@thkukuk\&.de>