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 .Op Fl x Ar statd cache period
  47 .Sh DESCRIPTION
  48 The
  49 .Nm
  50 utility provides monitored and unmonitored file and record locking services
  51 in an NFS environment.
  52 To monitor the status of hosts requesting locks,
  53 the locking daemon typically operates in conjunction
  54 with
  55 .Xr rpc.statd 8 .
  56 .Pp
  57 Options and operands available for
  58 .Nm :
  59 .Bl -tag -width indent
  60 .It Fl d
  61 The
  62 .Fl d
  63 option causes debugging information to be written to syslog, recording
  64 all RPC transactions to the daemon.
  65 These messages are logged with level
  66 .Dv LOG_DEBUG
  67 and facility
  68 .Dv LOG_DAEMON .
  69 Specifying a
  70 .Ar debug_level
  71 of 1 results
  72 in the generation of one log line per protocol operation.
  73 Higher
  74 debug levels can be specified, causing display of operation arguments
  75 and internal operations of the daemon.
  76 .It Fl g
  77 The
  78 .Fl g
  79 option allow to specify the
  80 .Ar grace period ,
  81 in seconds.
  82 During the grace period
  83 .Nm
  84 only accepts requests from hosts which are reinitialising locks which
  85 existed before the server restart.
  86 Default is 30 seconds.
  87 .It Fl w
  88 The
  89 .Fl w
  90 option tells
  91 .Nm
  92 to wait until the first client locking request is made before starting the
  93 locking daemon(s).  This may be used on NFS clients to defer starting the
  94 NFS locking daemons until it is known that they will be needed.  (Note:
  95 .Xr rpc.statd 8
  96 will also be started if it isn't already running)
  97 .It Fl x
  98 The
  99 .Fl x
 100 option tells rpc.lockd how long to cache state records for contacting
 101 client
 102 .Xr rpc.statd 8
 103 implementations.  Setting it to zero will disable the cache which will
 104 make lock and unlock requests from a single client more expensive because
 105 of additional interaction with the client's statd.  The default cache time
 106 is 60 seconds.
 107 .El
 108 .Pp
 109 Error conditions are logged to syslog, irrespective of the debug level,
 110 using log level
 111 .Dv LOG_ERR
 112 and facility
 113 .Dv LOG_DAEMON .
 114 .Pp
 115 The
 116 .Nm
 117 utility must NOT be invoked by
 118 .Xr inetd 8
 119 because the protocol assumes that the daemon will run from system start time.
 120 Instead, it should be configured in
 121 .Xr rc.conf 5
 122 to run at system startup.
 123 .Sh FILES
 124 .Bl -tag -width /usr/include/rpcsvc/nlm_prot.x -compact
 125 .It Pa /usr/include/rpcsvc/nlm_prot.x
 126 RPC protocol specification for the network lock manager protocol.
 127 .El
 128 .Sh SEE ALSO
 129 .Xr syslog 3 ,
 130 .Xr rc.conf 5 ,
 131 .Xr rpc.statd 8
 132 .Sh BUGS
 133 The current implementation serialises locks requests that could be shared.
 134 .Sh STANDARDS
 135 The implementation is based on the specification in
 136 .Rs
 137 .%B "X/Open CAE Specification C218"
 138 .%T "Protocols for X/Open PC Interworking: XNFS, Issue 4"
 139 .%O ISBN 1 872630 66 9
 140 .Re
 141 .Sh HISTORY
 142 A version of
 143 .Nm
 144 appeared in
 145 .Tn SunOS
 146 4.