summaryrefslogtreecommitdiff
path: root/modules/pam_lastlog/pam_lastlog.8.xml
blob: fa97b03e9776abad5f6e4421b75ee0306855c134 (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
<?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_lastlog">

  <refmeta>
    <refentrytitle>pam_lastlog</refentrytitle>
    <manvolnum>8</manvolnum>
    <refmiscinfo class="sectdesc">Linux-PAM Manual</refmiscinfo>
  </refmeta>

  <refnamediv id="pam_lastlog-name">
    <refname>pam_lastlog</refname>
    <refpurpose>PAM module to display date of last login</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis id="pam_lastlog-cmdsynopsis">
      <command>pam_lastlog.so</command>
      <arg choice="opt">
	debug
      </arg>
      <arg choice="opt">
        silent
      </arg>
      <arg choice="opt">
        never
      </arg>
      <arg choice="opt">
        nodate
      </arg>
      <arg choice="opt">
        nohost
      </arg>
      <arg choice="opt">
        noterm
      </arg>
      <arg choice="opt">
        nowtmp
      </arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1 id="pam_lastlog-description">

    <title>DESCRIPTION</title>

    <para>
      pam_lastlog is a PAM module to display a line of information
      about the last login of the user. In addition, the module maintains
      the <filename>/var/log/lastlog</filename> file.
    </para>
    <para>
      Some applications may perform this function themselves. In such
      cases, this module is not necessary.
    </para>
  </refsect1>

  <refsect1 id="pam_lastlog-options">

    <title>OPTIONS</title>
    <variablelist>
      <varlistentry>
        <term>
          <option>debug</option>
        </term>
        <listitem>
          <para>
            Print debug information.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>silent</option>
        </term>
        <listitem>
          <para>
            Don't inform the user about any previous login,
            just upate the <filename>/var/log/lastlog</filename> file.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>never</option>
        </term>
        <listitem>
          <para>
            If the <filename>/var/log/lastlog</filename> file does
            not contain any old entries for the user, indicate that
            the user has never previously logged in with a welcome
            message.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>nodate</option>
        </term>
        <listitem>
          <para>
            Don't display the date of the last login.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>noterm</option>
        </term>
        <listitem>
          <para>
            Don't display the terminal name on which the
            last login was attempted.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>nohost</option>
        </term>
        <listitem>
          <para>
            Don't indicate from which host the last login was
            attempted.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>nowtmp</option>
        </term>
        <listitem>
          <para>
            Don't update the wtmp entry.
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1 id="pam_lastlog-services">
    <title>MODULE SERVICES PROVIDED</title>
    <para>
      Only the <option>session</option> service is supported.
    </para>
  </refsect1>

  <refsect1 id='pam_lastlog-return_values'>
    <title>RETURN VALUES</title>
    <para>
      <variablelist>

        <varlistentry>
          <term>PAM_SUCCESS</term>
          <listitem>
            <para>
              Everything was successfull.
            </para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>PAM_SERVICE_ERR</term>
          <listitem>
            <para>
	      Internal service module error.
            </para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>PAM_USER_UNKNOWN</term>
          <listitem>
            <para>
	      User not known.
            </para>
          </listitem>
        </varlistentry>

      </variablelist>
    </para>
  </refsect1>

  <refsect1 id='pam_lastlog-examples'>
    <title>EXAMPLES</title>
    <para>
      Add the following line to <filename>/etc/pam.d/login</filename> to
      display the last login time of an user:
    </para>
      <programlisting>
    session  required  pam_lastlog.so nowtmp
      </programlisting>
  </refsect1>

  <refsect1 id="pam_lastlog-files">
    <title>FILES</title>
    <variablelist>
      <varlistentry>
        <term><filename>/var/log/lastlog</filename></term>
        <listitem>
          <para>Lastlog logging file</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1 id='pam_lastlog-see_also'>
    <title>SEE ALSO</title>
    <para>
      <citerefentry>
	<refentrytitle>pam.conf</refentrytitle><manvolnum>5</manvolnum>
      </citerefentry>,
      <citerefentry>
	<refentrytitle>pam.d</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>,
      <citerefentry>
	<refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>
    </para>
  </refsect1>

  <refsect1 id='pam_lastlog-author'>
    <title>AUTHOR</title>
      <para>
        pam_lastlog was written by Andrew G. Morgan &lt;morgan@kernel.org&gt;.
      </para>
  </refsect1>

</refentry>
<!-- vim: sw=2
-->