'\" t
.\"     Title: ST_SNAPSHOT.HOURLY
.\"    Author: Joost van Baal-Ilić <joostvb-systraq-20151105@mdcc.cx>
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: Uku 31 2020
.\"    Manual: st_snapshot.hourly User Manual
.\"    Source: st_snapshot.hourly
.\"  Language: English
.\"
.TH "ST_SNAPSHOT\&.HOURLY" "1" "Uku 31 2020" "st_snapshot.hourly" "st_snapshot.hourly User Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
st_snapshot.hourly \- wrapper for st_snapshot
.SH "SYNOPSIS"
.HP \w'\fBst_snapshot\&.hourly\fR\ 'u
\fBst_snapshot\&.hourly\fR
.SH "DESCRIPTION"
.PP
\fBst_snapshot\&.hourly\fR
is a wrapper for
\fBst_snapshot\fR\&.
\fBst_snapshot\&.hourly\fR
is to be run from cron\&.
.PP
It checks existence of the files
/etc/systraq/i_want_a_broken_systraq
and
/etc/systraq/systraq_is_unconfigured
\&. The file
i_want_a_broken_systraq
typically is empty; if it exists,
\fBst_snapshot\&.hourly\fR
exits immediately\&. Existence of this file "breaks" systraq: systraq will no longer warn when system configuration files changes, but will remain silent\&. If
systraq_is_unconfigured
exists, its contents are displayed and
\fBst_snapshot\&.hourly\fR
exits\&. The file
systraq_is_unconfigured
typically holds instructions on how to configure systraq, an example
systraq_is_unconfigured
file is shipped with the systraq tarball\&. If both files are missing,
\fBst_snapshot\fR
is called with appropriate arguments, either in "root" or in "public"\-mode, depending on the ST_MODE environment variable\&.
.PP
Since the systraq tarball behaves sanely on a fresh default install,
systraq_is_unconfigured
is
\fInot\fR
installed by default\&. However, people preparing systraq binary packages typically can make good use of this file\&.
.PP
When systraq is installed from tarball the systraq cronjobs are not enabled\&. One typically enables them
\fIafter\fR
having configured systraq, especially after the
\fBst_snapshot\fR
listfiles
snapshot_pub\&.list,
snapshot_pub\&.homelist,
snapshot_root\&.list
and
snapshot_root\&.homelist
in /etc/systraq are created\&. However, binary systraq packages typically enable the cronjobs without enforcing one\-fits\-all listfiles on the user\&.
.PP
.SH "ENVIRONMENT"
.PP
ST_MODE
.RS 4
If set to "root", run st_snapshot in root\-mode\&.
.RE
.PP
ST_SUM
.RS 4
Command for calculating file checksums\&. E\&.g\&. sha256sum, sha512sum, sha384sum, sha224sum or sha1sum\&. If unset, sha256sum is used\&. If unset and sha256sum is not found on the system while md5sum is found, md5sum is used and a warning is printed\&. Else, the script prints an error message and exits\&. ST_SUM is passed to and used by st_snapshot\&.
.RE
.PP
.SH "FILES"
.PP
/etc/systraq/i_want_a_broken_systraq,
/etc/systraq/systraq_is_unconfigured\&.
.SH "SEE ALSO"
.PP
st_snapshot (1), The systraq Manual\&.
.SH "VERSION"
.PP
20201231
.SH "AUTHOR"
.PP
\fBJoost van Baal\-Ilić\fR <\&joostvb\-systraq\-20151105@mdcc\&.cx\&>
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2001-2020 Joost van Baal-Ilić
.br
.PP
Permission is granted to copy, distribute and/or modify this document under the terms of the
GNU
General Public License, Version 2 or any later version published by the Free Software Foundation\&.
.sp