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