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.8122
1 files changed, 74 insertions, 48 deletions
diff --git a/Linux-PAM/modules/pam_mail/pam_mail.8 b/Linux-PAM/modules/pam_mail/pam_mail.8
index 6d8a69a8..4c575a90 100644
--- a/Linux-PAM/modules/pam_mail/pam_mail.8
+++ b/Linux-PAM/modules/pam_mail/pam_mail.8
@@ -1,26 +1,26 @@
.\" Title: pam_mail
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/>
-.\" Date: 06/09/2006
-.\" Manual: Linux\-PAM Manual
-.\" Source: Linux\-PAM Manual
+.\" 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" "06/09/2006" "Linux\-PAM Manual" "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
+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]
+\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
+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.
+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
@@ -28,76 +28,102 @@ or a pathname given with the
\fBdir=\fR
parameter) is a directory then pam_mail assumes it is in the
\fIMaildir\fR
-format.
+format\.
.SH "OPTIONS"
.PP
-.TP 3n
+.PP
\fBclose\fR
-Indicate if the user has any mail also on logout.
-.TP 3n
+.RS 4
+Indicate if the user has any mail also on logout\.
+.RE
+.PP
\fBdebug\fR
-Print debug information.
-.TP 3n
+.RS 4
+Print debug information\.
+.RE
+.PP
\fBdir=\fR\fB\fImaildir\fR\fR
-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
+.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.
-.TP 3n
+is prefixed by a \'~\', the directory is interpreted as indicating a file in the user\'s home directory\.
+.RE
+.PP
\fBempty\fR
-Also print message if user has no mail.
-.TP 3n
+.RS 4
+Also print message if user has no mail\.
+.RE
+.PP
\fBhash=\fR\fB\fIcount\fR\fR
-Mail directory hash depth. For example, a
+.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.
-.TP 3n
+\fI/var/spool/mail/u/s/user\fR\.
+.RE
+.PP
\fBnoenv\fR
+.RS 4
Do not set the
\fBMAIL\fR
-environment variable.
-.TP 3n
+environment variable\.
+.RE
+.PP
\fBnopen\fR
-Don't print any mail information on login. This flag is useful to get the
+.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.
-.TP 3n
+environment variable set, but to not display any information about it\.
+.RE
+.PP
\fBquiet\fR
-Only report when there is new mail.
-.TP 3n
+.RS 4
+Only report when there is new mail\.
+.RE
+.PP
\fBstandard\fR
-Old style "You have..." format which doesn't show the mail spool being used. This also implies "empty".
+.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.
+services are supported\.
.SH "RETURN VALUES"
-.TP 3n
+.PP
PAM_BUF_ERR
-Memory buffer error.
-.TP 3n
+.RS 4
+Memory buffer error\.
+.RE
+.PP
PAM_SERVICE_ERR
-Badly formed arguments.
-.TP 3n
+.RS 4
+Badly formed arguments\.
+.RE
+.PP
PAM_SUCCESS
-Success.
-.TP 3n
+.RS 4
+Success\.
+.RE
+.PP
PAM_USER_UNKNOWN
-User not known.
+.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.
+\fI/etc/pam\.d/login\fR
+to indicate that the user has new mail when they login to the system\.
.sp
-.RS 3n
+.RS 4
.nf
-session optional pam_mail.so standard
+session optional pam_mail\.so standard
.fi
.RE
@@ -110,4 +136,4 @@ session optional pam_mail.so standard
\fBpam\fR(8)
.SH "AUTHOR"
.PP
-pam_mail was written by Andrew G. Morgan <morgan@kernel.org>.
+pam_mail was written by Andrew G\. Morgan <morgan@kernel\.org>\.