add documentation

git-svn-id: file:///home/lennart/svn/public/waproamd/trunk@20 022f378f-78c4-0310-b860-d162c87e6274
author: Lennart Poettering <lennart@poettering.net> 2003-10-16 17:41:59 +0000
committer: Lennart Poettering <lennart@poettering.net> 2003-10-16 17:41:59 +0000
commit: 4ac9eff5fe74c882497f68d14832b4b74a666a86 (patch)
tree: 5d31bb44c5dd8be6fe82be8113b944b99d39e727
parent: 438052747029e2ae78c672ba5af932520bcc7bb9 (diff)
2 files changed, 261 insertions, 0 deletions
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 @@
+<?xml version="1.0" encoding="iso-8895-15"?> <!-- -*-html-helper-*- -->
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+
+<head>
+<title>waproamd @PACKAGE_VERSION@</title>
+<link rel="stylesheet" type="text/css" href="style.css" />
+</head>
+
+<body>
+<h1><a name="top">waproamd @PACKAGE_VERSION@</a></h1>
+
+<p><i>Copyright 2003 Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;</i></p>
+
+<ul class="toc">
+    <li><a href="#license">License</a></li>
+    <li><a href="#news">News</a></li>
+    <li><a href="#overview">Overview</a></li>
+    <li><a href="#status">Status</a></li>
+    <li><a href="#documentation">Documentation</a></li>
+    <li><a href="#requirements">Requirements</a></li>
+    <li><a href="#installation">Installation</a></li>
+    <li><a href="#acks">Acknowledgements</a></li>
+    <li><a href="#download">Download</a></li>
+</ul>
+
+<h2><a name="license">License</a></h2>
+
+<p>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.</p>
+
+<p>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.</p>
+
+<p>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.</p>
+
+<h2><a name="news">News</a></h2>
+
+<div class="news-date">Fri Sep 13 2003: </div> <p class="news-text"><a
+href="@PACKAGE_URL@waproamd-0.3.tar.gz">Version 0.3</a> released,
+changes include: split <tt><a
+href="http://0pointer.de/projects/aeswepd">aeswepd</a></tt> into its
+own package, add documentation, several bug fixes.</p>
+
+<h2><a name="overview">Overview</a></h2>
+
+<h2><a name="status">Status</a></h2>
+
+<p>Version 0.3 works fine on <tt>hostap</tt> 0.0.4 and <tt>airolan</tt>.</p>
+  
+<h2><a name="documentation">Documentation</a></h2>
+
+<p>Have a look on the man pages <a href="@PACKAGE_URL@waproamd.8.xml"><tt>waproamd(8)</tt></a>, <a href="@PACKAGE_URL@waproamd.conf.5.xml"><tt>waproamd.conf(5)</tt></a>. (A XSLT capable browser is required)</p>
+
+<h3>Configuration</h3>
+
+<p>Edit <tt>/etc/waproamd/waproamd.conf</tt> 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 <tt>INTERFACES</tt>. For each interface a
+seperate instance of <tt>waproamd</tt> is spawned. The arguments specified in
+<tt>ARGS</tt> are append to <tt>waproamd</tt>'s command line. Have a look on
+<tt>waproamd -h</tt> or <tt>man waproamd</tt> for further information
+about the available options.</p>
+
+<p>The network interface which is controlled by <tt>waproamd</tt>
+should not be configured automatically by your distribution's network
+subsystem, since <tt>waproamd</tt> will do this for you if needed. On
+Debian remove interface names beginning with <tt>eth</tt> or
+<tt>wlan</tt> from the <tt>auto</tt> option line in
+<tt>/etc/network/interfaces</tt>.</p>
+
+<h3>Troubleshooting</h3>
+
+<p>When you are using the hotplug subsystem (Debian package
+<tt>hotplug</tt>) you may notice that the network device is configured
+even when it is not listed on an <tt>auto</tt> line in
+<tt>/etc/network/interface</tt>. This may be due to <tt>hotplug</tt>
+being configured to <tt>ifup</tt> the network interface when it
+becomes available.  This was the default behavior in the Debian
+<tt>hotplug</tt> package prior to release <tt>0.0.20030117-1</tt>, for
+example.  To prevent this you should either upgrade your
+<tt>hotplug</tt> package or comment out the <tt>ifup</tt> call in
+<tt>/etc/hotplug/net.agent</tt>.</p>
+
+<p>When using <tt>waproamd</tt> 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 <tt>-f</tt> 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, <tt>waproamd</tt> should be disabled before the APM suspend
+and enabled back after the suspend. This may be done by using
+<tt>apmd</tt> and adding a script to
+<tt>/etc/apm/{suspend,resume}.d</tt> which simply calls
+<tt>/etc/init.d/waproamd suspend</tt>, resp. <tt>/etc/init.d/waproamd
+resume</tt>. It might even be a good idea to shut down the network
+completely during suspend, this may be achieved by calling
+<tt>/etc/init.d/waproamd stop</tt> and <tt>/etc/init.d/waproamd
+start</tt> in the appropriate places. I strongly urge the packagers of
+this software for the Linux distributions to add such scripts to their
+packages.</p>
+
+<h3>FAQ</h3>
+
+<ol>
+  <li><p><b>Q:</b> I want to use <tt>waproamd</tt> with my PCMCIA device, but <tt>waproamd</tt> quits
+  when it doesn't find <tt>eth0</tt>, when I have not inserted the
+  card. What can I do?</p>
+  
+  <p><b>A:</b> Use the <tt>-f</tt> switch. This is not very clean however,
+  since modprobe is called on each cable detection query of <tt>waproamd</tt> to
+  load a module for the network device. This is suboptimal. You should
+  probably run <tt>waproamd</tt> only when the card is really inserted.</p>
+  </li>
+  
+  <li><p><b>Q:</b> I am using the <tt>-f</tt> switch, but the kernel logs are getting filled
+  with messages like "<tt>modprobe: modprobe: Can't locate module
+  eth0</tt>". What can I do?</p>
+  
+  <p><b>A:</b> Make sure you have a line like <tt>alias eth0 off</tt> in your <tt>/etc/modules.conf</tt></p>
+  </li>
+  
+  <li><p><b>Q:</b> When the cable is unplugged and the interface shut down it is
+  still available with <tt>ifconfig</tt> and markes as UP. Why this?</p>
+
+  <p><b>A:</b> <tt>waproamd</tt> cannot detect the link beat with a shut down interface on
+  certain (most as of kernel 2.4.19) network drivers. Thus <tt>waproamd</tt>
+  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. <tt>eepro100</tt>). The subdirectory
+  <tt>patches/</tt> in the <tt>waproamd</tt> 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.</p></li>
+
+  <li><p><b>Q:</b> Does it work with anything else than plain ethernet or wireless LAN?</p>
+
+  <p><b>A:</b> Certainly not, since the <tt>MII</tt> and
+<tt>ETHTOOL</tt> <tt>ioctl()</tt>s and the wireless extension don't
+exist on
+  other network device types.</p></li>
+  
+  <li><p><b>Q:</b> I have a Realtek 8139 based network card. Everytime <tt>waproamd</tt>
+  starts on bootup my machine freezes. What can I do?</p>
+  
+  <p><b>A:</b> This is a bug in the <tt>8139too</tt> driver 0.9.25 (at least) shipped
+  with Linux 2.4.19, please upgrade to <tt>8139too</tt> 0.9.26 (Linux 2.4.20
+  or seperately at <a href="http://www.sourceforge.net/projects/gkernel/">http://www.sourceforge.net/projects/gkernel/</a>).</p></li>
+  
+  
+  <li><p><b>Q:</b> There are already <tt>laptop-net</tt>'s <tt>ifd</tt> and <tt>miid</tt>, why did you write
+  your own daemon?</p>
+
+  <p><b>A:</b> <tt>laptop-net</tt> simply sucks and I didn't know of <tt>miid</tt> when I wrote
+  <tt>waproamd</tt>. However, <tt>waproamd</tt> is far better than <tt>miid</tt>. For a
+     comparison of <tt>miid</tt> and <tt>waproamd</tt>, have a look on
+
+  <a href="http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=162763&amp;repeatmerged=yes">http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=162763&amp;repeatmerged=yes</a></p></li>
+</ol>
+
+
+<h2><a name="requirements">Requirements</a></h2>
+
+<p>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 <tt>8139too</tt> driver.</p>
+
+<p><tt>waproamd</tt> 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.</p>
+
+<p>The machine used was a Medion 9580-F laptop with a Realtek 8139
+network card and a PRISM1 PCMCIA wireless LAN card.</p>
+
+<p><tt>waproamd</tt> needs <a
+href="http://0pointer.de/lennart/projects/libdaemon/"><tt>libdaemon</tt></a>.</p>
+ 
+<h2><a name="installation">Installation</a></h2>
+
+<p>As this package is made with the GNU autotools you should run
+<tt>./configure</tt> inside the distribution directory for configuring
+the source tree. After that you should run <tt>make</tt> for
+compilation and <tt>make install</tt> (as root) for installation of
+<tt>waproamd</tt>.</p>
+
+<p>The installation scripts create an init script in
+<tt>${sysconfdir}/init.d/waproamd</tt>, however no <tt>/etc/rc?.d/</tt> links are created
+for it.</p>
+
+<h2><a name="acks">Acknowledgements</a></h2>
+
+<p>For the developers of <tt>mii-diag</tt>, <tt>ethtool</tt> and <tt>laptop-net</tt>, since I looked
+on their source codes for learning how to use the link beat ioctls.</p>
+
+<p>Oliver Kurth for packaging <tt>waproamd</tt> for Debian and <tt>waproamd</tt>'s
+manpage</p>
+
+<p>Asgeir Nilsen, Sean Reifschneider, R. Steve McKown, David Mitchell for patches</p>
+
+<p>Frederic Lepied for integrating <tt>waproamd</tt> into Mandrake Linux</p>
+
+<h2><a name="download">Download</a></h2>
+
+<p>The newest release is always available from <a href="@PACKAGE_URL@">@PACKAGE_URL@</a></p>
+
+<p>The current release is <a href="@PACKAGE_URL@waproamd-@PACKAGE_VERSION@.tar.gz">@PACKAGE_VERSION@</a></p>
+
+<p>Get <tt>waproamd</tt>'s development sources from the <a href="http://subversion.tigris.org/">Subversion</a> <a href="https://seth.intheinter.net:8081/svn/waproamd/">repository</a>.</p>
+
+<p>You may find a mostly up to date Debian package of <tt>waproamd</tt> on the <a href="http://packages.debian.org/waproamd">Debian package repository</a>.</p>
+
+<p>Packages for Mandrake Linux may be found in the Cooker distribution; Gentoo packages are available as well</p>
+
+<hr/>
+<address>Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;, Oct 2003</address>
+<div><i>$Id: README.html.in 48 2003-09-13 11:36:11Z lennart $</i></div>
+
+</body>
+</html>
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; }
author	Lennart Poettering <lennart@poettering.net>	2003-10-16 17:41:59 +0000
committer	Lennart Poettering <lennart@poettering.net>	2003-10-16 17:41:59 +0000
commit	4ac9eff5fe74c882497f68d14832b4b74a666a86 (patch)
tree	5d31bb44c5dd8be6fe82be8113b944b99d39e727
parent	438052747029e2ae78c672ba5af932520bcc7bb9 (diff)