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