aac7c5d6f3160e4acab384f4701bc7811844d5d6
[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 allow communication.
6 It is used to set the values of the Hello and the TC timers/multiplier in olsrd.
7 It can be also used to get the current values from the daemon.
8
9 Please first read what's written in the file lib/info/README_INFO.
10
11
12 ==================
13 SUPPORTED COMMANDS
14 ==================
15 The commands can be specified with or without a float number after the =.
16 In the former case the timer or the multiplier will be set at that specific value.
17 In the latter case the plugin will return the actual value for that timer or multiplier.
18
19 * /helloTimer=%f
20 * /TCTimer=%f
21 * /helloTimerMult=%f
22 * /TCTimerMult=%f
23 * /helloTimer
24 * /TCTimer
25 * /helloTimerMult
26 * /TCTimerMult
27
28 ====================
29 PLUGIN CONFIGURATION
30 ====================
31
32 The plugin is configured with the generic info plugin configuration parameters.
33
34 The port in the generic info plugin configuration is set to 2008.
35
36 LoadPlugin "olsrd_poprouting.so.1.0"
37 {
38   # <generic info plugin configuration>
39 }