blob: fb9b73777d5420b3ee89574b5ea318f4a3a7d17b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
|
<?xml version="1.0" encoding='UTF-8'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
<refentry id="pam_issue">
<refmeta>
<refentrytitle>pam_issue</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo class="sectdesc">Linux-PAM Manual</refmiscinfo>
</refmeta>
<refnamediv id="pam_issue-name">
<refname>pam_issue</refname>
<refpurpose>PAM module to add issue file to user prompt</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis id="pam_issue-cmdsynopsis">
<command>pam_issue.so</command>
<arg choice="opt">
noesc
</arg>
<arg choice="opt">
issue=<replaceable>issue-file-name</replaceable>
</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="pam_issue-description">
<title>DESCRIPTION</title>
<para>
pam_issue is a PAM module to prepend an issue file to the username
prompt. It also by default parses escape codes in the issue file
similar to some common getty's (using \x format).
</para>
<para>
Recognized escapes:
</para>
<variablelist>
<varlistentry>
<term><emphasis remap='B'>\d</emphasis></term>
<listitem>
<para>current day</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis remap='B'>\l</emphasis></term>
<listitem>
<para>name of this tty</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis remap='B'>\m</emphasis></term>
<listitem>
<para>machine architecture (uname -m)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis remap='B'>\n</emphasis></term>
<listitem>
<para>machine's network node hostname (uname -n)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis remap='B'>\o</emphasis></term>
<listitem>
<para>domain name of this system</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis remap='B'>\r</emphasis></term>
<listitem>
<para>release number of operating system (uname -r)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis remap='B'>\t</emphasis></term>
<listitem>
<para>current time</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis remap='B'>\s</emphasis></term>
<listitem>
<para>operating system name (uname -s)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis remap='B'>\u</emphasis></term>
<listitem>
<para>number of users currently logged in</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis remap='B'>\U</emphasis></term>
<listitem>
<para>
same as \u except it is suffixed with "user" or
"users" (eg. "1 user" or "10 users")
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis remap='B'>\v</emphasis></term>
<listitem>
<para>operating system version and build date (uname -v)</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="pam_issue-options">
<title>OPTIONS</title>
<para>
<variablelist>
<varlistentry>
<term>
<option>noesc</option>
</term>
<listitem>
<para>
Turns off escape code parsing.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>issue=<replaceable>issue-file-name</replaceable></option>
</term>
<listitem>
<para>
The file to output if not using the default.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 id="pam_issue-types">
<title>MODULE TYPES PROVIDED</title>
<para>
Only the <option>auth</option> module type is provided.
</para>
</refsect1>
<refsect1 id='pam_issue-return_values'>
<title>RETURN VALUES</title>
<para>
<variablelist>
<varlistentry>
<term>PAM_BUF_ERR</term>
<listitem>
<para>
Memory buffer error.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>PAM_IGNORE</term>
<listitem>
<para>
The prompt was already changed.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>PAM_SERVICE_ERR</term>
<listitem>
<para>
A service module error occurred.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>PAM_SUCCESS</term>
<listitem>
<para>
The new prompt was set successfully.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 id='pam_issue-examples'>
<title>EXAMPLES</title>
<para>
Add the following line to <filename>/etc/pam.d/login</filename> to
set the user specific issue at login:
<programlisting>
auth optional pam_issue.so issue=/etc/issue
</programlisting>
</para>
</refsect1>
<refsect1 id='pam_issue-see_also'>
<title>SEE ALSO</title>
<para>
<citerefentry>
<refentrytitle>pam.conf</refentrytitle><manvolnum>5</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>pam.d</refentrytitle><manvolnum>5</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>
</para>
</refsect1>
<refsect1 id='pam_issue-author'>
<title>AUTHOR</title>
<para>
pam_issue was written by Ben Collins <bcollins@debian.org>.
</para>
</refsect1>
</refentry>
|
