.\"Generated by db2man.xsl. Don't modify this, modify the source.
.de Sh \" Subsection
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.TH "METCHE" 8 "" "" ""
.SH NAME
metche \- reducing root bus factor
.SH "SYNOPSIS"
.ad l
.hy 0
.HP 7
\fBmetche\fR [\-h\ \fIhost\fR] {\fBcron\fR | \fBreport\ [\fImilestone\fR]\fR | \fBlist\fR}
.ad
.hy

.SH "DESCRIPTION"

.PP
metche is a tool meant to facilitate collective sysadmin, by monitoring changes in the system configuration\&. At least \fBWATCHED_DIR\fR (default: \fI/etc\fR) is monitored ; optionally, metche can also monitor :

.TP 3
\(bu
system Changelog files located in\fI\fBCHANGELOG_DIR\fR/*/Changelog\fR (default:\fI/root/changelogs/*/Changelog\fR)
.TP
\(bu
Debian packages states and versions
.LP

.PP
\fBWATCHED_DIR\fR and \fBCHANGELOG_DIR\fR options can me customized in metche's configuration file, as well as a few other ones\&.

.PP
If \fB\-h\fR  \fIHOST\fR is specified, \fI/etc/metche/HOST\&.conf\fR is used instead of \fI/etc/metche\&.conf\fR\&. This, along with the \fBVSERVER_EXEC_PREFIX\fR option, allows to monitor several vservers running on a system\&.

.PP
Anyway, one of the following commands has to be specified on the command line :

.SS "cron"

.PP
When run (usually by a cronjob) with the \fBcron\fR command, metche looks if the system configuration has changed in the last \fB$TESTING_TIME\fR minutes\&. If it is the case, a "unstable state" is saved\&. Otherwise, a "testing state" (also called a "milestone") is saved, and a report (see metche's homepage: \fIhttps://poivron.org/dev/metche/\fR for an example) is emailed to you\&.

.SS "report [milestone]"

.PP
When run with the \fBreport\fR command, metche displays a report against a given milestone, if specified, or against the latest one, otherwise\&. This is useful when you have broken your system and want to know which changes have been made since a given, known working, milestone\&.

.SS "list"

.PP
When run with the \fBlist\fR command, metche displays the full saved states list\&.

.SH "FILES"

.PP
\fI/etc/metche\&.conf\fR or \fI/etc/metche/*\&.conf\fR : configuration file(s)

.PP
\fI\fBCHANGELOG_DIR\fR/*/Changelog\fR (default : \fI/root/changelogs\fR), if Changelog monitoring is enabled : Changelog files location

.PP
\fI\fBBACKUP_DIR\fR\fR : directory containing the backups

.SH "SECURITY"

.PP
metche sends in \fIclear text email\fR the changes made to the watched directory\&.\&.\&. either make sure that the \fBTAR_OPTS\fR configuration variable prevents it to send sensitive information, or triple check that secure connections will be used end\-to\-end on the email path\&. If unsure, set \fBEMAIL_ADDRESS\fR configuration variable to a local mailbox\&.

.PP
metche stores, in \fBBACKUP_DIR\fR (default : \fI/var/lib/metche\fR), various backups of \fBWATCHED_DIR\fR\&. Make sure that the backup place is at least as secure as the source\&.

.SH "BUGS"

.PP
See metche's ticket system: \fIhttps://poivron.org/dev/metche/\fR to see the bugs, missing features, and development road\-map\&.

.SH "AUTHOR"

.PP
This manual page was written by Intri Geri <intrigeri@boum\&.org>\&.