chiark / gitweb /
document recipient formats better
authorIan Jackson <ijackson@chiark.greenend.org.uk>
Fri, 11 Apr 2014 16:39:43 +0000 (17:39 +0100)
committerIan Jackson <ijackson@chiark.greenend.org.uk>
Fri, 11 Apr 2014 16:39:43 +0000 (17:39 +0100)
notify
via-email
via-irctopic
via-sms

diff --git a/notify b/notify
index f47a19d3641a8c2cafd03ffe6b54e68954094bf1..f061ffca8fe059e44ab50700e567ed5970d434d0 100755 (executable)
--- a/notify
+++ b/notify
@@ -5,6 +5,7 @@ usage () { cat <<END
 usage: ./notify senderfile recipientsfile 'message'
 
 recipientsfile: see test-recipients for an example
+see comments in via-* scripts for individual line formats
 
 senderinfo: file containing
    email YOUREMAILADDRESS@EXAMPLE.COM
index 34b1d7fb42282549692e6c3a3cb8648e20759c6d..9ae22ea810401f51df1957d5eca84dd505bddfce 100755 (executable)
--- a/via-email
+++ b/via-email
@@ -1,4 +1,9 @@
 #!/bin/bash
+#
+# recipient format:
+#    email ADDRESS1@DOMAIN ADDRESS2@DOMAIN...
+# as many as you like on one line
+
 msg="$1"; shift
 rcpts="$*";
 ssh -vt ijackson@tunnel.chiark.greenend.org.uk \
index f67dba3c8dfb24665595b5cfb2972e7290e1f9ef..b0bafbd6ba7364eab4e906d9646d4068561f7e77 100755 (executable)
@@ -1,4 +1,8 @@
 #!/usr/bin/perl -w
+#
+# recipient format:
+#    irctopic SERVER PORT CHANNEL
+
 use strict;
 die unless @ARGV==4;
 our ($msg,$server,$port,$channel) = @ARGV;
diff --git a/via-sms b/via-sms
index 2dc4546af7329360bc3251d05fbdea8e2bdc9d40..91f188161c626d9b390384bcd6663d14bd8eb39f 100755 (executable)
--- a/via-sms
+++ b/via-sms
@@ -1,4 +1,9 @@
 #!/bin/sh
+#
+# recipient format:
+#    sms TELEPHONENUMBER COMMENT...
+# one per line
+
 set -e
 msg="$1"
 rcpt="$2"