README zu maild 0.2

Ein kleiner Email Reminder
__________________________________________________
english documentation follows below



maild ist ein kleines Programm, welches unter X11 im Hintergrund luft und
wartet, ob neue Emails reinkommen. Wenn eine (oder mehrere) neue Emails da sind, 
dann gibt das Programm einen Beep Ton aus und zeigt ein kleines Fenster mit einem
Bild an(eins liegt dieser Package bei, man kann aber natrlich auch sein Eigenes hernehmen),
bzw. wenn es kein Bild findet, ein kleines rotes Xterm Fenster.


RELEASE NOTES:

In Version 0.2 luft maild jetzt als vollwertiger daemon, den man ber ein script starten 
und stoppen kann. Der daemon erstellt im Homedirectory des Users eine Datei namens .mail.PID,
in welcher die ProcessID gespeichert wird.
maild kann pro User nur einmal ausgefhrt werden. Kann aber auf der selben Maschine mehrmals 
gestartet werden, vorrausgesetzt, es handelt sich jedesmal um einen anderen User.
Gestoppt werden muss maild dann wieder vom User, der den daemon gestartet hat, bzw. von root.



__________________________________________________

INSTALLATION:

Das Archiv maild-0.2.tar.gz auspacken. 

Danach muss die Software kompiliert werden. Dazu kann das mitgelieferte
Script benutzt werden:

	./install

Um das Script ausfhren zu knnen sollte man der Superuser sein. Ansonsten muss das Script 
editiert werden, bzw. die Zugriffsrechte mssen entsprechend gendert werden.

Klappt alles, dann wird das Programm im Verzeichniss /usr/bin installiert. Man fgt es dann
am Besten in eine systemweite X11 Startdatei ein, z.B. startx oder startkde:

	/usr/bin/maild start
	
Dadurch wird maild im Hintergrund gestartet. Beenden kann man maild dann nur noch durch Schicken 
des HUP Signals mit kill.


Wenn maild das erste Mal gestartet wird, dann erzeugt es eine Konfigurationsdatei($HOME/.maild),
falls man nicht schon eine erstellt hat. Diese Datei hat das folgende Format:

	mailbox=/var/spool/mail/USERNAME
	
Der Parameter mailbox gibt an, welche Mailbox berwacht werden soll. Diese Mailbox 
MUSS sich auf dem lokalen Rechner befinden. Eventuell knnte man es so konfigurieren,
da das Mailprogramm regelmssig auf den POP3 Server des Providers schaut, wenn man keinen
eigenen betreibt, und die Mails in einer Datei speichert. Diesen Dateinamen knnte man 
hier auch angeben.

	notifypic=/home/USERNAME/box.xpm
	
Der Parameter notifypic gibt das Bild an, welches angezeigt werden soll, wenn eine Email
eingetroffen ist.

	altcommand=xterm +sb -bg red -cr red -geometry 10x4 &

Der Parameter altcommand definiert einen Defaultwert, wenn kein Bild gefunden wurde. Dann wird
das angegebene Kommando audgefhrt. In diesem Fall handelt es sich um ein kleines Xterm Fenster.

	sec=10

Der Parameter sec gibt an, in welchen Zeitabstnden maild nach der Mailbox schauen soll.


Wenn maild gestoppt werden soll, dann den folgenden Befehl eingeben:

	/usr/bin/maild stop

Es gibt ausserdem die Parameter start und restart.


___________________________________________________________

TODO LIST:

	- Commandline Optionen hinzufgen
	- BEEP soll einstellbar werden
	- Logging
	- Doku in Englisch erstellen

___________________________________________________________


Viel Spass!






__________________________________________________________
english

maild is a small programm that stays in background and waits for incoming mail in a local mailbox. If a new mail arrives, it shows a small image using xv and beeps. one image is supplied in this package. If it finds no picture, a red small Xterm window will displayed. 



Release Notes

maild 0.2 is now a daemon. That means, that it starts a daughter process and finishs itself. It creates a file named .maild.PID in the homedirectory of the current user. maild could started only once a time by one user, but it is possible that various users starts maild. Then for every user another daughter process starts. You can start and stop the daemon with a script (provided in this package too: maild).


Installation

The installation of maild is very simple since i have included a install script. First unpack the archive:

	gzip -cd maild-0.2.tar.gz | tar xf -
	
Then change to the new created directory "maild-0.2" and view the script "install". Perhaps you want to change the destinations, where the files will be copied. If its OK for you, type

	./install

The programm will now compiled and copied to /usr/bin. Now add a line to your X11 startfile, startx or startkde, what you want:

	/usr/bin/maild start

The first time maild was started, it creates a configuration file in the current users home directory. Take a look and edit it, if needed. Here a short description of every parameter:

	mailbox=/var/spool/mail/USERNAME 
	- the mailbox to look
	
	notifypic=/usr/bin/box.xpm 
	- the image to display, if a mail arrives
	
	altcommand=xterm +sb -bg red -cr red -geometry 10x4 & 
	- the command to execute, if it could not find a image
	
	sec=10
	- the intervall it polls


TODO List:

- add commandline features
- make it possible to look at pop3 boxes
- make it possible to configure the beep
- ad logging capabilities


Have fun!







  (c) 1998 Thomas Linden
  All rights reserved.
  maild 0.2
   
  This program 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.
   
  
   Redistribution and use in source and binary forms, with or without
   modification, are permitted provided that the following conditions
   are met:
   1. Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
   2. 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.
   3. All advertising materials mentioning features or use of this software
      must display the following acknowledgement:
  	This product includes software developed by THOMAS LINDEN
        and other contributors.
   4. Neither the name of THOMAS LINDEN 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 THOMAS LINDEN ``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 THOMAS LINDEN 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.
  
  
   Thomas Linden
   Email: tom@artix.net
   Mail Comments and Bugreports about maild 0.2 to: maild@artix.net



