Sweep-fix man page section order to match mdoc(7), part 5/5.
[dragonfly.git] / usr.sbin / rpc.statd / rpc.statd.8
1 .\" -*- nroff -*-
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: src/usr.sbin/rpc.statd/rpc.statd.8,v 1.7.2.4 2003/03/11 22:31:32 trhodes Exp $
35 .\" $DragonFly: src/usr.sbin/rpc.statd/rpc.statd.8,v 1.3 2006/02/17 19:40:24 swildner Exp $
36 .\"
37 .Dd September 19, 1995
38 .Dt RPC.STATD 8
39 .Os
40 .Sh NAME
41 .Nm rpc.statd
42 .Nd host status monitoring daemon
43 .Sh SYNOPSIS
44 .Nm
45 .Op Fl d
46 .Sh DESCRIPTION
47 The
48 .Nm
49 utility
50 is a daemon which co-operates with
51 .Nm
52 daemons on other hosts to provide
53 a status monitoring service.  The daemon accepts requests from
54 programs running on the local host (typically,
55 .Xr rpc.lockd 8 ,
56 the NFS file locking daemon) to monitor the status of specified
57 hosts.  If a monitored host crashes and restarts, the remote daemon will
58 notify the local daemon, which in turn will notify the local program(s)
59 which requested the monitoring service.  Conversely, if this host crashes
60 and re-starts, when the
61 .Nm
62 re-starts, it will notify all of the hosts which were being monitored
63 at the time of the crash.
64 .Pp
65 The following option is available:
66 .Bl -tag -width indent
67 .It Fl d
68 Cause debugging information to be written to syslog, recording
69 all RPC transactions to the daemon.  These messages are logged with level
70 LOG_DEBUG and facility LOG_DAEMON.  Error conditions are logged irrespective
71 of this option, using level LOG_ERR.
72 .El
73 .Pp
74 The
75 .Nm
76 utility must NOT be invoked by
77 .Xr inetd 8
78 because the protocol assumes that the daemon will run from system start time.
79 Instead, it should be run from
80 .Xr rc 8
81 after the network has been started.
82 .Sh FILES
83 .Bl -tag -width /usr/include/rpcsvc/sm_inter.x -compact
84 .It Pa /var/db/statd.status
85 non-volatile record of currently monitored hosts.
86 .It Pa /usr/include/rpcsvc/sm_inter.x
87 RPC protocol specification used by local applications to register monitoring requests.
88 .El
89 .Sh SEE ALSO
90 .Xr syslog 3 ,
91 .Xr rc 8 ,
92 .Xr rpc.lockd 8
93 .Sh STANDARDS
94 The implementation is based on the specification in X/Open CAE Specification
95 C218, "Protocols for X/Open PC Interworking: XNFS, Issue 4", ISBN 1 872630 66 9
96 .Sh BUGS
97 There is no means for the daemon to tell when a monitored host has
98 disappeared permanently (eg. catastrophic hardware failure), as opposed
99 to transient failure of the host or an intermediate router.  At present,
100 it will re-try notification attempts at frequent intervals for 10 minutes,
101 then hourly, and finally gives up after 24 hours.
102 .Pp
103 The protocol requires that symmetric monitor requests are made to both
104 the local and remote daemon in order to establish a monitored relationship.
105 This is convenient for the NFS locking protocol, but probably reduces the
106 usefulness of the monitoring system for other applications.
107 .Pp
108 The current implementation uses more than 1Kbyte per monitored host in
109 the status file (and also in VM).  This may be inefficient for NFS servers
110 with large numbers of clients.