Differential D26005 Diff 76260 head/usr.bin/lockf/lockf.1

Changeset View

Standalone View

head/usr.bin/lockf/lockf.1

	.\"			.\"
	.\" Copyright (C) 1998 John D. Polstra. All rights reserved.			.\" Copyright (C) 1998 John D. Polstra. All rights reserved.
	.\"			.\"
	.\" Redistribution and use in source and binary forms, with or without			.\" Redistribution and use in source and binary forms, with or without
	.\" modification, are permitted provided that the following conditions			.\" modification, are permitted provided that the following conditions
	.\" are met:			.\" are met:
	.\" 1. Redistributions of source code must retain the above copyright			.\" 1. Redistributions of source code must retain the above copyright
	.\" notice, this list of conditions and the following disclaimer.			.\" notice, this list of conditions and the following disclaimer.
	.\" 2. Redistributions in binary form must reproduce the above copyright			.\" 2. Redistributions in binary form must reproduce the above copyright
	Show All 9 Lines
	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)			.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT			.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY			.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF			.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	.\" SUCH DAMAGE.			.\" SUCH DAMAGE.
	.\"			.\"
	.\" $FreeBSD$			.\" $FreeBSD$
	.\"			.\"
	.Dd June 18, 2020			.Dd August 26, 2020
	.Dt LOCKF 1			.Dt LOCKF 1
	.Os			.Os
	.Sh NAME			.Sh NAME
	.Nm lockf			.Nm lockf
	.Nd execute a command while holding a file lock			.Nd execute a command while holding a file lock
	.Sh SYNOPSIS			.Sh SYNOPSIS
	.Nm			.Nm
	.Op Fl kns			.Op Fl knsw
	.Op Fl t Ar seconds			.Op Fl t Ar seconds
	.Ar file			.Ar file
	.Ar command			.Ar command
	.Op Ar arguments			.Op Ar arguments
	.Sh DESCRIPTION			.Sh DESCRIPTION
	The			The
	.Nm			.Nm
	utility acquires an exclusive lock on a			utility acquires an exclusive lock on a
	▲ Show 20 Lines • Show All 72 Lines • ▼ Show 20 Lines
	A timeout of 0 may be given, in which case			A timeout of 0 may be given, in which case
	.Nm			.Nm
	will fail unless it can acquire the lock immediately.			will fail unless it can acquire the lock immediately.
	When a lock times out,			When a lock times out,
	.Ar command			.Ar command
	is			is
	.Em not			.Em not
	executed.			executed.
				.It Fl w
				Causes
				.Nm
				to open
				.Ar file
				for writing rather than reading.
				This is necessary on filesystems (including NFSv4) where a file which
				has been opened read-only cannot be exclusively locked.
	.El			.El
	.Pp			.Pp
	In no event will			In no event will
	.Nm			.Nm
	break a lock that is held by another process.			break a lock that is held by another process.
	.Sh EXIT STATUS			.Sh EXIT STATUS
	If			If
	.Nm			.Nm
	▲ Show 20 Lines • Show All 62 Lines • Show Last 20 Lines