Removed olsrd_plugin_io.h
[olsrd.git] / README-WIN32.txt
index 58ae54b..090688f 100644 (file)
@@ -63,9 +63,10 @@ how this version differs from the original Linux version.
                      ***** Running the GUI *****\r
 \r
   We now have a native Windows GUI. No more GTK+. Simply make sure\r
-  that "Switch.exe", "Shim.exe", and "olsrd.exe" are located in the\r
-  same directory and run "Switch.exe". "Shim.exe" is just an auxiliary\r
-  console application that is required by "Switch.exe".\r
+  that "Switch.exe", "Shim.exe", "olsrd.exe", "olsrd_cfgparser.dll",\r
+  and "Default.olsr" are located in the same directory and run\r
+  "Switch.exe". "Shim.exe" is just an auxiliary console application\r
+  that is required by "Switch.exe".\r
 \r
   The GUI is pretty self-explanatory. The three buttons on the lower\r
   right of the GUI window start the OLSR server, stop the OLSR server,\r
@@ -75,28 +76,38 @@ how this version differs from the original Linux version.
   run the OLSR server "olsrd.exe". When you click "Start" the GUI\r
   generates a temporary configuration file from the information given\r
   by the "Settings" tab. This temporary configuration file is passed\r
-  to the OLSR server via its "-f" option. If you need options that\r
-  cannot be controlled via the "Settings" tab, simply add them to the\r
-  "Manual additions" text box as you would add them to a configuration\r
-  file, e.g. "HNA 192.168.0.0 255.255.255.0". The contents of this\r
-  text box are appended to the temporary configuration file when it is\r
-  generated.\r
+  to the OLSR server via its "-f" option. \r
 \r
   "Offer Internet connection" is only available if you have an\r
   Internet connection, i.e. if you have a default route configured. If\r
-  you tick this option, "HNA 0.0.0.0 0.0.0.0" is added to the\r
-  temporary configuration file, allowing other nodes in the OLSR\r
+  you tick this option an HNA entry for the default route is added to\r
+  the temporary configuration file, allowing other nodes in the OLSR\r
   network to use your Internet connection.\r
 \r
-  Gateway tunnelling and IP version 6 cannot currently be selected, as\r
-  support for these features is not yet complete in the Windows\r
-  version.\r
+  IP version 6 cannot currently be selected, as support for IPv6 is\r
+  not yet complete in the Windows version.\r
+\r
+  "Enable ETX link quality" tells the OLSR server to detect the\r
+  quality of its links to its neighbours using a variant of the ETX\r
+  metric. "Window size" specifies the number of most recent packets to\r
+  be used when calculating the packet loss. If, for example, this\r
+  parameter is set to 10, then the OLSR server will calculate the\r
+  packet loss among the most recent 10 OLSR packets received from each\r
+  neighbour. If "For MPR selection only" is active, the link quality\r
+  information is only used to select MPRs that offer the best paths to\r
+  your two-hop neighbours. If "For MPR selection and routing" is\r
+  active, the link quality is additionally used to create the routing\r
+  table.\r
+\r
+  WARNING - Enabling ETX breaks compliance with the OLSR\r
+  standard. ETX-enabled nodes do not interoperate with nodes that have\r
+  ETX switched off. DO NOT USE NODES WITH DIFFERENT ETX SETTINGS IN A\r
+  SINGLE NETWORK!\r
 \r
   The three buttons on the lower right of the "Settings" tab open\r
   previously saved settings, save the current settings to a\r
   configuration file, and reset the current settings to default\r
-  values. When opening a saved configuration file, the GUI adds lines\r
-  that it cannot interpret to the "Manual additions" text box.\r
+  values.\r
 \r
   If you start the GUI with the path to a configuration file as the\r
   only command line argument, the GUI opens the given configuration\r
@@ -106,10 +117,12 @@ how this version differs from the original Linux version.
   OLSR server with a simple double click on the configuration file.\r
 \r
   The "Output" tab shows the output of the currently running OLSR\r
-  server. When you click "Start" The GUI simply invokes the OLSR\r
-  server "olsrd.exe" and intercepts its console output. Use the four\r
-  buttons on the upper right of the tab to freeze the output, resume\r
-  frozen output, save the output to a file, or clear the output.\r
+  server. The output is limited to 1000 lines. The 1001st line will\r
+  make the first line disappear and so on. When you click "Start" The\r
+  GUI simply invokes the OLSR server "olsrd.exe" and intercepts its\r
+  console output. Use the four buttons on the upper right of the tab\r
+  to freeze the output, resume frozen output, save the output to a\r
+  file, or clear the output.\r
 \r
   The "Nodes" tab contains information about the nodes that the OLSR\r
   server currently knows about. If you click on the address of a node\r
@@ -121,6 +134,16 @@ how this version differs from the original Linux version.
   The "Routes" tab shows the routes that the currently running OLSR\r
   server has added.\r
 \r
+  The default settings for the "Settings" tab are taken from the\r
+  "Default.olsr" file. The configuration of the last interface in this\r
+  file is used to populate the per-interface settings (HELLO interval,\r
+  etc.) in the "Settings" tab. If you do not want to specify any\r
+  interface in "Default.olsr", the problem arises that you do not have\r
+  such a last interface. In this case simply create an interface with\r
+  the special name of "GUI". This tells the GUI to use the\r
+  configuration of the interface for the per-interface settings and to\r
+  forget about this interface afterwards.\r
+\r
 \r
                    ***** Running the GTK+ GUI *****\r
 \r
@@ -131,13 +154,9 @@ how this version differs from the original Linux version.
                      ***** Missing features *****\r
 \r
   The Windows version currently does not implement the following\r
-  features known from the Linux release.\r
-\r
-    * IPv6.\r
-\r
-    * Link layer statistics.\r
+  major features known from the Linux release.\r
 \r
-    * Gateway tunnelling.\r
+    * IPv6\r
 \r
   There are also some Windows-specific features that I currently work\r
   on, but which have not made it into this release.\r
@@ -150,32 +169,16 @@ how this version differs from the original Linux version.
 \r
   To compile the Windows version of the OLSR server or the dot_draw\r
   plugin you need a Cygwin installation with a current version of GCC\r
-  and Mingw32. Each of the corresponding subdirectories contains a\r
-  shell script named "mkmf.sh" that takes "Makefile.win32.in" as its\r
-  input, appends the dependencies, and outputs "Makefile.win32". Then\r
-  simply say\r
-\r
-    make -f Makefile.win32 clean\r
-\r
-  to remove any compiled files or\r
-\r
-    make -f Makefile.win32 mclean\r
-\r
-  to remove any compiled files and the generated makefile. Say\r
-\r
-    make -f Makefile.win32\r
-\r
-  to compile the source code.\r
+  and Mingw32.\r
 \r
   The GUI has to be compiled with Visual C++ 6. Simply open the\r
   "Frontend.dsw" workspace in the Visual C++ 6 IDE. Then compile\r
   "Frontend" and "Shim", which creates "Switch.exe" and\r
-  "Shim.exe". Copy these two executables into the same directory as\r
-  "olsrd.exe" and you are ready to go.\r
+  "Shim.exe".\r
 \r
 Well, thanks for using an early release of a piece of software and\r
 please bear with me if there are any problems. Please do also feel\r
 free to suggest any features that you'd like to see in future\r
 releases.\r
 \r
-Thomas Lopatic <thomas@lopatic.de>, 2004-09-15\r
+Thomas Lopatic <thomas@lopatic.de>, 2004-11-21\r