[Systraq-commit] r214 - in trunk/systraq: . man

[Joost van Baal]

Author: joostvb
Date: 2005-02-12 23:35:44 +0100 (Sat, 12 Feb 2005)
New Revision: 214

Modified:
   trunk/systraq/TODO
   trunk/systraq/man/st_snapshot.hourly.dbx
Log:
need to finish manpage

Modified: trunk/systraq/TODO
===================================================================
--- trunk/systraq/TODO	2005-02-12 22:31:08 UTC (rev 213)
+++ trunk/systraq/TODO	2005-02-12 22:35:44 UTC (rev 214)
@@ -5,22 +5,20 @@
   document all run-time dependencies, get configure.ac check for them.
 - Document systraq-commit@lists.alioth.debian.org on systraq webpage.
 - Make sure "Skipped 'foo'" messages don't show up in ChangeLog.
-- Don't use pod but zoem (or docbook) for st_snapshot manpage (or wait for
-  Laurent to do this).  document zoem build-depends.
+- Don't use pod but docbook for st_snapshot manpage (or wait for
+  Laurent to do this).  document build-depends for typesetting manpages.
 - Write a systraq(8) manpage (or wait for Laurent to do this).  Remove details
   about this script from the systraq manual.  Copy stuff from NEWS file.
 - Finish systraq manual: add diagram listing dependencies (see the FIXME)
-- Do not install systraq_is_unconfigured , just ship it with tarball for
-  packagers only.
-- Document st_snapshot.hourly in manual.dbx.
+- Finish st_snapshot.hourly manpage.  Refer to this manpage in manual.dbx.
 - Don't install st_snapshot.hourly in bin/ , but in a location like libexec/ .
 - Don't use md5sum, but sha1sum as shipped with GNU coreutils
   ( ftp://ftp.gnu.org/gnu/coreutils/ ).  Interface seems same, so change
   should be trivial.
   md5sum should be variable ST_SUM in /usr/sbin/systraq, it should be set
   optionally.
-- The way all homedirectories are found is braindead.  it fails in case
-  something like NIS is used.  document this.
+- The way all homedirectories are found is braindead.  It fails in case
+  something like NIS is used.  Document this.
 - Check systraq announcement on http://directory.fsf.org/, update systraq webpage.
 - Systraq should silently ignore non-world-readable to-be-monitored files in
   homedirectories.  This is nice on systems where some users like to have e.g.

Modified: trunk/systraq/man/st_snapshot.hourly.dbx
===================================================================
--- trunk/systraq/man/st_snapshot.hourly.dbx	2005-02-12 22:31:08 UTC (rev 213)
+++ trunk/systraq/man/st_snapshot.hourly.dbx	2005-02-12 22:35:44 UTC (rev 214)
@@ -69,8 +69,11 @@
 st_snapshot.  <command>&command;</command> is to be run from cron.
 
 It checks existence of the files i_want_a_broken_systraq and systraq_is_unconfigured.
+An example systraq_is_unconfigured file is shipped with the systraq tarball.
+Since the systraq tarball behaves sanely on a fresh default install, this file
+is NOT installed by default.  However, people preparing systraq binary packages
+typically can make good use of this file.
 
-
 This manual page documents briefly the
       <command>&command;</command> and <command>bar</command>
       commands.</para>