Update to v30-pre9

[android-x86/external-wireless-tools.git] / wireless_tools / iwpriv.8

diff --git a/wireless_tools/iwpriv.8 b/wireless_tools/iwpriv.8
index 2f51651..11244a7 100644 (file)
--- a/wireless_tools/iwpriv.8
+++ b/wireless_tools/iwpriv.8
@@ -14,11 +14,11 @@ network interface
 .SH SYNOPSIS
 .BI "iwpriv [" interface ]
 .br
-.BI "iwpriv " interface " " private-command " [" private-parameters ]
+.BI "iwpriv " "interface private-command " "[" private-parameters ]
 .br
-.BI "iwpriv " interface " roam " {on,off}
+.BI "iwpriv " "interface private-command " [ I "] [" private-parameters ]
 .br
-.BI "iwpriv " interface " port " {ad-hoc,managed,N}
+.BI "iwpriv " interface " --all"
 .\"
 .\" DESCRIPTION part
 .\"
@@ -29,9 +29,7 @@ is the companion tool to
 .B Iwpriv
 deals with parameters and setting specific to each driver (as opposed to
 .I iwconfig
-which deals with generic ones) and a few commands that doesn't fit well in
-.I iwconfig
-(like listing the available frequencies).
+which deals with generic ones).
 .PP
 Without any argument,
 .B iwpriv
@@ -46,25 +44,33 @@ to use those interface specific commands and their effect.
 .\"
 .SH PARAMETERS
 .TP
-.B roam
-Enable or disable roaming, if supported. Call the private command
-.IR setroam .
-Found in the
-.I wavelan_cs
-driver.
-.TP
-.B port
-Read or configure the port type. Call the private commands
-.IR gport_type ", " sport_type ", " get_port " or " set_port
-found in the
-.IR wavelan2_cs " and " wvlan_cs " drivers."
-.TP
-.I private-command
+.IR private-command " [" private-parameters ]
 Execute the specified
 .I private-command
-on the interface. The command may take or require arguments, and may
-display information. Refer to the device driver documentation for
-information on how to use and the effect.
+on the interface.
+.br
+The command may optionally take or require arguments, and may display
+information. Therefore, the command line parameters may or may not be
+needed and should match the command expectations. The list of commands
+that
+.B iwpriv
+displays (when called without argument) should give you some hints
+about those parameters.
+.br
+However you should refer to the device driver documentation for
+information on how to properly use the command and the effect.
+.TP
+.IR "private-command " [ I "] [" private-parameters ]
+Idem, except that
+.I I
+(an integer) is passed to the command as a
+.IR "Token Index" .
+Only some command will use the Token Index (most will ignore it), and
+the driver documentation should tell you when it's needed.
+.TP
+.BR -a / --all
+Execute and display all the private commands that don't take any
+arguments (i.e.  read only).
 .\"
 .\" DISPLAY part
 .\"
@@ -105,11 +111,8 @@ Jean Tourrilhes \- jt@hpl.hp.com
 .\" SEE ALSO part
 .\"
 .SH SEE ALSO
-.BR ifconfig (8),
 .BR iwconfig (8),
 .BR iwlist (8),
+.BR iwevent (8),
 .BR iwspy (8),
-.BR wavelan (4),
-.BR wavelan_cs (4),
-.BR wvlan_cs (4),
-.BR netwave_cs (4).
+.BR wireless (7).