Remove old routes before adding new routes on any OS but Linux. Always
[olsrd.git] / README
diff --git a/README b/README
index 522b732..fa8e11e 100644 (file)
--- a/README
+++ b/README
@@ -1,17 +1,18 @@
 
-UnikOLSR 0.4.7
+olsr.org OLSR daemon 0.4.8
+
+Andreas Tonnesen(andreto@olsr.org)
+Thomas Lopatic  (thomas@lopatic.de)
 
-by Andreas Tonnesen(andreto@olsr.org)
 http://www.olsr.org
 
-18.08.04
+nn.11.04
 
 
 1. OLSR RFC COMPLIANCE
 
-  This version is RFC2636 compliant to my knowledge!
-
-  The OLSR-RFC definitions can be found in the olsr_protocol header file.
+  Olsrd is RFC3626 compliant. Most RFC realted definitions can be found 
+  in the olsr_protocol header file.
 
 
 2. EXTENTIONS
@@ -20,31 +21,27 @@ http://www.olsr.org
 
   Plugins:
 
+  - Dynamic Internet gateway. A plugin that dynamically adds and removes Internet
+    HNA transmissions based on if there exists a default gateway to Internet
+    with hopcount = 0(non OLSR gateway).
+
+  - Dot draw. A plugin that produces output in the dot format representing
+    the network topology.
+
   - Secure OLSR plugin. This plugin adds a signature to all messages
     to ensure data integrity. This way only nodes with access to the
     shared key can participate in the routing.
-    The key is read as the first 128 bits from /root/.olsr/olsrd_secure_key
     You need to have the OpenSSL libs installed to use this plugin.
 
   - Powerplugin. A plugin that uses OLSRs MPR flooding to spread information
-    about the powerstatus of nodes.
-
-  - Dynamic Internet gateway. A plugin that dynamically adds and removes Internet
-    HNA transmissions based on if there exists a default gateway to Internet
-    with hopcount = 0(non OLSR gateway).
+    about the powerstatus of nodes. Ment as an example plugin to get coders
+    started.
 
   Built in:
 
   - IPC to GUI front-end. A gui front-end can connect to the daemon
     if started with the -ipc switch or set in the configfile.
 
-  - Gateway tunneling. This is not easly configurated! For testing purposes.
-    This functioning will be updated in a later version. Do not try to
-    use this except you are 100% sure you need it!!
-
-  - Optional deletion of default gateways when recieving a 0.0.0.0/0.0.0.0
-    gw(in HNA).
-
 
 3. COMPILING & INSTALLING
 
@@ -54,10 +51,9 @@ http://www.olsr.org
   All this can be done on the command line(or in scripts), so there should
   not be any need to update the Makefile for different environments.
 
-  These changes also go for the pluginmakefiles.
-
   To compile:
-  'make'
+  'make OS=targetos'
+  Just type 'make' to see a list of available targets.
 
   To install(you must be root):
   'make install'
@@ -83,7 +79,7 @@ http://www.olsr.org
   Edit the configuration file to fit your needs.
 
   Options in the config file can also be overridden by command line 
-  options. See the manual page olsrd(8) for details.
+  options. See the manual pages olsrd(8) and olsrd.conf(5) for details.
 
   To run the daemon you MUST specify which interface(s) to use either in
   the config file or by using the -i option.
@@ -117,7 +113,7 @@ http://www.olsr.org
     To compile:
     cd linux-gui
     make
-    The binary is put in the bin directory
+    The binary is put in the current directory
 
   6.2 RUNNING