xref: /openbsd/sbin/dhcpleased/dhcpleased.8 (revision d415bd75)
1.\"	$OpenBSD: dhcpleased.8,v 1.6 2023/03/02 17:09:52 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: March 2 2023 $
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.
31It requests IP configuration information from for example those offered by
32.Xr dhcpd 8 ,
33on interfaces with the
34.Sy AUTOCONF4
35flag set.
36See
37.Xr hostname.if 5
38and
39.Xr ifconfig 8
40on how to enable auto configuration on an interface.
41.Pp
42.Nm
43monitors network interface states (interface going up or down,
44auto configuration enabled or disabled etc.) and sends requests
45when necessary.
46.Pp
47A running
48.Nm
49can be controlled with the
50.Xr dhcpleasectl 8
51utility.
52.Pp
53The options are as follows:
54.Bl -tag -width Ds
55.It Fl d
56Do not daemonize.
57If this option is specified,
58.Nm
59will run in the foreground and log to
60.Em stderr .
61.It Fl f Ar file
62Specify an alternative configuration file.
63.It Fl n
64Configtest mode.
65Only check the configuration file for validity.
66.It Fl s Ar socket
67Use an alternate location for the default control socket.
68.It Fl v
69Produce more verbose output.
70Multiple
71.Fl v
72options increase the verbosity.
73.El
74.Sh FILES
75.Bl -tag -width "/var/db/dhcpleased/<if>" -compact
76.It Pa /dev/dhcpleased.sock
77.Ux Ns -domain
78socket used for communication with
79.Xr dhcpleasectl 8 .
80.It Pa /etc/dhcpleased.conf
81Default
82.Nm
83configuration file.
84.It Pa /var/db/dhcpleased/ Ns Aq Ar if
85Interface specific lease files.
86.El
87.Sh SEE ALSO
88.Xr dhcpleased.conf 5 ,
89.Xr hostname.if 5 ,
90.Xr dhcpd 8 ,
91.Xr dhcpleasectl 8 ,
92.Xr ifconfig 8
93.Sh STANDARDS
94.Rs
95.%A R. Droms
96.%D March 1997
97.%R RFC 2131
98.%T Dynamic Host Configuration Protocol
99.Re
100.Pp
101.Rs
102.%A S. Alexander
103.%A R. Droms
104.%D March 1997
105.%R RFC 2132
106.%T DHCP Options and BOOTP Vendor Extensions
107.Re
108.Sh HISTORY
109The
110.Nm
111program first appeared in
112.Ox 6.9 .
113.Sh AUTHORS
114.An -nosplit
115The
116.Nm
117program was written by
118.An Florian Obser Aq Mt florian@openbsd.org .
119