From 856b6864a3f0dfaf81cfaba65ea65dfdc65f36c6 Mon Sep 17 00:00:00 2001
From: rhamnousia <rhamnousia@riseup.net>
Date: Sat, 27 Jun 2020 23:03:53 -0400
Subject: [PATCH] Added descriptions in tools/README for most of the unknown
 tools that didn't already have descriptions

---
 tools/README | 20 +++++++++++---------
 1 file changed, 11 insertions(+), 9 deletions(-)

diff --git a/tools/README b/tools/README
index 2d4d1f0..300e944 100644
--- a/tools/README
+++ b/tools/README
@@ -58,7 +58,8 @@ common - file sourced by other scripts to get the db info so it doesn't need
 
 unknown, needs to be reviewed
 -----------------------------
-changeUserDomains.pl
+changeUserDomains.pl - rewrites addrs from target domain to addrs for
+   destination domain
 checkdaemons - check if daemons are running, untested
 cleanspool - cleans spools, untested. sympa should be doing this, but it might
    be nice to have a tool that checks
@@ -69,7 +70,8 @@ create-admins-file - generates a list of all admins, don't we do this via a
 create_list_table - bit ofg sql for creating the db, likely out of date and
    should be cleaned up
 decrypt - some old thing to decrypt passwds, delete?
-disable_annoying_tasks
+disable_annoying_tasks - disables global_task_models, scenari, list_task_models
+   and create_list_templates
 email-unsub-instruct - sorta like remind
 find_lists_without_owners.rb - untested
 findmissing - check logs for "Unable to open", delete?
@@ -79,13 +81,13 @@ list.close - script to close a list, unneeded?
 list.common - ?
 list_stats - some old stats, maybe replaced by stats/
 merge-arctxt
-missingkeyfix.p
-pluckspam.pl
-pluckspam.pl.old
+missingkeyfix.py - does some fixing up on some list directory configs it seems
+pluckspam.pl - processes spam complaints
+pluckspam.pl.old - old version of above, probably unneeded
 sanity-check
-sympa_pass.pl
-tlsreport
+sympa_pass.pl - outputs md5 digest of inputted pass
+tlsreport - lists all domains with which TLS connections have been established
 updatedirectory.php
 updatedirectory.rb - generates the web directory of lists
-user.unsubscribe
-withincludes
+user.unsubscribe - command line script to remove a list of users
+withincludes - changes file stamps on some configs it seems
-- 
GitLab