xref: /netbsd/usr.sbin/rpc.lockd/rpc.lockd.8 (revision e684a528)
1.\"	$NetBSD: rpc.lockd.8,v 1.8 2012/08/13 12:37:05 wiz 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 August 11, 2012
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
43.Op Fl 46
44.Op Fl d Ar debug_level
45.Op Fl g Ar grace_period
46.Sh DESCRIPTION
47The
48.Nm
49daemon provides monitored and unmonitored file and record locking services
50in an NFS environment.
51To monitor the status of hosts requesting locks, the locking daemon
52typically operates in conjunction with
53.Xr rpc.statd 8 .
54.Pp
55Options and operands available for
56.Nm :
57.Bl -tag -width XgXgrace_periodXX
58.It Fl 4
59Listen for requests using IPv4.
60Do not listen using IPv6 unless the
61.Fl 6
62option is also specified.
63By default,
64.Nm
65listens for requests using both IPv4 and IPv6 if available.
66.It Fl 6
67Listen for requests using IPv6.
68It is an error if IPv6 is not available.
69.It Fl d Ar debug_level
70Cause debugging information to be written to syslog, recording all
71RPC transactions to the daemon.
72These messages are logged with level
73.Dv LOG_DEBUG
74and facility
75.Dv LOG_DAEMON .
76Specifying a
77.Ar debug_level
78of 1 results in the generation of one log line per protocol operation.
79Higher debug levels can be specified, causing display of operation
80arguments and internal operations of the daemon.
81.It Fl g Ar grace_period
82Set the grace period (in seconds) to
83.Ar grace_period .
84During the grace period
85.Nm
86only accepts requests from hosts which are reinitialising locks which
87existed before the server restarted.
88Default is 30 seconds.
89.El
90.Pp
91Error conditions are logged to syslog, irrespective of the debug level,
92using log level
93.Dv LOG_ERR
94and facility
95.Dv LOG_DAEMON .
96.Pp
97The
98.Nm
99daemon must NOT be invoked by
100.Xr inetd 8
101because the protocol assumes that the daemon will run from system start time.
102Instead, it should be configured in
103.Xr rc.conf 5
104to run at system startup.
105.Sh FILES
106.Bl -tag -width /usr/include/rpcsvc/nlm_prot.x -compact
107.It Pa /usr/include/rpcsvc/nlm_prot.x
108RPC protocol specification for the network lock manager protocol.
109.El
110.Sh SEE ALSO
111.Xr syslog 3 ,
112.Xr rc.conf 5 ,
113.Xr rpc.statd 8
114.Sh STANDARDS
115The implementation is based on the specification in X/Open CAE Specification
116C218, "Protocols for X/Open PC Interworking: XNFS, Issue 4", ISBN 1 872630 66 9.
117.Sh HISTORY
118A version of
119.Nm
120appeared in
121.Tn SunOS 4 .
122.Sh BUGS
123The current implementation provides only the server side of the protocol
124(i.e., clients running other OS types can establish locks on a
125.Nx
126fileserver, but there is currently no means for a
127.Nx
128client to establish locks).
129.Pp
130The current implementation serialises lock requests that could be shared.
131