rpc_lockd.tproj/rpc.lockd.8

   1 .\"     $NetBSD: rpc.lockd.8,v 1.5 2000/06/09 18:51:47 cgd Exp $
   2 .\"     $FreeBSD: src/usr.sbin/rpc.lockd/rpc.lockd.8,v 1.14 2002/07/14 14:45:36 charnier Exp $
   3 .\"
   4 .\" Copyright (c) 1995 A.R.Gordon, andrew.gordon@net-tel.co.uk
   5 .\" All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\" 3. All advertising materials mentioning features or use of this software
  16 .\"    must display the following acknowledgement:
  17 .\"     This product includes software developed by the University of
  18 .\"     California, Berkeley and its contributors.
  19 .\" 4. Neither the name of the University nor the names of its contributors
  20 .\"    may be used to endorse or promote products derived from this software
  21 .\"    without specific prior written permission.
  22 .\"
  23 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33 .\" SUCH DAMAGE.
  34 .\"
  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
  44 .Op Fl d Ar debug_level
  45 .Op Fl g Ar grace period
  46 .Sh DESCRIPTION
  47 The
  48 .Nm
  49 utility provides monitored and unmonitored file and record locking services
  50 in an NFS environment.
  51 To monitor the status of hosts requesting locks,
  52 the locking daemon typically operates in conjunction
  53 with
  54 .Xr rpc.statd 8 .
  55 .Pp
  56 Options and operands available for
  57 .Nm :
  58 .Bl -tag -width indent
  59 .It Fl d
  60 The
  61 .Fl d
  62 option causes debugging information to be written to syslog, recording
  63 all RPC transactions to the daemon.
  64 These messages are logged with level
  65 .Dv LOG_DEBUG
  66 and facility
  67 .Dv LOG_DAEMON .
  68 Specifying a
  69 .Ar debug_level
  70 of 1 results
  71 in the generation of one log line per protocol operation.
  72 Higher
  73 debug levels can be specified, causing display of operation arguments
  74 and internal operations of the daemon.
  75 .It Fl g
  76 The
  77 .Fl g
  78 option allow to specify the
  79 .Ar grace period ,
  80 in seconds.
  81 During the grace period
  82 .Nm
  83 only accepts requests from hosts which are reinitialising locks which
  84 existed before the server restart.
  85 Default is 30 seconds.
  86 .It Fl w
  87 The
  88 .Fl w
  89 option tells
  90 .Nm
  91 to wait until the first client locking request is made before starting the
  92 locking daemon(s).  This may be used on NFS clients to defer starting the
  93 NFS locking daemons until it is known that they will be needed.  (Note:
  94 .Xr rpc.statd 8
  95 will also be started if it isn't already running)
  96 .El
  97 .Pp
  98 Error conditions are logged to syslog, irrespective of the debug level,
  99 using log level
 100 .Dv LOG_ERR
 101 and facility
 102 .Dv LOG_DAEMON .
 103 .Pp
 104 The
 105 .Nm
 106 utility must NOT be invoked by
 107 .Xr inetd 8
 108 because the protocol assumes that the daemon will run from system start time.
 109 Instead, it should be configured in
 110 .Xr rc.conf 5
 111 to run at system startup.
 112 .Sh FILES
 113 .Bl -tag -width /usr/include/rpcsvc/nlm_prot.x -compact
 114 .It Pa /usr/include/rpcsvc/nlm_prot.x
 115 RPC protocol specification for the network lock manager protocol.
 116 .El
 117 .Sh SEE ALSO
 118 .Xr syslog 3 ,
 119 .Xr rc.conf 5 ,
 120 .Xr rpc.statd 8
 121 .Sh BUGS
 122 The current implementation serialises locks requests that could be shared.
 123 .Sh STANDARDS
 124 The implementation is based on the specification in
 125 .Rs
 126 .%B "X/Open CAE Specification C218"
 127 .%T "Protocols for X/Open PC Interworking: XNFS, Issue 4"
 128 .%O ISBN 1 872630 66 9
 129 .Re
 130 .Sh HISTORY
 131 A version of
 132 .Nm
 133 appeared in
 134 .Tn SunOS
 135 4.