usr.sbin/rpc.lockd/rpc.lockd.8

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