]> diplodocus.org Git - nmh/blobdiff - man/slocal.man
Editing of man/mh-mail.man.
[nmh] / man / slocal.man
index 53f9314a3ff2aaece3c86812b51fda0616270042..fa6625e888c3fc23569d189dec6752b29808ba28 100644 (file)
@@ -1,4 +1,4 @@
-.TH SLOCAL %manext1% "November 23, 2012" "%nmhversion%"
+.TH SLOCAL %manext1% "May 2, 2016" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
@@ -8,6 +8,8 @@ slocal \- asynchronously filter and deliver new mail
 .HP 5
 .na
 .B %nmhlibexecdir%/slocal
+.RB [ \-help ]
+.RB [ \-version ]
 .RB [ \-addr
 .IR address ]
 .RB [ \-info
@@ -26,11 +28,9 @@ slocal \- asynchronously filter and deliver new mail
 .RB [ \-verbose " | " \-noverbose ]
 .RB [ \-suppressdup " | " \-nosuppressdup ]
 .RB [ \-debug ]
-.RB [ \-version ]
-.RB [ \-help ]
 .ad
 .SH DESCRIPTION
-.B Slocal
+.B slocal
 is a program designed to allow you to have your inbound
 mail processed according to a complex set of selection criteria.
 You do not normally invoke
@@ -76,11 +76,11 @@ The
 switch tells
 .B slocal
 the name of the user for
-whom it is delivering mail.  The
+whom it is delivering mail.  It must exist on the local system.  The
 .B \-mailbox
 switch tells
 .B slocal
-the name of the user's maildrop file.
+the name of the user's mail drop file.
 .PP
 .B slocal
 is able to detect and suppress duplicate messages.
@@ -258,7 +258,7 @@ Perform the action.  If the action succeeds, then the message
 is considered delivered.
 .TP \w'Azzz'u
 .I R
-Perform the action. Regardless of the outcome of the action,
+Perform the action.  Regardless of the outcome of the action,
 the message is not considered delivered.
 .TP \w'Azzz'u
 .I ?
@@ -292,7 +292,7 @@ owned by root and must be writable only by root.
 .PP
 If a global delivery file cannot be found or does not perform an
 action which delivers the message, then standard delivery to the
-user's maildrop is performed.
+user's mail drop is performed.
 .SS "Example Delivery File"
 To summarize, here's an example delivery file:
 .PP
@@ -360,7 +360,7 @@ value immediately, and the child could continue on, doing whatever it
 wanted for as long as it wanted.  This approach is somewhat risky if
 the parent is going to return an exit status of zero.  If the parent is
 going to return a non-zero exit status, then this approach can lead to
-quicker delivery into your maildrop.
+quicker delivery into your mail drop.
 .SH FILES
 .fc ^ ~
 .nf
@@ -368,7 +368,7 @@ quicker delivery into your maildrop.
 ^%nmhetcdir%/mts.conf~^nmh mts configuration file
 ^$HOME/\&.maildelivery~^The file controlling local delivery
 ^%nmhetcdir%/maildelivery~^Rather than the standard file
-^%mailspool%/$USER~^The default maildrop
+^%mailspool%/$USER~^The default mail drop
 .fi
 .SH "SEE ALSO"
 .IR rcvdist (1),
@@ -381,14 +381,20 @@ quicker delivery into your maildrop.
 .RB ` \-noverbose '
 .RB ` \-nosuppressdup '
 .RB ` \-maildelivery "' defaults to $HOME/\&.maildelivery"
-.RB ` \-mailbox "' deaults to %mailspool%/$USER"
+.RB ` \-mailbox "' defaults to %mailspool%/$USER"
 .RB ` \-file "' defaults to stdin"
+.RB ` \-addr "' defaults to the current user"
 .RB ` \-user "' defaults to the current user"
 .fi
+.PP
+.B \-addr
+and
+.B \-user
+will be set the the user part of the Local-Mailbox profile entry, if set.
 .SH CONTEXT
 None
 .SH HISTORY
-.B Slocal
+.B slocal
 was originally designed to be backward-compatible with
 the
 .B maildelivery
@@ -414,11 +420,11 @@ interpreted as the
 value
 .B RP_MECH
 (200), which means
-\*(lquse an alternate route\*(rq (deliver the message to the maildrop).
+\*(lquse an alternate route\*(rq (deliver the message to the mail drop).
 .SH BUGS
 Only two return codes are meaningful, others should be.
 .PP
-.B Slocal
+.B slocal
 was originally designed to be backwards-compatible with the
 .B maildelivery
 functionality provided by