Added information about the new GUI.
authorThomas Lopatic <thomas@lopatic.de>
Tue, 14 Sep 2004 12:32:01 +0000 (12:32 +0000)
committerThomas Lopatic <thomas@lopatic.de>
Tue, 14 Sep 2004 12:32:01 +0000 (12:32 +0000)
README-WIN32.txt

index 1397bfe..24a2481 100644 (file)
@@ -1,9 +1,10 @@
 
 
-                        UniK OLSR for Windows
-                        ---------------------
+                         olsr.org for Windows
+                         --------------------
+
+Welcome to the Windows release of olsr.org. Let's have a quick look at
+how this version differs from the original Linux version.
 
 
-Welcome to the first Windows release. Let's have a quick look at how
-this version is different from the original Linux version.
 
                         ***** Stability *****
 
 
                         ***** Stability *****
 
@@ -11,15 +12,19 @@ this version is different from the original Linux version.
   hasn't yet received the extensive testing by the OLSR community that
   the Linux version has gone through. So, if you experience any
   strange behaviour, it's probably my fault. In this case please bear
   hasn't yet received the extensive testing by the OLSR community that
   the Linux version has gone through. So, if you experience any
   strange behaviour, it's probably my fault. In this case please bear
-  with me and send me a bug report via the OLSR-users mailing
-  list. I'll then do my best to find and fix the problem with your
-  assistance.
+  with me and use the issue tracker on SourceForge. I'll then do my
+  best to find and fix the problem with your assistance. The
+  SourceForge homepage for olsrd.org has the following URL.
+
+                http://sourceforge.net/projects/olsrd/
+
 
                     ***** Configuration file *****
 
 
                     ***** Configuration file *****
 
-  If you do not specify a configuration file, the OLSR server by
-  default attempts to use "olsrd.conf" in your Windows directory,
-  e.g. "C:\WINDOWS\olsrd.conf".
+  If you do not specify a configuration file, the OLSR server
+  ("olsrd.exe") by default attempts to use "olsrd.conf" in your
+  Windows directory, e.g. "C:\WINDOWS\olsrd.conf".
+
 
                      ***** Interface naming *****
 
 
                      ***** Interface naming *****
 
@@ -31,14 +36,14 @@ this version is different from the original Linux version.
 
   Hence, the Windows version implements its own naming scheme that
   maps each internal name to a made-up name like "if03", which is
 
   Hence, the Windows version implements its own naming scheme that
   maps each internal name to a made-up name like "if03", which is
-  easier to memorize. Simply invoke the OLSR executable as follows to
-  obtain the OLSR server's view of your interfaces:
+  easier to memorize. Simply invoke the OLSR server as follows to
+  obtain its view of your interfaces:
 
     olsrd.exe -int
 
   This lists the made-up interface names along with their current IP
   addresses to enable you to find out which made-up interface name
 
     olsrd.exe -int
 
   This lists the made-up interface names along with their current IP
   addresses to enable you to find out which made-up interface name
-  belongs to which of your physical interfaces.
+  corresponds to which of your physical interfaces.
 
   For techies: The made-up names consist of the string "if" followed
   by a two-digit hex representation of the least significant byte of
 
   For techies: The made-up names consist of the string "if" followed
   by a two-digit hex representation of the least significant byte of
@@ -48,47 +53,94 @@ this version is different from the original Linux version.
   cases. So, if the "-int" option reports two interfaces that have the
   same name, please do let me know.
 
   cases. So, if the "-int" option reports two interfaces that have the
   same name, please do let me know.
 
-                     ***** Running the GUI *****
-
-  The GUI is a GTK+ application and thus requires the GTK+ runtime
-  environment to work. The Windows port of GTK+ is available from the
-  following URL:
-
-    http://www.gimp.org/~tml/gimp/win32/downloads.html
 
 
-  You need to download the following packages or newer versions of
-  these packages:
+                     ***** Running the GUI *****
 
 
-    - atk-1.6.0.zip
-    - gettext-runtime-0.13.1.zip
-    - glib-2.4.5.zip
-    - gtk+-2.4.7.zip
-    - libiconv-1.9.1.bin.woe32.zip
-    - pango-1.4.1.zip
+  We now have a native Windows GUI. No more GTK+. Simply make sure
+  that "Switch.exe", "Shim.exe", and "olsrd.exe" are located in the
+  same directory and run "Switch.exe". "Shim.exe" is just an auxiliary
+  console application that is required by "Switch.exe".
+
+  The GUI is pretty self-explanatory. The three buttons on the lower
+  right of the GUI window start the OLSR server, stop the OLSR server,
+  and exit the GUI.
+
+  Use the "Settings" tab to specify the options that the GUI uses to
+  run the OLSR server "olsrd.exe". When you click "Start" the GUI
+  generates a temporary configuration file from the information given
+  by the "Settings" tab. This temporary configuration file is passed
+  to the OLSR server via its "-f" option. If you need options that
+  cannot be controlled via the "Settings" tab, simply add them to the
+  "Manual additions" text box as you would add them to a configuration
+  file, e.g. "HNA 192.168.0.0 255.255.255.0". The contents of this
+  text box are appended to the temporary configuration file when it is
+  generated.
+
+  "Offer Internet connection" is only available if you have an
+  Internet connection, i.e. if you have a default route configured. If
+  you tick this option, "HNA 0.0.0.0 0.0.0.0" is added to the
+  temporary configuration file, allowing other nodes in the OLSR
+  network to use your Internet connection.
+
+  Gateway tunnelling and IP version 6 cannot currently be selected, as
+  support for these features is not yet complete in the Windows
+  version.
+
+  The three buttons on the lower right of the "Settings" tab open
+  previously saved settings, save the current settings to a
+  configuration file, and reset the current settings to default
+  values. When opening a saved configuration file, the GUI adds lines
+  that it cannot interpret to the "Manual additions" text box.
+
+  If you start the GUI with the path to a configuration file as the
+  only command line argument, the GUI opens the given configuration
+  file and runs the OLSR server with this configuration. So, saving a
+  configuration file with a ".olsr" extension, for example, and making
+  "Switch.exe" the handler for ".olsr" files enables you to run the
+  OLSR server with a simple double click on the configuration file.
+
+  The "Output" tab shows the output of the currently running OLSR
+  server. When you click "Start" The GUI simply invokes the OLSR
+  server "olsrd.exe" and intercepts its console output. Use the four
+  buttons on the upper right of the tab to freeze the output, resume
+  frozen output, save the output to a file, or clear the output.
+
+  The "Nodes" tab contains information about the nodes that the OLSR
+  server currently knows about. If you click on the address of a node
+  in the "Node list" list box, the GUI populates the three "Node
+  information" list boxes on the right with the multi-point relays of
+  the selected node (MPR), the interfaces of the selected node (MID),
+  and the non-OLSR networks accessible via the selected node (HNA).
+
+  The "Routes" tab shows the routes that the currently running OLSR
+  server has added.
+
+
+                   ***** Running the GTK+ GUI *****
+
+  Please use the native Windows GUI instead. The GTK+ GUI is no longer
+  supported on Windows.
 
 
-  Simply unzip the files into a directory that you've created,
-  e.g. into "GUI". Then copy the "olsrd-gui.exe" file into the "bin"
-  subdirectory, e.g. into "GUI\bin", and run it from there.
 
                      ***** Missing features *****
 
   The Windows version currently does not implement the following
   features known from the Linux release.
 
 
                      ***** Missing features *****
 
   The Windows version currently does not implement the following
   features known from the Linux release.
 
-    * IPv6. This will probably be in version 0.4.7.
+    * IPv6.
 
     * Link layer statistics.
 
     * WLAN interface detection. The Windows port does not recognize
       whether an interface is a WLAN interface or a wired LAN
 
     * Link layer statistics.
 
     * WLAN interface detection. The Windows port does not recognize
       whether an interface is a WLAN interface or a wired LAN
-      interface.  All specified interfaces are assumed to be WLAN
+      interface. All specified interfaces are assumed to be WLAN
       interfaces. So, for example, specifying a different HELLO
       interval for wired interfaces does not currently work. Instead,
       the HELLO interval for WLAN interfaces is always used.
 
     * Gateway tunnelling. This is currently experimental on
       Windows. It is intended to work reliably on Windows 2000 and
       interfaces. So, for example, specifying a different HELLO
       interval for wired interfaces does not currently work. Instead,
       the HELLO interval for WLAN interfaces is always used.
 
     * Gateway tunnelling. This is currently experimental on
       Windows. It is intended to work reliably on Windows 2000 and
-      Windows XP in version 0.4.7. It is based on the ipinip.sys
+      Windows XP in a later version. It is based on the ipinip.sys
       device driver that comes with these operating systems, but which
       is completely undocumented. I've figured out how to use the
       device driver, but it looks like I've still missed one or two
       device driver that comes with these operating systems, but which
       is completely undocumented. I've figured out how to use the
       device driver, but it looks like I've still missed one or two
@@ -146,23 +198,22 @@ this version is different from the original Linux version.
   There are also some Windows-specific features that I currently work
   on, but which have not made it into this release.
 
   There are also some Windows-specific features that I currently work
   on, but which have not made it into this release.
 
-    * A nice installation package based on Inno Setup 4. However,
-      there will always be a ZIP archive available, too, for those who
-      do not like installation packages.
+    * A nice installation package. However, there will always be a ZIP
+      archive available, too, for those who do not like installation
+      packages.
 
     * The option to run the OLSR server as a Windows service on
       Windows NT, 2000, and XP.
 
 
     * The option to run the OLSR server as a Windows service on
       Windows NT, 2000, and XP.
 
-  These features will probably be in 0.4.7.
 
                         ***** Compiling *****
 
 
                         ***** Compiling *****
 
-  To compile the Windows version you need a Cygwin installation with a
-  current version of GCC and Mingw32. Currently the OLSR server, the
-  GUI, and the dot_draw plugin compile. Each of the corresponding
-  subdirectories contains a shell script named "mkmf.sh" that takes
-  "Makefile.win32.in" as its input, appends the dependencies, and
-  outputs "Makefile.win32". Then simply say
+  To compile the Windows version of the OLSR server or the dot_draw
+  plugin you need a Cygwin installation with a current version of GCC
+  and Mingw32. Each of the corresponding subdirectories contains a
+  shell script named "mkmf.sh" that takes "Makefile.win32.in" as its
+  input, appends the dependencies, and outputs "Makefile.win32". Then
+  simply say
 
     make -f Makefile.win32 clean
 
 
     make -f Makefile.win32 clean
 
@@ -176,22 +227,15 @@ this version is different from the original Linux version.
 
   to compile the source code.
 
 
   to compile the source code.
 
-  To compile the GUI you additionally need the development packages of
-  the GTK+ Windows port. They are available from the same URL as the
-  GTK+ runtime environment. You need the following packages or newer
-  versions of these packages:
-
-    - atk-dev-1.6.0.zip
-    - glib-dev-2.4.5.zip
-    - gtk+-dev-2.4.7.zip
-    - pango-dev-1.4.1.zip
-
-  Simply unzip the files into a directory that you've created and make
-  the variable "GTKBASE" in "Makefile.win32" point to this directory.
+  The GUI has to be compiled with Visual C++ 6. Simply open the
+  "Frontend.dsw" workspace in the Visual C++ 6 IDE. Then compile
+  "Frontend" and "Shim", which creates "Switch.exe" and
+  "Shim.exe". Copy these two executables into the same directory as
+  "olsrd.exe" and you are ready to go.
 
 
-Well, thanks for using the initial release of a piece of software and
+Well, thanks for using an early release of a piece of software and
 please bear with me if there are any problems. Please do also feel
 free to suggest any features that you'd like to see in future
 releases.
 
 please bear with me if there are any problems. Please do also feel
 free to suggest any features that you'd like to see in future
 releases.
 
-Thomas Lopatic <thomas@lopatic.de>, 2004-08-24
+Thomas Lopatic <thomas@lopatic.de>, 2004-09-14