manpages

git-svn-id: file:///home/lennart/svn/public/aeswepd/trunk@25 022f378f-78c4-0310-b860-d162c87e6274

4 files changed, 139 insertions, 9 deletions

diff --git a/Makefile.am b/Makefile.am
index 107f524..362ea44 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -24,7 +24,7 @@ noinst_DATA = README
 
 README:
 	rm -f README
-#	$(MAKE) -C doc README
+	$(MAKE) -C doc README
 	cd $(srcdir) && ln -s doc/README README
 
 homepage:
@@ -32,4 +32,4 @@ homepage:
 	mkdir -p $$HOME/homepage/lennart/projects/aeswepd
 	cp *.tar.gz $$HOME/homepage/lennart/projects/aeswepd
 	cp doc/README $$HOME/homepage/lennart/projects/aeswepd
-#	cp $$HOME/homepage/lennart/projects/aeswepd/README.html $$HOME/homepage/lennart/projects/aeswepd/index.html
+	cp $$HOME/homepage/lennart/projects/aeswepd/README.html $$HOME/homepage/lennart/projects/aeswepd/index.html
diff --git a/configure.ac b/configure.ac
index e890da7..9e8e3b4 100644
--- a/configure.ac
+++ b/configure.ac
@@ -101,5 +101,5 @@ fi
 
 AM_CONDITIONAL([USE_XMLTOMAN], [test "x$xmltoman" = xyes])
 
-AC_CONFIG_FILES([src/Makefile Makefile doc/Makefile man/Makefile]) # doc/README.html])
+AC_CONFIG_FILES([src/Makefile Makefile doc/Makefile man/Makefile doc/README.html])
 AC_OUTPUT
diff --git a/doc/Makefile.am b/doc/Makefile.am
index e9e863e..d1d976a 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -16,5 +16,21 @@
 # along with aeswepd; if not, write to the Free Software Foundation,
 # Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
 
-EXTRA_DIST=README
+noinst_DATA = README.html README
+EXTRA_DIST = $(noinst_DATA) style.css README.html.in NEWDRIVERS 
+
+MAINTAINERCLEANFILES = README README.html
+CLEANFILES =
+
+if USE_LYNX
+README: README.html
+	lynx --dump $^ | sed 's,file://localhost/.*/doc/README.html,README,' > $@
+
+CLEANFILES += README
+endif
+
+tidy: README.html
+	tidy -e < README.html
+
+.PHONY: tidy
 
diff --git a/doc/README b/doc/README
index f3fb58e..20324d3 100644
--- a/doc/README
+++ b/doc/README
@@ -1,6 +1,42 @@
-Sorry, no real README yet.
 
-Just a short intro:
+                                  aeswepd 0.3
+
+   Copyright 2002,2003 Lennart Poettering <mznrfjrcq (at) 0pointer (dot)
+   de>
+     * [1]License
+     * [2]News
+     * [3]Overview
+     * [4]Status
+     * [5]Documentation
+     * [6]Requirements
+     * [7]Installation
+     * [8]Acknowledgements
+     * [9]Download
+
+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:
+
+   [10]Version 0.3 released, splitted from [11]waproamd, added
+   documentation, manpage, some bug fixes.
+
+Overview
 
 What is it? waproamd is a Linux WLAN roaming daemon for IEEE 802.11b
 cards supported by a driver with wireless extension API. It may be
@@ -25,7 +61,7 @@ A short overview on the daemons involved and how they work together:
     using aeswepd as well. aeswepd may be used without waproamd. The
     opposite is true as well.
 
-    If you create a root-owned directory /var/lib/aeswepd all running 
+    If you create a root-owned directory /var/lib/aeswepd all running
     aeswepd instances will save the current wep keys to a file therein
     which may be accessed via "aeswepls".
 
@@ -73,6 +109,84 @@ The software packages involved are available from the following URLs:
   http://0pointer.de/lennart/projects/libdaemon/
   http://0pointer.de/lennart/projects/ifplugd/
 
-Feedback to mzjncebnzq (at) 0pointer (dot) de
+Status
+
+   Version 0.3 is stable and has all the sensible features its users
+   could think of.
+
+Documentation
+
+   Have a look on the man pages [12]aeswepd(8), [13]ifstatus(8),
+   [14]aeswepd.conf(5). (A XSLT capable browser is required)
+
+  Configuration
+
+  Troubleshooting
+
+  FAQ
+
+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.
+
+   aeswepd 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.
+
+   aeswepd needs [15]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 aeswepd.
+
+Acknowledgements
+
+   None so far
+
+Download
+
+   The newest release is always available from
+   [16]http://0pointer.de/lennart/projects/aeswepd/
+
+   The current release is [17]0.3
+
+   Get aeswepd's development sources from the [18]Subversion
+   [19]repository.
+     _________________________________________________________________
+
+
+    Lennart Poettering <mznrfjrcq (at) 0pointer (dot) de>, October 2003
+
+   $Id$
+
+References
 
-$Id$
+   1. README#license
+   2. README#news
+   3. README#overview
+   4. README#status
+   5. README#documentation
+   6. README#requirements
+   7. README#installation
+   8. README#acks
+   9. README#download
+  10. http://0pointer.de/lennart/projects/aeswepd/aeswepd-0.3.tar.gz
+  11. http://0pointer.de/lennart/projects/waproamd
+  12. http://0pointer.de/lennart/projects/aeswepd/aeswepd.8.xml
+  13. http://0pointer.de/lennart/projects/aeswepd/ifstatus.8.xml
+  14. http://0pointer.de/lennart/projects/aeswepd/aeswepd.conf.5.xml
+  15. http://0pointer.de/lennart/projects/libdaemon/
+  16. http://0pointer.de/lennart/projects/aeswepd/
+  17. http://0pointer.de/lennart/projects/aeswepd/aeswepd-0.3.tar.gz
+  18. http://subversion.tigris.org/
+  19. https://seth.intheinter.net:8081/svn/aeswepd/