No empty .Rs/.Re
[netbsd-mini2440.git] / share / man / man4 / swwdog.4
blob777f251bb608331e76fab43b29c7b3e2604a57ae
1 .\"     $NetBSD: swwdog.4,v 1.2 2005/01/11 11:32:11 wiz Exp $
2 .\"
3 .\" Copyright (c) 2004, 2005 Steven M. Bellovin
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 NetBSD
17 .\"        Foundation, Inc. and its contributors.
18 .\" 4. Neither the name of the author nor the names of its
19 .\"    contributors may be used to endorse or promote products derived
20 .\"    from this software without specific prior written permission.
21 .\"
22 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS
23 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
24 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
25 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS
26 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32 .\" POSSIBILITY OF SUCH DAMAGE.
33 .\"
34 .Dd January 6, 2005
35 .\" Written by Steven M. Bellovin
36 .Dt SWWDOG 4
37 .Os
38 .Sh NAME
39 .Nm swwdog
40 .Nd software watchdog timer
41 .Sh SYNOPSIS
42 .Cd "pseudo-device swwdog" Op Ar count
43 .Sh DESCRIPTION
44 The
45 .Nm
46 driver provides a software watchdog timer that works with
47 .Xr wdogctl 8 .
48 If the timer expires, the system reboots unless the variable
49 .Va swwdog_panic
50 is non-zero; if it is, the system will panic instead.
51 .Pp
52 The default period of
53 .Nm
54 is 60 seconds.
55 .Sh SEE ALSO
56 .Xr wdogctl 8
57 .Sh HISTORY
58 The
59 .Nm
60 driver was written by
61 .An Steven M. Bellovin .
62 .Sh BUGS
63 Although more than one
64 .Nm
65 timer can be configured, it's a pointless thing to do, since only
66 one watchdog timer can be active at any given time.
67 Arguably, this is a bug in the watchdog timer framework.
68 .Pp
69 Kernel tickle mode is useless with
70 .Nm
71 and arguably should be rejected, since both it and
72 this driver rely on the same callout mechanism; if one is
73 blocked, almost certainly the other is as well.
74 .Pp
75 The alarm option to
76 .Xr wdogctl 8
77 isn't implemented.