x86_64 patch from Bernd
[olsrd.git] / lib / powerinfo / README_POWER
1 POWER STATUS PLUGIN FOR OLSRD
2 by Andreas T√łnnesen(andreto@olsr.org)
3
4 ABOUT
5
6 The olsrd power status plugin is ment to be a easy
7 to understand example of how one can write custom
8 plugins for the UniK olsr daemon.
9
10 It gathers powerifno from the local node by polling
11 the /proc/apm pseudofile. So to diffuse powerinfo
12 about a node it needs to have APM enabled.
13 All powerinfo is gathered in a database and you
14 can wiev the output by telneting to 127.0.0.1
15 port 8888 on the local machine.
16
17 Feel free to use this as a framework for new 
18 plugins! That's what it is intended to be used for.
19
20 PORTABILITY
21
22 The plugin compiles for GNU/Linux, FreeBSD and
23 win32, but the APM interface only works on APM/ACPI 
24 enabled GNU/Linux systems. But since this plugin
25 is ment to be a startingpoint for new plugins, it
26 has been "ported" to the other OSes.
27
28 WHAT IS IT?
29
30 This code compiles as a dynamic loadable library -
31 known as so files in Linux and DLL in windows.
32 The code is loaded by olsrd at runtime and the
33 plugin can use certain functionality offered
34 by olsrd.
35 It is very usefull when adding custom packettypes
36 but it could be used for a variety of purposes.
37
38
39 Read the HOWTO at www.olsr.org for more info
40
41 - Andreas T