sbase/flock.1

.Dd 2015-10-08
.Dt FLOCK 1
.Os sbase
.Sh NAME
.Nm flock
.Nd tool to manage locks on files
.Sh SYNOPSIS
.Nm
.Op Fl nosux
.Ar file
.Ar cmd Op arg ...
.Sh DESCRIPTION
.Nm
is used to manage advisory locks on open files.
It is commonly used to prevent long running cron jobs from running in
parallel.
If
.Ar file
does not exist, it will be created.
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl n
Set non-blocking mode on the lock.
Fail immediately if the lock cannot be acquired.
.It Fl o
Close the file descriptor before exec to avoid having the exec'ed
program holding on to the lock.
.It Fl s
Acquire a shared lock.
.It Fl u
Release the lock.
.It Fl x
Acquire an exclusive lock.
This is the default.
.El
Use ISO-date-format in manpages The one specified by mdoc is hard to read for non-native speakers from countries which read the date day-first (like Germany, Greece, North-Korea, Swamp,...). This is also consistent with how we generally specify dates at suckless.org. 2015-10-08 11:15:08 -04:00			`.Dd 2015-10-08`
Initial implementation of flock(1) Very useful to prevent overlapping cron jobs amongst other things. 2015-10-07 05:16:18 -04:00			`.Dt FLOCK 1`
			`.Os sbase`
			`.Sh NAME`
			`.Nm flock`
			`.Nd tool to manage locks on files`
			`.Sh SYNOPSIS`
			`.Nm`
Implement -o for flock(1) to close fd before exec 2015-10-08 11:43:09 -04:00			`.Op Fl nosux`
Initial implementation of flock(1) Very useful to prevent overlapping cron jobs amongst other things. 2015-10-07 05:16:18 -04:00			`.Ar file`
			`.Ar cmd Op arg ...`
			`.Sh DESCRIPTION`
			`.Nm`
Fix various lint warnings in manuals Fix "new sentence, new line" warnings throughout so that formatters can produce correct spacing between sentences. join.1 Remove unnecessary Ns macros. These are not necessary for delimeters, which get special treatment. xinstall.1 Fix date in manual. The contents were last modified on 2016-12-03, so use that instead of the invalid date. grep.1 Fix escape sequence for `\<` and `\>`. ed.1 Remove spurious `\\n` escape for the null-command. 2020-03-01 17:37:31 -05:00			`is used to manage advisory locks on open files.`
			`It is commonly used to prevent long running cron jobs from running in`
			`parallel.`
			`If`
Initial implementation of flock(1) Very useful to prevent overlapping cron jobs amongst other things. 2015-10-07 05:16:18 -04:00			`.Ar file`
			`does not exist, it will be created.`
			`.Sh OPTIONS`
			`.Bl -tag -width Ds`
			`.It Fl n`
Fix various lint warnings in manuals Fix "new sentence, new line" warnings throughout so that formatters can produce correct spacing between sentences. join.1 Remove unnecessary Ns macros. These are not necessary for delimeters, which get special treatment. xinstall.1 Fix date in manual. The contents were last modified on 2016-12-03, so use that instead of the invalid date. grep.1 Fix escape sequence for `\<` and `\>`. ed.1 Remove spurious `\\n` escape for the null-command. 2020-03-01 17:37:31 -05:00			`Set non-blocking mode on the lock.`
			`Fail immediately if the lock cannot be acquired.`
Implement -o for flock(1) to close fd before exec 2015-10-08 11:43:09 -04:00			`.It Fl o`
			`Close the file descriptor before exec to avoid having the exec'ed`
			`program holding on to the lock.`
Initial implementation of flock(1) Very useful to prevent overlapping cron jobs amongst other things. 2015-10-07 05:16:18 -04:00			`.It Fl s`
			`Acquire a shared lock.`
			`.It Fl u`
			`Release the lock.`
			`.It Fl x`
Fix various lint warnings in manuals Fix "new sentence, new line" warnings throughout so that formatters can produce correct spacing between sentences. join.1 Remove unnecessary Ns macros. These are not necessary for delimeters, which get special treatment. xinstall.1 Fix date in manual. The contents were last modified on 2016-12-03, so use that instead of the invalid date. grep.1 Fix escape sequence for `\<` and `\>`. ed.1 Remove spurious `\\n` escape for the null-command. 2020-03-01 17:37:31 -05:00			`Acquire an exclusive lock.`
			`This is the default.`
Initial implementation of flock(1) Very useful to prevent overlapping cron jobs amongst other things. 2015-10-07 05:16:18 -04:00			`.El`