*    PEERHOOD   *

Copyright 2003,2004,2008,2009,2010 Lappeenranta University of Technology.

This program is distributed under the terms of the GNU Lesser General Public
License.


Running PeerHood
==============================================================================

Current version of PeerHood requires that the daemon is ran as root. The user 
configuration file (.phconfig found at /usr/share/libpeerhood) has to be
copied to $HOME directory of the user that will be running the daemon (root!)
or programs that use PeerHood daemon.

Additionally an environment variable can be set (for root running the
daemon and user whose applications are using PeerHood) to point PeerHood
library. If this variable is not specified plugins are searched from
/usr/lib/peerhood . The variable is:
  - PH_PLUGIN_DIR        Path for PeerHood plugins 

To start the PeerHood daemon (as root): ./peerhoodd

By default no parameters are used, if in some case the daemon is required to 
start as "passive" mode when no networking plugins will be started if there is
no client connected, run the daemon as root: ./peerhood passive

To run PeerHood as background daemon run as root:
Passive : ./peerhood passive daemon
Active  : ./peerhood active daemon


Configuring PeerHood
==============================================================================

The .phconfig file contains following variables (as key-value pairs separated
with colon):

  KEY NAME                 DEFAULT VALUE      MEANING
  ============================================================================
  PreferedPlugin           bt-base            What plugin PeerHood prefers.
                                              bt-base = Bluetooth plugin
                                              wlan-base = WLAN plugin
                                              gprs-base = GPRS plugin
  
  gateway                  10.0.20.215        Gateway address for GRPS plugin.
  
  WLANInterface            wlan0              Interface of the WLAN adapter.
                                              Note that reqular ethernet 
                                              adapters work too (e.g. eth0).
  
  BTMonitoringInterval     10                 Monitoring interval of Bluetooth
                                              in seconds.
  
  BTDaemonPort             24                 Bluetooth listening port for 
                                              Daemon only.
  
  BTServiceCheckInterval   3                  Service check interval of 
                                              Bluetooth in times seen. E.g.
                                              if interval is 3 services are
                                              checked when device has been
                                              seen 3 times in row.
  
  WLANMonitoringInterval   5                  Monitoring interval of WLAN in 
                                              seconds
	
  WLANServiceCheckInterval 10                 Service check interval of WLAN
                                              in times seen. See explanation
                                              of BTServiceCheckInterval.
	
  GPRSMonitoringInterval   10                 Monitoring interval of GPRS in
                                              seconds
	
  GPRSServiceCheckInterval 3                  Service check interval of GPRS
                                              in times seen. See explanation
                                              of BTServiceCheckInterval.
	
  MonitoringInterval       20                 Monitoring interval of a device
                                              when put to active monitoring.
                                              Currently not used.
	
  DeviceName               devicename         The name of the device. This is
                                              the name that is visible to
                                              other devices using PeerHood.
                                              Note that users cannot change
                                              this, the name set by root in
                                              .phconfig is used!
	
  Roaming                  no                 Is roaming option enabled.
                                              yes = enabled
                                              no = disabled
		
  DeviceInfo               1                  Can PeerHood share device info.
                                              1 = yes
                                              0 = no
	
  ServiceInfo              1                  Can PeerHood share service info.
                                              1 = yes
                                              0 = no
	
  ProtoInfo                1                  Can PeerHood share proto info.
                                              1 = yes
                                              0 = no
	
  NeighInfo                0                  Can PeerHood share neighborhood
                                              info.
                                              1 = yes
                                              0 = no


