Browse Source

Update 'README.md'

Siegrist(SystemLösungen) 5 years ago
parent
commit
f7389871b0
1 changed files with 16 additions and 24 deletions
  1. 16 24
      README.md

+ 16 - 24
README.md

@@ -14,8 +14,8 @@
  GNU General Public License for more details.    
 
 
-README
-------
+
+#### README
 
 BE CAREFUL BEFORE YOU USE THIS SOTWARE !
 In some Countries it might be illegal to read mail logs and produce mail log summaries.
@@ -24,8 +24,9 @@ If so, make sure that you run Yasma always with command line option (-u) or conf
 parameter "HIDE_USERS = TRUE".
 
 
+-----
+
 Thanks to Sébastien Aperghis-Tramoni
-====================================
 
 Yasma uses a slightly modified Parse::Syslog::Mail perl module 
 from Sébastien Aperghis-Tramoni <sebastien@aperghis.net>.
@@ -33,8 +34,7 @@ from Sébastien Aperghis-Tramoni <sebastien@aperghis.net>.
 Therefore you dont have to install this module, its delivered within the Yasma package.
 
 
-Installation:
-=============
+#### Installation:
 
 Download the archive, unpack it to a directory of your choice (ie. /usr/local/) with
 
@@ -50,8 +50,8 @@ Go to this directory an edit the 'yasma.conf' file suited to your environment an
 The configuration variables are explained within this file.
 
 
-Run it:
-=======
+#### Run it:
+
 
 The 'yasma.pl' programm have to run within the directory where yasma.conf resides 
 and must have read access to logfiles and write access to the folder 
@@ -66,8 +66,7 @@ Yasma can read single or multiple logfiles who can be plain, gzipped (.gz), comp
 ! Be sure the program cannot be started from an insecure place or user !
 
 
-Command line options:
----------------------
+#### Command line options:
 -c config	full name of yasma.conf config-file
 
 -u			dont show user names of mail addresses
@@ -75,8 +74,7 @@ Command line options:
 -f file		print the report to this file. Else output will sent to file defined in configfile.
 
 
-Examples:
-=========
+#### Examples:
 
 	#> yasma.pl -f /opt/httpd/htdocs/report.html /var/log/mail*
 
@@ -91,17 +89,14 @@ this will read the logfile /var/log/mail and puts the html report to file you ha
 the same as above but do not show user part of addresses.
 
 
-GeoIP Database:
-===============
+#### GeoIP Database:
 
 For installing and upgrading GeoIP-database you should do the following:
 1. Download GeoIP-database 'GeoIP.dat.gz' from http://www.maxmind.com/download/geoip/database/GeoLiteCountry/
 2. unpack the GeoIP.dat to the place you defined in yasma.conf (param "geoip_dbase")
 
 
-System Requirements:
-====================
-
+#### System Requirements:
 
 Software:
 
@@ -110,8 +105,7 @@ Software:
     * Optional Geo::IP::PurePerl and its GeoIP Database
 
 
-Changes
-=======
+#### Changes
 0.94: 	new comandline parameter -c configfile
 		allow timestamps in the future in mailfile
 0.95: 	fix a senseless isa() call when no logfile is given.	
@@ -120,23 +114,21 @@ Changes
 		Useful for leap years.
 
 		
-ToDo:
-=====
+#### ToDo:
 
 Yasma is very unfinished.
 Yasma is tested just for sendmail logfiles. Other mailsystems should be added in future.
 Therefor I'm looking for logfiles from other mailsystems as well as strange sendmail logfiles.
 
 
-Other:
-======
+#### Other:
+
 I would be pleased about suggestions, experience or problems.
 
 Please send any mails regarding yasma to yasma@ZweierNet.ch
 
 
-Copyright und Lizenz:
-=====================
+#### Copyright und Lizenz:
 
 Copyright © 2006 by Peter_Siegrist(SystemLoesungen) <pss@zweiernet.ch>.