OSDN Git Service

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