Added informations at the top to explain usage and describe dependencies
Benjamin Renard

Benjamin Renard commited on 2013-01-31 09:25:04
Showing 1 changed files, with 13 additions and 1 deletions.

... ...
@@ -4,6 +4,9 @@
4 4
 #
5 5
 # Postfix transport to sending SMS by gnokii
6 6
 #
7
+# Important : The SMS content is the email's subject header.
8
+#             Usefull for Nagios notification
9
+#
7 10
 # Usage : 
8 11
 #
9 12
 #   in master.cf :
... ...
@@ -15,7 +18,16 @@
15 18
 #
16 19
 #        sms.example.tld    sms
17 20
 #
18
-# # arg1: phone number 
21
+# Dependencies :
22
+#
23
+#   * Email::Simple in libemail-simple-perl Debian package
24
+#
25
+# Usage :
26
+#
27
+#  mail2gnokii [phone number] [SMSC]
28
+#       Mail content is sent through STDIN
29
+#       SMSC is optionaly. If not provided, default value is used.
30
+#
19 31
 
20 32
 use Email::Simple;
21 33
 use Encode qw/encode decode/;
22 34