.\" =======================================================
.TH IFCHK.CONF 5 "Apr 27th, 2019" "ifchk 1.1.1"
.\" =======================================================
.SH NAME
ifchk.conf \(em ifchk configuration file
.\" =======================================================
.SH SYNOPSIS
.B ifchk.conf
.if n .ti +9n
.\" =======================================================
.SH DESCRIPTION
.I ifchk.conf
is the configuration file for
.B ifchk.
Configuration file directives take the form of whitespace
separated keyword/value pairs. Lines beginning with a hash 
character ( # ) are considered comments and are ignored.
.\" =======================================================
.SH DIRECTIVES
The following configuration file directives are understood by
.B ifchk:
.\" -------------------------------------------------------
.TP
.B disableOnPromisc ( 0 | 1 )
.RS 4
Specifies whether to disable promiscuous interfaces or not.
If set to 0, promiscuous interfaces will not be disabled.
If set to 1, promiscuous interfaces will be disabled (requires
superuser privileges).
.fi
.RE
.\" -------------------------------------------------------
.TP
.B errLog <log_file>
.RS 4
Specifies the file to which
.B ifchk
logs its error messages (from standard error) when running
as a daemon process.
.B <log_file>
must be a full pathname.
.fi
.RE
.\" -------------------------------------------------------
.TP
.B ifMetricDumpFreq <range>
.RS 4
Specifies the number of seconds between interface
metrics report generation.
.B <range>
may be a number between 1 and 86400 (24 hours), inclusive.
.fi
.RE
.\" -------------------------------------------------------
.TP
.B ifStatusDumpFreq <range>
.RS 4
Specifies the number of seconds between interface status
scans.
.B <range>
may be a number between 1 and 86400 (24 hours), inclusive.
.fi
.RE
.\" =======================================================
.SH CONFIGURATION FILE EXAMPLE
#
.nf
# ifchk system-wide configuration file.
#
errLog                  /var/log/ifchk.errlog
disableOnPromisc        0
ifStatusDumpFreq        3600
ifMetricDumpFreq        7200
.\" =======================================================
.SH NOTES 
An
.B ifchk
configuration file must contain entries for all of
the above directives. There are no preset defaults.

Configuration directive keyword/value pairs should not contain
comments.
.\" =======================================================
.SH FILES
ifchk.conf
.\" =======================================================
.SH SEE ALSO 
ifchk(1)
.\" =======================================================
.SH HISTORY
The ifchk.conf file format first appeared in
.B ifchk
version 1.0.0.
.\" =======================================================
.SH AUTHOR
Joshua Birnbaum <engineer@noorg.org>
.\" =======================================================
.SH COPYRIGHT
.nf
Copyright (C) 2002-2019 Joshua Birnbaum
All Rights Reserved.
.fi
.\" =======================================================
