From patchwork Thu Apr 11 18:20:23 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Leigh Brown X-Patchwork-Id: 13626515 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from lists.xenproject.org (lists.xenproject.org [192.237.175.120]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id B3168C001CC for ; Thu, 11 Apr 2024 18:20:48 +0000 (UTC) Received: from list by lists.xenproject.org with outflank-mailman.704123.1100313 (Exim 4.92) (envelope-from ) id 1ruz2O-0005NE-Pc; Thu, 11 Apr 2024 18:20:40 +0000 X-Outflank-Mailman: Message body and most headers restored to incoming version Received: by outflank-mailman (output) from mailman id 704123.1100313; Thu, 11 Apr 2024 18:20:40 +0000 Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1ruz2O-0005Lr-GI; Thu, 11 Apr 2024 18:20:40 +0000 Received: by outflank-mailman (input) for mailman id 704123; Thu, 11 Apr 2024 18:20:40 +0000 Received: from se1-gles-flk1-in.inumbo.com ([94.247.172.50] helo=se1-gles-flk1.inumbo.com) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1ruz2N-0004xS-TJ for xen-devel@lists.xenproject.org; Thu, 11 Apr 2024 18:20:39 +0000 Received: from doppler.solinno.uk (doppler.solinno.uk [81.2.106.178]) by se1-gles-flk1.inumbo.com (Halon) with ESMTPS id 31d25aa9-f830-11ee-94a3-07e782e9044d; Thu, 11 Apr 2024 20:20:37 +0200 (CEST) Received: from folly.solinno.co.uk (folly.dyn.solinno.co.uk [192.168.2.135]) by doppler.solinno.uk (Postfix) with ESMTPSA id 32CC6800AC; Thu, 11 Apr 2024 19:20:37 +0100 (BST) Received: by folly.solinno.co.uk (Postfix, from userid 1000) id 0CE7B2017C; Thu, 11 Apr 2024 19:20:37 +0100 (BST) X-BeenThere: xen-devel@lists.xenproject.org List-Id: Xen developer discussion List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Errors-To: xen-devel-bounces@lists.xenproject.org Precedence: list Sender: "Xen-devel" X-Inumbo-ID: 31d25aa9-f830-11ee-94a3-07e782e9044d DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=solinno.co.uk; s=mail; t=1712859637; bh=YwGv2PhPp4Evj73ZY3lHmUchew8hvcOMY1tjrOsWuo8=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=jyK+6dO6x07zzohtd7D+p7nxPLtdOzqIerpifvQGmAwcDx40I3xLG/VGQD9reAVH+ zoKDfCFwo/Ddp+WuY1g5MOYRqcP5rxC9a6HeLv+9V53Bqc0zpNzFYWu3hLyO95jkRM FBeYwGmSn49U4U3w9RWJhI5MT0pRty+vq0aBtZy0= From: leigh@solinno.co.uk To: xen-devel@lists.xenproject.org Cc: andrew.cooper3@citrix.com, anthony.perard@citrix.com, slack@rabbit.lu, Leigh Brown Subject: [PATCH v3 4/4] docs/man: Add xenwatchdog manual page Date: Thu, 11 Apr 2024 19:20:23 +0100 Message-Id: <20240411182023.56309-5-leigh@solinno.co.uk> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20240411182023.56309-1-leigh@solinno.co.uk> References: <20240411182023.56309-1-leigh@solinno.co.uk> MIME-Version: 1.0 From: Leigh Brown 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.