wireless_tools/README

   1         Wireless Tools & IfRename
   2         -------------------------
   3
   4         This package contains the Wireless tools, used to manipulate
   5 the Wireless Extensions. The Wireless Extensions is an interface
   6 allowing you to set Wireless LAN specific parameters and get the
   7 specific stats.
   8         It also contains the IfRename package, used for advance
   9 renaming of network interfaces.
  10
  11 web page :
  12 --------
  13         You'll find a lot of useful info on :
  14                 http://www.hpl.hp.com/personal/Jean_Tourrilhes/Linux/Tools.html
  15                 http://web.hpl.hp.com/personal/Jean_Tourrilhes/Linux/
  16
  17 Precompiled version :
  18 -------------------
  19         Most Linux distributions offer precompiled package containing
  20 these tools. And many of them preinstall them by default. On the other
  21 hand, installation of this package is (now) easy and allows you to get
  22 a more up-to-date version.
  23
  24 INSTALL
  25 -------
  26         This file contains installation instructions and requirements.
  27         A *must*-read.
  28
  29 DISTRIBUTION.txt
  30 ----------------
  31         This file documents how to configure wireless cards at
  32 boot time with various Linux distributions (using Wireless
  33 Extensions). Please read it carefully before asking questions.
  34         In this file, I try to collect all the specifics of Wireless
  35 Extensions integration in the most common Linux distributions. I need
  36 your help to complete this file.
  37
  38 HOTPLUG-UDEV.txt
  39 ----------------
  40         This file documents how to manage and configure removable
  41 wireless cards using Hotplug or uDev. This is more advanced than the
  42 simple procedures of DISTRIBUTION.txt. This is currently mostly Debian
  43 specific, but I hope you will contribute for other distributions.
  44
  45 PCMCIA.txt
  46 ----------
  47         This file describes how to use PCMCIA init script to configure
  48 Wireless Extensions and how to use PCMCIA schemes.
  49
  50 man pages (iwconfig.8, iwlist.8, iwpriv.8, iwspy.8)
  51 ---------
  52         VERY IMPORTANT : I try to keep the man pages up to date, so
  53 you'd better read them before asking questions.
  54         ALSO IMPORTANT : Those man pages describe the capacities of
  55 the tools, no device implements the full range (and drivers usually
  56 implement even less).
  57
  58         As far as I know, the man pages are the most complete, up to
  59 date and accurate documentation of the wireless tools. An update of
  60 the web page related to Wireless Extensions is long overdue. Send
  61 feedback to me.
  62         The man pages can either be copied into a location where the
  63 command "man" will find them, such as /usr/local/man/man8, or can be
  64 read locally with the command :
  65                 nroff -man xxx.8 | less
  66
  67 localised man pages (fr.ISO8859-1/* ; fr.UTF-8/* ; cs/*)
  68 -------------------
  69         Localised man pages are not made by me, therefore the only
  70 localisations available are those sent to me by courageous volonteers,
  71 and I expect those man pages to 'lag' compared to the english
  72 version (i.e. not have all the latest updates). Translating man pages
  73 is not a very gratifying task, especially due to my broken english,
  74 and many technical terms don't translate well to other languages, so
  75 refer to the english version when in doubt.
  76
  77 iwconfig.c
  78 ----------
  79         The main wireless tool. Used for device configuration and to see
  80 the most common wireless parameters.
  81
  82 iwlist.c
  83 --------
  84         Display some large chunk of information not displayed by iwconfig.
  85         For example, all bit rates, all frequencies, all keys...
  86
  87 iwspy.c
  88 -------
  89         Mobile IP support test and allows to get stats per MAC
  90 address (instead of globally). Also, for some drivers/devices, this is
  91 the only way to get stats in Ad-Hoc mode.
  92
  93 iwpriv.c
  94 --------
  95         Manipulate driver private ioctls : all parameters that are
  96 specific to a driver or a device and therefore not part of iwconfig.
  97
  98 iwgetid.c
  99 ---------
 100         Output the ESSID or NWID of the specified device.
 101         Can also output it in a form that can be used as a PCMCIA Scheme.
 102
 103 iwevent.c
 104 ---------
 105         Display Wireless Events. Most recent drivers will support this
 106 relatively new feature, but some older drivers may not support it.
 107
 108 ifrename.c :
 109 ----------
 110         Rename network interfaces based on various selectors.
 111
 112 iwlib.c
 113 -------
 114         The Wireless Tools helper library. May be useful if you want
 115 to create your own applications using Wireless Extensions.
 116
 117 iwmulticall.c
 118 -------------
 119         Multicall version of the tools for embedded systems.
 120
 121 Changelog, contributions :
 122 ------------------------
 123         See CHANGELOG.h
 124
 125 wireless.h
 126 ----------
 127         Definition of the Wireless Extensions. Remember that the
 128 definition used by the drivers and the tools must match, otherwise
 129 funny things may happen. The tools try to check for that.
 130         Since Wireless Extensions v12, you can no longer drop this
 131 file into your kernel headers to update the Wireless Extensions, you
 132 need to use the full patches available on my web page. So, the use is
 133 more if you plan to do some cross compile or something similar.
 134         Just for your enjoyment, there are various releases of it. If
 135 your kernel/drivers are old, you may want to try the older releases...
 136
 137 sample_xxx.c :
 138 ------------
 139         Various samples of code showing how to implement some of the
 140 more tricky features of Wireless Extensions in your driver.
 141         Note that there is no guarantee that this code compiles, let
 142 alone works, but it should point you in the proper direction.
 143         Also, have a look at existing drivers in the Linux kernel.
 144
 145 19-udev-ifrename.rules :
 146 ----------------------
 147         udev rules to integrate properly ifrename (udev >= 107).
 148
 149 iw26x_restore_full_essid.diff :
 150 -----------------------------
 151         Current Linux kernel have a few bugs managing ESSID. These
 152 patches fix it. The first patch (iw261_...) is for kernel 2.6.19 to
 153 2.6.21, the second patch (iw262_...) is for kernel 2.6.22 and later.
 154
 155 Other tools :
 156 -----------
 157         My web page lists many other tools using Wireless
 158 Extensions that you may find useful...
 159         http://www.hpl.hp.com/personal/Jean_Tourrilhes/Linux/Tools.html#links
 160
 161 Other questions :
 162 ---------------
 163         You have the source, and it is documented. In 99% of cases,
 164 you will find your answer there.
 165
 166         Good luck...
 167
 168         Jean <jt@hpl.hp.com>