xref: /dragonfly/usr.sbin/rpc.lockd/rpc.lockd.8 (revision d4ef6694)
1.\"	$NetBSD: rpc.lockd.8,v 1.5 2000/06/09 18:51:47 cgd 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. Neither the name of the University nor the names of its contributors
15.\"    may be used to endorse or promote products derived from this software
16.\"    without specific prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28.\" SUCH DAMAGE.
29.\"
30.\" $FreeBSD: src/usr.sbin/rpc.lockd/rpc.lockd.8,v 1.18 2007/11/02 14:51:53 matteo Exp $
31.\" $DragonFly: src/usr.sbin/rpc.lockd/rpc.lockd.8,v 1.4 2006/02/17 19:40:23 swildner Exp $
32.\"
33.Dd November 2, 2007
34.Dt RPC.LOCKD 8
35.Os
36.Sh NAME
37.Nm rpc.lockd
38.Nd NFS file locking daemon
39.Sh SYNOPSIS
40.Nm
41.Op Fl d Ar debug_level
42.Op Fl g Ar grace period
43.Op Fl h Ar bindip
44.Op Fl p Ar port
45.Sh DESCRIPTION
46The
47.Nm
48utility provides monitored and unmonitored file and record locking services
49in an NFS environment.
50To monitor the status of hosts requesting locks,
51the locking daemon typically operates in conjunction
52with
53.Xr rpc.statd 8 .
54.Pp
55Options and operands available for
56.Nm :
57.Bl -tag -width indent
58.It Fl d
59The
60.Fl d
61option causes debugging information to be written to syslog, recording
62all RPC transactions to the daemon.
63These messages are logged with level
64.Dv LOG_DEBUG
65and facility
66.Dv LOG_DAEMON .
67Specifying a
68.Ar debug_level
69of 1 results
70in the generation of one log line per protocol operation.
71Higher
72debug levels can be specified, causing display of operation arguments
73and internal operations of the daemon.
74.It Fl g
75The
76.Fl g
77option allow to specify the
78.Ar grace period ,
79in seconds.
80During the grace period
81.Nm
82only accepts requests from hosts which are reinitialising locks which
83existed before the server restart.
84Default is 30 seconds.
85.It Fl h Ar bindip
86Specify specific IP addresses to bind to.
87This option may be specified multiple times.
88If no
89.Fl h
90option is specified,
91.Nm
92will bind to
93.Dv INADDR_ANY .
94Note that when specifying IP addresses with
95.Fl h ,
96.Nm
97will automatically add
98.Li 127.0.0.1
99and if IPv6 is enabled,
100.Li ::1
101to the list.
102.It Fl p
103The
104.Fl p
105option allow to force the daemon to bind to the specified
106.Ar port ,
107for both AF_INET and AF_INET6 address families.
108.El
109.Pp
110Error conditions are logged to syslog, irrespective of the debug level,
111using log level
112.Dv LOG_ERR
113and facility
114.Dv LOG_DAEMON .
115.Pp
116The
117.Nm
118utility must NOT be invoked by
119.Xr inetd 8
120because the protocol assumes that the daemon will run from system start time.
121Instead, it should be configured in
122.Xr rc.conf 5
123to run at system startup.
124.Sh FILES
125.Bl -tag -width /usr/include/rpcsvc/nlm_prot.x -compact
126.It Pa /usr/include/rpcsvc/nlm_prot.x
127RPC protocol specification for the network lock manager protocol.
128.El
129.Sh SEE ALSO
130.Xr syslog 3 ,
131.Xr rc.conf 5 ,
132.Xr rpc.statd 8
133.Sh STANDARDS
134The implementation is based on the specification in
135.Rs
136.%B "X/Open CAE Specification C218"
137.%T "Protocols for X/Open PC Interworking: XNFS, Issue 4"
138.%O ISBN 1 872630 66 9
139.Re
140.Sh HISTORY
141A version of
142.Nm
143appeared in
144.Tn SunOS
1454.
146.Sh BUGS
147The current implementation provides only the server side of the protocol
148(i.e., clients running other OS types can establish locks on a
149.Dx
150fileserver,
151but there is currently no means for a
152.Dx
153client to establish locks).
154.Pp
155The current implementation serialises locks requests that could be shared.
156