]> diplodocus.org Git - nmh/blobdiff - man/slocal.man
Remove unused NCWD and NPWD #defines.
[nmh] / man / slocal.man
index f1a2e39fda76d764e9126cfdf4c68a7a9e6aa7b7..302dfd28b21bf200f7fd469b9cda58ac490b66af 100644 (file)
@@ -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,7 +76,7 @@ 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
@@ -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,9 +286,9 @@ 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
@@ -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
@@ -365,10 +364,10 @@ quicker delivery into your maildrop.
 .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
+^%nmhetcdir%/maildelivery~^Rather than the standard file
 ^%mailspool%/$USER~^The default maildrop
 .fi
 .SH "SEE ALSO"
 ^%mailspool%/$USER~^The default maildrop
 .fi
 .SH "SEE ALSO"
@@ -384,12 +383,18 @@ quicker delivery into your maildrop.
 .RB ` \-maildelivery "' defaults to $HOME/\&.maildelivery"
 .RB ` \-mailbox "' deaults to %mailspool%/$USER"
 .RB ` \-file "' defaults to stdin"
 .RB ` \-maildelivery "' defaults to $HOME/\&.maildelivery"
 .RB ` \-mailbox "' deaults to %mailspool%/$USER"
 .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
@@ -419,7 +424,7 @@ value
 .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