<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [

<!--
Based upon Craig Small's dh-make /usr/share/debhelper/dh_make/debian/manpage.xml.ex,
http://packages.debian.org/dh-make .

Process this file with an XSLT processor, as specified in Makefile.am.
A manual page foo.1 will be generated.  You may view the manual page
with: 'nroff -man foo.1 | less'.  Or 'man -l ./foo.1'

The xsltproc binary is found in the xsltproc package.  The
XSL files are in docbook-xsl.
-->

  <!ENTITY firstname "<firstname>Joost</firstname>">
  <!ENTITY surname   "<surname>van Baal-Ilić</surname>">
  <!ENTITY section   "<manvolnum>1</manvolnum>">
  <!ENTITY username  "Joost van Baal-Ilić">
  <!ENTITY uccommand "<refentrytitle>ST_SNAPSHOT.HOURLY</refentrytitle>">
  <!ENTITY command   "st_snapshot.hourly">

  <!ENTITY dhtitle     "st_snapshot.hourly User Manual">
  <!ENTITY dhucpackage "ST_SNAPSHOT.HOURLY">
  <!ENTITY dhpackage   "st_snapshot.hourly">

  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
  <!ENTITY % man.ent SYSTEM "man.ent">
%man.ent;
]>

<refentry>
  <refentryinfo>
    <title>&dhtitle;</title>
    <productname>&dhpackage;</productname>
    <authorgroup>
      <author>
        &firstname;
        &surname;
        <email>&bugemail;</email>
      </author>
      <address>&bugemail;</address>
    </authorgroup>
    <copyright>
      <year>2001-&year;</year>
      <holder>&username;</holder>
    </copyright>
    <legalnotice>
    <para>
      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.
    </para>
    </legalnotice>
    &date;
  </refentryinfo>
  <refmeta>
    &uccommand;

    &section;
  </refmeta>
  <refnamediv>
    <refname>&command;</refname>

    <refpurpose>wrapper for st_snapshot</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&command;</command>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para><command>&command;</command> is a wrapper for
<command>st_snapshot</command>.  <command>&command;</command> is to be run from cron.

</para>
<para>

It checks existence of the files &brokenfile; and &unconfiguredfile; .  The
file <filename>i_want_a_broken_systraq</filename> typically is empty; if it
exists, <command>&command;</command> exits immediately.  Existence of this file
&quot;breaks&quot; systraq: systraq will no longer warn when system
configuration files changes, but will remain silent.  If
<filename>systraq_is_unconfigured</filename> exists, its contents are displayed
and <command>&command;</command> exits.  The file
<filename>systraq_is_unconfigured</filename> typically holds instructions on
how to configure systraq, an example
<filename>systraq_is_unconfigured</filename> file is shipped with the systraq
tarball.  If both files are missing, <command>st_snapshot</command> is called
with appropriate arguments, either in &quot;root&quot; or in
&quot;public&quot;-mode, depending on the ST_MODE environment variable.

</para>
<para>

Since the systraq tarball behaves sanely on a fresh default install,
<filename>systraq_is_unconfigured</filename> is <emphasis>not</emphasis> installed by
default.  However, people preparing systraq binary packages typically can make
good use of this file.

</para>
<para>

When systraq is installed from tarball the systraq cronjobs are not enabled.
One typically enables them <emphasis>after</emphasis> having configured
systraq, especially after the <command>st_snapshot</command> listfiles
<filename>snapshot_pub.list</filename>,
<filename>snapshot_pub.homelist</filename>,
<filename>snapshot_root.list</filename> and
<filename>snapshot_root.homelist</filename> in &etcpathraw; are created.
However, binary systraq packages typically enable the cronjobs without
enforcing one-fits-all listfiles on the user.

</para>
<para>

</para>

  </refsect1>

  <refsect1>
    <title>ENVIRONMENT</title>

    <variablelist>
      <varlistentry>
        <term>ST_MODE
        </term>
        <listitem>
          <para>If set to &quot;root&quot;, run st_snapshot in root-mode.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>ST_SUM
        </term>
        <listitem>
          <para>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.</para>
        </listitem>
      </varlistentry>

    </variablelist>

    <para> </para>

  </refsect1>
  <refsect1>
    <title>FILES</title>

    <para>

&brokenfile;, &unconfiguredfile;.

    </para>

  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>

    <para>st_snapshot (1), The systraq Manual.</para>

  </refsect1>
  <refsect1>
    <title>VERSION</title>

<para>&version;</para>

  </refsect1>
</refentry>
