modules/pam_lastlog/pam_lastlog.8

   1 .\"     Title: pam_lastlog
   2 .\"    Author: [see the "AUTHOR" section]
   3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
   4 .\"      Date: 06/21/2011
   5 .\"    Manual: Linux-PAM Manual
   6 .\"    Source: Linux-PAM Manual
   7 .\"  Language: English
   8 .\"
   9 .TH "PAM_LASTLOG" "8" "06/21/2011" "Linux-PAM Manual" "Linux\-PAM Manual"
  10 .\" -----------------------------------------------------------------
  11 .\" * (re)Define some macros
  12 .\" -----------------------------------------------------------------
  13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  14 .\" toupper - uppercase a string (locale-aware)
  15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  16 .de toupper
  17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
  18 \\$*
  19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
  20 ..
  21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  22 .\" SH-xref - format a cross-reference to an SH section
  23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  24 .de SH-xref
  25 .ie n \{\
  26 .\}
  27 .toupper \\$*
  28 .el \{\
  29 \\$*
  30 .\}
  31 ..
  32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  33 .\" SH - level-one heading that works better for non-TTY output
  34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35 .de1 SH
  36 .\" put an extra blank line of space above the head in non-TTY output
  37 .if t \{\
  38 .sp 1
  39 .\}
  40 .sp \\n[PD]u
  41 .nr an-level 1
  42 .set-an-margin
  43 .nr an-prevailing-indent \\n[IN]
  44 .fi
  45 .in \\n[an-margin]u
  46 .ti 0
  47 .HTML-TAG ".NH \\n[an-level]"
  48 .it 1 an-trap
  49 .nr an-no-space-flag 1
  50 .nr an-break-flag 1
  51 \." make the size of the head bigger
  52 .ps +3
  53 .ft B
  54 .ne (2v + 1u)
  55 .ie n \{\
  56 .\" if n (TTY output), use uppercase
  57 .toupper \\$*
  58 .\}
  59 .el \{\
  60 .nr an-break-flag 0
  61 .\" if not n (not TTY), use normal case (not uppercase)
  62 \\$1
  63 .in \\n[an-margin]u
  64 .ti 0
  65 .\" if not n (not TTY), put a border/line under subheading
  66 .sp -.6
  67 \l'\n(.lu'
  68 .\}
  69 ..
  70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  71 .\" SS - level-two heading that works better for non-TTY output
  72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  73 .de1 SS
  74 .sp \\n[PD]u
  75 .nr an-level 1
  76 .set-an-margin
  77 .nr an-prevailing-indent \\n[IN]
  78 .fi
  79 .in \\n[IN]u
  80 .ti \\n[SN]u
  81 .it 1 an-trap
  82 .nr an-no-space-flag 1
  83 .nr an-break-flag 1
  84 .ps \\n[PS-SS]u
  85 \." make the size of the head bigger
  86 .ps +2
  87 .ft B
  88 .ne (2v + 1u)
  89 .if \\n[.$] \&\\$*
  90 ..
  91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  92 .\" BB/BE - put background/screen (filled box) around block of text
  93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  94 .de BB
  95 .if t \{\
  96 .sp -.5
  97 .br
  98 .in +2n
  99 .ll -2n
 100 .gcolor red
 101 .di BX
 102 .\}
 103 ..
 104 .de EB
 105 .if t \{\
 106 .if "\\$2"adjust-for-leading-newline" \{\
 107 .sp -1
 108 .\}
 109 .br
 110 .di
 111 .in
 112 .ll
 113 .gcolor
 114 .nr BW \\n(.lu-\\n(.i
 115 .nr BH \\n(dn+.5v
 116 .ne \\n(BHu+.5v
 117 .ie "\\$2"adjust-for-leading-newline" \{\
 118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 119 .\}
 120 .el \{\
 121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 122 .\}
 123 .in 0
 124 .sp -.5v
 125 .nf
 126 .BX
 127 .in
 128 .sp .5v
 129 .fi
 130 .\}
 131 ..
 132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 133 .\" BM/EM - put colored marker in margin next to block of text
 134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 135 .de BM
 136 .if t \{\
 137 .br
 138 .ll -2n
 139 .gcolor red
 140 .di BX
 141 .\}
 142 ..
 143 .de EM
 144 .if t \{\
 145 .br
 146 .di
 147 .ll
 148 .gcolor
 149 .nr BH \\n(dn
 150 .ne \\n(BHu
 151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
 152 .in 0
 153 .nf
 154 .BX
 155 .in
 156 .fi
 157 .\}
 158 ..
 159 .\" -----------------------------------------------------------------
 160 .\" * set default formatting
 161 .\" -----------------------------------------------------------------
 162 .\" disable hyphenation
 163 .nh
 164 .\" disable justification (adjust text to left margin only)
 165 .ad l
 166 .\" -----------------------------------------------------------------
 167 .\" * MAIN CONTENT STARTS HERE *
 168 .\" -----------------------------------------------------------------
 169 .SH "Name"
 170 pam_lastlog \- PAM module to display date of last login
 171 .SH "Synopsis"
 172 .fam C
 173 .HP \w'\fBpam_lastlog\&.so\fR\ 'u
 174 \fBpam_lastlog\&.so\fR [debug] [silent] [never] [nodate] [nohost] [noterm] [nowtmp] [noupdate] [showfailed]
 175 .fam
 176 .SH "DESCRIPTION"
 177 .PP
 178 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
 179 \FC/var/log/lastlog\F[]
 180 file\&.
 181 .PP
 182 Some applications may perform this function themselves\&. In such cases, this module is not necessary\&.
 183 .SH "OPTIONS"
 184 .PP
 185 \fBdebug\fR
 186 .RS 4
 187 Print debug information\&.
 188 .RE
 189 .PP
 190 \fBsilent\fR
 191 .RS 4
 192 Don\'t inform the user about any previous login, just update the
 193 \FC/var/log/lastlog\F[]
 194 file\&.
 195 .RE
 196 .PP
 197 \fBnever\fR
 198 .RS 4
 199 If the
 200 \FC/var/log/lastlog\F[]
 201 file does not contain any old entries for the user, indicate that the user has never previously logged in with a welcome message\&.
 202 .RE
 203 .PP
 204 \fBnodate\fR
 205 .RS 4
 206 Don\'t display the date of the last login\&.
 207 .RE
 208 .PP
 209 \fBnoterm\fR
 210 .RS 4
 211 Don\'t display the terminal name on which the last login was attempted\&.
 212 .RE
 213 .PP
 214 \fBnohost\fR
 215 .RS 4
 216 Don\'t indicate from which host the last login was attempted\&.
 217 .RE
 218 .PP
 219 \fBnowtmp\fR
 220 .RS 4
 221 Don\'t update the wtmp entry\&.
 222 .RE
 223 .PP
 224 \fBnoupdate\fR
 225 .RS 4
 226 Don\'t update any file\&.
 227 .RE
 228 .PP
 229 \fBshowfailed\fR
 230 .RS 4
 231 Display number of failed login attempts and the date of the last failed attempt from btmp\&. The date is not displayed when
 232 \fBnodate\fR
 233 is specified\&.
 234 .RE
 235 .SH "MODULE TYPES PROVIDED"
 236 .PP
 237 Only the
 238 \fBsession\fR
 239 module type is provided\&.
 240 .SH "RETURN VALUES"
 241 .PP
 242 .PP
 243 PAM_SUCCESS
 244 .RS 4
 245 Everything was successful\&.
 246 .RE
 247 .PP
 248 PAM_SERVICE_ERR
 249 .RS 4
 250 Internal service module error\&.
 251 .RE
 252 .PP
 253 PAM_USER_UNKNOWN
 254 .RS 4
 255 User not known\&.
 256 .RE
 257 .SH "EXAMPLES"
 258 .PP
 259 Add the following line to
 260 \FC/etc/pam\&.d/login\F[]
 261 to display the last login time of an user:
 262 .sp
 263 .if n \{\
 264 .RS 4
 265 .\}
 266 .fam C
 267 .ps -1
 268 .nf
 269 .if t \{\
 270 .sp -1
 271 .\}
 272 .BB lightgray adjust-for-leading-newline
 273 .sp -1
 274
 275     session  required  pam_lastlog\&.so nowtmp
 276
 277 .EB lightgray adjust-for-leading-newline
 278 .if t \{\
 279 .sp 1
 280 .\}
 281 .fi
 282 .fam
 283 .ps +1
 284 .if n \{\
 285 .RE
 286 .\}
 287 .SH "FILES"
 288 .PP
 289 \FC/var/log/lastlog\F[]
 290 .RS 4
 291 Lastlog logging file
 292 .RE
 293 .SH "SEE ALSO"
 294 .PP
 295
 296 \fBpam.conf\fR(5),
 297 \fBpam.d\fR(5),
 298 \fBpam\fR(8)
 299 .SH "AUTHOR"
 300 .PP
 301 pam_lastlog was written by Andrew G\&. Morgan <morgan@kernel\&.org>\&.