</step>
<step>
- <para>Run the converter: <command>docbook2x-man --solinks
- olsrd-manpages.xml</command></para>
+ <para>Run the converter: <command>cd ./files &&
+ make</command></para>
</step>
</procedure>
- <refentry id="olsrd_8">
- <indexterm>
- <primary><command>olsrd</command></primary>
- </indexterm>
+ <appendix id="manpages">
+ <title id="manpages-title">Man Pages</title>
- <refentryinfo>
- <titleabbrev><command>olsrd</command> Optimized Link State Routing
- Protocol Daemon</titleabbrev>
- </refentryinfo>
+ <refentry id="olsrd_8">
+ <indexterm>
+ <primary><command>olsrd</command></primary>
+ </indexterm>
- <refmeta>
- <refentrytitle id="olsrd_8_name">olsrd</refentrytitle>
+ <refentryinfo>
+ <titleabbrev><command>olsrd</command> Optimized Link State Routing
+ Protocol Daemon</titleabbrev>
+ </refentryinfo>
- <manvolnum>8</manvolnum>
- </refmeta>
+ <refmeta>
+ <refentrytitle id="olsrd_8-title">olsrd</refentrytitle>
- <refnamediv>
- <refname><command>olsrd</command></refname>
+ <manvolnum>8</manvolnum>
+ </refmeta>
- <refpurpose>Optimized Link State Routing protocol daemon</refpurpose>
- </refnamediv>
+ <refnamediv>
+ <refname><command>olsrd</command></refname>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>olsrd</command>
+ <refpurpose>Optimized Link State Routing protocol daemon</refpurpose>
+ </refnamediv>
- <arg>-i <arg choice="plain" condition="">Filename1</arg><arg
- choice="plain" condition=""
- rep="repeat">Filename2</arg><replaceable></replaceable></arg>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>olsrd</command>
- <arg>-f <replaceable>configfile</replaceable></arg>
+ <group>
+ <arg>-h</arg>
- <arg>-d <replaceable>debuglevel</replaceable></arg>
+ <arg>--help</arg>
+ </group>
- <arg>-ipv6</arg>
+ <group>
+ <arg>-v</arg>
- <arg>-ipc</arg>
+ <arg>--version</arg>
+ </group>
- <arg>-dispout</arg>
+ <group choice="req">
+ <arg>-f</arg>
- <arg>-nofork</arg>
+ <arg>--config</arg>
- <arg>-bcast <replaceable>broadcastaddress</replaceable></arg>
+ <replaceable> configfile</replaceable>
+ </group>
- <arg>-delgw</arg>
+ <group choice="req">
+ <arg>-d</arg>
- <arg>-hint <replaceable>HELLO interval</replaceable></arg>
+ <arg>--DebugLevel</arg>
- <arg>-tcint <replaceable>TC interval</replaceable></arg>
+ <replaceable> level</replaceable>
+ </group>
- <arg>-midint <replaceable>MID interval</replaceable></arg>
+ <group>
+ <arg>-n</arg>
- <arg>-hnaint <replaceable>HNA interval</replaceable></arg>
+ <arg>--nofork</arg>
+ </group>
- <arg>-T <replaceable>scheduler poll rate</replaceable></arg>
+ <group>
+ <arg>-X</arg>
- <arg>-hemu <replaceable>IP address</replaceable></arg>
- </cmdsynopsis>
- </refsynopsisdiv>
+ <arg>--dispin</arg>
+ </group>
- <refsect1>
- <title>Description</title>
+ <group>
+ <arg>-O</arg>
- <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>
+ <arg>--dispout</arg>
+ </group>
- <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>
+ <group>
+ <arg>-D</arg>
- <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>
+ <arg>--delgw</arg>
+ </group>
- <para>The homepage of olsrd is <ulink
- url="http://www.olsr.org">http://www.olsr.org</ulink></para>
- </refsect1>
+ <group>
+ <arg>-P</arg>
- <refsect1>
- <title>Options</title>
+ <arg>--ipc</arg>
+ </group>
- <variablelist>
- <varlistentry>
- <term><option>-i <replaceable>interface1</replaceable> ...
- <replaceable>interfaceN</replaceable></option></term>
+ <group choice="req">
+ <arg>-H</arg>
- <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>
+ <arg>--hemu</arg>
- <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>
+ <replaceable> ipaddr</replaceable>
+ </group>
- <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 manually is <systemitem
- class="ipaddress">255.255.255.255</systemitem>. The default action
- is to use the broadcast address 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 interval 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 application. 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>
-
- <caution>
- <para>The current implementation (olsrd-0.5.7-pre as of Dec-2008)
- discards several parameters controlling the Link Quality Extensions in
- earlier versions (they are marked as <quote>Removed</quote> below). It
- is planned to re-implement the old RFC-mode using a special
- LinkQualityAlgorithm.</para>
- </caution>
-
- <para>Single options are single lines options that consists of a keyword
- 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 detach 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 addition 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>Removed from implementation: <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>Removed from implementation: <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>Removed from implementation: <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>Removed from implementation: <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 interfaces 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 neighbor. Defaults to
- <emphasis>1</emphasis>, and any other setting will severely reduce
- the optimization introduced by the MPR scheme!</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>Removed from implementation: <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 calculating 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 compatibility</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>Removed from implementation: <option>LinkQualityWinsize
- [number]</option></term>
-
- <listitem>
- <para>Window size for the Link Quality extensions.</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 >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 (e.g. 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 this kind of
- connections.</para>
-
- <para><option>MaxConnections [0-5]</option>: This option specifies
- how many connections that can exist simultaneously. Multiple
- connections have not been tested, and does not work! This option
- should only be used to control whether 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 connect from another host you should add it
- here. This option can be repeated to add multiple hosts.</para>
-
- <para><option>Net [IPv4 netaddress] [IPv4 netmask]</option>: Here
- you can specify an entire net range of IP addresses which olsrd
- will allow TCP connections 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 connectivity to
- external networks using HNA messages. This option block is used to
- set the IPv4 networks 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 connectivity to
- external networks using HNA messages. This option block is used to
- set the IPv6 networks 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 connectivity 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 option block specifies one or more network interfaces
- on which olsrd should run. At least one network interface block
- must be specified for olsrd to run! Various parameters can be
- specified on individual interfaces or groups of interfaces. This
- option block can be repeated to add multiple interface
- configurations.</para>
-
- <para><option>AutoDetectChanges [yes|no]</option>: Olsrd can auto
- detect 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 outgoing OLSR traffic on the interface. In reality 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
- destination 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
- destination 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 interface.</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 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
- interface.</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 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
- interface.</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 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
- interface.</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 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_switch_8">
- <indexterm>
- <primary><command>olsr_switch</command></primary>
- </indexterm>
-
- <refentryinfo>
- <titleabbrev>Olsrd Network Simulator</titleabbrev>
- </refentryinfo>
-
- <refmeta>
- <refentrytitle id="olsr_switch_8_name">olsr_switch</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>
+ <arg>interface1</arg>
- <refsect1>
- <title>Files</title>
+ <arg rep="repeat">interface2</arg>
+ </cmdsynopsis>
- <para><filename>/etc/olsrd.conf</filename></para>
- </refsect1>
-
- <refsect1>
- <title>See also</title>
+ <note>
+ <para>Only if <command>olsrd</command> is started without arguments,
+ the default config file is loaded - usually
+ <filename>/etc/olsrd.conf</filename> or
+ <filename>/usr/local/etc/olsrd.conf</filename>.</para>
+ </note>
+ </refsynopsisdiv>
- <simplelist type="inline">
- <member><xref endterm="olsrd_8_name" linkend="olsrd_8" /></member>
+ <refsect1>
+ <title>Description</title>
- <member><xref endterm="olsrd_conf_5_name"
- linkend="olsrd_conf_5" /></member>
- </simplelist>
- </refsect1>
- </refentry>
+ <para><command>olsrd</command> is an implementation of the
+ <emphasis>O</emphasis>ptimized <emphasis>L</emphasis>ink
+ <emphasis>S</emphasis>tate <emphasis>R</emphasis>outing protocol
+ (OLSR) for <emphasis>M</emphasis>obile <emphasis>A</emphasis>d-hoc
+ <emphasis>NET</emphasis>works (MANETs). 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.</para>
+
+ <para>This implementation of the OLSR protocol features an alternative
+ routing scheme based on link quality using an ETX-like metric which
+ was initially developed by the c-base community in Berlin and extended
+ by the Funkfeuer community in Vienna. This alternative routing scheme
+ uses non-standard messages and is therefore incompatible to standard
+ OLSR as it's described in the RFC. To switch back to RFC-mode, you
+ need to enable a (currently unavailable) metrics plug in using the
+ <option>--LinkQualityAlgorithm</option> option (see <xref
+ endterm="olsrd_conf_5-title" linkend="olsrd_conf_5" />).</para>
+
+ <para>The home page of olsrd is <ulink
+ url="http://www.olsr.org">http://www.olsr.org</ulink></para>
+ </refsect1>
+
+ <refsect1>
+ <title>Options</title>
+
+ <para>You can specify options either on the command line or by using a
+ config file - usually <filename>/etc/olsrd.conf</filename> or
+ <filename>/usr/local/etc/olsrd.conf</filename>. The getopt parser
+ replaces the <option>--config</option> option with options acquired in
+ from the specified config file. While it is possible to operate using
+ only command line options, you may want a config file especially for
+ readability of the larger config options (e.g.
+ <option>--Interface</option> or <option>--LoadPlugin</option>). To
+ preset a config file setting, add an option before
+ <option>--config</option>. To overwrite a config file setting, add an
+ option after <option>--config</option>.</para>
+
+ <para>The following list compiles only options frequently specified on
+ the command line. If you use one or more command line options, you
+ normally also have to specify <option>--config</option> for the
+ desired config file. </para>
+
+ <variablelist>
+ <varlistentry>
+ <term><option>-h</option> or <option>--help</option></term>
+
+ <listitem>
+ <para>Prints out the list of valid command line / config file
+ options and exits.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-v</option> or <option>--version</option></term>
+
+ <listitem>
+ <para>Prints out the current version number and exits.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-f <replaceable>configfile</replaceable></option> or
+ <option>--config <replaceable>configfile</replaceable></option>
+ </term>
+
+ <listitem>
+ <para>Reads in the specified config file. The acquired options
+ are inserted into the command line at the position of the
+ <option>-f</option> or <option>--config</option> option.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-d level</option> or <option>--DebugLevel
+ <replaceable>level</replaceable></option></term>
+
+ <listitem>
+ <para>Specifies the amount of debug information to be printed
+ out during operation. If set to 0, <command>olsrd</command> will
+ run in the background.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-n</option> or <option>--nofork</option></term>
+
+ <listitem>
+ <para>This option causes <command>olsrd</command> not to fork
+ into the background, even when started with <option>--DebugLevel
+ 0</option>.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-X</option> or <option>--dispin</option></term>
+
+ <listitem>
+ <para>This option causes <command>olsrd</command> to display all
+ incoming packet data.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-O</option> or <option>--dispout</option></term>
+
+ <listitem>
+ <para>This option causes <command>olsrd</command> to display all
+ outgoing packet data. </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-D</option> or <option>--delgw</option></term>
+
+ <listitem>
+ <para>This option will remove a static default route when
+ <command>olsrd</command> adds an Internet route based on OLSR
+ routing.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-P</option> or <option>--ipc</option></term>
+
+ <listitem>
+ <para>This option allows the GUI front end to create one
+ connection to <command>olsrd</command> at runtime.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-H <replaceable>ipaddr</replaceable></option> or
+ <option>--hemu <replaceable>ipaddr</replaceable></option></term>
+
+ <listitem>
+ <para>Use this option to connect to the <xref
+ endterm="olsr_switch_8-title" linkend="olsr_switch_8" /> network
+ simulation application. Here <replaceable>ipaddr</replaceable>
+ will be the IP address that the process will set as its main
+ address in the emulation mode. This emulated interfaces have no
+ connection to the real IP stack and can be chosen freely.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-i</option></term>
+
+ <listitem>
+ <para>Ignored for compatibility - older versions of
+ <command>olsrd</command> expect one or more interface names
+ after this option (see below). </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option><replaceable>interface1</replaceable>
+ interface2...</option></term>
+
+ <listitem>
+ <para>Any character combination without a leading dash is
+ interpreted as a list of interfaces. The list specifies on what
+ network interfaces olsrd should run. Only the main IP address of
+ an interface is evaluated, so you cannot specify an interface
+ alias such as eth0:1. Note, that you also cannot change the
+ interface parameters such as intervals and validity times. Use
+ the <option>--Interface</option> option instead.</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-title"
+ 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-title">olsrd.conf</refentrytitle>
+
+ <manvolnum>5</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname><filename>olsrd.conf</filename></refname>
+
+ <refpurpose>configuration file for <xref endterm="olsrd_8-title"
+ 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-title" 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>
+
+ <caution>
+ <para>The current implementation (olsrd-0.5.7-pre as of Dec-2008)
+ discards several parameters controlling the Link Quality Extensions
+ in earlier versions (they are marked as <quote>Removed</quote>
+ below). It is planned to re-implement the old RFC-mode using a
+ special LinkQualityAlgorithm.</para>
+ </caution>
+
+ <para>Single options are single lines options that consists of a
+ keyword 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 detach 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 addition 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>Removed from implementation: <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>Removed from implementation: <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>Removed from implementation: <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>Removed from implementation: <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 interfaces 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 neighbor. Defaults to
+ <emphasis>1</emphasis>, and any other setting will severely
+ reduce the optimization introduced by the MPR scheme!</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>Removed from implementation: <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 calculating 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 compatibility</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>Removed from implementation: <option>LinkQualityWinsize
+ [number]</option></term>
+
+ <listitem>
+ <para>Window size for the Link Quality extensions.</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 >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 (e.g.
+ 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
+ this kind of connections.</para>
+
+ <para><option>MaxConnections [0-5]</option>: This option
+ specifies how many connections that can exist simultaneously.
+ Multiple connections have not been tested, and does not work!
+ This option should only be used to control whether 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 connect from another host
+ you should add it here. This option can be repeated to add
+ multiple hosts.</para>
+
+ <para><option>Net [IPv4 netaddress] [IPv4 netmask]</option>:
+ Here you can specify an entire net range of IP addresses which
+ olsrd will allow TCP connections 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 connectivity
+ to external networks using HNA messages. This option block is
+ used to set the IPv4 networks 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 connectivity
+ to external networks using HNA messages. This option block is
+ used to set the IPv6 networks 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 connectivity 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 option block specifies one or more network interfaces
+ on which olsrd should run. At least one network interface block
+ must be specified for olsrd to run! Various parameters can be
+ specified on individual interfaces or groups of interfaces. This
+ option block can be repeated to add multiple interface
+ configurations.</para>
+
+ <para><option>AutoDetectChanges [yes|no]</option>: Olsrd can
+ auto detect 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 outgoing OLSR traffic on the interface. In reality 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
+ destination 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 destination 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 interface.</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 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
+ interface.</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 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
+ interface.</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 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
+ interface.</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 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-title" linkend="olsrd_8" /></member>
+ </simplelist>
+ </refsect1>
+ </refentry>
+
+ <refentry id="olsr_switch_8">
+ <indexterm>
+ <primary><command>olsr_switch</command></primary>
+ </indexterm>
+
+ <refentryinfo>
+ <titleabbrev>Olsrd Network Simulator</titleabbrev>
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle id="olsr_switch_8-title">olsr_switch</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>
+
+ <simplelist type="inline">
+ <member><xref endterm="olsrd_8-title" linkend="olsrd_8" /></member>
+
+ <member><xref endterm="olsrd_conf_5-title"
+ linkend="olsrd_conf_5" /></member>
+ </simplelist>
+ </refsect1>
+ </refentry>
+ </appendix>
</article>
Repositories / olsrd.git / commitdiff