xref: /openbsd-src/usr.sbin/dhcpleasectl/dhcpleasectl.8 (revision 24bb5fcea3ed904bc467217bdaadb5dfc618d5bf)
1.\"	$OpenBSD: dhcpleasectl.8,v 1.1 2021/02/26 16:16:37 florian Exp $
2.\"
3.\" Copyright (c) 2021 Florian Obser <florian@openbsd.org>
4.\" Copyright (c) 2016 Kenneth R Westerback <kwesterback@gmail.com>
5.\" Copyright (c) 2004, 2005 Esben Norby <norby@openbsd.org>
6.\"
7.\" Permission to use, copy, modify, and distribute this software for any
8.\" purpose with or without fee is hereby granted, provided that the above
9.\" copyright notice and this permission notice appear in all copies.
10.\"
11.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18.\"
19.Dd $Mdocdate: February 26 2021 $
20.Dt DHCPLEASECTL 8
21.Os
22.Sh NAME
23.Nm dhcpleasectl
24.Nd control the dhcpleased daemon
25.Sh SYNOPSIS
26.Nm
27.Op Fl s Ar socket
28.Ar command
29.Op Ar argument ...
30.Sh DESCRIPTION
31The
32.Nm
33program controls the
34.Xr dhcpleased 8
35daemon.
36.Pp
37The following options are available:
38.Bl -tag -width Ds
39.It Fl s Ar socket
40Use
41.Ar socket
42instead of the default
43.Pa /dev/dhcpleased.sock
44to communicate with
45.Xr dhcpleased 8 .
46.El
47.Pp
48The following commands are available:
49.Bl -tag -width Ds
50.It Cm log brief
51Disable verbose debug logging.
52.It Cm log verbose
53Enable verbose debug logging.
54.It Cm send request Ar interfacename
55Send a DHCP request on interface
56.Ar interfacename
57to force a renew of the lease.
58.It Cm show interface Op Ar interfacename
59Display status about network interfaces.
60If
61.Ar interfacename
62is specified, only information relative to
63.Ar interfacename
64is shown.
65Otherwise information on all interfaces is shown.
66.El
67.Sh FILES
68.Bl -tag -width "/dev/dhcpleased.sockXX" -compact
69.It Pa /dev/dhcpleased.sock
70.Ux Ns -domain
71socket used for communication with
72.Xr dhcpleased 8 .
73.El
74.Sh SEE ALSO
75.Xr dhcpleased 8
76.Sh HISTORY
77The
78.Nm
79program first appeared in
80.Ox 6.9 .
81