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