summaryrefslogtreecommitdiff
path: root/Linux-PAM/modules/pam_mail/pam_mail.8
diff options
context:
space:
mode:
Diffstat (limited to 'Linux-PAM/modules/pam_mail/pam_mail.8')
-rw-r--r--Linux-PAM/modules/pam_mail/pam_mail.8139
1 files changed, 0 insertions, 139 deletions
diff --git a/Linux-PAM/modules/pam_mail/pam_mail.8 b/Linux-PAM/modules/pam_mail/pam_mail.8
deleted file mode 100644
index 4c575a90..00000000
--- a/Linux-PAM/modules/pam_mail/pam_mail.8
+++ /dev/null
@@ -1,139 +0,0 @@
-.\" Title: pam_mail
-.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/>
-.\" Date: 01/08/2008
-.\" Manual: Linux-PAM Manual
-.\" Source: Linux-PAM Manual
-.\"
-.TH "PAM_MAIL" "8" "01/08/2008" "Linux-PAM Manual" "Linux\-PAM Manual"
-.\" disable hyphenation
-.nh
-.\" disable justification (adjust text to left margin only)
-.ad l
-.SH "NAME"
-pam_mail - Inform about available mail
-.SH "SYNOPSIS"
-.HP 12
-\fBpam_mail\.so\fR [close] [debug] [dir=\fImaildir\fR] [empty] [hash=\fIcount\fR] [noenv] [nopen] [quit] [standard]
-.SH "DESCRIPTION"
-.PP
-The pam_mail PAM module provides the "you have new mail" service to the user\. It can be plugged into any application that has credential or session hooks\. It gives a single message indicating the
-\fInewness\fR
-of any mail it finds in the user\'s mail folder\. This module also sets the PAM environment variable,
-\fBMAIL\fR, to the user\'s mail directory\.
-.PP
-If the mail spool file (be it
-\fI/var/mail/$USER\fR
-or a pathname given with the
-\fBdir=\fR
-parameter) is a directory then pam_mail assumes it is in the
-\fIMaildir\fR
-format\.
-.SH "OPTIONS"
-.PP
-.PP
-\fBclose\fR
-.RS 4
-Indicate if the user has any mail also on logout\.
-.RE
-.PP
-\fBdebug\fR
-.RS 4
-Print debug information\.
-.RE
-.PP
-\fBdir=\fR\fB\fImaildir\fR\fR
-.RS 4
-Look for the users\' mail in an alternative location defined by
-\fImaildir/<login>\fR\. The default location for mail is
-\fI/var/mail/<login>\fR\. Note, if the supplied
-\fImaildir\fR
-is prefixed by a \'~\', the directory is interpreted as indicating a file in the user\'s home directory\.
-.RE
-.PP
-\fBempty\fR
-.RS 4
-Also print message if user has no mail\.
-.RE
-.PP
-\fBhash=\fR\fB\fIcount\fR\fR
-.RS 4
-Mail directory hash depth\. For example, a
-\fIhashcount\fR
-of 2 would make the mail file be
-\fI/var/spool/mail/u/s/user\fR\.
-.RE
-.PP
-\fBnoenv\fR
-.RS 4
-Do not set the
-\fBMAIL\fR
-environment variable\.
-.RE
-.PP
-\fBnopen\fR
-.RS 4
-Don\'t print any mail information on login\. This flag is useful to get the
-\fBMAIL\fR
-environment variable set, but to not display any information about it\.
-.RE
-.PP
-\fBquiet\fR
-.RS 4
-Only report when there is new mail\.
-.RE
-.PP
-\fBstandard\fR
-.RS 4
-Old style "You have\.\.\." format which doesn\'t show the mail spool being used\. This also implies "empty"\.
-.RE
-.SH "MODULE SERVICES PROVIDED"
-.PP
-The
-\fBauth\fR
-and
-\fBaccount\fR
-services are supported\.
-.SH "RETURN VALUES"
-.PP
-PAM_BUF_ERR
-.RS 4
-Memory buffer error\.
-.RE
-.PP
-PAM_SERVICE_ERR
-.RS 4
-Badly formed arguments\.
-.RE
-.PP
-PAM_SUCCESS
-.RS 4
-Success\.
-.RE
-.PP
-PAM_USER_UNKNOWN
-.RS 4
-User not known\.
-.RE
-.SH "EXAMPLES"
-.PP
-Add the following line to
-\fI/etc/pam\.d/login\fR
-to indicate that the user has new mail when they login to the system\.
-.sp
-.RS 4
-.nf
-session optional pam_mail\.so standard
-
-.fi
-.RE
-.sp
-.SH "SEE ALSO"
-.PP
-
-\fBpam.conf\fR(5),
-\fBpam.d\fR(8),
-\fBpam\fR(8)
-.SH "AUTHOR"
-.PP
-pam_mail was written by Andrew G\. Morgan <morgan@kernel\.org>\.