usr.sbin/watchdogd/watchdogd.8

   1 .\" $OpenBSD: jmc $
   2 .\"
   3 .\" Copyright (c) 2005 Marc Balmer <mbalmer@openbsd.org>
   4 .\"
   5 .\" Permission to use, copy, modify, and distribute this software for any
   6 .\" purpose with or without fee is hereby granted, provided that the above
   7 .\" copyright notice and this permission notice appear in all copies.
   8 .\"
   9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16 .\"
  17 .Dd $Mdocdate$
  18 .Dt WATCHDOGD 8
  19 .Os
  20 .Sh NAME
  21 .Nm watchdogd
  22 .Nd watchdog timer retrigger daemon
  23 .Sh SYNOPSIS
  24 .Nm watchdogd
  25 .Op Fl dnq
  26 .Op Fl i Ar interval
  27 .Op Fl p Ar period
  28 .Sh DESCRIPTION
  29 .Nm
  30 is a daemon to activate and periodically retrigger the
  31 .Xr watchdog 4
  32 timer device from userland.
  33 .Nm
  34 is designed to work in high load environments,
  35 where other methods
  36 (such as a shell script invoking
  37 .Xr sysctl 8 )
  38 would involve too much overhead.
  39 .Pp
  40 The basic premise is that
  41 after every
  42 .Ar interval
  43 seconds,
  44 .Nm
  45 resets the hardware timer to
  46 .Ar period .
  47 See also
  48 .Xr watchdog 4
  49 for more information on how watchdog timers work.
  50 .Pp
  51 The options are as follows:
  52 .Bl -tag -width Ds
  53 .It Fl d
  54 Do not daemonize.
  55 If this option is specified,
  56 .Nm
  57 will run in the foreground.
  58 .It Fl i Ar interval
  59 Specify how often, in seconds,
  60 .Nm
  61 should retrigger the hardware timer.
  62 If no interval is specified,
  63 the value of
  64 .Ar period
  65 (see below)
  66 divided by three is used.
  67 .It Fl n
  68 Do not restore the watchdog to its original values once it has been activated.
  69 With this set, the system will be rebooted by the watchdog even after a
  70 .Xr halt 8 .
  71 .It Fl p Ar period
  72 Set the hardware timer to expire in
  73 .Ar period
  74 seconds.
  75 The default is 30 seconds.
  76 .It Fl q
  77 Be quiet.
  78 With this option specified,
  79 .Nm
  80 will not output a warning message if the underlying hardware adjusted the
  81 timeout period.
  82 .El
  83 .Sh SEE ALSO
  84 .Xr watchdog 4 ,
  85 .Xr sysctl 8
  86 .Sh HISTORY
  87 The
  88 .Nm
  89 program
  90 first appeared in
  91 .Ox 3.8 .
  92 .Sh AUTHORS
  93 .Nm
  94 was written by
  95 .An Marc Balmer Aq mbalmer@openbsd.org .