xref: /freebsd/usr.sbin/rpc.lockd/rpc.lockd.8 (revision 97d92980)
1.\" -*- nroff -*-
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$
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 rpc.lockd
44.Op Fl d Op Ar debug_level
45.Sh DESCRIPTION
46.Nm Rpc.lockd
47is a daemon which provides file- and record-locking services in an NFS
48environment.
49.Pp
50The following option is available:
51.Bl -tag -width indent
52.It Fl d
53Cause debugging information to be written to syslog, recording
54all RPC transactions to the daemon.  These messages are logged with level
55LOG_DEBUG and facility LOG_DAEMON.  If debug_level is not specified,
56level 1 is assumed, giving one log line per protocol operation.  Higher
57debug levels can be specified, causing display of operation arguments
58and internal operations of the daemon.
59.El
60.Pp
61Error conditions are logged to syslog, irrespective of the debug level,
62using log level LOG_ERR and facility LOG_DAEMON.
63.Pp
64The
65.Nm
66daemon must NOT be invoked by
67.Xr inetd 8
68because the protocol assumes that the daemon will run from system start time.
69Instead, it should be run from
70.Xr rc 8
71after the network has been started.
72.Sh FILES
73.Bl -tag -width /usr/include/rpcsvc/nlm_prot.x -compact
74.It Pa /usr/include/rpcsvc/nlm_prot.x
75RPC protocol specification for the network lock manager protocol.
76.El
77.Sh SEE ALSO
78.Xr syslog 3 ,
79.Xr rc 8 ,
80.Xr rpc.statd 8
81.Sh BUGS
82The current implementation provides only the server side of the protocol
83(ie. clients running other OS types can establish locks on a
84.Bx Free
85fileserver,
86but there is currently no means for a
87.Bx Free
88client to establish locks).
89.Pp
90Versions 1, 2 and 3 of the protocol are supported.  However, only versions
912 (Unix systems) and 3 (PC-NFS clients) seem to be in common use - the version
921 support has not been tested due to the lack of version 1 clients against
93which to test.
94.Sh STANDARDS
95The implementation is based on the specification in X/Open CAE Specification
96C218, "Protocols for X/Open PC Interworking: XNFS, Issue 4", ISBN 1 872630 66 9
97