X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/77d3c96bffb51782a88ab203cfab4a142103db88..54fb590089a2bf43d7987861ba57acb17cebc150:/man/slocal.man

diff --git a/man/slocal.man b/man/slocal.man
index a7624241..1f9472ff 100644
--- a/man/slocal.man
+++ b/man/slocal.man
@@ -1,13 +1,15 @@
-.TH SLOCAL %manext1% "November 23, 2012" "%nmhversion%"
-.\"
+.TH SLOCAL %manext1% 2016-05-02 "%nmhversion%"
+.
 .\" %nmhwarning%
-.\"
+.
 .SH NAME
 slocal \- asynchronously filter and deliver new mail
 .SH SYNOPSIS
 .HP 5
 .na
-.B %libdir%/slocal
+.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
@@ -43,9 +43,9 @@ is invoked on your behalf by your system's Message Transfer Agent
 when the message arrives.
 .PP
 The message selection criteria used by
-.B slocal is specified
-in the file
-.RI \*(lq \&.maildelivery \*(rq
+.B slocal
+is specified in the file
+.RI \*(lq .maildelivery \*(rq
 in the user's home directory.
 You can specify an alternate file with the
 .B \-maildelivery
@@ -68,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 \*(lq .maildelivery \*(rq
 file.
 .PP
 The
@@ -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.
@@ -109,12 +109,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 \*(lq .maildelivery \*(rq
 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 \*(lq .maildelivery \*(rq
 file.
 .SS "Message Transfer Agents"
 Most modern MTAs including
@@ -126,7 +126,7 @@ support a \&.forward file for directing incoming mail.
 You should include the line
 .PP
 .ce
-\*(lq|\ %libdir%/slocal\ \-user\ username\*(rq
+\*(lq|\ %nmhlibexecdir%/slocal\ \-user\ username\*(rq
 .PP
 in your \&.forward file in your home directory.  This will cause
 your MTA to invoke
@@ -134,7 +134,7 @@ your MTA to invoke
 on your behalf when a message arrives.
 .SS "The Maildelivery File"
 The
-.RI \*(lq \&.maildelivery \*(rq
+.RI \*(lq .maildelivery \*(rq
 file controls how
 .B slocal
 filters and delivers
@@ -145,7 +145,7 @@ 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 \*(lq .maildelivery \*(rq
 file is:
 .PP
 .RS 5
@@ -168,7 +168,7 @@ the address that was used to cause delivery to the recipient
 .TP \w'defaultrrr'u
 .I default
 this matches
-.B only
+.I only
 if the message hasn't been delivered yet
 .TP \w'defaultrrr'u
 .I *
@@ -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 ?
@@ -275,24 +275,24 @@ can be made and several actions can be taken.
 .RE
 .SS "Security of Delivery Files"
 In order to prevent security problems, the
-.RI \*(lq \&.maildelivery \*(rq
+.RI \*(lq .maildelivery \*(rq
 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 \*(lq .maildelivery \*(rq
 file cannot be found, or does not
 perform an action which delivers the message, then
 .B slocal
 will check for a global delivery file at
-.IR %etcdir%/maildelivery .
+.IR %nmhetcdir%/maildelivery .
 This file is read according to the same rules.  This file must be
 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
@@ -327,7 +327,7 @@ From      steve     destroy A       \-
 default   \-        file    ?       mailbox
 
 # always run rcvtty
-*         \-        pipe    R       %libdir%/rcvtty
+*         \-        pipe    R       %nmhlibexecdir%/rcvtty
 .fi
 .SS "Sub-process environment"
 When a process is invoked, its environment is: the user/group-ids are
@@ -360,15 +360,15 @@ 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
-.ta \w'%etcdir%/ExtraBigFileName  'u
-^%etcdir%/mts.conf~^nmh mts configuration file
-^$HOME/\&.maildelivery~^The file controlling local delivery
-^%etcdir%/maildelivery~^Rather than the standard file
-^%mailspool%/$USER~^The default maildrop
+.ta \w'%nmhetcdir%/ExtraBigFileName  'u
+^%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 mail drop
 .fi
 .SH "SEE ALSO"
 .IR rcvdist (1),
@@ -380,22 +380,28 @@ quicker delivery into your maildrop.
 .nf
 .RB ` \-noverbose '
 .RB ` \-nosuppressdup '
-.RB ` \-maildelivery "' defaults to $HOME/\&.maildelivery"
-.RB ` \-mailbox "' deaults to %mailspool%/$USER"
+.RB ` \-maildelivery "' defaults to $HOME/.maildelivery"
+.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
 facility provided by
 .BR MMDF-II .
 Thus, the
-.RI \*(lq \&.maildelivery \*(rq
+.RI \*(lq .maildelivery \*(rq
 file syntax is somewhat limited.  But
 .B slocal
 has been modified and extended, so that is it no longer compatible with
@@ -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