Renamed -version switch to -Version to remove the conflict with -verbose.

[mmh] / man / slocal.man1

diff --git a/man/slocal.man1 b/man/slocal.man1
index e2b6051..914fd7b 100644 (file)
--- a/man/slocal.man1
+++ b/man/slocal.man1
@@ -7,7 +7,7 @@ slocal \- asynchronously filter and deliver new mail
 .SH SYNOPSIS
 .HP 5
 .na
-.B %libdir%/slocal
+.B slocal
 [address\ info\ sender]
 .RB [ \-addr
 .IR address ]
@@ -25,9 +25,8 @@ slocal \- asynchronously filter and deliver new mail
 .RB [ \-maildelivery
 .IR deliveryfile ]
 .RB [ \-verbose " | " \-noverbose ]
-.RB [ \-suppressdup " | " \-nosuppressdup ]
 .RB [ \-debug ]
-.RB [ \-version ]
+.RB [ \-Version ]
 .RB [ \-help ]
 .ad
 .SH DESCRIPTION
@@ -57,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
@@ -83,16 +82,6 @@ switch tells
 .B slocal
 the name of the user's maildrop file.
 .PP
-.B slocal
-is able to detect and suppress duplicate messages.
-To enable this, use the option
-.BR \-suppressdup .
-.B slocal
-will
-keep a database containing the Message-ID's of incoming messages,
-in order to detect duplicates.  Depending on your configuration,
-this database will be in either ndbm or Berkeley db format.
-.PP
 The
 .B \-info
 switch may be used to pass an arbitrary argument to
@@ -128,7 +117,7 @@ support a \&.forward file for directing incoming mail.
 You should include the line
 .PP
 .RS 5
-\*(lq|\ %libdir%/slocal\ \-user\ username\*(rq
+\*(lq|\ %bindir%/slocal\ \-user\ username\*(rq
 .RE
 .PP
 in your \&.forward file in your home directory.  This will cause
@@ -153,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 :
@@ -195,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
@@ -241,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 :
@@ -326,9 +320,6 @@ From      steve     destroy A       \-
 
 # Put anything not matched yet into mailbox
 default   \-        file    ?       mailbox
-
-# always run rcvtty
-*         \-        pipe    R       %libdir%/rcvtty
 .fi
 
 .SS "Sub-process environment"
@@ -341,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
@@ -374,12 +367,11 @@ quicker delivery into your maildrop.
 .fi
 
 .SH "SEE ALSO"
-rcvdist(1), rcvpack(1), rcvstore(1), rcvtty(1), mh\-format(5)
+rcvdist(1), rcvpack(1), rcvstore(1), mh\-format(5)
 
 .SH DEFAULTS
 .nf
 .RB ` \-noverbose '
-.RB ` \-nosuppressdup '
 .RB ` \-maildelivery "' defaults to $HOME/\&.maildelivery"
 .RB ` \-mailbox "' deaults to %mailspool%/$USER"
 .RB ` \-file "' defaults to stdin"
@@ -417,6 +409,9 @@ value
 .B RP_MECH
 (200), which means
 \*(lquse an alternate route\*(rq (deliver the message to the maildrop).
+.PP
+The `suppress duplicates' function had been removed from slocal for
+simplicity reasons.
 
 .SH BUGS
 Only two return codes are meaningful, others should be.