usr.sbin/wpa/hostapd/hostapd.8

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