setlock

Section: Maintenance Commands (8)
Index Return to Main Contents

NAME

setlock - runs another program with a file locked.

SYNOPSIS

setlock [ -nNxX ] fn child

DESCRIPTION

fn is a single argument. child consists of one or more arguments.

setlock opens fn for writing (creating it if it does not exist), obtains an exclusive lock on it, and runs child.

Normally the lock disappears when child exits.

Here's the complete story: child is given a descriptor for a locked ofile pointing to the disk file named fn. The lock disappears when this ofile is

o: closed by all the processes that have descriptors for it or
o: explicitly unlocked.

OPTIONS

-n: No delay. If fn is locked by another process, setlock gives up.
-N: (Default.) Delay. If fn is locked by another process, setlock waits until it can obtain a new lock.
-x: If fn cannot be opened (or created) or locked, setlock exits zero.
-X: (Default.) If fn cannot be opened (or created) or locked, setlock prints an error message and exits nonzero.