Renamed -version switch to -Version to remove the conflict with -verbose.
[mmh] / man / slocal.man1
index c5cf7cf..914fd7b 100644 (file)
@@ -26,7 +26,7 @@ slocal \- asynchronously filter and deliver new mail
 .IR deliveryfile ]
 .RB [ \-verbose " | " \-noverbose ]
 .RB [ \-debug ]
-.RB [ \-version ]
+.RB [ \-Version ]
 .RB [ \-help ]
 .ad
 .SH DESCRIPTION
@@ -56,8 +56,8 @@ The message delivery address and message sender are determined from
 the Message Transfer Agent envelope information, if possible.
 Under
 .BR sendmail ,
-the sender will obtained from the UUCP
-\*(lqFrom:\*(rq line, if present.  The user may override these
+the sender will obtained from the mbox
+\*(lqFrom \*(rq line, if present.  The user may override these
 values with command line arguments, or arguments to the
 .B \-addr
 and
@@ -142,7 +142,7 @@ The format of each line in the
 file is:
 .PP
 .RS 5
-.B header      pattern action  result  string
+.B "header     pattern action  result  string
 .RE
 .PP
 .BR header :
@@ -184,12 +184,15 @@ and time that message was delivered.
 This action always succeeds.
 .TP 4
 .IR file ", " mbox ", or " >
-Append the message to the file named by
+Append the message to the mbox file named by
 .IR string .
-The message is
-appended to the file in mbox (uucp) format.  This is the format used by most
-other mail clients (such as mailx, elm).  If the message can be appended to
-the file, then this action succeeds.
+This is handled by piping the message to the
+.B nmh
+program
+.BR rcvpack .
+If
+.B rcvpack
+returned successful, then this action succeeds.
 .TP 4
 .IR pipe " or " |
 Pipe the message as the standard input to the command named by
@@ -230,11 +233,13 @@ Store the message in the
 .B nmh
 folder named by
 .IR string .
-Currently this is handled by piping the message to the
+This is handled by piping the message to the
 .B nmh
 program
-.BR rcvstore ,
-although this may change in the future.
+.BR rcvstore .
+If
+.B rcvstore
+returned successful, then this action succeeds.
 .RE
 .PP
 .BR result :
@@ -327,7 +332,9 @@ variables
 .BR $USER ,
 .BR $HOME ,
 .B $SHELL
-are set appropriately, and no other environment variables exist.
+are set appropriately,
+.B $PATH
+is preserved, but no other environment variables exist.
 .PP
 The process is given a certain amount of time to execute.  If the process
 does not exit within this limit, the process will be terminated with