xref: /freebsd/sbin/dhclient/dhclient.leases.5 (revision f126890a)
1.\"	$OpenBSD: dhclient.leases.5,v 1.4 2004/04/15 08:59:47 jmc Exp $
2.\"
3.\" Copyright (c) 1997 The Internet Software Consortium.
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\"
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. Neither the name of The Internet Software Consortium nor the names
16.\"    of its contributors may be used to endorse or promote products derived
17.\"    from this software without specific prior written permission.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY THE INTERNET SOFTWARE CONSORTIUM AND
20.\" CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
21.\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
22.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23.\" DISCLAIMED.  IN NO EVENT SHALL THE INTERNET SOFTWARE CONSORTIUM OR
24.\" CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
27.\" USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
28.\" ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
30.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31.\" SUCH DAMAGE.
32.\"
33.\" This software has been written for the Internet Software Consortium
34.\" by Ted Lemon <mellon@fugue.com> in cooperation with Vixie
35.\" Enterprises.  To learn more about the Internet Software Consortium,
36.\" see ``http://www.isc.org/isc''.  To learn more about Vixie
37.\" Enterprises, see ``http://www.vix.com''.
38.\"
39.Dd January 1, 1997
40.Dt DHCLIENT.LEASES 5
41.Os
42.Sh NAME
43.Nm dhclient.leases
44.Nd DHCP client lease database
45.Sh DESCRIPTION
46The Internet Software Consortium DHCP client keeps a persistent
47database of leases that it has acquired that are still valid.
48The database is a free-form ASCII file containing one valid declaration
49per lease.
50If more than one declaration appears for a given lease,
51the last one in the file is used.
52The file is written as a log, so this is not an unusual occurrence.
53.Pp
54The lease file is named
55.Pa dhclient.leases . Ns Ar IFNAME ,
56where
57.Ar IFNAME
58represents the network interface the DHCP client acquired the lease on.
59For example, if
60.Xr dhclient 8
61is configured for the
62.Li em0
63network device,
64the lease file will be named
65.Pa dhclient.leases.em0 .
66.Pp
67The format of the lease declarations is described in
68.Xr dhclient.conf 5 .
69.Sh FILES
70.Bl -tag -width ".Pa /var/db/dhclient.leases. Ns Ar IFNAME"
71.It Pa /var/db/dhclient.leases . Ns Ar IFNAME
72Current lease file.
73.El
74.Sh SEE ALSO
75.Xr dhclient.conf 5 ,
76.Xr dhcp-options 5 ,
77.Xr dhcpd.conf 5 ,
78.Xr dhclient 8 ,
79.Xr dhcpd 8
80.Rs
81.%R "RFC 2132, RFC 2131"
82.Re
83.Sh AUTHORS
84.An -nosplit
85The
86.Xr dhclient 8
87utility
88was written by
89.An Ted Lemon Aq Mt mellon@vix.com
90under a contract with Vixie Labs.
91.Pp
92The current implementation was reworked by
93.An Henning Brauer Aq Mt henning@openbsd.org .
94