iwi(4): Hook it into the build again and enable it everywhere else.
[dragonfly.git] / usr.sbin / 802_11 / hostapd / hostapd.8
CommitLineData
56b17b94
SZ
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.\"
afbf8796 25.\" $FreeBSD: head/usr.sbin/wpa/hostapd/hostapd.8 195644 2009-07-12 19:58:52Z sam $
56b17b94 26.\"
afbf8796 27.Dd October 26, 2007
56b17b94
SZ
28.Dt HOSTAPD 8
29.Os
30.Sh NAME
31.Nm hostapd
32.Nd "authenticator for IEEE 802.11 networks"
33.Sh SYNOPSIS
34.Nm
35.Op Fl BdhKtv
284e4769 36.Op Fl P Ar pidfile
56b17b94
SZ
37.Ar config-file ...
38.Sh DESCRIPTION
39The
40.Nm
41utility
42is an authenticator for IEEE 802.11 networks.
43It provides full support for WPA/IEEE 802.11i and
44can also act as an IEEE 802.1X Authenticator with a suitable
45backend Authentication Server (typically
46.Tn FreeRADIUS ) .
47The
48.Nm
49utility
50implements the authentication protocols that piggyback on top
51of the normal IEEE 802.11 protocol mechanisms.
52To use
53.Nm
54as an authenticator, the underlying device must support some
55basic functionality such as the ability to set security information
56in the 802.11 management frames.
57Beware that not all devices have this support.
58.Pp
59The
60.Nm
61utility
62is designed to be a
63.Dq daemon
64program that runs in the
65background and acts as the backend component controlling
66the wireless connection.
67It supports separate frontend programs such as the
68text-based frontend,
69.Xr hostapd_cli 8 .
70.Pp
71The following arguments must be specified on the command line:
72.Bl -tag -width indent
73.It Ar config-file
74Use the settings in the specified configuration file; the name of
75the specified wireless interface is contained in this file.
76See
77.Xr hostapd.conf 5
78for a description of the configuration file syntax.
79.Pp
80Changes to the configuration file can be reloaded by sending a
81.Dv SIGHUP
82to the
83.Nm
84processor or with the
85.Xr hostapd_cli 8
86utility, using
87.Dq Li "hostapd_cli reconfigure" .
88.El
89.Sh OPTIONS
90The options are as follows:
91.Bl -tag -width indent
92.It Fl d
93Enable debugging messages.
94If this option is supplied twice, more verbose messages are displayed.
95.It Fl h
96Show help text.
97.It Fl t
98Include timestamps in debugging output.
99.It Fl v
100Display version information on the terminal and exit.
101.It Fl B
102Detach from the controlling terminal and run as a daemon process
103in the background.
104.It Fl K
105Include key information in debugging output.
284e4769
SW
106.It Fl P Ar pidfile
107Store PID in
108.Ar pidfile .
56b17b94
SZ
109.El
110.Sh SEE ALSO
111.Xr ath 4 ,
4097c65c 112.\".Xr ipw 4 ,
1d97534a 113.Xr iwi 4 ,
56b17b94 114.Xr ral 4 ,
4097c65c 115.\".Xr ural 4 ,
56b17b94
SZ
116.Xr wi 4 ,
117.Xr hostapd.conf 5 ,
118.Xr hostapd_cli 8 ,
119.Xr ifconfig 8
120.Sh HISTORY
121The
122.Nm
123utility first appeared in
124.Fx 6.0 .
125.Sh AUTHORS
126The
127.Nm
128utility was written by
afbf8796 129.An Jouni Malinen Aq j@w1.fi .
56b17b94
SZ
130This manual page is derived from the
131.Pa README
132file included in the
133.Nm
134distribution.