From f6341c40b5c9fe447b39bf2ed7f5bc6716cfbf80 Mon Sep 17 00:00:00 2001
From: ahriman <ahriman@falte.red>
Date: Tue, 26 Mar 2019 02:07:20 +0000
Subject: [PATCH] updated comments at top of scripts

---
 bin/connusers.py  | 3 +++
 bin/makeuser      | 1 +
 bin/motdrotate.py | 2 +-
 bin/newmail.sh    | 2 ++
 bin/regusers.py   | 4 ++++
 bin/rmuser        | 4 ++++
 bin/toot.py       | 5 +++--
 7 files changed, 18 insertions(+), 3 deletions(-)

diff --git a/bin/connusers.py b/bin/connusers.py
index a09ae4a..eee4e7e 100755
--- a/bin/connusers.py
+++ b/bin/connusers.py
@@ -1,5 +1,8 @@
 #!/usr/local/bin/python3 -I
 
+# Lists currently connected users for https://tilde.institute/stats
+# ben@gbmor.dev
+
 from sys import exit
 import subprocess
 
diff --git a/bin/makeuser b/bin/makeuser
index 05d0b39..06c2d1e 100755
--- a/bin/makeuser
+++ b/bin/makeuser
@@ -2,6 +2,7 @@
 # ---------------------------------------------------------------------------
 # makeuser - tilde.institute new user creation
 # Usage: makeuser [-h|--help] <username> <email> "<pubkey>"
+# ben@gbmor.dev
 # ---------------------------------------------------------------------------
 
 PROGNAME=${0##*/}
diff --git a/bin/motdrotate.py b/bin/motdrotate.py
index ceb8147..fd46614 100755
--- a/bin/motdrotate.py
+++ b/bin/motdrotate.py
@@ -7,7 +7,7 @@ import random
 ## Uses a skeleton motd plus a random quote ##
 ## to produce a motd with a nifty quote.    ##
 ##------------------------------------------##
-## Created by ahriman - ahriman@falte.red   ##
+## Created by ahriman - ben@gbmor.dev       ##
 ## --> BSD 3-clause license applies         ##
 ##############################################
 
diff --git a/bin/newmail.sh b/bin/newmail.sh
index 59e42e2..a9da32b 100644
--- a/bin/newmail.sh
+++ b/bin/newmail.sh
@@ -1,5 +1,7 @@
 #!/usr/local/bin/bash
 
+# Notifies users of newly received mail
+
 NewMail(){
     NEWMAIL=$(mailx &)
     UNREAD=$(echo $NEWMAIL |grep -o 'messages.*new' | cut -f2 -d" ")
diff --git a/bin/regusers.py b/bin/regusers.py
index 758da18..e6fff77 100755
--- a/bin/regusers.py
+++ b/bin/regusers.py
@@ -1,5 +1,9 @@
 #!/usr/local/bin/python3
 
+# Lists all the currently registered users extant on the system
+# for the stats page at https://tilde.institute/stats
+# ben@gbmor.dev
+
 import os
 import sys
 
diff --git a/bin/rmuser b/bin/rmuser
index b220181..4413ebc 100755
--- a/bin/rmuser
+++ b/bin/rmuser
@@ -1,5 +1,9 @@
 #!/usr/local/bin/bash
 
+# Hopefully, this never has to be used.
+# Cleans up and removes a user from the system.
+# ben@gbmor.dev
+
 echo "Removing user $1 from the system"
 userdel $1
 echo "Cleaning /home and /var/www/users"
diff --git a/bin/toot.py b/bin/toot.py
index 79c8d81..a8d0b08 100755
--- a/bin/toot.py
+++ b/bin/toot.py
@@ -1,7 +1,8 @@
 #!/usr/local/bin/python2
 
-# Borrowed from Ben Harris of tilde.team
-# Thanks Ben!
+# Called by bin/makeuser to send a 'toot' to the
+# tilde.institute mastodon account at
+# https://tilde.zone/@tildeinstitute
 
 import json
 import os