Merge branch 'release-0.6.6'
[olsrd.git] / lib / pgraph / README_PGRAPH
1 README-OLSR
2 Modified: 05/17/2005
3
4 #========================================================================
5 #  These programs NEVER meet your needs.  In fact, they can cause
6 #  serious damages to your precious things, including, but not being
7 #  limited to, time, money, effort, computer files, information,
8 #  hardware, software, and other things that you value.
9 #
10 #  The author DOES NOT request or even suggest that you use any of these
11 #  programs. You understand clearly that you are taking a big risk
12 #  in using these programs and that you are completely (100%) liable
13 #  for using them.
14 #
15 #  You further understand that although you can use these programs
16 #  without paying the author or the employer of the author, you
17 #  do not own them.  You will give proper credits to the
18 #  author and his employer whenever you use them; i.e.,
19 #  you will never pretend that you are the author of these programs.
20 #  If you make any changes to them, you will send a copy
21 #  of each modified programs to the author.  You will also NEVER
22 #  sell or give any of them to anyone else without the approval of the
23 #  author or his employer.
24
25
26 Parser: OLSRConnect.py
27 Description: This parser has been written to interface with a plugin for
28              the version 4.9 OLSR from olsr.org.  The plugin can also be 
29              found in this directory.  
30
31 Parser for OLSR:        OLSRConnect.py
32 Plugin for OLSRv4.9:    olsr_v4.9-pgraph-plugin
33
34 Usage:
35         1) Copy the "olsr_v4.9-pgraph-plugin" directory from this distribution
36            to the "/<your OLSRv4.9 path>/lib/."
37
38         2) cd to the "/<your OLSRv4.9 path>/lib/." directory, 
39            run "make" and "make install"
40            This will create the "olsrd_pgraph.so.1.1" file and install it. 
41
42         3) Modify the "/etc/olsrd/olsrd.conf" file of the system you wish to
43            monitor from to load the plugin. 
44            Add the line: "LoadPlugin "olsrd_pgraph.so.1.1" {}"
45
46         4) The plugin actually allows any host to connect regardless of
47            what is specified in the olsrd.conf file.  This is currently 
48            done for testing purposes and due to the fact that the "Host" 
49            parameter in the olsrd.conf file never worked.  
50
51            # By default only localhost will be able to connect to the IPC
52            # system of the olsrd process so if you are not going to be 
53            # running pgraph locally, modify the "Host" variable of the 
54            # "IpcConnect" structure in the "/etc/olsrd/olsrd.conf" file to
55            # reflect the IP address of the host you will be connecting from. 
56
57         5) Start olsrd and make sure that the plugin has loaded correctly.
58
59         6) On the machine you will be running pgraph from, use the 
60            "OLSRConnect.py" parser to connect to the olsrd plugin and pipe
61            the output to pgraph. 
62
63 Usage: (note the use of the backquote "`") 
64 "python  OLSRConnect.py <ip of machine running plugin> 2004 | `python pgraph.py`"
65
66 - Where the "2004" above is the default port that the plugin will be listening on.
67
68 To kill pgraph when using the parser:
69 - Hit "Ctl-C" in the terminal.