summaryrefslogtreecommitdiff
path: root/doc/INSTRUCTION
diff options
context:
space:
mode:
Diffstat (limited to 'doc/INSTRUCTION')
-rw-r--r--doc/INSTRUCTION21
1 files changed, 12 insertions, 9 deletions
diff --git a/doc/INSTRUCTION b/doc/INSTRUCTION
index d4ffc69..921d8ee 100644
--- a/doc/INSTRUCTION
+++ b/doc/INSTRUCTION
@@ -61,15 +61,18 @@ And understand the following variables:
password <username> The password to give to the server.
Defaults to an empty string.
- log <path> Log information to the given file (note the file is
- appended to).
+ log <path> Logs deleted messages to the given file, which is
+ appended to. Note that non-deletion diagnostics go to
+ stderr.
If not used, or is an illegal path, logging is to
- stdout.
+ $HOME/.kbs-deletelog unless the variable is set to
+ a dash (-), in which case logging is disabled.
- delete_log <path> Logs deleted messages to the given file, which is
- appended to.
- If not used, or is an illegal path, logging is to
- $HOME/.kbs-deletelog.
+ verbose <on|off> Whether logging is verbose. If it's verbose then
+ the username, subject and a tailing report is generated.
+ If logging is not verbose, then just usernames are
+ logged.
+ Defaults to verbose (on).
timeout <seconds> Number of seconds to allow for no response from the
server.
@@ -89,7 +92,7 @@ And understand the following variables:
Defaults to off.
testmode <on|off> Whether things will be really deleted, or just
- the actions logged. Note that the delete_log is still
+ the actions logged. Note that the log is still
filled out as if the deletion occured.
Defaults to off, though it is recommended to use this
for early runs to ensure your rules are not too harsh
@@ -148,4 +151,4 @@ domain.
-------------------------------------------------------------------------------
-$Id: INSTRUCTION,v 1.1.1.1 2003-12-04 01:54:55 ianc Exp $
+$Id: INSTRUCTION,v 1.2 2003-12-05 02:33:05 ianc Exp $