################################################################################
#                                                                              #
#  Fred - Zeiterfassungstool                                                   #
#  SoPra Gruppe 5                                                              #
#  Wolfgang Bischoff, Sebastian Krysmanski, Christoph Müller                   #
#  2006-2008 - Universität Stuttgart                                           #
#                                                                              #
#  Webseite von Fred:                                                          #
#  http://fred.mayastudios.com                                                 #
#                                                                              #
#  Projektseite der Abteilung "Software Engineering"                           #
#  an der Universität Stuttgart:                                               #
#  http://www.iste.uni-stuttgart.de/se/research/projects/Fred/index.html       #
#                                                                              #
################################################################################

Diese Datei enthält Hinweise zur Verwendung von Fred.


Benötigte Java-Version
----------------------
Um Fred ausführen zu können, muss mindestens die Java-Runtime-Version 1.5.0_00
installiert sein. Es wird jedoch die neuste Java-Version empfohlen. Das schließt
Java 6 ein. Die Version 1.4.2 oder niedriger wird nicht unterstützt und kann 
nicht dazu verwendet werden, um Fred auszuführen.

Die Java-Version kann auf der Kommandozeile mit dem Befehl "java -version"
ermittelt werden.

Die aktuellste Java Version erhalten Sie für Windows, Linux und Solaris unter:

  http://www.java.com


Unterstütze Betriebssysteme
---------------------------
Derzeit werden folgende Betriebssysteme unterstützt:

* Windows XP (32-Bit)
* Linux (32-Bit und 64-Bit)
* MacOSX

Fred kann möglicherweise auch unter folgenden Betriebssystemen verwendet werden, 
jedoch ist das (noch) nicht durch ein Test bestätigt wurden:

* Windows 98 (2.Edition)
* Windows ME
* Windows 2000 Professional (SP3+)
* Windows 2003 Server
* Windows x64
* Solaris (32-Bit und 64-Bit)


Unter Windows 95 (oder früher) und Windows NT4 (oder früher) läuft Fred hingegen
nicht, da auf diesen Betriebssystemen die Java-Runtime 1.5 nicht lauffähig ist.
(siehe: http://java.com/de/download/help/5000011000.xml)


Starten von Fred
----------------
Um Fred zu starten, verwendet man:

* unter Windows: fred.exe
* unter Linux/Solaris: fred.sh
* unter MacOSX: das MacOSX-Paket von Fred
* unter anderen Betriebssystemen: den Befehl aus der Datei "fred-command"

Sollte Fred wider Erwarten nicht starten, dann kann man versuchen, Fred mit
dem Befehl aus der Datei "fred-command" zu starten. (Sollten Sie mit diesem
Problem konfrontiert sein, dann melden Sie das bitten in unserem Bug Tracking 
System. Mehr Informationen darüben finden Sie am Ende dieser Datei.)


Lizenz
------
Fred wird unter der GNU General Public License vertrieben, d.h. es 
Freeware/Open-Source und kann somit kostenlos sowohl privat als auch im 
kommerziellen Bereich eingesetzt werden. Die genaueren Lizenzbestimmungen finden
sich in der Datei "license.txt" oder unter:

  http://www.gnu.org/licenses/gpl.txt


Kommandozeilen-Parameter
------------------------
Für Fred existieren die folgenden Kommandozeilen-Parameter. Diese müssen an die 
Java-VM übergeben werden (d.h. nicht direkt an Fred selbst; am besten vor dem 
Parameter "-cp"):

* "-DUseShout=1" : Mit diesem Parameter kann man diverse Debug-Text-Nachrichten
       auf die Konsole ausgeben lassen. (Unter Windows sollte man dann Fred 
       mit "java.exe" statt mit "java.exe" starten.)
                   
* "-DUseDoubleInstanceCheck=0" : Mit diesem Parameter kann man die Prüfung, ob
       Fred bereits läuft, deaktiveren.
                                 
* "-DUserMode=[Single|Multi]" : Mit diesem Parameter kann man festlegen, in
       welchem Modus (Single-User-/Multi-User-Modus) Fred ausgeführt werden 
       soll. Siehe Abschnitt "User-Modus" für mehr Informationen.


User-Modus
----------
Fred bietet eine Unterstützung für einen Multi-User-Modus. Dabei geht es 
hauptsächlich darum, wo Fred Einstellungen speichert, die den Benutzer an sich 
betreffen (z.B. wo sich das Handbuch befindet oder welche Arbeitsdatei als 
letztes geöffnet war). Im Single-User-Modus werden diese Informationen in einer 
Datei im Programmverzeichnis von Fred gespeichert. Im Multi-User-Modus wird 
diese Datei stattdessen irgendwo (abhängig vom verwendeten Betriebssystem) im 
Homeverzeichnis des Benutzers gespeichert.

Welcher Modus verwendet wird, ist in der Datei 

  "<Programmverzeichnis>/config/UserMode.xml"

gespeichert. Die beiden gültigen Werte für "value" sind "Single" und "Multi"
(für den jeweils entsprechenden Modus). Außerdem kann dieser Wert beim Starten
mit Hilfe des Parameters "-DUserMode" festgelegt werden. In diesem Fall wird
die Datei "UserMode.xml" ignoriert.

Falls die Datei "UserMode.xml" noch nicht existiert, wird sie beim Sarten von 
Fred angelegt. Dabei wird automatisch der Multi-User-Modus verwendet, falls 
dieser auf dem verwendeten Betriebssystem von Fred unterstützt wird. Ansonsten
wird der Single-User-Modus verwendet.

Der Multi-User-Modus wird von Fred unter den folgenden Betriebssystemen 
unterstützt:

 * Windows 2000, XP und Vista
 * Linux
 * Solaris
 * MacOSX


Bekannte Probleme
-----------------
* Fred kann unter Linux und Java 1.5 nicht mit den Window-Managern "Compiz" bzw.
  "Beryl" verwendet werden. Bei diesen Window-Managern startet Fred zwar, aber 
  das Hauptfenster von Fred bleibt leer. Der Grund für dieses Problem ein Fehler
  in Java (siehe: Java-Bug 6429775).
  Um das Problem zu beheben, muss Java 6 installiert werden.
  
* Die Spaltenköpfe in Tabellen unter Windows Vista sind zu hoch. Das Problem 
  wurde in Java6u4 behoben. Sobald mindestens diese Java-Version installiert 
  ist, ist das Problem verschwunden. (siehe Java-Bug 6434444)


Quellcode
---------
Der Quellcode von Fred steht über Subversion (http://subversion.tigris.org) zum
Download zur Verfügung. Die URL zum Subversion-Repository lautet:

  https://svn.mayastudios.de/sopra/repos/sources/fred
  
Im Unterordner "trunk" befindet sich die aktuellste Entwickler-Version. Alle 
Release-Versionen befinden sich im Unterordner "tags" (siehe auch die Datei 
"changelog.txt").

Des Weiteren sind die Quellcodes für die intern verwendete Bibliotheken 
vorhanden. Diese stehen einerseits in speziellen Jar-Dateien (deren Dateinamen 
auf "-src.jar" enden) zu Verfügung und sind andererseits über Subversion 
beziehbar. Diese Quellcodes werden zum Kompilieren von Fred nicht benötigt, 
helfen aber evtl. beim Verständnis von Freds eigenem Quellcode:

  Replication:  https://svn.mayastudios.de/sopra/repos/sources/server
  JavaTray:     https://svn.mayastudios.de/maya/repos/javatray
  MSCL4j:       https://svn.mayastudios.de/maya/repos/mscl4j
  IXML+Labels:  https://svn.mayastudios.de/maya/repos/ixml
 
Um Fred zu bauen, muss der Quellcode einfach ausgecheckt und dann mit dem
Ant-Build-Skript (build.xml) gebaut werden. (Erst ab Version 1.3.1b)


Fehler-Berichte (Bug Reports) und Verbesserungsvorschläge (Feature Requests)
----------------------------------------------------------------------------
Alle in Fred bekannten Bugs und Verbesserungsvorschläge können in der 
Fehler-Datenbank von Fred eingesehen werden. Diese befindet sich unter:

  http://fred.mayastudios.com/bugtracking/
  
Dort können Sie auch einen neuen Fehler-Report erstellen, falls Sie auf einen
Fehler in Fred gestoßen sind. Außerdem können Sie Verbesserungsvorschläge oder 
Vorschläge für neue Funktion einreichen.
