d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
f36c2bbe0c
freebsd-dev/share/man/man4/watchdog.4

102 lines
3.0 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>
Fix up a little language. Remove reference to sysctl(9). Fix reference to watchdog(9) (was watchdogd(9)).
2004-04-28 21:42:36 +00:00
.\" Copyright (c) 2003, 2004 Sean M. Kelly <smkelly@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
.\" 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
Yield to ru's ninja-like manpage skills and update watchdog(4) to look more like other manpages. Move some content around, use an EXAMPLES section, etc. Submitted by: ru
2004-06-19 21:17:07 +00:00
.Dt WATCHDOG 4
- 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
.Os
.Sh NAME
.Nm watchdog
Yield to ru's ninja-like manpage skills and update watchdog(4) to look more like other manpages. Move some content around, use an EXAMPLES section, etc. Submitted by: ru
2004-06-19 21:17:07 +00:00
.Nd "hardware and software watchdog"
- 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
Yield to ru's ninja-like manpage skills and update watchdog(4) to look more like other manpages. Move some content around, use an EXAMPLES section, etc. Submitted by: ru
2004-06-19 21:17:07 +00:00
.Cd "options CPU_ELAN"
.Cd "options CPU_GEODE"
.Cd "options SW_WATCHDOG"
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
.Pp
.In sys/watchdog.h
- 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
Yield to ru's ninja-like manpage skills and update watchdog(4) to look more like other manpages. Move some content around, use an EXAMPLES section, etc. Submitted by: ru
2004-06-19 21:17:07 +00:00
The
- 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
.Nm
Yield to ru's ninja-like manpage skills and update watchdog(4) to look more like other manpages. Move some content around, use an EXAMPLES section, etc. Submitted by: ru
2004-06-19 21:17:07 +00:00
facility is used for controlling hardware and software watchdogs.
- 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
o Document /dev/fido. PR: docs/85425 Approved by: phk MFC after: 2 weeks
2006-04-15 17:52:02 +00:00
The interface is through a device
.Pa /dev/fido
Yield to ru's ninja-like manpage skills and update watchdog(4) to look more like other manpages. Move some content around, use an EXAMPLES section, etc. Submitted by: ru
2004-06-19 21:17:07 +00:00
which responds to a single
.Xr ioctl 2
call,
Add more .Dv markup.
2004-04-29 08:33:12 +00:00
.Dv WDIOCPATPAT .
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
.Pp
Yield to ru's ninja-like manpage skills and update watchdog(4) to look more like other manpages. Move some content around, use an EXAMPLES section, etc. Submitted by: ru
2004-06-19 21:17:07 +00:00
The call takes a single argument which represents a timeout value
Fix up a little language. Remove reference to sysctl(9). Fix reference to watchdog(9) (was watchdogd(9)).
2004-04-28 21:42:36 +00:00
specified as an integer power of two nanoseconds.
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
.Pp
Add missing .Dv markup and a comma.
2004-04-29 08:27:38 +00:00
The
.Dv WD_ACTIVE
Yield to ru's ninja-like manpage skills and update watchdog(4) to look more like other manpages. Move some content around, use an EXAMPLES section, etc. Submitted by: ru
2004-06-19 21:17:07 +00:00
flag signals that the
.Nm
will be kept from
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
timing out from userland, for instance by the
.Xr watchdogd 8
daemon.
.Pp
Yield to ru's ninja-like manpage skills and update watchdog(4) to look more like other manpages. Move some content around, use an EXAMPLES section, etc. Submitted by: ru
2004-06-19 21:17:07 +00:00
To disable the watchdogs, an argument of zero should be used.
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
.Pp
Yield to ru's ninja-like manpage skills and update watchdog(4) to look more like other manpages. Move some content around, use an EXAMPLES section, etc. Submitted by: ru
2004-06-19 21:17:07 +00:00
The
.Xr ioctl 2
call will return success if just one of the available
.Xr watchdog 9
implementations support the request.
If the call fails, for instance if none of
.Xr watchdog 9
implementations support the timeout
length, all watchdogs are disabled and must be explicitly re-enabled.
.Sh EXAMPLES
.\" XXX insert some descriptive text here
.Bd -literal -offset indent
u_int u = WD_ACTIVE | WD_TO_8SEC;
o Document /dev/fido. PR: docs/85425 Approved by: phk MFC after: 2 weeks
2006-04-15 17:52:02 +00:00
int fd = open("/dev/fido", O_RDWR);
Yield to ru's ninja-like manpage skills and update watchdog(4) to look more like other manpages. Move some content around, use an EXAMPLES section, etc. Submitted by: ru
2004-06-19 21:17:07 +00:00
ioctl(fd, WDIOCPATPAT, &u);
.Ed
- 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 SEE ALSO
Add missing .Dv markup and a comma.
2004-04-29 08:27:38 +00:00
.Xr watchdogd 8 ,
Fix up a little language. Remove reference to sysctl(9). Fix reference to watchdog(9) (was watchdogd(9)).
2004-04-28 21:42:36 +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 HISTORY
The
.Nm
code first appeared in
.Fx 5.1 .
.Sh AUTHORS
.An -nosplit
The
Yield to ru's ninja-like manpage skills and update watchdog(4) to look more like other manpages. Move some content around, use an EXAMPLES section, etc. Submitted by: ru
2004-06-19 21:17:07 +00:00
.Nm
facility was written by
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
.An Poul-Henning Kamp Aq phk@FreeBSD.org .
Yield to ru's ninja-like manpage skills and update watchdog(4) to look more like other manpages. Move some content around, use an EXAMPLES section, etc. Submitted by: ru
2004-06-19 21:17:07 +00:00
The software watchdog code
and this manual page were written by
- 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
.An Sean Kelly Aq smkelly@FreeBSD.org .
Some contributions were made by
.An Jeff Roberson Aq jeff@FreeBSD.org .
Reference in New Issue Copy Permalink