From 20578bda745098f23d12bdfdfa9247c70caec6e7 Mon Sep 17 00:00:00 2001 From: "Daniel P. Berrange" Date: Tue, 2 Feb 2010 18:46:52 +0000 Subject: [PATCH] Expand docs about clock modes * formatdomain.html.in: Document new clock options --- docs/formatdomain.html.in | 38 +++++++++++++++++++++++++++++++++++--- 1 file changed, 35 insertions(+), 3 deletions(-) diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index c4ba54f687..14d237198a 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -400,9 +400,41 @@
clock
-
The offset attribute takes either "utc" or - "localtime" to specify how the guest clock is initialized - in relation to the host OS. +
+

The offset attribute takes three possible + values, allowing fine grained control over how the guest + clock is synchronized to the host. NB, not all hypervisors + support all modes.

+
+
utc
+
+ The guest clock will always be synchronized to UTC when + booted
+
localtime
+
+ The guest clock will be synchronized to the host's configured + timezone when booted, if any. +
+
timezone
+
+ The guest clock will be synchronized to the requested timezone + using the timezone attribute. +
+
variable
+
+ The guest clock will have an arbitrary offset applied + relative to UTC. The delta relative to UTC is specified + in seconds, using the adjustment attribute. + The guest is free to adjust the RTC over time an expect + that it will be honoured at next reboot. This is in + contrast to 'utc' mode, where the RTC adjustments are + lost at each reboot. +
+
+

+ NB, at time of writing, only QEMU supports the variable + clock mode, or custom timezones. +