BongoSurfer   ***   README   ***   Hinweis: file encoding: utf-8   ***
######################################################################


Inhaltsverzeichnis:
-------------------

 1) Programmbeschreibung
 2) Lizenzinformationen
 3) Disclaimer / Benutzungsbedingungen
 4) Systemvorrausetzungen
 5) Installation / Deinstallation
 6) Programmstart
 7) Quellcode / wichtige Funktions-Prinzipien
 8) Librarys / Beans
 9) Webseite / Kontakt


1) Beschreibung des Programms
   --------------------------

BongoSurfer ist ein graphischer Internet Least-Cost-Router (LCR). Ein
LCR ist ein Programm zum erstellen einer Verbindung ins Internet mit
einem möglichst günstigen Tarif. Abhängig von der Uhrzeit und des
Wochentages berechnet es aufgrund einer Tarifdatenbank welche Tarife
gerade am günstigsten sind und ermöglicht eine Einwahl mit einem
beliebigen dieser Tarife.

BongoSurfer bezieht nach einer Einwahl automatisch eine aktualisierte
Tarifliste, sofern eine verfügbar ist. Die Tarifliste wird mehrmals
täglich aus den Daten des Internet-Dienstleisters
http://www.telespiegel.de erstellt.
BongoSurfer kann weit mehr als nur eine Einwahl ins Internet. Im
folgenden werden die Haupt-Features aufgelistet:

- Verbindung erstellen und trennen
- Unterstützung für analoge Modems und ISDN (wahlweise CAPI oder Hisax)
- ISDN: Kanalbündelung erstellen und trennen
- Kostenberechnung: alle anfallenden Kosten werden gespeichert und
  können übersichtlich dargestellt werden.
- Traffic-Monitor: graphische Anzeige des Datenverkehrs
- Warnung bei Aenderung des Preises fuer eine aktive Verbindung
- Sortieren der Tarife nach dem Preis fuer eine definierbare Surfzeit.
  Hier werden Aenderungen des Preises waehrend der Surfzeit
  beruecksichtigt, sowie eventuell anfallende Einwahlgebuehren.
- Ein- und Ausblenden von Tarifen mit Einwahlgebuehr und/oder
  60-Sekundentakt
- automatische Synchronisierung der Uhrzeit mit einem Time-Server
- automatisch einen Befehl nach Aufbau der Verbindung ausfuehren
  lassen.
- Tarifauswahl-Dialog: hier können Tarife aus der Liste verbannt
  werden
- Online-Timer: automatisches erstellen einer Verbindung zu einer
  bestimmten Uhrzeit
- Feiertagseditor: bestimmen sie selbst, wann Feiertag ist ;)
- Log-Fenster: gibt Aufschluss über die Hintergrundprozesse und hilft
  bei Problemen
- jede Menge Konfigurationsmöglichkeiten



2) Lizenzinformationen (GNU-GPL)
   -----------------------------

Copyright 2004-2007 Pascal Pollet

BongoSurfer is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 2 of the License, or (at your
option) any later version.

This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 
USA


3) Disclaimer
   ----------

Benutzungsbedingungen:
----------------------

Die Autoren übernehmen keinerlei Verantwortung für eventuelle Schäden,
die durch die Benutzung dieses Programms verursacht werden können.
Insbesondere Schäden, die durch falsche oder veraltete Tarifdaten 
entstehen können, unterliegen allein der Verantwortung des Benutzers.

BongoSurfer verwendet eigene Tarifdaten oder Tarifdaten von Fremdanbietern,
deren Aktualität nicht gewährleistet werden kann. Auch für Fehler beim
Parsen von Webseiten zum Erstellen von Tariflisten und allen möglichen
Konsequenzen kann der Autor keine Verantwortung übernehmen.

Sie sind nicht gezwungen, die interne Tarifliste von BongoSurfer zu benutzen.
Sie können BongoSurfer auch ausschließlich und unabhängig mit einer eigenen
Tarifliste betreiben.

Sie müssen BongoSurfer nicht als Least-Cost-Router betreiben; das Programm
kann auch als normale Einwahlhilfe für Ihre eigenen Tarife benutzt werden.

Das Programm bietet eine Funktion für die Berechnung der angefallenen
Kosten für die Internetverbindung. Alle von dieser Funktion ausgegebenen
Daten sind ohne Gewähr, und müssen nicht mit der Telefonrechnung des
Benutzers übereinstimmen.

Es gibt keine Garantie; auch nicht für VERKAUFBARKEIT oder FÜR SPEZIELLE ZWECKE.


4) Systemvorraussetzungen
   ----------------------

Dies sind die Programme, die BongoSurfer benoetigt:

1. Ein Linux-Betriebssystem mit einem konfigurierten Modem oder ISDN
2. Java(TM) 2 Runtime Environment (build 1.5.0 oder hoeher)

die Java Standard Edition gibts unter http://www.java.com/ zum
Download.

BongoSurfer bietet die Moeglichkeit, ueber ein Button das Programm
"Teleview" zu oeffnen. Teleview ist ein Programm, dass die aktuell
guenstigsten Vorwahlnummern fuer Telefongespraeche anzeigt. Es kann
unter 

http://wwww.a-zkaufhaus.de 

heruntergeladen werden.


5) Installation / Deinstallation: (x = Ziffern der Versionsnummer)
   ------------------------------

ERSTINSTALLATION:
#################

Wichtig!!! Führen Sie nach der Installation als root den Befehl
"bongosetup" aus!

tar.gz-Archiv:
--------------
1) Archiv entpacken:
     tar -xzf bongoSurfer-2.x.x-x.tar.gz
2) in das entpackte Verzeichnis wechseln:
     cd bongoSurfer-2.x.x-x
3) Installationsskript starten:
     ./install.sh

RPM-Archiv:
-----------
als root in das Verzeichnis wechseln, in dem sich das RPM-Archiv
befindet.
Folgendes eingeben:
   rpm -i bongosurfer-2.x.x-x.i386.rpm

Debian-Paket:
-------------
als root in das Verzeichnis wechseln, in dem sich das Debian-Paket
befindet
Folgendes eingeben:
   dpkg -i bongosurfer-2.x.x-x.deb

UPDATE:
#######

von Versionen aelter als 1.5.3-1:
--------------------------------

1) laden Sie das Archiv uninstall.tar.gz herunter
2) entpacken des Archivs:
    tar -xzf uninstall.tar.gz
3) starten des Deinstallationsskripts:
    ./uninstall.sh
4) Installieren Sie die neue Version nach der Anleitung fuer die
Erstinstallation.

von Versionen ab 1.5.3-1:
-------------------------

tar.gz-Archiv:
--------------
cd /usr/share/bongosurfer
./uninstall.sh
anschliessend nach Anleitung die neue Version installieren.

RPM:
----
rpm -U bongosurfer-2.x.x.i386.rpm

Debian-Paket:
-------------
dpkg -i bongosurfer-2.x.x.deb	
	

DEINSTALLATION:
###############

tar.gz-Archiv:
--------------
1) ein Terminal oeffnen
2) in das Verzeichnis /usr/share/bongosurfer/ wechseln
    cd /usr/share/bongosurfer
3) Den Deinstallationsskript starten:
    ./uninstall.sh

RPM-Archiv:
-----------
oeffnen Sie ein Terminal, loggen Sie sich als root ein, und
deinstallieren Sie BongoSurfer mit:
    rpm -e bongosurfer-2.x.x-x
	
Debian-Paket:
-----------
oeffnen Sie ein Terminal, loggen Sie sich als root ein, und
deinstallieren Sie BongoSurfer mit:
    dpkg -P bongosurfer


6) Programmstart: bongo
   --------------
	
7) Quellcode / wichtige Funktions-Prinzipien:
   ------------------------------------------

Die Quellcodes werden in einem Subversion Repository bei Sourceforge
verwaltet. Alle Informationen zur Verwendung von Subversion koennen
auf der Projektseite von BongoSurfer bei www.sourceforge.net gefunden
werden.

Die Einwahl und das hoch- bzw. runterfahren der Schnittstelle erfolgen
mithilfe der Befehle "isdnctrl", "ifup" und "ifdown" (bei ISDN-I4L
Einwahl), pppd (bei ISDN-CAPI Einwahl) bzw. pppd u. chat (bei Modem).
Die I4L-Befehle benoetigen fuer eine uneingeschraenkte Verwendung
Root-Rechte. Dies wird mit Hilfe des Kommandos "sudo" umgangen,
welches es ermoeglicht, freigegebene Programme vom User mit
Root-Rechten auszufuehren. Um die oben genannten Programme fuer sudo
freizugeben, wird die Datei /etc/sudoers vom Installationsskript
bearbeitet. Zuvor wird ein backup der Datei unter /etc/sudoers.bs.old
erstellt.
Fuer die ISDN-CAPI-Einwahl und die Modemeinwahl wird dem Benutzer die
Wahl gelassen, ob sudo verwendet werden soll, oder auf pppd ein
SUID-Bit gesetzt werden soll. sudo wird empfohlen, letztere Methode
sollte nur verwendet werden, wenn die sudo-Alternative nicht
funktioniert.
Zur Wahl der Methode und zum authorisieren von Usern (sudo-Methode)
muss als root das Programm "bongosetup" ausgefuehrt werden.


8) Librarys / Beans:
   -----------------

Alle verwendeten Librarys werden mit der Java Standard Edition
mitgeliefert, ausser diese zwei (von jgoodies.com):

forms-1.2.1.jar
looks-2.3.1.jar

Diese zwei JARs sind in dem Downloadarchiv des BongoSurfers mitenthalten.


The BSD License for the JGoodies Looks
======================================

Copyright (c) 2001-2006 JGoodies Karsten Lentzsch. All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

 o Redistributions of source code must retain the above copyright notice,
   this list of conditions and the following disclaimer.

 o Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

 o Neither the name of JGoodies Karsten Lentzsch nor the names of
   its contributors may be used to endorse or promote products derived
   from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


The BSD License for the JGoodies Forms
======================================

Copyright (c) 2002-2006 JGoodies Karsten Lentzsch. All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

 o Redistributions of source code must retain the above copyright notice,
   this list of conditions and the following disclaimer.

 o Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

 o Neither the name of JGoodies Karsten Lentzsch nor the names of
   its contributors may be used to endorse or promote products derived
   from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.



9) Webseite / Kontakt

Homepage: http://www.bongosoft.de

email: pascal@bongosoft.de

Adresse:
Pascal Pollet
Jägerhäusleweg 47
Freiburg, Germany

Viel Spass beim BongoSurfen !!!
