usr.sbin/wpa/hostapd_cli/hostapd_cli.8

   1 .\" $NetBSD$
   2 .\"
   3 .\" Copyright (c) 2005 Sam Leffler <sam@errno.com>
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\" $FreeBSD: src/usr.sbin/wpa/hostapd_cli/hostapd_cli.8,v 1.2 2005/06/27 06:40:43 ru Exp $
  28 .\"
  29 .Dd June 16, 2005
  30 .Dt HOSTAPD_CLI 8
  31 .Os
  32 .Sh NAME
  33 .Nm hostapd_cli
  34 .Nd text-based frontend program for interacting with
  35 .Xr hostapd 8
  36 .Sh SYNOPSIS
  37 .Nm
  38 .Op Ar commands
  39 .Sh DESCRIPTION
  40 The
  41 .Nm
  42 utility
  43 is a text-based frontend program for interacting with
  44 .Xr hostapd 8 .
  45 It is used to query the current status.
  46 .Pp
  47 The
  48 .Nm
  49 utility
  50 can show the
  51 current authentication status,
  52 dot11 and dot1x MIBs, etc.
  53 .Pp
  54 The
  55 .Nm
  56 utility
  57 supports two modes: interactive and command line.
  58 Both modes share the same command set.
  59 .Pp
  60 Interactive mode is started when
  61 .Nm
  62 is executed without any parameters on the command line.
  63 Commands are then entered from the controlling terminal in
  64 response to the
  65 .Nm
  66 prompt.
  67 In command line mode, the same commands are
  68 entered as command line arguments.
  69 .Sh COMMANDS
  70 The following commands may be supplied on the command line
  71 or at a prompt when operating interactively.
  72 .Bl -tag -width indent
  73 .It Ic mib
  74 Report MIB variables (dot1x, dot11) for the current interface.
  75 .It Ic sta Ar addr
  76 Report the MIB variables for the associated station with MAC address
  77 .Ar addr .
  78 .It Ic all_sta
  79 Report the MIB variables for all associated stations.
  80 .It Ic help
  81 Show usage help.
  82 .It Ic interface Op Ar ifname
  83 Show available interfaces and/or set the current interface
  84 when multiple are available.
  85 .It Ic level Ar debug_level
  86 Change the debugging level in
  87 .Xr hostapd 8 .
  88 Larger numbers generate more messages.
  89 .It Ic license
  90 Display the full
  91 license for
  92 .Nm .
  93 .It Ic quit
  94 Exit
  95 .Nm .
  96 .El
  97 .Sh SEE ALSO
  98 .Xr hostapd.conf 5 ,
  99 .Xr hostapd 8
 100 .Sh HISTORY
 101 The
 102 .Nm
 103 utility first appeared in
 104 .Nx 4.0 .
 105 .Sh AUTHORS
 106 The
 107 .Nm
 108 utility was written by
 109 .An Jouni Malinen Aq jkmaline@cc.hut.fi .
 110 This manual page is derived from the
 111 .Pa README
 112 file included in the
 113 .Nm hostapd
 114 distribution.