diff options
Diffstat (limited to '')
-rw-r--r-- | modules/pam_mail/README | 71 | ||||
-rw-r--r-- | modules/pam_mail/README.xml | 41 |
2 files changed, 112 insertions, 0 deletions
diff --git a/modules/pam_mail/README b/modules/pam_mail/README new file mode 100644 index 0000000..3da9276 --- /dev/null +++ b/modules/pam_mail/README @@ -0,0 +1,71 @@ +pam_mail — Inform about available mail + +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + +DESCRIPTION + +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 newness of any mail it finds in the +user's mail folder. This module also sets the PAM environment variable, MAIL, +to the user's mail directory. + +If the mail spool file (be it /var/mail/$USER or a pathname given with the dir= +parameter) is a directory then pam_mail assumes it is in the Maildir format. + +OPTIONS + +close + + Indicate if the user has any mail also on logout. + +debug + + Print debug information. + +dir=maildir + + Look for the user's mail in an alternative location defined by maildir/ + <login>. The default location for mail is /var/mail/<login>. Note, if the + supplied maildir is prefixed by a '~', the directory is interpreted as + indicating a file in the user's home directory. + +empty + + Also print message if user has no mail. + +hash=count + + Mail directory hash depth. For example, a hashcount of 2 would make the + mail file be /var/spool/mail/u/s/user. + +noenv + + Do not set the MAIL environment variable. + +nopen + + Don't print any mail information on login. This flag is useful to get the + MAIL environment variable set, but to not display any information about it. + +quiet + + Only report when there is new mail. + +standard + + Old style "You have..." format which doesn't show the mail spool being + used. This also implies "empty". + +EXAMPLES + +Add the following line to /etc/pam.d/login to indicate that the user has new +mail when they login to the system. + +session optional pam_mail.so standard + + +AUTHOR + +pam_mail was written by Andrew G. Morgan <morgan@kernel.org>. + diff --git a/modules/pam_mail/README.xml b/modules/pam_mail/README.xml new file mode 100644 index 0000000..4165d85 --- /dev/null +++ b/modules/pam_mail/README.xml @@ -0,0 +1,41 @@ +<?xml version="1.0" encoding='UTF-8'?> +<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.docbook.org/xml/4.3/docbookx.dtd" +[ +<!-- +<!ENTITY pamaccess SYSTEM "pam_mail.8.xml"> +--> +]> + +<article> + + <articleinfo> + + <title> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" + href="pam_mail.8.xml" xpointer='xpointer(//refnamediv[@id = "pam_mail-name"]/*)'/> + </title> + + </articleinfo> + + <section> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" + href="pam_mail.8.xml" xpointer='xpointer(//refsect1[@id = "pam_mail-description"]/*)'/> + </section> + + <section> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" + href="pam_mail.8.xml" xpointer='xpointer(//refsect1[@id = "pam_mail-options"]/*)'/> + </section> + + <section> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" + href="pam_mail.8.xml" xpointer='xpointer(//refsect1[@id = "pam_mail-examples"]/*)'/> + </section> + + <section> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" + href="pam_mail.8.xml" xpointer='xpointer(//refsect1[@id = "pam_mail-author"]/*)'/> + </section> + +</article> |