xref: /openbsd-src/sbin/dhcpleased/dhcpleased.8 (revision fb6793a638ba2c194401d3a26cc78c1d73e6f504)
1.\"	$OpenBSD: dhcpleased.8,v 1.7 2024/08/11 06:07:37 jmc Exp $
2.\"
3.\" Copyright (c) 2021 Florian Obser <florian@openbsd.org>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd $Mdocdate: August 11 2024 $
18.Dt DHCPLEASED 8
19.Os
20.Sh NAME
21.Nm dhcpleased
22.Nd Dynamic Host Configuration Protocol (DHCP) client
23.Sh SYNOPSIS
24.Nm
25.Op Fl dnv
26.Op Fl f Ar file
27.Op Fl s Ar socket
28.Sh DESCRIPTION
29.Nm
30is a dynamic host configuration protocol (DHCP) daemon for clients.
31If an interface has the
32.Sy AUTOCONF4
33flag set
34(auto configuration is enabled),
35.Nm
36sends requests for IP configuration information from a DHCP server,
37such as
38.Xr dhcpd 8 ,
39and uses that information to configure the relevant interface.
40.Pp
41See
42.Xr hostname.if 5
43and
44.Xr ifconfig 8
45on how to enable auto configuration on an interface.
46.Pp
47.Nm
48monitors network interface states (interface going up or down,
49auto configuration enabled or disabled, etc.) and sends requests
50when necessary.
51A running
52.Nm
53can be controlled with the
54.Xr dhcpleasectl 8
55utility.
56.Pp
57The options are as follows:
58.Bl -tag -width Ds
59.It Fl d
60Do not daemonize.
61If this option is specified,
62.Nm
63will run in the foreground and log to
64.Em stderr .
65.It Fl f Ar file
66Specify an alternative configuration file.
67.It Fl n
68Configtest mode.
69Only check the configuration file for validity.
70.It Fl s Ar socket
71Use an alternate location for the default control socket.
72.It Fl v
73Produce more verbose output.
74Multiple
75.Fl v
76options increase the verbosity.
77.El
78.Sh FILES
79.Bl -tag -width "/var/db/dhcpleased/<if>" -compact
80.It Pa /dev/dhcpleased.sock
81.Ux Ns -domain
82socket used for communication with
83.Xr dhcpleasectl 8 .
84.It Pa /etc/dhcpleased.conf
85Default
86.Nm
87configuration file.
88.It Pa /var/db/dhcpleased/ Ns Aq Ar if
89Interface specific lease files.
90.El
91.Sh SEE ALSO
92.Xr dhcpleased.conf 5 ,
93.Xr hostname.if 5 ,
94.Xr dhcpd 8 ,
95.Xr dhcpleasectl 8 ,
96.Xr ifconfig 8
97.Sh STANDARDS
98.Rs
99.%A R. Droms
100.%D March 1997
101.%R RFC 2131
102.%T Dynamic Host Configuration Protocol
103.Re
104.Pp
105.Rs
106.%A S. Alexander
107.%A R. Droms
108.%D March 1997
109.%R RFC 2132
110.%T DHCP Options and BOOTP Vendor Extensions
111.Re
112.Sh HISTORY
113The
114.Nm
115program first appeared in
116.Ox 6.9 .
117.Sh AUTHORS
118.An -nosplit
119The
120.Nm
121program was written by
122.An Florian Obser Aq Mt florian@openbsd.org .
123