granicus.if.org Git - shadow/blob - man/faillog.8.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
   3                 "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
   4 <refentry id='faillog.8'>
   5   <!--  $Id: faillog.8.xml,v 1.16 2005/10/01 15:01:45 kloczek Exp $ -->
   6   <refmeta>
   7     <refentrytitle>faillog</refentrytitle>
   8     <manvolnum>8</manvolnum>
   9   </refmeta>
  10   <refnamediv id='name'>
  11     <refname>faillog</refname>
  12     <refpurpose>display faillog records or set login failure limits</refpurpose>
  13   </refnamediv>
  14
  15   <refsynopsisdiv id='synopsis'>
  16     <cmdsynopsis>
  17       <command>faillog</command>
  18       <arg choice='opt'>
  19         <replaceable>options</replaceable>
  20       </arg>
  21     </cmdsynopsis>
  22   </refsynopsisdiv>
  23
  24   <refsect1 id='description'>
  25     <title>DESCRIPTION</title>
  26     <para>
  27       <command>faillog</command> formats the contents of the failure log
  28       from <filename>/var/log/faillog</filename> database. It also can be
  29       used for maintains failure counters and limits. Run
  30       <command>faillog</command> without arguments display only list of user
  31       faillog records who have ever had a login failure.
  32     </para>
  33   </refsect1>
  34
  35   <refsect1 id='options'>
  36     <title>OPTIONS</title>
  37     <para>
  38       The options which apply to the <command>faillog</command> command
  39       are:
  40     </para>
  41     <variablelist remap='IP'>
  42       <varlistentry>
  43         <term><option>-a</option>, <option>--all</option></term>
  44         <listitem>
  45           <para>Display faillog records for all users.</para>
  46         </listitem>
  47       </varlistentry>
  48       <varlistentry>
  49         <term><option>-h</option>, <option>--help</option></term>
  50         <listitem>
  51           <para>Display help message and exit.</para>
  52         </listitem>
  53       </varlistentry>
  54       <varlistentry>
  55         <term>
  56           <option>-l</option>, <option>--lock-time</option>
  57           <replaceable>SEC</replaceable>
  58         </term>
  59         <listitem>
  60           <para>
  61             Lock account to <replaceable>SEC</replaceable>
  62             seconds after failed login.
  63           </para>
  64         </listitem>
  65       </varlistentry>
  66       <varlistentry>
  67         <term>
  68           <option>-m</option>, <option>--maximum</option>
  69           <replaceable>MAX</replaceable>
  70         </term>
  71         <listitem>
  72           <para>
  73             Set maximum number of login failures after the account is
  74             disabled to <replaceable>MAX</replaceable>. Selecting
  75             <replaceable>MAX</replaceable> value of 0 has the effect of not
  76             placing a limit on the number of failed logins. The maximum
  77             failure count should always be 0 for <emphasis>root</emphasis>
  78             to prevent a denial of services attack against the system.
  79           </para>
  80         </listitem>
  81       </varlistentry>
  82       <varlistentry>
  83         <term><option>-r</option>, <option>--reset</option></term>
  84         <listitem>
  85           <para>
  86             Reset the counters of login failures or one record if used with
  87             the -u <replaceable>LOGIN</replaceable> option. Write access to
  88             <filename>/var/log/faillog</filename> is required for this
  89             option.
  90           </para>
  91         </listitem>
  92       </varlistentry>
  93       <varlistentry>
  94         <term><option>-t</option>, <option>--time</option>
  95         <replaceable>DAYS</replaceable>
  96         </term>
  97         <listitem>
  98           <para>
  99             Display faillog records more recent than
 100             <replaceable>DAYS</replaceable>. The <option>-t</option>
 101             flag overrides the use of <option>-u</option>.
 102           </para>
 103         </listitem>
 104       </varlistentry>
 105       <varlistentry>
 106         <term>
 107           <option>-u</option>, <option>--user</option> <replaceable>LOGIN</replaceable>
 108         </term>
 109         <listitem>
 110           <para>
 111             Display faillog record or maintains failure counters and limits
 112             (if used with <option>-l</option>, <option>-m</option> or
 113             <option>-r</option> options) only for user with
 114             <replaceable>LOGIN</replaceable>.
 115           </para>
 116         </listitem>
 117       </varlistentry>
 118     </variablelist>
 119   </refsect1>
 120
 121   <refsect1 id='caveats'>
 122     <title>CAVEATS</title>
 123     <para>
 124       <command>faillog</command> only prints out users with no successful
 125       login since the last failure. To print out a user who has had a
 126       successful login since their last failure, you must explicitly request
 127       the user with the <option>-u</option> flag, or print out all users
 128       with the <option>-a</option> flag.
 129     </para>
 130   </refsect1>
 131
 132   <refsect1 id='files'>
 133     <title>FILES</title>
 134     <variablelist>
 135       <varlistentry>
 136         <term><filename>/var/log/faillog</filename></term>
 137         <listitem>
 138           <para>failure logging file</para>
 139         </listitem>
 140       </varlistentry>
 141     </variablelist>
 142   </refsect1>
 143
 144   <refsect1 id='see_also'>
 145     <title>SEE ALSO</title>
 146     <para>
 147       <citerefentry>
 148         <refentrytitle>login</refentrytitle><manvolnum>1</manvolnum>
 149       </citerefentry>,
 150       <citerefentry>
 151         <refentrytitle>faillog</refentrytitle><manvolnum>5</manvolnum>
 152       </citerefentry>.
 153     </para>
 154   </refsect1>
 155
 156   <refsect1 id='author'>
 157     <title>AUTHOR</title>
 158     <para>Julianne Frances Haugh (jockgrrl@ix.netcom.com)</para>
 159   </refsect1>
 160 </refentry>