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. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\" $FreeBSD$
  31 .\"
  32 .Dd November 2, 2007
  33 .Dt RPC.LOCKD 8
  34 .Os
  35 .Sh NAME
  36 .Nm rpc.lockd
  37 .Nd NFS file locking daemon
  38 .Sh SYNOPSIS
  39 .Nm
  40 .Op Fl d Ar debug_level
  41 .Op Fl g Ar grace period
  42 .Op Fl h Ar bindip
  43 .Op Fl p Ar port
  44 .Sh DESCRIPTION
  45 The
  46 .Nm
  47 utility provides monitored and unmonitored file and record locking services
  48 in an NFS environment.
  49 To monitor the status of hosts requesting locks,
  50 the locking daemon typically operates in conjunction
  51 with
  52 .Xr rpc.statd 8 .
  53 .Pp
  54 Options and operands available for
  55 .Nm :
  56 .Bl -tag -width indent
  57 .It Fl d
  58 The
  59 .Fl d
  60 option causes debugging information to be written to syslog, recording
  61 all RPC transactions to the daemon.
  62 These messages are logged with level
  63 .Dv LOG_DEBUG
  64 and facility
  65 .Dv LOG_DAEMON .
  66 Specifying a
  67 .Ar debug_level
  68 of 1 results
  69 in the generation of one log line per protocol operation.
  70 Higher
  71 debug levels can be specified, causing display of operation arguments
  72 and internal operations of the daemon.
  73 .It Fl g
  74 The
  75 .Fl g
  76 option allow to specify the
  77 .Ar grace period ,
  78 in seconds.
  79 During the grace period
  80 .Nm
  81 only accepts requests from hosts which are reinitialising locks which
  82 existed before the server restart.
  83 Default is 30 seconds.
  84 .It Fl h Ar bindip
  85 Specify specific IP addresses to bind to.
  86 This option may be specified multiple times.
  87 If no
  88 .Fl h
  89 option is specified,
  90 .Nm
  91 will bind to
  92 .Dv INADDR_ANY .
  93 Note that when specifying IP addresses with
  94 .Fl h ,
  95 .Nm
  96 will automatically add
  97 .Li 127.0.0.1
  98 and if IPv6 is enabled,
  99 .Li ::1
 100 to the list.
 101 .It Fl p
 102 The
 103 .Fl p
 104 option allow to force the daemon to bind to the specified
 105 .Ar port ,
 106 for both AF_INET and AF_INET6 address families.
 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 STANDARDS
 133 The implementation is based on the specification in
 134 .Rs
 135 .%B "X/Open CAE Specification C218"
 136 .%T "Protocols for X/Open PC Interworking: XNFS, Issue 4"
 137 .%O ISBN 1 872630 66 9
 138 .Re
 139 .Sh HISTORY
 140 A version of
 141 .Nm
 142 appeared in
 143 .Tn SunOS
 144 4.
 145 .Sh BUGS
 146 The current implementation serialises locks requests that could be shared.