.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'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 turned on, 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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "LockDev 3pm"
.TH LockDev 3pm "1999-12-01" "perl v5.14.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"
LockDev \- Perl extension to manage device lockfiles
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 5
\&  use LockDev;
\&  $pid = LockDev::dev_testlock( $device);
\&  $pid = LockDev::dev_lock( $device);
\&  $pid = LockDev::dev_relock( $device, $oldpid);
\&  $pid = LockDev::dev_unlock( $device, $oldpid);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The LockDev methods act on device locks normally located in /var/lock .
The lock is acquired creating a pair of files hardlinked between them
and named after the device name (as mandated by \s-1FSSTND\s0) and the device's
major and minor numbers (as in SVr4 locks). This permits to circumvent
a problem using only the \s-1FSSTND\s0 lock method when the same device exists
under different names (for convenience or when a device must be accessable
by more than one group of users).
.PP
The lock file names are typically in the form \s-1LCK\s0..ttyS1 and \s-1LCK\s0.004.065 ,
and their content is the pid of the process who owns the lock.
.SH "METHODS"
.IX Header "METHODS"
.Vb 1
\&  $pid = LockDev::dev_testlock( $device);
.Ve
.PP
This method simply checks if the device is in some way locked and if
the owner of the lock is still active (otherways it removes the lock).
It recognise a valid lock even if only one of the two lock files exists
(and is owned by an existing process), thus permitting a safe use of
this library toghether with programs using only \s-1FSSTND\s0 or SVr4 lock style.
.PP
.Vb 1
\&  $pid = LockDev::dev_lock( $device);
.Ve
.PP
This method first checks if the device is already locked and then tryes
to acquire the lock building the two lock files. First it creates the
file which name contains the major and minor numbers (in SVr4 style),
then it creates the file with the device name in its name. This order
reduces the clashes with other processes trying to lock the same device
(even with a different name) and using this library. It has no problem
with processes that uses only the \s-1FSSTND\s0 algorithm.
.PP
.Vb 1
\&  $pid = LockDev::dev_relock( $device, $oldpid);
.Ve
.PP
This method changes the owner of an existing lock; if the pid of the
old owner is provided, then it checks if the lock was correctly assigned
(otherways there is the possibility of a process acquiring a lock which
was owned by another unrelated process). If the device was not locked,
locks it.
.PP
.Vb 1
\&  $pid = LockDev::dev_unlock( $device, $oldpid);
.Ve
.PP
This method removes the existing locks on the device. If the pid of the
owner of the lock is provided, then it check if the locks are assigned
to that process, avoiding to remove locks assigned to other existing
processes.
.SH "RETURN VALUES"
.IX Header "RETURN VALUES"
All the methods in LockDev library return \s-1ZERO\s0 on successfull completion
of the function (LockDev::dev_testlock returns zero if there is no
lock on the device), otherways, if the device is currently locked by
an existing process, they return the pid of the process owner of the
lock.  They return a negative number when some kind of error happens.
Actually they all return only (\-1).
.SH "AUTHOR"
.IX Header "AUTHOR"
(c) 1997 by Fabrizio Polacco <fpolacco@icenet.fi>.  The LockDev extension
library and the liblockdev 'C' library are licensed under the \s-1FSF\s0's \s-1LGPL\s0.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIperl\fR\|(1), \fIlockdev\fR\|(3).