poprouting: tighten up README
[olsrd.git] / lib / poprouting / README_POPROUTING
1 ============
2 INTRODUCTION
3 ============
4
5 The poprouting plugin is not an info plugin, but it uses the info structure to
6 allow communication.
7
8 The poprouting plugin is used to set the values of the Hello and the TC
9 timers/multiplier in OLSRd. It can be also used to get the current values from
10 the daemon.
11
12 Please first read what's written in the file lib/info/README_INFO.
13
14
15 ==================
16 SUPPORTED COMMANDS
17 ==================
18 The commands can be specified with or without a float number after the =.
19 In the former case the timer or the multiplier will be set at that specific
20 value. In the latter case the plugin will return the actual value for that
21 timer or multiplier.
22
23 * /helloTimer=%f
24 * /TCTimer=%f
25 * /helloTimerMult=%f
26 * /TCTimerMult=%f
27 * /helloTimer
28 * /TCTimer
29 * /helloTimerMult
30 * /TCTimerMult
31
32 ====================
33 PLUGIN CONFIGURATION
34 ====================
35
36 The plugin is configured with the generic info plugin configuration parameters.
37
38 The port in the generic info plugin configuration is set to 2008.
39
40 LoadPlugin "olsrd_poprouting.so.1.0"
41 {
42   # <generic info plugin configuration>
43 }