From 70d46b51e2f80f808c91f264f501cca1ca7af2b5 Mon Sep 17 00:00:00 2001 From: Leigh Brown Date: Tue, 23 Apr 2024 14:11:14 +0200 Subject: [PATCH] docs/man: Add xenwatchdog manual page Add a manual page for xenwatchdogd. Signed-off-by: Leigh Brown Reviewed-by: Anthony PERARD --- docs/man/xenwatchdogd.8.pod | 55 +++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 docs/man/xenwatchdogd.8.pod diff --git a/docs/man/xenwatchdogd.8.pod b/docs/man/xenwatchdogd.8.pod new file mode 100644 index 0000000000..b03ed53ee6 --- /dev/null +++ b/docs/man/xenwatchdogd.8.pod @@ -0,0 +1,55 @@ +=head1 NAME + +xenwatchdogd - Xen hypercall based watchdog daemon + +=head1 SYNOPSIS + +B [ I ] > [ > ] + +=head1 DESCRIPTION + +B arms the Xen watchdog timer to I every I +seconds. If the xenwatchdogd process dies or is delayed for more than +I seconds, then Xen will take the B action +specified in the domain configuration (see xl.cfg(5)). If B +is running in dom0, the whole system will reboot. + +=head1 OPTIONS + +=over 4 + +=item B<-h>, B<--help> + +Display a help message. + +=item B<-F>, B<--foreground> + +Run in the foreground. The default behaviour is to daemonize. + +=item B<-x>, B<--safe-exit> + +Disable watchdog on orderly exit. The default behaviour is to arm the +watchdog to 300 seconds to allow time for the domain to shutdown. See +also the B section. + +=item B + +The number of seconds to arm the Xen watchdog timer. This must be set to +a minimum of two. + +=item B + +The number of seconds to sleep in between calls to arm the Xen watchdog +timer. This must be at least one second, and less than the I +value. If not specified, it defaults to half the I value. + +=back + +=head1 SIGNALS + +B Will cause the program to disarm the watchdog timer and exit, +regardless of whether the B<--safe-exit> option was passed. + +=head1 AUTHOR + +Citrix Ltd and other contributors. -- 2.39.5