Merge branch 'PolynomialDivision-feature/add_workflow'
[olsrd.git] / lib / txtinfo / README_TXTINFO
1 ============
2 INTRODUCTION
3 ============
4
5 The txtinfo plugin is an info plugin.
6
7 Please first read what's written in the file lib/info/README_INFO.
8
9
10 ==================
11 SUPPORTED COMMANDS
12 ==================
13
14 Grouped information:
15 * /all
16 * /runtime
17 * /startup
18
19 Runtime information:
20 * /nei
21 * /lin
22 * /rou
23 * /hna
24 * /mid
25 * /top
26 * /gat
27 * /int
28 * /2ho
29 * /sgw
30
31 A special case for Freifunk, combining /nei and /lin:
32 * /neighbours
33
34 Start-up information:
35 * /ver
36 * /config  (not supported, will output nothing)
37 * /plugins (not supported, will output nothing)
38
39 The current configuration, formatted for writing directly to a configuration
40 file, like /etc/olsrd/olsrd.conf:
41 * /con
42
43
44 ====================
45 PLUGIN CONFIGURATION
46 ====================
47
48 The plugin is configured with the generic info plugin configuration parameters
49 and with 1 extra parameter.
50
51 The port in the generic info plugin configuration is set to 2006.
52
53 LoadPlugin "olsrd_txtinfo.so.1.1"
54 {
55   # <generic info plugin configuration>
56   # The option "httpheaders" is overridden to "false" by default
57
58   # Set to true to include VTime values into Link/Topology commands
59   # Default: false
60   # PlParam "vtime" "false"
61 }