| 1 |
.\" Jean II - HPLB - 96 |
| 2 |
.\" iwpriv.8 |
| 3 |
.\" |
| 4 |
.TH IWPRIV 8 "31 October 1996" "wireless-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 |
.\" |
| 23 |
.\" DESCRIPTION part |
| 24 |
.\" |
| 25 |
.SH DESCRIPTION |
| 26 |
.B Iwpriv |
| 27 |
is the companion tool to |
| 28 |
.IR iwconfig (8). |
| 29 |
.B Iwpriv |
| 30 |
deals with parameters and setting specific to each driver (as opposed to |
| 31 |
.I iwconfig |
| 32 |
which deals with generic ones). |
| 33 |
.PP |
| 34 |
Without any argument, |
| 35 |
.B iwpriv |
| 36 |
list the available private commands available on each interface, and |
| 37 |
the parameters that they require. Using this information, the user may |
| 38 |
apply those interface specific commands on the specified interface. |
| 39 |
.PP |
| 40 |
In theory, the documentation of each device driver should indicate how |
| 41 |
to use those interface specific commands and their effect. |
| 42 |
.\" |
| 43 |
.\" PARAMETER part |
| 44 |
.\" |
| 45 |
.SH PARAMETERS |
| 46 |
.TP |
| 47 |
.IR private-command " [" private-parameters ] |
| 48 |
Execute the specified |
| 49 |
.I private-command |
| 50 |
on the interface. |
| 51 |
.br |
| 52 |
The command may optionally take or require arguments, and may display |
| 53 |
information. Therefore, the command line parameters may or may not be |
| 54 |
needed and should match the command expectations. The list of commands |
| 55 |
that |
| 56 |
.B iwpriv |
| 57 |
displays (when called without argument) should give you some hints |
| 58 |
about those parameters. |
| 59 |
.br |
| 60 |
However you should refer to the device driver documentation for |
| 61 |
information on how to properly use the command and the effect. |
| 62 |
.TP |
| 63 |
.IR "private-command " [ I "] [" private-parameters ] |
| 64 |
Idem, except that |
| 65 |
.I I |
| 66 |
(an integer) is passed to the command as a |
| 67 |
.IR "Token Index" . |
| 68 |
Only some command will use the Token Index (most will ignore it), and |
| 69 |
the driver documentation should tell you when it's needed. |
| 70 |
.TP |
| 71 |
.BR -a / --all |
| 72 |
Execute and display all the private commands that don't take any |
| 73 |
arguments (i.e. read only). |
| 74 |
.\" |
| 75 |
.\" DISPLAY part |
| 76 |
.\" |
| 77 |
.SH DISPLAY |
| 78 |
For each device which support private commands, |
| 79 |
.I iwpriv |
| 80 |
will display the list of private commands available. |
| 81 |
.PP |
| 82 |
This include the name of the private command, the number or arguments |
| 83 |
that may be set and their type, and the number or arguments that may |
| 84 |
be display and their type. |
| 85 |
.PP |
| 86 |
For example, you may have the following display : |
| 87 |
.br |
| 88 |
.B "eth0 Available private ioctl :" |
| 89 |
.br |
| 90 |
.B " setqualthr (89F0) : set 1 byte & get 0" |
| 91 |
.br |
| 92 |
.B " gethisto (89F7) : set 0 & get 16 int" |
| 93 |
.PP |
| 94 |
This indicate that you may set the quality threshold and display an |
| 95 |
histogram of up to 16 values with the following commands : |
| 96 |
.br |
| 97 |
.I " iwpriv eth0 setqualthr 20" |
| 98 |
.br |
| 99 |
.I " iwpriv eth0 gethisto" |
| 100 |
.\" |
| 101 |
.\" AUTHOR part |
| 102 |
.\" |
| 103 |
.SH AUTHOR |
| 104 |
Jean Tourrilhes \- [email protected] |
| 105 |
.\" |
| 106 |
.\" FILES part |
| 107 |
.\" |
| 108 |
.SH FILES |
| 109 |
.I /proc/net/wireless |
| 110 |
.\" |
| 111 |
.\" SEE ALSO part |
| 112 |
.\" |
| 113 |
.SH SEE ALSO |
| 114 |
.BR iwconfig (8), |
| 115 |
.BR iwlist (8), |
| 116 |
.BR iwevent (8), |
| 117 |
.BR iwspy (8), |
| 118 |
.BR wireless (7), |
| 119 |
.BR ifrename (8), |
| 120 |
.BR iftab (5), |
| 121 |
.BR iwgetid (8) |
| 122 |
.BR iwevent (8). |