This is STAMOS 0.3.

The latest release is available at:

	http://privat.schlund.de/K/Knut_Grahlmann/english/stamos.html
	
STAMOS was written by Knut Grahlmann <Knut.Grahlmann@bigfoot.com> and is copyrighted
under the terms of the GPL (see LICENSE for further information).



HISTORY:

STAMOS stands for "Some Things About My Own Server" and was written for more or less
one reason; boasting. :-)
This is because, that one day, one message in suse-linux@suse.com lead me to
http://capsi.com/linux-uptimed.shtml. There, I found uptimed, a programm that keeps
track of your uptimes and makes a "file of fame".
At the time I write this, I had my own server (but was not shure if I could keep it).
Anyways, I wanted to tell the world what a sweet machine "yoda" is. Therefore I
needed the information of uprecords (the program that displays the "file of fame")
as an HTML file.
Well, I could use Ud that does basically the same as uptimed does and it also
produces HTML output. Here is what Rob Kaper (the author of uptimed) has to say
about Ud:
"Uptimed was inspired by Ud, a similar program. Ud has way more features,
but I didn't like how it was using pid files. Uptimed instead looks at the
boottime from /proc/stat to see whether a current uptime is actually the
same session as one in the log file."
I also don't use Ud, because I never had a chance to look at it, since its site was
(and is still [04/05/1999]) somehow down.
While I wrote the program that just displayed the uptime, I got the idea to include
some more stuff, like information about the CPU, RAM etc..
And here it is...


INSTALL:

1) In order to run this program, you need the uptimed utilities from
   http://capsi.com/linux-uptimed.shtml. For installation instructions on these, see
   its INSTALL file.

2) When you got all that stuff running (it's really easy, believe me), you have two
   choices:
   a) You leave all these files in the folder it came in and move this folder
   somewhere "safe" (like /opt), or
   b) You copy the stamos file into a folder that is in PATH.
   I rather have my programs in their own folders, it's easier to update and less
   confusing.

3) Make shure, STAMOS is executable.

4) Also make shure that you have write access to the folder/file you specified as
   your output file.

5) If you want, you can copy sample.conf to /etc/stamos.conf. (Makes life easier
   because this way, you don't have to specify it everytime you start STAMOS.)

6) Adapt the configuration file to your needs.

7) Since STAMOS main purpose is to display the current uptime, it wouldn't be very
   smart to let STAMOS run per hand. On my server, it runs as a cron job every
   five minutes.
   (snip ----/etc/crontab----
   */5 * * * * root /root/scripts/stamos (options)
   ---- snap)
   
   (For information about crontab refer to 'man crontab' and 'man 5 crontab'.)

8) PLEASE give me feedback! I'm especially interested in comments on the programming
   style.


USE:

STAMOS needs in order to run at least two commandline parameters, uptimed and output
(for explanation see below). Without these two, it will refuse to work.

list of options:

mandatory options:
--output      the name and the full path of the file where STAMOS should write to
--uptimed     the directory with the uprecords program in it

non-mandatory options:
--config	specifies the name and path of a config file and overrides the
		standard /etc/stamos.conf
--help         	displays a help screen
--overwrite    	In case the output file exists, it is overwritten.
--quiet        	STAMOS produces (unless there are errors) NO screen output.
--verbose      	Makes STAMOS a bit more talkative during the creation of the the
               	output file.


CONFIGURATION FILE:

See sample.conf for more information on the configuration file.


TODO:

see TODO


CREDITS:

see CREDITS



Knut Grahlmann <Knut.Grahlmann@bigfoot.com> 04/18/1999
