diff options
Diffstat (limited to 'Linux-PAM/modules/pam_mail/pam_mail.8.xml')
| -rw-r--r-- | Linux-PAM/modules/pam_mail/pam_mail.8.xml | 279 |
1 files changed, 0 insertions, 279 deletions
diff --git a/Linux-PAM/modules/pam_mail/pam_mail.8.xml b/Linux-PAM/modules/pam_mail/pam_mail.8.xml deleted file mode 100644 index d3c481a5..00000000 --- a/Linux-PAM/modules/pam_mail/pam_mail.8.xml +++ /dev/null @@ -1,279 +0,0 @@ -<?xml version="1.0" encoding='UTF-8'?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" - "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> - -<refentry id="pam_mail"> - - <refmeta> - <refentrytitle>pam_mail</refentrytitle> - <manvolnum>8</manvolnum> - <refmiscinfo class="sectdesc">Linux-PAM Manual</refmiscinfo> - </refmeta> - - <refnamediv id="pam_mail-name"> - <refname>pam_mail</refname> - <refpurpose>Inform about available mail</refpurpose> - </refnamediv> - - <refsynopsisdiv> - <cmdsynopsis id="pam_mail-cmdsynopsis"> - <command>pam_mail.so</command> - <arg choice="opt"> - close - </arg> - <arg choice="opt"> - debug - </arg> - <arg choice="opt"> - dir=<replaceable>maildir</replaceable> - </arg> - <arg choice="opt"> - empty - </arg> - <arg choice="opt"> - hash=<replaceable>count</replaceable> - </arg> - <arg choice="opt"> - noenv - </arg> - <arg choice="opt"> - nopen - </arg> - <arg choice="opt"> - quit - </arg> - <arg choice="opt"> - standard - </arg> - </cmdsynopsis> - </refsynopsisdiv> - - <refsect1 id="pam_mail-description"> - - <title>DESCRIPTION</title> - - <para> - 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 <emphasis>newness</emphasis> of any mail it finds - in the user's mail folder. This module also sets the PAM - environment variable, <emphasis remap='B'>MAIL</emphasis>, to the - user's mail directory. - </para> - <para> - If the mail spool file (be it <filename>/var/mail/$USER</filename> - or a pathname given with the <option>dir=</option> parameter) is - a directory then pam_mail assumes it is in the - <emphasis remap='I'>Maildir</emphasis> format. - </para> - </refsect1> - - <refsect1 id="pam_mail-options"> - - <title>OPTIONS</title> - <para> - <variablelist> - - <varlistentry> - <term> - <option>close</option> - </term> - <listitem> - <para> - Indicate if the user has any mail also on logout. - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <option>debug</option> - </term> - <listitem> - <para> - Print debug information. - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <option>dir=<replaceable>maildir</replaceable></option> - </term> - <listitem> - <para> - Look for the users' mail in an alternative location defined by - <filename>maildir/<login></filename>. The default - location for mail is <filename>/var/mail/<login></filename>. - Note, if the supplied - <filename>maildir</filename> is prefixed by a '~', the - directory is interpreted as indicating a file in the user's - home directory. - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <option>empty</option> - </term> - <listitem> - <para> - Also print message if user has no mail. - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <option>hash=<replaceable>count</replaceable></option> - </term> - <listitem> - <para> - Mail directory hash depth. For example, a - <emphasis>hashcount</emphasis> of 2 would - make the mail file be - <filename>/var/spool/mail/u/s/user</filename>. - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <option>noenv</option> - </term> - <listitem> - <para> - Do not set the <emphasis remap='B'>MAIL</emphasis> - environment variable. - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <option>nopen</option> - </term> - <listitem> - <para> - Don't print any mail information on login. This flag is - useful to get the <emphasis remap='B'>MAIL</emphasis> - environment variable set, but to not display any information - about it. - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <option>quiet</option> - </term> - <listitem> - <para> - Only report when there is new mail. - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <option>standard</option> - </term> - <listitem> - <para> - Old style "You have..." format which doesn't show the - mail spool being used. This also implies "empty". - </para> - </listitem> - </varlistentry> - - </variablelist> - - </para> - </refsect1> - - <refsect1 id="pam_mail-services"> - <title>MODULE SERVICES PROVIDED</title> - <para> - The <emphasis remap='B'>auth</emphasis> and - <emphasis remap='B'>account</emphasis> services are supported. - </para> - </refsect1> - - <refsect1 id='pam_mail-return_values'> - <title>RETURN VALUES</title> - <variablelist> - <varlistentry> - <term>PAM_BUF_ERR</term> - <listitem> - <para> - Memory buffer error. - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term>PAM_SERVICE_ERR</term> - <listitem> - <para> - Badly formed arguments. - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term>PAM_SUCCESS</term> - <listitem> - <para> - Success. - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term>PAM_USER_UNKNOWN</term> - <listitem> - <para> - User not known. - </para> - </listitem> - </varlistentry> - - </variablelist> - </refsect1> - - <refsect1 id='pam_mail-examples'> - <title>EXAMPLES</title> - <para> - Add the following line to <filename>/etc/pam.d/login</filename> to - indicate that the user has new mail when they login to the system. - <programlisting> -session optional pam_mail.so standard - </programlisting> - </para> - </refsect1> - - <refsect1 id='pam_mail-see_also'> - <title>SEE ALSO</title> - <para> - <citerefentry> - <refentrytitle>pam.conf</refentrytitle><manvolnum>5</manvolnum> - </citerefentry>, - <citerefentry> - <refentrytitle>pam.d</refentrytitle><manvolnum>8</manvolnum> - </citerefentry>, - <citerefentry> - <refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum> - </citerefentry> - </para> - </refsect1> - - <refsect1 id='pam_mail-author'> - <title>AUTHOR</title> - <para> - pam_mail was written by Andrew G. Morgan <morgan@kernel.org>. - </para> - </refsect1> - -</refentry> |