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 November 2, 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 h Ar bindip
  47 .Op Fl p Ar port
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 utility provides monitored and unmonitored file and record locking services
  52 in an NFS environment.
  53 To monitor the status of hosts requesting locks,
  54 the locking daemon typically operates in conjunction
  55 with
  56 .Xr rpc.statd 8 .
  57 .Pp
  58 Options and operands available for
  59 .Nm :
  60 .Bl -tag -width indent
  61 .It Fl d
  62 The
  63 .Fl d
  64 option causes debugging information to be written to syslog, recording
  65 all RPC transactions to the daemon.
  66 These messages are logged with level
  67 .Dv LOG_DEBUG
  68 and facility
  69 .Dv LOG_DAEMON .
  70 Specifying a
  71 .Ar debug_level
  72 of 1 results
  73 in the generation of one log line per protocol operation.
  74 Higher
  75 debug levels can be specified, causing display of operation arguments
  76 and internal operations of the daemon.
  77 .It Fl g
  78 The
  79 .Fl g
  80 option allow to specify the
  81 .Ar grace period ,
  82 in seconds.
  83 During the grace period
  84 .Nm
  85 only accepts requests from hosts which are reinitialising locks which
  86 existed before the server restart.
  87 Default is 30 seconds.
  88 .It Fl h Ar bindip
  89 Specify specific IP addresses to bind to.
  90 This option may be specified multiple times.
  91 If no
  92 .Fl h
  93 option is specified,
  94 .Nm
  95 will bind to
  96 .Dv INADDR_ANY .
  97 Note that when specifying IP addresses with
  98 .Fl h ,
  99 .Nm
 100 will automatically add
 101 .Li 127.0.0.1
 102 and if IPv6 is enabled,
 103 .Li ::1
 104 to the list.
 105 .It Fl p
 106 The
 107 .Fl p
 108 option allow to force the daemon to bind to the specified
 109 .Ar port ,
 110 for both AF_INET and AF_INET6 address families.
 111 .El
 112 .Pp
 113 Error conditions are logged to syslog, irrespective of the debug level,
 114 using log level
 115 .Dv LOG_ERR
 116 and facility
 117 .Dv LOG_DAEMON .
 118 .Pp
 119 The
 120 .Nm
 121 utility must NOT be invoked by
 122 .Xr inetd 8
 123 because the protocol assumes that the daemon will run from system start time.
 124 Instead, it should be configured in
 125 .Xr rc.conf 5
 126 to run at system startup.
 127 .Sh FILES
 128 .Bl -tag -width /usr/include/rpcsvc/nlm_prot.x -compact
 129 .It Pa /usr/include/rpcsvc/nlm_prot.x
 130 RPC protocol specification for the network lock manager protocol.
 131 .El
 132 .Sh SEE ALSO
 133 .Xr syslog 3 ,
 134 .Xr rc.conf 5 ,
 135 .Xr rpc.statd 8
 136 .Sh STANDARDS
 137 The implementation is based on the specification in
 138 .Rs
 139 .%B "X/Open CAE Specification C218"
 140 .%T "Protocols for X/Open PC Interworking: XNFS, Issue 4"
 141 .%O ISBN 1 872630 66 9
 142 .Re
 143 .Sh HISTORY
 144 A version of
 145 .Nm
 146 appeared in
 147 .Tn SunOS
 148 4.
 149 .Sh BUGS
 150 The current implementation serialises locks requests that could be shared.