usr.bin/shlock/shlock.1

   1 .\"
   2 .\" Copyright (c) 2005 Jeroen Ruigrok van der Werven <asmodai@dragonflybsd.org>
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .Dd July 24, 2005
  27 .Dt SHLOCK 1
  28 .Os
  29 .Sh NAME
  30 .Nm shlock
  31 .Nd create lock file from shell script
  32 .Sh SYNOPSIS
  33 .Nm
  34 .Op Fl d
  35 .Op Fl f Ar name
  36 .Op Fl p Ar pid
  37 .Op Fl u
  38 .Sh DESCRIPTION
  39 The
  40 .Nm
  41 utility tries to create a lock file named
  42 .Ar name
  43 and writes the process id
  44 .Ar pid
  45 into this file.
  46 .Pp
  47 Options:
  48 .Bl -tag -width Fl
  49 .It Fl d
  50 Enable debugging.
  51 .It Fl f Ar name
  52 The filename of the lock file.
  53 .It Fl p Ar pid
  54 The process id that will be written to file.
  55 .It Fl u
  56 Use UUCP style lock file format.
  57 .El
  58 .Sh EXIT STATUS
  59 .Ex -std
  60 .Sh EXAMPLES
  61 A typical use could be (from within a script):
  62 .Pp
  63 .Dl "shlock -f script.lock -p $$"
  64 .Sh HISTORY
  65 The
  66 .Nm
  67 command appeared in
  68 .Dx 1.3 .