usr.sbin/802_11/hostapd_cli/hostapd_cli.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: head/usr.sbin/wpa/hostapd_cli/hostapd_cli.8 195644 2009-07-12 19:58:52Z sam $
  26 .\"
  27 .Dd August 19, 2006
  28 .Dt HOSTAPD_CLI 8
  29 .Os
  30 .Sh NAME
  31 .Nm hostapd_cli
  32 .Nd text-based frontend program for interacting with
  33 .Xr hostapd 8
  34 .Sh SYNOPSIS
  35 .Nm
  36 .Op Ar commands
  37 .Sh DESCRIPTION
  38 The
  39 .Nm
  40 utility
  41 is a text-based frontend program for interacting with
  42 .Xr hostapd 8 .
  43 It is used to query the current status.
  44 .Pp
  45 The
  46 .Nm
  47 utility
  48 can show the
  49 current authentication status,
  50 dot11 and dot1x MIBs, etc.
  51 .Pp
  52 The
  53 .Nm
  54 utility
  55 supports two modes: interactive and command line.
  56 Both modes share the same command set.
  57 .Pp
  58 Interactive mode is started when
  59 .Nm
  60 is executed without any parameters on the command line.
  61 Commands are then entered from the controlling terminal in
  62 response to the
  63 .Nm
  64 prompt.
  65 In command line mode, the same commands are
  66 entered as command line arguments.
  67 .Sh COMMANDS
  68 The following commands may be supplied on the command line
  69 or at a prompt when operating interactively.
  70 .Bl -tag -width indent
  71 .It Ic mib
  72 Report MIB variables (dot1x, dot11) for the current interface.
  73 .It Ic sta Ar addr
  74 Report the MIB variables for the associated station with MAC address
  75 .Ar addr .
  76 .It Ic all_sta
  77 Report the MIB variables for all associated stations.
  78 .It Ic help
  79 Show usage help.
  80 .It Ic interface Op Ar ifname
  81 Show available interfaces and/or set the current interface
  82 when multiple are available.
  83 .It Ic level Ar debug_level
  84 Change the debugging level in
  85 .Xr hostapd 8 .
  86 Larger numbers generate more messages.
  87 .It Ic license
  88 Display the full
  89 license for
  90 .Nm .
  91 .It Ic quit
  92 Exit
  93 .Nm .
  94 .El
  95 .Sh SEE ALSO
  96 .Xr hostapd.conf 5 ,
  97 .Xr hostapd 8
  98 .Sh HISTORY
  99 The
 100 .Nm
 101 utility first appeared in
 102 .Fx 6.0 .
 103 .Sh AUTHORS
 104 The
 105 .Nm
 106 utility was written by
 107 .An Jouni Malinen Aq Mt jkmaline@cc.hut.fi .
 108 This manual page is derived from the
 109 .Pa README
 110 file included in the
 111 .Nm hostapd
 112 distribution.