xref: /netbsd-src/external/bsd/wpa/bin/hostapd/hostapd.8 (revision 6cb10275d08f045e872662c371fe2f2724f2f6e6)
1.\"	$NetBSD: hostapd.8,v 1.5 2014/03/18 18:20:36 riastradh Exp $
2.\"
3.\" Copyright (c) 2005 Sam Leffler <sam@errno.com>
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25.\" SUCH DAMAGE.
26.\"
27.\" $FreeBSD: src/usr.sbin/wpa/hostapd/hostapd.8,v 1.2 2005/06/27 06:40:43 ru Exp $
28.\"
29.Dd March 21, 2013
30.Dt HOSTAPD 8
31.Os
32.Sh NAME
33.Nm hostapd
34.Nd "authenticator for IEEE 802.11 networks"
35.Sh SYNOPSIS
36.Nm
37.Op Fl BdhKtv
38.Ar config-file ...
39.Sh DESCRIPTION
40The
41.Nm
42utility
43is an authenticator for IEEE 802.11 networks.
44It provides full support for WPA/IEEE 802.11i and
45can also act as an IEEE 802.1X Authenticator with a suitable
46backend Authentication Server (typically
47.Tn FreeRADIUS ) .
48The
49.Nm
50utility
51implements the authentication protocols that piggyback on top
52of the normal IEEE 802.11 protocol mechanisms.
53To use
54.Nm
55as an authenticator, the underlying device must support some
56basic functionality such as the ability to set security information
57in the 802.11 management frames.
58Beware that not all devices have this support.
59.Pp
60The
61.Nm
62utility
63is designed to be a
64.Dq daemon
65program that runs in the
66background and acts as the backend component controlling
67the wireless connection.
68It supports separate frontend programs such as the
69text-based frontend,
70.Xr hostapd_cli 8 .
71.Pp
72The following arguments must be specified on the command line:
73.Bl -tag -width indent
74.It Ar config-file
75Use the settings in the specified configuration file; the name of
76the specified wireless interface is contained in this file.
77See
78.Xr hostapd.conf 5
79for a description of the configuration file syntax.
80.Pp
81Changes to the configuration file can be reloaded by sending a
82.Dv SIGHUP
83to the
84.Nm
85processor or with the
86.Xr hostapd_cli 8
87utility, using
88.Dq Li "hostapd_cli reconfigure" .
89.El
90.Sh OPTIONS
91The options are as follows:
92.Bl -tag -width indent
93.It Fl d
94Enable debugging messages.
95If this option is supplied twice, more verbose messages are displayed.
96.It Fl h
97Show help text.
98.It Fl t
99Include timestamps in debugging output.
100.It Fl v
101Display version information on the terminal and exit.
102.It Fl B
103Detach from the controlling terminal and run as a daemon process
104in the background.
105.It Fl K
106Include key information in debugging output.
107.El
108.Sh SEE ALSO
109.Xr ath 4 ,
110.Xr athn 4 ,
111.Xr atw 4 ,
112.Xr awi 4 ,
113.Xr bwi 4 ,
114.Xr ipw 4 ,
115.Xr iwi 4 ,
116.Xr ral 4 ,
117.Xr rtw 4 ,
118.Xr rum 4 ,
119.Xr run 4 ,
120.Xr wi 4 ,
121.Xr hostapd.conf 5 ,
122.Xr hostapd_cli 8 ,
123.Xr ifconfig 8
124.Sh HISTORY
125The
126.Nm
127utility first appeared in
128.Nx 4.0 .
129.Sh AUTHORS
130The
131.Nm
132utility was written by
133.An Jouni Malinen Aq Mt jkmaline@cc.hut.fi .
134This manual page is derived from the
135.Pa README
136file included in the
137.Nm
138distribution.
139