chiark / gitweb /
better error docs
authorianmdlvl <ianmdlvl>
Sun, 13 Jul 2003 22:54:41 +0000 (22:54 +0000)
committerianmdlvl <ianmdlvl>
Sun, 13 Jul 2003 22:54:41 +0000 (22:54 +0000)
cprogs/with-lock-ex.1

index ce3f87f..3715cd8 100644 (file)
@@ -3,7 +3,7 @@
 with-lock-ex \- file locker
 .SH SYNOPSIS
 .B with-lock-ex
-.RB [\| \-w \||\| \-q \||\| \-f \|]
+.BR \-w \||\| \-q \||\| \-f
 .I lockfile command 
 .IR args \ \|.\|.\|.
 .br
@@ -21,14 +21,16 @@ for each user class for which the umask has
 .SH OPTIONS
 .TP
 .B \-w
-wait for the lock
+Wait for the lock to be available.
 .TP
 .B \-f
-fail if the lock cannot be acquired
+Fail (printing a message to stderr and exiting 255) if the lock cannot
+be acquired immediately because another process has it.
 .TP
 .B \-q
-silently do nothing (ie, exit 0 instead of executing the specified
-process) if the lock cannot be acquired
+Silently do nothing (ie, exit 0 instead of executing the specified
+process) if the lock cannot be acquired immediately because another
+process has it.
 .SH STALE LOCKS
 The locking protocol used does not suffer from stale locks.  If the
 lock cannot be acquired, one or more running processes must currently