OSDN Git Service

v25
[android-x86/external-wireless-tools.git] / wireless_tools / README
1         Wireless Tools
2         --------------
3
4         This package contain the Wireless tools, used to manipulate
5 the Wireless Extensions. The Wireless Extension is an interface
6 allowing you to set Wireless LAN specific parameters and get the
7 specific stats.
8
9 web page
10 --------
11         You'll find a lot of useful info on :
12                 http://www.hpl.hp.com/personal/Jean_Tourrilhes/Linux/Tools.html
13                 http://web.hpl.hp.com/personal/Jean_Tourrilhes/Linux/
14
15 INSTALL
16 -------
17         This file contains installation instruction and requirements.
18         A *must* read.
19
20 PCMCIA.txt
21 ----------
22         This file describes how to use Pcmcia init script to configure
23 Wireless Extensions and how to use Pcmcia schemes.
24
25 DISTRIBUTION
26 ------------
27         This file will document the specifics of Wireless Extensions
28 with a few different distributions. I need your help to complete this
29 file.
30
31 man pages (iwconfig.8, iwlist.8, iwpriv.8, iwspy.8)
32 ---------
33         VERY IMPORTANT : I try to keep the man page up to date, so
34 you'd better read them before asking questions.
35         ALSO IMPORTANT : Those man pages describe the capacity of the
36 tools, no device implement the full range (and drivers usually
37 implement even less).
38
39         As far as I know, the man pages are the most complete, up to
40 date and accurate documentation of the wireless tools. An update of
41 the web page related to Wireless Extension is long overdue. Send
42 feedback to me.
43         The man pages can either be copied in a location where the
44 command "man" will find them, such as /usr/local/man/man8, or can be
45 read locally with the command :
46                 nroff -man xxx.8 | less
47
48 iwconfig.c
49 ----------
50         The main wireless tool. Used for device configuration and to see
51 the most common wireless parameters.
52
53 iwlist.c
54 --------
55         Display some large chunk of information not displayed by iwconfig.
56         For example, all bit rates, all frequencies, all keys...
57
58 iwspy.c
59 -------
60         Mobile IP support test and allow get get stats per MAC address
61 (instead of globally). Also, for some driver/device, this is the only
62 way to get stats in Ad-Hoc mode.
63
64 iwpriv.c
65 --------
66         Manipulate driver private ioctls : all parameters that are
67 specific to a driver or a device and therefore not part of iwconfig.
68
69 iwgetid.c
70 ---------
71         Output the ESSID or NWID of the specified device.
72         Can also output it in a form that can be used as a Pcmcia Scheme.
73
74 iwevent.c
75 ---------
76         Display Wireless Events. This is new, so there is not much support
77 in drivers for it yet...
78
79 iwlib.c
80 -------
81         The Wireless Tools helper library. May be usefull if you want
82 to create your own applications using Wireless Extensions.
83
84 Changelog, contributions
85 ------------------------
86         See CHANGELOG.h
87
88 wireless.h
89 ----------
90         Definition of the Wireless Extensions. Remember that the
91 definition used by the drivers and the tools must match, otherwise
92 funny things may happen. The tools try to check for that.
93         Since Wireless Extensions v12, you can no longer drop this
94 file in your kernel headers to update the Wireless Extensions, you
95 need to use the full patches available on my web page. So, the use is
96 more if you plan to do some cross compile or something similar.
97         Just for your enjoyement, there is various release of it. If
98 your kernel/drivers are old, you may want to try the older releases...
99
100 sample_xxx.c :
101 ------------
102         Various samples of code showing how to implement some of the
103 more tricky feature of Wireless Extensions in your driver.
104         Note that there is no guarantee that this code compile, let
105 alone work, but it should point you in the proper direction.
106         Also, have a look at existing drivers in the Linux kernel.
107
108 Other tools :
109 -----------
110         My web page list many other tools using Wireless
111 Extensions that you may find useful...
112         http://www.hpl.hp.com/personal/Jean_Tourrilhes/Linux/Tools.html#links
113
114 Other questions :
115 ---------------
116         You have the source, and it is documented. In 99% of the case,
117 you will find your answer there.
118
119         Good luck...
120
121         Jean <jt@hpl.hp.com>