From a5ac082e97881c155ce3693deb4f81f861243d09 Mon Sep 17 00:00:00 2001
From: Chris Koeritz <fred@gruntose.com>
Date: Fri, 4 Nov 2016 03:57:12 -0400
Subject: [PATCH] added comments in crontabs for purpose.

added functional title before each block of real crontab guts
---
 infobase/configuration/cron/acroread_cleaner.crontab        | 1 +
 .../configuration/cron/backup_all_mysql_databases.crontab   | 1 +
 infobase/configuration/cron/backup_maildir.crontab          | 1 +
 infobase/configuration/cron/backup_photo_albums.crontab     | 2 +-
 infobase/configuration/cron/backup_trac.crontab             | 2 +-
 infobase/configuration/cron/bookmarks_builder.crontab       | 1 +
 infobase/configuration/cron/chkrootkit.crontab              | 5 ++---
 infobase/configuration/cron/doxygen.crontab                 | 1 +
 infobase/configuration/cron/git_account_backup.crontab      | 3 ++-
 infobase/configuration/cron/linux_config_snarf.crontab      | 1 +
 infobase/configuration/cron/mailman_attribute_fix.crontab   | 1 +
 infobase/configuration/cron/nechung_fortune.crontab         | 1 +
 infobase/configuration/cron/opensim_restart.crontab         | 1 +
 infobase/configuration/cron/process_check.crontab           | 1 +
 infobase/configuration/cron/random_sound.crontab            | 1 +
 infobase/configuration/cron/repositories_updater.crontab    | 2 +-
 .../cron/run_grid_container_non_work_hours.crontab          | 2 ++
 infobase/configuration/cron/serene_backup.crontab           | 5 +----
 infobase/configuration/cron/swim_upstream.crontab           | 6 +++---
 infobase/configuration/cron/tell_zooty_our_ip.crontab       | 1 +
 infobase/configuration/cron/time_synch.crontab              | 2 ++
 infobase/configuration/cron/uptime_report.crontab           | 1 +
 infobase/configuration/cron/web_group_perm_fix.crontab      | 1 +
 infobase/configuration/cron/whack_knotify4.crontab          | 1 +
 infobase/configuration/cron/zooty_archive_packer.crontab    | 1 +
 25 files changed, 31 insertions(+), 14 deletions(-)

diff --git a/infobase/configuration/cron/acroread_cleaner.crontab b/infobase/configuration/cron/acroread_cleaner.crontab
index 6c59e43d..0a543cf2 100644
--- a/infobase/configuration/cron/acroread_cleaner.crontab
+++ b/infobase/configuration/cron/acroread_cleaner.crontab
@@ -3,5 +3,6 @@ SHELL=/bin/bash
 
 # m h dom mon dow command
 
+#[acroread cleaner]
 * * * * * /bin/rm -f $HOME'/C:\nppdf32Log\debuglog.txt'
 
diff --git a/infobase/configuration/cron/backup_all_mysql_databases.crontab b/infobase/configuration/cron/backup_all_mysql_databases.crontab
index 3c465d4b..662c2175 100644
--- a/infobase/configuration/cron/backup_all_mysql_databases.crontab
+++ b/infobase/configuration/cron/backup_all_mysql_databases.crontab
@@ -6,6 +6,7 @@ SHELL=/bin/bash
 
 USER=fred
 
+#[backup all mysql databases]
 # backs up our databases on a weekly basis.
 28 4 * * 2 (source $HOME/feisty_meow/scripts/core/launch_feisty_meow.sh; mysqldump -u root '-pPASSWORD' --all-databases | gzip > /z/stuffing/archives/database_backup_$(hostname)_$(date_stringer).sql.gz) &>/tmp/database_backup_${USER}.log
 
diff --git a/infobase/configuration/cron/backup_maildir.crontab b/infobase/configuration/cron/backup_maildir.crontab
index b0dc261c..259511f0 100644
--- a/infobase/configuration/cron/backup_maildir.crontab
+++ b/infobase/configuration/cron/backup_maildir.crontab
@@ -6,6 +6,7 @@ SHELL=/bin/bash
 
 USER=fred
 
+#[backup maildir]
 # backs up the maildir folder for fred monthly
 * * 1 * * (source $HOME/feisty_meow/scripts/core/launch_feisty_meow.sh; tar -czf /z/stuffing/archives/maildir_backup_$(date_stringer).tar.gz $HOME/Maildir) &>/tmp/maildir_backup_${USER}.log
 
diff --git a/infobase/configuration/cron/backup_photo_albums.crontab b/infobase/configuration/cron/backup_photo_albums.crontab
index 6209055b..51e80c88 100644
--- a/infobase/configuration/cron/backup_photo_albums.crontab
+++ b/infobase/configuration/cron/backup_photo_albums.crontab
@@ -1,5 +1,5 @@
 
-
+#[backup photo albums]
 # back up the pictures in coppermine gallery every month.
 34 6 4 * * (source $HOME/feisty_meow/scripts/core/launch_feisty_meow.sh; tar -czf /z/stuffing/archives/photo_albums_backup_$(date_stringer).tar.gz /home/albums ; refred) &>/tmp/albums_backup_${USER}.log
 
diff --git a/infobase/configuration/cron/backup_trac.crontab b/infobase/configuration/cron/backup_trac.crontab
index c7967aab..0b8fcc01 100644
--- a/infobase/configuration/cron/backup_trac.crontab
+++ b/infobase/configuration/cron/backup_trac.crontab
@@ -1,6 +1,6 @@
 
 
-
+#[backup trac]
 # backs up trac every week.
 28 7 * * 2 bash $HOME/feisty_meow/scripts/archival/backup_trac.sh /home/trac /z/stuffing/archives
 
diff --git a/infobase/configuration/cron/bookmarks_builder.crontab b/infobase/configuration/cron/bookmarks_builder.crontab
index 54595965..ddae6716 100644
--- a/infobase/configuration/cron/bookmarks_builder.crontab
+++ b/infobase/configuration/cron/bookmarks_builder.crontab
@@ -5,6 +5,7 @@ SHELL=/bin/bash
 
 USER=fred
 
+#[bookmarks builder]
 # regenerate the bookmarks pages.
 24 10 * * * (source $HOME/feisty_meow/scripts/core/launch_feisty_meow.sh; bash $HOME/feisty_meow/scripts/bookmarks/create_marks.sh ) &>>/tmp/zz_bookmarkingering_$USER.log 
 
diff --git a/infobase/configuration/cron/chkrootkit.crontab b/infobase/configuration/cron/chkrootkit.crontab
index c73f4f4d..1bd47407 100644
--- a/infobase/configuration/cron/chkrootkit.crontab
+++ b/infobase/configuration/cron/chkrootkit.crontab
@@ -3,10 +3,9 @@ SHELL=/bin/bash
 
 # m h dom mon dow command
 
+#[chkrootkit]
 # this runs chkrootkit to demonstrate a bug in the vm kernel currently
-# provided by...?
-# who's the vendor?
-
+# provided by...?  hmmm: who's the vendor?
 3 * * * * (/usr/sbin/chkrootkit -q &>/var/www/rootkit_report_quiet.txt )
 4 * * * * (/usr/sbin/chkrootkit -x &>/var/www/rootkit_report_expert.txt )
 
diff --git a/infobase/configuration/cron/doxygen.crontab b/infobase/configuration/cron/doxygen.crontab
index 0b3c73c8..4ea575e5 100644
--- a/infobase/configuration/cron/doxygen.crontab
+++ b/infobase/configuration/cron/doxygen.crontab
@@ -5,5 +5,6 @@ SHELL=/bin/bash
 
 USER=fred
 
+#[doxygen]
 20 4 * * * (source $HOME/feisty_meow/scripts/core/launch_feisty_meow.sh; cd $HOME/hoople/docs; make) &>>/tmp/zz_doxy_make_$USER.log
 
diff --git a/infobase/configuration/cron/git_account_backup.crontab b/infobase/configuration/cron/git_account_backup.crontab
index 77036adf..d57e65f6 100644
--- a/infobase/configuration/cron/git_account_backup.crontab
+++ b/infobase/configuration/cron/git_account_backup.crontab
@@ -5,6 +5,7 @@ SHELL=/bin/bash
 
 USER=fred
 
+#[git account backup]
+# archives the whole ~git folder with all account databases into a compressed tar file.
 34 20 * * 5 tar -czf /z/stuffing/archives/git_archive_$(date +"\%Y_\%m_\%d_\%H\%M_\%S" | tr -d '/\n/').tar.gz /home/git >/home/git/archiving_log.txt 
 
-# archives the whole ~git folder with all account databases into a compressed tar file.
diff --git a/infobase/configuration/cron/linux_config_snarf.crontab b/infobase/configuration/cron/linux_config_snarf.crontab
index f6fc022a..f8d51b08 100644
--- a/infobase/configuration/cron/linux_config_snarf.crontab
+++ b/infobase/configuration/cron/linux_config_snarf.crontab
@@ -5,6 +5,7 @@ SHELL=/bin/bash
 
 USER=fred
 
+#[linux config snarf]
 # do a backup of the config files once a week.
 28 7 * * 4 (source $HOME/feisty_meow/scripts/core/launch_feisty_meow.sh; cd /z/stuffing/archives; perl $HOME/feisty_meow/scripts/archival/snarf_linux_config.pl) &>>/tmp/zz_linux_config_snarf_$USER.log
 
diff --git a/infobase/configuration/cron/mailman_attribute_fix.crontab b/infobase/configuration/cron/mailman_attribute_fix.crontab
index 4714aad9..489c156c 100644
--- a/infobase/configuration/cron/mailman_attribute_fix.crontab
+++ b/infobase/configuration/cron/mailman_attribute_fix.crontab
@@ -3,6 +3,7 @@
 
 SHELL=/bin/bash
 
+#[mailman attribute fix]
 # fix the mailman binaries.
 23 5 * * * chmod -R 02775 /var/lib/mailman/logs &>/dev/null 
 
diff --git a/infobase/configuration/cron/nechung_fortune.crontab b/infobase/configuration/cron/nechung_fortune.crontab
index 13f48806..6f11b83e 100644
--- a/infobase/configuration/cron/nechung_fortune.crontab
+++ b/infobase/configuration/cron/nechung_fortune.crontab
@@ -5,5 +5,6 @@ SHELL=/bin/bash
 
 USER=fred
 
+#[nechung fortune]
 * * * * * (export LIGHTWEIGHT_INIT=true; source $HOME/feisty_meow/scripts/core/launch_feisty_meow.sh; perl $HOME/feisty_meow/scripts/text/new_sig.pl) &>>/tmp/zz_nechung_fortune_$USER.log
 
diff --git a/infobase/configuration/cron/opensim_restart.crontab b/infobase/configuration/cron/opensim_restart.crontab
index 5df6319c..22fbdfff 100644
--- a/infobase/configuration/cron/opensim_restart.crontab
+++ b/infobase/configuration/cron/opensim_restart.crontab
@@ -5,6 +5,7 @@ SHELL=/bin/bash
 
 USER=fred
 
+#[opensim restart]
 # make sure opensim is started if we can't detect it as running.
 */5 * * * * export FOOP=/tmp/opensim_restart_$USER.log; export LIGHTWEIGHT_INIT=true; source $HOME/feisty_meow/scripts/core/launch_feisty_meow.sh &>>$FOOP ; bash $HOME/feisty_meow/scripts/opensim/maybe_restart_opensim.sh &>>$FOOP ; /bin/chmod g+w $FOOP
 
diff --git a/infobase/configuration/cron/process_check.crontab b/infobase/configuration/cron/process_check.crontab
index a88e9c0f..7ee3d4f5 100644
--- a/infobase/configuration/cron/process_check.crontab
+++ b/infobase/configuration/cron/process_check.crontab
@@ -5,6 +5,7 @@ SHELL=/bin/bash
 
 USER=fred
 
+#[process check]
 # a crontab for periodically dumping the process state.
 * * * * * (export LIGHTWEIGHT_INIT=true; source $HOME/feisty_meow/scripts/core/launch_feisty_meow.sh; bash $HOME/feisty_meow/scripts/processes/show_hot_ones.sh) &>>/home/$USER/zz_hot_processes.log 
 
diff --git a/infobase/configuration/cron/random_sound.crontab b/infobase/configuration/cron/random_sound.crontab
index 58f109bd..99f17e16 100644
--- a/infobase/configuration/cron/random_sound.crontab
+++ b/infobase/configuration/cron/random_sound.crontab
@@ -5,5 +5,6 @@ SHELL=/bin/bash
 
 USER=fred
 
+#[random sound]
 * * * * * (export LIGHTWEIGHT_INIT=true; source $HOME/feisty_meow/scripts/core/launch_feisty_meow.sh; bash $HOME/feisty_meow/scripts/multimedia/randomly_play.sh) &>>/tmp/zz_random_sound_$USER.log
 
diff --git a/infobase/configuration/cron/repositories_updater.crontab b/infobase/configuration/cron/repositories_updater.crontab
index 26487e9a..c5c118f0 100644
--- a/infobase/configuration/cron/repositories_updater.crontab
+++ b/infobase/configuration/cron/repositories_updater.crontab
@@ -3,9 +3,9 @@ SHELL=/bin/bash
 
 # m h dom mon dow command
 
+#[repositories updater]
 # update the source code to the latest, every day at 3am or so.
 14 3 * * * (cd ~/hoople1 ; cvs update . ; cd ~/hoople2 ; svn update . ; cd ~/yeti ; svn update . ) &>/dev/null 
-
 # this packs up our source code distributions once a day.
 32 6 * * * (source $HOME/yeti/scripts/core/profile.sh; bash $HOME/yeti/scripts/archival/pack_yeti.sh ; bash $HOME/yeti/scripts/archival/pack_hoople1.sh ; bash $HOME/yeti/scripts/archival/pack_hoople2.sh) &>$HOME/.tmp/zz_packing_cron.log 
 
diff --git a/infobase/configuration/cron/run_grid_container_non_work_hours.crontab b/infobase/configuration/cron/run_grid_container_non_work_hours.crontab
index b93764bf..3a008e00 100644
--- a/infobase/configuration/cron/run_grid_container_non_work_hours.crontab
+++ b/infobase/configuration/cron/run_grid_container_non_work_hours.crontab
@@ -5,6 +5,8 @@ SHELL=/bin/bash
 
 USER=jurgis
 
+#[run grid container non-work-hours]
+
 # we need these for the GenesisII GFFS environment.
 GENII_INSTALL_DIR=/home/jurgis/gffs/code/GenesisII/trunk
 XSEDE_TESTS_FOLDER=$GENII_INSTALL_DIR/toolkit
diff --git a/infobase/configuration/cron/serene_backup.crontab b/infobase/configuration/cron/serene_backup.crontab
index 303b053d..aa6e8ca2 100644
--- a/infobase/configuration/cron/serene_backup.crontab
+++ b/infobase/configuration/cron/serene_backup.crontab
@@ -3,10 +3,7 @@ SHELL=/bin/bash
 
 # m h dom mon dow command
 
-##############
-
+#[serene backup]
 # backs up config files and important parts of home directories to off-machine storage.
 14 2 * * */7 (source $HOME/feisty_meow/scripts/core/launch_feisty_meow.sh; bash $HOME/feisty_meow/scripts/archival/serene_backer_upper.sh) &>/tmp/offmachine_backup.log
 
-##############
-
diff --git a/infobase/configuration/cron/swim_upstream.crontab b/infobase/configuration/cron/swim_upstream.crontab
index c4b9b9c1..f7ca01f4 100644
--- a/infobase/configuration/cron/swim_upstream.crontab
+++ b/infobase/configuration/cron/swim_upstream.crontab
@@ -1,13 +1,13 @@
 
 SHELL=/bin/bash
 
-# this cron job updates the feisty meow repository on source forge based on
-# the real one at feistymeow.org.
-
 # m h dom mon dow command
 
 USER=fred
 
+#[swim upstream]
+# this cron job updates the feisty meow repository on source forge based on
+# the real one at feistymeow.org.
 # update the source code to the latest, every day at 3am or so.
 14 */2 * * * (export LIGHTWEIGHT_INIT=true; source $HOME/feisty_meow/scripts/core/launch_feisty_meow.sh; bash $HOME/feisty_meow/scripts/rev_control/push_repo_upstream.sh $HOME/repos/sf-feistymeow-trunk ) &>>/tmp/zz_nechung_fortune_$USER.log
 
diff --git a/infobase/configuration/cron/tell_zooty_our_ip.crontab b/infobase/configuration/cron/tell_zooty_our_ip.crontab
index 4e8f4753..bdf45d5e 100644
--- a/infobase/configuration/cron/tell_zooty_our_ip.crontab
+++ b/infobase/configuration/cron/tell_zooty_our_ip.crontab
@@ -3,6 +3,7 @@ SHELL=/bin/bash
 
 # m h dom mon dow command
 
+#[tell zooty our ip address]
 # special for firewall host; get zooty informed of our IP so we can make
 # the back-connection and get home.
 0,14,28,42,56 * * * * (bash /home/fred/feisty_meow/scripts/security/tell_zooty_our_ip.sh serene.feistymeow.org fred fred ) &>>/tmp/zooty_tell_report.txt
diff --git a/infobase/configuration/cron/time_synch.crontab b/infobase/configuration/cron/time_synch.crontab
index ee390d2b..ef5a747e 100644
--- a/infobase/configuration/cron/time_synch.crontab
+++ b/infobase/configuration/cron/time_synch.crontab
@@ -3,6 +3,8 @@ SHELL=/bin/bash
 
 # m h dom mon dow command
 
+#[time synch crontab]
+
 # standard to synch to local machine.
 0,4,8,12,16,20,24,28,32,36,40,44,48,52,56 * * * * /usr/sbin/sntp -P no -r greendragon
 or
diff --git a/infobase/configuration/cron/uptime_report.crontab b/infobase/configuration/cron/uptime_report.crontab
index 8a2684ec..8aaab715 100644
--- a/infobase/configuration/cron/uptime_report.crontab
+++ b/infobase/configuration/cron/uptime_report.crontab
@@ -5,6 +5,7 @@ SHELL=/bin/bash
 
 USER=fred
 
+#[uptime report]
 # the script writes the current time and current uptime to the log file.
 0 * * * * (source $HOME/feisty_meow/scripts/core/launch_feisty_meow.sh; bash $HOME/feisty_meow/scripts/system/write_uptime_report.sh) &>>/tmp/zz_uptime_report_$USER.log
 
diff --git a/infobase/configuration/cron/web_group_perm_fix.crontab b/infobase/configuration/cron/web_group_perm_fix.crontab
index 86b645ae..906b1122 100644
--- a/infobase/configuration/cron/web_group_perm_fix.crontab
+++ b/infobase/configuration/cron/web_group_perm_fix.crontab
@@ -3,6 +3,7 @@
 
 SHELL=/bin/bash
 
+#[web group perm fix]
 # fix the web directories for group access.
 0 * * * * chmod -R g+w /var/www &>/dev/null
 
diff --git a/infobase/configuration/cron/whack_knotify4.crontab b/infobase/configuration/cron/whack_knotify4.crontab
index 68a0ae6a..7bfe07bb 100644
--- a/infobase/configuration/cron/whack_knotify4.crontab
+++ b/infobase/configuration/cron/whack_knotify4.crontab
@@ -3,6 +3,7 @@ SHELL=/bin/bash
 
 # m h dom mon dow command
 
+#[whack knotify]
 # whack this troublesome process that can go cpu crazy on a logout.
 # so far this is the best solution to this major annoyance.
 */3 * * * * killall knotify4 &>/dev/null
diff --git a/infobase/configuration/cron/zooty_archive_packer.crontab b/infobase/configuration/cron/zooty_archive_packer.crontab
index 1e941519..69d3d447 100644
--- a/infobase/configuration/cron/zooty_archive_packer.crontab
+++ b/infobase/configuration/cron/zooty_archive_packer.crontab
@@ -5,6 +5,7 @@ SHELL=/bin/bash
 
 USER=fred
 
+#[zooty archive packer]
 # this packs up our archives once a day.
 32 6 0 * * (source $HOME/feisty_meow/scripts/core/launch_feisty_meow.sh; bash $HOME/feisty_meow/scripts/archival/pack_yeti.sh ; bash $HOME/feisty_meow/scripts/archival/pack_hoople.sh ) &>>/tmp/zz_packing_cron_$USER.log 
 
-- 
2.34.1