summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2009-02-08 00:40:59 +0000
committerPaul Buetow <paul@buetow.org>2009-02-08 00:40:59 +0000
commit6353a49ca8db2ef5a6b33097b438f6323833bed1 (patch)
tree6e3f55541123cea4d8a5ba11d05b1fe2626f3602
parent6d1e588e91f8e3e3a49e9256504e221e1ca49c10 (diff)
-rw-r--r--README.de.txt53
-rw-r--r--README.en.txt55
-rw-r--r--README.txt106
-rw-r--r--SSL/README.txt (renamed from SSL/README.en.txt)0
-rw-r--r--todo.txt16
5 files changed, 106 insertions, 124 deletions
diff --git a/README.de.txt b/README.de.txt
deleted file mode 100644
index 9b006e5..0000000
--- a/README.de.txt
+++ /dev/null
@@ -1,53 +0,0 @@
-Copyright: (c) 2006, 2009 Dipl.-Inform. (FH) Paul C. Buetow
-WWW: http://netcalendar.buetow.org
-Mail: netcalendar@dev.buetow.org
-
-Starten des NetCalendars im stand alone betrieb:
-
-Der Befehl
-
-java -jar NetCalendar.jar --client-and-server
-
-started den Client und den Server-Teil vom NetCalendar im selben Prozess als 2 verschiedene
-threads. Die Option "server_address" wird automatisch auf "localhost" gesetzt. Die
-Kommuniklation laeuft jedoch via TCP/IP ab.
-
-Starten des NetCalendars ueber das Netzwerk:
-
-1. Server- und Client-PC sollten, wenn moeglich, die selbe JRE Version installiert aben.
-2. Den gesamten NetCalendar Ordner sowohl auf den Client-, als auch auf den Server-PC kopieren.
-3. Den Server mit dem Befehl "java -jar NetCalendar --server-only" starten.
-4. Den Client mit dem Befehl "java -jar NetCalendar --client-only --server-address=host"
- starten, wobei host hier die IP oder der Hostname vom Server ist.
-
-Um den Server wieder zu beenden, im Client unter "Server -> Shutdown server" den Prozess beenden.
-
-Wird der NetCalendar ohne Optionen aufgerufen, so werden die Standardeinstellungen, die in der
-config.txt stehen, verwendet.
-
-Der Befehl "java -jar NetCalendar --help" zeigt ein paar weitere Informationen an.
-
-In der config.txt können ebenso einige Einstellungen vorgenommen werden. Jedoch empfiehlt es sich
-dies über das GUI unter "Session -> Preferences" zu tun.
-
-Infos zu den Farbdarstellungen:
-
-Blau in der "Date" Spalte: Jaehrliches Event
-Gruen in der "Date" Spalte: Einmaliges Event
-
-Rot: Event findet innerhlab der nächste 24h statt.
-Orange: Event findet innerhalb der nächsten Woche statt.
-Gelb: Event findet innerhalb der nächsten 28 Tage statt.
-Dunkelbeige: Event findet innerhalb der nächsten 168 Tage (~ 1/2 Jahr) statt.
-Hellbesch: Event findet innerhalb der nächsten 365 Tage statt.
-Grau: Event findet nicht in den nächsten 365 Tagen statt.
-
-Funktionen die in der Zukunft evtl. eingebaut werden sollen stehen in der "todo.txt" Datei.
-
-Falls das 'calendar' UNIX-Tool verwendet wird, dann kann ~/.calendar auch als
-NetCalendar Datenbankverzeichnis konfiguriert werden :)
-
-
-
-
-
diff --git a/README.en.txt b/README.en.txt
deleted file mode 100644
index cde04f3..0000000
--- a/README.en.txt
+++ /dev/null
@@ -1,55 +0,0 @@
-Copyright: (c) 2009 Dipl.-Inform. (FH) Paul C. Buetow
-WWW: http://netcalendar.buetow.org
-Mail: netcalendar@dev.buetow.org
-
-Quick howto for the NetCalendar
-
-How to start the NetCalendar stand alone:
-
-The command
-
- "java -jar NetCalendar.jar --client-and-server"
-
-is starting the client and the server of the NetCalendar within the same
-process as two different threads. The option "server_address" will be set
-automatically to "localhost". The communication between both threads is done
-per TCP/IP.
-
-How to start the NetCalendar distributed:
-
-1. Server and client should use, if possible, the same version of the JRE.
-2. You should copy the complete NetCalendar suite to the client and the server
-computer.
-3. Start the server with "java -jar NetCalendar --server-only"
-4. Start the server with "java -jar NetCalendar --client-only \
- --server-address=HOSTORIPOFTHESERVER"
-
-In order to stop the server, select "Server -> Shutdown server" in the GUI of
-the client.
-
-All options will be set to their default values while starting the NetCalendar
-without any explicit options given.
-
-If you want to see more available parameters, then run the command
-"java -jar NetCalendar --help"
-
-It is possible to configure the NetCalendar by editing the configuration file
-which is "config.txt". However, the preferred way is using the client GUI via
-"Session -> Preferences".
-
-Informations concerning the colors being used within the NetCalendar client:
-
-Blue in the "Date" column: Yearly event
-Green in the "Date" column: The event will take place only once
-
-Red: Event takes place within the next 24h
-Orange: Event takes place within the next week
-Yellow: Event takes place within the next 28 days
-Dark: Event takes place within the next 168 days (~ 1/2 year)
-Light beige: Event takes place within the next 365 days (1 year)
-Grey: Event takes place after 365 days
-
-If you are using the 'calendar' tool on UNIX, you can use ~/.calendar as your
-NetCalendar database dir :)
-
-
diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..5527032
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,106 @@
+Copyright: (c) 2009 Dipl.-Inform. (FH) Paul C. Buetow
+WWW: http://netcalendar.buetow.org
+Mail: netcalendar@dev.buetow.org
+
+Quick howto for the NetCalendar
+
+I. HOW TO START THE NETCALENDAR STAND ALONE (WITHOUT SSL):
+II. HOW TO START THE NETCALENDAR DISTRIBUTED (WITHOUT SSL):
+III. HOW TO START THE NETCALENDAR DISTRIBUTED (WITH SSL):
+IV. MORE OPTIONS
+V. INFORMATIONS CONCERNING THE COLORS BEING USED WITHIN THE NETCALENDAR CLIENT:
+VI. USING THE UNIX CALENDAR DATABASE
+
+
+I. HOW TO START THE NETCALENDAR STAND ALONE (WITHOUT SSL):
+
+The command
+
+ java -jar NetCalendar.jar --client-and-server
+
+is starting the client and the server of the NetCalendar within the same
+process as two different threads. The option "server_address" will be set
+automatically to "localhost". The communication between both threads is done
+per TCP/IP.
+
+
+II. HOW TO START THE NETCALENDAR DISTRIBUTED (WITHOUT SSL):
+
+1. Server and client should use, if possible, the same version of the JRE.
+
+2. You should copy the complete NetCalendar suite to the client and the server
+computer.
+
+3. Start the server with
+
+ java -jar NetCalendar --server-only
+
+4. Start the server with
+
+ java -jar NetCalendar --client-only \
+ --server-address=HOSTORIPOFTHESERVER"
+
+In order to stop the server, select "Server -> Shutdown server" in the GUI of
+the client.
+
+
+III. HOW TO START THE NETCALENDAR DISTRIBUTED (WITH SSL):
+
+1. Server and client should use, if possible, the same version of the JRE.
+
+2. You should copy the complete NetCalendar suite to the client and the server
+computer.
+
+3. You should create clientKeys,clientTrust,serverKeys and serverTrust as
+discribed in http://www.ibm.com/developerworks/java/library/j-customssl/ and
+save them for example into ./SSL.
+
+3. Start the server with (replacing $(PASSWORD) by your passwords)
+ java \
+ -Djavax.net.ssl.keyStore=./SSL/serverKeys \
+ -Djavax.net.ssl.keyStorePassword=$(PASSWORD) \
+ -Djavax.net.ssl.trustStore=./SSL/serverTrust \
+ -Djavax.net.ssl.trustStorePassword=$(PASSWORD) \
+ -jar NetCalendar.jar --server-only
+
+4. Start the server with
+ java \
+ -Djavax.net.ssl.keyStore=./SSL/clientKeys \
+ -Djavax.net.ssl.keyStorePassword=$(PASSWORD) \
+ -Djavax.net.ssl.trustStore=./SSL/clientTrust \
+ -Djavax.net.ssl.trustStorePassword=$(PASSWORD) \
+ -jar NetCalendar.jar --client-only --server-address=SERVERHOST
+
+
+IV. MORE OPTIONS
+
+All options will be set to their default values while starting the NetCalendar
+without any explicit options given.
+
+If you want to see more available parameters, then run the command
+
+ java -jar NetCalendar --help
+
+It is possible to configure the NetCalendar by editing the configuration file
+which is "config.txt". However, the preferred way is using the client GUI via
+"Session -> Preferences".
+
+
+V. INFORMATIONS CONCERNING THE COLORS BEING USED WITHIN THE NETCALENDAR CLIENT:
+
+Blue in the "Date" column: Yearly event
+Green in the "Date" column: The event will take place only once
+
+Red: Event takes place within the next 24h
+Orange: Event takes place within the next week
+Yellow: Event takes place within the next 28 days
+Dark: Event takes place within the next 168 days (~ 1/2 year)
+Light beige: Event takes place within the next 365 days (1 year)
+Grey: Event takes place after 365 days
+
+
+VI. USING THE UNIX CALENDAR DATABASE
+
+If you are using the 'calendar' tool on UNIX, you can use ~/.calendar as your
+NetCalendar database dir :)
+
diff --git a/SSL/README.en.txt b/SSL/README.txt
index e91baa6..e91baa6 100644
--- a/SSL/README.en.txt
+++ b/SSL/README.txt
diff --git a/todo.txt b/todo.txt
deleted file mode 100644
index 32762b7..0000000
--- a/todo.txt
+++ /dev/null
@@ -1,16 +0,0 @@
-Might do's for the future:
-
-- Security
-+ SSL sockets (Partly done)
-
-- Client GUI
-+ Use dropdown menu for category selection
-+ Alarm function
-+ Table cellspacing => black
-
-- Preferences menu
-+ Use *** for the passphrase
-+ Add description strings
-
-
-