chklogsrc

Section: File Formats (5)
Updated: 03 August 1997
Index
 

NAME

chklogsrc - ChkLogs Resource file  

DESCRIPTION

As of version 2.0 Chklogs supports a resource file. This resource file is not to be confused with the configuration file. The resource mechanism is hierarchichal, thus there can be a global (system wide) resource file chklogsrc as well as a personal resource file ~/.chklogsrc

The purpose of the resource file is to override built-in configuration values. First chklogs(8) attempts to interpret the global resource file, possibly overriding some of the built-in configuration (not necessarily all). This sort of setup is used during the installation.

If Chklogs is being used in non-root mode (by a normal user or during testing or trial) a personal resource file can be used. This Personal Resource File overrides whatever was set by the built-in configuration or the Global Resource File, thus allowing a finer level of control.

There is no need to specify all the configuration values in the resource file, those that are not used retain their previous setting. Also due to the hierarchichal approach, no error will be produced should any of the resource files not exist.

The syntax of the resource file is quite simple. Comments begin with a hash (#) sign, empty lines are ignored. The setting of variables is like Tcl, thus

          # This is a comment line
          # Configure our MailHost to panama.iaehv.nl, the
          # format is:  set <Variable>  <Value>
          set   MailHost   panama.iaehv.nl
          mode ignore on
          set   Admin      root
          mode ignore off

The settings found between the mode ignore on and mode ignore off do not go into effect. You may choose to only comment the line but sometimes it is easier to just move things around.

 

CONFIGURATION VARIABLES

Each of the configuration variables recognized by the Resource File Interpreter are mapped to a built-in configuration variable. The name of the built-in variable is shown within parenthesis and is assumed to be in the Chklogs.pm module unless specified otherwise. Remember that the resource file(s) override these values!.

ChklogsConf
(ConfFile) The location of the Chklogs configuration file, usually /etc/chklogs.conf.
ChklogsDb
(ResrcFile) The location of the Chklogs status database (previously had the unfortunate name of resource file...). You will never touch that file. Usually /usr/local/lib/chklogs/.chklogsdb
VarRun
(VarRun) Directory where your system keeps the PId files of various processes, here we expect to find syslog.pid and put chklogs.pid. Usually /var/run
RelativePath
(RelativePath) The name of the directory where Chklogs will archive a log when using the Local Repository option. This name is always relative to the path name of the log being examined. Usually OldLogs but you can choose any name.
Admin
(admin) The email address of the administrator that will receive all Chklogs reports. This can be just a login name if on the localhost. Usually root
SyslogConf
(SyslogConf) The location of the syslog daemon's configuration file. If you don't have syslogd installed (you should) comment this out or move it into an `ignore' block. Usually /etc/syslog.conf
MiniMail
(useMiniMail) This can be either yes or no. It specifies whether you want Chklogs to directly talk to the SMTP port which is the preferred (and default) method because it is more portable. Otherwise (when set to no) it uses the pre-2.0 method of spawning a sendmail/smail process to do the work. Usually yes.
MailHost
(mailhost) The name of the mail host to which we will connect to the SMTP port. This name must be resolvable. Usually localhost

Resource files were introduced in Chklogs-2000 (ver. 2.0-1), previously the term was used in Chklogs for the status database, that was an unfortunate choice of name.

 

FILES

/usr/local/lib/chklogs/chklogsrc
~/.chklogsrc
 

SEE ALSO

chklogs(8), chklogsadm(8), chklogs.conf(5)

 

AUTHOR

Didimo Emilio Grimaldo Tunon <grimaldo@panama.IAEhv.nl>

 

Index

NAME
DESCRIPTION
CONFIGURATION VARIABLES
FILES
SEE ALSO
AUTHOR

This document was created by man2html, using the manual pages.
Time: 08:29:48 GMT, August 28, 1997