Merge tag 'v0.6.5.6'
authorFerry Huberts <ferry.huberts@pelagic.nl>
Mon, 2 Jun 2014 12:59:31 +0000 (14:59 +0200)
committerFerry Huberts <ferry.huberts@pelagic.nl>
Mon, 2 Jun 2014 12:59:31 +0000 (14:59 +0200)
OLSRd release 0.6.5.6

* tag 'v0.6.5.6':
  Release v0.6.5.6
  Fix strange coding in the 'long headers' fix
  jsoninfo: HTTP headers with CORS (if requested)
  Hotfix for very long http headers also for jsoninfo
  Hotfix for much too long http headers
  Fix some spelling mistakes
  Fix processing error for fragmented hellos
  neighbor table: fix crash in olsr_print_neighbor_table on MinGW
  tok: improve the nmea_calc_crc function a bit

Signed-off-by: Ferry Huberts <ferry.huberts@pelagic.nl>
172 files changed:
.gitignore
CHANGELOG
Makefile
Makefile.inc
README-Debian-package [new file with mode: 0644]
README-LINUX_NL80211.txt [new file with mode: 0644]
README-Olsr-Extensions
android/linux/if_tunnel.h
android/linux/ip6_tunnel.h
debian/.gitignore [deleted file]
debian/README.Debian [deleted file]
debian/changelog [deleted file]
debian/compat [deleted file]
debian/control [deleted file]
debian/copyright [deleted file]
debian/olsrd-default [deleted file]
debian/olsrd-plugins.dirs [deleted file]
debian/olsrd-plugins.docs [deleted file]
debian/olsrd.conf [deleted file]
debian/olsrd.dirs [deleted file]
debian/olsrd.docs [deleted file]
debian/olsrd.init [deleted file]
debian/olsrd.postinst [deleted file]
debian/rules [deleted file]
debian/todo [deleted file]
doc/Makefile
doc/SmartGateway/.gitignore [new file with mode: 0644]
doc/SmartGateway/SmartGatewayCost.gnuplot [new file with mode: 0644]
doc/SmartGateway/watchAndPlot.bash [new file with mode: 0755]
files/olsrd.conf.commotion
files/olsrd.conf.default.full
files/olsrd.conf.default.lq
files/olsrd.conf.default.lq-fisheye
files/olsrd.ufw.profile [new file with mode: 0644]
files/sgw_policy_routing_setup.sh [new file with mode: 0755]
gui/linux-gtk/Makefile
gui/win32/Inst/installer.nsi
gui/win32/Inst/linux-manual.txt
gui/win32/Main/Frontend.rc
lib/arprefresh/README_ARPREFRESH
lib/arprefresh/src/olsrd_arprefresh.c
lib/bmf/Makefile
lib/bmf/README_BMF
lib/dot_draw/README_DOT_DRAW
lib/dyn_gw/Makefile
lib/dyn_gw/src/olsrd_dyn_gw.c
lib/httpinfo/src/olsrd_httpinfo.c
lib/jsoninfo/README_JSONINFO
lib/jsoninfo/src/olsrd_jsoninfo.c
lib/mdns/Makefile
lib/mdns/src/NetworkInterfaces.c
lib/mdns/src/RouterElection.c
lib/mdns/src/container_of.h
lib/mdns/src/mdns.c
lib/mini/README_MINI
lib/nameservice/README_NAMESERVICE
lib/p2pd/Makefile
lib/p2pd/README
lib/p2pd/src/olsrd_plugin.c
lib/p2pd/src/p2pd.c
lib/p2pd/src/p2pd.h
lib/pgraph/README_PGRAPH
lib/pud/Makefile
lib/pud/Makefile.inc
lib/pud/doc/pud.odt
lib/pud/nmealib/COPYRIGHT [new file with mode: 0644]
lib/pud/nmealib/Makefile
lib/pud/nmealib/Makefile.inc
lib/pud/nmealib/doc/nmea.doxygen
lib/pud/nmealib/include/nmea/context.h
lib/pud/nmealib/include/nmea/conversions.h
lib/pud/nmealib/include/nmea/generate.h
lib/pud/nmealib/include/nmea/generator.h
lib/pud/nmealib/include/nmea/gmath.h
lib/pud/nmealib/include/nmea/info.h
lib/pud/nmealib/include/nmea/parse.h
lib/pud/nmealib/include/nmea/parser.h
lib/pud/nmealib/include/nmea/sentence.h
lib/pud/nmealib/include/nmea/tok.h
lib/pud/nmealib/samples/Makefile [deleted file]
lib/pud/nmealib/samples/generate/main.c [deleted file]
lib/pud/nmealib/samples/generator/main.c [deleted file]
lib/pud/nmealib/samples/math/main.c [deleted file]
lib/pud/nmealib/samples/parse/main.c [deleted file]
lib/pud/nmealib/samples/parse_file/gpslog.txt [deleted file]
lib/pud/nmealib/samples/parse_file/main.c [deleted file]
lib/pud/nmealib/src/context.c
lib/pud/nmealib/src/conversions.c
lib/pud/nmealib/src/generate.c
lib/pud/nmealib/src/generator.c
lib/pud/nmealib/src/gmath.c
lib/pud/nmealib/src/info.c
lib/pud/nmealib/src/parse.c
lib/pud/nmealib/src/parser.c
lib/pud/nmealib/src/sentence.c
lib/pud/nmealib/src/tok.c
lib/pud/olsrd.conf.sample
lib/pud/src/configTools.c
lib/pud/src/configTools.h
lib/pud/src/configuration.c
lib/pud/src/configuration.h
lib/pud/src/gpsConversion.c
lib/pud/src/netTools.c
lib/pud/src/netTools.h
lib/pud/src/posAvg.c
lib/pud/src/pud.c
lib/pud/src/pudOlsrdPlugin.h
lib/pud/src/receiver.c
lib/pud/src/uplinkGateway.c
lib/pud/wireformat-java/Makefile
lib/pud/wireformat-java/resources/WireFormatConstants.java.h
lib/pud/wireformat-java/resources/build.xml
lib/pud/wireformat-java/src/main/c/org_olsr_plugin_pud_PositionUpdate.c
lib/pud/wireformat-java/src/main/java/org/olsr/plugin/pud/PositionUpdate.java
lib/pud/wireformat/Makefile
lib/pud/wireformat/include/OlsrdPudWireFormat/nodeIdConversion.h
lib/pud/wireformat/include/OlsrdPudWireFormat/wireFormat.h
lib/pud/wireformat/src/nodeIdConversion.c
lib/pud/wireformat/src/wireFormat.c
lib/quagga/README_QUAGGA
lib/quagga/src/common.h
lib/quagga/src/plugin.c
lib/quagga/src/quagga.c
lib/sgwdynspeed/Makefile
lib/sgwdynspeed/src/speedFile.c
lib/txtinfo/README_TXTINFO
lib/txtinfo/src/olsrd_txtinfo.c
lib/watchdog/README_WATCHDOG
make/Makefile.android
make/Makefile.fbsd
make/Makefile.win32
make/getmingwversion.bash [new file with mode: 0755]
make/hash_source.sh
openwrt/olsrd-stable-git/Makefile
redhat/olsrd.spec
src/bsd/dummy.c
src/bsd/kernel_routes.c
src/builddata.h [new file with mode: 0644]
src/cfgparser/Makefile
src/cfgparser/cfgfile_gen.c
src/cfgparser/olsrd_conf.c
src/cfgparser/oparse.y
src/cfgparser/oscan.lex
src/common/autobuf.c
src/defs.h
src/gateway.c
src/gateway.h
src/gateway_costs.c [new file with mode: 0644]
src/gateway_costs.h [new file with mode: 0644]
src/gateway_default_handler.c
src/gateway_list.c [new file with mode: 0644]
src/gateway_list.h [new file with mode: 0644]
src/kernel_routes.h
src/kernel_tunnel.h
src/linux/kernel_routes_nl.c
src/linux/kernel_tunnel.c
src/lq_plugin_default_ff.c
src/lq_plugin_default_ffeth.c
src/main.c
src/olsr.c
src/olsr_cfg.h
src/olsr_switch/ohs_cmd.c
src/scheduler.c
src/unix/ifnet.c
src/win32/arpa/inet.h
src/win32/compat.c
src/win32/compat.h [new file with mode: 0644]
src/win32/compat/sys/time.h [moved from src/win32/sys/time.h with 97% similarity]
src/win32/dummy.c
unmaintained/README
unmaintained/README-Link-Quality-Fish-Eye.txt
unmaintained/README-Olsr-Switch.html

index e54968f..66e1cd0 100644 (file)
 /.project
 /.settings
 /build-stamp
+/builddata.txt
 /configure-stamp
+/debian/
 /olsrd
 /olsrd.exe
 /olsr_switch
 /olsr_switch.exe
-/olsr-setup.exe
\ No newline at end of file
+/olsr-setup.exe
+/src/cfgparser/olsrd_cfgparser
index 38251dd..a1d6233 100644 (file)
--- a/CHANGELOG
+++ b/CHANGELOG
@@ -1,3 +1,214 @@
+Note: In this release the pud plugin was upgraded to version 2.0.0.
+      This is because of a breaking change in its wire format. If you have
+      deployed the pud plugin on your mesh then you should update all nodes
+      to the new pud plugin at the same time since there is no interoperability
+      between the old version and the new version.
+
+0.6.6.1 -------------------------------------------------------------------
+
+Henning Rogge (2):
+      Update version after release of v0.6.6
+      Release v0.6.6.1
+
+Manuel Munz (1):
+      Fix jsoninfo again after a regression which was introduced with
+
+0.6.6 -------------------------------------------------------------------
+
+Bastian Bittorf (3):
+      [hotfix] plugin: httpinfo: in case of an unrecoverable error ("could not
+         initialize HTTP socket") exit for returnvalue != 0
+      plugin: dot_draw: readme: make it clear, that it only opens an
+         IPv4-socket, so a 'telnet ::1 2004' is not possible
+      plugin: dot_draw: readme: replaced a b0rken link
+
+Ferry Huberts (146):
+      Update version after branch of v0.6.5
+      gateway: store current gateway(s) in a struct
+      gateway: lazily allocate the current gateway structs
+      gateway: add path_cost to 'set gateway' interface
+      gateway: add interface to get the gateway costs
+      gateway: simplify by using the new costs interface
+      gateway: add gateway_list.{c,h}
+      gateway: keep track of the active gateways in a list
+      Merge branch 'release-0.6.5'
+      pud: java make target is dependent on library make target
+      Merge branch 'release-0.6.5'
+      Merge branch 'release-0.6.5'
+      json_info: only output smart gateway info on Linux
+      kernel_route: olsr_os_inetgw_tunnel_route can now take the table
+      gateway: let the gateway code determine the tunnel name
+      gateway: remove the worst gateway before adding new one
+      gateway: add SmartGatewayUseCount configuration parameter
+      gateway: use SmartGatewayUseCount setting the the gateway lists
+      gateway: add SmartGatewayEgressInterfaces configuration parameter
+      gateway: add SmartGatewayMarkOffset{Egress,Tunnels} configuration
+         parameters
+      gateway: add SmartGatewayPolicyRoutingScript configuration parameter
+      gateway: initialise a set of fixed tunnel names in/for multi-gateway mode
+      gateway: initialise the egress interface names in/for multi-gateway mode
+      gateway: use fixed tunnel names in/for multi-gateway mode
+      gateway: setup and clear table specific default routes in/for
+         multi-gateway mode
+      gateway: setup/cleanup multi-gateway mode during startup/shutdown of olsrd
+      gateway: introduce and use MULTI_GW_MODE define
+      gateway: enable multi-gateway mode
+      gateway: convert some defines into inline functions
+      kernel_route: olsr_os_inetgw_tunnel_route now needs the table explicitly
+      Merge branch 'multigw'
+      gateway: remove 2 superfluous asserts
+      gateway: add an assert to prevent an 'unused' warning
+      gateway: also adjust the IPv6 gateway list in olsr_update_gateway_entry
+      gateway: fix policy script permissions checking
+      gateway: the gateway policy script really is a bash script
+      gateway: minor indentation fixes in the gateway script
+      gateway: fix copy/paste mistake in setting up the egress rules
+      gateway: remove policy rules before adding them
+      gateway: ignore errors in remove-before-add rule removals
+      Revert "linux: name is required to be non-null in
+         olsr_os_cleanup_iptunnel"
+      gateway: do not show (bogus) errors
+      gateway: cleanup the server tunnel later
+      cfgparser: add SmartGatewayAlwaysRemoveServerTunnel configuration
+         parameter
+      gateway: use SmartGatewayAlwaysRemoveServerTunnel configuration parameter
+      gateway: fix a revert problem
+      gateway: use tnl_(4|6) tunnel names instead of tnl(4|6)_
+      gateway: properly set the egress interface names
+      json_info: do not loop forever on smart gateway egress interfaces
+      pud: the best uplink gateway is the same as the current (smart) gateway
+      pud: there is no hard dependency on smart gateway
+      pud: only forward downlinked messages when the smart gateway system is
+         enabled
+      pud: update documentation about smart gateway changes
+      gateway: fix 2 small typos in a comment
+      Revert "pud: the best uplink gateway is the same as the current (smart)
+         gateway"
+      pud: minor update resulting from the previous revert
+      pud: minor update to getBestUplinkGateway
+      gateway: minor improvement to get_unused_iptunnel_name
+      gateway: update some comments
+      gateway: remove 2 unneeded asserts
+      gateway: use standard macro to loop over the gateway tree in
+         olsr_cleanup_gateways
+      gateway: fix 'eligible' conditions in gw_default_choose_gateway
+      gateway: minor speed improvement in gw_default_choose_gateway
+      android: fix the path of the tunnel node in the /dev tree
+      pud: use the proper __ANDROID__ define
+      gateway: allow advertisement of zero bandwidth
+      gateway: add some comments
+      gateway: also set (update) the gateway when costs have changed
+      gateway: find_interfaceName only works in multi-gateway mode
+      gateway: simplify gw_default_calc_threshold
+      gateway: improve comments of gw_default_weigh_costs a bit
+      gateway: rename some variables to make it more readable
+      gateway: fix stable count dampening in gw_default_timer
+      gateway: do not use bitwise operators for logic conditions
+      gateway: reverse semantics of two variables
+      gateway: always select a new gateway when threshold != 0
+      main: add -pidfile command line option
+      main: fix pidfile compilation on windows
+      Merge branch 'release-0.6.5'
+      make: enable 32/64 bit cross compilation
+      pud: pull in nmealib v1.0.4
+      gateway: remove some 'unused' code from sgw script
+      make: fix typos in 'enable 32/64 bit cross compilation' commit
+      pud: enable 32/64 bit cross compilation for the java build
+      make: ifdef fixups
+      Merge branch 'release-0.6.5'
+      Merge branch 'release-0.6.5'
+      Merge branch 'release-0.6.5'
+      pud: detect the java include directory
+      dyn_gw: remove bogus include
+      make: fix a type in the Linux SUBDIRS assignment
+      make: add dyn_gw, mdns and p2pd to the Android SUBDIRS
+      pud: update nmealib 32/64 cross compilation
+      Revert "pud: update nmealib 32/64 cross compilation"
+      main: fix 2 minor warnings for win64 build on debian squeeze
+      make: only install sgw related files when sgw is supported
+      mdns: fix container_of pointer arith
+      mdns: don't use non-standard ushot type
+      mdns: fix three alignment warnings
+      mdns: supported on Android
+      p2pd: supported on Android
+      make: ensure win32 install respects DESTDIR
+      Merge branch 'release-0.6.5'
+      gateway: work around kernel IPIP module initialisation bug
+      gateway: fix overlap in success/fail IPIP tunnel init
+      doc: make the documentation generation commands a bit more verbose
+      pud: detect the java include directory
+      pud: better detection of java jdk
+      pud: better detection of java jdk
+      gateway: work around kernel IPIP module initialisation bug
+      Merge branch 'release-0.6.5'
+      PUD: nmealib: fix parsing of date in GPRMC
+      pud: nmealib: fixup the previous commit
+      main: use /dev/urandom by default
+      main: use /dev/urandom by default
+      pud: set local loopback for multicast tx
+      pud: set local loopback for multicast tx
+      Merge branch 'release-0.6.5'
+      arprefresh: fix some spelling
+      arprefresh: document the BPF program to make it readable
+      arprefresh: use the ARRAYSIZE macro
+      arprefresh: remove a comment
+      arprefresh: do not process IPv6 packets when in IPv4 mode
+      arprefresh: add a note about VLANs and IPv6
+      remove pthread usage as much as possible
+      Branch v0.6.6
+      Remove mercurial ignore file; we use git
+      build: ignore builddata.c when hashing sources
+      build: move build data into its own include file
+      gateway: always deal with 64bit scaled path costs
+      gateway: introduce and use removeGatewayFromList function
+      gateway: add SmartGatewayTakeDownPercentage configuration parameter
+      gateway: proactively take down 'expensive' gateways
+      release: fix the list of generated files
+      release: update some comments
+      release: refactor the checkVersionIncrementing function
+      release: do not update the version on master when it's already higher
+      release: only report that master changed when it was actually changed
+      release: checkVersionIncrementing: optionally allow equal versions
+      release: also check against the Makefile version when branching
+      txtinfo: prevent buffer overflow
+      pud: nmealib: _nmea_parse_time not parsing hsec when given "hhmmss" format
+      build: really _ignore_ builddata.c when hashing sources
+      build: only print the md5 hash in hash_source.sh
+      Makefile: fix builddata when building from tarball
+      pud: fix readIPAddress function
+
+Hans-Christoph Steiner (3):
+      GNU/Linux: add service profile for 'ufw' firewall package
+      update Commotion example olsrd.conf to represent current project state
+      dyn_gw/dyn_gw_plain require /proc, remove from default build on non-Linux
+
+Henning Rogge (7):
+      Fixed debug output of Scheduler polling interval
+      Fix multicast join for IPv6
+      Merge branch 'master' of http://olsr.org/git/olsrd
+      Update version after release of v0.6.5.2
+      Update version after release of v0.6.5.2
+      Fix build break for MinGW compilation on Fedora 19.
+      Release v0.6.6
+
+Ronald in 't Velt (1):
+      Fix setsockopt for setting Traffic Class in IPv6
+
+Saverio Proto (3):
+      main: fix the check on inet_pton return value because it returns 1 on
+         success.
+      mDNS: remove from Makefile PTHREAD useless dependency
+      txtinfo: update README file
+
+Scott Kidder (1):
+      jsoninfo: ensure output is wrapped in curly braces.
+
+Vasilis Tsiligiannis (1):
+      olsrd-quagga: Fix memory leak when adding and deleting routes
+
+equinox (1):
+      quagga plugin routes additional
+
 0.6.5.6 -------------------------------------------------------------------
 
 Alessio Caiazza (2):
index a5934cc..f35a020 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -39,7 +39,7 @@
 # Please also write a new version to:
 # gui/win32/Main/Frontend.rc (line 71, around "CAPTION [...]")
 # gui/win32/Inst/installer.nsi (line 57, around "MessageBox MB_YESNO [...]")
-VERS =         0.6.5.6
+VERS =         pre-0.6.7
 
 TOPDIR = .
 INSTALLOVERWRITE ?=
@@ -59,6 +59,15 @@ CFGDIR =     src/cfgparser
 include $(CFGDIR)/local.mk
 TAG_SRCS =     $(SRCS) $(HDRS) $(wildcard $(CFGDIR)/*.[ch] $(SWITCHDIR)/*.[ch])
 
+SGW_SUPPORT = 0
+ifeq ($(OS),linux)
+  SGW_SUPPORT = 1
+endif
+ifeq ($(OS),android)
+  SGW_SUPPORT = 1
+endif
+
+
 .PHONY: default_target switch
 default_target: $(EXENAME)
 
@@ -75,16 +84,15 @@ switch:
        $(MAKECMDPREFIX)$(MAKECMD) -C $(SWITCHDIR)
 
 # generate it always
-.PHONY: src/builddata.c
-src/builddata.c:
-       $(MAKECMDPREFIX)$(RM) "$@"
-       $(MAKECMDPREFIX)echo "#include \"defs.h\"" >> "$@" 
-       $(MAKECMDPREFIX)echo "const char olsrd_version[] = \"olsr.org -  $(VERS)`./make/hash_source.sh`\";"  >> "$@"
-       $(MAKECMDPREFIX)date +"const char build_date[] = \"%Y-%m-%d %H:%M:%S\";" >> "$@" 
-       $(MAKECMDPREFIX)echo "const char build_host[] = \"$(shell hostname)\";" >> "$@" 
+.PHONY: builddata.txt
+builddata.txt:
+       $(MAKECMDPREFIX)./make/hash_source.sh "$@" "$(VERS)" "$(VERBOSE)"
 
+# only overwrite it when it doesn't exists or when it has changed
+src/builddata.c: builddata.txt
+       $(MAKECMDPREFIX)if [ ! -f "$@" ] || [ -n "$$(diff "$<" "$@")" ]; then cp -p "$<" "$@"; fi
 
-.PHONY: help libs clean_libs libs_clean clean distclean uberclean install_libs uninstall_libs libs_install libs_uninstall install_bin uninstall_bin install_olsrd uninstall_olsrd install uninstall build_all install_all uninstall_all clean_all gui clean_gui 
+.PHONY: help libs clean_libs libs_clean clean distclean uberclean install_libs uninstall_libs libs_install libs_uninstall install_bin uninstall_bin install_olsrd uninstall_olsrd install uninstall build_all install_all uninstall_all clean_all gui clean_gui cfgparser_install cfgparser_clean
 
 clean:
        -rm -f $(OBJS) $(SRCS:%.c=%.d) $(EXENAME) $(EXENAME).exe src/builddata.c $(TMPFILES)
@@ -118,10 +126,24 @@ install: install_olsrd
 
 uninstall: uninstall_olsrd
 
+cfgparser_install: cfgparser
+               $(MAKECMDPREFIX)$(MAKECMD) -C $(CFGDIR) install
+
+cfgparser_clean:
+               $(MAKECMDPREFIX)$(MAKECMD) -C $(CFGDIR) clean
+
 install_bin:
                mkdir -p $(SBINDIR)
                install -m 755 $(EXENAME) $(SBINDIR)
                $(STRIP) $(SBINDIR)/$(EXENAME)
+ifeq ($(SGW_SUPPORT),1)
+               $(MAKECMDPREFIX)if [ -e $(SBINDIR)/$(SGW_POLICY_SCRIPT) ]; then \
+                       cp -f files/$(SGW_POLICY_SCRIPT) $(SBINDIR)/$(SGW_POLICY_SCRIPT).new; \
+                       echo "Policy routing script was saved as $(SBINDIR)/$(SGW_POLICY_SCRIPT).new"; \
+               else \
+                       cp -f files/$(SGW_POLICY_SCRIPT) $(SBINDIR)/$(SGW_POLICY_SCRIPT); \
+               fi
+endif
 
 uninstall_bin:
                rm -f $(SBINDIR)/$(EXENAME)
@@ -180,15 +202,15 @@ rpm:
 
 # This is quite ugly but at least it works
 ifeq ($(OS),linux)
-SUBDIRS = arprefresh bmf dot_draw dyn_gw dyn_gw_plain httpinfo jsoninfo mdns mini nameservice p2pd pgraph pud quagga secure sgwdynspeed txtinfo watchdog
+SUBDIRS := arprefresh bmf dot_draw dyn_gw dyn_gw_plain httpinfo jsoninfo mdns mini nameservice p2pd pgraph pud quagga secure sgwdynspeed txtinfo watchdog
 else
 ifeq ($(OS),win32)
 SUBDIRS := dot_draw httpinfo jsoninfo mini pgraph secure txtinfo
 else
 ifeq ($(OS),android)
-SUBDIRS := arprefresh bmf dot_draw dyn_gw_plain httpinfo jsoninfo mini nameservice pgraph pud secure sgwdynspeed txtinfo watchdog
+SUBDIRS := arprefresh bmf dot_draw dyn_gw dyn_gw_plain httpinfo jsoninfo mdns mini nameservice p2pd pgraph pud secure sgwdynspeed txtinfo watchdog
 else
-SUBDIRS := dot_draw dyn_gw dyn_gw_plain httpinfo jsoninfo mini nameservice pgraph secure txtinfo watchdog
+SUBDIRS := dot_draw httpinfo jsoninfo mini nameservice pgraph secure txtinfo watchdog
 endif
 endif
 endif
index 9ef9881..dc1122c 100644 (file)
@@ -57,7 +57,7 @@ TAGCMD ?=     etags
 
 # target directories and names
 DESTDIR  ?=
-ETCDIR   ?= $(DESTDIR)/etc
+ETCDIR   ?= $(DESTDIR)/etc/olsrd
 USRDIR   ?= $(DESTDIR)/usr
 INCLUDEDIR ?= $(DESTDIR)/usr/include
 LIBDIR   ?= $(USRDIR)/lib
@@ -68,6 +68,7 @@ MANDIR   ?= $(SHAREDIR)/man
 EXENAME  ?= olsrd
 CFGNAME  ?= $(EXENAME).conf
 CFGFILE  ?= $(ETCDIR)/$(CFGNAME)
+SGW_POLICY_SCRIPT ?= sgw_policy_routing_setup.sh
 
 DOCDIR_OLSRD ?= $(DOCDIR)/$(EXENAME)
 
@@ -97,7 +98,9 @@ WARNINGS +=   -Wendif-labels
 WARNINGS +=    -Wwrite-strings
 WARNINGS +=    -Wbad-function-cast
 WARNINGS +=    -Wpointer-arith
+ifneq ($(OS),win32)
 WARNINGS +=    -Wcast-qual
+endif
 WARNINGS +=    -Wshadow
 WARNINGS +=    -Wformat
 WARNINGS +=    -Wsequence-point
@@ -150,8 +153,6 @@ CFLAGS +=   $(WARNINGS)
 CFLAGS +=      $(OPTIMIZE)
 CFLAGS +=      $(EXTRA_CFLAGS)
 
-# Must be specified along with -lpthread on linux
-CPPFLAGS +=    $(OS_CFLAG_PTHREAD)
 endif
 ifneq ($(MUDFLAP),0)
 CFLAGS +=      -fmudflapth
@@ -184,11 +185,22 @@ LDFLAGS +=        -Wl,--warn-common
 ifneq ($(MUDFLAP),0)
 LIBS +=                -lmudflapth
 endif
-LIBS +=                $(OS_LIB_PTHREAD)
 
 # extra options from the outside
 CPPFLAGS +=    $(EXTRA_CPPFLAGS)
 
+
+# 32/64 cross compilation
+ifdef M32
+CFLAGS +=      -m32
+LDFLAGS +=     -m32
+endif
+ifdef M64
+CFLAGS +=      -m64
+LDFLAGS +=     -m64
+endif
+
+
 ###################################
 #
 # options to save space on small systems
@@ -218,6 +230,9 @@ OBJS +=             $(SRCS:%.c=%.o)
 ifeq ($(DEBUG),1)
 CPPFLAGS +=    -DDEBUG
 CFLAGS +=      -ggdb
+ifeq ($(OS),linux)
+LDFLAGS  += -rdynamic
+endif
 else
 CPPFLAGS +=    -DNDEBUG
 ifeq ($(OPTIMIZE),)
diff --git a/README-Debian-package b/README-Debian-package
new file mode 100644 (file)
index 0000000..2d98790
--- /dev/null
@@ -0,0 +1,28 @@
+
+If you want to build the Debian packages from the latest git source, here is
+how to do it:
+
+First, get the latest debian/ folder from Subversion, which contains all the
+files needed to build the Debian package, then run dpkg-buildpackage:
+
+  sudo apt-get install build-essential dpkg-dev
+  git clone http://olsr.org/git/olsrd.git
+  cd olsrd
+  svn checkout svn://svn.debian.org/svn/collab-maint/deb-maint/olsrd/trunk/debian
+  echo "1.0" > debian/source/format
+  dpkg-buildpackage -uc -us
+  ls -l ../olsrd*.*
+
+If you want the package to have the proper version, then you'll need to edit
+the debian/changelog file.  Just change the version number on the top-most
+line of debian/changelog.
+
+You can also find the latest tarballs of the debian/ folder here, look on the
+right column under "Download Source Package olsrd":
+http://packages.debian.org/source/sid/olsrd
+
+e.g.
+http://ftp.debian.org/debian/pool/main/o/olsrd/olsrd_0.6.3-6.debian.tar.gz
+
+You can find complete developer info here:
+http://packages.qa.debian.org/o/olsrd.html
diff --git a/README-LINUX_NL80211.txt b/README-LINUX_NL80211.txt
new file mode 100644 (file)
index 0000000..55fca68
--- /dev/null
@@ -0,0 +1,62 @@
+Abstract
+==========================================================================
+This document describes the OLSRd link quality extension that utilizes
+linux NL80211 to apply wireless link information in the link quality
+calculation.
+
+Design
+==========================================================================
+Each second the latest information is gathered from linux NL80211. This
+data contains the MAC addresses of the neighbor stations. To match this
+MAC address with the neighbors IP, the linux ARP cache is queried.
+
+Implementation
+==========================================================================
+The extension adds an external dependency to build the code namely libnl.
+This library is used to simplify the IPC communication with linux kernel.
+
+The files src/linux/nl80211_link_info.* are doing the actual wireless link
+status gathering. A modified link ffeth quality plugin will use the new
+link status information for link quality calculations. This link quality
+plugin is using #ifdef LINUX_NL80211 statements as much as possible to
+make it easy to merge the code back into the original ffeth plugin. The
+benefit of merging those link quality plugins will be less duplicate code
+and less code to maintain.
+
+Cost calculation
+==========================================================================
+A penalty is added to the old cost from the ffeth plugin, depending on the
+signal strength and the link bandwidth. Both penalties can have a maximum
+value of 1.0.
+
+Costs = EXT + BandwidthPenalty + SignalPenalty
+
+BandwidthPenalty = 1 - ( ActualBandwidth / ReferenceBandwidth)
+
+SignalPenalty = LookupSignalPenaltyTable(SignalStrenghtOfNeighbor)
+
+Both penalties are added into the two unused bytes of LQ_HELLO messages.
+Currently the nodes won't use this value when received from their neighbor
+and only use their own NL80211 information.
+
+Considerations
+==========================================================================
+It is designed mainly for IPv4, but should work with minimal effort on
+IPv6 as well. Majority of that work will be actually testing it on IPv6.
+
+The netlink code is blocking, this shouldn't cause major problems but a
+more ideal design would be non-blocking.
+
+Current version does not use the NL80211 data received from it's neighbors.
+A discussion is needed to find out if this is required or not.
+
+Currently both penalties have a maximum of 1.0, which might not be enough.
+If that's the case, a configurable multiplier for both penalties might be
+interesting to add.
+
+The value for ReferenceBandwidth is hardcoded to 54 MBit.
+The values in the signal strength penalty table are hardcoded.
+It's desirable to have them configurable through the configuration file.
+
+Add configuration option to completely disable the use of NL80211 data, in
+case the plugin is merged with the existing ff_eth link quality plugin.
\ No newline at end of file
index ac244cf..103fb46 100644 (file)
@@ -251,20 +251,50 @@ All other parameters will be ignored if SmartGateway is set to "no"
 
     5.2) Client Side
 
-1- SmartGatewayAllowNAT controls whether you want to allow the selection
+1- SmartGatewayUseCount controls the maximum number of gateways that can be
+   in use at any given time. This setting is used to mitigate the effects of
+   breaking connections (due to the selection of a new gateway) on a dynamic
+   network.
+   The default setting is 1.
+2- SmartGatewayTakeDownPercentage determines the take-down percentage for a
+   non-current smart gateway tunnel. If the cost of the current smart gateway
+   tunnel is less than this percentage of the cost of the non-current smart
+   gateway tunnel, then the non-current smart gateway tunnel is taken down
+   because it is then presumed to be 'too expensive'.
+   This setting is only relevant when SmartGatewayUseCount is larger than 1;
+   a value of 0 will result in the tunnels not being taken down proactively.
+   The default setting is 0.
+3- SmartGatewayPolicyRoutingScript controls the policy routing script that is
+   executed during startup and shutdown of olsrd. The script is only executed
+   when SmartGatewayUseCount is set to a value larger than 1. The script must
+   setup policy routing rules such that multi-gateway mode works. A reference
+   script is included.
+   The default setting is <not set>.
+4- SmartGatewayEgressInterfaces determines the egress interfaces that are part
+   of the multi-gateway setup and therefore only relevant when
+   SmartGatewayUseCount is larger than 1 (in which case it must be explicitly
+   set).
+   The default setting is <not set>.
+5- SmartGatewayTablesOffset and SmartGatewayRulesOffset determine the ranges of
+   policy routing rule markings that are used in a multi-gateway setup (see the
+   policy routing script for an explanation).
+   The default settings are 90 and 0 respectively. The value of 0 for
+   SmartGatewayRulesOffset will automatically align the table and rule numbers
+   for the server tunnel, egress interfaces and gateway tunnel interfaces.
+6- SmartGatewayAllowNAT controls whether you want to allow the selection
    of an outgoing ipv4 gateway with NAT (Network Address Translation).
    The default setting is "yes".
-2- SmartGatewayPeriod determines the period (in milliseconds) on which
+7- SmartGatewayPeriod determines the period (in milliseconds) on which
    a new smart gateway selection is performed.
    The default setting is 10000 milliseconds.
-3- SmartGatewayStableCount determines the number of times the link state
+8- SmartGatewayStableCount determines the number of times the link state
    database must be stable before a new smart gateway is selected.
    The default setting is 6.
-4- SmartGatewayThreshold controls whether you want to allow re-selection
+9- SmartGatewayThreshold controls whether you want to allow re-selection
    of a new outgoing gateway if its routing cost is lower or equal to the
    configured percentage of the routing cost of the current gateway.
    The default setting is 0, which disables it.
-5- SmartGatewayWeightExitLinkUp, SmartGatewayWeightExitLinkDown,
+10-SmartGatewayWeightExitLinkUp, SmartGatewayWeightExitLinkDown,
    SmartGatewayWeightEtx and SmartGatewayDividerEtx control the weighing
    of gateway bandwidth and ETX costs.
 
@@ -309,10 +339,12 @@ All other parameters will be ignored if SmartGateway is set to "no"
 
      ** Recommended Configuration Parameter Settings
      ===============================================
-     SmartGatewayWeightExitLinkUp   = 1 (default is 1)
-     SmartGatewayWeightExitLinkDown = 1 (default is 1)
-     SmartGatewayWeightEtx          = 1 (default is 1)
-     SmartGatewayDividerEtx         = 4 (default is 0)
+     (assuming LinkQualityAlgorithm "etx_ffeth")
+
+     SmartGatewayWeightExitLinkUp   = 1    (default is 1)
+     SmartGatewayWeightExitLinkDown = 1    (default is 1)
+     SmartGatewayWeightEtx          = 1    (default is 1)
+     SmartGatewayDividerEtx         = 4096 (default is 0)
 
 
     5.3) Uplink Side
@@ -331,6 +363,9 @@ All other parameters will be ignored if SmartGateway is set to "no"
    local IPv6 address to use the IPv6 gateway without any kind of address
    translation. The maximum prefix length is 64 bits,
    the default is ::/0 (no prefix).
+5- SmartGatewayAlwaysRemoveServerTunnel can be used to signal that the
+   server tunnel must always be removed on shutdown, irrespective of the
+   interface up/down state during startup.
 
 
     5.4) Architecture & Notes
index a1acfa9..b522a06 100644 (file)
@@ -3,6 +3,7 @@
 
 #include <linux/types.h>
 #include <asm/byteorder.h>
+#include <net/if.h>
 
 #ifdef __KERNEL__
 #include <linux/ip.h>
index 9bcc323..b3597d7 100644 (file)
@@ -2,6 +2,7 @@
 #define _IP6_TUNNEL_H
 
 #include <linux/types.h>
+#include <net/if.h>
 
 #define IPV6_TLV_TNL_ENCAP_LIMIT 4
 #define IPV6_DEFAULT_TNL_ENCAP_LIMIT 4
diff --git a/debian/.gitignore b/debian/.gitignore
deleted file mode 100644 (file)
index a650178..0000000
+++ /dev/null
@@ -1,10 +0,0 @@
-/olsrd/
-/olsrd-plugins/
-/olsrd-plugins.debhelper.log
-/olsrd.debhelper.log
-/files
-/olsrd-plugins.substvars
-/olsrd.postinst.debhelper
-/olsrd.postrm.debhelper
-/olsrd.prerm.debhelper
-/olsrd.substvars
\ No newline at end of file
diff --git a/debian/README.Debian b/debian/README.Debian
deleted file mode 100644 (file)
index 93a8115..0000000
+++ /dev/null
@@ -1,78 +0,0 @@
-olsrd for Debian
-----------------
-
-
-Configuration
--------------
-
-Before running olsrd you must edit the default configuration file
-/etc/olsrd/olsrd.conf (the location differs in the debian package from the 
-upstream default /etc/olsrd.conf). The one change you must make is to define
-on which interfaces olsrd is supposed to act on.
-
-If you want, you can run olsrd via init.d by editing /etc/default/olsrd - the
-default configuration is to not start olsrd on boot. It needs root privileges
-to run olsrd. 
-
-To debug olsrd you can start it with "/etc/init.d/olsrd start debug".
-
-You also need to configure your network interface. For example, for 
-freifunk.hamburg.net the following settings are used:
-
-       ifconfig eth1 $YOUR_IP broadcast 10.127.255.255
-       iwconfig eth1 essid hamburg.freifunk.net channel 10 mode ad-hoc enc off
-
-Options in the olsrd config file can also be overridden by command line
-options or in /etc/default/olsrd. See the manual pages olsrd(8) and 
-olsrd.conf(5) for details.
-
-If debug level is set to 0 olsrd will detach and run in the background (this 
-is the default in the debian package), if not it will keep running in your 
-shell.
-
-
-Plugins
--------
-
-The following plugins are included in the olsrd-plugins package and are 
-explained in detail in /usr/share/doc/olsrd-plugins:
-
-- httpinfo     - tiny webserver for information purposes 
-- dyn_gw       - dynamically announce uplinks
-- dot_draw     - generates output (over a TCP socket) in the dot format
-- secure       - secure OLSR routing with a shared key
-- nameservice  - announce hostnames and dns servers
-- bmf          - basic multicast forwarding plugin for olsrd
-- txtinfo
-
-The following plugins are not included in the olsrd-plugins binary package:
-
-- quagga       - quagga plugin
-- powerinfo    - displays /proc/apm on 127.0.0.1:8888
-- pgraph       - obsoleted by httpinfo and dot-draw
-- mini         - minimal example plugin, useful as a howto for writing plugins
-
-If you need them, you can easily build them from the debian source package 
-yourself: define which (additional) plugins you want in debian/rules, and 
-rebuild the package. And if you tell me a good reason why they should be 
-included in the binary package, I'll be glad to add them :)
-
-
-About this package
-------------------
-
-This is actually the unik-olsrd implementation, but because it's the only 
-commonly used one (the other two, nrl- and inria-olsrd are mostly used 
-where they were written) and the one found on www.olsr.org, so I decided to 
-call the package olsrd.
-
-The config file shipped in /etc/olsrd/olsrd.conf is based on the one from
-http://olsrexperiment.de/sven-ola/nylon/packages/olsrd/files/olsrd.conf-sven-ola 
-and has been successfully used in the freifunk networks in Berlin and Hamburg
-(Germany).
-
-The plugins are installed in /usr/lib/olsrd/ which differs from the upstream 
-default /usr/lib/.
-
-
- -- Holger Levsen <holger@debian.org>  Tue,  8 Jul 2008 18:09:15 +0200
diff --git a/debian/changelog b/debian/changelog
deleted file mode 100644 (file)
index 87ca478..0000000
+++ /dev/null
@@ -1,227 +0,0 @@
-olsrd (0.6.1-1) UNRELEASED; urgency=low
-
-  * New upstream version with quite some fixes and new features, see upstream
-    changelog for details. Quoting from there:
-     Change in version number system. No more -rcX for release candidates and
-     -rX for bugfix releases. In future bugfix releases or updates of plugins
-     will increase the third digit of the version string while feature 
-     releases will increase the first and/or the second one.
-   Removed the following patches from series trying to make it build again:
-   - 100-debug_level.patch
-   - 240-plugin-install-targets.patch
-   - 260-quagga-plugin-detect-protocol-version.patch
-   - 270-make-kfbsd.patch
-   
-  THIS IS WORK IN PROGRESS and needs checking whether those patches are still
-  needed. Also 0.6.1 is out.
-
-  * Update package description, OLSR is no experimental protocol anymore. 
-
- -- Holger Levsen <holger@debian.org>  Fri, 21 May 2010 23:47:52 +0200
-
-olsrd (0.5.6-r8-1) unstable; urgency=low
-
-  * New upstream version, the eighth maintenance release of 0.5.6, introducing
-    options to set the source and destination IP of the OLSR packets and a 
-    more flexible handling config handling as well as some bug fixes including
-    memory leaks.
-
- -- Holger Levsen <holger@debian.org>  Wed, 20 Jan 2010 01:13:43 +0000
-
-olsrd (0.5.6-r7-1) unstable; urgency=low
-
-  * New upstream version, the seventh maintenance release of 0.5.6, with some
-    improvements in the ETX-FFmetric and new stabilization patches for the 
-    route generation.
-
- -- Holger Levsen <holger@debian.org>  Wed, 11 Nov 2009 17:53:26 +0100
-
-olsrd (0.5.6-r6-3) unstable; urgency=low
-
-  * Brown paper bag release: add 270-make-kfbsd.patch to debian/patches/series
-    so it actually gets applied. (Closes: #544758)
-
- -- Holger Levsen <holger@debian.org>  Mon, 19 Oct 2009 11:31:38 +0200
-
-olsrd (0.5.6-r6-2) unstable; urgency=low
-
-  * Do not override the general setting in Makefile.kfbsd to "honor DESTDIR 
-    in make install". Thanks to Petr Salinger for the patch. (Closes: #544758)
-
- -- Holger Levsen <holger@debian.org>  Sat, 17 Oct 2009 13:00:41 +0000
-
-olsrd (0.5.6-r6-1) unstable; urgency=low
-
-  * New upstream version, the sixth maintenance release of 0.5.6, adding
-    support for Debian kfreebsd (Closes: #544758) and including fixes for
-    httpinfo, txtinfo and dotdraw plugin to prevent them blocking in case of
-    timed out outgoing connections. 
-    Drop 250-dot-draw-plugin-honor-accept-parameter.patch as it has been
-    included in the new upstream release.
-  * Fix incorrect runlevels and dependencies in init.d LSB header, thanks to
-    Petter Reinholdtsen for spotting the issues and providing the patch.
-    (Closes: #548607)
-  * Bump standards version to 3.8.3, no changes necessary.
-
- -- Holger Levsen <holger@debian.org>  Sat, 10 Oct 2009 14:55:37 +0200
-
-olsrd (0.5.6-r5-1) unstable; urgency=low
-
-  * New upstream version, the fifth maintenance release of 0.5.6.
-  * Add patch by Sebastian Harl to add a listen parameter to the dot_draw
-    plugin. (Closes: #532573) - Thanks, Sebastian! 
-  * Re-enable quagga plugin. Since olsrd is licenced under the 3 clause BSD 
-    licence and quagga is GPL-2 code, the resuling binary is GPL-2 licenced
-    too, and thats fine. (Closes: #532761)
-    Add patch by Florian Forster to determine quagga protocol version - thanks
-    Florian!
-  * Add descriptions of quagga, bmf and txtinfo plugins to package 
-    description. (Closes: #532765)
-  * Bump standards version to 3.8.2.
-  * Update years in debian/copyright.
-
- -- Holger Levsen <holger@debian.org>  Tue, 04 Aug 2009 12:10:35 +0000
-
-olsrd (0.5.6-r4-1) unstable; urgency=low
-
-  * New upstream version, the fourth maintenance release of 0.5.6.
-  * olsrd.init: 
-    - do not write the pidfile until olsrd has actually been started
-      (Closes: #519842) - thanks to Sebastian Reichel for the bug report!
-    - only start olsrd if it is not already running. 
-  * Bump standards-version to 3.8.1.
-
- -- Holger Levsen <holger@debian.org>  Sat, 30 May 2009 09:14:27 +0000
-
-olsrd (0.5.6-r3-1) unstable; urgency=low
-
-  * New upstream release, the third maintenance release of 0.5.6.
-  * Adopt debian/patches/200-etc-olsrd.patch to cope with the whitespace
-    changes in the new release.
-
- -- Holger Levsen <holger@debian.org>  Sat, 14 Mar 2009 18:31:55 +0100
-
-olsrd (0.5.6~rc7-1) unstable; urgency=low
-
-  * New upstream release candidate.
-  * Use a PID file. (Closes: #484128)
-  * Bump standards-version to 3.8.0, no changes needed.
-  * Install the plugins into /usr/lib/olsrd/, to get rid off all the lintian
-    overrides. Adapted README.Debian to reflect that.
-  * Compile the source without DESTDIR, just install it to DESTDIR.
-  * Modify the plugin targets in the upstream Makefile to provide distinct
-    $pluginname_install targets, otherwise DESTDIR shows up in rpath. 
-  * Drop debian/patches/210-txtinfo-Makefile.patch as it has been adapted by
-    upstream.
-
- -- Holger Levsen <holger@debian.org>  Sat, 12 Jul 2008 16:38:15 +0000
-
-olsrd (0.5.5-3) unstable; urgency=low
-
-  * No longer work around a bug in debhelper (#470913) in debian/rules,
-    which was introduced in 0.5.5-2 to fix #471627. Due to this, it's also not
-    necessary to manually uncompress and compress some manpages, as debhelper
-    now handles this as well.
-
- -- Holger Levsen <holger@debian.org>  Wed,  2 Apr 2008 13:06:27 +0200
-
-olsrd (0.5.5-2) unstable; urgency=low
-
-  * update debian/copyright to clarify that src/cfgparser/oparse.(c|h)
-    has a special exception which allows distributing it under other
-    conditions than the GPL in special cases
-  * fix handling of zipped manpages (Closes: #471627)
-  * remove the quagga plugin from the binary package, as it is GPL licenced
-    and cannot be distributed together with the BSD licenced olsrd 
-  * remove linda overwrites as linda is deprecated
-  * updated lintian overwrites
-
- -- Holger Levsen <holger@debian.org>  Mon, 31 Mar 2008 08:50:25 +0000
-
-olsrd (0.5.5-1) unstable; urgency=low
-
-  * new upstream version
-  * removed unused lintian overwrites
-  * upgraded to policy 3.7.3, no changes requiered
-  * made debian/copyright machine readable following
-    http://wiki.debian.org/Proposals/CopyrightFormat and converted it to utf8
-  * patch upstream Makefile to use /usr/lib on amd64
-    (Closes: #461604)
-
- -- Holger Levsen <holger@debian.org>  Sat, 09 Feb 2008 09:39:28 +0000
-
-olsrd (0.5.4-2) unstable; urgency=low
-
-  * clean up olsrd makefile, fix a very annoying dependency bug in the olsrd
-    build system (Closes: #452100) - taken from OpenWRT, thanks to Felix
-    Fietkau 
-
- -- Holger Levsen <holger@debian.org>  Tue, 20 Nov 2007 14:26:34 +0100
-
-olsrd (0.5.4-1) unstable; urgency=low
-
-  * new upstream version
-  * add Homepage and Vcs-* headers to debian/control
-  * olsrd.conf: small improvements as suggested by Jens Nachtigall - Thanks!
-
- -- Holger Levsen <holger@debian.org>  Fri, 16 Nov 2007 12:02:21 +0000
-
-olsrd (0.5.3-3) unstable; urgency=low
-
-  * Undefine STRIP when running make install and instead use dh_strip so that 
-    DEB_BUILD_OPTIONS=nostrip can be used (Closes: #437676) 
-
- -- Holger Levsen <holger@debian.org>  Sat, 18 Aug 2007 23:06:02 +0200
-
-olsrd (0.5.3-2) unstable; urgency=low
-
-  * improved olsrd.conf settings (Thanks elektra!) and made olsrd quiet on 
-    default
-
- -- Holger Levsen <holger@debian.org>  Sun, 12 Aug 2007 19:38:19 +0200
-
-olsrd (0.5.3-1) unstable; urgency=low
-
-  * new upstream version (Closes: #404899, #405331)
-  * include bmf, quagga and txtinfo plugins in binary package
-
- -- Holger Levsen <holger@debian.org>  Sun,  5 Aug 2007 01:49:19 +0200
-
-olsrd (0.5.2-1) unstable; urgency=low
-
-  * new upstream release (Closes: #426580)
-  * added build-dependency on bison and flex
-  * removed dependency on libpthread2 (Closes: #412752)
-  * maintainer address updated
-  * updated README.Debian
-  * cleaned up debian/patches/ (from openwrt) as they are included
-    upstream by now
-  * added debian/todo in source
-  * make init-script exit gracefully if stopping olsrd fails (Closes: #412936)
-
- -- Holger Levsen <holger@debian.org>  Wed,  1 Aug 2007 00:58:23 +0200
-
-olsrd (0.4.10-3) unstable; urgency=low
-
-  * improved Makefile clean target to allow rebuilds
-  * fixed and improved broken /etc/default/olsrd and /etc/init.d/olsrd
-  * improved README.Debian and olsrd.conf
-
- -- Holger Levsen <debian@layer-acht.org>  Wed, 20 Dec 2006 22:57:21 +0000
-
-olsrd (0.4.10-2) unstable; urgency=low
-
-  * fix debian/copyright (gui/linux-gtk is GPL licenced, not BSD like the rest)
-  * upgraded debian/compat debhelper source-depends version to 5 (as it's enough 
-    if 0.4.10-1 builds on sarge without changes)
-  * use ${binary:Version} format for olsrd-plugins depends on olsrd, for the
-    same reason
-
- -- Holger Levsen <debian@layer-acht.org>  Sun, 17 Dec 2006 18:51:00 +0000
-
-olsrd (0.4.10-1) unstable; urgency=low
-
-  * Initial release (Closes: #401307, #243527)
-
- -- Holger Levsen <debian@layer-acht.org>  Sat,  9 Dec 2006 17:04:26 +0000
-
diff --git a/debian/compat b/debian/compat
deleted file mode 100644 (file)
index 7ed6ff8..0000000
+++ /dev/null
@@ -1 +0,0 @@
-5
diff --git a/debian/control b/debian/control
deleted file mode 100644 (file)
index 287f860..0000000
+++ /dev/null
@@ -1,40 +0,0 @@
-Source: olsrd
-Section: net
-Priority: extra
-Maintainer: Holger Levsen <holger@debian.org>
-Build-Depends: debhelper (>= 5), quilt, bison, flex
-Standards-Version: 3.8.3
-Homepage: http://olsr.org/
-Vcs-Svn: svn://svn.debian.org/svn/collab-maint/deb-maint/olsrd/
-Vcs-Browser: http://svn.debian.org/wsvn/collab-maint/deb-maint/olsrd/
-
-Package: olsrd
-Architecture: any
-Depends: ${shlibs:Depends}, ${misc:Depends}
-Description: optimized link-state routing daemon (unik-olsrd)
- unik-olsrd is an implementation of the Optimized Link State Routing protocol 
- for Mobile Ad-Hoc networks(MANET). The protocol is described in RFC3626. It 
- is designed to be run as a standalone server process.
- .
- OLSR operates as a table driven, proactive protocol, i.e., it exchanges 
- topology information with other nodes of the network regularly. It is 
- developed to work independently from other protocols. Likewise, OLSR makes no
- assumptions about the underlying link-layer.
-
-Package: olsrd-plugins
-Architecture: any
-Depends: ${shlibs:Depends}, ${misc:Depends}, olsrd (= ${binary:Version})
-Description: various plugins to enhance olsrd
- olsrd is an implementation of the Optimized Link State Routing protocol
- for Mobile Ad-Hoc networks(MANET)
- .
- The following plugins are available:
- .
-  * httpinfo      - tiny webserver for information purposes 
-  * dyn_gw        - dynamically announce uplinks
-  * dot_draw      - generates output (over a TCP socket) in the dot format
-  * secure        - secure OLSR routing with a shared key
-  * nameservice   - announce hostnames and dns servers
-  * bmf           - basic multicast forwarding
-  * quagga        - import external routes from quagga
-  * txtinfo       - display information about the OSLR node
diff --git a/debian/copyright b/debian/copyright
deleted file mode 100644 (file)
index 4fb358c..0000000
+++ /dev/null
@@ -1,153 +0,0 @@
-This package was downloaded from http://www.olsr.org/releases/
-
-Files: debian/*
-Copyright: © 2006-2009 Holger Levsen <holger@debian.org>
-Licence: GPL-2+
- The Debian packaging 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, or (at your option)
- any later version.
- On Debian systems, the full text of the GPL-2+ is available at
- /usr/share/common-licenses/GPL-2
-
-Files: *
-Copyright: © 2003-2005 Andreas Tønnesen <andreto@olsr.org>, 2004 Thomas Lopatic 
- <thomas@lopatic.de>, 2006, 2007 Sven-Ola <sven-ola-aet-gmx.de>, 2005, Bruno Randolf <bruno.randolf@4g-systems.biz>, 2007 Bernd Petrovitsch <bernd@firmix.at> and 
- 2006 Jens Nachtigall <nachtigall@web.de>
-Licence: BSD-3
- | All rights reserved.
- |
- | Redistribution and use in source and binary forms, with or without 
- | modification, are permitted provided that the following conditions 
- | are met:
- |
- | * Redistributions of source code must retain the above copyright 
- |   notice, this list of conditions and the following disclaimer.
- | * Redistributions in binary form must reproduce the above copyright 
- |   notice, this list of conditions and the following disclaimer in 
- |   the documentation and/or other materials provided with the 
- |   distribution.
- | * Neither the name of olsr.org, olsrd nor the names of its 
- |   contributors may be used to endorse or promote products derived 
- |   from this software without specific prior written permission.
- |
- | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
- | "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
- | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
- | FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
- | COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
- | INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
- | BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
- | LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
- | CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
- | LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
- | ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
- | POSSIBILITY OF SUCH DAMAGE.
-
-Files: gui/linux-gtk/*
-Copyright: © 2003 Andreas Tønnesen (andreto@ifi.uio.no)
-Licence: GPL-2+
- olsrd/gui/linux-gtk 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, or (at your option)
- any later version.
- On Debian systems, the full text of the GPL-2+ is available at
- /usr/share/common-licenses/GPL-2
-
-Files: lib/bmf*
-Copyright: © 2005 - 2007, Thales Communications, Huizen, The Netherlands.
- Written by Erik Tromp.
-Licence: BSD-3
- | All rights reserved.
- |
- | Redistribution and use in source and binary forms, with or without 
- | modification, are permitted provided that the following conditions 
- | are met:
- | 
- | * Redistributions of source code must retain the above copyright 
- |   notice, this list of conditions and the following disclaimer.
- | * Redistributions in binary form must reproduce the above copyright 
- |   notice, this list of conditions and the following disclaimer in 
- |   the documentation and/or other materials provided with the 
- |   distribution.
- | * Neither the name of Thales, BMF nor the names of its 
- |   contributors may be used to endorse or promote products derived 
- |   from this software without specific prior written permission.
- |
- | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
- | ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
- | WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
- | IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
- | INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
- | BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
- | DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY 
- | OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
- | OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 
- | OF THE POSSIBILITY OF SUCH DAMAGE.
-
-Files: src/cfgparser/oparse.c src/cfgparser/oparse.h
-Copyright: © 1984, 1989, 1990, 2000, 2001, 2002, 2003, 2004, 2005, 2006
-   Free Software Foundation, Inc.
-Licence: GPL-2+
- | src/cfgparser/oparse.(c|h) 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, or (at your option)
- | any later version.
- | On Debian systems, the full text of the GPL-2+ is available at
- | /usr/share/common-licenses/GPL-2
- |
- | As a special exception, you may create a larger work that contains
- |  part or all of the Bison parser skeleton and distribute that work
- |  under terms of your choice, so long as that work isn't itself a
- |  parser generator using the skeleton or a modified version thereof
- |  as a parser skeleton.  Alternatively, if you modify or redistribute
- |  the parser skeleton itself, you may (at your option) remove this
- |  special exception, which will cause the skeleton and the resulting
- |  Bison output files to be licensed under the GNU General Public
- |  License without this special exception.
- |
- | This special exception was added by the Free Software Foundation in
- | version 2.2 of Bison.  
-
-Files: lib/quagga/src/quagga.h lib/quagga/src/olsrd_plugin.c lib/quagga.c
-Copyright: © 2006 Immo 'FaUl' Wehrenberg <immo@chaostreff-dortmund.de>
-Licence: GPL-2+
- lib/quagga/src/quagga.h 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, or (at your option)
- any later version.
- On Debian systems, the full text of the GPL is available at
- /usr/share/common-licenses/GPL-2
-
-Files: lib/quagga/src/quagga/zebra.h
-Copyright: © 1997, 1998, 1999, 2000, 2001, 2002 Kunihiro Ishiguro 
-Licence: GPL-2+
- lib/quagga/zebra.h 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, or (at your option)
- any later version.
- On Debian systems, the full text of the GPL-2+ is available at
- /usr/share/common-licenses/GPL-2
-
-Files: lib/secure/src/md5.(c|h)
-Copyright: © 1991, 1992 RSA Data Security, Inc. Created 1991. 
-Licence: other
- | All rights reserved.
- | License to copy and use this software is granted provided that it
- |  is identified as the "RSA Data Security, Inc. MD5 Message-Digest
- |  Algorithm" in all material mentioning or referencing this software
- |  or this function.
- |
- |  License is also granted to make and use derivative works provided
- |  that such works are identified as "derived from the RSA Data
- |  Security, Inc. MD5 Message-Digest Algorithm" in all material
- |  mentioning or referencing the derived work.  
- |                                                                   
- |  RSA Data Security, Inc. makes no representations concerning either
- |  the merchantability of this software or the suitability of this
- |  software for any particular purpose. It is provided "as is"
- |  without express or implied warranty of any kind.  
- |                                                                   
- |  These notices must be retained in any copies of any part of this
- |  documentation and/or software.  
-
diff --git a/debian/olsrd-default b/debian/olsrd-default
deleted file mode 100644 (file)
index 00dac53..0000000
+++ /dev/null
@@ -1,24 +0,0 @@
-# Defaults for olsrd initscript
-# sourced by /etc/init.d/olsrd
-# installed at /etc/default/olsrd by the maintainer scripts
-
-#
-# This is a POSIX shell fragment
-#
-
-#
-# uncomment the next line run olsrd automatically at startup
-#
-#START_OLSRD="YES"
-
-#
-# debuglevel from 1 (=quiet) to 9 (=max debug)
-# for running from init.d 0 is recommended
-#
-DEBUGLEVEL=0
-
-#
-# "command-line options"
-#
-DAEMON_OPTS="-f /etc/olsrd/olsrd.conf -d $DEBUGLEVEL"
-
diff --git a/debian/olsrd-plugins.dirs b/debian/olsrd-plugins.dirs
deleted file mode 100644 (file)
index 51b9280..0000000
+++ /dev/null
@@ -1 +0,0 @@
-usr/lib/olsrd
diff --git a/debian/olsrd-plugins.docs b/debian/olsrd-plugins.docs
deleted file mode 100644 (file)
index 16e45f8..0000000
+++ /dev/null
@@ -1,8 +0,0 @@
-lib/dyn_gw/README_DYN_GW
-lib/httpinfo/README_HTTPINFO
-lib/dot_draw/README_DOT_DRAW
-lib/nameservice/README_NAMESERVICE
-lib/secure/README_SECURE
-lib/bmf/README_BMF
-lib/quagga/README_QUAGGA
-lib/txtinfo/README_TXTINFO 
diff --git a/debian/olsrd.conf b/debian/olsrd.conf
deleted file mode 100644 (file)
index 31775b5..0000000
+++ /dev/null
@@ -1,18 +0,0 @@
-#
-# olsr.org OLSR daemon config file
-#
-# Lines starting with a # are discarded
-#
-# This file was shipped with the debian olsrd package
-#
-
-# Interfaces and their rules
-# Omitted options will be set to the
-# default values. Multiple interfaces
-# can be specified in the same block
-# and multiple blocks can be set.
-
-#Interface "eth1" "eth0" "wlan0" "wlan1" "ath0" "ath1"
-Interface "eth1" 
-{
-}
diff --git a/debian/olsrd.dirs b/debian/olsrd.dirs
deleted file mode 100644 (file)
index 34a2cc6..0000000
+++ /dev/null
@@ -1,3 +0,0 @@
-usr/sbin
-etc/default/
-etc/olsrd
diff --git a/debian/olsrd.docs b/debian/olsrd.docs
deleted file mode 100644 (file)
index 19331e7..0000000
+++ /dev/null
@@ -1,2 +0,0 @@
-README-Olsr-Extensions
-
diff --git a/debian/olsrd.init b/debian/olsrd.init
deleted file mode 100644 (file)
index 2168853..0000000
+++ /dev/null
@@ -1,84 +0,0 @@
-#! /bin/sh
-### BEGIN INIT INFO
-# Provides:          olsrd
-# Required-Start:    $network $remote_fs $syslog
-# Required-Stop:     $network $remote_fs $syslog
-# Default-Start:     2 3 4 5
-# Default-Stop:      0 1 6
-# Short-Description: /etc/init.d/olsrd: start olsrd
-### END INIT INFO
-
-#              Based on skeleton script written by Miquel van Smoorenburg <miquels@cistron.nl>.
-#              Modified for Debian 
-#              by Ian Murdock <imurdock@gnu.ai.mit.edu>.
-#              Modified for olsrd
-#              by Holger Levsen <debian@layer-acht.org>
-# 
-# Version:     21-Dec-2006  
-# modified:     01-Aug-2007
-#              31-Jun-2008
-#              30-May-2009
-
-PATH=/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin
-DAEMON=/usr/sbin/olsrd
-NAME=olsrd
-DESC=olsrd
-
-PID_FILE=/var/run/$NAME.pid
-
-test -x $DAEMON || exit 0
-
-# Include olsrd defaults if available
-if [ -f /etc/default/olsrd ] ; then
-       . /etc/default/olsrd
-fi
-
-set -e
-
-case "$1" in
-  debug)
-       echo -n "Starting $DESC: "
-       start-stop-daemon --start --quiet --exec $DAEMON --pidfile $PID_FILE -- $DAEMON_OPTS &
-       # sleep til olsrd has been started
-       while ! pidof $NAME > /dev/null ; do 
-         sleep 1
-       done
-       echo "$NAME."
-       echo $(pidof $NAME) > $PID_FILE
-       ;;
-  start)
-       if [ "$START_OLSRD" != "YES" ] ; then exit 0 ; fi
-       if [ $(pidof $NAME) -eq 0 ] ; then 
-               echo "$NAME already running, doing nothing."
-               exit 0
-       fi
-       echo -n "Starting $DESC: "
-       start-stop-daemon --start --quiet --exec $DAEMON --pidfile $PID_FILE -- $DAEMON_OPTS &
-       # sleep til olsrd has been started
-       while ! pidof $NAME > /dev/null ; do 
-         sleep 1
-       done
-       echo "$NAME."        
-       echo $(pidof $NAME) > $PID_FILE
-       ;;
-  stop)
-       pidof $NAME || exit 0
-       echo -n "Stopping $DESC: "
-       start-stop-daemon --stop  --quiet --exec $DAEMON --pidfile $PID_FILE
-        rm -f $PID_FILE
-       echo "$NAME."
-       ;;
-  restart|force-reload)
-       echo -n "Restarting $DESC: "
-       $0 stop
-       sleep 1
-       $0 start
-       ;;
-  *)
-       N=/etc/init.d/$NAME
-       echo "Usage: $N {start|stop|restart}" >&2
-       exit 1
-       ;;
-esac
-
-exit 0
diff --git a/debian/olsrd.postinst b/debian/olsrd.postinst
deleted file mode 100644 (file)
index 1ecae81..0000000
+++ /dev/null
@@ -1,12 +0,0 @@
-#!/bin/sh
-
-set -e
-
-# Recover from incorrect init.d script headers in version 0.5.6-r5-1 and earlier
-if [ "$1" = "configure" ] && dpkg --compare-versions "$2" le "0.5.6-r5-1" \
-   && [ -f /etc/rcS.d/S[0-9][0-9]olsrd ] \
-   && ! [ -f /etc/rc2.d/S[0-9][0-9]olsrd ] ; then
-    update-rc.d -f olsrd remove
-fi
-
-#DEBHELPER#
diff --git a/debian/rules b/debian/rules
deleted file mode 100644 (file)
index b5100b8..0000000
+++ /dev/null
@@ -1,100 +0,0 @@
-#!/usr/bin/make -f
-# Holger Levsen, 2006-12, based on 
-# -*- makefile -*-
-# Sample debian/rules that uses debhelper.
-# This file was originally written by Joey Hess and Craig Small.
-# As a special exception, when this file is copied by dh-make into a
-# dh-make output file, you may use that output file without restriction.
-# This special exception was added by Craig Small in version 0.37 of dh-make.
-
-# Uncomment this to turn on verbose mode.
-#export DH_VERBOSE=1
-
-# plugins to be build (not build per default are: powerinfo pgraph mini quagga)
-#      (fixme?: if you add them here, they are build but their README is not 
-#      copied to /usr/share/doc/olsrd-plugins/)
-#
-# you dont need to edit this file. export PLUGIS=foo ; fakeroot ./debian/rules binary
-# is enough for a rebuild :)
-PLUGINS ?= dyn_gw httpinfo dot_draw nameservice secure txtinfo bmf quagga
-#hack: - also needs debian/patches/240-plugin-install-targets.patch - this has been reported to upstream...
-PLUGINS_INSTALL ?= dyn_gw_install httpinfo_install dot_draw_install nameservice_install secure_install txtinfo_install bmf_install quagga_install
-
-CFLAGS = -Wall -g
-
-ifneq (,$(findstring noopt,$(DEB_BUILD_OPTIONS)))
-       CFLAGS += -O0
-else
-       CFLAGS += -O2
-endif
-
-configure: configure-stamp
-configure-stamp:
-       dh_testdir
-       # Add here commands to configure the package.
-       QUILT_PATCHES=debian/patches quilt push -a || test $$? = 2
-       
-       touch configure-stamp
-
-build: build-stamp
-
-build-stamp: configure-stamp 
-       dh_testdir
-
-       # Add here commands to compile the package.
-       $(MAKE)
-       $(MAKE) $(PLUGINS)
-
-       touch $@
-
-clean:
-       dh_testdir
-       dh_testroot
-       rm -f build-stamp configure-stamp
-
-       # Add here commands to clean up after the build process.
-       -$(MAKE) clean_all
-       rm -f $(CURDIR)/lib/*/src/*.o $(CURDIR)/lib/*/*.so.?.?
-       QUILT_PATCHES=debian/patches quilt pop -a -R || test $$? = 2
-
-       dh_clean 
-
-install: build
-       dh_testdir
-       dh_testroot
-       dh_clean -k 
-       dh_installdirs
-
-       # Add here commands to install the package into debian/olsrd.
-       $(MAKE) DESTDIR=$(CURDIR)/debian/olsrd install STRIP=: 
-       $(MAKE) DESTDIR=$(CURDIR)/debian/olsrd-plugins LIBDIR=$(CURDIR)/debian/olsrd-plugins/usr/lib/olsrd $(PLUGINS_INSTALL) STRIP=:
-
-# Build architecture-independent files here.
-binary-indep: build install
-# We have nothing to do by default.
-
-# Build architecture-dependent files here.
-binary-arch: build install
-       dh_testdir
-       dh_testroot
-       dh_installchangelogs -polsrd CHANGELOG -polsrd-plugins
-       dh_installdocs
-       dh_installinit
-       dh_installman
-       dh_link
-       dh_strip
-       # compress, but don't compress README_NAMESERVICE, for consistency reasons
-       dh_compress -XREADME_NAMESERVICE -XREADME_BMF
-       # provide better default config
-       rm $(CURDIR)/debian/olsrd/etc/olsrd.conf
-       cp $(CURDIR)/debian/olsrd.conf $(CURDIR)/debian/olsrd/etc/olsrd/olsrd.conf
-       cp  $(CURDIR)/debian/olsrd-default $(CURDIR)/debian/olsrd/etc/default/olsrd
-       dh_fixperms
-       dh_installdeb
-       dh_shlibdeps
-       dh_gencontrol
-       dh_md5sums
-       dh_builddeb
-
-binary: binary-indep binary-arch
-.PHONY: build clean binary-indep binary-arch binary install configure
diff --git a/debian/todo b/debian/todo
deleted file mode 100644 (file)
index 4d2f2a4..0000000
+++ /dev/null
@@ -1 +0,0 @@
-- remove debian/patches/240-plugin-install-targets.patch
index c6dec19..ced50a0 100644 (file)
@@ -56,10 +56,10 @@ clean:
 doc: $(DOX_FILE)
        @echo "[$@] doc"
        @echo "  Cleaning up $(OS) outputs..."
-       @rm -fr "$(HTML_OUTPUT)" "$(LATEX_OUTPUT)" "$(PDF_OUTPUT)"
-       @mkdir -p "$(HTML_OUTPUT)"
-       @mkdir -p "$(LATEX_OUTPUT)"
-       @mkdir -p "$(PDF_DIR)"
+       @rm -frv "$(HTML_OUTPUT)" "$(LATEX_OUTPUT)" "$(PDF_OUTPUT)"
+       @mkdir -pv "$(HTML_OUTPUT)"
+       @mkdir -pv "$(LATEX_OUTPUT)"
+       @mkdir -pv "$(PDF_DIR)"
        @echo "  Generating doxygen configuration..."
        @sed \
          -e "s/__OLSRD_VER__/$(OLSRD_VER)/" \
@@ -72,11 +72,11 @@ doc: $(DOX_FILE)
          "$(DOX_FILE)" > "$(TMP_DOX_FILE)"
        @echo "  Running doxygen to create HTML..."
        @doxygen "$(TMP_DOX_FILE)"
-       @rm -f "$(TMP_DOX_FILE)"
+       @rm -fv "$(TMP_DOX_FILE)"
        @echo "  Running latex to create a PDF..."
-       @$(MAKE) -s -C $(LATEX_OUTPUT) all > /dev/null 2>&1
-       @mkdir -p "$(PDF_DIR)"
-       @mv "$(LATEX_OUTPUT)/refman.pdf" "$(PDF_OUTPUT)"
-       @rm -fr "$(LATEX_OUTPUT)"
-       @rmdir --ignore-fail-on-non-empty "$(LATEX_DIR)"
+       @$(MAKE) -s -C $(LATEX_OUTPUT) all
+       @mkdir -pv "$(PDF_DIR)"
+       @mv -v "$(LATEX_OUTPUT)/refman.pdf" "$(PDF_OUTPUT)"
+       @rm -frv "$(LATEX_OUTPUT)"
+       @rmdir -v --ignore-fail-on-non-empty "$(LATEX_DIR)"
        @echo "  Done"
diff --git a/doc/SmartGateway/.gitignore b/doc/SmartGateway/.gitignore
new file mode 100644 (file)
index 0000000..d8c3b27
--- /dev/null
@@ -0,0 +1 @@
+/*.svg
diff --git a/doc/SmartGateway/SmartGatewayCost.gnuplot b/doc/SmartGateway/SmartGatewayCost.gnuplot
new file mode 100644 (file)
index 0000000..5168c0d
--- /dev/null
@@ -0,0 +1,42 @@
+sizex=1920
+sizey=1080
+
+set terminal svg dynamic enhanced fname 'Helvetica' fsize 16 mousing name "SmartGatewayCost" butt solid size sizex,sizey
+set output 'SmartGatewayCost.svg'
+
+set grid xtics lt 0 lw 1 lc rgb "#bbbbbb"
+set grid ytics lt 0 lw 1 lc rgb "#bbbbbb"
+set grid ztics lt 0 lw 1 lc rgb "#bbbbbb"
+
+set dummy x,y
+set isosamples 100, 100
+
+
+set title "Smart Gateway Cost (Symmetric Link)" 
+
+#                     WexitU   WexitD   Wetx
+# path_cost_weight =  ------ + ------ + ---- * path_cost
+#                     exitUm   exitDm   Detx
+
+WexitU=1.0
+WexitD=1.0
+Wetx=1.0
+Detx=4096.0
+
+set xlabel "Uplink / Downlink (Mbps)" 
+xlow=0.0
+xhigh=1.0
+set xlabel  offset character 0, 0, 0 font "Helvetica" textcolor lt -1 norotate
+set xrange [ xlow : xhigh ] noreverse nowriteback
+
+set ylabel "Path Cost ( = ETX * 1024 )"
+ylow=1000.0
+yhigh=10000.0
+set ylabel  offset character 0, 0, 0 font "Helvetica" textcolor lt -1 rotate by -270
+set yrange [ ylow : yhigh ] noreverse nowriteback
+
+
+set zlabel "Costs" 
+set zlabel  offset character -2, 0, 0 font "" textcolor lt -1 norotate
+
+splot (WexitU/x)+(WexitD/x)+((Wetx/Detx)*y)
diff --git a/doc/SmartGateway/watchAndPlot.bash b/doc/SmartGateway/watchAndPlot.bash
new file mode 100755 (executable)
index 0000000..da05038
--- /dev/null
@@ -0,0 +1,32 @@
+#!/bin/bash
+
+set -e
+set -u
+
+ifsOld="$IFS"
+IFS=$'\n'
+gnuplotfiles=( $(ls -1 *.gnuplot | sort) )
+IFS="$ifsOld"
+gnuplotfilestimes=()
+
+# init time stamps
+declare -i index=0
+while [[ $index -lt ${#gnuplotfiles[*]} ]]; do
+  gnuplotfilestimes[$index]=1
+  index+=1
+done
+
+
+declare -i tim=0
+while true; do
+  index=0
+  while [[ $index -lt ${#gnuplotfiles[*]} ]]; do
+    tim=$(stat -c "%Y" "${gnuplotfiles[index]}")
+    if [[ $tim -ne ${gnuplotfilestimes[index]} ]]; then
+      gnuplot "${gnuplotfiles[index]}"
+      gnuplotfilestimes[$index]=$tim
+    fi
+    index+=1
+  done
+  sleep 1
+done
index 3709ed5..029e600 100644 (file)
@@ -23,14 +23,9 @@ LoadPlugin "olsrd_dyn_gw.so.0.5"
 {
 }
 
-LoadPlugin "olsrd_httpinfo.so.0.1"
-{
-       PlParam "Net" "0.0.0.0 0.0.0.0"
-       PlParam "port" "1978"
-}
-
 LoadPlugin "olsrd_nameservice.so.0.3"
 {
+    # you should set this to your own node name
        PlParam "name" "commotion-7814921"
        PlParam "sighup-pid-file" "/var/run/dnsmasq.pid"
        PlParam "suffix" ".mesh"
@@ -43,13 +38,21 @@ LoadPlugin "olsrd_p2pd.so.0.1.0"
        PlParam "UdpDestPort" "224.0.0.251 5353"
 }
 
+LoadPlugin "olsrd_jsoninfo.so.0.0"
+{
+#      PlParam "accept" "0.0.0.0"
+}
+
 LoadPlugin "olsrd_txtinfo.so.0.1"
 {
-       PlParam "accept" "0.0.0.0"
+#      PlParam "accept" "0.0.0.0"
 }
 
-Interface "wlan0"
+InterfaceDefaults
 {
+    # if you using this on Mac OS X, then comment this out because Mac OS X
+    # does weird things with 255.255.255.255. By commenting this out, olsrd
+    # will use the broadcast that's assigned to the network interface
        Ip4Broadcast 255.255.255.255
 }
 
index 6b11c7d..2e2e648 100644 (file)
 
 # SmartGateway no
 
+# Signals that the server tunnel must always be removed on shutdown,
+# irrespective of the interface up/down state during startup.
+# (default is "no")
+
+# SmartGatewayAlwaysRemoveServerTunnel no
+
+# Determines the maximum number of gateways that can be in use at any given
+# time. This setting is used to mitigate the effects of breaking connections
+# (due to the selection of a new gateway) on a dynamic network.
+# (default is 1)
+
+# SmartGatewayUseCount 1
+
+# Determines the take-down percentage for a non-current smart gateway tunnel.
+# If the cost of the current smart gateway tunnel is less than this percentage
+# of the cost of the non-current smart gateway tunnel, then the non-current smart
+# gateway tunnel is taken down because it is then presumed to be 'too expensive'.
+# This setting is only relevant when SmartGatewayUseCount is larger than 1;
+# a value of 0 will result in the tunnels not being taken down proactively.
+# (default is 0)
+
+# SmartGatewayTakeDownPercentage 0
+
+# Determines the policy routing script that is executed during startup and
+# shutdown of olsrd. The script is only executed when SmartGatewayUseCount
+# is set to a value larger than 1. The script must setup policy routing
+# rules such that multi-gateway mode works. A sample script is included.
+# (default is not set)
+
+# SmartGatewayPolicyRoutingScript ""
+
+# Determines the egress interfaces that are part of the multi-gateway setup and
+# therefore only relevant when SmartGatewayUseCount is larger than 1 (in which
+# case it must be explicitly set).
+# (default is not set)
+
+# SmartGatewayEgressInterfaces ""
+
+# Determines the routing tables offset for multi-gateway policy routing tables
+# See the policy routing script for an explanation.
+# (default is 90)
+
+# SmartGatewayTablesOffset 90
+
+# Determines the policy routing rules offset for multi-gateway policy routing
+# rules. See the policy routing script for an explanation.
+# (default is 0, which indicates that the rules and tables should be aligned and
+# puts this value at SmartGatewayTablesOffset - # egress interfaces -
+# # olsr interfaces)
+
+# SmartGatewayRulesOffset 87
+
 # Allows the selection of a smartgateway with NAT (only for IPv4)
 # (default is "yes")
 
index 4ed0650..e694e3d 100644 (file)
 
 # SmartGateway no
 
+# Signals that the server tunnel must always be removed on shutdown,
+# irrespective of the interface up/down state during startup.
+# (default is "no")
+
+# SmartGatewayAlwaysRemoveServerTunnel no
+
+# Determines the maximum number of gateways that can be in use at any given
+# time. This setting is used to mitigate the effects of breaking connections
+# (due to the selection of a new gateway) on a dynamic network.
+# (default is 1)
+
+# SmartGatewayUseCount 1
+
+# Determines the take-down percentage for a non-current smart gateway tunnel.
+# If the cost of the current smart gateway tunnel is less than this percentage
+# of the cost of the non-current smart gateway tunnel, then the non-current smart
+# gateway tunnel is taken down because it is then presumed to be 'too expensive'.
+# This setting is only relevant when SmartGatewayUseCount is larger than 1;
+# a value of 0 will result in the tunnels not being taken down proactively.
+# (default is 0)
+
+# SmartGatewayTakeDownPercentage 0
+
+# Determines the policy routing script that is executed during startup and
+# shutdown of olsrd. The script is only executed when SmartGatewayUseCount
+# is set to a value larger than 1. The script must setup policy routing
+# rules such that multi-gateway mode works. A sample script is included.
+# (default is not set)
+
+# SmartGatewayPolicyRoutingScript ""
+
+# Determines the egress interfaces that are part of the multi-gateway setup and
+# therefore only relevant when SmartGatewayUseCount is larger than 1 (in which
+# case it must be explicitly set).
+# (default is not set)
+
+# SmartGatewayEgressInterfaces ""
+
+# Determines the routing tables offset for multi-gateway policy routing tables
+# See the policy routing script for an explanation.
+# (default is 90)
+
+# SmartGatewayTablesOffset 90
+
+# Determines the policy routing rules offset for multi-gateway policy routing
+# rules. See the policy routing script for an explanation.
+# (default is 0, which indicates that the rules and tables should be aligned and
+# puts this value at SmartGatewayTablesOffset - # egress interfaces -
+# # olsr interfaces)
+
+# SmartGatewayRulesOffset 87
+
 # Allows the selection of a smartgateway with NAT (only for IPv4)
 # (default is "yes")
 
index 0437239..2b5587b 100644 (file)
 
 # SmartGateway no
 
+# Signals that the server tunnel must always be removed on shutdown,
+# irrespective of the interface up/down state during startup.
+# (default is "no")
+
+# SmartGatewayAlwaysRemoveServerTunnel no
+
+# Determines the maximum number of gateways that can be in use at any given
+# time. This setting is used to mitigate the effects of breaking connections
+# (due to the selection of a new gateway) on a dynamic network.
+# (default is 1)
+
+# SmartGatewayUseCount 1
+
+# Determines the take-down percentage for a non-current smart gateway tunnel.
+# If the cost of the current smart gateway tunnel is less than this percentage
+# of the cost of the non-current smart gateway tunnel, then the non-current smart
+# gateway tunnel is taken down because it is then presumed to be 'too expensive'.
+# This setting is only relevant when SmartGatewayUseCount is larger than 1;
+# a value of 0 will result in the tunnels not being taken down proactively.
+# (default is 0)
+
+# SmartGatewayTakeDownPercentage 0
+
+# Determines the policy routing script that is executed during startup and
+# shutdown of olsrd. The script is only executed when SmartGatewayUseCount
+# is set to a value larger than 1. The script must setup policy routing
+# rules such that multi-gateway mode works. A sample script is included.
+# (default is not set)
+
+# SmartGatewayPolicyRoutingScript ""
+
+# Determines the egress interfaces that are part of the multi-gateway setup and
+# therefore only relevant when SmartGatewayUseCount is larger than 1 (in which
+# case it must be explicitly set).
+# (default is not set)
+
+# SmartGatewayEgressInterfaces ""
+
+# Determines the routing tables offset for multi-gateway policy routing tables
+# See the policy routing script for an explanation.
+# (default is 90)
+
+# SmartGatewayTablesOffset 90
+
+# Determines the policy routing rules offset for multi-gateway policy routing
+# rules. See the policy routing script for an explanation.
+# (default is 0, which indicates that the rules and tables should be aligned and
+# puts this value at SmartGatewayTablesOffset - # egress interfaces -
+# # olsr interfaces)
+
+# SmartGatewayRulesOffset 87
+
 # Allows the selection of a smartgateway with NAT (only for IPv4)
 # (default is "yes")
 
diff --git a/files/olsrd.ufw.profile b/files/olsrd.ufw.profile
new file mode 100644 (file)
index 0000000..7b68a12
--- /dev/null
@@ -0,0 +1,4 @@
+[olsrd]
+title=olsrd
+description=optimized link-state routing daemon for OLSR mesh networking
+ports=698
diff --git a/files/sgw_policy_routing_setup.sh b/files/sgw_policy_routing_setup.sh
new file mode 100755 (executable)
index 0000000..8fdc4a1
--- /dev/null
@@ -0,0 +1,244 @@
+#!/bin/bash
+
+set -e
+set -u
+
+
+###############################################################################
+#
+# OVERVIEW
+#
+###############################################################################
+
+# Tables (from SmartGatewayTablesOffset):
+#                                               +-----------------+-----------------+---------------+
+#                                               | sgwsrvtun table | egressif tables | sgwtun tables |
+#                                               +-----------------+-----------------+---------------+
+# Example:                                              90               91 92            93 94 ...
+#
+#
+# Rules (from SmartGatewayRulesOffset):
+# +-----------------------+---------------------+-----------------+-----------------+---------------+
+# | egressif bypass rules | olsrif bypass rules | sgwsrvtun rule  | egressif rules  | sgwtun rules  |
+# +-----------------------+---------------------+-----------------+-----------------+---------------+
+# Example:  84 85               86 87 88 89             90               91 92            93 94 ...
+
+
+###############################################################################
+#
+# SETTINGS
+#
+###############################################################################
+
+declare IPVERSION_4="ipv4"
+declare IPVERSION_6="ipv6"
+
+declare MODE_GENERIC="generic"
+declare MODE_OLSRIF="olsrif"
+declare MODE_SGWSRVTUN="sgwsrvtun"
+declare MODE_EGRESSIF="egressif"
+declare MODE_SGWTUN="sgwtun"
+
+declare ADDMODE_ADD="add"
+declare ADDMODE_DEL="del"
+
+declare -i MODE_GENERIC_ARGC=0
+declare -i MODE_OLSRIF_ARGC=2
+declare -i MODE_EGRESSIF_ARGC=4
+declare -i MODE_SGWSRVTUN_ARGC=3
+declare -i MODE_SGWTUN_ARGC=3
+
+
+###############################################################################
+#
+# HELPER FUNCTIONS
+#
+###############################################################################
+
+function usage() {
+  echo ""
+  echo "The script was called as:"
+  echo "  $script ${arguments[@]:-}"
+  echo ""
+  echo "Usage:"
+  echo "  $script ipVersion mode addMode ifName tableNr ruleNr bypassRuleNr"
+  echo "    - ipVersion   : $IPVERSION_4 or $IPVERSION_6"
+  echo "    - mode        : $MODE_GENERIC, $MODE_OLSRIF, $MODE_EGRESSIF, $MODE_SGWSRVTUN or $MODE_SGWTUN"
+  echo "    - addMode     : $ADDMODE_ADD or $ADDMODE_DEL"
+  echo "    - ifName      : the interface name       , only relevant for modes $MODE_EGRESSIF, $MODE_SGWSRVTUN, $MODE_SGWTUN"
+  echo "    - tableNr     : the routing table number , only relevant for modes $MODE_EGRESSIF, $MODE_SGWSRVTUN, $MODE_SGWTUN"
+  echo "    - ruleNr      : the ip rule number       , only relevant for modes $MODE_EGRESSIF, $MODE_SGWSRVTUN, $MODE_SGWTUN"
+  echo "    - bypassRuleNr: the bypass ip rule number, only relevant for mode  $MODE_EGRESSIF, $MODE_OLSRIF"
+}
+
+function error() {
+  local -i firstLine=1
+  while [ $# -gt 0 ]; do
+    if [ $firstLine -eq 1 ]; then
+      echo "Error: $1"
+    else
+      echo "       $1"
+    fi
+    firstLine=0
+    shift 1
+  done
+}
+
+
+###############################################################################
+#
+# MODE FUNCTIONS
+#
+###############################################################################
+
+function generic() {
+  "$IPTABLES" $IPTABLES_ARGS -t mangle "$ADDMODE_IPTABLES" PREROUTING  -m conntrack ! --ctstate NEW -j CONNMARK --restore-mark
+  "$IPTABLES" $IPTABLES_ARGS -t mangle "$ADDMODE_IPTABLES" OUTPUT      -m conntrack ! --ctstate NEW -j CONNMARK --restore-mark
+}
+
+function olsrif() {
+  local interfaceName="$1"
+  local bypassRuleNr="$2"
+
+  "$IP"       $IP_ARGS        rule      "$ADDMODE_IP" iif    "$interfaceName" table main       priority "$bypassRuleNr"
+}
+
+function egressif() {
+  local interfaceName="$1"
+  local tableNr="$2"
+  local ruleNr="$3"
+  local bypassRuleNr="$4"
+
+  "$IPTABLES" $IPTABLES_ARGS -t mangle "$ADDMODE_IPTABLES" POSTROUTING -m conntrack --ctstate NEW -o "$interfaceName" -j CONNMARK --set-mark "$ruleNr"
+  "$IPTABLES" $IPTABLES_ARGS -t mangle "$ADDMODE_IPTABLES" INPUT       -m conntrack --ctstate NEW -i "$interfaceName" -j CONNMARK --set-mark "$ruleNr"
+  "$IP"       $IP_ARGS       rule      "$ADDMODE_IP" fwmark "$ruleNr"        table "$tableNr" priority "$ruleNr"
+  "$IP"       $IP_ARGS       rule      "$ADDMODE_IP" iif    "$interfaceName" table main       priority "$bypassRuleNr"
+}
+
+function sgwsrvtun() {
+  local interfaceName="$1"
+  local tableNr="$2"
+  local ruleNr="$3"
+
+  "$IPTABLES" $IPTABLES_ARGS -t mangle "$ADDMODE_IPTABLES" PREROUTING  -m conntrack --ctstate NEW -i "$interfaceName" -j CONNMARK --set-mark "$ruleNr"
+  "$IP"       $IP_ARGS       rule      "$ADDMODE_IP" fwmark "$ruleNr" table "$tableNr" priority "$ruleNr"
+}
+
+function sgwtun() {
+  local interfaceName="$1"
+  local tableNr="$2"
+  local ruleNr="$3"
+
+  "$IPTABLES" $IPTABLES_ARGS -t mangle "$ADDMODE_IPTABLES" POSTROUTING -m conntrack --ctstate NEW -o "$interfaceName" -j CONNMARK --set-mark "$ruleNr"
+  "$IP"       $IP_ARGS       rule      "$ADDMODE_IP" fwmark "$ruleNr" table "$tableNr" priority "$ruleNr"
+}
+
+
+###############################################################################
+#
+# MAIN
+#
+###############################################################################
+
+declare script="$0"
+declare -a arguments=( ${@} )
+declare -i argc=$#
+
+# we always need 3 arguments, check it
+if [ $argc -lt 3 ]; then
+  error "Need at least 3 arguments"
+  usage
+  exit 1
+fi
+
+# get first 3 arguments
+declare ipVersion=$1
+declare mode="$2"
+declare addMode="$3"
+shift 3
+argc=$#
+
+# check IP version argument
+if [ ! "$ipVersion" == "$IPVERSION_4" ] && \
+   [ ! "$ipVersion" == "$IPVERSION_6" ]; then
+  error "Illegal IP version"
+  usage
+  exit 1
+fi
+
+# check mode argument
+if [ ! "$mode" == "$MODE_GENERIC" ] && \
+   [ ! "$mode" == "$MODE_OLSRIF" ] && \
+   [ ! "$mode" == "$MODE_SGWSRVTUN" ] && \
+   [ ! "$mode" == "$MODE_EGRESSIF" ] && \
+   [ ! "$mode" == "$MODE_SGWTUN" ]; then
+  error "Illegal mode"
+  usage
+  exit 1
+fi
+
+# check addMode argument
+if [ ! "$addMode" == "$ADDMODE_ADD" ] && \
+   [ ! "$addMode" == "$ADDMODE_DEL" ]; then
+  error "Illegal addMode"
+  usage
+  exit 1
+fi
+
+# check argument count for all modes
+if ([ "$mode" == "$MODE_GENERIC" ]   && [ $argc -lt $MODE_GENERIC_ARGC   ]) || \
+   ([ "$mode" == "$MODE_OLSRIF" ]    && [ $argc -lt $MODE_OLSRIF_ARGC    ]) || \
+   ([ "$mode" == "$MODE_EGRESSIF"  ] && [ $argc -lt $MODE_EGRESSIF_ARGC  ]) || \
+   ([ "$mode" == "$MODE_SGWSRVTUN" ] && [ $argc -lt $MODE_SGWSRVTUN_ARGC ]) || \
+   ([ "$mode" == "$MODE_SGWTUN"  ]   && [ $argc -lt $MODE_SGWTUN_ARGC    ]); then
+  if [ $argc -eq 0 ]; then
+    error "Not enough arguments arguments ($argc) for mode $mode"
+  else
+    error "Not enough arguments arguments ($argc) for mode $mode" "Arguments: ${@}"
+  fi
+  usage
+  exit 1
+fi
+
+# check argument count for all modes
+if ([ "$mode" == "$MODE_GENERIC" ]   && [ $argc -gt $MODE_GENERIC_ARGC   ]) || \
+   ([ "$mode" == "$MODE_OLSRIF" ]    && [ $argc -gt $MODE_OLSRIF_ARGC    ]) || \
+   ([ "$mode" == "$MODE_EGRESSIF"  ] && [ $argc -gt $MODE_EGRESSIF_ARGC  ]) || \
+   ([ "$mode" == "$MODE_SGWSRVTUN" ] && [ $argc -gt $MODE_SGWSRVTUN_ARGC ]) || \
+   ([ "$mode" == "$MODE_SGWTUN"  ]   && [ $argc -gt $MODE_SGWTUN_ARGC    ]); then
+  if [ $argc -eq 0 ]; then
+    error "Not enough arguments arguments ($argc) for mode $mode"
+  else
+    error "Not enough arguments arguments ($argc) for mode $mode" "Arguments: ${@}"
+  fi
+  usage
+  exit 1
+fi
+
+# process ipVersion argument
+declare IPTABLES="iptables"
+declare IPTABLES_ARGS=""
+declare IP="ip"
+declare IP_ARGS="-4"
+if [ "$ipVersion" == "$IPVERSION_6" ]; then
+  IPTABLES="ip6tables"
+  IPTABLES_ARGS=""
+  IP="ip"
+  IP_ARGS="-6"
+fi
+
+# process addMode argument
+declare ADDMODE_IPTABLES="-D"
+declare ADDMODE_IP="delete"
+if [ "$addMode" == "$ADDMODE_ADD" ]; then
+  # first call the delete mode to remove any left-over rules
+  set +e
+  "$mode" "${@}" 2> /dev/null
+  set -e
+
+  ADDMODE_IPTABLES="-I"
+  ADDMODE_IP="add"
+fi
+
+# call the mode
+"$mode" "${@}"
index 50e060a..28183cd 100644 (file)
@@ -11,6 +11,17 @@ LDFLAGS = -pie
 
 LIBS := $(shell pkg-config --libs gtk+-2.0) -lm
 
+# 32/64 cross compilation
+ifdef M32
+CFLAGS +=      -m32
+LDFLAGS +=     -m32
+endif
+ifdef M64
+CFLAGS +=      -m64
+LDFLAGS +=     -m64
+endif
+
+
 all: default_target
 
 default_target: olsrd-gui
index c009a59..74ca4fe 100644 (file)
@@ -54,7 +54,7 @@ UninstPage uninstConfirm
 UninstPage instfiles
 
 Function .onInit
-        MessageBox MB_YESNO "This will install olsr.org 0.6.5.6 on your computer. Continue?" IDYES NoAbort
+        MessageBox MB_YESNO "This will install olsr.org pre-0.6.7 on your computer. Continue?" IDYES NoAbort
         Abort
 NoAbort:
 FunctionEnd
index 64db668..23ff9e7 100644 (file)
@@ -24,8 +24,8 @@ DESCRIPTION
        it with some debug output which is directed to STDOUT.\r
 \r
 \r
-       This  manual page only lists the command line arguments. For details of\r
-       the configuration file see the comments  included  in  /etc/olsrd.conf.\r
+       This  manual page only lists command line arguments. For details of the\r
+       configuration file see the comments  included in /etc/olsrd/olsrd.conf.\r
        Note  that  none  of these options need to be set at the command line -\r
        all these options and others can be set in the configuration file.\r
 \r
@@ -41,7 +41,7 @@ OPTIONS
 \r
        -f configfile\r
                    This option overrides the default configuration  file  path\r
-                   used by olsrd - /etc/olsrd.conf\r
+                   used by olsrd - /etc/olsrd/olsrd.conf\r
 \r
        -d debuglevel\r
                    This option specifies the amount of debug information olsrd\r
@@ -118,7 +118,7 @@ OPTIONS
 \r
 \r
 \r
-       FILES  /etc/olsrd.conf\r
+       FILES  /etc/olsrd/olsrd.conf\r
 \r
 SEE ALSO\r
        iwconfig(8) route(8).\r
index d8098d7..2ffaf2c 100644 (file)
@@ -68,7 +68,7 @@ IDD_FRONTEND_DIALOG DIALOGEX 0, 0, 399, 289
 STYLE DS_MODALFRAME | WS_MINIMIZEBOX | WS_POPUP | WS_VISIBLE | WS_CAPTION | \r
     WS_SYSMENU\r
 EXSTYLE WS_EX_APPWINDOW\r
-CAPTION "olsr.org Switch 0.6.5.6"
+CAPTION "olsr.org Switch pre-0.6.7"\r
 FONT 8, "MS Sans Serif", 0, 0, 0x1\r
 BEGIN\r
     CONTROL         "Tab1",IDC_TAB1,"SysTabControl32",0x0,7,7,383,256\r
index 8308d51..b624611 100644 (file)
@@ -3,12 +3,12 @@ ARP REFRESH PLUGIN FOR OLSRD
 by Sven-Ola Tuecke <sven-ola-aet-gmx.de>
 ---------------------------------------------------------------------
 
-This plugin listens to all recevice UDP packets and maintains an
+This plugin listens to all received UDP packets and maintains an
 internal list of MAC addresses extracted from these. By hitchhiking
 the set-route-function, the kernel ARP cache will be refreshed from
-this list if a direct-neighbour host route is configured. Result:
+this list if a direct-neighbor host route is configured. Result:
 no more ARP lookups if you use a larger routing chain - e.g. fetch
-a web site 8 olsr-hops away does not show the typcial 8-nodes-need
+a web site 8 olsr-hops away does not show the typical 8-nodes-need
 to ARP first delay.
 
 ---------------------------------------------------------------------
@@ -21,7 +21,7 @@ None.
 SAMPLE CONFIG
 ---------------------------------------------------------------------
 
-add in /etc/olsrd.conf:
+add in /etc/olsrd/olsrd.conf:
 
 LoadPlugin "arprefresh.so.0.1"
 {
index 8282dcf..8533b7c 100644 (file)
@@ -31,7 +31,9 @@
  */
 
 /*
- * Plugin to refresh the local ARP cache from received OLSR broadcasts
+ * Plugin to refresh the local ARP cache from received OLSR broadcasts.
+ *
+ * Note: this code does not work with IPv6 and not with VLANs (on IPv4 or IPv6)
  */
 
 #include <stdio.h>
@@ -112,14 +114,7 @@ olsr_arp_event(void *foo __attribute__ ((unused)))
                             MSG_TRUNC, (struct sockaddr *)&from,
                             &fromlen);
 
-    if (0 <= size && size >= (ssize_t) sizeof(buf)
-
-                                                 /*** &&
-                   ETH_P_IP == ntohs(buf.eth.h_proto) &&
-                   IPPROTO_UDP == buf.ip.protocol &&
-                   arprefresh_portnum == ntohs(buf.udp.source) &&
-                   arprefresh_portnum == ntohs(buf.udp.dest) ***/
-      ) {
+    if (0 <= size && size >= (ssize_t) sizeof(buf)) {
       union {
         struct arpreq arp;
         struct sockaddr_in in_pa;
@@ -166,25 +161,27 @@ olsrd_plugin_init(void)
     struct sock_fprog filter;
     struct sock_filter BPF_code[] = {
       /* tcpdump -s [sizeof(arprefresh_buf)] -ni lo udp and dst port [arprefresh_portnum] -dd */
-      {0x28, 0, 0, 0x0000000c},
-      {0x15, 0, 4, 0x000086dd},
-      {0x30, 0, 0, 0x00000014},
-      {0x15, 0, 11, 0x00000011},
-      {0x28, 0, 0, 0x00000038},
-      {0x15, 8, 9, arprefresh_portnum},
-      {0x15, 0, 8, 0x00000800},
-      {0x30, 0, 0, 0x00000017},
-      {0x15, 0, 6, 0x00000011},
-      {0x28, 0, 0, 0x00000014},
-      {0x45, 4, 0, 0x00001fff},
-      {0xb1, 0, 0, 0x0000000e},
-      {0x48, 0, 0, 0x00000010},
-      {0x15, 0, 1, arprefresh_portnum},
-      {0x6, 0, 0, sizeof(arprefresh_buf)}
-      ,
-      {0x6, 0, 0, 0x00000000}
+
+      /* Note: This program assumes NON-VLAN */
+      /* See also http://www.unix.com/man-page/FreeBSD/4/bpf/ */
+      /*      code                          jump-true jump-false generic-multiuse-field */
+             {BPF_LD  | BPF_H    | BPF_ABS , 0,        0,         0x0000000c},             // 0x28: A <- P[k:2], get 2-bytes from offset 0x0c : get Ethernet type
+
+/* test4  */ {BPF_JMP | BPF_JEQ  | BPF_K   , 0,        8,         0x00000800},             // 0x15: pc += (A == k) ? ipv4 : ignore            : IPv4?
+
+/* ipv4   */ {BPF_LD  | BPF_B    | BPF_ABS , 0,        0,         0x00000017},             // 0x30: A <- P[k:1], get 1-byte from offset 0x17  : get IPv4 protocol
+             {BPF_JMP | BPF_JEQ  | BPF_K   , 0,        6,         0x00000011},             // 0x15: pc += (A == k) ? udp4 : ignore            : UDP?
+/* udp4   */ {BPF_LD  | BPF_H    | BPF_ABS , 0,        0,         0x00000014},             // 0x28: A <- P[k:2], get 2-bytes from offset 0x14 : get fragment offset
+             {BPF_JMP | BPF_JSET | BPF_K   , 4,        0,         0x00001fff},             // 0x45: pc += (A & k) ? ignore : nofrag           : is this a fragment?
+/* nofrag */ {BPF_LDX | BPF_B    | BPF_MSH , 0,        0,         0x0000000e},             // 0xb1: X <- 4*(P[k:1]&0xf)                       : get the IP header length in bytes
+             {BPF_LD  | BPF_H    | BPF_IND , 0,        0,         0x00000010},             // 0x48: A <- P[X+k:2]                             : get UDP destination port
+             {BPF_JMP | BPF_JEQ  | BPF_K   , 0,        1,         arprefresh_portnum},     // 0x15: pc += (A == k) ? ok : ignore              : sent to port arprefresh_portnum?
+
+/* ok     */ {BPF_RET | BPF_K              , 0,        0,         sizeof(arprefresh_buf)}, //                                                 : accept sizeof(arprefresh_buf) bytes (all headers)
+/* ignore */ {BPF_RET | BPF_K              , 0,        0,         0x00000000}              //                                                 : accept 0 bytes
+
     };
-    filter.len = sizeof(BPF_code) / sizeof(BPF_code[0]);
+    filter.len = ARRAYSIZE(BPF_code);
     filter.filter = BPF_code;
     if (0 <= (arprefresh_sockfd = socket(PF_PACKET, SOCK_RAW, htons(ETH_P_IP)))
         && 0 <= (flags = fcntl(arprefresh_sockfd, F_GETFL))
index cff7b70..46047c9 100644 (file)
@@ -39,8 +39,6 @@ PLUGIN_VER =  1.7.0
 TOPDIR = ../..
 include $(TOPDIR)/Makefile.inc
 
-#LIBS +=       $(OS_LIB_PTHREAD)
-
 ifeq ($(OS),$(filter $(OS),linux android))
 
 default_target: $(PLUGIN_FULLNAME)
index d92f1b5..bbf5ced 100644 (file)
@@ -44,7 +44,7 @@ Set permissions, e.g.:
 
   chmod 0700 /dev/net/tun
 
-To configure BMF in OLSR, you must edit the file /etc/olsrd.conf
+To configure BMF in OLSR, you must edit the file /etc/olsrd/olsrd.conf
 to load the BMF plugin. For example, add the following lines:
 
   LoadPlugin "olsrd_bmf.so.1.7.0"
@@ -184,7 +184,7 @@ the forwarding towards non-OLSR enabled hosts are omitted):
 -------------------------
 
 All configuration of BMF is done via the "LoadPlugin" section in
-the /etc/olsrd.conf file.
+the /etc/olsrd/olsrd.conf file.
 
 The following gives an overview of all plugin parameters that can be
 configured. Unless otherwise stated, settings may differ for each node in the
@@ -354,7 +354,7 @@ non-OLSR interfaces.
 If you have network interfaces on which OLSR is *not* running, but you *do*
 want to forward multicast and local-broadcast IP packets, specify these
 interfaces one by one as "NonOlsrIf" parameters in the BMF plugin section
-of /etc/olsrd.conf. For example:
+of /etc/olsrd/olsrd.conf. For example:
 
   LoadPlugin "olsrd_bmf.so.1.7.0"
   {
@@ -374,7 +374,7 @@ as an OLSR-enabled interface.
 In a typical interworking configuration there is a network of OLSR hosts
 in which one host acts as a gateway to a fixed infrastructure network.
 Usually that host will be advertising a default route via the HNA
-mechanism, e.g. by adding the following lines to its /etc/olsrd.conf
+mechanism, e.g. by adding the following lines to its /etc/olsrd/olsrd.conf
 file:
 
   Hna4
@@ -411,7 +411,7 @@ add the following line /etc/mrouted.conf :
 
 Finally, mrouted does not accept interfaces with prefix length 32.
 Therefore, override the default IP address and prefix length of
-the BMF network interface, by editing the /etc/olsrd.conf file.
+the BMF network interface, by editing the /etc/olsrd/olsrd.conf file.
 For example:
 
   LoadPlugin "olsrd_bmf.so.1.7.0"
index df70317..01b85a4 100644 (file)
@@ -23,7 +23,7 @@ ABOUT
 
 Note that this code is a quick hack done at the Wizards Of Oz 3
 
-The plugin generates output (over a TCP socket) in the dot format.
+The plugin generates output (over a TCP-IPv4 socket) in the dot format.
 The dot tool generates visual presentations of directed graphs.
 It can be downloaded as part of the GraphViz package from:
 http://www.graphviz.org/
@@ -38,6 +38,8 @@ make install
 
 olsr-topology-view.pl is a simple script to visualize the dotdraw data
 on your computer. You will find some more explanations about the script at
+http://n0rg.org/node1448/OlsrTopologyVisualization/OlsrTopologyVisualization.htm
+or
 http://br1.einfach.org/OlsrTopologyVisualization
 
 - Henning Rogge
index 35dbe76..dc22c33 100644 (file)
@@ -43,7 +43,10 @@ PLUGIN_VER = 0.5
 TOPDIR = ../..
 include $(TOPDIR)/Makefile.inc
 
-LIBS +=                $(OS_LIB_PTHREAD)
+LIBS +=        $(OS_LIB_PTHREAD)
+
+# Must be specified along with -lpthread on linux
+CPPFLAGS += $(OS_CFLAG_PTHREAD)
 
 default_target: $(PLUGIN_FULLNAME)
 
index c006af1..027863c 100644 (file)
@@ -60,9 +60,6 @@
 #include <stdlib.h>
 #include <sys/time.h>
 #include <net/route.h>
-#ifdef __linux__
-#include <linux/in_route.h>
-#endif /* __linux__ */
 #include <unistd.h>
 #include <errno.h>
 #include <time.h>
index d6ea831..0dff3b7 100644 (file)
 #endif /* _WIN32 */
 
 #include "olsr.h"
+#include "builddata.h"
 #include "olsr_cfg.h"
 #include "interfaces.h"
+#include "gateway.h"
 #include "olsr_protocol.h"
 #include "net_olsr.h"
 #include "link_set.h"
@@ -184,6 +186,10 @@ static void build_nodes_body(struct autobuf *);
 
 static void build_all_body(struct autobuf *);
 
+#ifdef __linux__
+static void build_sgw_body(struct autobuf *);
+#endif /* __linux__ */
+
 #ifdef HTTPINFO_PUD
 static void build_pud_body(struct autobuf *);
 #endif /* HTTPINFO_PUD */
@@ -218,6 +224,9 @@ static const struct tab_entry tab_entries[] = {
   {"Configuration", "config", build_config_body, true},
   {"Routes", "routes", build_routes_body, true},
   {"Links/Topology", "nodes", build_nodes_body, true},
+#ifdef __linux__
+  {"Smart Gateway", "sgw", build_sgw_body, true},
+#endif /* __linux__ */
 #ifdef HTTPINFO_PUD
   {"Position", "position", build_pud_body, true},
 #endif /* HTTPINFO_PUD */
@@ -313,7 +322,7 @@ olsrd_plugin_init(void)
 
   if (http_socket < 0) {
     fprintf(stderr, "(HTTPINFO) could not initialize HTTP socket\n");
-    exit(0);
+    exit(1);
   }
 
   /* Register socket */
@@ -1098,6 +1107,9 @@ build_all_body(struct autobuf *abuf)
   build_neigh_body(abuf);
   build_topo_body(abuf);
   build_mid_body(abuf);
+#ifdef __linux__
+  build_sgw_body(abuf);
+#endif /* __linux__ */
 #ifdef HTTPINFO_PUD
   build_pud_body(abuf);
 #endif /* HTTPINFO_PUD */
@@ -1112,8 +1124,8 @@ build_all_body(struct autobuf *abuf)
  * @param fieldName use a name from nmeaINFO_FIELD
  * @return a boolean, true when the structure has the requested field
  */
-static inline bool nmea_INFO_has_field_local(uint32_t present, nmeaINFO_FIELD fieldName) {
-       return ((present & fieldName) != 0);
+static inline bool nmea_INFO_is_present_local(uint32_t present, nmeaINFO_FIELD fieldName) {
+  return ((present & fieldName) != 0);
 }
 
 static const char * NA_STRING = "N.A.";
@@ -1155,13 +1167,13 @@ static void build_pud_body(struct autobuf *abuf) {
 
        /* utc */
        abuf_puts(abuf, "<tr><td>Date / Time</td><td></td><td>UTC</td><td></td><td id=\"utc\">");
-       datePresent = nmea_INFO_has_field_local(txGpsInfo->txPosition.nmeaInfo.present, UTCDATE);
-       timePresent = nmea_INFO_has_field_local(txGpsInfo->txPosition.nmeaInfo.present, UTCTIME);
+       datePresent = nmea_INFO_is_present_local(txGpsInfo->txPosition.nmeaInfo.present, UTCDATE);
+       timePresent = nmea_INFO_is_present_local(txGpsInfo->txPosition.nmeaInfo.present, UTCTIME);
        if (datePresent || timePresent) {
                if (datePresent) {
                        abuf_appendf(abuf, "%04d%02d%02d",
                                txGpsInfo->txPosition.nmeaInfo.utc.year + 1900,
-                               txGpsInfo->txPosition.nmeaInfo.utc.mon,
+                               txGpsInfo->txPosition.nmeaInfo.utc.mon + 1,
                                txGpsInfo->txPosition.nmeaInfo.utc.day);
                }
                if (datePresent && timePresent) {
@@ -1179,9 +1191,76 @@ static void build_pud_body(struct autobuf *abuf) {
        }
        abuf_puts(abuf, "</td></tr>\n");
 
+       /* present */
+       abuf_puts(abuf, "<tr><td>Input Fields</td><td></td><td></td><td></td><td id=\"present\">");
+       if (txGpsInfo->txPosition.nmeaInfo.present != 0) {
+    const int id[] = {
+        SMASK,
+        UTCDATE,
+        UTCTIME,
+        SIG,
+        FIX,
+        PDOP,
+        HDOP,
+        VDOP,
+        LAT,
+        LON,
+        ELV,
+        SPEED,
+        TRACK,
+        MTRACK,
+        MAGVAR,
+        SATINUSECOUNT,
+        SATINUSE,
+        SATINVIEW,
+        0 };
+               const char * ids[] = {
+        "SMASK",
+        "UTCDATE",
+        "UTCTIME",
+        "SIG",
+        "FIX",
+        "PDOP",
+        "HDOP",
+        "VDOP",
+        "LAT",
+        "LON",
+        "ELV",
+        "SPEED",
+        "TRACK",
+        "MTRACK",
+        "MAGVAR",
+        "SATINUSECOUNT",
+        "SATINUSE",
+        "SATINVIEW" };
+               bool printed = false;
+               int i = 0;
+               int count = 0;
+
+               while (id[i] != 0) {
+                       if (txGpsInfo->txPosition.nmeaInfo.present & id[i]) {
+                               if (printed) {
+                                 if (count >= 8) {
+                                   abuf_puts(abuf, "<br/>");
+                                   count = 0;
+                                 } else {
+                                   abuf_puts(abuf, "&nbsp;");
+                                 }
+                               }
+                               abuf_puts(abuf, ids[i]);
+                               count++;
+                               printed = true;
+                       }
+                       i++;
+               }
+       } else {
+               abuf_puts(abuf, NA_STRING);
+       }
+       abuf_puts(abuf, "</td></tr>\n");
+
        /* smask */
        abuf_puts(abuf, "<tr><td>Input Sentences</td><td></td><td></td><td></td><td id=\"smask\">");
-       if (nmea_INFO_has_field_local(txGpsInfo->txPosition.nmeaInfo.present, SMASK)
+       if (nmea_INFO_is_present_local(txGpsInfo->txPosition.nmeaInfo.present, SMASK)
                        && (txGpsInfo->txPosition.nmeaInfo.smask != GPNON)) {
                const int id[] = { GPGGA, GPGSA, GPGSV, GPRMC, GPVTG, GPNON };
                const char * ids[] = { "GPGGA", "GPGSA", "GPGSV", "GPRMC", "GPVTG" };
@@ -1204,7 +1283,7 @@ static void build_pud_body(struct autobuf *abuf) {
 
        /* sig */
        abuf_puts(abuf, "<tr><td>Signal Strength</td><td></td><td></td><td></td><td id=\"sig\">");
-       if (nmea_INFO_has_field_local(txGpsInfo->txPosition.nmeaInfo.present, SIG)) {
+       if (nmea_INFO_is_present_local(txGpsInfo->txPosition.nmeaInfo.present, SIG)) {
                const char * s;
                switch (txGpsInfo->txPosition.nmeaInfo.sig) {
                        case NMEA_SIG_BAD:
@@ -1246,7 +1325,7 @@ static void build_pud_body(struct autobuf *abuf) {
 
        /* fix */
        abuf_puts(abuf, "<tr><td>Fix</td><td></td><td></td><td></td><td id=\"fix\">");
-       if (nmea_INFO_has_field_local(txGpsInfo->txPosition.nmeaInfo.present, FIX)) {
+       if (nmea_INFO_is_present_local(txGpsInfo->txPosition.nmeaInfo.present, FIX)) {
                const char * s;
                switch (txGpsInfo->txPosition.nmeaInfo.fix) {
                        case NMEA_FIX_BAD:
@@ -1270,7 +1349,7 @@ static void build_pud_body(struct autobuf *abuf) {
 
        /* PDOP */
        abuf_puts(abuf, "<tr><td>PDOP</td><td></td><td></td><td></td><td id=\"pdop\">");
-       if (nmea_INFO_has_field_local(txGpsInfo->txPosition.nmeaInfo.present, PDOP)) {
+       if (nmea_INFO_is_present_local(txGpsInfo->txPosition.nmeaInfo.present, PDOP)) {
                abuf_appendf(abuf, "%f", txGpsInfo->txPosition.nmeaInfo.PDOP);
        } else {
                abuf_puts(abuf, NA_STRING);
@@ -1279,7 +1358,7 @@ static void build_pud_body(struct autobuf *abuf) {
 
        /* HDOP */
        abuf_puts(abuf, "<tr><td>HDOP</td><td></td><td></td><td></td><td id=\"hdop\">");
-       if (nmea_INFO_has_field_local(txGpsInfo->txPosition.nmeaInfo.present, HDOP)) {
+       if (nmea_INFO_is_present_local(txGpsInfo->txPosition.nmeaInfo.present, HDOP)) {
                abuf_appendf(abuf, "%f", txGpsInfo->txPosition.nmeaInfo.HDOP);
        } else {
                abuf_puts(abuf, NA_STRING);
@@ -1288,7 +1367,7 @@ static void build_pud_body(struct autobuf *abuf) {
 
        /* VDOP */
        abuf_puts(abuf, "<tr><td>VDOP</td><td></td><td></td><td></td><td id=\"vdop\">");
-       if (nmea_INFO_has_field_local(txGpsInfo->txPosition.nmeaInfo.present, VDOP)) {
+       if (nmea_INFO_is_present_local(txGpsInfo->txPosition.nmeaInfo.present, VDOP)) {
                abuf_appendf(abuf, "%f", txGpsInfo->txPosition.nmeaInfo.VDOP);
        } else {
                abuf_puts(abuf, NA_STRING);
@@ -1297,7 +1376,7 @@ static void build_pud_body(struct autobuf *abuf) {
 
        /* lat */
        abuf_puts(abuf, "<tr><td>Latitude</td><td></td><td>degrees</td><td></td><td id=\"lat\">");
-       if (nmea_INFO_has_field_local(txGpsInfo->txPosition.nmeaInfo.present, LAT)) {
+       if (nmea_INFO_is_present_local(txGpsInfo->txPosition.nmeaInfo.present, LAT)) {
                abuf_appendf(abuf, "%f", txGpsInfo->txPosition.nmeaInfo.lat);
        } else {
                abuf_puts(abuf, NA_STRING);
@@ -1306,7 +1385,7 @@ static void build_pud_body(struct autobuf *abuf) {
 
        /* lon */
        abuf_puts(abuf, "<tr><td>Longitude</td><td></td><td>degrees</td><td></td><td id=\"lon\">");
-       if (nmea_INFO_has_field_local(txGpsInfo->txPosition.nmeaInfo.present, LON)) {
+       if (nmea_INFO_is_present_local(txGpsInfo->txPosition.nmeaInfo.present, LON)) {
                abuf_appendf(abuf, "%f", txGpsInfo->txPosition.nmeaInfo.lon);
        } else {
                abuf_puts(abuf, NA_STRING);
@@ -1315,7 +1394,7 @@ static void build_pud_body(struct autobuf *abuf) {
 
        /* elv */
        abuf_puts(abuf, "<tr><td>Elevation</td><td></td><td>m</td><td></td><td id=\"elv\">");
-       if (nmea_INFO_has_field_local(txGpsInfo->txPosition.nmeaInfo.present, ELV)) {
+       if (nmea_INFO_is_present_local(txGpsInfo->txPosition.nmeaInfo.present, ELV)) {
                abuf_appendf(abuf, "%f", txGpsInfo->txPosition.nmeaInfo.elv);
        } else {
                abuf_puts(abuf, NA_STRING);
@@ -1324,7 +1403,7 @@ static void build_pud_body(struct autobuf *abuf) {
 
        /* speed */
        abuf_puts(abuf, "<tr><td>Speed</td><td></td><td>kph</td><td></td><td id=\"speed\">");
-       if (nmea_INFO_has_field_local(txGpsInfo->txPosition.nmeaInfo.present, SPEED)) {
+       if (nmea_INFO_is_present_local(txGpsInfo->txPosition.nmeaInfo.present, SPEED)) {
                abuf_appendf(abuf, "%f", txGpsInfo->txPosition.nmeaInfo.speed);
        } else {
                abuf_puts(abuf, NA_STRING);
@@ -1333,7 +1412,7 @@ static void build_pud_body(struct autobuf *abuf) {
 
        /* track */
        abuf_puts(abuf, "<tr><td>Track</td><td></td><td>degrees</td><td></td><td id=\"track\">");
-       if (nmea_INFO_has_field_local(txGpsInfo->txPosition.nmeaInfo.present, TRACK)) {
+       if (nmea_INFO_is_present_local(txGpsInfo->txPosition.nmeaInfo.present, TRACK)) {
                abuf_appendf(abuf, "%f", txGpsInfo->txPosition.nmeaInfo.track);
        } else {
                abuf_puts(abuf, NA_STRING);
@@ -1342,7 +1421,7 @@ static void build_pud_body(struct autobuf *abuf) {
 
        /* mtrack */
        abuf_puts(abuf, "<tr><td>Magnetic Track</td><td></td><td>degrees</td><td></td><td id=\"mtrack\">");
-       if (nmea_INFO_has_field_local(txGpsInfo->txPosition.nmeaInfo.present, MTRACK)) {
+       if (nmea_INFO_is_present_local(txGpsInfo->txPosition.nmeaInfo.present, MTRACK)) {
                abuf_appendf(abuf, "%f", txGpsInfo->txPosition.nmeaInfo.mtrack);
        } else {
                abuf_puts(abuf, NA_STRING);
@@ -1351,7 +1430,7 @@ static void build_pud_body(struct autobuf *abuf) {
 
        /* magvar */
        abuf_puts(abuf, "<tr><td>Magnetic Variation</td><td></td><td>degrees</td><td></td><td id=\"magvar\">");
-       if (nmea_INFO_has_field_local(txGpsInfo->txPosition.nmeaInfo.present, MAGVAR)) {
+       if (nmea_INFO_is_present_local(txGpsInfo->txPosition.nmeaInfo.present, MAGVAR)) {
                abuf_appendf(abuf, "%f", txGpsInfo->txPosition.nmeaInfo.magvar);
        } else {
                abuf_puts(abuf, NA_STRING);
@@ -1362,7 +1441,7 @@ static void build_pud_body(struct autobuf *abuf) {
        abuf_puts(abuf, "</table></p>\n");
 
        /* sats */
-       if (nmea_INFO_has_field_local(txGpsInfo->txPosition.nmeaInfo.present, SATINVIEW)) {
+       if (nmea_INFO_is_present_local(txGpsInfo->txPosition.nmeaInfo.present, SATINVIEW)) {
                int cnt = 0;
 
                abuf_puts(abuf, "<p>\n");
@@ -1380,7 +1459,7 @@ static void build_pud_body(struct autobuf *abuf) {
                                        bool inuse = false;
                                        const char * inuseStr;
 
-                                       if (!nmea_INFO_has_field_local(txGpsInfo->txPosition.nmeaInfo.present, SATINUSE)) {
+                                       if (!nmea_INFO_is_present_local(txGpsInfo->txPosition.nmeaInfo.present, SATINUSE)) {
                                                inuseStr = NA_STRING;
                                        } else {
                                                int inuseIndex;
@@ -1413,8 +1492,8 @@ static void build_pud_body(struct autobuf *abuf) {
        }
 
        /* add Google Maps and OpenStreetMap links when we have both lat and lon */
-       if (nmea_INFO_has_field_local(txGpsInfo->txPosition.nmeaInfo.present, LAT)
-                       && nmea_INFO_has_field_local(txGpsInfo->txPosition.nmeaInfo.present, LON)) {
+       if (nmea_INFO_is_present_local(txGpsInfo->txPosition.nmeaInfo.present, LAT)
+                       && nmea_INFO_is_present_local(txGpsInfo->txPosition.nmeaInfo.present, LON)) {
                const char * c = nodeId;
 
                abuf_appendf(abuf,
@@ -1445,6 +1524,118 @@ static void build_pud_body(struct autobuf *abuf) {
 }
 #endif /* HTTPINFO_PUD */
 
+#ifdef __linux__
+
+/**
+ * Construct the sgw table for a given ip version
+ *
+ * @param abuf the string buffer
+ * @param ipv6 true for IPv6, false for IPv4
+ */
+static void sgw_ipvx(struct autobuf *abuf, bool ipv6) {
+  struct gateway_entry * current_gw;
+  struct gw_list * list;
+  struct gw_container_entry * gw;
+
+  list = ipv6 ? &gw_list_ipv6 : &gw_list_ipv4;
+  if (!list->count) {
+    abuf_appendf(abuf, "<p><b>No IPv%s Gateways</b></p>\n", ipv6 ? "6" : "4");
+  } else {
+    char buf[INET6_ADDRSTRLEN];
+    memset(buf, 0, sizeof(buf));
+
+    abuf_appendf(abuf, "<p><b>IPv%s Gateways</b></p>\n", ipv6 ? "6" : "4");
+    abuf_puts(abuf, "<p>\n");
+    abuf_appendf(abuf, "<table border=\"1\" cellpadding=\"2\" cellspacing=\"0\" id=\"sgw_ipv%s\">\n", ipv6 ? "6" : "4");
+    abuf_puts(abuf, "  <tbody align=\"center\">\n");
+    abuf_puts(abuf, "    <tr>\n");
+    abuf_puts(abuf, "      <th><center>Originator</center></th>\n");
+    abuf_puts(abuf, "      <th><center>Prefix</center></th>\n");
+    abuf_puts(abuf, "      <th><center>Uplink (kbps)</center></th>\n");
+    abuf_puts(abuf, "      <th><center>Downlink (kbps)</center></th>\n");
+    abuf_puts(abuf, "      <th><center>Path Cost</center></th>\n");
+    abuf_puts(abuf, "      <th><center>IPv4</center></th>\n");
+    abuf_puts(abuf, "      <th><center>IPv4 NAT</center></th>\n");
+    abuf_puts(abuf, "      <th><center>IPv6</center></th>\n");
+    abuf_puts(abuf, "      <th><center>Tunnel Name</center></th>\n");
+    abuf_puts(abuf, "      <th><center>Destination</center></th>\n");
+    abuf_puts(abuf, "      <th><center>Cost</center></th>\n");
+    abuf_puts(abuf, "    </tr>\n");
+
+    current_gw = olsr_get_inet_gateway(false);
+    OLSR_FOR_ALL_GWS(&list->head, gw) {
+      if (gw) {
+        bool is_current = (current_gw && (gw->gw == current_gw));
+
+        if (is_current) {
+          abuf_puts(abuf, "    <tr bgcolor=\"lime\">\n");
+        } else {
+          abuf_puts(abuf, "    <tr>\n");
+        }
+
+        if (!gw->gw) {
+          int i;
+          for (i = 0; i < 8; i++) {
+            abuf_puts(abuf, "      <td></td>\n");
+          }
+        } else {
+          struct tc_entry* tc = olsr_lookup_tc_entry(&gw->gw->originator);
+          olsr_linkcost etx = ROUTE_COST_BROKEN;
+          if (tc) {
+            etx = tc->path_cost;
+          }
+
+          abuf_appendf(abuf, "      <td>%s</td>\n", inet_ntop(ipv6 ? AF_INET6 : AF_INET, &gw->gw->originator, buf, sizeof(buf)));
+          abuf_appendf(abuf, "      <td>%s</td>\n", olsr_ip_prefix_to_string(&gw->gw->external_prefix));
+          abuf_appendf(abuf, "      <td>%u</td>\n", gw->gw->uplink);
+          abuf_appendf(abuf, "      <td>%u</td>\n", gw->gw->downlink);
+
+          if (tc->path_cost == ROUTE_COST_BROKEN) {
+            abuf_appendf(abuf, "      <td>Unreachable</td>\n");
+          } else {
+            abuf_appendf(abuf, "      <td>%u</td>\n", etx);
+          }
+
+          abuf_appendf(abuf, "      <td>%s</td>\n", gw->gw->ipv4 ? "yes" : "no");
+          abuf_appendf(abuf, "      <td>%s</td>\n", gw->gw->ipv4nat ? "yes" : "no");
+          abuf_appendf(abuf, "      <td>%s</td>\n", gw->gw->ipv6 ? "yes" : "no");
+        }
+        if (!gw->tunnel) {
+          int i;
+          for (i = 0; i < 2; i++) {
+            abuf_puts(abuf, "      <td></td>\n");
+          }
+        } else {
+          abuf_appendf(abuf, "      <td>%s</td>\n", gw->tunnel->if_name);
+          abuf_appendf(abuf, "      <td>%s</td>\n", inet_ntop(ipv6 ? AF_INET6 : AF_INET, &gw->tunnel->target, buf, sizeof(buf)));
+        }
+        if (!gw->gw) {
+          abuf_puts(abuf, "      <td></td>\n");
+        } else {
+          abuf_appendf(abuf, "      <td>%llu</td>\n", (long long unsigned int)gw->gw->path_cost);
+        }
+        abuf_puts(abuf, "    </tr>\n");
+      }
+    } OLSR_FOR_ALL_GWS_END(gw);
+    abuf_puts(abuf, "  </tbody>\n");
+    abuf_puts(abuf, "</table>\n");
+    abuf_puts(abuf, "</p>\n");
+  }
+}
+
+static void build_sgw_body(struct autobuf *abuf) {
+  abuf_puts(abuf, "<h2>Smart Gateway System</h2>\n");
+
+  if (!olsr_cnf->smart_gw_active) {
+    abuf_puts(abuf, "<p><b>Smart Gateway system is not enabled</b></p>\n");
+    return;
+  }
+
+  sgw_ipvx(abuf, false);
+  sgw_ipvx(abuf, true);
+}
+#endif /* __linux__ */
+
 static void
 build_about_body(struct autobuf *abuf)
 {
index 8311ade..4e63859 100644 (file)
@@ -48,7 +48,7 @@ start-up information:
 * /plugins - currently loaded plugins and their config parameters
 
 start-up information not in JSON format:
-* /olsrd.conf - the current config, formatted for writing directly to /etc/olsrd.conf
+* /olsrd.conf - the current config, formatted for writing directly to /etc/olsrd/olsrd.conf
 
 
 PLUGIN CONFIGURATION
index e85a4b9..d86fa88 100644 (file)
@@ -73,6 +73,7 @@
 
 #include "ipcalc.h"
 #include "olsr.h"
+#include "builddata.h"
 #include "olsr_types.h"
 #include "neighbor_table.h"
 #include "two_hop_neighbor_table.h"
@@ -1005,8 +1006,30 @@ ipc_print_config(struct autobuf *abuf)
   abuf_json_string(abuf, "lockFile", olsr_cnf->lock_file);
   abuf_json_boolean(abuf, "useNiit", olsr_cnf->use_niit);
 
+#ifdef __linux__
   abuf_json_boolean(abuf, "smartGateway", olsr_cnf->smart_gw_active);
   if (olsr_cnf->smart_gw_active) {
+    abuf_json_boolean(abuf, "smartGatewayAlwaysRemoveServerTunnel", olsr_cnf->smart_gw_always_remove_server_tunnel);
+    abuf_json_int(abuf, "smartGatewayUseCount", olsr_cnf->smart_gw_use_count);
+    abuf_json_string(abuf, "smartGatewayPolicyRoutingScript", olsr_cnf->smart_gw_policyrouting_script);
+    {
+      struct autobuf egressbuf;
+      struct sgw_egress_if * egressif = olsr_cnf->smart_gw_egress_interfaces;
+
+      abuf_init(&egressbuf, (olsr_cnf->smart_gw_egress_interfaces_count * IFNAMSIZ) /* interface names */
+          + (olsr_cnf->smart_gw_egress_interfaces_count - 1) /* commas */);
+      while (egressif) {
+        if (egressbuf.len) {
+          abuf_puts(&egressbuf, ",");
+        }
+        abuf_appendf(&egressbuf, "%s", egressif->name);
+        egressif = egressif->next;
+      }
+      abuf_json_string(abuf, "smartGatewayEgressInterfaces", egressbuf.buf);
+      abuf_free(&egressbuf);
+    }
+    abuf_json_int(abuf, "smartGatewayTablesOffset", olsr_cnf->smart_gw_offset_tables);
+    abuf_json_int(abuf, "smartGatewayRulesOffset", olsr_cnf->smart_gw_offset_rules);
     abuf_json_boolean(abuf, "smartGatewayAllowNat", olsr_cnf->smart_gw_allow_nat);
     abuf_json_boolean(abuf, "smartGatewayUplinkNat", olsr_cnf->smart_gw_uplink_nat);
     abuf_json_int(abuf, "smartGatewayPeriod", olsr_cnf->smart_gw_period);
@@ -1019,6 +1042,7 @@ ipc_print_config(struct autobuf *abuf)
                      olsr_ip_to_string(&mainaddrbuf, &olsr_cnf->smart_gw_prefix.prefix));
     abuf_json_int(abuf, "smartGatewayPrefixLength", olsr_cnf->smart_gw_prefix.prefix_len);
   }
+#endif /* __linux__ */
 
   abuf_json_string(abuf, "mainIpAddress",
                    olsr_ip_to_string(&mainaddrbuf, &olsr_cnf->main_addr));
@@ -1284,7 +1308,7 @@ send_info(unsigned int send_what, int the_socket)
   abuf_init(&abuf, 32768);
 
  // only add if outputing JSON
-  if (send_what & SIW_ALL) abuf_json_open_array_entry(&abuf);
+  if (send_what & SIW_ALL) abuf_puts(&abuf, "{");
 
   if ((send_what & SIW_LINKS) == SIW_LINKS) ipc_print_links(&abuf);
   if ((send_what & SIW_NEIGHBORS) == SIW_NEIGHBORS) ipc_print_neighbors(&abuf);
@@ -1306,7 +1330,7 @@ send_info(unsigned int send_what, int the_socket)
     abuf_json_int(&abuf, "timeSinceStartup", now_times);
     if(*uuid != 0)
       abuf_json_string(&abuf, "uuid", uuid);
-    abuf_json_close_array_entry(&abuf);
+      abuf_puts(&abuf, "}\n");
   }
 
   /* this outputs the olsrd.conf text directly, not JSON */
index b27f007..e158d8c 100644 (file)
@@ -6,15 +6,23 @@ PLUGIN_VER =  1.0.1
 TOPDIR = ../..
 include $(TOPDIR)/Makefile.inc
 
-LIBS +=        $(OS_LIB_PTHREAD)
+SUPPORTED = 0
+ifeq ($(OS),linux)
+SUPPORTED = 1
+endif
+ifeq ($(OS),android)
+SUPPORTED = 1
+endif
+
+
+ifeq ($(SUPPORTED),0)
 
-# Must be specified along with -lpthread on linux
-CPPFLAGS += $(OS_CFLAG_PTHREAD)
+.PHONY: all default_target install clean
 
-ifneq ($(OS),linux)
+all: default_target
 
 default_target install clean:
-       @echo "*** mdns Plugin only supported on Linux, sorry!"
+       @echo "*** $(PLUGIN_NAME) plugin not supported on $(OS), sorry!"
 
 else
 
index 44cd522..831a004 100644 (file)
@@ -285,7 +285,7 @@ CreateRouterElectionSocket(const char *ifName)
                        BmfPError("Could not get ipv4 address of %s interface", ifName);
                        goto bail;
                }
-               ipv4_addr = ((struct sockaddr_in *)&req.ifr_addr)->sin_addr;
+               ipv4_addr = ((struct sockaddr_in *)(void *) &req.ifr_addr)->sin_addr;
                mc_settings.imr_interface = ipv4_addr;
                errno = 0;
                if (setsockopt(rxSocket, ipProtoSetting, ipAddMembershipSetting,
@@ -380,7 +380,7 @@ static int CreateHelloSocket(const char *ifName) {
                        BmfPError("Could not get ipv4 address of %s interface", ifName);
                        goto bail;
                }
-               ipv4_addr = ((struct sockaddr_in *)&req.ifr_addr)->sin_addr;
+               ipv4_addr = ((struct sockaddr_in *)(void *) &req.ifr_addr)->sin_addr;
                address.in4.sin_addr = ipv4_addr;
                address.in4.sin_family = ipFamilySetting;
                address.in4.sin_port = ipPort;
index cb15027..dba336a 100644 (file)
@@ -7,7 +7,6 @@
 #include <assert.h>             /* assert() */
 #include <linux/if_ether.h>     /* ETH_P_IP */
 #include <linux/if_packet.h>    /* struct sockaddr_ll, PACKET_MULTICAST */
-//#include <pthread.h> /* pthread_t, pthread_create() */
 #include <signal.h>             /* sigset_t, sigfillset(), sigdelset(), SIGINT */
 #include <netinet/ip.h>         /* struct ip */
 #include <netinet/udp.h>        /* struct udphdr */
index ca3150c..4fcaebd 100644 (file)
@@ -55,7 +55,7 @@
  * @param member name of node inside struct
  * @return pointer to surrounding struct
  */
-#define container_of(ptr, type, member) ((type *)( (char *)(ptr) - offsetof(type,member) ))
+#define container_of(ptr, type, member) ((type *) (((size_t) ptr) - offsetof(type, member) ))
 
 /**
  * Helper function for NULL safe container_of macro
index 2d5e06a..3eaba16 100644 (file)
@@ -50,7 +50,6 @@
 #include <assert.h>             /* assert() */
 #include <linux/if_ether.h>     /* ETH_P_IP */
 #include <linux/if_packet.h>    /* struct sockaddr_ll, PACKET_MULTICAST */
-//#include <pthread.h> /* pthread_t, pthread_create() */
 #include <signal.h>             /* sigset_t, sigfillset(), sigdelset(), SIGINT */
 #include <netinet/ip.h>         /* struct ip */
 #include <netinet/udp.h>        /* struct udphdr */
@@ -91,8 +90,8 @@ static uint16_t ip_checksum(char* data, int len)
     else
         len = (len >> 1) + 1;
     while (len > 0) {
-        sum += *((ushort*)data);
-        data += sizeof(ushort);
+        sum += *((unsigned short int*)(void *)data);
+        data += sizeof(unsigned short int);
         len--;
     }
     sum = (sum >> 16) + (sum & 0xffff);
index 625f994..ff47b3f 100644 (file)
@@ -24,7 +24,7 @@ PlParam "test" "anything"
 SAMPLE CONFIG
 ---------------------------------------------------------------------
 
-add in /etc/olsrd.conf:
+add in /etc/olsrd/olsrd.conf:
 
 LoadPlugin "olsrd_mini.so.0.1"
 {
index 828139d..a91b921 100644 (file)
@@ -66,8 +66,8 @@ PlParam "interval" "SEC"
        (default: 120 - 2 minutes)
 
 PlParam "timeout" "SEC"
-       validity time for received NAME messages in seconds.
-       (default: 3600 - 1 hour)
+       validity time for transmitted NAME messages in seconds.
+       (default: 1800 - 30 minutes)
 
 PlParam "lat" "12.123"
        Float: Decimal latitude for this node to be flooded in the mesh
@@ -142,7 +142,7 @@ PlParam "macs-change-script" "/path/to/script"
 SAMPLE CONFIG
 ---------------------------------------------------------------------
 
-add in /etc/olsrd.conf:
+add in /etc/olsrd/olsrd.conf:
 
 LoadPlugin "olsrd_nameservice.so.0.2"
 {
index b6dc775..c8a2f90 100644 (file)
@@ -6,15 +6,23 @@ PLUGIN_VER =  0.1.0
 TOPDIR = ../..
 include $(TOPDIR)/Makefile.inc
 
-LIBS +=        $(OS_LIB_PTHREAD)
+SUPPORTED = 0
+ifeq ($(OS),linux)
+SUPPORTED = 1
+endif
+ifeq ($(OS),android)
+SUPPORTED = 1
+endif
+
+
+ifeq ($(SUPPORTED),0)
 
-# Must be specified along with -lpthread on linux
-CPPFLAGS += $(OS_CFLAG_PTHREAD)
+.PHONY: all default_target install clean
 
-ifneq ($(OS),linux)
+all: default_target
 
 default_target install clean:
-       @echo "*** p2pd Plugin only supported on Linux, sorry!"
+       @echo "*** $(PLUGIN_NAME) plugin not supported on $(OS), sorry!"
 
 else
 
index c89f292..b5c44a5 100644 (file)
@@ -67,6 +67,8 @@ PlParam     "P2pdTtl"     "5"
 PlParam     "UdpDestPort" "255.255.255.255 1211"
 #   MDNS multicast (draft-cheshire-dnsext-multicastdns)
 PlParam     "UdpDestPort" "224.0.0.251 5353"
+# Set to 1 to decrement the TTL on the packet going into the OLSR network (default 0)
+#PlParam     "UseTTLDecrement" "0"
 }
 
 Where eth0 and eth1 are the names of the interfaces where you want to capture
index 737cef8..da2d9c0 100644 (file)
@@ -112,6 +112,7 @@ static const struct olsrd_plugin_parameters plugin_parameters[] = {
   {.name = "P2pdTtl", .set_plugin_parameter = &SetP2pdTtl, .data = NULL },
   {.name = "UdpDestPort",.set_plugin_parameter = &AddUdpDestPort,.data = NULL},
   {.name = "UseHashFilter",.set_plugin_parameter = &SetP2pdUseHashFilter,.data = NULL},
+  {.name = "UseTTLDecrement",.set_plugin_parameter = &SetP2pdUseTtlDecrement,.data = NULL},
 };
 
 /* -------------------------------------------------------------------------
index 73905a0..6e3f98c 100644 (file)
@@ -52,7 +52,6 @@
 #include <fcntl.h>
 #include <linux/if_ether.h>     /* ETH_P_IP */
 #include <linux/if_packet.h>    /* struct sockaddr_ll, PACKET_MULTICAST */
-//#include <pthread.h> /* pthread_t, pthread_create() */
 #include <signal.h>             /* sigset_t, sigfillset(), sigdelset(), SIGINT */
 #include <netinet/ip.h>         /* struct ip */
 #include <netinet/udp.h>        /* struct udphdr */
@@ -86,6 +85,7 @@
 
 int P2pdTtl                        = 0;
 int P2pdUseHash                    = 0;  /* Switch off hash filter by default */
+int P2pdUseTtlDecrement            = 0;  /* No TTL decrement by default */
 int P2pdDuplicateTimeout           = P2PD_VALID_TIME;
 
 /* List of UDP destination address and port information */
@@ -604,6 +604,46 @@ InUdpDestPortList(int ip_version, union olsr_ip_addr *addr, uint16_t port)
   return false;
 }
 
+/*
+ * Function for checksum calculation.
+ * From the RFC, the checksum algorithm is:
+ *   "The checksum field is the 16 bit one's complement of the one's
+ *   complement sum of all 16 bit words in the header. For purposes of
+ *   computing the checksum, the value of the checksum field is zero."
+ *
+ * For example, consider Hex 4500003044224000800600008c7c19acae241e2b (20 bytes IP header):
+ * - Step 1) 4500 + 0030 + 4422 + 4000 + 8006 + 0000 + 8c7c + 19ac + ae24 + 1e2b = 0002`BBCF (16-bit sum)
+ * - Step 2) 0002 + BBCF = BBD1 = 1011101111010001 (1's complement 16-bit sum)
+ * - Step 3) ~BBD1 = 0100010000101110 = 442E (1's complement of 1's complement 16-bit sum)
+ */
+static void recomputeIPv4HeaderChecksum(struct ip *header) {
+  uint32_t sum;
+  uint32_t nwords;
+  u_short *headerWords;
+
+  if (!header) {
+    return;
+  }
+
+  header->ip_sum = 0;
+  nwords = header->ip_hl << 1;
+  headerWords = (u_short *) header;
+
+  /* step 1 */
+  for (sum = 0; nwords > 0; nwords--) {
+    sum += ntohs(*headerWords);
+    headerWords++;
+  }
+
+  /* step 2 */
+  sum = (sum >> 16) + (sum & 0xffff);
+
+  /* step 3 */
+  sum = ~sum & 0xffff;
+
+  header->ip_sum = htons((u_short)sum);
+}
+
 /* -------------------------------------------------------------------------
  * Function   : P2pdPacketCaptured
  * Description: Handle a captured IP packet
@@ -623,6 +663,8 @@ P2pdPacketCaptured(unsigned char *encapsulationUdpData, int nBytes)
   struct ip *ipHeader;         /* The IP header inside the captured IP packet */
   struct ip6_hdr *ipHeader6;   /* The IP header inside the captured IP packet */
   struct udphdr *udpHeader;
+  uint8_t * ttl = NULL;
+  int recomputeChecksum = 0;
   u_int16_t destPort;
 
   if ((encapsulationUdpData[0] & 0xf0) == 0x40) {       //IPV4
@@ -663,6 +705,9 @@ P2pdPacketCaptured(unsigned char *encapsulationUdpData, int nBytes)
 #endif /* INCLUDE_DEBUG_OUTPUT */
        return;
     }
+
+    ttl = &ipHeader->ip_ttl;
+    recomputeChecksum = 1;
   }                            //END IPV4
   else if ((encapsulationUdpData[0] & 0xf0) == 0x60) {  //IPv6
 
@@ -704,11 +749,29 @@ P2pdPacketCaptured(unsigned char *encapsulationUdpData, int nBytes)
 #endif /* INCLUDE_DEBUG_OUTPUT */
       return;
     }
+
+    ttl = &ipHeader6->ip6_ctlun.ip6_un1.ip6_un1_hlim;
+    recomputeChecksum = 0;
   }                             //END IPV6
   else {
     return;                     //Is not IP packet
   }
 
+  if (P2pdUseTtlDecrement) {
+    assert(ttl);
+    if (!*ttl) {
+      return;
+    }
+    *ttl -= 1;
+    if (!*ttl) {
+      return;
+    }
+
+    if (recomputeChecksum) {
+      recomputeIPv4HeaderChecksum(ipHeader);
+    }
+  }
+
   // send the packet to OLSR forward mechanism
   olsr_p2pd_gen(encapsulationUdpData, nBytes);
 }                               /* P2pdPacketCaptured */
@@ -862,6 +925,27 @@ SetP2pdUseHashFilter(const char *value,
   return 0;
 }
 
+/* -------------------------------------------------------------------------
+ * Function   : SetP2pdUseTtlDecrement
+ * Description: Set the TTL decrement lag for this plug-in
+ * Input      : value - parameter value to evaluate
+ *              data  - data associated with this parameter (unused in this app)
+ *              addon - additional parameter data
+ * Output     : none
+ * Return     : Always 0
+ * Data Used  : P2pdUseTtlDecrement
+ * ------------------------------------------------------------------------- */
+int
+SetP2pdUseTtlDecrement(const char *value,
+                     void *data __attribute__ ((unused)),
+                     set_plugin_parameter_addon addon __attribute__ ((unused)))
+{
+  assert(value != NULL);
+  P2pdUseTtlDecrement = atoi(value);
+
+  return 0;
+}
+
 /* -------------------------------------------------------------------------
  * Function   : AddUdpDestPort
  * Description: Set the UDP destination/port combination as an entry in the
index 4f90bbf..5d1762f 100644 (file)
@@ -99,6 +99,7 @@ int AddUdpDestPort(const char *value, void *data __attribute__ ((unused)), set_p
 bool InUdpDestPortList(int ip_version, union olsr_ip_addr *addr, uint16_t port);
 int SetP2pdTtl(const char *value, void *data __attribute__ ((unused)), set_plugin_parameter_addon addon __attribute__ ((unused)));
 int SetP2pdUseHashFilter(const char *value, void *data __attribute__ ((unused)), set_plugin_parameter_addon addon __attribute__ ((unused)));
+int SetP2pdUseTtlDecrement(const char *value, void *data __attribute__ ((unused)), set_plugin_parameter_addon addon __attribute__ ((unused)));
 bool p2pd_message_seen(struct node **head, struct node **tail, union olsr_message *m);
 void p2pd_store_message(struct node **head, struct node **tail, union olsr_message *m);
 bool p2pd_is_duplicate_message(union olsr_message *msg);
index bc73f69..a663bc3 100644 (file)
@@ -39,7 +39,7 @@ Usage:
            run "make" and "make install"
           This will create the "olsrd_pgraph.so.1.1" file and install it. 
 
-       3) Modify the "/etc/olsrd.conf" file of the system you wish to
+       3) Modify the "/etc/olsrd/olsrd.conf" file of the system you wish to
           monitor from to load the plugin. 
           Add the line: "LoadPlugin "olsrd_pgraph.so.1.1" {}"
 
@@ -51,7 +51,7 @@ Usage:
            # By default only localhost will be able to connect to the IPC
           # system of the olsrd process so if you are not going to be 
           # running pgraph locally, modify the "Host" variable of the 
-          # "IpcConnect" structure in the "/etc/olsrd.conf" file to 
+          # "IpcConnect" structure in the "/etc/olsrd/olsrd.conf" file to
           # reflect the IP address of the host you will be connecting from. 
 
        5) Start olsrd and make sure that the plugin has loaded correctly.
index 9a32312..a543200 100644 (file)
@@ -82,16 +82,16 @@ install: all
        $(MAKECMDPREFIX)$(MAKE) -C "$(NMEALIB_PATH)" DESTDIR="$(DESTDIR)" install
        $(MAKECMDPREFIX)$(MAKE) -C "$(LIBRARY_PATH)" DESTDIR="$(DESTDIR)" install
        $(INSTALL_LIB)
-       mkdir -p "$(DOCDIR_OLSRD)"
-       cp "$(RESOURCESDIR)/olsrd.pud.position.conf" "$(DOCDIR_OLSRD)"
+       mkdir -p "$(ETCDIR)"
+       cp "$(RESOURCESDIR)/olsrd.pud.position.conf" "$(ETCDIR)"
        $(STRIP) "$(LIBDIR)/$(PLUGIN_FULLNAME)"
 
 uninstall:
        $(MAKECMDPREFIX)$(MAKE) -C "$(NMEALIB_PATH)" DESTDIR="$(DESTDIR)" uninstall
        $(MAKECMDPREFIX)$(MAKE) -C "$(LIBRARY_PATH)" DESTDIR="$(DESTDIR)" uninstall
-       rm -f "$(LIBDIR)/lib$(PLUGIN_NAME).so" "$(LIBDIR)/$(PLUGIN_NAME)" "$(DOCDIR_OLSRD)/olsrd.pud.position.conf"
+       rm -f "$(LIBDIR)/lib$(PLUGIN_NAME).so" "$(LIBDIR)/$(PLUGIN_NAME)" "$(ETCDIR)/olsrd.pud.position.conf"
        $(UNINSTALL_LIB)
-       rmdir -v -p --ignore-fail-on-non-empty "$(LIBDIR)" "$(DOCDIR_OLSRD)"
+       rmdir -v -p --ignore-fail-on-non-empty "$(LIBDIR)" "$(ETCDIR)"
 
 clean:
 ifeq ($(VERBOSE),0)
index 23a8696..5fed938 100644 (file)
@@ -1,3 +1,3 @@
 OLSRD_PLUGIN = true
 PLUGIN_NAME  = olsrd_pud
-PLUGIN_VER   = 1.1.0
+PLUGIN_VER   = 2.0.0
index 9f3d31f..52cd26d 100755 (executable)
Binary files a/lib/pud/doc/pud.odt and b/lib/pud/doc/pud.odt differ
diff --git a/lib/pud/nmealib/COPYRIGHT b/lib/pud/nmealib/COPYRIGHT
new file mode 100644 (file)
index 0000000..b3e55da
--- /dev/null
@@ -0,0 +1,10 @@
+----------
+Copyrights
+----------
+
+Copyrights may apply to all sources or to parts, use our Git repository to
+find out which parts have copyrights by whom.
+
+* Copyright (c) 2008      Timur Sinitsyn
+* Copyright (c) 2011-2014 Ferry Huberts
+* Copyright (c) 2014      Tobias Simon
\ No newline at end of file
index 0288a6e..201dc35 100644 (file)
@@ -47,7 +47,7 @@ lib/$(LIBNAME): $(OBJ)
 ifeq ($(VERBOSE),0)
        @echo "[LD] $@"
 endif
-       $(MAKECMDPREFIX)$(CC) -shared -Wl,-soname=$(LIBNAME) -o "$@" $(LIBRARIES) $(OBJ)
+       $(MAKECMDPREFIX)$(CC) $(LDFLAGS) -Wl,-soname=$(LIBNAME) -o "$@" $(LIBRARIES) $(OBJ)
 
 build/%.o: src/%.c Makefile Makefile.inc
 ifeq ($(VERBOSE),0)
@@ -55,9 +55,6 @@ ifeq ($(VERBOSE),0)
 endif
        $(MAKECMDPREFIX)$(CC) $(CFLAGS) $(INCLUDES) -c $< -o $@
 
-samples: all
-       $(MAKECMDPREFIX)$(MAKE) -C samples all
-
 
 #
 # Phony Targets
@@ -70,7 +67,6 @@ all-before:
 
 clean:
        $(MAKECMDPREFIX)$(MAKE) -C doc clean
-       $(MAKECMDPREFIX)$(MAKE) -C samples clean
        $(MAKECMDPREFIX)rm -frv build lib
 
 doc:
index cb16939..5d5b4a4 100644 (file)
@@ -31,7 +31,7 @@ endif
 
 # we expect the version to be like 'v0.5.3-27-g0c2727a' and then strip the 'v',
 # and the '-27-g0c2727a' parts
-VERSION=1.0.3
+VERSION=2.0.0
 
 # protect against no version number
 ifeq ($(strip $(VERSION)),)
@@ -52,3 +52,16 @@ CFLAGS+= -O2
 else
 CFLAGS+= -O0
 endif
+
+
+LDFLAGS = -shared -Wl,--warn-common -fPIC
+
+# 32/64 cross compilation
+ifdef M32
+CFLAGS +=      -m32
+LDFLAGS +=     -m32
+endif
+ifdef M64
+CFLAGS +=      -m64
+LDFLAGS +=     -m64
+endif
index 9954954..eb6d5b7 100644 (file)
-# Doxyfile 1.8.1.1
+# Doxyfile 1.8.6
 
 # This file describes the settings to be used by the documentation system
 # doxygen (www.doxygen.org) for a project.
 #
-# All text after a hash (#) is considered a comment and will be ignored.
+# All text after a double hash (##) is considered a comment and is placed in
+# front of the TAG it is preceding.
+#
+# All text after a single hash (#) is considered a comment and will be ignored.
 # The format is:
-#       TAG = value [value, ...]
-# For lists items can also be appended using:
-#       TAG += value [value, ...]
-# Values that contain spaces should be placed between quotes (").
+# TAG = value [value, ...]
+# For lists, items can also be appended using:
+# TAG += value [value, ...]
+# Values that contain spaces should be placed between quotes (\" \").
 
 #---------------------------------------------------------------------------
 # Project related configuration options
 #---------------------------------------------------------------------------
 
 # This tag specifies the encoding used for all characters in the config file
-# that follow. The default is UTF-8 which is also the encoding used for all
-# text before the first occurrence of this tag. Doxygen uses libiconv (or the
-# iconv built into libc) for the transcoding. See
-# http://www.gnu.org/software/libiconv for the list of possible encodings.
+# that follow. The default is UTF-8 which is also the encoding used for all text
+# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
+# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
+# for the list of possible encodings.
+# The default value is: UTF-8.
 
 DOXYFILE_ENCODING      = UTF-8
 
-# The PROJECT_NAME tag is a single word (or sequence of words) that should
-# identify the project. Note that if you do not use Doxywizard you need
-# to put quotes around the project name if it contains spaces.
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
+# double-quotes, unless you are using Doxywizard) that should identify the
+# project for which the documentation is generated. This name is used in the
+# title of most generated pages and in a few other places.
+# The default value is: My Project.
 
 PROJECT_NAME           = "NMEAlib"
 
-# The PROJECT_NUMBER tag can be used to enter a project or revision number.
-# This could be handy for archiving the generated documentation or
-# if some version control system is used.
+# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
+# could be handy for archiving the generated documentation or if some version
+# control system is used.
 
 PROJECT_NUMBER         =
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
-# for a project that appears at the top of each page and should give viewer
-# quick idea about the purpose of the project. Keep the description short.
+# for a project that appears at the top of each page and should give viewer a
+# quick idea about the purpose of the project. Keep the description short.
 
 PROJECT_BRIEF          =
 
-# With the PROJECT_LOGO tag one can specify an logo or icon that is
-# included in the documentation. The maximum height of the logo should not
-# exceed 55 pixels and the maximum width should not exceed 200 pixels.
-# Doxygen will copy the logo to the output directory.
+# With the PROJECT_LOGO tag one can specify an logo or icon that is included in
+# the documentation. The maximum height of the logo should not exceed 55 pixels
+# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
+# to the output directory.
 
 PROJECT_LOGO           =
 
-# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
-# base path where the generated documentation will be put.
-# If a relative path is entered, it will be relative to the location
-# where doxygen was started. If left blank the current directory will be used.
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
+# into which the generated documentation will be written. If a relative path is
+# entered, it will be relative to the location where doxygen was started. If
+# left blank the current directory will be used.
 
 OUTPUT_DIRECTORY       =
 
-# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
-# 4096 sub-directories (in 2 levels) under the output directory of each output
-# format and will distribute the generated files over these directories.
-# Enabling this option can be useful when feeding doxygen a huge amount of
-# source files, where putting all generated files in the same directory would
-# otherwise cause performance problems for the file system.
+# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
+# directories (in 2 levels) under the output directory of each output format and
+# will distribute the generated files over these directories. Enabling this
+# option can be useful when feeding doxygen a huge amount of source files, where
+# putting all generated files in the same directory would otherwise causes
+# performance problems for the file system.
+# The default value is: NO.
 
 CREATE_SUBDIRS         = NO
 
 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
 # documentation generated by doxygen is written. Doxygen will use this
 # information to generate all constant output in the proper language.
-# The default language is English, other supported languages are:
-# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
-# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
-# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
-# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
-# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
-# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
+# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
+# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
+# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
+# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
+# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
+# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
+# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
+# Ukrainian and Vietnamese.
+# The default value is: English.
 
 OUTPUT_LANGUAGE        = English
 
-# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
-# include brief member descriptions after the members that are listed in
-# the file and class documentation (similar to JavaDoc).
-# Set to NO to disable this.
+# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
+# descriptions after the members that are listed in the file and class
+# documentation (similar to Javadoc). Set to NO to disable this.
+# The default value is: YES.
 
 BRIEF_MEMBER_DESC      = YES
 
-# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
-# the brief description of a member or function before the detailed description.
-# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
+# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
+# description of a member or function before the detailed description
+#
+# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
 # brief descriptions will be completely suppressed.
+# The default value is: YES.
 
 REPEAT_BRIEF           = YES
 
-# This tag implements a quasi-intelligent brief description abbreviator
-# that is used to form the text in various listings. Each string
-# in this list, if found as the leading text of the brief description, will be
-# stripped from the text and the result after processing the whole list, is
-# used as the annotated text. Otherwise, the brief description is used as-is.
-# If left blank, the following values are used ("$name" is automatically
-# replaced with the name of the entity): "The $name class" "The $name widget"
-# "The $name file" "is" "provides" "specifies" "contains"
-# "represents" "a" "an" "the"
+# This tag implements a quasi-intelligent brief description abbreviator that is
+# used to form the text in various listings. Each string in this list, if found
+# as the leading text of the brief description, will be stripped from the text
+# and the result, after processing the whole list, is used as the annotated
+# text. Otherwise, the brief description is used as-is. If left blank, the
+# following values are used ($name is automatically replaced with the name of
+# the entity):The $name class, The $name widget, The $name file, is, provides,
+# specifies, contains, represents, a, an and the.
 
 ABBREVIATE_BRIEF       =
 
 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
-# Doxygen will generate a detailed section even if there is only a brief
+# doxygen will generate a detailed section even if there is only a brief
 # description.
+# The default value is: NO.
 
 ALWAYS_DETAILED_SEC    = NO
 
@@ -112,169 +123,204 @@ ALWAYS_DETAILED_SEC    = NO
 # inherited members of a class in the documentation of that class as if those
 # members were ordinary class members. Constructors, destructors and assignment
 # operators of the base classes will not be shown.
+# The default value is: NO.
 
 INLINE_INHERITED_MEMB  = NO
 
-# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
-# path before files name in the file list and in the header files. If set
-# to NO the shortest path that makes the file name unique will be used.
+# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
+# before files name in the file list and in the header files. If set to NO the
+# shortest path that makes the file name unique will be used
+# The default value is: YES.
 
 FULL_PATH_NAMES        = NO
 
-# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
-# can be used to strip a user-defined part of the path. Stripping is
-# only done if one of the specified strings matches the left-hand part of
-# the path. The tag can be used to show relative paths in the file list.
-# If left blank the directory from which doxygen is run is used as the
-# path to strip.
+# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
+# Stripping is only done if one of the specified strings matches the left-hand
+# part of the path. The tag can be used to show relative paths in the file list.
+# If left blank the directory from which doxygen is run is used as the path to
+# strip.
+#
+# Note that you can specify absolute paths here, but also relative paths, which
+# will be relative from the directory where doxygen is started.
+# This tag requires that the tag FULL_PATH_NAMES is set to YES.
 
 STRIP_FROM_PATH        =
 
-# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
-# the path mentioned in the documentation of a class, which tells
-# the reader which header file to include in order to use a class.
-# If left blank only the name of the header file containing the class
-# definition is used. Otherwise one should specify the include paths that
-# are normally passed to the compiler using the -I flag.
+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
+# path mentioned in the documentation of a class, which tells the reader which
+# header file to include in order to use a class. If left blank only the name of
+# the header file containing the class definition is used. Otherwise one should
+# specify the list of include paths that are normally passed to the compiler
+# using the -I flag.
 
 STRIP_FROM_INC_PATH    =
 
-# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
-# (but less readable) file names. This can be useful if your file system
-# doesn't support long names like on DOS, Mac, or CD-ROM.
+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
+# less readable) file names. This can be useful is your file systems doesn't
+# support long names like on DOS, Mac, or CD-ROM.
+# The default value is: NO.
 
 SHORT_NAMES            = NO
 
-# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
-# will interpret the first line (until the first dot) of a JavaDoc-style
-# comment as the brief description. If set to NO, the JavaDoc
-# comments will behave just like regular Qt-style comments
-# (thus requiring an explicit @brief command for a brief description.)
+# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
+# first line (until the first dot) of a Javadoc-style comment as the brief
+# description. If set to NO, the Javadoc-style will behave just like regular Qt-
+# style comments (thus requiring an explicit @brief command for a brief
+# description.)
+# The default value is: NO.
 
 JAVADOC_AUTOBRIEF      = YES
 
-# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
-# interpret the first line (until the first dot) of a Qt-style
-# comment as the brief description. If set to NO, the comments
-# will behave just like regular Qt-style comments (thus requiring
-# an explicit \brief command for a brief description.)
+# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
+# line (until the first dot) of a Qt-style comment as the brief description. If
+# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
+# requiring an explicit \brief command for a brief description.)
+# The default value is: NO.
 
 QT_AUTOBRIEF           = NO
 
-# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
-# treat a multi-line C++ special comment block (i.e. a block of //! or ///
-# comments) as a brief description. This used to be the default behaviour.
-# The new default is to treat a multi-line C++ comment block as a detailed
-# description. Set this tag to YES if you prefer the old behaviour instead.
+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
+# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
+# a brief description. This used to be the default behavior. The new default is
+# to treat a multi-line C++ comment block as a detailed description. Set this
+# tag to YES if you prefer the old behavior instead.
+#
+# Note that setting this tag to YES also means that rational rose comments are
+# not recognized any more.
+# The default value is: NO.
 
 MULTILINE_CPP_IS_BRIEF = NO
 
-# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
-# member inherits the documentation from any documented member that it
-# re-implements.
+# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
+# documentation from any documented member that it re-implements.
+# The default value is: YES.
 
 INHERIT_DOCS           = YES
 
-# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
-# a new page for each member. If set to NO, the documentation of a member will
-# be part of the file/class/namespace that contains it.
+# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
+# new page for each member. If set to NO, the documentation of a member will be
+# part of the file/class/namespace that contains it.
+# The default value is: NO.
 
 SEPARATE_MEMBER_PAGES  = NO
 
-# The TAB_SIZE tag can be used to set the number of spaces in a tab.
-# Doxygen uses this value to replace tabs by spaces in code fragments.
+# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
+# uses this value to replace tabs by spaces in code fragments.
+# Minimum value: 1, maximum value: 16, default value: 4.
 
 TAB_SIZE               = 2
 
-# This tag can be used to specify a number of aliases that acts
-# as commands in the documentation. An alias has the form "name=value".
-# For example adding "sideeffect=\par Side Effects:\n" will allow you to
-# put the command \sideeffect (or @sideeffect) in the documentation, which
-# will result in a user-defined paragraph with heading "Side Effects:".
-# You can put \n's in the value part of an alias to insert newlines.
+# This tag can be used to specify a number of aliases that act as commands in
+# the documentation. An alias has the form:
+# name=value
+# For example adding
+# "sideeffect=@par Side Effects:\n"
+# will allow you to put the command \sideeffect (or @sideeffect) in the
+# documentation, which will result in a user-defined paragraph with heading
+# "Side Effects:". You can put \n's in the value part of an alias to insert
+# newlines.
 
 ALIASES                =
 
 # This tag can be used to specify a number of word-keyword mappings (TCL only).
-# A mapping has the form "name=value". For example adding
-# "class=itcl::class" will allow you to use the command class in the
-# itcl::class meaning.
+# A mapping has the form "name=value". For example adding "class=itcl::class"
+# will allow you to use the command class in the itcl::class meaning.
 
 TCL_SUBST              =
 
-# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
-# sources only. Doxygen will then generate output that is more tailored for C.
-# For instance, some of the names that are used will be different. The list
-# of all members will be omitted, etc.
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
+# only. Doxygen will then generate output that is more tailored for C. For
+# instance, some of the names that are used will be different. The list of all
+# members will be omitted, etc.
+# The default value is: NO.
 
 OPTIMIZE_OUTPUT_FOR_C  = YES
 
-# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
-# sources only. Doxygen will then generate output that is more tailored for
-# Java. For instance, namespaces will be presented as packages, qualified
-# scopes will look different, etc.
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
+# Python sources only. Doxygen will then generate output that is more tailored
+# for that language. For instance, namespaces will be presented as packages,
+# qualified scopes will look different, etc.
+# The default value is: NO.
 
 OPTIMIZE_OUTPUT_JAVA   = NO
 
 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
-# sources only. Doxygen will then generate output that is more tailored for
-# Fortran.
+# sources. Doxygen will then generate output that is tailored for Fortran.
+# The default value is: NO.
 
 OPTIMIZE_FOR_FORTRAN   = NO
 
 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
-# sources. Doxygen will then generate output that is tailored for
-# VHDL.
+# sources. Doxygen will then generate output that is tailored for VHDL.
+# The default value is: NO.
 
 OPTIMIZE_OUTPUT_VHDL   = NO
 
 # Doxygen selects the parser to use depending on the extension of the files it
-# parses. With this tag you can assign which parser to use for a given extension.
-# Doxygen has a built-in mapping, but you can override or extend it using this
-# tag. The format is ext=language, where ext is a file extension, and language
-# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
-# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
+# parses. With this tag you can assign which parser to use for a given
+# extension. Doxygen has a built-in mapping, but you can override or extend it
+# using this tag. The format is ext=language, where ext is a file extension, and
+# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
+# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make
 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
-# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
-# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
+# (default is Fortran), use: inc=Fortran f=C.
+#
+# Note For files without extension you can use no_extension as a placeholder.
+#
+# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
+# the files are not read by doxygen.
 
 EXTENSION_MAPPING      =
 
-# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
-# comments according to the Markdown format, which allows for more readable
+# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
+# according to the Markdown format, which allows for more readable
 # documentation. See http://daringfireball.net/projects/markdown/ for details.
-# The output of markdown processing is further processed by doxygen, so you
-# can mix doxygen, HTML, and XML commands with Markdown formatting.
-# Disable only in case of backward compatibilities issues.
+# The output of markdown processing is further processed by doxygen, so you can
+# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
+# case of backward compatibilities issues.
+# The default value is: YES.
 
 MARKDOWN_SUPPORT       = YES
 
+# When enabled doxygen tries to link words that correspond to documented
+# classes, or namespaces to their corresponding documentation. Such a link can
+# be prevented in individual cases by by putting a % sign in front of the word
+# or globally by setting AUTOLINK_SUPPORT to NO.
+# The default value is: YES.
+
+AUTOLINK_SUPPORT       = YES
+
 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
-# to include (a tag file for) the STL sources as input, then you should
-# set this tag to YES in order to let doxygen match functions declarations and
-# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
-# func(std::string) {}). This also makes the inheritance and collaboration
+# to include (a tag file for) the STL sources as input, then you should set this
+# tag to YES in order to let doxygen match functions declarations and
+# definitions whose arguments contain STL classes (e.g. func(std::string);
+# versus func(std::string) {}). This also make the inheritance and collaboration
 # diagrams that involve STL classes more complete and accurate.
+# The default value is: NO.
 
 BUILTIN_STL_SUPPORT    = NO
 
 # If you use Microsoft's C++/CLI language, you should set this option to YES to
 # enable parsing support.
+# The default value is: NO.
 
 CPP_CLI_SUPPORT        = NO
 
-# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
-# Doxygen will parse them like normal C++ but will assume all classes use public
-# instead of private inheritance when no explicit protection keyword is present.
+# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
+# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
+# will parse them like normal C++ but will assume all classes use public instead
+# of private inheritance when no explicit protection keyword is present.
+# The default value is: NO.
 
 SIP_SUPPORT            = NO
 
-# For Microsoft's IDL there are propget and propput attributes to indicate getter
-# and setter methods for a property. Setting this option to YES (the default)
-# will make doxygen replace the get and set methods by a property in the
-# documentation. This will only work if the methods are indeed getting or
-# setting a simple type. If this is not the case, or you want to show the
-# methods anyway, you should set this option to NO.
+# For Microsoft's IDL there are propget and propput attributes to indicate
+# getter and setter methods for a property. Setting this option to YES will make
+# doxygen to replace the get and set methods by a property in the documentation.
+# This will only work if the methods are indeed getting or setting a simple
+# type. If this is not the case, or you want to show the methods anyway, you
+# should set this option to NO.
+# The default value is: YES.
 
 IDL_PROPERTY_SUPPORT   = YES
 
@@ -282,67 +328,61 @@ IDL_PROPERTY_SUPPORT   = YES
 # tag is set to YES, then doxygen will reuse the documentation of the first
 # member in the group (if any) for the other members of the group. By default
 # all members of a group must be documented explicitly.
+# The default value is: NO.
 
 DISTRIBUTE_GROUP_DOC   = NO
 
-# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
-# the same type (for instance a group of public functions) to be put as a
-# subgroup of that type (e.g. under the Public Functions section). Set it to
-# NO to prevent subgrouping. Alternatively, this can be done per class using
-# the \nosubgrouping command.
+# Set the SUBGROUPING tag to YES to allow class member groups of the same type
+# (for instance a group of public functions) to be put as a subgroup of that
+# type (e.g. under the Public Functions section). Set it to NO to prevent
+# subgrouping. Alternatively, this can be done per class using the
+# \nosubgrouping command.
+# The default value is: YES.
 
 SUBGROUPING            = YES
 
-# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
-# unions are shown inside the group in which they are included (e.g. using
-# @ingroup) instead of on a separate page (for HTML and Man pages) or
-# section (for LaTeX and RTF).
+# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
+# are shown inside the group in which they are included (e.g. using \ingroup)
+# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
+# and RTF).
+#
+# Note that this feature does not work in combination with
+# SEPARATE_MEMBER_PAGES.
+# The default value is: NO.
 
 INLINE_GROUPED_CLASSES = NO
 
-# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
-# unions with only public data fields will be shown inline in the documentation
-# of the scope in which they are defined (i.e. file, namespace, or group
-# documentation), provided this scope is documented. If set to NO (the default),
-# structs, classes, and unions are shown on a separate page (for HTML and Man
-# pages) or section (for LaTeX and RTF).
+# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
+# with only public data fields or simple typedef fields will be shown inline in
+# the documentation of the scope in which they are defined (i.e. file,
+# namespace, or group documentation), provided this scope is documented. If set
+# to NO, structs, classes, and unions are shown on a separate page (for HTML and
+# Man pages) or section (for LaTeX and RTF).
+# The default value is: NO.
 
 INLINE_SIMPLE_STRUCTS  = NO
 
-# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
-# is documented as struct, union, or enum with the name of the typedef. So
+# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
+# enum is documented as struct, union, or enum with the name of the typedef. So
 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
 # with name TypeT. When disabled the typedef will appear as a member of a file,
-# namespace, or class. And the struct will be named TypeS. This can typically
-# be useful for C code in case the coding convention dictates that all compound
+# namespace, or class. And the struct will be named TypeS. This can typically be
+# useful for C code in case the coding convention dictates that all compound
 # types are typedef'ed and only the typedef is referenced, never the tag name.
+# The default value is: NO.
 
 TYPEDEF_HIDES_STRUCT   = NO
 
-# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
-# determine which symbols to keep in memory and which to flush to disk.
-# When the cache is full, less often used symbols will be written to disk.
-# For small to medium size projects (<1000 input files) the default value is
-# probably good enough. For larger projects a too small cache size can cause
-# doxygen to be busy swapping symbols to and from disk most of the time
-# causing a significant performance penalty.
-# If the system has enough physical memory increasing the cache will improve the
-# performance by keeping more symbols in memory. Note that the value works on
-# a logarithmic scale so increasing the size by one will roughly double the
-# memory usage. The cache size is given by this formula:
-# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
-# corresponding to a cache size of 2^16 = 65536 symbols.
-
-SYMBOL_CACHE_SIZE      = 0
-
-# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
-# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
-# their name and scope. Since this can be an expensive process and often the
-# same symbol appear multiple times in the code, doxygen keeps a cache of
-# pre-resolved symbols. If the cache is too small doxygen will become slower.
-# If the cache is too large, memory is wasted. The cache size is given by this
-# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
-# corresponding to a cache size of 2^16 = 65536 symbols.
+# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
+# cache is used to resolve symbols given their name and scope. Since this can be
+# an expensive process and often the same symbol appears multiple times in the
+# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
+# doxygen will become slower. If the cache is too large, memory is wasted. The
+# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
+# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
+# symbols. At the end of a run doxygen will report the cache usage and suggest
+# the optimal cache size from a speed point of view.
+# Minimum value: 0, maximum value: 9, default value: 0.
 
 LOOKUP_CACHE_SIZE      = 0
 
@@ -351,341 +391,392 @@ LOOKUP_CACHE_SIZE      = 0
 #---------------------------------------------------------------------------
 
 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
-# documentation are documented, even if no documentation was available.
-# Private class members and static file members will be hidden unless
-# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
+# documentation are documented, even if no documentation was available. Private
+# class members and static file members will be hidden unless the
+# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
+# Note: This will also disable the warnings about undocumented members that are
+# normally produced when WARNINGS is set to YES.
+# The default value is: NO.
 
 EXTRACT_ALL            = YES
 
-# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
-# will be included in the documentation.
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
+# be included in the documentation.
+# The default value is: NO.
 
 EXTRACT_PRIVATE        = YES
 
-# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal scope will be included in the documentation.
+# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
+# scope will be included in the documentation.
+# The default value is: NO.
 
 EXTRACT_PACKAGE        = NO
 
-# If the EXTRACT_STATIC tag is set to YES all static members of a file
-# will be included in the documentation.
+# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
+# included in the documentation.
+# The default value is: NO.
 
 EXTRACT_STATIC         = YES
 
-# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
-# defined locally in source files will be included in the documentation.
-# If set to NO only classes defined in header files are included.
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
+# locally in source files will be included in the documentation. If set to NO
+# only classes defined in header files are included. Does not have any effect
+# for Java sources.
+# The default value is: YES.
 
 EXTRACT_LOCAL_CLASSES  = YES
 
-# This flag is only useful for Objective-C code. When set to YES local
-# methods, which are defined in the implementation section but not in
-# the interface are included in the documentation.
-# If set to NO (the default) only methods in the interface are included.
+# This flag is only useful for Objective-C code. When set to YES local methods,
+# which are defined in the implementation section but not in the interface are
+# included in the documentation. If set to NO only methods in the interface are
+# included.
+# The default value is: NO.
 
 EXTRACT_LOCAL_METHODS  = YES
 
 # If this flag is set to YES, the members of anonymous namespaces will be
 # extracted and appear in the documentation as a namespace called
-# 'anonymous_namespace{file}', where file will be replaced with the base
-# name of the file that contains the anonymous namespace. By default
-# anonymous namespaces are hidden.
+# 'anonymous_namespace{file}', where file will be replaced with the base name of
+# the file that contains the anonymous namespace. By default anonymous namespace
+# are hidden.
+# The default value is: NO.
 
 EXTRACT_ANON_NSPACES   = YES
 
-# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
-# undocumented members of documented classes, files or namespaces.
-# If set to NO (the default) these members will be included in the
-# various overviews, but no documentation section is generated.
-# This option has no effect if EXTRACT_ALL is enabled.
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
+# undocumented members inside documented classes or files. If set to NO these
+# members will be included in the various overviews, but no documentation
+# section is generated. This option has no effect if EXTRACT_ALL is enabled.
+# The default value is: NO.
 
 HIDE_UNDOC_MEMBERS     = NO
 
-# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
-# undocumented classes that are normally visible in the class hierarchy.
-# If set to NO (the default) these classes will be included in the various
-# overviews. This option has no effect if EXTRACT_ALL is enabled.
+# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
+# undocumented classes that are normally visible in the class hierarchy. If set
+# to NO these classes will be included in the various overviews. This option has
+# no effect if EXTRACT_ALL is enabled.
+# The default value is: NO.
 
 HIDE_UNDOC_CLASSES     = NO
 
-# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
-# friend (class|struct|union) declarations.
-# If set to NO (the default) these declarations will be included in the
-# documentation.
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
+# (class|struct|union) declarations. If set to NO these declarations will be
+# included in the documentation.
+# The default value is: NO.
 
 HIDE_FRIEND_COMPOUNDS  = NO
 
-# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
-# documentation blocks found inside the body of a function.
-# If set to NO (the default) these blocks will be appended to the
-# function's detailed documentation block.
+# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
+# documentation blocks found inside the body of a function. If set to NO these
+# blocks will be appended to the function's detailed documentation block.
+# The default value is: NO.
 
 HIDE_IN_BODY_DOCS      = NO
 
-# The INTERNAL_DOCS tag determines if documentation
-# that is typed after a \internal command is included. If the tag is set
-# to NO (the default) then the documentation will be excluded.
-# Set it to YES to include the internal documentation.
+# The INTERNAL_DOCS tag determines if documentation that is typed after a
+# \internal command is included. If the tag is set to NO then the documentation
+# will be excluded. Set it to YES to include the internal documentation.
+# The default value is: NO.
 
 INTERNAL_DOCS          = NO
 
-# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
-# file names in lower-case letters. If set to YES upper-case letters are also
+# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
+# names in lower-case letters. If set to YES upper-case letters are also
 # allowed. This is useful if you have classes or files whose names only differ
 # in case and if your file system supports case sensitive file names. Windows
 # and Mac users are advised to set this option to NO.
+# The default value is: system dependent.
 
 CASE_SENSE_NAMES       = YES
 
-# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
-# will show members with their full class and namespace scopes in the
-# documentation. If set to YES the scope will be hidden.
+# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
+# their full class and namespace scopes in the documentation. If set to YES the
+# scope will be hidden.
+# The default value is: NO.
 
 HIDE_SCOPE_NAMES       = NO
 
-# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
-# will put a list of the files that are included by a file in the documentation
-# of that file.
+# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
+# the files that are included by a file in the documentation of that file.
+# The default value is: YES.
 
 SHOW_INCLUDE_FILES     = YES
 
-# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
-# will list include files with double quotes in the documentation
-# rather than with sharp brackets.
+# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
+# grouped member an include statement to the documentation, telling the reader
+# which file to include in order to use the member.
+# The default value is: NO.
+
+SHOW_GROUPED_MEMB_INC  = NO
+
+# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
+# files with double quotes in the documentation rather than with sharp brackets.
+# The default value is: NO.
 
 FORCE_LOCAL_INCLUDES   = NO
 
-# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
-# is inserted in the documentation for inline members.
+# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
+# documentation for inline members.
+# The default value is: YES.
 
 INLINE_INFO            = YES
 
-# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
-# will sort the (detailed) documentation of file and class members
-# alphabetically by member name. If set to NO the members will appear in
-# declaration order.
+# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
+# (detailed) documentation of file and class members alphabetically by member
+# name. If set to NO the members will appear in declaration order.
+# The default value is: YES.
 
 SORT_MEMBER_DOCS       = YES
 
-# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
-# brief documentation of file, namespace and class members alphabetically
-# by member name. If set to NO (the default) the members will appear in
-# declaration order.
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
+# descriptions of file, namespace and class members alphabetically by member
+# name. If set to NO the members will appear in declaration order. Note that
+# this will also influence the order of the classes in the class list.
+# The default value is: NO.
 
 SORT_BRIEF_DOCS        = NO
 
-# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
-# will sort the (brief and detailed) documentation of class members so that
-# constructors and destructors are listed first. If set to NO (the default)
-# the constructors will appear in the respective orders defined by
-# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
-# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
-# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
+# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
+# (brief and detailed) documentation of class members so that constructors and
+# destructors are listed first. If set to NO the constructors will appear in the
+# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
+# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
+# member documentation.
+# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
+# detailed member documentation.
+# The default value is: NO.
 
 SORT_MEMBERS_CTORS_1ST = NO
 
-# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
-# hierarchy of group names into alphabetical order. If set to NO (the default)
-# the group names will appear in their defined order.
+# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
+# of group names into alphabetical order. If set to NO the group names will
+# appear in their defined order.
+# The default value is: NO.
 
 SORT_GROUP_NAMES       = NO
 
-# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
-# sorted by fully-qualified names, including namespaces. If set to
-# NO (the default), the class list will be sorted only by class name,
-# not including the namespace part.
+# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
+# fully-qualified names, including namespaces. If set to NO, the class list will
+# be sorted only by class name, not including the namespace part.
 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
-# Note: This option applies only to the class list, not to the
-# alphabetical list.
+# Note: This option applies only to the class list, not to the alphabetical
+# list.
+# The default value is: NO.
 
 SORT_BY_SCOPE_NAME     = NO
 
-# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
-# do proper type resolution of all parameters of a function it will reject a
-# match between the prototype and the implementation of a member function even
-# if there is only one candidate or it is obvious which candidate to choose
-# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
-# will still accept a match between prototype and implementation in such cases.
+# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
+# type resolution of all parameters of a function it will reject a match between
+# the prototype and the implementation of a member function even if there is
+# only one candidate or it is obvious which candidate to choose by doing a
+# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
+# accept a match between prototype and implementation in such cases.
+# The default value is: NO.
 
 STRICT_PROTO_MATCHING  = NO
 
-# The GENERATE_TODOLIST tag can be used to enable (YES) or
-# disable (NO) the todo list. This list is created by putting \todo
-# commands in the documentation.
+# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
+# todo list. This list is created by putting \todo commands in the
+# documentation.
+# The default value is: YES.
 
 GENERATE_TODOLIST      = YES
 
-# The GENERATE_TESTLIST tag can be used to enable (YES) or
-# disable (NO) the test list. This list is created by putting \test
-# commands in the documentation.
+# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
+# test list. This list is created by putting \test commands in the
+# documentation.
+# The default value is: YES.
 
 GENERATE_TESTLIST      = YES
 
-# The GENERATE_BUGLIST tag can be used to enable (YES) or
-# disable (NO) the bug list. This list is created by putting \bug
-# commands in the documentation.
+# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
+# list. This list is created by putting \bug commands in the documentation.
+# The default value is: YES.
 
 GENERATE_BUGLIST       = YES
 
-# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
-# disable (NO) the deprecated list. This list is created by putting
-# \deprecated commands in the documentation.
+# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
+# the deprecated list. This list is created by putting \deprecated commands in
+# the documentation.
+# The default value is: YES.
 
 GENERATE_DEPRECATEDLIST= YES
 
-# The ENABLED_SECTIONS tag can be used to enable conditional
-# documentation sections, marked by \if sectionname ... \endif.
+# The ENABLED_SECTIONS tag can be used to enable conditional documentation
+# sections, marked by \if <section_label> ... \endif and \cond <section_label>
+# ... \endcond blocks.
 
 ENABLED_SECTIONS       =
 
-# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
-# the initial value of a variable or macro consists of for it to appear in
-# the documentation. If the initializer consists of more lines than specified
-# here it will be hidden. Use a value of 0 to hide initializers completely.
-# The appearance of the initializer of individual variables and macros in the
-# documentation can be controlled using \showinitializer or \hideinitializer
-# command in the documentation regardless of this setting.
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
+# initial value of a variable or macro / define can have for it to appear in the
+# documentation. If the initializer consists of more lines than specified here
+# it will be hidden. Use a value of 0 to hide initializers completely. The
+# appearance of the value of individual variables and macros / defines can be
+# controlled using \showinitializer or \hideinitializer command in the
+# documentation regardless of this setting.
+# Minimum value: 0, maximum value: 10000, default value: 30.
 
 MAX_INITIALIZER_LINES  = 30
 
-# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
-# at the bottom of the documentation of classes and structs. If set to YES the
-# list will mention the files that were used to generate the documentation.
+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
+# the bottom of the documentation of classes and structs. If set to YES the list
+# will mention the files that were used to generate the documentation.
+# The default value is: YES.
 
 SHOW_USED_FILES        = YES
 
-# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
-# This will remove the Files entry from the Quick Index and from the
-# Folder Tree View (if specified). The default is YES.
+# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
+# will remove the Files entry from the Quick Index and from the Folder Tree View
+# (if specified).
+# The default value is: YES.
 
 SHOW_FILES             = YES
 
-# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
-# Namespaces page.
-# This will remove the Namespaces entry from the Quick Index
-# and from the Folder Tree View (if specified). The default is YES.
+# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
+# page. This will remove the Namespaces entry from the Quick Index and from the
+# Folder Tree View (if specified).
+# The default value is: YES.
 
 SHOW_NAMESPACES        = YES
 
 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
 # doxygen should invoke to get the current version for each file (typically from
 # the version control system). Doxygen will invoke the program by executing (via
-# popen()) the command <command> <input-file>, where <command> is the value of
-# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
-# provided by doxygen. Whatever the program writes to standard output
-# is used as the file version. See the manual for examples.
+# popen()) the command command input-file, where command is the value of the
+# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
+# by doxygen. Whatever the program writes to standard output is used as the file
+# version. For an example see the documentation.
 
 FILE_VERSION_FILTER    =
 
 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
 # by doxygen. The layout file controls the global structure of the generated
 # output files in an output format independent way. To create the layout file
-# that represents doxygen's defaults, run doxygen with the -l option.
-# You can optionally specify a file name after the option, if omitted
-# DoxygenLayout.xml will be used as the name of the layout file.
+# that represents doxygen's defaults, run doxygen with the -l option. You can
+# optionally specify a file name after the option, if omitted DoxygenLayout.xml
+# will be used as the name of the layout file.
+#
+# Note that if you run doxygen from a directory containing a file called
+# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
+# tag is left empty.
 
 LAYOUT_FILE            =
 
-# The CITE_BIB_FILES tag can be used to specify one or more bib files
-# containing the references data. This must be a list of .bib files. The
-# .bib extension is automatically appended if omitted. Using this command
-# requires the bibtex tool to be installed. See also
-# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
-# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
-# feature you need bibtex and perl available in the search path.
+# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
+# the reference definitions. This must be a list of .bib files. The .bib
+# extension is automatically appended if omitted. This requires the bibtex tool
+# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
+# For LaTeX the style of the bibliography can be controlled using
+# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
+# search path. Do not use file names with spaces, bibtex cannot handle them. See
+# also \cite for info how to create references.
 
 CITE_BIB_FILES         =
 
 #---------------------------------------------------------------------------
-# configuration options related to warning and progress messages
+# Configuration options related to warning and progress messages
 #---------------------------------------------------------------------------
 
-# The QUIET tag can be used to turn on/off the messages that are generated
-# by doxygen. Possible values are YES and NO. If left blank NO is used.
+# The QUIET tag can be used to turn on/off the messages that are generated to
+# standard output by doxygen. If QUIET is set to YES this implies that the
+# messages are off.
+# The default value is: NO.
 
 QUIET                  = YES
 
 # The WARNINGS tag can be used to turn on/off the warning messages that are
-# generated by doxygen. Possible values are YES and NO. If left blank
-# NO is used.
+# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
+# this implies that the warnings are on.
+#
+# Tip: Turn warnings on while writing the documentation.
+# The default value is: YES.
 
 WARNINGS               = YES
 
-# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
-# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
-# automatically be disabled.
+# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
+# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
+# will automatically be disabled.
+# The default value is: YES.
 
 WARN_IF_UNDOCUMENTED   = YES
 
-# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
-# potential errors in the documentation, such as not documenting some
-# parameters in a documented function, or documenting parameters that
-# don't exist or using markup commands wrongly.
+# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
+# potential errors in the documentation, such as not documenting some parameters
+# in a documented function, or documenting parameters that don't exist or using
+# markup commands wrongly.
+# The default value is: YES.
 
 WARN_IF_DOC_ERROR      = YES
 
-# The WARN_NO_PARAMDOC option can be enabled to get warnings for
-# functions that are documented, but have no documentation for their parameters
-# or return value. If set to NO (the default) doxygen will only warn about
-# wrong or incomplete parameter documentation, but not about the absence of
-# documentation.
+# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
+# are documented, but have no documentation for their parameters or return
+# value. If set to NO doxygen will only warn about wrong or incomplete parameter
+# documentation, but not about the absence of documentation.
+# The default value is: NO.
 
 WARN_NO_PARAMDOC       = YES
 
-# The WARN_FORMAT tag determines the format of the warning messages that
-# doxygen can produce. The string should contain the $file, $line, and $text
-# tags, which will be replaced by the file and line number from which the
-# warning originated and the warning text. Optionally the format may contain
-# $version, which will be replaced by the version of the file (if it could
-# be obtained via FILE_VERSION_FILTER)
+# The WARN_FORMAT tag determines the format of the warning messages that doxygen
+# can produce. The string should contain the $file, $line, and $text tags, which
+# will be replaced by the file and line number from which the warning originated
+# and the warning text. Optionally the format may contain $version, which will
+# be replaced by the version of the file (if it could be obtained via
+# FILE_VERSION_FILTER)
+# The default value is: $file:$line: $text.
 
 WARN_FORMAT            = "$file:$line: $text"
 
-# The WARN_LOGFILE tag can be used to specify a file to which warning
-# and error messages should be written. If left blank the output is written
-# to stderr.
+# The WARN_LOGFILE tag can be used to specify a file to which warning and error
+# messages should be written. If left blank the output is written to standard
+# error (stderr).
 
 WARN_LOGFILE           =
 
 #---------------------------------------------------------------------------
-# configuration options related to the input files
+# Configuration options related to the input files
 #---------------------------------------------------------------------------
 
-# The INPUT tag can be used to specify the files and/or directories that contain
-# documented source files. You may enter file names like "myfile.cpp" or
-# directories like "/usr/src/myproject". Separate the files or directories
-# with spaces.
+# The INPUT tag is used to specify the files and/or directories that contain
+# documented source files. You may enter file names like myfile.cpp or
+# directories like /usr/src/myproject. Separate the files or directories with
+# spaces.
+# Note: If this tag is empty the current directory is searched.
 
 INPUT                  = ../src \
                          ../include/nmea
 
 # This tag can be used to specify the character encoding of the source files
-# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
-# also the default input encoding. Doxygen uses libiconv (or the iconv built
-# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
-# the list of possible encodings.
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
+# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
+# documentation (see: http://www.gnu.org/software/libiconv) for the list of
+# possible encodings.
+# The default value is: UTF-8.
 
 INPUT_ENCODING         = UTF-8
 
 # If the value of the INPUT tag contains directories, you can use the
-# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
-# and *.h) to filter out the source-files in the directories. If left
-# blank the following patterns are tested:
-# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
-# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
-# *.f90 *.f *.for *.vhd *.vhdl
+# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
+# *.h) to filter out the source-files in the directories. If left blank the
+# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
+# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
+# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
+# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
+# *.qsf, *.as and *.js.
 
 FILE_PATTERNS          = *.c \
                          *.h
 
-# The RECURSIVE tag can be used to turn specify whether or not subdirectories
-# should be searched for input files as well. Possible values are YES and NO.
-# If left blank NO is used.
+# The RECURSIVE tag can be used to specify whether or not subdirectories should
+# be searched for input files as well.
+# The default value is: NO.
 
 RECURSIVE              = YES
 
 # The EXCLUDE tag can be used to specify files and/or directories that should be
 # excluded from the INPUT source files. This way you can easily exclude a
 # subdirectory from a directory tree whose root is specified with the INPUT tag.
+#
 # Note that relative paths are relative to the directory from which doxygen is
 # run.
 
@@ -694,14 +785,16 @@ EXCLUDE                =
 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
 # directories that are symbolic links (a Unix file system feature) are excluded
 # from the input.
+# The default value is: NO.
 
 EXCLUDE_SYMLINKS       = NO
 
 # If the value of the INPUT tag contains directories, you can use the
 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
-# certain files from those directories. Note that the wildcards are matched
-# against the file with absolute path, so to exclude all test directories
-# for example use the pattern */test/*
+# certain files from those directories.
+#
+# Note that the wildcards are matched against the file with absolute path, so to
+# exclude all test directories for example use the pattern */test/*
 
 EXCLUDE_PATTERNS       =
 
@@ -710,755 +803,1080 @@ EXCLUDE_PATTERNS       =
 # output. The symbol name can be a fully qualified name, a word, or if the
 # wildcard * is used, a substring. Examples: ANamespace, AClass,
 # AClass::ANamespace, ANamespace::*Test
+#
+# Note that the wildcards are matched against the file with absolute path, so to
+# exclude all test directories use the pattern */test/*
 
 EXCLUDE_SYMBOLS        =
 
-# The EXAMPLE_PATH tag can be used to specify one or more files or
-# directories that contain example code fragments that are included (see
-# the \include command).
+# The EXAMPLE_PATH tag can be used to specify one or more files or directories
+# that contain example code fragments that are included (see the \include
+# command).
 
 EXAMPLE_PATH           =
 
 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
-# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
-# and *.h) to filter out the source-files in the directories. If left
-# blank all files are included.
+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
+# *.h) to filter out the source-files in the directories. If left blank all
+# files are included.
 
 EXAMPLE_PATTERNS       =
 
 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
-# searched for input files to be used with the \include or \dontinclude
-# commands irrespective of the value of the RECURSIVE tag.
-# Possible values are YES and NO. If left blank NO is used.
+# searched for input files to be used with the \include or \dontinclude commands
+# irrespective of the value of the RECURSIVE tag.
+# The default value is: NO.
 
 EXAMPLE_RECURSIVE      = NO
 
-# The IMAGE_PATH tag can be used to specify one or more files or
-# directories that contain image that are included in the documentation (see
-# the \image command).
+# The IMAGE_PATH tag can be used to specify one or more files or directories
+# that contain images that are to be included in the documentation (see the
+# \image command).
 
 IMAGE_PATH             =
 
 # The INPUT_FILTER tag can be used to specify a program that doxygen should
 # invoke to filter for each input file. Doxygen will invoke the filter program
-# by executing (via popen()) the command <filter> <input-file>, where <filter>
-# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
-# input file. Doxygen will then use the output that the filter program writes
-# to standard output.
-# If FILTER_PATTERNS is specified, this tag will be
-# ignored.
+# by executing (via popen()) the command:
+#
+# <filter> <input-file>
+#
+# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
+# name of an input file. Doxygen will then use the output that the filter
+# program writes to standard output. If FILTER_PATTERNS is specified, this tag
+# will be ignored.
+#
+# Note that the filter must not add or remove lines; it is applied before the
+# code is scanned, but not when the output code is generated. If lines are added
+# or removed, the anchors will not be placed correctly.
 
 INPUT_FILTER           =
 
 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
-# basis.
-# Doxygen will compare the file name with each pattern and apply the
-# filter if there is a match.
-# The filters are a list of the form:
-# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
-# info on how filters are used. If FILTER_PATTERNS is empty or if
-# non of the patterns match the file name, INPUT_FILTER is applied.
+# basis. Doxygen will compare the file name with each pattern and apply the
+# filter if there is a match. The filters are a list of the form: pattern=filter
+# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
+# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
+# patterns match the file name, INPUT_FILTER is applied.
 
 FILTER_PATTERNS        =
 
 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
-# INPUT_FILTER) will be used to filter the input files when producing source
-# files to browse (i.e. when SOURCE_BROWSER is set to YES).
+# INPUT_FILTER ) will also be used to filter the input files that are used for
+# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
+# The default value is: NO.
 
 FILTER_SOURCE_FILES    = NO
 
 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
-# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
-# and it is also possible to disable source filtering for a specific pattern
-# using *.ext= (so without naming a filter). This option only has effect when
-# FILTER_SOURCE_FILES is enabled.
+# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
+# it is also possible to disable source filtering for a specific pattern using
+# *.ext= (so without naming a filter).
+# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
 
 FILTER_SOURCE_PATTERNS =
 
+# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
+# is part of the input, its contents will be placed on the main page
+# (index.html). This can be useful if you have a project on for instance GitHub
+# and want to reuse the introduction page also for the doxygen output.
+
+USE_MDFILE_AS_MAINPAGE =
+
 #---------------------------------------------------------------------------
-# configuration options related to source browsing
+# Configuration options related to source browsing
 #---------------------------------------------------------------------------
 
-# If the SOURCE_BROWSER tag is set to YES then a list of source files will
-# be generated. Documented entities will be cross-referenced with these sources.
-# Note: To get rid of all source code in the generated output, make sure also
-# VERBATIM_HEADERS is set to NO.
+# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
+# generated. Documented entities will be cross-referenced with these sources.
+#
+# Note: To get rid of all source code in the generated output, make sure that
+# also VERBATIM_HEADERS is set to NO.
+# The default value is: NO.
 
 SOURCE_BROWSER         = YES
 
-# Setting the INLINE_SOURCES tag to YES will include the body
-# of functions and classes directly in the documentation.
+# Setting the INLINE_SOURCES tag to YES will include the body of functions,
+# classes and enums directly into the documentation.
+# The default value is: NO.
 
 INLINE_SOURCES         = NO
 
-# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
-# doxygen to hide any special comment blocks from generated source code
-# fragments. Normal C, C++ and Fortran comments will always remain visible.
+# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
+# special comment blocks from generated source code fragments. Normal C, C++ and
+# Fortran comments will always remain visible.
+# The default value is: YES.
 
 STRIP_CODE_COMMENTS    = NO
 
-# If the REFERENCED_BY_RELATION tag is set to YES
-# then for each documented function all documented
-# functions referencing it will be listed.
+# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
+# function all documented functions referencing it will be listed.
+# The default value is: NO.
 
 REFERENCED_BY_RELATION = YES
 
-# If the REFERENCES_RELATION tag is set to YES
-# then for each documented function all documented entities
-# called/used by that function will be listed.
+# If the REFERENCES_RELATION tag is set to YES then for each documented function
+# all documented entities called/used by that function will be listed.
+# The default value is: NO.
 
 REFERENCES_RELATION    = YES
 
-# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
-# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
-# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
-# link to the source code.
-# Otherwise they will link to the documentation.
+# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
+# to YES, then the hyperlinks from functions in REFERENCES_RELATION and
+# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
+# link to the documentation.
+# The default value is: YES.
 
 REFERENCES_LINK_SOURCE = YES
 
-# If the USE_HTAGS tag is set to YES then the references to source code
-# will point to the HTML generated by the htags(1) tool instead of doxygen
-# built-in source browser. The htags tool is part of GNU's global source
-# tagging system (see http://www.gnu.org/software/global/global.html). You
-# will need version 4.8.6 or higher.
+# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
+# source code will show a tooltip with additional information such as prototype,
+# brief description and links to the definition and documentation. Since this
+# will make the HTML file larger and loading of large files a bit slower, you
+# can opt to disable this feature.
+# The default value is: YES.
+# This tag requires that the tag SOURCE_BROWSER is set to YES.
+
+SOURCE_TOOLTIPS        = YES
+
+# If the USE_HTAGS tag is set to YES then the references to source code will
+# point to the HTML generated by the htags(1) tool instead of doxygen built-in
+# source browser. The htags tool is part of GNU's global source tagging system
+# (see http://www.gnu.org/software/global/global.html). You will need version
+# 4.8.6 or higher.
+#
+# To use it do the following:
+# - Install the latest version of global
+# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
+# - Make sure the INPUT points to the root of the source tree
+# - Run doxygen as normal
+#
+# Doxygen will invoke htags (and that will in turn invoke gtags), so these
+# tools must be available from the command line (i.e. in the search path).
+#
+# The result: instead of the source browser generated by doxygen, the links to
+# source code will now point to the output of htags.
+# The default value is: NO.
+# This tag requires that the tag SOURCE_BROWSER is set to YES.
 
 USE_HTAGS              = NO
 
-# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
-# will generate a verbatim copy of the header file for each class for
-# which an include is specified. Set to NO to disable this.
+# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
+# verbatim copy of the header file for each class for which an include is
+# specified. Set to NO to disable this.
+# See also: Section \class.
+# The default value is: YES.
 
 VERBATIM_HEADERS       = YES
 
 #---------------------------------------------------------------------------
-# configuration options related to the alphabetical class index
+# Configuration options related to the alphabetical class index
 #---------------------------------------------------------------------------
 
-# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
-# of all compounds will be generated. Enable this if the project
-# contains a lot of classes, structs, unions or interfaces.
+# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
+# compounds will be generated. Enable this if the project contains a lot of
+# classes, structs, unions or interfaces.
+# The default value is: YES.
 
 ALPHABETICAL_INDEX     = YES
 
-# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
-# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
-# in which this list will be split (can be a number in the range [1..20])
+# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
+# which the alphabetical index list will be split.
+# Minimum value: 1, maximum value: 20, default value: 5.
+# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
 
 COLS_IN_ALPHA_INDEX    = 2
 
-# In case all classes in a project start with a common prefix, all
-# classes will be put under the same header in the alphabetical index.
-# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
-# should be ignored while generating the index headers.
+# In case all classes in a project start with a common prefix, all classes will
+# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
+# can be used to specify a prefix (or a list of prefixes) that should be ignored
+# while generating the index headers.
+# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
 
 IGNORE_PREFIX          =
 
 #---------------------------------------------------------------------------
-# configuration options related to the HTML output
+# Configuration options related to the HTML output
 #---------------------------------------------------------------------------
 
-# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
-# generate HTML output.
+# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
+# The default value is: YES.
 
 GENERATE_HTML          = YES
 
-# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
-# If a relative path is entered the value of OUTPUT_DIRECTORY will be
-# put in front of it. If left blank `html' will be used as the default path.
+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: html.
+# This tag requires that the tag GENERATE_HTML is set to YES.
 
 HTML_OUTPUT            = html
 
-# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
-# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
-# doxygen will generate files with .html extension.
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
+# generated HTML page (for example: .htm, .php, .asp).
+# The default value is: .html.
+# This tag requires that the tag GENERATE_HTML is set to YES.
 
 HTML_FILE_EXTENSION    = .html
 
-# The HTML_HEADER tag can be used to specify a personal HTML header for
-# each generated HTML page. If it is left blank doxygen will generate a
-# standard header. Note that when using a custom header you are responsible
-#  for the proper inclusion of any scripts and style sheets that doxygen
-# needs, which is dependent on the configuration options used.
-# It is advised to generate a default header using "doxygen -w html
-# header.html footer.html stylesheet.css YourConfigFile" and then modify
-# that header. Note that the header is subject to change so you typically
-# have to redo this when upgrading to a newer version of doxygen or when
-# changing the value of configuration settings such as GENERATE_TREEVIEW!
+# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
+# each generated HTML page. If the tag is left blank doxygen will generate a
+# standard header.
+#
+# To get valid HTML the header file that includes any scripts and style sheets
+# that doxygen needs, which is dependent on the configuration options used (e.g.
+# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
+# default header using
+# doxygen -w html new_header.html new_footer.html new_stylesheet.css
+# YourConfigFile
+# and then modify the file new_header.html. See also section "Doxygen usage"
+# for information on how to generate the default header that doxygen normally
+# uses.
+# Note: The header is subject to change so you typically have to regenerate the
+# default header when upgrading to a newer version of doxygen. For a description
+# of the possible markers and block names see the documentation.
+# This tag requires that the tag GENERATE_HTML is set to YES.
 
 HTML_HEADER            =
 
-# The HTML_FOOTER tag can be used to specify a personal HTML footer for
-# each generated HTML page. If it is left blank doxygen will generate a
-# standard footer.
+# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
+# generated HTML page. If the tag is left blank doxygen will generate a standard
+# footer. See HTML_HEADER for more information on how to generate a default
+# footer and what special commands can be used inside the footer. See also
+# section "Doxygen usage" for information on how to generate the default footer
+# that doxygen normally uses.
+# This tag requires that the tag GENERATE_HTML is set to YES.
 
 HTML_FOOTER            =
 
-# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
-# style sheet that is used by each HTML page. It can be used to
-# fine-tune the look of the HTML output. If the tag is left blank doxygen
-# will generate a default style sheet. Note that doxygen will try to copy
-# the style sheet file to the HTML output directory, so don't put your own
-# style sheet in the HTML output directory as well, or it will be erased!
+# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
+# sheet that is used by each HTML page. It can be used to fine-tune the look of
+# the HTML output. If left blank doxygen will generate a default style sheet.
+# See also section "Doxygen usage" for information on how to generate the style
+# sheet that doxygen normally uses.
+# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
+# it is more robust and this tag (HTML_STYLESHEET) will in the future become
+# obsolete.
+# This tag requires that the tag GENERATE_HTML is set to YES.
 
 HTML_STYLESHEET        =
 
+# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
+# defined cascading style sheet that is included after the standard style sheets
+# created by doxygen. Using this option one can overrule certain style aspects.
+# This is preferred over using HTML_STYLESHEET since it does not replace the
+# standard style sheet and is therefor more robust against future updates.
+# Doxygen will copy the style sheet file to the output directory. For an example
+# see the documentation.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_EXTRA_STYLESHEET  =
+
 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
 # other source files which should be copied to the HTML output directory. Note
 # that these files will be copied to the base HTML output directory. Use the
-# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
-# files. In the HTML_STYLESHEET file, use the file name only. Also note that
-# the files will be copied as-is; there are no commands or markers available.
+# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
+# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
+# files will be copied as-is; there are no commands or markers available.
+# This tag requires that the tag GENERATE_HTML is set to YES.
 
 HTML_EXTRA_FILES       =
 
-# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
-# Doxygen will adjust the colors in the style sheet and background images
-# according to this color. Hue is specified as an angle on a colorwheel,
-# see http://en.wikipedia.org/wiki/Hue for more information.
-# For instance the value 0 represents red, 60 is yellow, 120 is green,
-# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
-# The allowed range is 0 to 359.
+# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
+# will adjust the colors in the stylesheet and background images according to
+# this color. Hue is specified as an angle on a colorwheel, see
+# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
+# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
+# purple, and 360 is red again.
+# Minimum value: 0, maximum value: 359, default value: 220.
+# This tag requires that the tag GENERATE_HTML is set to YES.
 
 HTML_COLORSTYLE_HUE    = 220
 
-# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
-# the colors in the HTML output. For a value of 0 the output will use
-# grayscales only. A value of 255 will produce the most vivid colors.
+# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
+# in the HTML output. For a value of 0 the output will use grayscales only. A
+# value of 255 will produce the most vivid colors.
+# Minimum value: 0, maximum value: 255, default value: 100.
+# This tag requires that the tag GENERATE_HTML is set to YES.
 
 HTML_COLORSTYLE_SAT    = 100
 
-# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
-# the luminance component of the colors in the HTML output. Values below
-# 100 gradually make the output lighter, whereas values above 100 make
-# the output darker. The value divided by 100 is the actual gamma applied,
-# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
-# and 100 does not change the gamma.
+# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
+# luminance component of the colors in the HTML output. Values below 100
+# gradually make the output lighter, whereas values above 100 make the output
+# darker. The value divided by 100 is the actual gamma applied, so 80 represents
+# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
+# change the gamma.
+# Minimum value: 40, maximum value: 240, default value: 80.
+# This tag requires that the tag GENERATE_HTML is set to YES.
 
 HTML_COLORSTYLE_GAMMA  = 80
 
 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
-# page will contain the date and time when the page was generated. Setting
-# this to NO can help when comparing the output of multiple runs.
+# page will contain the date and time when the page was generated. Setting this
+# to NO can help when comparing the output of multiple runs.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
 
 HTML_TIMESTAMP         = YES
 
 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
 # documentation will contain sections that can be hidden and shown after the
 # page has loaded.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
 
 HTML_DYNAMIC_SECTIONS  = NO
 
-# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
-# entries shown in the various tree structured indices initially; the user
-# can expand and collapse entries dynamically later on. Doxygen will expand
-# the tree to such a level that at most the specified number of entries are
-# visible (unless a fully collapsed tree already exceeds this amount).
-# So setting the number of entries 1 will produce a full collapsed tree by
-# default. 0 is a special value representing an infinite number of entries
-# and will result in a full expanded tree by default.
+# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
+# shown in the various tree structured indices initially; the user can expand
+# and collapse entries dynamically later on. Doxygen will expand the tree to
+# such a level that at most the specified number of entries are visible (unless
+# a fully collapsed tree already exceeds this amount). So setting the number of
+# entries 1 will produce a full collapsed tree by default. 0 is a special value
+# representing an infinite number of entries and will result in a full expanded
+# tree by default.
+# Minimum value: 0, maximum value: 9999, default value: 100.
+# This tag requires that the tag GENERATE_HTML is set to YES.
 
 HTML_INDEX_NUM_ENTRIES = 100
 
-# If the GENERATE_DOCSET tag is set to YES, additional index files
-# will be generated that can be used as input for Apple's Xcode 3
-# integrated development environment, introduced with OSX 10.5 (Leopard).
-# To create a documentation set, doxygen will generate a Makefile in the
-# HTML output directory. Running make will produce the docset in that
-# directory and running "make install" will install the docset in
-# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
-# it at startup.
-# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
+# If the GENERATE_DOCSET tag is set to YES, additional index files will be
+# generated that can be used as input for Apple's Xcode 3 integrated development
+# environment (see: http://developer.apple.com/tools/xcode/), introduced with
+# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
+# Makefile in the HTML output directory. Running make will produce the docset in
+# that directory and running make install will install the docset in
+# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
+# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
 # for more information.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
 
 GENERATE_DOCSET        = NO
 
-# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
-# feed. A documentation feed provides an umbrella under which multiple
-# documentation sets from a single provider (such as a company or product suite)
-# can be grouped.
+# This tag determines the name of the docset feed. A documentation feed provides
+# an umbrella under which multiple documentation sets from a single provider
+# (such as a company or product suite) can be grouped.
+# The default value is: Doxygen generated docs.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
 
 DOCSET_FEEDNAME        = "Doxygen generated docs"
 
-# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
-# should uniquely identify the documentation set bundle. This should be a
-# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
-# will append .docset to the name.
+# This tag specifies a string that should uniquely identify the documentation
+# set bundle. This should be a reverse domain-name style string, e.g.
+# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
 
 DOCSET_BUNDLE_ID       = org.doxygen.Project
 
-# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
+# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
 # the documentation publisher. This should be a reverse domain-name style
 # string, e.g. com.mycompany.MyDocSet.documentation.
+# The default value is: org.doxygen.Publisher.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
 
 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
 
-# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
+# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
+# The default value is: Publisher.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
 
 DOCSET_PUBLISHER_NAME  = Publisher
 
-# If the GENERATE_HTMLHELP tag is set to YES, additional index files
-# will be generated that can be used as input for tools like the
-# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
-# of the generated HTML documentation.
+# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
+# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
+# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
+# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
+# Windows.
+#
+# The HTML Help Workshop contains a compiler that can convert all HTML output
+# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
+# files are now used as the Windows 98 help format, and will replace the old
+# Windows help format (.hlp) on all Windows platforms in the future. Compressed
+# HTML files also contain an index, a table of contents, and you can search for
+# words in the documentation. The HTML workshop also contains a viewer for
+# compressed HTML files.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
 
 GENERATE_HTMLHELP      = NO
 
-# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
-# be used to specify the file name of the resulting .chm file. You
-# can add a path in front of the file if the result should not be
+# The CHM_FILE tag can be used to specify the file name of the resulting .chm
+# file. You can add a path in front of the file if the result should not be
 # written to the html output directory.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
 
 CHM_FILE               = nmealib.chm
 
-# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
-# be used to specify the location (absolute path including file name) of
-# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
-# the HTML help compiler on the generated index.hhp.
+# The HHC_LOCATION tag can be used to specify the location (absolute path
+# including file name) of the HTML help compiler ( hhc.exe). If non-empty
+# doxygen will try to run the HTML help compiler on the generated index.hhp.
+# The file has to be specified with full path.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
 
 HHC_LOCATION           =
 
-# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
-# controls if a separate .chi index file is generated (YES) or that
-# it should be included in the master .chm file (NO).
+# The GENERATE_CHI flag controls if a separate .chi index file is generated (
+# YES) or that it should be included in the master .chm file ( NO).
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
 
 GENERATE_CHI           = NO
 
-# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
-# is used to encode HtmlHelp index (hhk), content (hhc) and project file
-# content.
+# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
+# and project file content.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
 
 CHM_INDEX_ENCODING     =
 
-# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
-# controls whether a binary table of contents is generated (YES) or a
-# normal table of contents (NO) in the .chm file.
+# The BINARY_TOC flag controls whether a binary table of contents is generated (
+# YES) or a normal table of contents ( NO) in the .chm file.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
 
 BINARY_TOC             = NO
 
-# The TOC_EXPAND flag can be set to YES to add extra items for group members
-# to the contents of the HTML help documentation and to the tree view.
+# The TOC_EXPAND flag can be set to YES to add extra items for group members to
+# the table of contents of the HTML help documentation and to the tree view.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
 
 TOC_EXPAND             = YES
 
 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
-# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
-# that can be used as input for Qt's qhelpgenerator to generate a
-# Qt Compressed Help (.qch) of the generated HTML documentation.
+# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
+# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
+# (.qch) of the generated HTML documentation.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
 
 GENERATE_QHP           = NO
 
-# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
-# be used to specify the file name of the resulting .qch file.
-# The path specified is relative to the HTML output folder.
+# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
+# the file name of the resulting .qch file. The path specified is relative to
+# the HTML output folder.
+# This tag requires that the tag GENERATE_QHP is set to YES.
 
 QCH_FILE               =
 
-# The QHP_NAMESPACE tag specifies the namespace to use when generating
-# Qt Help Project output. For more information please see
-# http://doc.trolltech.com/qthelpproject.html#namespace
+# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
+# Project output. For more information please see Qt Help Project / Namespace
+# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_QHP is set to YES.
 
 QHP_NAMESPACE          = org.doxygen.Project
 
-# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
-# Qt Help Project output. For more information please see
-# http://doc.trolltech.com/qthelpproject.html#virtual-folders
+# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
+# Help Project output. For more information please see Qt Help Project / Virtual
+# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
+# folders).
+# The default value is: doc.
+# This tag requires that the tag GENERATE_QHP is set to YES.
 
 QHP_VIRTUAL_FOLDER     = doc
 
-# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
-# add. For more information please see
-# http://doc.trolltech.com/qthelpproject.html#custom-filters
+# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
+# filter to add. For more information please see Qt Help Project / Custom
+# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
+# filters).
+# This tag requires that the tag GENERATE_QHP is set to YES.
 
 QHP_CUST_FILTER_NAME   =
 
-# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
-# custom filter to add. For more information please see
-# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
-# Qt Help Project / Custom Filters</a>.
+# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
+# custom filter to add. For more information please see Qt Help Project / Custom
+# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
+# filters).
+# This tag requires that the tag GENERATE_QHP is set to YES.
 
 QHP_CUST_FILTER_ATTRS  =
 
 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
-# project's
-# filter section matches.
-# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
-# Qt Help Project / Filter Attributes</a>.
+# project's filter section matches. Qt Help Project / Filter Attributes (see:
+# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
+# This tag requires that the tag GENERATE_QHP is set to YES.
 
 QHP_SECT_FILTER_ATTRS  =
 
-# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
-# be used to specify the location of Qt's qhelpgenerator.
-# If non-empty doxygen will try to run qhelpgenerator on the generated
-# .qhp file.
+# The QHG_LOCATION tag can be used to specify the location of Qt's
+# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
+# generated .qhp file.
+# This tag requires that the tag GENERATE_QHP is set to YES.
 
 QHG_LOCATION           =
 
-# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
-#  will be generated, which together with the HTML files, form an Eclipse help
-# plugin. To install this plugin and make it available under the help contents
-# menu in Eclipse, the contents of the directory containing the HTML and XML
-# files needs to be copied into the plugins directory of eclipse. The name of
-# the directory within the plugins directory should be the same as
-# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
-# the help appears.
+# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
+# generated, together with the HTML files, they form an Eclipse help plugin. To
+# install this plugin and make it available under the help contents menu in
+# Eclipse, the contents of the directory containing the HTML and XML files needs
+# to be copied into the plugins directory of eclipse. The name of the directory
+# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
+# After copying Eclipse needs to be restarted before the help appears.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
 
 GENERATE_ECLIPSEHELP   = NO
 
-# A unique identifier for the eclipse help plugin. When installing the plugin
-# the directory name containing the HTML and XML files should also have
-# this name.
+# A unique identifier for the Eclipse help plugin. When installing the plugin
+# the directory name containing the HTML and XML files should also have this
+# name. Each documentation set should have its own identifier.
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
 
 ECLIPSE_DOC_ID         = org.doxygen.Project
 
-# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
-# at top of each HTML page. The value NO (the default) enables the index and
-# the value YES disables it. Since the tabs have the same information as the
-# navigation tree you can set this option to NO if you already set
-# GENERATE_TREEVIEW to YES.
+# If you want full control over the layout of the generated HTML pages it might
+# be necessary to disable the index and replace it with your own. The
+# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
+# of each HTML page. A value of NO enables the index and the value YES disables
+# it. Since the tabs in the index contain the same information as the navigation
+# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
 
 DISABLE_INDEX          = NO
 
 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
-# structure should be generated to display hierarchical information.
-# If the tag value is set to YES, a side panel will be generated
-# containing a tree-like index structure (just like the one that
-# is generated for HTML Help). For this to work a browser that supports
-# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
-# Windows users are probably better off using the HTML help feature.
-# Since the tree basically has the same information as the tab index you
-# could consider to set DISABLE_INDEX to NO when enabling this option.
+# structure should be generated to display hierarchical information. If the tag
+# value is set to YES, a side panel will be generated containing a tree-like
+# index structure (just like the one that is generated for HTML Help). For this
+# to work a browser that supports JavaScript, DHTML, CSS and frames is required
+# (i.e. any modern browser). Windows users are probably better off using the
+# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
+# further fine-tune the look of the index. As an example, the default style
+# sheet generated by doxygen has an example that shows how to put an image at
+# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
+# the same information as the tab index, you could consider setting
+# DISABLE_INDEX to YES when enabling this option.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
 
 GENERATE_TREEVIEW      = YES
 
-# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
-# (range [0,1..20]) that doxygen will group on one line in the generated HTML
-# documentation. Note that a value of 0 will completely suppress the enum
-# values from appearing in the overview section.
+# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
+# doxygen will group on one line in the generated HTML documentation.
+#
+# Note that a value of 0 will completely suppress the enum values from appearing
+# in the overview section.
+# Minimum value: 0, maximum value: 20, default value: 4.
+# This tag requires that the tag GENERATE_HTML is set to YES.
 
 ENUM_VALUES_PER_LINE   = 4
 
-# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
-# used to set the initial width (in pixels) of the frame in which the tree
-# is shown.
+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
+# to set the initial width (in pixels) of the frame in which the tree is shown.
+# Minimum value: 0, maximum value: 1500, default value: 250.
+# This tag requires that the tag GENERATE_HTML is set to YES.
 
 TREEVIEW_WIDTH         = 250
 
-# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
-# links to external symbols imported via tag files in a separate window.
+# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
+# external symbols imported via tag files in a separate window.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
 
 EXT_LINKS_IN_WINDOW    = NO
 
-# Use this tag to change the font size of Latex formulas included
-# as images in the HTML documentation. The default is 10. Note that
-# when you change the font size after a successful doxygen run you need
-# to manually remove any form_*.png images from the HTML output directory
-# to force them to be regenerated.
+# Use this tag to change the font size of LaTeX formulas included as images in
+# the HTML documentation. When you change the font size after a successful
+# doxygen run you need to manually remove any form_*.png images from the HTML
+# output directory to force them to be regenerated.
+# Minimum value: 8, maximum value: 50, default value: 10.
+# This tag requires that the tag GENERATE_HTML is set to YES.
 
 FORMULA_FONTSIZE       = 10
 
 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
-# generated for formulas are transparent PNGs. Transparent PNGs are
-# not supported properly for IE 6.0, but are supported on all modern browsers.
-# Note that when changing this option you need to delete any form_*.png files
-# in the HTML output before the changes have effect.
+# generated for formulas are transparent PNGs. Transparent PNGs are not
+# supported properly for IE 6.0, but are supported on all modern browsers.
+#
+# Note that when changing this option you need to delete any form_*.png files in
+# the HTML output directory before the changes have effect.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
 
 FORMULA_TRANSPARENT    = YES
 
-# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
-# (see http://www.mathjax.org) which uses client side Javascript for the
-# rendering instead of using prerendered bitmaps. Use this if you do not
-# have LaTeX installed or if you want to formulas look prettier in the HTML
-# output. When enabled you may also need to install MathJax separately and
-# configure the path to it using the MATHJAX_RELPATH option.
+# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
+# http://www.mathjax.org) which uses client side Javascript for the rendering
+# instead of using prerendered bitmaps. Use this if you do not have LaTeX
+# installed or if you want to formulas look prettier in the HTML output. When
+# enabled you may also need to install MathJax separately and configure the path
+# to it using the MATHJAX_RELPATH option.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
 
 USE_MATHJAX            = NO
 
-# When MathJax is enabled you need to specify the location relative to the
-# HTML output directory using the MATHJAX_RELPATH option. The destination
-# directory should contain the MathJax.js script. For instance, if the mathjax
-# directory is located at the same level as the HTML output directory, then
-# MATHJAX_RELPATH should be ../mathjax. The default value points to
-# the MathJax Content Delivery Network so you can quickly see the result without
-# installing MathJax.
-# However, it is strongly recommended to install a local
-# copy of MathJax from http://www.mathjax.org before deployment.
+# When MathJax is enabled you can set the default output format to be used for
+# the MathJax output. See the MathJax site (see:
+# http://docs.mathjax.org/en/latest/output.html) for more details.
+# Possible values are: HTML-CSS (which is slower, but has the best
+# compatibility), NativeMML (i.e. MathML) and SVG.
+# The default value is: HTML-CSS.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_FORMAT         = HTML-CSS
+
+# When MathJax is enabled you need to specify the location relative to the HTML
+# output directory using the MATHJAX_RELPATH option. The destination directory
+# should contain the MathJax.js script. For instance, if the mathjax directory
+# is located at the same level as the HTML output directory, then
+# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
+# Content Delivery Network so you can quickly see the result without installing
+# MathJax. However, it is strongly recommended to install a local copy of
+# MathJax from http://www.mathjax.org before deployment.
+# The default value is: http://cdn.mathjax.org/mathjax/latest.
+# This tag requires that the tag USE_MATHJAX is set to YES.
 
 MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
 
-# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
-# names that should be enabled during MathJax rendering.
+# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
+# extension names that should be enabled during MathJax rendering. For example
+# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
+# This tag requires that the tag USE_MATHJAX is set to YES.
 
 MATHJAX_EXTENSIONS     =
 
-# When the SEARCHENGINE tag is enabled doxygen will generate a search box
-# for the HTML output. The underlying search engine uses javascript
-# and DHTML and should work on any modern browser. Note that when using
-# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
-# (GENERATE_DOCSET) there is already a search function so this one should
-# typically be disabled. For large projects the javascript based search engine
-# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
+# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
+# of code that will be used on startup of the MathJax code. See the MathJax site
+# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
+# example see the documentation.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_CODEFILE       =
+
+# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
+# the HTML output. The underlying search engine uses javascript and DHTML and
+# should work on any modern browser. Note that when using HTML help
+# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
+# there is already a search function so this one should typically be disabled.
+# For large projects the javascript based search engine can be slow, then
+# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
+# search using the keyboard; to jump to the search box use <access key> + S
+# (what the <access key> is depends on the OS and browser, but it is typically
+# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
+# key> to jump into the search results window, the results can be navigated
+# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
+# the search. The filter options can be selected when the cursor is inside the
+# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
+# to select a filter and <Enter> or <escape> to activate or cancel the filter
+# option.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
 
 SEARCHENGINE           = YES
 
 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
-# implemented using a PHP enabled web server instead of at the web client
-# using Javascript. Doxygen will generate the search PHP script and index
-# file to put on the web server. The advantage of the server
-# based approach is that it scales better to large projects and allows
-# full text search. The disadvantages are that it is more difficult to setup
-# and does not have live searching capabilities.
+# implemented using a web server instead of a web client using Javascript. There
+# are two flavours of web server based searching depending on the
+# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
+# searching and an index file used by the script. When EXTERNAL_SEARCH is
+# enabled the indexing and searching needs to be provided by external tools. See
+# the section "External Indexing and Searching" for details.
+# The default value is: NO.
+# This tag requires that the tag SEARCHENGINE is set to YES.
 
 SERVER_BASED_SEARCH    = NO
 
+# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
+# script for searching. Instead the search results are written to an XML file
+# which needs to be processed by an external indexer. Doxygen will invoke an
+# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
+# search results.
+#
+# Doxygen ships with an example indexer ( doxyindexer) and search engine
+# (doxysearch.cgi) which are based on the open source search engine library
+# Xapian (see: http://xapian.org/).
+#
+# See the section "External Indexing and Searching" for details.
+# The default value is: NO.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTERNAL_SEARCH        = NO
+
+# The SEARCHENGINE_URL should point to a search engine hosted by a web server
+# which will return the search results when EXTERNAL_SEARCH is enabled.
+#
+# Doxygen ships with an example indexer ( doxyindexer) and search engine
+# (doxysearch.cgi) which are based on the open source search engine library
+# Xapian (see: http://xapian.org/). See the section "External Indexing and
+# Searching" for details.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SEARCHENGINE_URL       =
+
+# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
+# search data is written to a file for indexing by an external tool. With the
+# SEARCHDATA_FILE tag the name of this file can be specified.
+# The default file is: searchdata.xml.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SEARCHDATA_FILE        = searchdata.xml
+
+# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
+# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
+# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
+# projects and redirect the results back to the right project.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTERNAL_SEARCH_ID     =
+
+# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
+# projects other than the one defined by this configuration file, but that are
+# all added to the same external search index. Each project needs to have a
+# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
+# to a relative location where the documentation can be found. The format is:
+# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTRA_SEARCH_MAPPINGS  =
+
 #---------------------------------------------------------------------------
-# configuration options related to the LaTeX output
+# Configuration options related to the LaTeX output
 #---------------------------------------------------------------------------
 
-# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
-# generate Latex output.
+# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
+# The default value is: YES.
 
 GENERATE_LATEX         = YES
 
-# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
-# If a relative path is entered the value of OUTPUT_DIRECTORY will be
-# put in front of it. If left blank `latex' will be used as the default path.
+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: latex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
 
 LATEX_OUTPUT           = latex
 
 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
-# invoked. If left blank `latex' will be used as the default command name.
-# Note that when enabling USE_PDFLATEX this option is only used for
-# generating bitmaps for formulas in the HTML output, but not in the
-# Makefile that is written to the output directory.
+# invoked.
+#
+# Note that when enabling USE_PDFLATEX this option is only used for generating
+# bitmaps for formulas in the HTML output, but not in the Makefile that is
+# written to the output directory.
+# The default file is: latex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
 
 LATEX_CMD_NAME         = latex
 
-# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
-# generate index for LaTeX. If left blank `makeindex' will be used as the
-# default command name.
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
+# index for LaTeX.
+# The default file is: makeindex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
 
 MAKEINDEX_CMD_NAME     = makeindex
 
-# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
-# LaTeX documents. This may be useful for small projects and may help to
-# save some trees in general.
+# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
+# documents. This may be useful for small projects and may help to save some
+# trees in general.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
 
 COMPACT_LATEX          = NO
 
-# The PAPER_TYPE tag can be used to set the paper type that is used
-# by the printer. Possible values are: a4, letter, legal and
-# executive. If left blank a4wide will be used.
+# The PAPER_TYPE tag can be used to set the paper type that is used by the
+# printer.
+# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
+# 14 inches) and executive (7.25 x 10.5 inches).
+# The default value is: a4.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
 
 PAPER_TYPE             = a4wide
 
-# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
-# packages that should be included in the LaTeX output.
+# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
+# that should be included in the LaTeX output. To get the times font for
+# instance you can specify
+# EXTRA_PACKAGES=times
+# If left blank no extra packages will be included.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
 
 EXTRA_PACKAGES         =
 
-# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
-# the generated latex document. The header should contain everything until
-# the first chapter. If it is left blank doxygen will generate a
-# standard header. Notice: only use this tag if you know what you are doing!
+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
+# generated LaTeX document. The header should contain everything until the first
+# chapter. If it is left blank doxygen will generate a standard header. See
+# section "Doxygen usage" for information on how to let doxygen write the
+# default header to a separate file.
+#
+# Note: Only use a user-defined header if you know what you are doing! The
+# following commands have a special meaning inside the header: $title,
+# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
+# replace them by respectively the title of the page, the current date and time,
+# only the current date, the version number of doxygen, the project name (see
+# PROJECT_NAME), or the project number (see PROJECT_NUMBER).
+# This tag requires that the tag GENERATE_LATEX is set to YES.
 
 LATEX_HEADER           =
 
-# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
-# the generated latex document. The footer should contain everything after
-# the last chapter. If it is left blank doxygen will generate a
-# standard footer. Notice: only use this tag if you know what you are doing!
+# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
+# generated LaTeX document. The footer should contain everything after the last
+# chapter. If it is left blank doxygen will generate a standard footer.
+#
+# Note: Only use a user-defined footer if you know what you are doing!
+# This tag requires that the tag GENERATE_LATEX is set to YES.
 
 LATEX_FOOTER           =
 
-# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
-# is prepared for conversion to pdf (using ps2pdf). The pdf file will
-# contain links (just like the HTML output) instead of page references
-# This makes the output suitable for online browsing using a pdf viewer.
+# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
+# other source files which should be copied to the LATEX_OUTPUT output
+# directory. Note that the files will be copied as-is; there are no commands or
+# markers available.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_EXTRA_FILES      =
+
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
+# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
+# contain links (just like the HTML output) instead of page references. This
+# makes the output suitable for online browsing using a PDF viewer.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
 
 PDF_HYPERLINKS         = YES
 
-# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
-# plain latex in the generated Makefile. Set this option to YES to get a
+# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
+# the PDF file directly from the LaTeX files. Set this option to YES to get a
 # higher quality PDF documentation.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
 
 USE_PDFLATEX           = YES
 
-# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
-# command to the generated LaTeX files. This will instruct LaTeX to keep
-# running if errors occur, instead of asking the user for help.
-# This option is also used when generating formulas in HTML.
+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
+# command to the generated LaTeX files. This will instruct LaTeX to keep running
+# if errors occur, instead of asking the user for help. This option is also used
+# when generating formulas in HTML.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
 
 LATEX_BATCHMODE        = YES
 
-# If LATEX_HIDE_INDICES is set to YES then doxygen will not
-# include the index chapters (such as File Index, Compound Index, etc.)
-# in the output.
+# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
+# index chapters (such as File Index, Compound Index, etc.) in the output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
 
 LATEX_HIDE_INDICES     = NO
 
-# If LATEX_SOURCE_CODE is set to YES then doxygen will include
-# source code with syntax highlighting in the LaTeX output.
-# Note that which sources are shown also depends on other settings
-# such as SOURCE_BROWSER.
+# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
+# code with syntax highlighting in the LaTeX output.
+#
+# Note that which sources are shown also depends on other settings such as
+# SOURCE_BROWSER.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
 
 LATEX_SOURCE_CODE      = NO
 
 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
-# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
-# http://en.wikipedia.org/wiki/BibTeX for more info.
+# bibliography, e.g. plainnat, or ieeetr. See
+# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
+# The default value is: plain.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
 
 LATEX_BIB_STYLE        = plain
 
 #---------------------------------------------------------------------------
-# configuration options related to the RTF output
+# Configuration options related to the RTF output
 #---------------------------------------------------------------------------
 
-# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
-# The RTF output is optimized for Word 97 and may not look very pretty with
-# other RTF readers or editors.
+# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
+# RTF output is optimized for Word 97 and may not look too pretty with other RTF
+# readers/editors.
+# The default value is: NO.
 
 GENERATE_RTF           = NO
 
-# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
-# If a relative path is entered the value of OUTPUT_DIRECTORY will be
-# put in front of it. If left blank `rtf' will be used as the default path.
+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: rtf.
+# This tag requires that the tag GENERATE_RTF is set to YES.
 
 RTF_OUTPUT             = rtf
 
-# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
-# RTF documents. This may be useful for small projects and may help to
-# save some trees in general.
+# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
+# documents. This may be useful for small projects and may help to save some
+# trees in general.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_RTF is set to YES.
 
 COMPACT_RTF            = NO
 
-# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
-# will contain hyperlink fields. The RTF file will
-# contain links (just like the HTML output) instead of page references.
-# This makes the output suitable for online browsing using WORD or other
-# programs which support those fields.
-# Note: wordpad (write) and others do not support links.
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
+# contain hyperlink fields. The RTF file will contain links (just like the HTML
+# output) instead of page references. This makes the output suitable for online
+# browsing using Word or some other Word compatible readers that support those
+# fields.
+#
+# Note: WordPad (write) and others do not support links.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_RTF is set to YES.
 
 RTF_HYPERLINKS         = YES
 
-# Load style sheet definitions from file. Syntax is similar to doxygen's
-# config file, i.e. a series of assignments. You only have to provide
-# replacements, missing definitions are set to their default value.
+# Load stylesheet definitions from file. Syntax is similar to doxygen's config
+# file, i.e. a series of assignments. You only have to provide replacements,
+# missing definitions are set to their default value.
+#
+# See also section "Doxygen usage" for information on how to generate the
+# default style sheet that doxygen normally uses.
+# This tag requires that the tag GENERATE_RTF is set to YES.
 
 RTF_STYLESHEET_FILE    =
 
-# Set optional variables used in the generation of an rtf document.
-# Syntax is similar to doxygen's config file.
+# Set optional variables used in the generation of an RTF document. Syntax is
+# similar to doxygen's config file. A template extensions file can be generated
+# using doxygen -e rtf extensionFile.
+# This tag requires that the tag GENERATE_RTF is set to YES.
 
 RTF_EXTENSIONS_FILE    =
 
 #---------------------------------------------------------------------------
-# configuration options related to the man page output
+# Configuration options related to the man page output
 #---------------------------------------------------------------------------
 
-# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
-# generate man pages
+# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
+# classes and files.
+# The default value is: NO.
 
 GENERATE_MAN           = YES
 
-# The MAN_OUTPUT tag is used to specify where the man pages will be put.
-# If a relative path is entered the value of OUTPUT_DIRECTORY will be
-# put in front of it. If left blank `man' will be used as the default path.
+# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it. A directory man3 will be created inside the directory specified by
+# MAN_OUTPUT.
+# The default directory is: man.
+# This tag requires that the tag GENERATE_MAN is set to YES.
 
 MAN_OUTPUT             = man
 
-# The MAN_EXTENSION tag determines the extension that is added to
-# the generated man pages (default is the subroutine's section .3)
+# The MAN_EXTENSION tag determines the extension that is added to the generated
+# man pages. In case the manual section does not start with a number, the number
+# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
+# optional.
+# The default value is: .3.
+# This tag requires that the tag GENERATE_MAN is set to YES.
 
 MAN_EXTENSION          = .3
 
-# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
-# then it will generate one additional man file for each entity
-# documented in the real man page(s). These additional files
-# only source the real man page, but without them the man command
-# would be unable to find the correct page. The default is NO.
+# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
+# will generate one additional man file for each entity documented in the real
+# man page(s). These additional files only source the real man page, but without
+# them the man command would be unable to find the correct page.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_MAN is set to YES.
 
 MAN_LINKS              = YES
 
 #---------------------------------------------------------------------------
-# configuration options related to the XML output
+# Configuration options related to the XML output
 #---------------------------------------------------------------------------
 
-# If the GENERATE_XML tag is set to YES Doxygen will
-# generate an XML file that captures the structure of
-# the code including all documentation.
+# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
+# captures the structure of the code including all documentation.
+# The default value is: NO.
 
 GENERATE_XML           = NO
 
-# The XML_OUTPUT tag is used to specify where the XML pages will be put.
-# If a relative path is entered the value of OUTPUT_DIRECTORY will be
-# put in front of it. If left blank `xml' will be used as the default path.
+# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: xml.
+# This tag requires that the tag GENERATE_XML is set to YES.
 
 XML_OUTPUT             = xml
 
-# The XML_SCHEMA tag can be used to specify an XML schema,
-# which can be used by a validating XML parser to check the
-# syntax of the XML files.
+# The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a
+# validating XML parser to check the syntax of the XML files.
+# This tag requires that the tag GENERATE_XML is set to YES.
 
 XML_SCHEMA             =
 
-# The XML_DTD tag can be used to specify an XML DTD,
-# which can be used by a validating XML parser to check the
-# syntax of the XML files.
+# The XML_DTD tag can be used to specify a XML DTD, which can be used by a
+# validating XML parser to check the syntax of the XML files.
+# This tag requires that the tag GENERATE_XML is set to YES.
 
 XML_DTD                =
 
-# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
-# dump the program listings (including syntax highlighting
-# and cross-referencing information) to the XML output. Note that
-# enabling this will significantly increase the size of the XML output.
+# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
+# listings (including syntax highlighting and cross-referencing information) to
+# the XML output. Note that enabling this will significantly increase the size
+# of the XML output.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_XML is set to YES.
 
 XML_PROGRAMLISTING     = YES
 
 #---------------------------------------------------------------------------
-# configuration options for the AutoGen Definitions output
+# Configuration options related to the DOCBOOK output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
+# that can be used to generate PDF.
+# The default value is: NO.
+
+GENERATE_DOCBOOK       = NO
+
+# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
+# front of it.
+# The default directory is: docbook.
+# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
+
+DOCBOOK_OUTPUT         = docbook
+
+#---------------------------------------------------------------------------
+# Configuration options for the AutoGen Definitions output
 #---------------------------------------------------------------------------
 
-# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
-# generate an AutoGen Definitions (see autogen.sf.net) file
-# that captures the structure of the code including all
-# documentation. Note that this feature is still experimental
-# and incomplete at the moment.
+# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
+# Definitions (see http://autogen.sf.net) file that captures the structure of
+# the code including all documentation. Note that this feature is still
+# experimental and incomplete at the moment.
+# The default value is: NO.
 
 GENERATE_AUTOGEN_DEF   = NO
 
 #---------------------------------------------------------------------------
-# configuration options related to the Perl module output
+# Configuration options related to the Perl module output
 #---------------------------------------------------------------------------
 
-# If the GENERATE_PERLMOD tag is set to YES Doxygen will
-# generate a Perl module file that captures the structure of
-# the code including all documentation. Note that this
-# feature is still experimental and incomplete at the
-# moment.
+# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
+# file that captures the structure of the code including all documentation.
+#
+# Note that this feature is still experimental and incomplete at the moment.
+# The default value is: NO.
 
 GENERATE_PERLMOD       = NO
 
-# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
-# the necessary Makefile rules, Perl scripts and LaTeX code to be able
-# to generate PDF and DVI output from the Perl module output.
+# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
+# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
+# output from the Perl module output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
 
 PERLMOD_LATEX          = NO
 
-# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
-# nicely formatted so it can be parsed by a human reader.
-# This is useful
-# if you want to understand what is going on.
-# On the other hand, if this
-# tag is set to NO the size of the Perl module output will be much smaller
-# and Perl will parse it just the same.
+# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
+# formatted so it can be parsed by a human reader. This is useful if you want to
+# understand what is going on. On the other hand, if this tag is set to NO the
+# size of the Perl module output will be much smaller and Perl will parse it
+# just the same.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
 
 PERLMOD_PRETTY         = YES
 
-# The names of the make variables in the generated doxyrules.make file
-# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
-# This is useful so different doxyrules.make files included by the same
-# Makefile don't overwrite each other's variables.
+# The names of the make variables in the generated doxyrules.make file are
+# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
+# so different doxyrules.make files included by the same Makefile don't
+# overwrite each other's variables.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
 
 PERLMOD_MAKEVAR_PREFIX =
 
@@ -1466,106 +1884,128 @@ PERLMOD_MAKEVAR_PREFIX =
 # Configuration options related to the preprocessor
 #---------------------------------------------------------------------------
 
-# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
-# evaluate all C-preprocessor directives found in the sources and include
-# files.
+# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
+# C-preprocessor directives found in the sources and include files.
+# The default value is: YES.
 
 ENABLE_PREPROCESSING   = YES
 
-# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
-# names in the source code. If set to NO (the default) only conditional
-# compilation will be performed. Macro expansion can be done in a controlled
-# way by setting EXPAND_ONLY_PREDEF to YES.
+# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
+# in the source code. If set to NO only conditional compilation will be
+# performed. Macro expansion can be done in a controlled way by setting
+# EXPAND_ONLY_PREDEF to YES.
+# The default value is: NO.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
 MACRO_EXPANSION        = YES
 
-# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
-# then the macro expansion is limited to the macros specified with the
-# PREDEFINED and EXPAND_AS_DEFINED tags.
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
+# the macro expansion is limited to the macros specified with the PREDEFINED and
+# EXPAND_AS_DEFINED tags.
+# The default value is: NO.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
 EXPAND_ONLY_PREDEF     = YES
 
-# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
-# pointed to by INCLUDE_PATH will be searched when a #include is found.
+# If the SEARCH_INCLUDES tag is set to YES the includes files in the
+# INCLUDE_PATH will be searched if a #include is found.
+# The default value is: YES.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
 SEARCH_INCLUDES        = YES
 
 # The INCLUDE_PATH tag can be used to specify one or more directories that
-# contain include files that are not input files but should be processed by
-# the preprocessor.
+# contain include files that are not input files but should be processed by the
+# preprocessor.
+# This tag requires that the tag SEARCH_INCLUDES is set to YES.
 
 INCLUDE_PATH           =
 
 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
 # patterns (like *.h and *.hpp) to filter out the header-files in the
-# directories. If left blank, the patterns specified with FILE_PATTERNS will
-# be used.
+# directories. If left blank, the patterns specified with FILE_PATTERNS will be
+# used.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
 INCLUDE_FILE_PATTERNS  =
 
-# The PREDEFINED tag can be used to specify one or more macro names that
-# are defined before the preprocessor is started (similar to the -D option of
-# gcc). The argument of the tag is a list of macros of the form: name
-# or name=definition (no spaces). If the definition and the = are
-# omitted =1 is assumed. To prevent a macro definition from being
-# undefined via #undef or recursively expanded use the := operator
-# instead of the = operator.
+# The PREDEFINED tag can be used to specify one or more macro names that are
+# defined before the preprocessor is started (similar to the -D option of e.g.
+# gcc). The argument of the tag is a list of macros of the form: name or
+# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
+# is assumed. To prevent a macro definition from being undefined via #undef or
+# recursively expanded use the := operator instead of the = operator.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
 PREDEFINED             = "__attribute__(x)="
 
-# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
-# this tag can be used to specify a list of macro names that should be expanded.
-# The macro definition that is found in the sources will be used.
-# Use the PREDEFINED tag if you want to use a different macro definition that
-# overrules the definition found in the source code.
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
+# tag can be used to specify a list of macro names that should be expanded. The
+# macro definition that is found in the sources will be used. Use the PREDEFINED
+# tag if you want to use a different macro definition that overrules the
+# definition found in the source code.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
 EXPAND_AS_DEFINED      =
 
-# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
-# doxygen's preprocessor will remove all references to function-like macros
-# that are alone on a line, have an all uppercase name, and do not end with a
-# semicolon, because these will confuse the parser if not removed.
+# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
+# remove all refrences to function-like macros that are alone on a line, have an
+# all uppercase name, and do not end with a semicolon. Such function macros are
+# typically used for boiler-plate code, and will confuse the parser if not
+# removed.
+# The default value is: YES.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
 SKIP_FUNCTION_MACROS   = YES
 
 #---------------------------------------------------------------------------
-# Configuration::additions related to external references
+# Configuration options related to external references
 #---------------------------------------------------------------------------
 
-# The TAGFILES option can be used to specify one or more tagfiles. For each
-# tag file the location of the external documentation should be added. The
-# format of a tag file without this location is as follows:
-#
+# The TAGFILES tag can be used to specify one or more tag files. For each tag
+# file the location of the external documentation should be added. The format of
+# a tag file without this location is as follows:
 # TAGFILES = file1 file2 ...
 # Adding location for the tag files is done as follows:
-#
 # TAGFILES = file1=loc1 "file2 = loc2" ...
-# where "loc1" and "loc2" can be relative or absolute paths
-# or URLs. Note that each tag file must have a unique name (where the name does
-# NOT include the path). If a tag file is not located in the directory in which
-# doxygen is run, you must also specify the path to the tagfile here.
+# where loc1 and loc2 can be relative or absolute paths or URLs. See the
+# section "Linking to external documentation" for more information about the use
+# of tag files.
+# Note: Each tag file must have an unique name (where the name does NOT include
+# the path). If a tag file is not located in the directory in which doxygen is
+# run, you must also specify the path to the tagfile here.
 
 TAGFILES               =
 
-# When a file name is specified after GENERATE_TAGFILE, doxygen will create
-# a tag file that is based on the input files it reads.
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
+# tag file that is based on the input files it reads. See section "Linking to
+# external documentation" for more information about the usage of tag files.
 
 GENERATE_TAGFILE       =
 
-# If the ALLEXTERNALS tag is set to YES all external classes will be listed
-# in the class index. If set to NO only the inherited external classes
-# will be listed.
+# If the ALLEXTERNALS tag is set to YES all external class will be listed in the
+# class index. If set to NO only the inherited external classes will be listed.
+# The default value is: NO.
 
 ALLEXTERNALS           = NO
 
-# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
-# in the modules index. If set to NO, only the current project's groups will
-# be listed.
+# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
+# the modules index. If set to NO, only the current project's groups will be
+# listed.
+# The default value is: YES.
 
 EXTERNAL_GROUPS        = YES
 
+# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
+# the related pages index. If set to NO, only the current project's pages will
+# be listed.
+# The default value is: YES.
+
+EXTERNAL_PAGES         = YES
+
 # The PERL_PATH should be the absolute path and name of the perl script
-# interpreter (i.e. the result of `which perl').
+# interpreter (i.e. the result of 'which perl').
+# The default file (with absolute path) is: /usr/bin/perl.
 
 PERL_PATH              = /usr/bin/perl
 
@@ -1573,222 +2013,293 @@ PERL_PATH              = /usr/bin/perl
 # Configuration options related to the dot tool
 #---------------------------------------------------------------------------
 
-# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
-# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
-# or super classes. Setting the tag to NO turns the diagrams off. Note that
-# this option also works with HAVE_DOT disabled, but it is recommended to
-# install and use dot, since it yields more powerful graphs.
+# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
+# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
+# NO turns the diagrams off. Note that this option also works with HAVE_DOT
+# disabled, but it is recommended to install and use dot, since it yields more
+# powerful graphs.
+# The default value is: YES.
 
 CLASS_DIAGRAMS         = YES
 
 # You can define message sequence charts within doxygen comments using the \msc
-# command. Doxygen will then run the mscgen tool (see
-# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
+# command. Doxygen will then run the mscgen tool (see:
+# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
 # the mscgen tool resides. If left empty the tool is assumed to be found in the
 # default search path.
 
 MSCGEN_PATH            =
 
-# If set to YES, the inheritance and collaboration graphs will hide
-# inheritance and usage relations if the target is undocumented
-# or is not a class.
+# You can include diagrams made with dia in doxygen documentation. Doxygen will
+# then run dia to produce the diagram and insert it in the documentation. The
+# DIA_PATH tag allows you to specify the directory where the dia binary resides.
+# If left empty dia is assumed to be found in the default search path.
+
+DIA_PATH               =
+
+# If set to YES, the inheritance and collaboration graphs will hide inheritance
+# and usage relations if the target is undocumented or is not a class.
+# The default value is: YES.
 
 HIDE_UNDOC_RELATIONS   = YES
 
 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
-# available from the path. This tool is part of Graphviz, a graph visualization
-# toolkit from AT&T and Lucent Bell Labs. The other options in this section
-# have no effect if this option is set to NO (the default)
+# available from the path. This tool is part of Graphviz (see:
+# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
+# Bell Labs. The other options in this section have no effect if this option is
+# set to NO
+# The default value is: NO.
 
 HAVE_DOT               = YES
 
-# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
-# allowed to run in parallel. When set to 0 (the default) doxygen will
-# base this on the number of processors available in the system. You can set it
-# explicitly to a value larger than 0 to get control over the balance
-# between CPU load and processing speed.
+# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
+# to run in parallel. When set to 0 doxygen will base this on the number of
+# processors available in the system. You can set it explicitly to a value
+# larger than 0 to get control over the balance between CPU load and processing
+# speed.
+# Minimum value: 0, maximum value: 32, default value: 0.
+# This tag requires that the tag HAVE_DOT is set to YES.
 
 DOT_NUM_THREADS        = 0
 
-# By default doxygen will use the Helvetica font for all dot files that
-# doxygen generates. When you want a differently looking font you can specify
-# the font name using DOT_FONTNAME. You need to make sure dot is able to find
-# the font, which can be done by putting it in a standard location or by setting
-# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
-# directory containing the font.
+# When you want a differently looking font n the dot files that doxygen
+# generates you can specify the font name using DOT_FONTNAME. You need to make
+# sure dot is able to find the font, which can be done by putting it in a
+# standard location or by setting the DOTFONTPATH environment variable or by
+# setting DOT_FONTPATH to the directory containing the font.
+# The default value is: Helvetica.
+# This tag requires that the tag HAVE_DOT is set to YES.
 
-DOT_FONTNAME           = FreeSans.ttf
+DOT_FONTNAME           = Helvetica
 
-# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
-# The default size is 10pt.
+# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
+# dot graphs.
+# Minimum value: 4, maximum value: 24, default value: 10.
+# This tag requires that the tag HAVE_DOT is set to YES.
 
 DOT_FONTSIZE           = 10
 
-# By default doxygen will tell dot to use the Helvetica font.
-# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
-# set the path where dot can find it.
+# By default doxygen will tell dot to use the default font as specified with
+# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
+# the path where dot can find it using this tag.
+# This tag requires that the tag HAVE_DOT is set to YES.
 
 DOT_FONTPATH           =
 
-# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
-# will generate a graph for each documented class showing the direct and
-# indirect inheritance relations. Setting this tag to YES will force the
-# CLASS_DIAGRAMS tag to NO.
+# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
+# each documented class showing the direct and indirect inheritance relations.
+# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
 
 CLASS_GRAPH            = YES
 
-# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
-# will generate a graph for each documented class showing the direct and
-# indirect implementation dependencies (inheritance, containment, and
-# class references variables) of the class with other documented classes.
+# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
+# graph for each documented class showing the direct and indirect implementation
+# dependencies (inheritance, containment, and class references variables) of the
+# class with other documented classes.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
 
 COLLABORATION_GRAPH    = YES
 
-# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
-# will generate a graph for groups, showing the direct groups dependencies
+# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
+# groups, showing the direct groups dependencies.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
 
 GROUP_GRAPHS           = YES
 
 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
 # collaboration diagrams in a style similar to the OMG's Unified Modeling
 # Language.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
 
 UML_LOOK               = YES
 
-# If the UML_LOOK tag is enabled, the fields and methods are shown inside
-# the class node. If there are many fields or methods and many nodes the
-# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
-# threshold limits the number of items for each type to make the size more
-# managable. Set this to 0 for no limit. Note that the threshold may be
-# exceeded by 50% before the limit is enforced.
+# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
+# class node. If there are many fields or methods and many nodes the graph may
+# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
+# number of items for each type to make the size more manageable. Set this to 0
+# for no limit. Note that the threshold may be exceeded by 50% before the limit
+# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
+# but if the number exceeds 15, the total amount of fields shown is limited to
+# 10.
+# Minimum value: 0, maximum value: 100, default value: 10.
+# This tag requires that the tag HAVE_DOT is set to YES.
 
 UML_LIMIT_NUM_FIELDS   = 10
 
-# If set to YES, the inheritance and collaboration graphs will show the
-# relations between templates and their instances.
+# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
+# collaboration graphs will show the relations between templates and their
+# instances.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
 
 TEMPLATE_RELATIONS     = YES
 
-# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
-# tags are set to YES then doxygen will generate a graph for each documented
-# file showing the direct and indirect include dependencies of the file with
-# other documented files.
+# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
+# YES then doxygen will generate a graph for each documented file showing the
+# direct and indirect include dependencies of the file with other documented
+# files.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
 
 INCLUDE_GRAPH          = YES
 
-# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
-# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
-# documented header file showing the documented files that directly or
-# indirectly include this file.
+# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
+# set to YES then doxygen will generate a graph for each documented file showing
+# the direct and indirect include dependencies of the file with other documented
+# files.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
 
 INCLUDED_BY_GRAPH      = YES
 
-# If the CALL_GRAPH and HAVE_DOT options are set to YES then
-# doxygen will generate a call dependency graph for every global function
-# or class method. Note that enabling this option will significantly increase
-# the time of a run. So in most cases it will be better to enable call graphs
-# for selected functions only using the \callgraph command.
+# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
+# dependency graph for every global function or class method.
+#
+# Note that enabling this option will significantly increase the time of a run.
+# So in most cases it will be better to enable call graphs for selected
+# functions only using the \callgraph command.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
 
 CALL_GRAPH             = YES
 
-# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
-# doxygen will generate a caller dependency graph for every global function
-# or class method. Note that enabling this option will significantly increase
-# the time of a run. So in most cases it will be better to enable caller
-# graphs for selected functions only using the \callergraph command.
+# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
+# dependency graph for every global function or class method.
+#
+# Note that enabling this option will significantly increase the time of a run.
+# So in most cases it will be better to enable caller graphs for selected
+# functions only using the \callergraph command.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
 
 CALLER_GRAPH           = YES
 
-# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
-# will generate a graphical hierarchy of all classes instead of a textual one.
+# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
+# hierarchy of all classes instead of a textual one.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
 
 GRAPHICAL_HIERARCHY    = YES
 
-# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES
-# then doxygen will show the dependencies a directory has on other directories
-# in a graphical way. The dependency relations are determined by the #include
-# relations between the files in the directories.
+# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
+# dependencies a directory has on other directories in a graphical way. The
+# dependency relations are determined by the #include relations between the
+# files in the directories.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
 
 DIRECTORY_GRAPH        = YES
 
 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
-# generated by dot. Possible values are svg, png, jpg, or gif.
-# If left blank png will be used. If you choose svg you need to set
-# HTML_FILE_EXTENSION to xhtml in order to make the SVG files
-# visible in IE 9+ (other browsers do not have this requirement).
+# generated by dot.
+# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
+# to make the SVG files visible in IE 9+ (other browsers do not have this
+# requirement).
+# Possible values are: png, jpg, gif and svg.
+# The default value is: png.
+# This tag requires that the tag HAVE_DOT is set to YES.
 
 DOT_IMAGE_FORMAT       = png
 
 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
 # enable generation of interactive SVG images that allow zooming and panning.
-# Note that this requires a modern browser other than Internet Explorer.
-# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
-# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
-# visible. Older versions of IE do not have SVG support.
+#
+# Note that this requires a modern browser other than Internet Explorer. Tested
+# and working are Firefox, Chrome, Safari, and Opera.
+# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
+# the SVG files visible. Older versions of IE do not have SVG support.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
 
 INTERACTIVE_SVG        = NO
 
-# The tag DOT_PATH can be used to specify the path where the dot tool can be
+# The DOT_PATH tag can be used to specify the path where the dot tool can be
 # found. If left blank, it is assumed the dot tool can be found in the path.
+# This tag requires that the tag HAVE_DOT is set to YES.
 
 DOT_PATH               =
 
 # The DOTFILE_DIRS tag can be used to specify one or more directories that
-# contain dot files that are included in the documentation (see the
-# \dotfile command).
+# contain dot files that are included in the documentation (see the \dotfile
+# command).
+# This tag requires that the tag HAVE_DOT is set to YES.
 
 DOTFILE_DIRS           =
 
 # The MSCFILE_DIRS tag can be used to specify one or more directories that
-# contain msc files that are included in the documentation (see the
-# \mscfile command).
+# contain msc files that are included in the documentation (see the \mscfile
+# command).
 
 MSCFILE_DIRS           =
 
-# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
-# nodes that will be shown in the graph. If the number of nodes in a graph
-# becomes larger than this value, doxygen will truncate the graph, which is
-# visualized by representing a node as a red box. Note that doxygen if the
-# number of direct children of the root node in a graph is already larger than
-# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
-# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
+# The DIAFILE_DIRS tag can be used to specify one or more directories that
+# contain dia files that are included in the documentation (see the \diafile
+# command).
+
+DIAFILE_DIRS           =
+
+# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
+# that will be shown in the graph. If the number of nodes in a graph becomes
+# larger than this value, doxygen will truncate the graph, which is visualized
+# by representing a node as a red box. Note that doxygen if the number of direct
+# children of the root node in a graph is already larger than
+# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
+# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
+# Minimum value: 0, maximum value: 10000, default value: 50.
+# This tag requires that the tag HAVE_DOT is set to YES.
 
 DOT_GRAPH_MAX_NODES    = 50
 
-# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
-# graphs generated by dot. A depth value of 3 means that only nodes reachable
-# from the root by following a path via at most 3 edges will be shown. Nodes
-# that lay further from the root node will be omitted. Note that setting this
-# option to 1 or 2 may greatly reduce the computation time needed for large
-# code bases. Also note that the size of a graph can be further restricted by
+# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
+# generated by dot. A depth value of 3 means that only nodes reachable from the
+# root by following a path via at most 3 edges will be shown. Nodes that lay
+# further from the root node will be omitted. Note that setting this option to 1
+# or 2 may greatly reduce the computation time needed for large code bases. Also
+# note that the size of a graph can be further restricted by
 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
+# Minimum value: 0, maximum value: 1000, default value: 0.
+# This tag requires that the tag HAVE_DOT is set to YES.
 
 MAX_DOT_GRAPH_DEPTH    = 0
 
 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
-# background. This is disabled by default, because dot on Windows does not
-# seem to support this out of the box. Warning: Depending on the platform used,
-# enabling this option may lead to badly anti-aliased labels on the edges of
-# a graph (i.e. they become hard to read).
+# background. This is disabled by default, because dot on Windows does not seem
+# to support this out of the box.
+#
+# Warning: Depending on the platform used, enabling this option may lead to
+# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
+# read).
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
 
 DOT_TRANSPARENT        = YES
 
 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
 # files in one run (i.e. multiple -o and -T options on the command line). This
-# makes dot run faster, but since only newer versions of dot (>1.8.10)
-# support this, this feature is disabled by default.
+# makes dot run faster, but since only newer versions of dot (>1.8.10) support
+# this, this feature is disabled by default.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
 
 DOT_MULTI_TARGETS      = YES
 
-# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
-# generate a legend page explaining the meaning of the various boxes and
-# arrows in the dot generated graphs.
+# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
+# explaining the meaning of the various boxes and arrows in the dot generated
+# graphs.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
 
 GENERATE_LEGEND        = YES
 
-# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
-# remove the intermediate dot files that are used to generate
-# the various graphs.
+# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
+# files that are used to generate the various graphs.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
 
 DOT_CLEANUP            = YES
index 7599b57..73ce64f 100644 (file)
@@ -1,9 +1,6 @@
 /*
  * This file is part of nmealib.
  *
- * Copyright (c) 2008 Timur Sinitsyn
- * Copyright (c) 2011 Ferry Huberts
- *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
index bd12ff7..55cc4ad 100644 (file)
@@ -1,9 +1,6 @@
 /*
  * This file is part of nmealib.
  *
- * Copyright (c) 2008 Timur Sinitsyn
- * Copyright (c) 2011 Ferry Huberts
- *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
index c0c6d04..4c9af70 100644 (file)
@@ -1,9 +1,6 @@
 /*
  * This file is part of nmealib.
  *
- * Copyright (c) 2008 Timur Sinitsyn
- * Copyright (c) 2011 Ferry Huberts
- *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
index a692434..b214dfc 100644 (file)
@@ -1,9 +1,6 @@
 /*
  * This file is part of nmealib.
  *
- * Copyright (c) 2008 Timur Sinitsyn
- * Copyright (c) 2011 Ferry Huberts
- *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
index fd7470c..0c24725 100644 (file)
@@ -1,9 +1,6 @@
 /*
  * This file is part of nmealib.
  *
- * Copyright (c) 2008 Timur Sinitsyn
- * Copyright (c) 2011 Ferry Huberts
- *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
index e761d00..398e197 100644 (file)
@@ -1,9 +1,6 @@
 /*
  * This file is part of nmealib.
  *
- * Copyright (c) 2008 Timur Sinitsyn
- * Copyright (c) 2011 Ferry Huberts
- *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
index 93dc0bf..c2fb093 100644 (file)
@@ -1,9 +1,6 @@
 /*
  * This file is part of nmealib.
  *
- * Copyright (c) 2008 Timur Sinitsyn
- * Copyright (c) 2011 Ferry Huberts
- *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
 extern "C" {
 #endif /* __cplusplus */
 
-bool nmea_parse_sentence_has_invalid_chars(const char * str, const size_t str_len, const char * strName, char * report,
-               const size_t reportSize);
+const char * isInvalidNMEACharacter(const char * c);
+const char * nmea_parse_sentence_has_invalid_chars(const char * s, const size_t len);
 
-int nmea_parse_get_sentence_type(const char *s, const int len);
-int nmea_parse_get_sentence_length(const char *s, const int len, int *checksum);
+enum nmeaPACKTYPE nmea_parse_get_sentence_type(const char *s, const int len);
 
-int nmea_parse_GPGGA(const char *s, const int len, nmeaGPGGA *pack);
-int nmea_parse_GPGSA(const char *s, const int len, nmeaGPGSA *pack);
-int nmea_parse_GPGSV(const char *s, const int len, nmeaGPGSV *pack);
-int nmea_parse_GPRMC(const char *s, const int len, nmeaGPRMC *pack);
-int nmea_parse_GPVTG(const char *s, const int len, nmeaGPVTG *pack);
+int nmea_parse_GPGGA(const char *s, const int len, bool has_checksum, nmeaGPGGA *pack);
+int nmea_parse_GPGSA(const char *s, const int len, bool has_checksum, nmeaGPGSA *pack);
+int nmea_parse_GPGSV(const char *s, const int len, bool has_checksum, nmeaGPGSV *pack);
+int nmea_parse_GPRMC(const char *s, const int len, bool has_checksum, nmeaGPRMC *pack);
+int nmea_parse_GPVTG(const char *s, const int len, bool has_checksum, nmeaGPVTG *pack);
 
 #ifdef  __cplusplus
 }
index 87596ef..3fbc615 100644 (file)
@@ -1,9 +1,6 @@
 /*
  * This file is part of nmealib.
  *
- * Copyright (c) 2008 Timur Sinitsyn
- * Copyright (c) 2011 Ferry Huberts
- *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
 #define __NMEA_PARSER_H__
 
 #include <nmea/info.h>
+#include <nmea/sentence.h>
 
 #ifdef  __cplusplus
 extern "C" {
 #endif /* __cplusplus */
 
+/* we need to be able to parse much longer sentences than specified in the (original) specification */
+#define SENTENCE_SIZE (4096 * 1)
+
+typedef enum _sentence_parser_state {
+  SKIP_UNTIL_START,
+  READ_SENTENCE,
+  READ_CHECKSUM,
+  READ_EOL
+} sentence_parser_state;
+
 /**
- * Description of a parser node / packet
+ * NMEA frame parser structure
  */
-typedef struct _nmeaParserNODE {
-       int packType;                                           /**< the type of the packet (see nmeaPACKTYPE) */
-       void *pack;                         /**< the packet (a pointer to a malloced sentence sctucture) */
-       struct _nmeaParserNODE *next_node;  /**< pointer to the next node / packet */
-} nmeaParserNODE;
+typedef struct _sentencePARSER {
+    int sentence_checksum;
+    int calculated_checksum;
+
+    char sentence_checksum_chars[2];
+    char sentence_checksum_chars_count;
+
+    char sentence_eol_chars_count;
+
+    bool has_checksum;
+
+    sentence_parser_state state;
+} sentencePARSER;
 
 /**
- * The parser data.
+ * parsed NMEA data and frame parser state
  */
 typedef struct _nmeaPARSER {
-       nmeaParserNODE *top_node; /**< the first node / packet */
-       nmeaParserNODE *end_node; /**< the last node / packet */
-       char *buffer;             /**< the buffer containing the string to parse */
-       int buff_size;            /**< the size of the buffer */
-       int buff_use;             /**< the number of bytes in the buffer */
+    struct {
+        unsigned int length;
+        char buffer[SENTENCE_SIZE];
+    } buffer;
+
+    union {
+        nmeaGPGGA gpgga;
+        nmeaGPGSA gpgsa;
+        nmeaGPGSV gpgsv;
+        nmeaGPRMC gprmc;
+        nmeaGPVTG gpvtg;
+    } sentence;
+
+    sentencePARSER sentence_parser;
 } nmeaPARSER;
 
 int nmea_parser_init(nmeaPARSER *parser);
-void nmea_parser_destroy(nmeaPARSER *parser);
-int nmea_parse(nmeaPARSER *parser, const char *buff, const int buff_sz, nmeaINFO *info);
-
-int nmea_parser_push(nmeaPARSER *parser, const char *buff, int buff_sz);
-int nmea_parser_top(const nmeaPARSER *parser);
-int nmea_parser_pop(nmeaPARSER *parser, void **pack_ptr);
-int nmea_parser_peek(const nmeaPARSER *parser, void **pack_ptr);
-int nmea_parser_drop(nmeaPARSER *parser);
-void nmea_parser_buff_clear(nmeaPARSER *parser);
-void nmea_parser_queue_clear(nmeaPARSER *parser);
+int nmea_parse(nmeaPARSER * parser, const char * s, int len, nmeaINFO * info);
 
 #ifdef  __cplusplus
 }
index eee47ab..dbfd133 100644 (file)
@@ -1,9 +1,6 @@
 /*
  * This file is part of nmealib.
  *
- * Copyright (c) 2008 Timur Sinitsyn
- * Copyright (c) 2011 Ferry Huberts
- *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
index ea69082..20c66d6 100644 (file)
@@ -1,9 +1,6 @@
 /*
  * This file is part of nmealib.
  *
- * Copyright (c) 2008 Timur Sinitsyn
- * Copyright (c) 2011 Ferry Huberts
- *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
diff --git a/lib/pud/nmealib/samples/Makefile b/lib/pud/nmealib/samples/Makefile
deleted file mode 100644 (file)
index ac2b4c6..0000000
+++ /dev/null
@@ -1,48 +0,0 @@
-include ../Makefile.inc
-
-#
-# Settings
-#
-
-SAMPLES = generate generator math parse parse_file
-SMPLS = $(SAMPLES:%=../build/samples/%)
-SMPLOBJ = $(SAMPLES:%=%/main.o)
-
-LIBRARIES = -lm -L../lib -lnmea
-INCLUDES = -I ../include
-
-
-#
-# Targets
-#
-
-all: all-before samples
-
-remake: clean all
-
-samples: $(SMPLS)
-
-../build/samples/%: %/main.o
-ifeq ($(VERBOSE),0)
-       @echo "[LD] $@"
-endif
-       $(MAKECMDPREFIX)$(CC) $(CFLAGS) $< $(LIBRARIES) -o $@
-
-%/main.o: %/main.c Makefile ../Makefile.inc
-ifeq ($(VERBOSE),0)
-       @echo "[CC] $<"
-endif
-       $(MAKECMDPREFIX)$(CC) $(CFLAGS) $(INCLUDES) -c $< -o $@
-
-
-#
-# Phony Targets
-#
-
-.PHONY: all all-before clean samples
-
-all-before:
-       $(MAKECMDPREFIX)mkdir -p ../build/samples
-
-clean:
-       $(MAKECMDPREFIX)rm -f $(SMPLOBJ) $(SMPLS)
diff --git a/lib/pud/nmealib/samples/generate/main.c b/lib/pud/nmealib/samples/generate/main.c
deleted file mode 100644 (file)
index 3b93a21..0000000
+++ /dev/null
@@ -1,91 +0,0 @@
-/*
- * This file is part of nmealib.
- *
- * Copyright (c) 2008 Timur Sinitsyn
- * Copyright (c) 2011 Ferry Huberts
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library 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
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- */
-
-#include <nmea/info.h>
-
-#include <nmea/gmath.h>
-#include <nmea/generate.h>
-
-#include <stdio.h>
-#include <unistd.h>
-
-int main(int argc __attribute__((unused)), char *argv[] __attribute__((unused))) {
-       nmeaINFO info;
-       char buff[2048];
-       int gen_sz;
-       int it;
-
-       nmea_zero_INFO(&info);
-
-       info.sig = 3;
-       info.fix = 3;
-       info.lat = 5000.0;
-       info.lon = 3600.0;
-       info.speed = 2.14 * NMEA_TUS_MS;
-       info.elv = 10.86;
-       info.track = 45;
-       info.mtrack = 55;
-       info.magvar = 55;
-       info.HDOP = 2.3;
-       info.VDOP = 1.2;
-       info.PDOP = 2.594224354;
-
-       nmea_INFO_set_present(&info.present, SIG);
-       nmea_INFO_set_present(&info.present, FIX);
-       nmea_INFO_set_present(&info.present, LAT);
-       nmea_INFO_set_present(&info.present, LON);
-       nmea_INFO_set_present(&info.present, SPEED);
-       nmea_INFO_set_present(&info.present, ELV);
-       nmea_INFO_set_present(&info.present, TRACK);
-       nmea_INFO_set_present(&info.present, MTRACK);
-       nmea_INFO_set_present(&info.present, MAGVAR);
-       nmea_INFO_set_present(&info.present, HDOP);
-       nmea_INFO_set_present(&info.present, VDOP);
-       nmea_INFO_set_present(&info.present, PDOP);
-
-       info.satinfo.inuse = NMEA_MAXSAT;
-       nmea_INFO_set_present(&info.present, SATINUSECOUNT);
-       for (it = 0; it < NMEA_MAXSAT; it++) {
-               info.satinfo.in_use[it] = it + 1;
-       }
-       nmea_INFO_set_present(&info.present, SATINUSE);
-
-       info.satinfo.inview = NMEA_MAXSAT;
-       for (it = 0; it < NMEA_MAXSAT; it++) {
-               info.satinfo.sat[it].id = it + 1;
-               info.satinfo.sat[it].elv = (it * 10);
-               info.satinfo.sat[it].azimuth = it + 1;
-               info.satinfo.sat[it].sig = 99 - it;
-       }
-       nmea_INFO_set_present(&info.present, SATI