Bring in a transport-independent RPC (TI-RPC).
[dragonfly.git] / usr.sbin / rpc.lockd / rpc.lockd.8
CommitLineData
ce0e08e2 1.\" $NetBSD: rpc.lockd.8,v 1.5 2000/06/09 18:51:47 cgd Exp $
984263bc
MD
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.\"
ce0e08e2 34.\" $FreeBSD: src/usr.sbin/rpc.lockd/rpc.lockd.8,v 1.18 2007/11/02 14:51:53 matteo Exp $
49781055 35.\" $DragonFly: src/usr.sbin/rpc.lockd/rpc.lockd.8,v 1.4 2006/02/17 19:40:23 swildner Exp $
984263bc 36.\"
ce0e08e2 37.Dd November 2, 2007
984263bc
MD
38.Dt RPC.LOCKD 8
39.Os
40.Sh NAME
41.Nm rpc.lockd
42.Nd NFS file locking daemon
43.Sh SYNOPSIS
44.Nm
ce0e08e2
PA
45.Op Fl d Ar debug_level
46.Op Fl g Ar grace period
47.Op Fl h Ar bindip
48.Op Fl p Ar port
984263bc 49.Sh DESCRIPTION
ce0e08e2
PA
50The
51.Nm
52utility provides monitored and unmonitored file and record locking services
53in an NFS environment.
54To monitor the status of hosts requesting locks,
55the locking daemon typically operates in conjunction
56with
57.Xr rpc.statd 8 .
984263bc 58.Pp
ce0e08e2
PA
59Options and operands available for
60.Nm :
984263bc
MD
61.Bl -tag -width indent
62.It Fl d
ce0e08e2
PA
63The
64.Fl d
65option causes debugging information to be written to syslog, recording
66all RPC transactions to the daemon.
67These messages are logged with level
68.Dv LOG_DEBUG
69and facility
70.Dv LOG_DAEMON .
71Specifying a
72.Ar debug_level
73of 1 results
74in the generation of one log line per protocol operation.
75Higher
984263bc
MD
76debug levels can be specified, causing display of operation arguments
77and internal operations of the daemon.
ce0e08e2
PA
78.It Fl g
79The
80.Fl g
81option allow to specify the
82.Ar grace period ,
83in seconds.
84During the grace period
85.Nm
86only accepts requests from hosts which are reinitialising locks which
87existed before the server restart.
88Default is 30 seconds.
89.It Fl h Ar bindip
90Specify specific IP addresses to bind to.
91This option may be specified multiple times.
92If no
93.Fl h
94option is specified,
95.Nm
96will bind to
97.Dv INADDR_ANY .
98Note that when specifying IP addresses with
99.Fl h ,
100.Nm
101will automatically add
102.Li 127.0.0.1
103and if IPv6 is enabled,
104.Li ::1
105to the list.
106.It Fl p
107The
108.Fl p
109option allow to force the daemon to bind to the specified
110.Ar port ,
111for both AF_INET and AF_INET6 address families.
984263bc
MD
112.El
113.Pp
114Error conditions are logged to syslog, irrespective of the debug level,
ce0e08e2
PA
115using log level
116.Dv LOG_ERR
117and facility
118.Dv LOG_DAEMON .
984263bc
MD
119.Pp
120The
121.Nm
ce0e08e2 122utility must NOT be invoked by
984263bc
MD
123.Xr inetd 8
124because the protocol assumes that the daemon will run from system start time.
ce0e08e2
PA
125Instead, it should be configured in
126.Xr rc.conf 5
127to run at system startup.
984263bc
MD
128.Sh FILES
129.Bl -tag -width /usr/include/rpcsvc/nlm_prot.x -compact
130.It Pa /usr/include/rpcsvc/nlm_prot.x
131RPC protocol specification for the network lock manager protocol.
132.El
133.Sh SEE ALSO
134.Xr syslog 3 ,
ce0e08e2 135.Xr rc.conf 5 ,
984263bc 136.Xr rpc.statd 8
49781055 137.Sh STANDARDS
ce0e08e2
PA
138The implementation is based on the specification in
139.Rs
140.%B "X/Open CAE Specification C218"
141.%T "Protocols for X/Open PC Interworking: XNFS, Issue 4"
142.%O ISBN 1 872630 66 9
143.Re
144.Sh HISTORY
145A version of
146.Nm
147appeared in
148.Tn SunOS
1494.
984263bc
MD
150.Sh BUGS
151The current implementation provides only the server side of the protocol
ce0e08e2 152(i.e., clients running other OS types can establish locks on a
9bb2a92d 153.Dx
984263bc
MD
154fileserver,
155but there is currently no means for a
9bb2a92d 156.Dx
984263bc
MD
157client to establish locks).
158.Pp
ce0e08e2 159The current implementation serialises locks requests that could be shared.