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