Blame contrib/adm-mrtg/adm-mrtg.README

Packit 667938
This script organizes config files for MRTG
Packit 667938
and restarts the MRTG processes cleanly.
Packit 667938
 
Packit 667938
Author: Scott Ripley, U.S. House of Representatives
Packit 667938
Version: 1.0 (and all that a 1.0 release entails)
Packit 667938
Contact: scott.ripley@mail.house.gov
Packit 667938
Copyright: (C) 2001 Scott Ripley
Packit 667938
 
Packit 667938
This program is free software; you can redistribute it and/or
Packit 667938
modify it under the terms of the GNU General Public License
Packit 667938
as published by the Free Software Foundation; either version 2
Packit 667938
of the License, or (at your option) any later version.
Packit 667938
 
Packit 667938
This program is distributed in the hope that it will be useful,
Packit 667938
but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit 667938
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Packit 667938
GNU General Public License for more details.
Packit 667938
Packit 667938
1.0 Installing
Packit 667938
Packit 667938
Since this is just a shell script, it can be installed anywhere.
Packit 667938
The standard location is the /usr/local/sbin directory. It creates
Packit 667938
temp files in the same directory as the MRTG binaries, which are
Packit 667938
cleared out at the end of the script.
Packit 667938
Packit 667938
2.0 Configuration
Packit 667938
Packit 667938
You will need to set your pathnames for MRTG, a back-up directory,
Packit 667938
and the location of your log files. That's it.
Packit 667938
Packit 667938
Note: This script only works if you are running MRTG as a daemon.
Packit 667938
It relies on the presence of .pid files to identify your scripts.
Packit 667938
Packit 667938
3.0 Using adm-mrtg
Packit 667938
Packit 667938
The script reads mrtg's bin directory for pid files and displays
Packit 667938
the appropriate config name on-screen.
Packit 667938
Packit 667938
If you make a change to a config file and want to reload it, type
Packit 667938
in the number of the config file name. It will kill the process,
Packit 667938
remove the .pid file and restart it. Once you go back to the home
Packit 667938
screen, you should see a new date for that config under the
Packit 667938
"Running" column.
Packit 667938
Packit 667938
4.0 Backing up with adm-mrtg
Packit 667938
Packit 667938
It is vitally important that you back up your config and log files
Packit 667938
from time to time. Adm-mrtg will do that for you with the simple
Packit 667938
press of the 'b' key.
Packit 667938
Packit 667938
It puts all your config files into a tar file with the format
Packit 667938
"MRTG_<date>.cfgs.tar." It does the same with your .log and .old files.
Packit 667938
If you want to gzip the files, you can uncomment the gzip lines in the
Packit 667938
script.
Packit 667938
Packit 667938
5.0 Technical notes
Packit 667938
Packit 667938
The script was written in ksh on Solaris 7, but there's nothing
Packit 667938
particularly machine-specific in it. It should only require minor
Packit 667938
tweaking for other OS/shell combinations.
Packit 667938
Packit 667938
If you have changes or additions you'd like to make, I would enjoy
Packit 667938
seeing a copy. Please e-mail your changes/comments/ideas to:
Packit 667938
scott.ripley@mail.house.gov, or nevada@mac.com.
Packit 667938
Packit 667938
Thank you.