From d5dce3e452e19914d3a6896a99d69f59ad643520 Mon Sep 17 00:00:00 2001 From: "kaf24@firebug.cl.cam.ac.uk" Date: Tue, 1 Nov 2005 10:36:19 +0100 Subject: The following patch adds a section for SHUTDOWN OPTIONS for the xmdomain.cfg man page. It documents the new set of options introduced over the last few weeks. Signed-off-by: Sean Dague --- docs/man/xmdomain.cfg.pod.5 | 51 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) (limited to 'docs/man/xmdomain.cfg.pod.5') diff --git a/docs/man/xmdomain.cfg.pod.5 b/docs/man/xmdomain.cfg.pod.5 index b1c661ee87..ad38ca09a2 100644 --- a/docs/man/xmdomain.cfg.pod.5 +++ b/docs/man/xmdomain.cfg.pod.5 @@ -72,6 +72,57 @@ A bare minimal config file example might be as follows: =item I +=back + +=head1 DOMAIN SHUTDOWN OPTIONS + +There are 3 options which control domain shutdown (both planned and +unplanned) under certain events. The 3 events currently captured are: + +=over 4 + +=item I + +Triggered on either an I or graceful shutdown from inside +the DomU. + +=item I + +Triggered on either an I or graceful reboot from inside the +DomU. + +=item I + +Triggered when a DomU goes to the crashed state for any reason. + +=back + +All of them take one of 4 valid states listed below. + +=over 4 + +=item I + +The domain will be cleaned up completely. No attempt at respawning +will occur. This is what a typical shutdown would look like. + +=item I + +The domain will be restarted with the same name as the old domain. +This is what a typical reboot would look like. + +=item I + +The domain will not be cleaned up at all. This is often useful for +crash state domains which ensures that enough evidence is to debug the +real issue. + +=item I + +The old domain will not be cleaned up, but will be renamed so a new +domain can be restarted in it's place. (TODO: what does this mean for +resources? What is the renamed name?) + =back =head1 SEE ALSO -- cgit v1.2.3