.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "Mail::Box::Locker::DotLock 3"
.TH Mail::Box::Locker::DotLock 3 2026-04-11 "perl v5.42.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Mail::Box::Locker::DotLock \- lock a folder with a separate file
.SH INHERITANCE
.IX Header "INHERITANCE"
.Vb 3
\& Mail::Box::Locker::DotLock
\&   is a Mail::Box::Locker
\&   is a Mail::Reporter
.Ve
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  See Mail::Box::Locker
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \f(CW\*(C`::DotLock\*(C'\fR object lock the folder by creating a file with the
same name as the folder, extended by \f(CW\*(C`.lock\*(C'\fR.
.PP
Extends "DESCRIPTION" in Mail::Box::Locker.
.SH METHODS
.IX Header "METHODS"
Extends "METHODS" in Mail::Box::Locker.
.SS Constructors
.IX Subsection "Constructors"
Extends "Constructors" in Mail::Box::Locker.
.ie n .IP $class\->\fBnew\fR(%options) 4
.el .IP \f(CW$class\fR\->\fBnew\fR(%options) 4
.IX Item "$class->new(%options)"
Name of the file to lock.  By default, the folder\*(Aqs name is extended
with \f(CW\*(C`.lock\*(C'\fR.
Improves base, see "METHODS" in Mail::Box::Locker
.Sp
.Vb 7
\& \-Option      \-\-Defined in       \-\-Default
\&  dotlock_file                     undef
\&  expires       Mail::Box::Locker  1 hour
\&  file          Mail::Box::Locker  <folderfile>.lock
\&  folder        Mail::Box::Locker  <C<undef>>
\&  method        Mail::Box::Locker  \*(AqDOTLOCK\*(Aq
\&  timeout       Mail::Box::Locker  10
.Ve
.RS 4
.ie n .IP "dotlock_file => $file" 2
.el .IP "dotlock_file => \f(CW$file\fR" 2
.IX Item "dotlock_file => $file"
Alternative name for \f(CW\*(C`file\*(C'\fR, especially useful to confusion when
the multi locker is used.
.ie n .IP "expires => $seconds" 2
.el .IP "expires => \f(CW$seconds\fR" 2
.IX Item "expires => $seconds"
.PD 0
.ie n .IP "file => $file" 2
.el .IP "file => \f(CW$file\fR" 2
.IX Item "file => $file"
.ie n .IP "folder => $folder" 2
.el .IP "folder => \f(CW$folder\fR" 2
.IX Item "folder => $folder"
.ie n .IP "method => $name|CLASS|\e@names" 2
.el .IP "method => \f(CW$name\fR|CLASS|\e@names" 2
.IX Item "method => $name|CLASS|@names"
.ie n .IP "timeout => $seconds|\*(AqNOTIMEOUT\*(Aq" 2
.el .IP "timeout => \f(CW$seconds\fR|\*(AqNOTIMEOUT\*(Aq" 2
.IX Item "timeout => $seconds|'NOTIMEOUT'"
.PD
.RE
.RS 4
.RE
.SS Attributes
.IX Subsection "Attributes"
Extends "Attributes" in Mail::Box::Locker.
.ie n .IP "$obj\->\fBexpires\fR( [SECONDS] )" 4
.el .IP "\f(CW$obj\fR\->\fBexpires\fR( [SECONDS] )" 4
.IX Item "$obj->expires( [SECONDS] )"
Inherited, see "Attributes" in Mail::Box::Locker
.ie n .IP "$obj\->\fBfilename\fR( [$filename] )" 4
.el .IP "\f(CW$obj\fR\->\fBfilename\fR( [$filename] )" 4
.IX Item "$obj->filename( [$filename] )"
Inherited, see "Attributes" in Mail::Box::Locker
.ie n .IP $obj\->\fBfolder\fR() 4
.el .IP \f(CW$obj\fR\->\fBfolder\fR() 4
.IX Item "$obj->folder()"
Inherited, see "Attributes" in Mail::Box::Locker
.ie n .IP $obj\->\fBname\fR() 4
.el .IP \f(CW$obj\fR\->\fBname\fR() 4
.IX Item "$obj->name()"
Inherited, see "Attributes" in Mail::Box::Locker
.ie n .IP "$obj\->\fBtimeout\fR( [SECONDS] )" 4
.el .IP "\f(CW$obj\fR\->\fBtimeout\fR( [SECONDS] )" 4
.IX Item "$obj->timeout( [SECONDS] )"
Inherited, see "Attributes" in Mail::Box::Locker
.SS Locking
.IX Subsection "Locking"
Extends "Locking" in Mail::Box::Locker.
.ie n .IP $obj\->\fBhasLock\fR() 4
.el .IP \f(CW$obj\fR\->\fBhasLock\fR() 4
.IX Item "$obj->hasLock()"
Inherited, see "Locking" in Mail::Box::Locker
.ie n .IP $obj\->\fBisLocked\fR() 4
.el .IP \f(CW$obj\fR\->\fBisLocked\fR() 4
.IX Item "$obj->isLocked()"
Inherited, see "Locking" in Mail::Box::Locker
.ie n .IP $obj\->\fBlock\fR() 4
.el .IP \f(CW$obj\fR\->\fBlock\fR() 4
.IX Item "$obj->lock()"
Inherited, see "Locking" in Mail::Box::Locker
.ie n .IP $obj\->\fBunlock\fR() 4
.el .IP \f(CW$obj\fR\->\fBunlock\fR() 4
.IX Item "$obj->unlock()"
Inherited, see "Locking" in Mail::Box::Locker
.SS "Error handling"
.IX Subsection "Error handling"
Extends "Error handling" in Mail::Box::Locker.
.ie n .IP $obj\->\fBAUTOLOAD\fR() 4
.el .IP \f(CW$obj\fR\->\fBAUTOLOAD\fR() 4
.IX Item "$obj->AUTOLOAD()"
Inherited, see "Error handling" in Mail::Reporter
.ie n .IP $obj\->\fBnotImplemented\fR() 4
.el .IP \f(CW$obj\fR\->\fBnotImplemented\fR() 4
.IX Item "$obj->notImplemented()"
Inherited, see "Error handling" in Mail::Reporter
.SS Cleanup
.IX Subsection "Cleanup"
Extends "Cleanup" in Mail::Box::Locker.
.ie n .IP $obj\->\fBDESTROY\fR() 4
.el .IP \f(CW$obj\fR\->\fBDESTROY\fR() 4
.IX Item "$obj->DESTROY()"
Inherited, see "Cleanup" in Mail::Box::Locker
.SH DIAGNOSTICS
.IX Header "DIAGNOSTICS"
.IP "Error: Dotlock requires a lock file name." 4
.IX Item "Error: Dotlock requires a lock file name."
Cast by \f(CWfolder()\fR
.ie n .IP "Error: class $package does not implement method $method." 4
.el .IP "Error: class \f(CW$package\fR does not implement method \f(CW$method\fR." 4
.IX Item "Error: class $package does not implement method $method."
Fatal error: the specific \f(CW$package\fR (or one of its superclasses) does not
implement this method where it should. This message means that some other
related classes do implement this method however the class at hand does
not.  Probably you should investigate this and probably inform the author
of the package.
Cast by \f(CWnotImplemented()\fR
.ie n .IP "Warning: couldn\*(Aqt remove lockfile $file: $!" 4
.el .IP "Warning: couldn\*(Aqt remove lockfile \f(CW$file:\fR $!" 4
.IX Item "Warning: couldn't remove lockfile $file: $!"
Cast by \f(CWunlock()\fR
.ie n .IP "Fault: failed to remove expired lockfile $file: $!" 4
.el .IP "Fault: failed to remove expired lockfile \f(CW$file:\fR $!" 4
.IX Item "Fault: failed to remove expired lockfile $file: $!"
Cast by \f(CWlock()\fR
.ie n .IP "Warning: folder already locked with file $file" 4
.el .IP "Warning: folder already locked with file \f(CW$file\fR" 4
.IX Item "Warning: folder already locked with file $file"
Cast by \f(CWlock()\fR
.ie n .IP "Fault: lockfile $file can never be created: $!" 4
.el .IP "Fault: lockfile \f(CW$file\fR can never be created: $!" 4
.IX Item "Fault: lockfile $file can never be created: $!"
Cast by \f(CWlock()\fR
.ie n .IP "Warning: removed expired lockfile $file" 4
.el .IP "Warning: removed expired lockfile \f(CW$file\fR" 4
.IX Item "Warning: removed expired lockfile $file"
Cast by \f(CWlock()\fR
.SH "SEE ALSO"
.IX Header "SEE ALSO"
This module is part of Mail\-Box version 4.02,
built on April 10, 2026. Website: \fIhttp://perl.overmeer.net/CPAN/\fR
.SH LICENSE
.IX Header "LICENSE"
For contributors see file ChangeLog.
.PP
This software is copyright (c) 2001\-2026 by Mark Overmeer.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.