]> diplodocus.org Git - nmh/blobdiff - man/slocal.man
Replace getcpy() with mh_xstrdup() where the string isn't NULL.
[nmh] / man / slocal.man
index cc0f4ceb4ed78d6e7cece7d20d016234c2dda4df..1d8abf8949c43574ccbb8947c48d7770042b43be 100644 (file)
@@ -1,4 +1,4 @@
-.TH SLOCAL %manext1% "January 16, 2006" "%nmhversion%"
+.TH SLOCAL %manext1% "May 2, 2016" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
@@ -7,8 +7,9 @@ slocal \- asynchronously filter and deliver new mail
 .SH SYNOPSIS
 .HP 5
 .na
-.B %libdir%/slocal
-[address\ info\ sender]
+.B %nmhlibexecdir%/slocal
+.RB [ \-help ]
+.RB [ \-version ]
 .RB [ \-addr
 .IR address ]
 .RB [ \-info
@@ -27,8 +28,6 @@ slocal \- asynchronously filter and deliver new mail
 .RB [ \-verbose " | " \-noverbose ]
 .RB [ \-suppressdup " | " \-nosuppressdup ]
 .RB [ \-debug ]
-.RB [ \-version ]
-.RB [ \-help ]
 .ad
 .SH DESCRIPTION
 .B Slocal
@@ -59,7 +58,7 @@ Under
 .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
@@ -77,7 +76,7 @@ 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
@@ -127,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
@@ -140,7 +139,7 @@ file controls how
 .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.
@@ -259,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 ?
@@ -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
-.IR %etcdir%/maildelivery .
+.IR %nmhetcdir%/maildelivery .
 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
@@ -328,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
@@ -365,10 +364,10 @@ quicker delivery into your maildrop.
 .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
-^%etcdir%/maildelivery~^Rather than the standard file
+^%nmhetcdir%/maildelivery~^Rather than the standard file
 ^%mailspool%/$USER~^The default maildrop
 .fi
 .SH "SEE ALSO"
@@ -384,8 +383,14 @@ quicker delivery into your maildrop.
 .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
+.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