summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--guimb/scm/README27
1 files changed, 22 insertions, 5 deletions
diff --git a/guimb/scm/README b/guimb/scm/README
index fb463ad84..9de7cfa33 100644
--- a/guimb/scm/README
+++ b/guimb/scm/README
@@ -1,8 +1,25 @@
-To convert a sieve script into equivalent Scheme program, executable
-by guimb, run:
+To convert a sieve script into equivalent Scheme program, run:
- guile -s sieve.scm --file <sieve-script-name> --output <output-file-name>
+ sieve.scm --file <sieve-script-name> --output <scm-file-name>
-To compile and execute a sieve script upon a mailbox, run:
+The produced script can then be run as:
+
+ guile -s <scm-file-name> [MAILBOX]
+
+ If MAILBOX is not given, the script will operate upon the user's system
+mailbox.
+
+ To invoke the script directly by its name, add executable bit to its
+permissions.
+
+ The same script may be used by mail.local to sieve the incoming mail upon
+its arrival, see node "Programs -> mail.local" in the accompanying
+documentation for more information on this.
+
+ To execute the sieve script directly, without saving the produced Scheme
+text to a file, run:
+
+ sieve.scm --file <sieve-script-name> [MAILBOX]
+
+The semantics of MAILBOX argument is described above.
- guimb -f sieve.scm -{ --file <sieve-script-name> -} --mailbox ~/mbox

Return to:

Send suggestions and report system problems to the System administrator.