xref: /netbsd/usr.sbin/rpc.lockd/rpc.lockd.8 (revision 6550d01e)
1.\"	$NetBSD: rpc.lockd.8,v 1.6 2002/02/02 01:42:45 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 September 24, 1995
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 d Ar debug_level
44.Op Fl g Ar grace period
45.Sh DESCRIPTION
46The
47.Nm
48daemon provides monitored and unmonitored file and record locking services
49in an NFS environment.  To monitor the status of hosts requesting locks,
50the locking daemon typically operates in conjunction
51with
52.Xr rpc.statd 8 .
53.Pp
54Options and operands available for
55.Nm
56:
57.Bl -tag -width Ds
58.It Fl d
59The
60.Fl d
61option causes debugging information to be written to syslog, recording
62all RPC transactions to the daemon.  These messages are logged with level
63LOG_DEBUG and facility LOG_DAEMON.  Specifying a debug_level of 1 results
64in the generation of one log line per protocol operation.  Higher
65debug levels can be specified, causing display of operation arguments
66and internal operations of the daemon.
67.It Fl g
68The
69.Fl g
70option allow to specify the grace period, in seconds. During the grace period
71.Nm
72only accepts requests from hosts which are reinitialising locks which
73existed before the server restart. Default is 30 seconds.
74.El
75.Pp
76Error conditions are logged to syslog, irrespective of the debug level,
77using log level LOG_ERR and facility LOG_DAEMON.
78.Pp
79The
80.Nm
81daemon must NOT be invoked by
82.Xr inetd 8
83because the protocol assumes that the daemon will run from system start time.
84Instead, it should be configured in
85.Xr rc.conf 5
86to run at system startup.
87.Sh FILES
88.Bl -tag -width /usr/include/rpcsvc/nlm_prot.x -compact
89.It Pa /usr/include/rpcsvc/nlm_prot.x
90RPC protocol specification for the network lock manager protocol.
91.El
92.Sh SEE ALSO
93.Xr syslog 3 ,
94.Xr rc.conf 5 ,
95.Xr rpc.statd 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 HISTORY
100A version of
101.Nm
102appeared in
103.Tn SunOS 4 .
104.Sh BUGS
105The current implementation provides only the server side of the protocol
106(i.e. clients running other OS types can establish locks on a
107.Nx
108fileserver,
109but there is currently no means for a
110.Nx
111client to establish locks).
112.Pp
113The current implementation serialises locks requests that could be shared.
114