wireless_tools/iwpriv.8

   1 .\" Jean II - HPLB - 96
   2 .\" iwpriv.8
   3 .\"
   4 .TH IWPRIV 8 "31 October 1996" "net-tools" "Linux Programmer's Manual"
   5 .\"
   6 .\" NAME part
   7 .\"
   8 .SH NAME
   9 iwpriv \- configure optionals (private) parameters of a wireless
  10 network interface
  11 .\"
  12 .\" SYNOPSIS part
  13 .\"
  14 .SH SYNOPSIS
  15 .BI "iwpriv [" interface ]
  16 .br
  17 .BI "iwpriv " "interface private-command " "[" private-parameters ]
  18 .br
  19 .BI "iwpriv " "interface private-command [I] " "[" private-parameters ]
  20 .br
  21 .BI "iwpriv " interface " --all"
  22 .br
  23 .BI "iwpriv " interface " roam " {on,off}
  24 .br
  25 .BI "iwpriv " interface " port " {ad-hoc,managed,N}
  26 .\"
  27 .\" DESCRIPTION part
  28 .\"
  29 .SH DESCRIPTION
  30 .B Iwpriv
  31 is the companion tool to
  32 .IR iwconfig (8).
  33 .B Iwpriv
  34 deals with parameters and setting specific to each driver (as opposed to
  35 .I iwconfig
  36 which deals with generic ones).
  37 .PP
  38 Without any argument,
  39 .B iwpriv
  40 list the available private commands available on each interface, and
  41 the parameters that they require. Using this information, the user may
  42 apply those interface specific commands on the specified interface.
  43 .PP
  44 In theory, the documentation of each device driver should indicate how
  45 to use those interface specific commands and their effect.
  46 .\"
  47 .\" PARAMETER part
  48 .\"
  49 .SH PARAMETERS
  50 .TP
  51 .IR private-command " [" private-parameters ]
  52 Execute the specified
  53 .I private-command
  54 on the interface.
  55 .br
  56 The command may optionally take or require arguments, and may display
  57 information. Therefore, the command line parameters may or may not be
  58 needed and should match the command expectations. The list of commands
  59 that
  60 .B iwpriv
  61 displays (when called without argument) should give you some hints
  62 about those parameters.
  63 .br
  64 However you should refer to the device driver documentation for
  65 information on how to properly use the command and the effect.
  66 .TP
  67 .I "private-command [I]" "[" private-parameters ]
  68 Idem, except that
  69 .I I
  70 (an integer) is passed to the command as a
  71 .IR "Token Index" .
  72 Only some command will use the Token Index (most will ignore it), and
  73 the driver documentation should tell you when it's needed.
  74 .TP
  75 .BR -a / --all
  76 Execute and display all the private commands that don't take any
  77 arguments (i.e.  read only).
  78 .TP
  79 .B roam
  80 Enable or disable roaming, if supported. Call the private command
  81 .IR setroam .
  82 Found in the
  83 .I wavelan_cs
  84 driver.
  85 .TP
  86 .B port
  87 Read or configure the port type. Call the private commands
  88 .IR gport_type ", " sport_type ", " get_port " or " set_port
  89 found in the
  90 .IR wavelan2_cs " and " wvlan_cs " drivers."
  91 .\"
  92 .\" DISPLAY part
  93 .\"
  94 .SH DISPLAY
  95 For each device which support private commands,
  96 .I iwpriv
  97 will display the list of private commands available.
  98 .PP
  99 This include the name of the private command, the number or arguments
 100 that may be set and their type, and the number or arguments that may
 101 be display and their type.
 102 .PP
 103 For example, you may have the following display :
 104 .br
 105 .B "eth0      Available private ioctl :"
 106 .br
 107 .B "          setqualthr (89F0) : set   1 byte & get   0"
 108 .br
 109 .B "          gethisto (89F7) : set   0      & get  16 int"
 110 .PP
 111 This indicate that you may set the quality threshold and display an
 112 histogram of up to 16 values with the following commands :
 113 .br
 114 .I "  iwpriv eth0 setqualthr 20"
 115 .br
 116 .I "  iwpriv eth0 gethisto"
 117 .\"
 118 .\" AUTHOR part
 119 .\"
 120 .SH AUTHOR
 121 Jean Tourrilhes \- jt@hpl.hp.com
 122 .\"
 123 .\" FILES part
 124 .\"
 125 .SH FILES
 126 .I /proc/net/wireless
 127 .\"
 128 .\" SEE ALSO part
 129 .\"
 130 .SH SEE ALSO
 131 .BR iwconfig (8),
 132 .BR iwlist (8),
 133 .BR iwevent (8),
 134 .BR iwspy (8),
 135 .BR wireless (7).