Factor trim format function out
[mmh] / man / slocal.man1
index e2b6051..8779c0c 100644 (file)
@@ -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
@@ -46,7 +45,7 @@ when the message arrives.
 The message selection criteria used by
 .B slocal is specified
 in the file
-.RI \*(lq \&.maildelivery \*(rq
+.RI ` \&.maildelivery '
 in the user's home directory.
 You can specify an alternate file with the
 .B \-maildelivery
@@ -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
+`From ' line, if present.  The user may override these
 values with command line arguments, or arguments to the
 .B \-addr
 and
@@ -69,7 +68,7 @@ The message is normally read from the standard input.  The
 .B \-file
 switch sets the name of the file from which the message should be
 read, instead of reading stdin.  This is useful when debugging a
-.RI \*(lq \&.maildelivery \*(rq
+.RI ` \&.maildelivery '
 file.
 .PP
 The
@@ -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
@@ -110,12 +99,12 @@ stdout about its progress.  The
 switch produces more
 verbose debugging output on stderr.  These flags are useful when
 creating and debugging your
-.RI \*(lq \&.maildelivery \*(rq
+.RI ` \&.maildelivery '
 file, as they
 allow you to see the decisions and actions that
 .B slocal
 is taking, as well as check for syntax errors in your
-.RI \*(lq \&.maildelivery \*(rq
+.RI ` \&.maildelivery '
 file.
 
 .SS "Message Transfer Agents"
@@ -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
+`|\ %bindir%/slocal\ \-user\ username'
 .RE
 .PP
 in your \&.forward file in your home directory.  This will cause
@@ -138,7 +127,7 @@ on your behalf when a message arrives.
 
 .SS "The Maildelivery File"
 The
-.RI \*(lq \&.maildelivery \*(rq
+.RI ` \&.maildelivery '
 file controls how
 .B slocal
 filters and delivers
@@ -149,11 +138,11 @@ argument in double-quotes.  A double-quote can be included by preceding it
 with a backslash.  Lines beginning with `#' and blank lines are ignored.
 .PP
 The format of each line in the
-.RI \*(lq \&.maildelivery \*(rq
+.RI ` \&.maildelivery '
 file is:
 .PP
 .RS 5
-.B header      pattern action  result  string
+.B "header     pattern action  result  string
 .RE
 .PP
 .BR header :
@@ -188,19 +177,22 @@ Matching is case-insensitive, but does not use regular expressions.
 .BR action :
 .RS 5
 The action to take to deliver the message.  When a message is delivered,
-a \*(lqDelivery\-Date:\ date\*(rq header is added which indicates the date
+a `Delivery\-Date:\ date' header is added which indicates the date
 and time that message was delivered.
 .TP 4
 .I destroy
 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 mmh
+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
@@ -222,7 +214,7 @@ $(size)
 the size of the message in bytes
 .TP \w'zzreplyztozaaa'u
 $(reply\-to)
-either the \*(lqReply\-To:\*(rq or \*(lqFrom:\*(rq field of the message
+either the `Reply\-To:' or `From:' field of the message
 .TP \w'zzreplyztozaaa'u
 $(info)
 the out-of-band information specified
@@ -238,14 +230,16 @@ which your shell might interpret.
 .TP 4
 .IR folder " or " +
 Store the message in the
-.B nmh
+.B mh
 folder named by
 .IR string .
-Currently this is handled by piping the message to the
-.B nmh
+This is handled by piping the message to the
+.B mmh
 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 :
@@ -275,13 +269,13 @@ can be made and several actions can be taken.
 
 .SS "Security of Delivery Files"
 In order to prevent security problems, the
-.RI \*(lq \&.maildelivery \*(rq
+.RI ` \&.maildelivery '
 file must be owned either by the user or by root, and must be
 writable only by the owner.  If this is not the case, the file is
 not read.
 .PP
 If the
-.RI \*(lq \&.maildelivery \*(rq
+.RI ` \&.maildelivery '
 file cannot be found, or does not
 perform an action which delivers the message, then
 .B slocal
@@ -300,20 +294,20 @@ To summarize, here's an example delivery file:
 .nf
 .ta \w'default  'u +\w'mh-workersxx 'uC +\w'destroy 'uC +\w'result 'u
 #
-# .maildelivery file for nmh's slocal
+# .maildelivery file for mmh's slocal
 #
 # Blank lines and lines beginning with a '#' are ignored
 #
 # FIELD   PATTERN   ACTION  RESULT  STRING
 #
 
-# File mail with foobar in the \*(lqTo:\*(rq line into file foobar.log
+# File mail with foobar in the `To:' line into file foobar.log
 To        foobar    file    A       foobar.log
 
 # Pipe messages from coleman to the program message-archive
 From      coleman   pipe    A       /bin/message-archive
 
-# Anything to the \*(lqnmh-workers\*(rq mailing list is put in
+# Anything to the `nmh-workers' mailing list is put in
 # its own folder, if not filed already
 To        nmh-workers  folder ?     nmh-workers
 
@@ -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"
@@ -387,7 +379,9 @@ rcvdist(1), rcvpack(1), rcvstore(1), rcvtty(1), mh\-format(5)
 .fi
 
 .SH CONTEXT
-None
+.B slocal
+does neither read nor change the context.
+Nor does it read the user profile.
 
 .SH HISTORY
 .B Slocal
@@ -397,7 +391,7 @@ the
 facility provided by
 .BR MMDF-II .
 Thus, the
-.RI \*(lq \&.maildelivery \*(rq
+.RI ` \&.maildelivery '
 file syntax is somewhat limited.  But
 .B slocal
 has been modified and extended, so that is it no longer compatible with
@@ -416,7 +410,10 @@ interpreted as the
 value
 .B RP_MECH
 (200), which means
-\*(lquse an alternate route\*(rq (deliver the message to the maildrop).
+`use an alternate route' (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.