Editing of man/mh-mail.man.

[nmh] / man / slocal.man

diff --git a/man/slocal.man b/man/slocal.man
index f1a2e39fda76d764e9126cfdf4c68a7a9e6aa7b7..fa6625e888c3fc23569d189dec6752b29808ba28 100644 (file)
--- a/man/slocal.man
+++ b/man/slocal.man
@@ -1,4 +1,4 @@
-.TH SLOCAL %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH SLOCAL %manext1% "May 2, 2016" "%nmhversion%"

 .\"
 .\" %nmhwarning%
 .\"
 .\"
 .\" %nmhwarning%
 .\"


@@ -7,8 +7,9 @@ slocal \- asynchronously filter and deliver new mail
 .SH SYNOPSIS
 .HP 5
 .na
 .SH SYNOPSIS
 .HP 5
 .na

-.B %libdir%/slocal
-[address\ info\ sender]
+.B %nmhlibexecdir%/slocal
+.RB [ \-help ]
+.RB [ \-version ]

 .RB [ \-addr
 .IR address ]
 .RB [ \-info
 .RB [ \-addr
 .IR address ]
 .RB [ \-info


@@ -27,11 +28,9 @@ slocal \- asynchronously filter and deliver new mail
 .RB [ \-verbose " | " \-noverbose ]
 .RB [ \-suppressdup " | " \-nosuppressdup ]
 .RB [ \-debug ]
 .RB [ \-verbose " | " \-noverbose ]
 .RB [ \-suppressdup " | " \-nosuppressdup ]
 .RB [ \-debug ]

-.RB [ \-version ]
-.RB [ \-help ]

 .ad
 .SH DESCRIPTION
 .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
 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


@@ -59,7 +58,7 @@ Under
 .BR sendmail ,
 the sender will obtained from the UUCP
 \*(lqFrom:\*(rq line, if present.  The user may override these
 .BR sendmail ,
 the sender will obtained from the UUCP
 \*(lqFrom:\*(rq line, if present.  The user may override these

-values with command line arguments, or arguments to the
+values with the

 .B \-addr
 and
 .B \-sender
 .B \-addr
 and
 .B \-sender


@@ -77,11 +76,11 @@ The
 switch tells
 .B slocal
 the name of the user for
 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
 .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.
 .PP
 .B slocal
 is able to detect and suppress duplicate messages.


@@ -127,7 +126,7 @@ support a \&.forward file for directing incoming mail.
 You should include the line
 .PP
 .ce
 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
 .PP
 in your \&.forward file in your home directory.  This will cause
 your MTA to invoke


@@ -140,7 +139,7 @@ file controls how
 .B slocal
 filters and delivers
 incoming mail.  Each line of this file consists of five fields, separated
 .B slocal
 filters and delivers
 incoming mail.  Each line of this file consists of five fields, separated

-by white-space or comma.  Since double-quotes are honored, these
+by whitespace or comma.  Since double-quotes are honored, these

 characters may be included in a single argument by enclosing the entire
 argument in double-quotes.  A double-quote can be included by preceding it
 with a backslash.  Lines beginning with `#' and blank lines are ignored.
 characters may be included in a single argument by enclosing the entire
 argument in double-quotes.  A double-quote can be included by preceding it
 with a backslash.  Lines beginning with `#' and blank lines are ignored.


@@ -259,7 +258,7 @@ Perform the action.  If the action succeeds, then the message
 is considered delivered.
 .TP \w'Azzz'u
 .I R
 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 ?
 the message is not considered delivered.
 .TP \w'Azzz'u
 .I ?


@@ -287,13 +286,13 @@ 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
 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
 This file is read according to the same rules.  This file must be

-owned by the root and must be writable only by the root.
+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
 .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
 .SS "Example Delivery File"
 To summarize, here's an example delivery file:
 .PP


@@ -328,7 +327,7 @@ From      steve     destroy A       \-
 default   \-        file    ?       mailbox
 
 # always run rcvtty
 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
 .fi
 .SS "Sub-process environment"
 When a process is invoked, its environment is: the user/group-ids are


@@ -361,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
 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
 .SH FILES
 .fc ^ ~
 .nf

-.ta \w'%etcdir%/ExtraBigFileName  'u
-^%etcdir%/mts.conf~^nmh mts configuration file
+.ta \w'%nmhetcdir%/ExtraBigFileName  'u
+^%nmhetcdir%/mts.conf~^nmh mts configuration file

 ^$HOME/\&.maildelivery~^The file controlling local delivery
 ^$HOME/\&.maildelivery~^The file controlling local delivery

-^%etcdir%/maildelivery~^Rather than the standard file
-^%mailspool%/$USER~^The default maildrop
+^%nmhetcdir%/maildelivery~^Rather than the standard file
+^%mailspool%/$USER~^The default mail drop

 .fi
 .SH "SEE ALSO"
 .IR rcvdist (1),
 .fi
 .SH "SEE ALSO"
 .IR rcvdist (1),


@@ -382,14 +381,20 @@ quicker delivery into your maildrop.
 .RB ` \-noverbose '
 .RB ` \-nosuppressdup '
 .RB ` \-maildelivery "' defaults to $HOME/\&.maildelivery"
 .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 ` \-file "' defaults to stdin"

+.RB ` \-addr "' defaults to the current user"

 .RB ` \-user "' defaults to the current user"
 .fi
 .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
 .SH CONTEXT
 None
 .SH HISTORY

-.B Slocal
+.B slocal

 was originally designed to be backward-compatible with
 the
 .B maildelivery
 was originally designed to be backward-compatible with
 the
 .B maildelivery


@@ -415,11 +420,11 @@ interpreted as the
 value
 .B RP_MECH
 (200), which means
 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
 .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
 was originally designed to be backwards-compatible with the
 .B maildelivery
 functionality provided by