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 .\" $DragonFly: src/usr.bin/shlock/shlock.1,v 1.6 2008/05/02 02:05:07 swildner Exp $
  27 .\"
  28 .Dd July 24, 2005
  29 .Dt SHLOCK 1
  30 .Os
  31 .Sh NAME
  32 .Nm shlock
  33 .Nd create lock file from shell scipt
  34 .Sh SYNOPSIS
  35 .Nm
  36 .Op Fl d
  37 .Op Fl f Ar name
  38 .Op Fl p Ar pid
  39 .Op Fl u
  40 .Sh DESCRIPTION
  41 The
  42 .Nm
  43 utility tries to create a lock file named
  44 .Ar name
  45 and writes the process id
  46 .Ar pid
  47 into this file.
  48 .Pp
  49 Options:
  50 .Bl -tag -width Fl
  51 .It Fl d
  52 Enable debugging.
  53 .It Fl f Ar name
  54 The filename of the lock file.
  55 .It Fl p Ar pid
  56 The process id that will be written to file.
  57 .It Fl u
  58 Use UUCP style lock file format.
  59 .El
  60 .Sh EXAMPLES
  61 A typical use could be (from within a script):
  62 .Pp
  63 .Dl "shlock -f script.lock -p $$"
  64 .Sh DIAGNOSTICS
  65 The
  66 .Nm
  67 command exists with 0 on success or with >0 if there was a problem.
  68 .Sh HISTORY
  69 The
  70 .Nm
  71 command appeared in
  72 .Dx 1.3 .