plugin util: add set_plugin_long function
[olsrd.git] / lib / jsoninfo / README_JSONINFO
1 ============
2 INTRODUCTION
3 ============
4
5 The jsoninfo 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 * /neighbors
21 * /links
22 * /routes
23 * /hna
24 * /mid
25 * /topology
26 * /gateways
27 * /interfaces
28 * /2hop
29 * /sgw
30
31 A special case for Freifunk, combining /neighbors and /links:
32 * /neighbours
33
34 Start-up information:
35 * /version
36 * /config
37 * /plugins
38
39 The current configuration, formatted for writing directly to a configuration
40 file, like /etc/olsrd/olsrd.conf:
41 * /olsrd.conf
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 9090.
52
53 LoadPlugin "olsrd_jsoninfo.so.0.0"
54 {
55   # <generic info plugin configuration>
56
57   # The first line of the specified file will be read. If properly read, then
58   # this line will be included in the JSON reply as the value of the 'uuid'
59   # field.
60   # Default: <not set>
61   # PlParam "uuidfile" "uuid.txt"
62 }