.\" This manpage has been automatically generated by docbook2man 
.\" from a DocBook document.  This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
.\" Please send any bug reports, improvements, comments, patches, 
.\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "UPTIMED.CONF" "5" "31 December 2020" "uptimed.conf" ""

.SH NAME
uptimed.conf \- The configuration file for uptimed(8)
.SH "DESCRIPTION"
.PP

\fIuptimed.conf\fR contains a list of key-value
pairs to configure the behaviour of \fBuptimed\fR(8),
comments start with \fB#\fR\&.
The beginning of \fIuptimed.conf\fR might look like
the following:
.PP
.sp
.RS

.nf
# Uptimed configuration file.

# Interval to write the logfile with in seconds.
UPDATE_INTERVAL=3600

# Maximum number of entries in logfile. Set to 0 for unlimited.
LOG_MAXIMUM_ENTRIES=500
.fi
.RE
.PP
The variables LOG_MINIMUM_UPTIMED, 
MAIL_MINIMUM_UPTIME and MILESTONE
expect a time unit which are encoded by a single letter. 
\fBh\fR is used for hour,
\fBd\fR is used for day, 
\fBw\fR is used for weeks and
\fBy\fR is used for years. Default (nothings specified)
is seconds.
.PP
The default \fIuptimed.conf\fR is quite well commented so
you should be able to use it as a basis. The following keys are supported:
.PP
.TP
\fBUPDATE_INTERVAL\fR
Interval to write the logfile with in seconds, e.g. 60.
.TP
\fBLOG_MAXIMUM_ENTRIES\fR
Maximum number of entries in logfile, e.g. 50. Set to 0 for unlimited.
.TP
\fBLOG_MINIMUM_UPTIMED\fR
Minimum uptime that must be reached to be considered a record.
.TP
\fBMAIL_MINIMUM_UPTIME\fR
Minimum uptime before sending out e-mail.
.TP
\fBMAIL_MINIMUM_POSITION\fR
Minimum position in uptime ranking before sending out e-mail.
.TP
\fBEMAIL\fR
Email address to mail milestones/records to.
Assumes \fBsendmail\fR(8) compatible MTA 
installed as \fI/usr/lib/sendmail\fR\&.
You can enable this with SEND_EMAIL or with the 
\fB-e\fR option on the commandline.
.TP
\fBSEND_EMAIL\fR
Controls if email is sent. Use \fB0\fR if you never want
an email, \fB1\fR if you want emails for both milestones and
records, \fB2\fR if you want emails only for milestones and
\fB3\fR if you want emails only for records.
.TP
\fBSENDMAIL\fR
Command to call a sendmail compatible mailer,
e.g. /usr/lib/sendmail -t\&.
.TP
\fBPIDFILE\fR
Path to store PID file, e.g.
\fI/var/run/uptimed\fR
.TP
\fBMILESTONE\fR
Configurable milestones. 
Syntax is pretty easy: MILESTONE=time:description\&.
Keep in mind that the description needs to fit in the window. 

.SS "EXAMPLE FOR MILESTONE SETTINGS"
.sp
.RS

.nf
MILESTONE=5d:five days
MILESTONE=10d:ten days
MILESTONE=25d:twenty-five days
MILESTONE=50d:fifty days
MILESTONE=10w:ten weeks
MILESTONE=75d:seventy-five days
MILESTONE=100d:hundred days
MILESTONE=150d:hundred and fifty days
MILESTONE=25w:twenty-five weeks
MILESTONE=200d:two hundred days
MILESTONE=250d:250 days
MILESTONE=300d:three hundred days
MILESTONE=50w:fifty weeks
MILESTONE=1y:one year
MILESTONE=400d:four hundred days
MILESTONE=500d:five hundred days
MILESTONE=100w:hundred weeks
MILESTONE=750d:750 days
MILESTONE=1000d:thousand days
.fi
.RE
.SH "AUTHOR"
.PP
This man page was written by Helge Kreutzmann
<kreutzm@itp.uni-hannover.de> for the Debian GNU/Linux project but
may be used by others.
.SH "SEE ALSO"
.PP
\fBuptimed\fR(8), \fBuprecords\fR(1)