xref: /freebsd/usr.sbin/rpc.lockd/rpc.lockd.8 (revision dd41de95a84d979615a2ef11df6850622bf6184e)
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$
31.\"
32.Dd November 21, 2019
33.Dt RPC.LOCKD 8
34.Os
35.Sh NAME
36.Nm rpc.lockd
37.Nd NFS file locking daemon
38.Sh SYNOPSIS
39.Nm
40.Op Fl d Ar debug_level
41.Op Fl F
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 F
75Run
76.Nm
77in the foreground, rather than going into daemon mode.
78This is useful if some other process uses
79.Xr fork 2
80and
81.Xr exec 3
82to run
83.Nm ,
84and wants to monitor when and how it exits.
85.It Fl g
86The
87.Fl g
88option allow to specify the
89.Ar grace period ,
90in seconds.
91During the grace period
92.Nm
93only accepts requests from hosts which are reinitialising locks which
94existed before the server restart.
95Default is 30 seconds.
96.It Fl h Ar bindip
97Specify specific IP addresses to bind to.
98This option may be specified multiple times.
99If no
100.Fl h
101option is specified,
102.Nm
103will bind to
104.Dv INADDR_ANY .
105Note that when specifying IP addresses with
106.Fl h ,
107.Nm
108will automatically add
109.Li 127.0.0.1
110and if IPv6 is enabled,
111.Li ::1
112to the list.
113.It Fl p
114The
115.Fl p
116option allow to force the daemon to bind to the specified
117.Ar port ,
118for both AF_INET and AF_INET6 address families.
119.El
120.Pp
121Error conditions are logged to syslog, irrespective of the debug level,
122using log level
123.Dv LOG_ERR
124and facility
125.Dv LOG_DAEMON .
126.Pp
127The
128.Nm
129utility must NOT be invoked by
130.Xr inetd 8
131because the protocol assumes that the daemon will run from system start time.
132Instead, it should be configured in
133.Xr rc.conf 5
134to run at system startup.
135.Sh FILES
136.Bl -tag -width /usr/include/rpcsvc/nlm_prot.x -compact
137.It Pa /usr/include/rpcsvc/nlm_prot.x
138RPC protocol specification for the network lock manager protocol.
139.El
140.Sh SEE ALSO
141.Xr syslog 3 ,
142.Xr rc.conf 5 ,
143.Xr rpc.statd 8
144.Sh STANDARDS
145The implementation is based on the specification in
146.Rs
147.%B "X/Open CAE Specification C218"
148.%T "Protocols for X/Open PC Interworking: XNFS, Issue 4"
149.%O ISBN 1 872630 66 9
150.Re
151.Sh HISTORY
152A version of
153.Nm
154appeared in
155.Tn SunOS
1564.
157.Sh BUGS
158The current implementation serialises locks requests that could be shared.
159