From: Thomas Roessler <roessler@does-not-exist.org>
Date: Wed, 1 Mar 2000 10:52:28 +0000 (+0000)
Subject: dotlock is called mutt_dotlock for quite some time now.
X-Git-Tag: mutt-1-1-8-rel~21
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=83c8caa08fd6d1a7f89a31e35c467f48281a7ff3;p=mutt

dotlock is called mutt_dotlock for quite some time now.
---

diff --git a/doc/dotlock.man b/doc/dotlock.man
index 18b55bbf..a89ec427 100644
--- a/doc/dotlock.man
+++ b/doc/dotlock.man
@@ -28,7 +28,7 @@ mutt_dotlock \- Lock mail spool files.
 [-t|-f|-u|-d] [-p] [-r \fIretries\fP] \fIfile\fP
 .SH DESCRIPTION
 .PP
-.B dotlock
+.B mutt_dotlock
 implements the traditional mail spool file locking method:
 To lock \fIfile\fP, a file named \fIfile\fP.lock is
 created. The program operates with group mail privileges
@@ -37,43 +37,43 @@ if necessary.
 .PP
 .IP "-t"
 Just try.
-.B dotlock
+.B mutt_dotlock
 won't actually lock a file, but inform the invoking
 process if it's at all possible to lock \fIfile\fP.
 .IP "-f"
 Force the lock.  If another process holds a lock on
 \fIfile\fP longer than a certain amount of time, 
-.B dotlock
+.B mutt_dotlock
 will break that lock by removing the lockfile.
 .IP "-u"
 Unlock.
-.B dotlock 
+.B mutt_dotlock 
 will remove \fIfile\fP.lock.
 .IP "-d"
 Delete.
-.B dotlock
+.B mutt_dotlock
 will lock \fIfile\fP, remove it if it has length 0, and afterwards
 remove \fIfile\fP.lock.
 .IP "-p"
 Use privileges.  If given this option, 
-.B dotlock
+.B mutt_dotlock
 will operate with group mail privileges when creating and
 deleting lock files.
 .IP "-r \fIretries\fP"
 This command line option tells 
-.B dotlock 
+.B mutt_dotlock 
 to try locking
 \fIretries\fP times before giving up or (if invoked with
 the 
 .B -f
 command line option) break a lock.  The default value is 5.
-.B dotlock
+.B mutt_dotlock
 waits one second between successive locking attempts.  
 .SH FILES
 .PP
 .IP "\fIfile\fP.lock"
 The lock file 
-.B dotlock
+.B mutt_dotlock
 generates.
 .SH SEE ALSO
 .PP
@@ -83,7 +83,7 @@ generates.
 .BR mutt (1)
 .SH DIAGNOSTICS
 .PP
-.B dotlock
+.B mutt_dotlock
 gives all diagnostics in its return values:
 .TP
 .B "0 \- DL_EX_OK"
@@ -97,44 +97,46 @@ lack of system memory and the like has occured.
 The 
 user wants to lock a file which has been locked by
 another process already.  If 
-.B dotlock
+.B mutt_dotlock
 is invoked with the
 .B -f 
 command line option, 
-.B dotlock
+.B mutt_dotlock
 won't generate this error, but break other processes'
 locks.
 .TP 
 .B "4 \- DL_EX_NEED_RPIVS"
 This return value only occurs if 
-.B dotlock 
+.B mutt_dotlock 
 has been invoked
 with the 
 .B -t
 command line option.  It means that
-.B dotlock
+.B mutt_dotlock
 will have to use its group mail privileges to lock
 \fIfile\fP.
 .TP
 .B "5 \- DL_EX_IMPOSSIBLE"
 This return value only occurs if
-.B dotlock
+.B mutt_dotlock
 has been invoked with the
 .B -t
 command line option.  It means that
-.B dotlock 
+.B mutt_dotlock 
 is unable to lock \fIfile\fP even with group mail
 privileges.
 .SH NOTES
 .PP
-.B dotlock
+.B mutt_dotlock
 tries to implement an NFS-safe dotlocking method which was
 borrowed from 
 .B lockfile
 (1).  
 .PP
 If the user can't open \fIfile\fP for reading with his
-normal privileges, dotlock will return the
+normal privileges, 
+.B mutt_dotlock 
+will return the
 .B DL_EX_ERROR
 exit value to avoid certain attacks against other users'
 spool files. The code carefully avoids race conditions
@@ -142,7 +144,7 @@ when checking permissions; for details of all this see the
 comments in dotlock.c.
 .SH HISTORY
 .PP
-.B dotlock
+.B mutt_dotlock
 is part of the Mutt mail user agent package.  It has been
 created to avoid running mutt with group mail privileges.
 .SH AUTHOR
diff --git a/doc/mutt.man b/doc/mutt.man
index 6fe7980f..748f3145 100644
--- a/doc/mutt.man
+++ b/doc/mutt.man
@@ -145,7 +145,7 @@ GNU General Public License for more details.
 .PP
 .BR muttrc (5),
 .BR curses (3),
-.BR dotlock (1),
+.BR mutt_dotlock (1),
 .BR ncurses (3),
 .BR sendmail (1),
 .BR smail (1),