usr.bin/lockf/lockf.1

   1 .\"
   2 .\" Copyright (C) 1998 John D. Polstra.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY JOHN D. POLSTRA AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL JOHN D. POLSTRA OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd July 7, 1998
  28 .Os
  29 .Dt LOCKF 1
  30 .Sh NAME
  31 .Nm lockf
  32 .Nd execute a command while holding a file lock
  33 .Sh SYNOPSIS
  34 .Nm
  35 .Op Fl ks
  36 .Op Fl t Ar seconds
  37 .Ar file
  38 .Ar command
  39 .Op Ar arguments
  40 .Sh DESCRIPTION
  41 The
  42 .Nm
  43 utility acquires an exclusive lock on a
  44 .Ar file ,
  45 creating it if necessary,
  46 .Bf Em
  47 and removing the file on exit unless explicitly told not to.
  48 .Ef
  49 While holding the lock, it executes a
  50 .Ar command
  51 with optional
  52 .Ar arguments .
  53 After the
  54 .Ar command
  55 completes,
  56 .Nm
  57 releases the lock, and removes the
  58 .Ar file
  59 unless the
  60 .Fl k
  61 option is specified.
  62 .Bx Ns -style
  63 locking is used, as described in
  64 .Xr flock 2 ;
  65 the mere existence of the
  66 .Ar file
  67 is not considered to constitute a lock.
  68 .Pp
  69 If the
  70 .Nm
  71 utility is being used to facilitate concurrency between a number
  72 of processes, it is recommended that the
  73 .Fl k
  74 option be used.
  75 This will guarantee lock ordering, as well as implement
  76 a performance enhanced algorithm which minimizes CPU load associated
  77 with concurrent unlink, drop and re-acquire activity.
  78 It should be noted
  79 that if the
  80 .Fl k
  81 option is not used, then no guarantees around lock ordering can be made.
  82 .Pp
  83 The following options are supported:
  84 .Bl -tag -width ".Fl t Ar seconds"
  85 .It Fl k
  86 Causes the lock file to be kept (not removed) after the command
  87 completes.
  88 .It Fl s
  89 Causes
  90 .Nm
  91 to operate silently.
  92 Failure to acquire the lock is indicated only in the exit status.
  93 .It Fl t Ar seconds
  94 Specifies a timeout for waiting for the lock.
  95 By default,
  96 .Nm
  97 waits indefinitely to acquire the lock.
  98 If a timeout is specified with this option,
  99 .Nm
 100 will wait at most the given number of
 101 .Ar seconds
 102 before giving up.
 103 A timeout of 0 may be given, in which case
 104 .Nm
 105 will fail unless it can acquire the lock immediately.
 106 When a lock times out,
 107 .Ar command
 108 is
 109 .Em not
 110 executed.
 111 .El
 112 .Pp
 113 In no event will
 114 .Nm
 115 break a lock that is held by another process.
 116 .Sh EXIT STATUS
 117 If
 118 .Nm
 119 successfully acquires the lock, it returns the exit status produced by
 120 .Ar command .
 121 Otherwise, it returns one of the exit codes defined in
 122 .Xr sysexits 3 ,
 123 as follows:
 124 .Bl -tag -width ".Dv EX_CANTCREAT"
 125 .It Dv EX_TEMPFAIL
 126 The specified lock file was already locked by another process.
 127 .It Dv EX_CANTCREAT
 128 The
 129 .Nm
 130 utility
 131 was unable to create the lock file, e.g., because of insufficient access
 132 privileges.
 133 .It Dv EX_USAGE
 134 There was an error on the
 135 .Nm
 136 command line.
 137 .It Dv EX_OSERR
 138 A system call (e.g.,
 139 .Xr fork 2 )
 140 failed unexpectedly.
 141 .It Dv EX_SOFTWARE
 142 The
 143 .Ar command
 144 did not exit normally,
 145 but may have been signaled or stopped.
 146 .El
 147 .Sh SEE ALSO
 148 .Xr flock 2 ,
 149 .Xr sysexits 3
 150 .Sh HISTORY
 151 A
 152 .Nm
 153 utility first appeared in
 154 .Fx 2.2 .
 155 .Sh AUTHORS
 156 .An John Polstra Aq jdp@polstra.com