From: matthewv <matthewv>
Date: Mon, 7 Jul 2003 04:40:29 +0000 (+0000)
Subject: Add manual page for with-lock-ex
X-Git-Tag: debian_version_3_99_1_0_9~5
X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ian/git?p=chiark-utils.git;a=commitdiff_plain;h=92105cecb1af534119a7376d3cda100057f88032

Add manual page for with-lock-ex
---

diff --git a/cprogs/Makefile b/cprogs/Makefile
index fc4b4dc..f584470 100644
--- a/cprogs/Makefile
+++ b/cprogs/Makefile
@@ -28,7 +28,7 @@ RWBUFFER_SIZE_MB=16
 PROGRAMS=		readbuffer writebuffer with-lock-ex
 SUIDSBINPROGRAMS=	really
 DAEMONS=		trivsoundd
-MAN1PAGES=		readbuffer.1 writebuffer.1
+MAN1PAGES=		readbuffer.1 writebuffer.1 with-lock-ex.1
 MAN8PAGES=		trivsoundd.8 really.8
 
 TARGETS=	$(PROGRAMS) $(SUIDSBINPROGRAMS) $(DAEMONS)
diff --git a/cprogs/with-lock-ex.1 b/cprogs/with-lock-ex.1
new file mode 100644
index 0000000..6f89277
--- /dev/null
+++ b/cprogs/with-lock-ex.1
@@ -0,0 +1,32 @@
+.TH WITH-LOCK-EX "1" "July 2003" "Debian" "Chiark-utils-bin"
+.SH NAME
+with-lock-ex \- file locker
+.SH SYNOPSIS
+.B with-lock-ex
+.RB [\| \-w \||\| \-q \||\| \-f \|]
+.I lockfile command 
+.IR args \ \|.\|.\|.
+.br
+.SH DESCRIPTION
+with-lock-ex will open and lock the lockfile for writing and then feed
+the remainder of its arguments to
+.BR exec (2);
+when that process terminates the fd will be closed and the file
+unlocked automatically by the kernel.
+.SH OPTIONS
+.TP
+.B \-w
+wait for the lock
+.TP
+.B \-f
+fail if the lock cannot be acquired
+.TP
+.B \-q
+silently do nothing if the lock cannot be acquired
+.SH AUTHOR
+This Manual page was written by Matthew Vernon <matthew@debian.org> but 
+may be used by anyone.
+.SH COPYRIGHT
+with-lock-ex was written by Ian Jackons <ian@chiark.greenend.org.uk>
+in 1993, 1994, 1995, 1996, 1998, 1999. He has placed it in the public
+domain.