Merge branch 'release-0.6.6'
[olsrd.git] / lib / txtinfo / README_TXTINFO
1
2    PLUGIN USAGE
3 ==================
4
5 installation:
6 make
7 make install
8
9 echo /all | nc 127.0.0.1 2006
10  or
11 telnet 127.0.0.1 2006 (and type /all then enter)
12  or
13 wget http://localhost:2006/all -qO -
14  or
15 curl http://localhost:2006/all
16
17 Or in a web browser: http://localhost:2006/all
18
19 The output shows the links of the node, its neighbors, the topology
20 table, HNA (Host and Network Association) and MID (Multiple Interface
21 Declaration) tables and the actual routing table.
22
23 So what commands does the txtinfo plugin accept?
24
25     * Config: "/config" -> send_what=SIW_CONFIG
26     * Gateways: "/gateway" -> send_what=SIW_GATEWAY
27     * HNA: "/hna" -> send_what=SIW_HNA
28     * Interfaces: "/interface" -> send_what=SIW_INTERFACE
29     * Links: "/link" -> send_what=SIW_LINK
30     * MID: "/mid" -> send_what=SIW_MID
31     * Neighbors: "/neigh" -> send_what=SIW_NEIGH
32     * Routes: "/route" -> send_what=SIW_ROUTE
33     * Topology: "/topo" -> send_what=SIW_TOPO
34     * 2-hop neighbors: "/2hop" -> send_what=SIW_2HOP
35     * Version: "/ver" -> send_what=version of olsrd
36     * (Smart) Gateway Information: "/sgw" -> send_what=information on all active (smart) gateways
37
38 This is the same as the "/neigh" and "/link" commands combined:
39
40     * "/neighbours" -> send_what = SIW_NEIGHLINK -> neighbours and links
41
42 Then there is "/all" which returns all of the most commonly used
43 commands above (but not every command above). "/all" is the same as
44 "/links/neigh/topo/hna/mid/routes".
45
46 http://www.olsr.org/?q=node/26
47
48
49    PLUGIN CONFIGURATION
50 ==========================
51
52 The plugin accepts two parameters: "port" and "accept". There are no
53 futher parameters.  Here's an example configuration for UNIX systems
54 (for Windows, change the plugin to end in .dll):
55
56 LoadPlugin "olsrd_txtinfo.so.0.1"
57 {
58     # the default port is 2006 but you can change it like this:
59     #PlParam     "port"   "8080"
60
61     # You can set a "accept" single address to allow to connect to
62     # txtinfo. If no address is specified, then localhost (127.0.0.1)
63     # is allowed by default.  txtinfo will only use the first "accept"
64     # parameter specified and will ignore the rest.
65
66     # to allow a specific host:
67     #PlParam      "accept" "172.29.44.23"
68     # if you set it to 0.0.0.0, it will accept all connections
69     #PlParam      "accept" "0.0.0.0"
70 }