xref: /freebsd/usr.sbin/wpa/hostapd_cli/hostapd_cli.8 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
1.\" Copyright (c) 2005 Sam Leffler <sam@errno.com>
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.Dd June 16, 2005
26.Dt HOSTAPD_CLI 8
27.Os
28.Sh NAME
29.Nm hostapd_cli
30.Nd text-based frontend program for interacting with
31.Xr hostapd 8
32.Sh SYNOPSIS
33.Nm
34.Op Ar commands
35.Sh DESCRIPTION
36The
37.Nm
38utility
39is a text-based frontend program for interacting with
40.Xr hostapd 8 .
41It is used to query the current status.
42.Pp
43The
44.Nm
45utility
46can show the
47current authentication status,
48dot11 and dot1x MIBs, etc.
49.Pp
50The
51.Nm
52utility
53supports two modes: interactive and command line.
54Both modes share the same command set.
55.Pp
56Interactive mode is started when
57.Nm
58is executed without any parameters on the command line.
59Commands are then entered from the controlling terminal in
60response to the
61.Nm
62prompt.
63In command line mode, the same commands are
64entered as command line arguments.
65.Sh COMMANDS
66The following commands may be supplied on the command line
67or at a prompt when operating interactively.
68.Bl -tag -width indent
69.It Ic mib
70Report MIB variables (dot1x, dot11) for the current interface.
71.It Ic sta Ar addr
72Report the MIB variables for the associated station with MAC address
73.Ar addr .
74.It Ic all_sta
75Report the MIB variables for all associated stations.
76.It Ic help
77Show usage help.
78.It Ic interface Op Ar ifname
79Show available interfaces and/or set the current interface
80when multiple are available.
81.It Ic level Ar debug_level
82Change the debugging level in
83.Xr hostapd 8 .
84Larger numbers generate more messages.
85.It Ic license
86Display the full
87license for
88.Nm .
89.It Ic quit
90Exit
91.Nm .
92.El
93.Sh SEE ALSO
94.Xr hostapd.conf 5 ,
95.Xr hostapd 8
96.Sh HISTORY
97The
98.Nm
99utility first appeared in
100.Fx 6.0 .
101.Sh AUTHORS
102The
103.Nm
104utility was written by
105.An Jouni Malinen Aq Mt j@w1.fi .
106This manual page is derived from the
107.Pa README
108file included in the
109.Nm hostapd
110distribution.
111