Update 'README.md'

This commit is contained in:
justine 2021-11-26 15:50:37 +01:00
parent 405ebc5462
commit 79f342fbea

View File

@ -1,20 +1,20 @@
#JuMonitor : A simple monitoring script
# JuMonitor : A simple monitoring script
This script is designed to monitor a list a clients by sending pings.
It can keep you informed by sending alerts, sending a logfile, or both, by mail.
##Contents:
## Contents:
* JuMonitor.py : The main program
* jumonitor.conf : the configuration file. See the comments inside of it for details.
* jumonitor.conf.orig : A sample configuration file, kept for backup.
* jumonitor.log : logfile generated by the program. Will be created if absent.
* juconfigen.py : generates a default config file. You should not need it to use this program.
##Options are:
## Options are:
* -h : prints the help
* -v : verbose (prints to screen as well as to logfile)
* -d : dynamic : instead of reading the config file, ask for info in a dynamic fashion
* -t : testmail : sends a test email
##Dynamic mode :
## Dynamic mode :
Dynamic mode is used when configuration has yet to be made. It is recommended if you don't know where to start. It asks for every information needed, and then allows you to save it to a file. It is quite slef-explanatory, however, using it with in verbose mode results in a VERY talkative manner.