From 4ac9eff5fe74c882497f68d14832b4b74a666a86 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Thu, 16 Oct 2003 17:41:59 +0000 Subject: add documentation git-svn-id: file:///home/lennart/svn/public/waproamd/trunk@20 022f378f-78c4-0310-b860-d162c87e6274 --- doc/README.html.in | 232 +++++++++++++++++++++++++++++++++++++++++++++++++++++ doc/style.css | 29 +++++++ 2 files changed, 261 insertions(+) create mode 100644 doc/README.html.in create mode 100644 doc/style.css diff --git a/doc/README.html.in b/doc/README.html.in new file mode 100644 index 0000000..c218746 --- /dev/null +++ b/doc/README.html.in @@ -0,0 +1,232 @@ + + + + + +waproamd @PACKAGE_VERSION@ + + + + +

waproamd @PACKAGE_VERSION@

+ +

Copyright 2003 Lennart Poettering <@PACKAGE_BUGREPORT@>

+ + + +

License

+ +

This program is free software; you can redistribute it and/or +modify it under the terms of the GNU General Public License as +published by the Free Software Foundation; either version 2 of the +License, or (at your option) any later version.

+ +

This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details.

+ +

You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

+ +

News

+ +
Fri Sep 13 2003:

Version 0.3 released, +changes include: split aeswepd into its +own package, add documentation, several bug fixes.

+ +

Overview

+ +

Status

+ +

Version 0.3 works fine on hostap 0.0.4 and airolan.

+ +

Documentation

+ +

Have a look on the man pages waproamd(8), waproamd.conf(5). (A XSLT capable browser is required)

+ +

Configuration

+ +

Edit /etc/waproamd/waproamd.conf for configuration +changes. This file is a bourne shell script sourced by the init script +and used to generate a suiting command line. You may specify more than +one ethernet interface in INTERFACES. For each interface a +seperate instance of waproamd is spawned. The arguments specified in +ARGS are append to waproamd's command line. Have a look on +waproamd -h or man waproamd for further information +about the available options.

+ +

The network interface which is controlled by waproamd +should not be configured automatically by your distribution's network +subsystem, since waproamd will do this for you if needed. On +Debian remove interface names beginning with eth or +wlan from the auto option line in +/etc/network/interfaces.

+ +

Troubleshooting

+ +

When you are using the hotplug subsystem (Debian package +hotplug) you may notice that the network device is configured +even when it is not listed on an auto line in +/etc/network/interface. This may be due to hotplug +being configured to ifup the network interface when it +becomes available. This was the default behavior in the Debian +hotplug package prior to release 0.0.20030117-1, for +example. To prevent this you should either upgrade your +hotplug package or comment out the ifup call in +/etc/hotplug/net.agent.

+ +

When using waproamd together with APM (and probably ACPI) +suspends, strange things may happen: some network devices fail to +detect the network cable for a short period of time before and after +the suspend. When using the -f switch, this will be treated +as "no link beat", thus the network is shutdown after a +timeout. During this timeout the machine changes to suspended +state. When it is resumed again, the timeout will be run out, the +network is deconfigured, however, as the next cable detection +succeeds, the network is configured again immediately. To fix this +problem, waproamd should be disabled before the APM suspend +and enabled back after the suspend. This may be done by using +apmd and adding a script to +/etc/apm/{suspend,resume}.d which simply calls +/etc/init.d/waproamd suspend, resp. /etc/init.d/waproamd +resume. It might even be a good idea to shut down the network +completely during suspend, this may be achieved by calling +/etc/init.d/waproamd stop and /etc/init.d/waproamd +start in the appropriate places. I strongly urge the packagers of +this software for the Linux distributions to add such scripts to their +packages.

+ +

FAQ

+ +
    +

  1. Q: I want to use waproamd with my PCMCIA device, but waproamd quits + when it doesn't find eth0, when I have not inserted the + card. What can I do?

    + +

    A: Use the -f switch. This is not very clean however, + since modprobe is called on each cable detection query of waproamd to + load a module for the network device. This is suboptimal. You should + probably run waproamd only when the card is really inserted.

    +
    2. + +

  2. Q: I am using the -f switch, but the kernel logs are getting filled + with messages like "modprobe: modprobe: Can't locate module + eth0". What can I do?

    + +

    A: Make sure you have a line like alias eth0 off in your /etc/modules.conf

    +
    3. + +

  3. Q: When the cable is unplugged and the interface shut down it is + still available with ifconfig and markes as UP. Why this?

    + +

    A: waproamd cannot detect the link beat with a shut down interface on + certain (most as of kernel 2.4.19) network drivers. Thus waproamd + enables the interface before querying the link status. This may + be switched off with -a flag. You might want to use it if you + have a sane network driver (e.g. eepro100). The subdirectory + patches/ in the waproamd distribution includes a patch for the + 8139too 0.9.26 driver, which makes the driver compatible with + -a. Don't ask me how to apply this patch. If you don't know, you + won't need it.

    4. + +

  4. Q: Does it work with anything else than plain ethernet or wireless LAN?

    + +

    A: Certainly not, since the MII and +ETHTOOL ioctl()s and the wireless extension don't +exist on + other network device types.

    5. + +

  5. Q: I have a Realtek 8139 based network card. Everytime waproamd + starts on bootup my machine freezes. What can I do?

    + +

    A: This is a bug in the 8139too driver 0.9.25 (at least) shipped + with Linux 2.4.19, please upgrade to 8139too 0.9.26 (Linux 2.4.20 + or seperately at http://www.sourceforge.net/projects/gkernel/).

    6. + + +

  6. Q: There are already laptop-net's ifd and miid, why did you write + your own daemon?

    + +

    A: laptop-net simply sucks and I didn't know of miid when I wrote + waproamd. However, waproamd is far better than miid. For a + comparison of miid and waproamd, have a look on + + http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=162763&repeatmerged=yes

    7. +
+ + +

Requirements

+ +

A newer Linux Kernel (I think 2.2 is good enough, alltough I tested it +only with 2.4) with a compatible device driver and +ethernet card. Most modern cards and drivers are compatible, like mine +which works with the 8139too driver.

+ +

waproamd was developed and tested on Debian GNU/Linux +"testing" from July 2003, it should work on most other Linux +distributions (and maybe Unix versions) since it uses GNU autoconf and +GNU libtool for source code configuration and shared library +management.

+ +

The machine used was a Medion 9580-F laptop with a Realtek 8139 +network card and a PRISM1 PCMCIA wireless LAN card.

+ +

waproamd needs libdaemon.

+ +

Installation

+ +

As this package is made with the GNU autotools you should run +./configure inside the distribution directory for configuring +the source tree. After that you should run make for +compilation and make install (as root) for installation of +waproamd.

+ +

The installation scripts create an init script in +${sysconfdir}/init.d/waproamd, however no /etc/rc?.d/ links are created +for it.

+ +

Acknowledgements

+ +

For the developers of mii-diag, ethtool and laptop-net, since I looked +on their source codes for learning how to use the link beat ioctls.

+ +

Oliver Kurth for packaging waproamd for Debian and waproamd's +manpage

+ +

Asgeir Nilsen, Sean Reifschneider, R. Steve McKown, David Mitchell for patches

+ +

Frederic Lepied for integrating waproamd into Mandrake Linux

+ +

Download

+ +

The newest release is always available from @PACKAGE_URL@

+ +

The current release is @PACKAGE_VERSION@

+ +

Get waproamd's development sources from the Subversion repository.

+ +

You may find a mostly up to date Debian package of waproamd on the Debian package repository.

+ +

Packages for Mandrake Linux may be found in the Cooker distribution; Gentoo packages are available as well

+ +
+
Lennart Poettering <@PACKAGE_BUGREPORT@>, Oct 2003
+
$Id: README.html.in 48 2003-09-13 11:36:11Z lennart $
+ + + diff --git a/doc/style.css b/doc/style.css new file mode 100644 index 0000000..090bbc7 --- /dev/null +++ b/doc/style.css @@ -0,0 +1,29 @@ +/* $Id: style.css 43 2003-09-13 11:25:11Z lennart $ */ + +/*** + * This file is part of ifplugd. + * + * ifplugd is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * ifplugd is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with ifplugd; if not, write to the Free Software Foundation, + * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. + ***/ + +body { color: black; background-color: white; margin: 0.5cm; } +a:link, a:visited { color: #900000; } +p { margin-left: 0.5cm; margin-right: 0.5cm; } +div.news-date { margin-left: 0.5cm; font-size: 80%; color: #4f0000; } +p.news-text { margin-left: 1cm; } +ul { margin-left: 0.5cm; } +h1 { color: #00009F; } +h2 { color: #00009F; } +h3 { color: #00004F; margin-left: 0.5cm; } -- cgit