diff options
Diffstat (limited to 'usr.sbin/watchdogd/watchdogd.8')
-rw-r--r-- | usr.sbin/watchdogd/watchdogd.8 | 127 |
1 files changed, 127 insertions, 0 deletions
diff --git a/usr.sbin/watchdogd/watchdogd.8 b/usr.sbin/watchdogd/watchdogd.8 new file mode 100644 index 0000000..b00fef1 --- /dev/null +++ b/usr.sbin/watchdogd/watchdogd.8 @@ -0,0 +1,127 @@ +.\" Copyright (c) 2004 Poul-Henning Kamp <phk@FreeBSD.org> +.\" Copyright (c) 2003 Sean M. Kelly <smkelly@FreeBSD.org> +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd September 2, 2006 +.Dt WATCHDOGD 8 +.Os +.Sh NAME +.Nm watchdogd +.Nd watchdog daemon +.Sh SYNOPSIS +.Nm +.Op Fl d +.Op Fl e Ar cmd +.Op Fl I Ar file +.Op Fl s Ar sleep +.Op Fl t Ar timeout +.Sh DESCRIPTION +The +.Nm +utility interfaces with the kernel's watchdog facility to ensure +that the system is in a working state. +If +.Nm +is unable to interface with the kernel over a specific timeout, +the kernel will take actions to assist in debugging or restarting the computer. +.Pp +If +.Fl e Ar cmd +is specified, +.Nm +will attempt to execute this command with +.Xr system 3 , +and only if the command returns with a zero exit code will the +watchdog be reset. +If +.Fl e Ar cmd +is not specified, the daemon will perform a trivial file system +check instead. +.Pp +The +.Fl s Ar sleep +argument can be used to control the sleep period between each execution +of the check and defaults to one second. +.Pp +The +.Fl t Ar timeout +specifies the desired timeout period in seconds. +The default timeout is 16 seconds. +.Pp +One possible circumstance which will cause a watchdog timeout is an interrupt +storm. +If this occurs, +.Nm +will no longer execute and thus the kernel's watchdog routines will take +action after a configurable timeout. +.Pp +Upon receiving the +.Dv SIGTERM +or +.Dv SIGINT +signals, +.Nm +will first instruct the kernel to no longer perform watchdog checks and then +will terminate. +.Pp +The +.Nm +utility recognizes the following runtime options: +.Bl -tag -width ".Fl I Ar file" +.It Fl I Ar file +Write the process ID of the +.Nm +utility in the specified file. +.It Fl d +Do not fork. +When this option is specified, +.Nm +will not fork into the background at startup. +.El +.Sh FILES +.Bl -tag -width ".Pa /var/run/watchdogd.pid" -compact +.It Pa /var/run/watchdogd.pid +.El +.Sh SEE ALSO +.Xr watchdog 4 , +.Xr watchdog 8 , +.Xr watchdog 9 +.Sh HISTORY +The +.Nm +utility appeared in +.Fx 5.1 . +.Sh AUTHORS +.An -nosplit +The +.Nm +utility and manual page were written by +.An Sean Kelly Aq smkelly@FreeBSD.org +and +.An Poul-Henning Kamp Aq phk@FreeBSD.org . +.Pp +Some contributions made by +.An Jeff Roberson Aq jeff@FreeBSD.org . |