d/freebsd-nq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
8ad3557f05
freebsd-nq/usr.sbin/watchdogd/watchdogd.8

127 lines
3.4 KiB
Groff
Raw Normal View History

Rename the WATCHDOG option to SW_WATCHDOG and make it use the generic watchdoc(9) interface. Make watchdogd(8) perform as watchdog(8) as well, and make it possible to specify a check command to run, timeout and sleep periods. Update watchdog(4) to talk about the generic interface and add new watchdog(8) page.
2004-02-28 20:56:35 +00:00
.\" Copyright (c) 2004 Poul-Henning Kamp <phk@FreeBSD.org>
- Add a software watchdog facility. This commit has two pieces. One half is the watchdog kernel code which lives primarily in hardclock() in sys/kern/kern_clock.c. The other half is a userland daemon which, when run, will keep the watchdog from firing while the userland is intact and functioning. Approved by: jeff (mentor)
2003-06-26 09:50:52 +00:00
.\" 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 June 25, 2003
.Dt WATCHDOGD 8
.Os
.Sh NAME
.Nm watchdogd
Rename the WATCHDOG option to SW_WATCHDOG and make it use the generic watchdoc(9) interface. Make watchdogd(8) perform as watchdog(8) as well, and make it possible to specify a check command to run, timeout and sleep periods. Update watchdog(4) to talk about the generic interface and add new watchdog(8) page.
2004-02-28 20:56:35 +00:00
.Nd Watchdog daemon
- Add a software watchdog facility. This commit has two pieces. One half is the watchdog kernel code which lives primarily in hardclock() in sys/kern/kern_clock.c. The other half is a userland daemon which, when run, will keep the watchdog from firing while the userland is intact and functioning. Approved by: jeff (mentor)
2003-06-26 09:50:52 +00:00
.Sh SYNOPSIS
.Nm
.Op Fl d
Rename the WATCHDOG option to SW_WATCHDOG and make it use the generic watchdoc(9) interface. Make watchdogd(8) perform as watchdog(8) as well, and make it possible to specify a check command to run, timeout and sleep periods. Update watchdog(4) to talk about the generic interface and add new watchdog(8) page.
2004-02-28 20:56:35 +00:00
.Op Fl e Ar cmd
- Add a software watchdog facility. This commit has two pieces. One half is the watchdog kernel code which lives primarily in hardclock() in sys/kern/kern_clock.c. The other half is a userland daemon which, when run, will keep the watchdog from firing while the userland is intact and functioning. Approved by: jeff (mentor)
2003-06-26 09:50:52 +00:00
.Op Fl I Ar file
Rename the WATCHDOG option to SW_WATCHDOG and make it use the generic watchdoc(9) interface. Make watchdogd(8) perform as watchdog(8) as well, and make it possible to specify a check command to run, timeout and sleep periods. Update watchdog(4) to talk about the generic interface and add new watchdog(8) page.
2004-02-28 20:56:35 +00:00
.Op Fl s Ar sleep
.Op Fl t Ar timeout
- Add a software watchdog facility. This commit has two pieces. One half is the watchdog kernel code which lives primarily in hardclock() in sys/kern/kern_clock.c. The other half is a userland daemon which, when run, will keep the watchdog from firing while the userland is intact and functioning. Approved by: jeff (mentor)
2003-06-26 09:50:52 +00:00
.Sh DESCRIPTION
The
.Nm
Rename the WATCHDOG option to SW_WATCHDOG and make it use the generic watchdoc(9) interface. Make watchdogd(8) perform as watchdog(8) as well, and make it possible to specify a check command to run, timeout and sleep periods. Update watchdog(4) to talk about the generic interface and add new watchdog(8) page.
2004-02-28 20:56:35 +00:00
utility interfaces with the kernel's watchdog facility to ensure
- Add a software watchdog facility. This commit has two pieces. One half is the watchdog kernel code which lives primarily in hardclock() in sys/kern/kern_clock.c. The other half is a userland daemon which, when run, will keep the watchdog from firing while the userland is intact and functioning. Approved by: jeff (mentor)
2003-06-26 09:50:52 +00:00
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
mdoc(7) janitor: - Remove EOL whitespace. - Expand contracted words. - Correct usage of .Fl macro. - Use complete argument to -width. - Remove redundant ','.
2004-04-25 14:09:38 +00:00
If
Rename the WATCHDOG option to SW_WATCHDOG and make it use the generic watchdoc(9) interface. Make watchdogd(8) perform as watchdog(8) as well, and make it possible to specify a check command to run, timeout and sleep periods. Update watchdog(4) to talk about the generic interface and add new watchdog(8) page.
2004-02-28 20:56:35 +00:00
.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
mdoc(7) janitor: - Remove EOL whitespace. - Expand contracted words. - Correct usage of .Fl macro. - Use complete argument to -width. - Remove redundant ','.
2004-04-25 14:09:38 +00:00
is not specified the daemon will perform a trivial file system
Rename the WATCHDOG option to SW_WATCHDOG and make it use the generic watchdoc(9) interface. Make watchdogd(8) perform as watchdog(8) as well, and make it possible to specify a check command to run, timeout and sleep periods. Update watchdog(4) to talk about the generic interface and add new watchdog(8) page.
2004-02-28 20:56:35 +00:00
check instead.
.Pp
The
mdoc(7) janitor: - Remove EOL whitespace. - Expand contracted words. - Correct usage of .Fl macro. - Use complete argument to -width. - Remove redundant ','.
2004-04-25 14:09:38 +00:00
.Fl s Ar sleep
Rename the WATCHDOG option to SW_WATCHDOG and make it use the generic watchdoc(9) interface. Make watchdogd(8) perform as watchdog(8) as well, and make it possible to specify a check command to run, timeout and sleep periods. Update watchdog(4) to talk about the generic interface and add new watchdog(8) page.
2004-02-28 20:56:35 +00:00
argument can be used to control the sleep period between each execution
of the check and defaults to one second.
.Pp
The
mdoc(7) janitor: - Remove EOL whitespace. - Expand contracted words. - Correct usage of .Fl macro. - Use complete argument to -width. - Remove redundant ','.
2004-04-25 14:09:38 +00:00
.Fl t Ar timeout
Rename the WATCHDOG option to SW_WATCHDOG and make it use the generic watchdoc(9) interface. Make watchdogd(8) perform as watchdog(8) as well, and make it possible to specify a check command to run, timeout and sleep periods. Update watchdog(4) to talk about the generic interface and add new watchdog(8) page.
2004-02-28 20:56:35 +00:00
specifies the desired timeout period in seconds.
.Pp
- Add a software watchdog facility. This commit has two pieces. One half is the watchdog kernel code which lives primarily in hardclock() in sys/kern/kern_clock.c. The other half is a userland daemon which, when run, will keep the watchdog from firing while the userland is intact and functioning. Approved by: jeff (mentor)
2003-06-26 09:50:52 +00:00
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
mdoc(7) janitor: - Remove EOL whitespace. - Expand contracted words. - Correct usage of .Fl macro. - Use complete argument to -width. - Remove redundant ','.
2004-04-25 14:09:38 +00:00
will terminate.
- Add a software watchdog facility. This commit has two pieces. One half is the watchdog kernel code which lives primarily in hardclock() in sys/kern/kern_clock.c. The other half is a userland daemon which, when run, will keep the watchdog from firing while the userland is intact and functioning. Approved by: jeff (mentor)
2003-06-26 09:50:52 +00:00
.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
mdoc(7) janitor: - Remove EOL whitespace. - Expand contracted words. - Correct usage of .Fl macro. - Use complete argument to -width. - Remove redundant ','.
2004-04-25 14:09:38 +00:00
Do not fork.
- Add a software watchdog facility. This commit has two pieces. One half is the watchdog kernel code which lives primarily in hardclock() in sys/kern/kern_clock.c. The other half is a userland daemon which, when run, will keep the watchdog from firing while the userland is intact and functioning. Approved by: jeff (mentor)
2003-06-26 09:50:52 +00:00
When this option is specified,
.Nm
will not fork into the background at startup.
.El
.Sh FILES
mdoc(7) janitor: - Remove EOL whitespace. - Expand contracted words. - Correct usage of .Fl macro. - Use complete argument to -width. - Remove redundant ','.
2004-04-25 14:09:38 +00:00
.Bl -tag -width ".Pa /var/run/watchdogd.pid" -compact
- Add a software watchdog facility. This commit has two pieces. One half is the watchdog kernel code which lives primarily in hardclock() in sys/kern/kern_clock.c. The other half is a userland daemon which, when run, will keep the watchdog from firing while the userland is intact and functioning. Approved by: jeff (mentor)
2003-06-26 09:50:52 +00:00
.It Pa /var/run/watchdogd.pid
.El
.Sh SEE ALSO
.Xr watchdog 4 ,
Rename the WATCHDOG option to SW_WATCHDOG and make it use the generic watchdoc(9) interface. Make watchdogd(8) perform as watchdog(8) as well, and make it possible to specify a check command to run, timeout and sleep periods. Update watchdog(4) to talk about the generic interface and add new watchdog(8) page.
2004-02-28 20:56:35 +00:00
.Xr watchdog 8 ,
mdoc(7) janitor: - Remove EOL whitespace. - Expand contracted words. - Correct usage of .Fl macro. - Use complete argument to -width. - Remove redundant ','.
2004-04-25 14:09:38 +00:00
.Xr watchdog 9
- Add a software watchdog facility. This commit has two pieces. One half is the watchdog kernel code which lives primarily in hardclock() in sys/kern/kern_clock.c. The other half is a userland daemon which, when run, will keep the watchdog from firing while the userland is intact and functioning. Approved by: jeff (mentor)
2003-06-26 09:50:52 +00:00
.Sh AUTHORS
.An -nosplit
The
.Nm
utility and manual page were written by
mdoc(7) janitor: - Remove EOL whitespace. - Expand contracted words. - Correct usage of .Fl macro. - Use complete argument to -width. - Remove redundant ','.
2004-04-25 14:09:38 +00:00
.An Sean Kelly Aq smkelly@FreeBSD.org
Rename the WATCHDOG option to SW_WATCHDOG and make it use the generic watchdoc(9) interface. Make watchdogd(8) perform as watchdog(8) as well, and make it possible to specify a check command to run, timeout and sleep periods. Update watchdog(4) to talk about the generic interface and add new watchdog(8) page.
2004-02-28 20:56:35 +00:00
and
.An Poul-Henning Kamp Aq phk@FreeBSD.org .
- Add a software watchdog facility. This commit has two pieces. One half is the watchdog kernel code which lives primarily in hardclock() in sys/kern/kern_clock.c. The other half is a userland daemon which, when run, will keep the watchdog from firing while the userland is intact and functioning. Approved by: jeff (mentor)
2003-06-26 09:50:52 +00:00
.Pp
Some contributions made by
.An Jeff Roberson Aq jeff@FreeBSD.org .
.Sh HISTORY
The
.Nm
utility appeared in
.Fx 5.1 .
Reference in New Issue Copy Permalink