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$
  35 .\"
  36 .Dd April 3, 2007
  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 p Ar port
  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 p
  88 The
  89 .Fl p
  90 option allow to force the daemon to bind to the specified
  91 .Ar port ,
  92 for both AF_INET and AF_INET6 address families.
  93 .El
  94 .Pp
  95 Error conditions are logged to syslog, irrespective of the debug level,
  96 using log level
  97 .Dv LOG_ERR
  98 and facility
  99 .Dv LOG_DAEMON .
 100 .Pp
 101 The
 102 .Nm
 103 utility must NOT be invoked by
 104 .Xr inetd 8
 105 because the protocol assumes that the daemon will run from system start time.
 106 Instead, it should be configured in
 107 .Xr rc.conf 5
 108 to run at system startup.
 109 .Sh FILES
 110 .Bl -tag -width /usr/include/rpcsvc/nlm_prot.x -compact
 111 .It Pa /usr/include/rpcsvc/nlm_prot.x
 112 RPC protocol specification for the network lock manager protocol.
 113 .El
 114 .Sh SEE ALSO
 115 .Xr syslog 3 ,
 116 .Xr rc.conf 5 ,
 117 .Xr rpc.statd 8
 118 .Sh STANDARDS
 119 The implementation is based on the specification in
 120 .Rs
 121 .%B "X/Open CAE Specification C218"
 122 .%T "Protocols for X/Open PC Interworking: XNFS, Issue 4"
 123 .%O ISBN 1 872630 66 9
 124 .Re
 125 .Sh HISTORY
 126 A version of
 127 .Nm
 128 appeared in
 129 .Tn SunOS
 130 4.
 131 .Sh BUGS
 132 The current implementation serialises locks requests that could be shared.