Initial import from FreeBSD RELENG_4:
[dragonfly.git] / contrib / libpam / modules / pam_mail / README
1 # $FreeBSD: src/contrib/libpam/modules/pam_mail/README,v 1.1.1.1.2.2 2001/06/11 15:28:19 markm Exp $
2 This is the README for pam_mail
3 -------------------------------
4
5 This PAM module tells the User that he has new/unread email.
6
7 Options for:
8 auth:   for authentication it provides pam_authenticate() and
9         pam_setcred() hooks.
10
11         "debug"         write more information to syslog
12         "dir=maildir"   users mailbox is maildir/<login> 
13         "hash=count"    mail directory hash depth
14         "close"         print message also on logout
15         "nopen"         print message not on login
16         "noenv"         don't set the MAIL environment variable
17         "empty"         also print message if user has no mail
18