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