modules/pam_faildelay/pam_faildelay.8.xml

   1 <?xml version="1.0" encoding='UTF-8'?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   3         "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
   4
   5 <refentry id="pam_faildelay">
   6
   7   <refmeta>
   8     <refentrytitle>pam_faildelay</refentrytitle>
   9     <manvolnum>8</manvolnum>
  10     <refmiscinfo class="sectdesc">Linux-PAM Manual</refmiscinfo>
  11   </refmeta>
  12
  13   <refnamediv id="pam_faildelay-name">
  14     <refname>pam_faildelay</refname>
  15     <refpurpose>Change the delay on failure per-application</refpurpose>
  16   </refnamediv>
  17
  18   <refsynopsisdiv>
  19     <cmdsynopsis id="pam_faildelay-cmdsynopsis">
  20       <command>pam_faildelay.so</command>
  21       <arg choice="opt">
  22         debug
  23       </arg>
  24       <arg choice="opt">
  25         delay=<replaceable>microseconds</replaceable>
  26       </arg>
  27     </cmdsynopsis>
  28   </refsynopsisdiv>
  29
  30   <refsect1 id="pam_faildelay-description">
  31
  32     <title>DESCRIPTION</title>
  33
  34     <para>
  35       pam_faildelay is a PAM module that can be used to set
  36       the delay on failure per-application.
  37     </para>
  38     <para>
  39       If no <option>delay</option> is given, pam_faildelay will
  40       use the value of FAIL_DELAY from <filename>/etc/login.defs</filename>.
  41     </para>
  42   </refsect1>
  43
  44   <refsect1 id="pam_faildelay-options">
  45
  46     <title>OPTIONS</title>
  47     <variablelist>
  48       <varlistentry>
  49         <term>
  50           <option>debug</option>
  51         </term>
  52         <listitem>
  53           <para>
  54             Turns on debugging messages sent to syslog.
  55           </para>
  56         </listitem>
  57       </varlistentry>
  58       <varlistentry>
  59         <term>
  60           <option>delay=<replaceable>N</replaceable></option>
  61         </term>
  62         <listitem>
  63           <para>
  64             Set the delay on failure to N microseconds.
  65           </para>
  66         </listitem>
  67       </varlistentry>
  68     </variablelist>
  69   </refsect1>
  70
  71   <refsect1 id="pam_faildelay-types">
  72     <title>MODULE TYPES PROVIDED</title>
  73     <para>
  74       Only the <option>auth</option> module type is provided.
  75     </para>
  76   </refsect1>
  77
  78   <refsect1 id='pam_faildelay-return_values'>
  79     <title>RETURN VALUES</title>
  80     <variablelist>
  81       <varlistentry>
  82         <term>PAM_IGNORE</term>
  83         <listitem>
  84            <para>
  85             Delay was successful adjusted.
  86           </para>
  87         </listitem>
  88       </varlistentry>
  89       <varlistentry>
  90         <term>PAM_SYSTEM_ERR</term>
  91         <listitem>
  92           <para>
  93             The specified delay was not valid.
  94           </para>
  95         </listitem>
  96       </varlistentry>
  97     </variablelist>
  98   </refsect1>
  99
 100   <refsect1 id='pam_faildelay-examples'>
 101     <title>EXAMPLES</title>
 102     <para>
 103       The following example will set the delay on failure to
 104       10 seconds:
 105       <programlisting>
 106 auth  optional  pam_faildelay.so  delay=10000000
 107       </programlisting>
 108     </para>
 109   </refsect1>
 110
 111   <refsect1 id='pam_faildelay-see_also'>
 112     <title>SEE ALSO</title>
 113     <para>
 114       <citerefentry>
 115         <refentrytitle>pam_fail_delay</refentrytitle><manvolnum>3</manvolnum>
 116       </citerefentry>,
 117       <citerefentry>
 118         <refentrytitle>pam.conf</refentrytitle><manvolnum>5</manvolnum>
 119       </citerefentry>,
 120       <citerefentry>
 121         <refentrytitle>pam.d</refentrytitle><manvolnum>5</manvolnum>
 122       </citerefentry>,
 123       <citerefentry>
 124         <refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum>
 125       </citerefentry>
 126     </para>
 127   </refsect1>
 128
 129   <refsect1 id='pam_faildelay-author'>
 130     <title>AUTHOR</title>
 131       <para>
 132         pam_faildelay was written by Darren Tucker &lt;dtucker@zip.com.au&gt;.
 133       </para>
 134   </refsect1>
 135
 136 </refentry>