Initial commit for Tizen
[profile/extras/shadow-utils.git] / man / faillog.5.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3    Copyright (c) 1989 - 1994, Julianne Frances Haugh
4    Copyright (c) 2007 - 2008, Nicolas François
5    All rights reserved.
6   
7    Redistribution and use in source and binary forms, with or without
8    modification, are permitted provided that the following conditions
9    are met:
10    1. Redistributions of source code must retain the above copyright
11       notice, this list of conditions and the following disclaimer.
12    2. Redistributions in binary form must reproduce the above copyright
13       notice, this list of conditions and the following disclaimer in the
14       documentation and/or other materials provided with the distribution.
15    3. The name of the copyright holders or contributors may not be used to
16       endorse or promote products derived from this software without
17       specific prior written permission.
18   
19    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
22    PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT
23    HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 -->
31 <refentry id='faillog.5'>
32   <!-- $Id: faillog.5.xml 2967 2009-05-21 14:01:16Z nekral-guest $ -->
33   <refmeta>
34     <refentrytitle>faillog</refentrytitle>
35     <manvolnum>5</manvolnum>
36     <refmiscinfo class="sectdesc"> File Formats and Conversions</refmiscinfo>
37   </refmeta>
38   <refnamediv id='name'>
39     <refname>faillog</refname>
40     <refpurpose>login failure logging file</refpurpose>
41   </refnamediv>
42
43   <refsect1 id='description'>
44     <title>DESCRIPTION</title>
45     <para>
46       <filename>/var/log/faillog</filename> maintains a count of login
47       failures and the limits for each account.
48     </para>
49     <para>
50       The file contains fixed length
51       records, indexed by numerical UID. Each record contains the count of
52       login failures since the last successful login; the maximum number of
53       failures before the account is disabled; the line on whiche the last login
54       failure occurred; the date of the last login failure;
55       and the duration (in seconds) during which the account will be locked after
56       a failure.
57     </para>
58
59     <para>The structure of the file is:</para>
60       <programlisting>
61 struct  faillog {
62         short   fail_cnt;
63         short   fail_max;
64         char    fail_line[12];
65         time_t  fail_time;
66         long    fail_locktime;
67 };</programlisting>
68   </refsect1>
69
70   <refsect1 id='files'>
71     <title>FILES</title>
72     <variablelist>
73       <varlistentry>
74         <term><filename>/var/log/faillog</filename></term>
75         <listitem>
76           <para>Failure logging file.</para>
77         </listitem>
78       </varlistentry>
79     </variablelist>
80   </refsect1>
81
82   <refsect1 id='see_also'>
83     <title>SEE ALSO</title>
84     <para>
85       <citerefentry>
86         <refentrytitle>faillog</refentrytitle><manvolnum>8</manvolnum>
87       </citerefentry>
88     </para>
89   </refsect1>
90 </refentry>
91