From: Ian Jackson <ijackson@chiark.greenend.org.uk>
Date: Fri, 11 Apr 2014 16:39:43 +0000 (+0100)
Subject: document recipient formats better
X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=commitdiff_plain;h=fafa408b13f06cd430066417368d31da59b3ca18;p=post-pizza-notify.git

document recipient formats better
---

diff --git a/notify b/notify
index f47a19d..f061ffc 100755
--- 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
diff --git a/via-email b/via-email
index 34b1d7f..9ae22ea 100755
--- 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 \
diff --git a/via-irctopic b/via-irctopic
index f67dba3..b0bafbd 100755
--- a/via-irctopic
+++ b/via-irctopic
@@ -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 2dc4546..91f1881 100755
--- 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"