xref: /openbsd-src/usr.sbin/unwindctl/unwindctl.8 (revision 9f11ffb7133c203312a01e4b986886bc88c7d74b)
1.\"	$OpenBSD: unwindctl.8,v 1.4 2019/02/05 20:41:12 jmc Exp $
2.\"
3.\" Copyright (c) 2004, 2005 Esben Norby <norby@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: February 5 2019 $
18.Dt UNWINDCTL 8
19.Os
20.Sh NAME
21.Nm unwindctl
22.Nd control the unwind daemon
23.Sh SYNOPSIS
24.Nm
25.Op Fl s Ar socket
26.Ar command
27.Op Ar argument ...
28.Sh DESCRIPTION
29The
30.Nm
31program controls the
32.Xr unwind 8
33daemon.
34.Pp
35The following options are available:
36.Bl -tag -width Ds
37.It Fl s Ar socket
38Use
39.Ar socket
40instead of the default
41.Pa /var/run/unwind.sock
42to communicate with
43.Xr unwind 8 .
44.El
45.Pp
46The following commands are available:
47.Bl -tag -width Ds
48.It Cm log brief
49Disable verbose logging.
50.It Cm log verbose
51Enable verbose logging.
52.It Cm log debug
53Enable very noisy debug logging.
54.It Cm reload
55Reload the configuration file.
56.It Cm recheck portal
57Run the captive portal detection.
58.It Cm status Op Cm recursor | dhcp | DoT | static
59Show a status summary.
60If one of
61.Cm recursor ,
62.Cm dhcp ,
63.Cm DoT ,
64or
65.Cm static
66is specified, more detailed information about that type of resolver is given
67including reasons why DNSSEC validation might be failing and a query time
68histogram.
69.El
70.Sh FILES
71.Bl -tag -width "/var/run/unwind.sockXX" -compact
72.It Pa /var/run/unwind.sock
73.Ux Ns -domain
74socket used for communication with
75.Xr unwind 8 .
76.El
77.Sh SEE ALSO
78.Xr unwind.conf 5 ,
79.Xr unwind 8
80.Sh HISTORY
81The
82.Nm
83program first appeared in
84.Ox 6.5 .
85