.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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" ''
.    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
.\"
.\" 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 "SHLOCK 1"
.TH SHLOCK 1 "2022-07-10" "INN 2.7.2" "InterNetNews 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"
shlock \- Create lock files for use in shell scripts
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBshlock\fR [\fB\-b\fR|\fB\-c\fR|\fB\-u\fR] \fB\-f\fR \fIname\fR \fB\-p\fR \fIpid\fR
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBshlock\fR tries to create a lock file named \fIname\fR and write
the process \s-1ID\s0 \fIpid\fR into it.  If the file already exists, \fBshlock\fR
will read the process \s-1ID\s0 from the file and test to see whether
the process is currently running.  If the process exists, then the file
will not be created.  \fIshlock\fR exits with a zero status if it could
create the lock file, or non-zero if the file refers to a currently
active process.
.PP
A Perl wrapper around \fBshlock\fR can be used via the \f(CW\*(C`INN::Utils::Shlock\*(C'\fR
module.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-b\fR" 4
.IX Item "-b"
Process IDs are normally read and written in \s-1ASCII.\s0  If the \fB\-b\fR flag
is used, then they will be written as a binary int.
.IP "\fB\-c\fR" 4
.IX Item "-c"
If the \fB\-c\fR flag is used, then \fBshlock\fR will not create a lock file,
but will instead use the file to see if the lock is held by another program.
If the lock is valid, the program will exit with a non-zero status;
if the lock is not valid (i.e. invoking \fBshlock\fR without the flag would
have succeeded), then the program will exit with a zero status.
.IP "\fB\-f\fR \fIname\fR" 4
.IX Item "-f name"
\&\fIname\fR is the name of the lock file \fBshlock\fR attempts to create.
If the file already exists, it will read the process \s-1ID\s0 from the file
and exit with a non-zero status if this process is currently active.
.IP "\fB\-p\fR \fIpid\fR" 4
.IX Item "-p pid"
\&\fIpid\fR is the process \s-1ID\s0 to write into the file \fIname\fR.
.IP "\fB\-u\fR" 4
.IX Item "-u"
For compatibility with other systems, the \fB\-u\fR flag is accepted
as a synonym for \fB\-b\fR since binary locks are used by many \s-1UUCP\s0 packages.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
The following example shows how \fBshlock\fR would be used within
a shell script:
.PP
.Vb 7
\&    LOCK=<pathrun in inn.conf>/LOCK.send
\&    trap \*(Aqrm \-f ${LOCK} ; exit 1\*(Aq 1 2 3 15
\&    if shlock \-p $$ \-f ${LOCK} ; then
\&        # Do appropriate work.
\&    else
\&        echo "Locked by \`cat ${LOCK}\`"
\&    fi
.Ve
.SH "HISTORY"
.IX Header "HISTORY"
Written by Rich \f(CW$alz\fR <rsalz@uunet.uu.net> for InterNetNews after
a description of \s-1HDB UUCP\s0 locking given by Peter Honeyman, and
improved by Berend Reitsma to solve a race condition.
Converted to \s-1POD\s0 by Julien Elie.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBINN::Utils::Shlock\fR\|(3pm).