xref: /openbsd/usr.sbin/rpc.lockd/rpc.lockd.8 (revision e5dd7070)
1.\"	$OpenBSD: rpc.lockd.8,v 1.13 2008/06/13 23:56:28 jmc Exp $
2.\"
3.\" Copyright (c) 1995 A.R.Gordon, andrew.gordon@net-tel.co.uk
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	This product includes software developed by the University of
17.\"	California, Berkeley and its contributors.
18.\" 4. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\"
35.Dd $Mdocdate: June 13 2008 $
36.Dt RPC.LOCKD 8
37.Os
38.Sh NAME
39.Nm rpc.lockd
40.Nd NFS file locking daemon
41.Sh SYNOPSIS
42.Nm rpc.lockd
43.Op Fl d Op Ar debug_level
44.Op Fl g Ar grace_period
45.Sh DESCRIPTION
46.Nm rpc.lockd
47is a daemon which provides file- and record-locking services in an NFS
48environment.
49.Pp
50The options are as follows:
51.Bl -tag -width Ds
52.It Fl d Op Ar debug_level
53Write debugging information to syslog, recording
54all RPC transactions to the daemon.
55These messages are logged with level
56.Dv LOG_DEBUG
57and facility
58.Dv LOG_DAEMON .
59If
60.Ar debug_level
61is not specified,
62level 1 is assumed, giving one log line per protocol operation.
63Higher debug levels can be specified, causing display of operation arguments
64and internal operations of the daemon.
65.It Fl g Ar grace_period
66Specify the grace period, in seconds.
67During the grace period
68.Nm
69only accepts requests from hosts which are reinitialising locks which
70existed before the server restart.
71The default is 30 seconds.
72.El
73.Pp
74Error conditions are logged to syslog, irrespective of the debug level,
75using log level
76.Dv LOG_ERR
77and facility
78.Dv LOG_DAEMON .
79.Pp
80The
81.Nm rpc.lockd
82daemon must NOT be invoked by
83.Xr inetd 8
84because the protocol assumes that the daemon will run from system start time.
85Instead, it should be run from
86.Xr rc 8
87after the network has been started.
88.Sh FILES
89.Bl -tag -width /usr/include/rpcsvc/nlm_prot.x -compact
90.It Pa /usr/include/rpcsvc/nlm_prot.x
91RPC protocol specification for the network lock manager protocol.
92.El
93.Sh SEE ALSO
94.Xr syslog 3 ,
95.Xr rc 8
96.Sh STANDARDS
97The implementation is based on the specification in X/Open CAE Specification
98C218, "Protocols for X/Open PC Interworking: XNFS, Issue 4", ISBN 1 872630 66 9
99.Sh BUGS
100The current implementation provides only the server side of the protocol
101(i.e., clients running other OS types can establish locks on an
102.Ox
103fileserver,
104but there is currently no means for an
105.Ox
106client to establish locks).
107.Pp
108The current implementation serialises lock requests that could be shared.
109