More roundup-mailgw usage help.

Author: Richard Jones

roundup-mailgw

@@ -16,7 +16,7 @@
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 # 
-# $Id: roundup-mailgw,v 1.10 2001-11-07 05:30:11 richard Exp $
+# $Id: roundup-mailgw,v 1.11 2001-11-07 05:32:58 richard Exp $
 
 import sys
 if int(sys.version[0]) < 2:
@@ -31,6 +31,18 @@ else:
     instance_home = os.environ.get('ROUNDUP_INSTANCE', '')
 if not instance_home:
     print 'Usage: %s <instance home> [mail spool file]'%sys.argv[0]
+    print '''
+The roundup mail gateway may be called in one of two ways:
+ . with an instance home as the only argument, or
+ . with both an instance home and a mail spool file.
+
+In the first case, the mail gateway reads a single message from the
+standard input and submits the message to the roundup.mailgw module.
+
+In the second case, the gateway reads all messages from the mail spool
+file and submits each in turn to the roundup.mailgw module. The file is
+emptied once all messages have been successfully handled.
+'''
     sys.exit(1)
 
 # get the instance
@@ -73,6 +85,9 @@ fcntl.flock(f.fileno(), FCNTL.LOCK_UN)
 
 #
 # $Log: not supported by cvs2svn $
+# Revision 1.10  2001/11/07 05:30:11  richard
+# Nicer usage message.
+#
 # Revision 1.9  2001/11/07 05:29:26  richard
 # Modified roundup-mailgw so it can read e-mails from a local mail spool
 # file. Truncates the spool file after parsing.