X-Git-Url: http://git.madism.org/?p=apps%2Fmadmutt.git;a=blobdiff_plain;f=doc%2Fdotlock.man;h=73a6a21c7063d2059dd454b027b71b26e7669af0;hp=646eab659dbdaad23a39418db9c82b07bc2849e0;hb=daf6df95bfcc7efc888b488a825e467268f20d3c;hpb=fad91a52c8feae82875ce8a78cddd67253124655 diff --git a/doc/dotlock.man b/doc/dotlock.man index 646eab6..73a6a21 100644 --- a/doc/dotlock.man +++ b/doc/dotlock.man @@ -16,18 +16,18 @@ .\" .\" You should have received a copy of the GNU General Public License .\" along with this program; if not, write to the Free Software -.\" Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA. +.\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. .\" .TH dotlock 1 "AUGUST 1999" Unix "User Manuals" .SH NAME -muttng_dotlock \- Lock mail spool files. +madmutt_dotlock \- Lock mail spool files. .SH SYNOPSIS .PP -.B muttng_dotlock +.B madmutt_dotlock [-t|-f|-u|-d] [-p] [-r \fIretries\fP] \fIfile\fP .SH DESCRIPTION .PP -.B muttng_dotlock +.B madmutt_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 @@ -36,53 +36,53 @@ if necessary. .PP .IP "-t" Just try. -.B muttng_dotlock +.B madmutt_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 muttng_dotlock +.B madmutt_dotlock will break that lock by removing the lockfile. .IP "-u" Unlock. -.B muttng_dotlock +.B madmutt_dotlock will remove \fIfile\fP.lock. .IP "-d" Delete. -.B muttng_dotlock +.B madmutt_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 muttng_dotlock +.B madmutt_dotlock will operate with group mail privileges when creating and deleting lock files. .IP "-r \fIretries\fP" This command line option tells -.B muttng_dotlock +.B madmutt_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 muttng_dotlock +.B madmutt_dotlock waits one second between successive locking attempts. .SH FILES .PP .IP "\fIfile\fP.lock" The lock file -.B muttng_dotlock +.B madmutt_dotlock generates. .SH SEE ALSO .PP .BR fcntl (2), .BR flock (2), .BR lockfile (1), -.BR muttng (1) +.BR madmutt (1) .SH DIAGNOSTICS .PP -.B muttng_dotlock +.B madmutt_dotlock gives all diagnostics in its return values: .TP .B "0 \- DL_EX_OK" @@ -96,37 +96,37 @@ 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 muttng_dotlock +.B madmutt_dotlock is invoked with the .B -f command line option, -.B muttng_dotlock +.B madmutt_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 muttng_dotlock +.B madmutt_dotlock has been invoked with the .B -t command line option. It means that -.B muttng_dotlock +.B madmutt_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 muttng_dotlock +.B madmutt_dotlock has been invoked with the .B -t command line option. It means that -.B muttng_dotlock +.B madmutt_dotlock is unable to lock \fIfile\fP even with group mail privileges. .SH NOTES .PP -.B muttng_dotlock +.B madmutt_dotlock tries to implement an NFS-safe dotlocking method which was borrowed from .B lockfile @@ -134,7 +134,7 @@ borrowed from .PP If the user can't open \fIfile\fP for reading with his normal privileges, -.B muttng_dotlock +.B madmutt_dotlock will return the .B DL_EX_ERROR exit value to avoid certain attacks against other users' @@ -143,8 +143,8 @@ when checking permissions; for details of all this see the comments in dotlock.c. .SH HISTORY .PP -.B muttng_dotlock -is part of the Mutt-ng mail user agent package. It has been -created to avoid running mutt with group mail privileges. +.B madmutt_dotlock +is part of the Madmutt mail user agent package. It has been +created to avoid running Madmutt with group mail privileges. .SH AUTHOR -Thomas Roessler +Thomas Roessler , Nico Golde >