Re-acquired man page source as docbook-xml
authorSven-Ola Tuecke <sven-ola@gmx.de>
Tue, 16 Dec 2008 20:49:36 +0000 (21:49 +0100)
committerSven-Ola Tuecke <sven-ola@gmx.de>
Tue, 16 Dec 2008 20:49:36 +0000 (21:49 +0100)
files/olsrd-manpages.xml [new file with mode: 0644]

diff --git a/files/olsrd-manpages.xml b/files/olsrd-manpages.xml
new file mode 100644 (file)
index 0000000..c87f4a6
--- /dev/null
@@ -0,0 +1,867 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+<article id="olsrd_manpages" lang="en">
+  <title>Unik OLSRD Man Pages</title>
+
+  <articleinfo>
+    <titleabbrev>olsrd man pages</titleabbrev>
+
+    <author>
+      <firstname>Sven-Ola</firstname>
+
+      <surname>Tücke</surname>
+
+      <affiliation>
+        <address><email>sven-ola@gmx.de</email></address>
+      </affiliation>
+    </author>
+
+    <releaseinfo>Version 0.5.7-pre</releaseinfo>
+
+    <copyright>
+      <year>2004</year>
+
+      <holder>Andreas Tønnesen</holder>
+    </copyright>
+
+    <copyright>
+      <year>2008</year>
+
+      <holder>Sven-Ola Tücke</holder>
+    </copyright>
+
+    <abstract>
+      <para>Source for olsrd man pages</para>
+    </abstract>
+  </articleinfo>
+
+  <para>This document contains sources for man pages. They where converted
+  from the original man page files which are maintained by Andreas Tønnesen
+  until 2005. Because the 0.5.7 version of olsrd introduces several
+  configuration changes and removes old configuration options, a re-write was
+  necessary in late 2008.</para>
+
+  <para>To process this file and convert the included man pages, use the
+  <ulink url="http://docbook2x.sourceforge.net/">docbook2X</ulink> tool
+  kit.</para>
+
+  <procedure>
+    <step>
+      <para>Install docbook2X: <command>sudo apt-get install
+      docbook2x</command></para>
+    </step>
+
+    <step>
+      <para>Install the XML DTD: <command>sudo apt-get install
+      docbook-xml</command></para>
+    </step>
+
+    <step>
+      <para>Run the converter: <command>docbook2x-man --solinks
+      olsrd-manpages.xml</command></para>
+    </step>
+  </procedure>
+
+  <refentry id="olsrd_8">
+    <indexterm>
+      <primary><command>olsrd</command></primary>
+    </indexterm>
+
+    <refentryinfo>
+      <titleabbrev><command>olsrd</command> Optimized Link State Routing
+      Protocol Daemon</titleabbrev>
+    </refentryinfo>
+
+    <refmeta>
+      <refentrytitle id="olsrd_8_name">olsrd</refentrytitle>
+
+      <manvolnum>8</manvolnum>
+    </refmeta>
+
+    <refnamediv>
+      <refname><command>olsrd</command></refname>
+
+      <refpurpose>Optimized Link State Routing protocol daemon</refpurpose>
+    </refnamediv>
+
+    <refsynopsisdiv>
+      <cmdsynopsis>
+        <command>olsrd</command>
+
+        <arg>-i <arg choice="plain" condition="">Filename1</arg><arg
+        choice="plain" condition=""
+        rep="repeat">Filename2</arg><replaceable></replaceable></arg>
+
+        <arg>-f <replaceable>configfile</replaceable></arg>
+
+        <arg>-d <replaceable>debuglevel</replaceable></arg>
+
+        <arg>-ipv6</arg>
+
+        <arg>-ipc</arg>
+
+        <arg>-dispout</arg>
+
+        <arg>-nofork</arg>
+
+        <arg>-bcast <replaceable>broadcastaddress</replaceable></arg>
+
+        <arg>-delgw</arg>
+
+        <arg>-hint <replaceable>HELLO interval</replaceable></arg>
+
+        <arg>-tcint <replaceable>TC interval</replaceable></arg>
+
+        <arg>-midint <replaceable>MID interval</replaceable></arg>
+
+        <arg>-hnaint <replaceable>HNA interval</replaceable></arg>
+
+        <arg>-T <replaceable>scheduler poll rate</replaceable></arg>
+
+        <arg>-hemu <replaceable>IP address</replaceable></arg>
+      </cmdsynopsis>
+    </refsynopsisdiv>
+
+    <refsect1>
+      <title>Description</title>
+
+      <para><command>olsrd</command> 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 - but as it is still in an experimental stage
+      most users will prefer running it with some debug output which is
+      directed to STDOUT.</para>
+
+      <para>This manual page only lists the command line arguments. For
+      details of the configuration file see the comments included in
+      <filename>/etc/olsrd.conf</filename>. Note that none of these options
+      need to be set at the command line - all these options and others can be
+      set in the configuration file.</para>
+
+      <para>This implementation also features an alternative routing scheme
+      based on link quality using an ETX-like metric developed by the c-base
+      community in Berlin. To enable and tweak this mode you must use the
+      configuration file.</para>
+
+      <para>The homepage of olsrd is <ulink
+      url="http://www.olsr.org">http://www.olsr.org</ulink></para>
+    </refsect1>
+
+    <refsect1>
+      <title>Options</title>
+
+      <variablelist>
+        <varlistentry>
+          <term><option>-i <replaceable>interface1</replaceable> ...
+          <replaceable>interfaceN</replaceable></option></term>
+
+          <listitem>
+            <para>This option specifies on what network interfaces olsrd
+            should run. These interfaces cannot be aliased interfaces such as
+            eth0:1.</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>-f
+          <replaceable>configfile</replaceable></option></term>
+
+          <listitem>
+            <para>This option overrides the default configuration file path
+            used by olsrd - <filename>/etc/olsrd.conf</filename></para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>-d
+          <replaceable>debuglevel</replaceable></option></term>
+
+          <listitem>
+            <para>This option specifies the amount of debug information olsrd
+            should write to STDOUT. If set to 0 olsrd will run in the
+            background.</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>-ipv6</option></term>
+
+          <listitem>
+            <para>This option instructs olsrd to use the Internet Protocol
+            version 6. The default is version 4.</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>-ipc</option></term>
+
+          <listitem>
+            <para>This option allows the GUI front-end created fro olsrd to
+            connect to olsrd at runtime.</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>-dispin</option></term>
+
+          <listitem>
+            <para>This option, when set, causes olsrd to display all incoming
+            packet data on STDOUT. When using IPv4 the data is displayed in
+            decimal format, when using IPv6 the data is displayed in
+            hexadecimal format.</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>-dispout</option></term>
+
+          <listitem>
+            <para>This option, when set, causes olsrd to display all outgoing
+            packet data on STDOUT. When using IPv4 the data is displayed in
+            decimal format, when using IPv6 the data is displayed in
+            hexadecimal format.</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>-nofork</option></term>
+
+          <listitem>
+            <para>This option, when set, causes olsrd not to fork and run in
+            the background if started with debuglevel 0. Useful for init
+            scripts.</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>-delgw</option></term>
+
+          <listitem>
+            <para>If this option is set olsrd will remove any default routes
+            set prior to adding an Internet route based on OLSR
+            routing.</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>-bcast
+          <replaceable>broadcastaddress</replaceable></option></term>
+
+          <listitem>
+            <para>This option specifies what IPv4 broadcastaddress to use for
+            OLSR control traffic. The only value that currently makes sense
+            when setting broadcast address mannually is <systemitem
+            class="ipaddress">255.255.255.255</systemitem>. The default action
+            is to use the broadcastaddres that the network interface is
+            preconfigured with(per interface).</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>-hint
+          <replaceable>seconds</replaceable></option></term>
+
+          <listitem>
+            <para>This value sets the interval on which
+            <emphasis>HELLO</emphasis> messages should be generated. The value
+            is a floating point number representing seconds.</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>-tcint
+          <replaceable>seconds</replaceable></option></term>
+
+          <listitem>
+            <para>This value sets the interval on which
+            <emphasis>TC</emphasis> messages should be generated. The value is
+            a floating point number representing seconds.</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>-midint
+          <replaceable>seconds</replaceable></option></term>
+
+          <listitem>
+            <para>This value sets the interval on which
+            <emphasis>MID</emphasis> messages should be generated. The value
+            is a floating point number representing seconds.</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>-T <replaceable>seconds</replaceable></option></term>
+
+          <listitem>
+            <para>This option sets the polling intervall of the scheduler. The
+            default is 0.1 seconds. This option should only be considered if
+            running with really low emission intervals.</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>-hemu <replaceable>IP
+          address</replaceable></option></term>
+
+          <listitem>
+            <para>Use this option to connect to the olsr_switch network
+            simulation applica‐ tion. Here IP address will be the IP address
+            that the process will set as its main address in the emulation
+            mode. This address has no connection to the real IP-stack and can
+            be chosen freely.</para>
+          </listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect1>
+
+    <refsect1>
+      <title>Files</title>
+
+      <simplelist type="vert">
+        <member><filename><?install-datadir ?>/etc/olsrd.conf</filename></member>
+      </simplelist>
+    </refsect1>
+
+    <refsect1>
+      <title>See Also</title>
+
+      <simplelist type="inline">
+        <member><xref endterm="olsrd_conf_5_name"
+        linkend="olsrd_conf_5" /></member>
+      </simplelist>
+    </refsect1>
+  </refentry>
+
+  <refentry id="olsrd_conf_5">
+    <indexterm>
+      <primary><command>olsrd.conf</command></primary>
+    </indexterm>
+
+    <refentryinfo>
+      <titleabbrev>Configuration File for Olsrd</titleabbrev>
+    </refentryinfo>
+
+    <refmeta>
+      <refentrytitle id="olsrd_conf_5_name">olsrd.conf</refentrytitle>
+
+      <manvolnum>5</manvolnum>
+    </refmeta>
+
+    <refnamediv>
+      <refname><filename>olsrd.conf</filename></refname>
+
+      <refpurpose>configuration file for <xref endterm="olsrd_8_name"
+      linkend="olsrd_8" /></refpurpose>
+    </refnamediv>
+
+    <refsect1>
+      <title>Description</title>
+
+      <para>The file olsrd.conf Which is located in /etc by default, contains
+      run-time configuration for the Optimized Link State Routing daemon <xref
+      endterm="olsrd_8_name" linkend="olsrd_8" />. Olsrd can however be set to
+      read an alternative configuration file at startup using the
+      <option>-f</option> command line argument. A configuration file
+      parser/generator <filename>olsrd_cfgparser</filename> can be built as
+      both a standalone executable or a dynamically linked library from the
+      olsrd sources. The DLL version can be used to easily create tools for
+      generating/parsing olsrd configuration files.</para>
+
+      <para>The configuration file consists of comments, single options and
+      option blocks.</para>
+    </refsect1>
+
+    <refsect1>
+      <title>Comments</title>
+
+      <para>Comments are everything following a <emphasis>#</emphasis> in a
+      line. This data is discarded. Commenting out options is an easy way to
+      make olsrd use the default value for that option.</para>
+    </refsect1>
+
+    <refsect1>
+      <title>Single Options</title>
+
+      <para>Single options are single lines options that consists of a keword
+      and a user supplied value. Note that a comment can follow such a option
+      on the same line. Valid single options are:</para>
+
+      <variablelist>
+        <varlistentry>
+          <term><option>DebugLevel [0-9]</option></term>
+
+          <listitem>
+            <para>Controls the amount of debug output olsrd sends to stdout.
+            If set to 0, olsrd will detatch from the current process and run
+            in the background. A value of 9 yields a maximum of debug output.
+            Defaults to <emphasis>0</emphasis>.</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>IpVersion [4|6]</option></term>
+
+          <listitem>
+            <para>Olsrd supports both IP version 4 and 6. This option controls
+            what IP version olsrd is to use. Defaults to
+            <emphasis>4</emphasis>.</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>AllowNoInt [yes|no]</option></term>
+
+          <listitem>
+            <para>Olsrd supports dynamic configuration of network interfaces.
+            This means that interfaces on which olsrd runs, can be
+            reconfigured and olsrd will update itself with no need to be
+            restarted. Olsrd also supports removal and addittion of interfaces
+            in run-time. This option specifies if olsrd should keep running if
+            no network interfaces are available. Defaults to
+            <emphasis>yes</emphasis>.</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>TosValue [0-16]</option></term>
+
+          <listitem>
+            <para>This value controls the type of service value to set in the
+            IP header of OLSR control traffic. Defaults to
+            <option>16</option>.</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>Willingness [0-7]</option></term>
+
+          <listitem>
+            <para>Nodes participating in a OLSR routed network will announce
+            their willingness to act as relays for OLSR control traffic for
+            their neighbors. This option specifies a fixed willingness value
+            to be announced by the local node. 4 is a neutral option here,
+            while 0 specifies that this node will never act as a relay, and 7
+            specifies that this node will always act as such a relay. If this
+            option is not set in the configuration file, then olsrd will try
+            to retrieve information about the system power and dynamically
+            update willingness according to this info. If no such info can be
+            retrieved willingness is set to <emphasis>4</emphasis>.</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>UseHysteresis [yes|no]</option></term>
+
+          <listitem>
+            <para>If set to yes hysteresis will be used as explained in
+            section 14 of RFC3626.</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>HystScaling [0.01-0.99]</option></term>
+
+          <listitem>
+            <para>Sets the scaling value used by the hysteresis algorithm.
+            This must be a positive floating point value smaller than 1.0.
+            Consult RFC3626 for details. The default value is
+            <emphasis>0.5</emphasis>.</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>HystThrHigh [HystThrLow-0.99]</option></term>
+
+          <listitem>
+            <para>This option sets the upper threshold for accepting a link in
+            hysteresis calculation. The value must be higher than the one set
+            as the lower threshold. Defaults to
+            <emphasis>0.8</emphasis>.</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>HystThrLow [0.01-HystThrHigh]</option></term>
+
+          <listitem>
+            <para>This option sets the lower threshold for setting a link to
+            asymmetric using hysteresis. The value must be lower than the one
+            set as the upper threshold. Defaults to
+            <emphasis>0.3</emphasis>.</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>Pollrate [0.1-10.0]</option></term>
+
+          <listitem>
+            <para>This option sets the interval, in seconds, that the olsrd
+            event scheduler should be set to poll. A setting of 0.2 will set
+            olsrd to poll for events every 0.2 seconds. Defaults to
+            <emphasis>0.1</emphasis>.</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>NicChgsPollInt[0.1-100.0]</option></term>
+
+          <listitem>
+            <para>This option sets the interval, in seconds, that olsrd will
+            check the configured inter‐ faces for changes in configuration.
+            Defaults to <emphasis>2.5</emphasis>.</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>TcRedundancy [0|1|2]</option></term>
+
+          <listitem>
+            <para>This value controls the TC redundancy used by the local node
+            in TC message generation. To enable a more robust understanding of
+            the topology, nodes can be set to announce more than just their
+            MPR selector set in TC messages. If set to 0 the advertised link
+            set of the node is limited to the MPR selectors. If set to 1 the
+            advertised link set of the node is the union of its MPR set and
+            its MPR selector set. Finally, if set to 2 the advertised link set
+            of the node is the full symmetric neighbor set of the node.
+            Defaults to <emphasis>0</emphasis>.</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>MprCoverage [1-]</option></term>
+
+          <listitem>
+            <para>This value decides how many MPRs a node should attempt to
+            select for every two hop neigh‐ bor. Defaults to
+            <emphasis>1</emphasis>, and any other setting will severly reduce
+            the optimization intro‐ duced by the MPR secheme!</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>LinkQualityLevel [1-2]</option></term>
+
+          <listitem>
+            <para>This setting decides the Link Quality scheme to use. If set
+            to 0 link quality is not regarded and olsrd runs in "RFC3626
+            mode". If set to 1 link quality is used when calcu‐ lating MPRs.
+            If set to 2 routes will also be calculated based on distributed
+            link quality information. Note that a setting of 1 or 2
+            <emphasis>breaks RFC3626 compability</emphasis>! This option
+            should therefore only be set to 1 or 2 if such a setting is used
+            by all other nodes in the network.</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>LinkQualityFishEye [0|1]</option></term>
+
+          <listitem>
+            <para>Enables(1) or disables(0) use of the experimental Fish Eye
+            algorithm.</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>ClearScreen [yes|no]</option></term>
+
+          <listitem>
+            <para>If set to yes and olsrd is running with a debuglevel &gt;0
+            the terminal to which output is sent(STDOUT) is cleared prior to
+            writing updated tables. This makes it easier to follow changes in
+            real-time by eye. If STDOUT is not a terminal(eg. it is a file),
+            then no action is taken upon writing tables to STDOUT.</para>
+          </listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect1>
+
+    <refsect1>
+      <title>Option Blocks</title>
+
+      <para>Option blocks are configuration options that holds a body of
+      sub-options encapsulated in curled braces ( <emphasis>{}</emphasis> ).
+      Valid options are:</para>
+
+      <variablelist>
+        <varlistentry>
+          <term><option>IpcConnect {[sub-options]}</option></term>
+
+          <listitem>
+            <para>Olsrd can allow processes to make a TCP connection to itself
+            on which data regarding the topology will be transmitted. This is
+            typically used by GUI applications to provide a user-friendly
+            front-end to olsrd. This option block controls thees kind of
+            connections.</para>
+
+            <para><option>MaxConnections [0-5]</option>: This option specifies
+            how many connections that can exist simoult‐ neously. Multiple
+            connections have not been tested, and does not work! This option
+            should only be used to control wheter or not processes can connect
+            to olsrd by setting it either to 0, which will tell olsrd not to
+            allow any connections, or by setting it to a positive value.
+            Defaults to 0.</para>
+
+            <para><option>Host [IPv4 address]</option>: This option specifies
+            a single host that is allowed to connect to olsrd. By default only
+            the loopback address(127.0.0.1) is set to be allowed. So if you
+            want to be able to con‐ nect from another host you should add it
+            here. This option can be repeated to add multi‐ ple hosts.</para>
+
+            <para><option>Net [IPv4 netaddress] [IPv4 netmask]</option>: Here
+            you can specify an entire netrange of IP addresses which olsrd
+            will allow TCP con‐ nections from. This option can be repeated to
+            add multiple networks.</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>Hna4 {[sub-options]}</option></term>
+
+          <listitem>
+            <para>Hosts in a OLSR routed network can announce connecitivty to
+            external networks using HNA messages. This optionblock is used to
+            set the IPv4 nteworks to be announced by this host.</para>
+
+            <para><option>[IPv4 netaddress] [IPv4 netmask]</option>: Specifies
+            a IPv4 network to announce in HNA messages. Multiple entries can
+            be added. To announce Internet connectivity set <emphasis>0.0.0.0
+            0.0.0.0</emphasis></para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>Hna6 {[sub-options]}</option></term>
+
+          <listitem>
+            <para>Hosts in a OLSR routed network can announce connecitivty to
+            external networks using HNA messages. This optionblock is used to
+            set the IPv6 nteworks to be announced by this host.</para>
+
+            <para><option>[IPv6 netaddress] [0-48]</option>: Specifies a IPv6
+            network to announce in HNA messages. The second value is the
+            prefix-length of the network address. Multiple entries can be
+            added. To announce Internet con‐ nectivity set <emphasis>::
+            0</emphasis></para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>LoadPlugin "[plugin-name]"
+          {[sub-options]}x</option></term>
+
+          <listitem>
+            <para>Specifies a plugin that olsrd is to load at startup.</para>
+
+            <para><option>PlParam [key] [value]</option>: Sends a pair of
+            parameters to the plugin at initialization. Consult individual
+            plugin documentation to find the possible parameters.</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>Interface "[device-name1]" "[device-name2]" ...
+          {[sub-options]}</option></term>
+
+          <listitem>
+            <para>This optionblock specifies one or more network interfaces on
+            which olsrd should run. Atleast one network interface block must
+            be specified for olsrd to run! Various parame‐ ters can be
+            specified on individual interfaces or groups of interfaces. This
+            optionblock can be repeated to add multiple interface
+            configurations.</para>
+
+            <para><option>AutoDetectChanges [yes|no]</option>: Olsrd can
+            autodetect changes in interface configurations (polling on the
+            interval set by <option>NicChgsPollInt</option>). This is Enabled
+            by default but can be turned off pr. NIC to save CPU
+            cycles.</para>
+
+            <para><option>Ip4Broadcast [IPv4 address]</option>: Forces the
+            given IPv4 broadcast address to be used as destination address for
+            all outgo‐ ing OLSR traffic on the interface. In reallity only the
+            address <emphasis>255.255.255.255</emphasis> makes sense to set
+            here. If this option is not set the broadcast address that the
+            interface is configured with will be used. This address will also
+            be updated in run-time if a change is detected.</para>
+
+            <para><option>Ip6AddrType [site-local|global]</option>: This
+            option sets what IPv6 address type is to be used in interface
+            address detection. Defaults to site-local.</para>
+
+            <para><option>Ip6MulticastSite [IPv6 address]</option>: Sets the
+            destionation of outgoing OLSR traffic on this interface to use the
+            specified IPv6 multicast address as destination if the site-local
+            address type is set on this interface.</para>
+
+            <para><option>Ip6MulticastGlobal [IPv6 address]</option>: Sets the
+            destionation of outgoing OLSR traffic on this interface to use the
+            specified IPv6 multicast address as destination if the global
+            address type is set on this inter‐ face.</para>
+
+            <para><option>HelloInterval [0.0-]</option>: Sets the interval on
+            which HELLO messages will be generated and transmitted on this
+            interface.</para>
+
+            <para><option>HelloValidityTime [0.0-]</option>: Sets the validity
+            time to be announced in HELLO messages generated by this host on
+            this interface. This value must be larger than than the HELLO
+            generation interval to make any sense. Defaults to 3 * the
+            generation interval.</para>
+
+            <para><option>TcInterval [0.0-]</option>: Sets the interval on
+            which TC messages will be generated and transmitted on this inter‐
+            face.</para>
+
+            <para><option>TcValidityTime [0.0-]</option>: Sets the validity
+            time to be announced in TC messages generated by this host on this
+            interface. This value must be larger than than the TC generation
+            interval to make any sense. Defaults to 3 * the generation
+            interval.</para>
+
+            <para><option>MidInterval [0.0-]</option>: Sets the interval on
+            which MID messages will be generated and transmitted on this
+            inter‐ face.</para>
+
+            <para><option>MidValidityTime [0.0-]</option>: Sets the validity
+            time to be announced in MID messages generated by this host on
+            this interface. This value must be larger than than the MID
+            generation interval to make any sense. Defaults to 3 * the
+            generation interval.</para>
+
+            <para><option>HnaInterval [0.0-]</option>: Sets the interval on
+            which HNA messages will be generated and transmitted on this
+            inter‐ face.</para>
+
+            <para><option>HnaValidityTime [0.0-]</option>: Sets the validity
+            time to be announced in HNA messages generated by this host on
+            this interface. This value must be larger than than the HNA
+            generation interval to make any sense. Defaults to 3 * the
+            generation interval.</para>
+
+            <para><option>Weight [0-]</option>: When multiple links exist
+            between hosts the weight of the interface is used to determine the
+            link to route by. Normally the weight is automatically calculated
+            by olsrd based on the characteristics of the interface, but here
+            you can specify a fixed value. Olsrd will choose links with the
+            lowest value.</para>
+          </listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect1>
+
+    <refsect1>
+      <title>Misc</title>
+
+      <para>The homepage of olsrd is <ulink
+      url="http://www.olsr.org">http://www.olsr.org</ulink></para>
+    </refsect1>
+
+    <refsect1>
+      <title>Files</title>
+
+      <para><filename>/etc/olsrd.conf</filename></para>
+    </refsect1>
+
+    <refsect1>
+      <title>See Also</title>
+
+      <simplelist type="inline">
+        <member><xref endterm="olsrd_8_name" linkend="olsrd_8" /></member>
+      </simplelist>
+    </refsect1>
+  </refentry>
+
+  <refentry id="olsr_swtich_8">
+    <indexterm>
+      <primary><command>olsr_switch</command></primary>
+    </indexterm>
+
+    <refentryinfo>
+      <titleabbrev>Olsrd Network Simulator</titleabbrev>
+    </refentryinfo>
+
+    <refmeta>
+      <refentrytitle id="olsr_switch_8_name">olsrd.conf</refentrytitle>
+
+      <manvolnum>8</manvolnum>
+    </refmeta>
+
+    <refnamediv>
+      <refname>olsr_switch</refname>
+
+      <refpurpose>olsrd network simulator</refpurpose>
+    </refnamediv>
+
+    <refsynopsisdiv>
+      <cmdsynopsis>
+        <command>olsr_switch</command>
+
+        <arg>-foo <replaceable>foo</replaceable></arg>
+
+        <arg>-bar <replaceable>bar</replaceable></arg>
+      </cmdsynopsis>
+    </refsynopsisdiv>
+
+    <refsect1>
+      <title>Description</title>
+
+      <para><command>olsr_switch</command> 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 - but as it is still in an experimental stage
+      most users will prefer running it with some debug output which is
+      directed to STDOUT. </para>
+
+      <para>This manual page only lists the command line arguments. For
+      details of the configuration file see the comments included in
+      <filename>/etc/olsrd.conf</filename>. Note that none of these options
+      need to be set at the command line - all these options and others can be
+      set in the configuration file. </para>
+
+      <para>The homepage of olsrd is <ulink
+      url="http://www.olsr.org">http://www.olsr.org</ulink> </para>
+    </refsect1>
+
+    <refsect1>
+      <title>Options</title>
+
+      <variablelist>
+        <varlistentry>
+          <term><option>-foo <replaceable>foo</replaceable></option></term>
+
+          <listitem>
+            <para>This option specifies on what network interfaces olsrd
+            should run. These interfaces cannot be aliased interfaces such as
+            eth0:1. </para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>-bar <replaceable>bar</replaceable></option></term>
+
+          <listitem>
+            <para>This option overrides the default configuration file path
+            used by olsrd - <filename>/etc/olsrd.conf</filename> </para>
+          </listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect1>
+
+    <refsect1>
+      <title>Files</title>
+
+      <para><filename>/etc/olsrd.conf</filename></para>
+    </refsect1>
+
+    <refsect1>
+      <title>See also</title>
+
+      <para><xref endterm="olsrd_8_name" linkend="olsrd_8" />, <xref
+      endterm="olsrd_conf_5_name" linkend="olsrd_conf_5" /></para>
+    </refsect1>
+  </refentry>
+</article>