diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index 5269cc5edc..f9a153bd64 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -411,13 +411,18 @@
... - <clock offset="localtime"/> + <clock offset="localtime"> + <timer name="rtc" tickpolicy="catchup" track="guest"> + <catchup threshold=123 slew=120 limit=10000/> + </timer> + <timer name="pit" tickpolicy="none"/> + </clock> ...
clock
The offset
attribute takes three possible
+
The offset
attribute takes four possible
values, allowing fine grained control over how the guest
clock is synchronized to the host. NB, not all hypervisors
support all modes.
timezone
attribute.
+ Since 0.7.7
variable
- NB, at time of writing, only QEMU supports the variable
- clock mode, or custom timezones.
+ A clock
may have zero or more
+ timer
sub-elements. Since
+ 0.8.0
timer
+ Each timer element requires a name
attribute,
+ and has other optional attributes that depend on
+ the name
specified. Various hypervisors
+ support different combinations of attributes.
+
name
name
attribute selects which timer is
+ being modified, and can be one of "platform", "pit",
+ "rtc", "hpet", or "tsc".
+ track
track
attribute specifies what the timer
+ tracks, and can be "boot", "guest", or "wall".
+ Only valid for name="rtc"
+ or name="platform"
.
+ tickpolicy
tickpolicy
attribute determines how
+ missed ticks in the guest are handled, and can be "delay",
+ "catchup", "merge", or "discard". If the policy is
+ "catchup", there can be further details in
+ the catchup
sub-element.
+ catchup
catchup
element has three optional
+ attributes, each a positive integer. The attributes
+ are threshold
, slew
,
+ and limit
.
+ frequency
frequency
attribute is an unsigned
+ integer specifying the frequency at
+ which name="tsc"
runs.
+ mode
mode
attribute controls how
+ the name="tsc"
timer is managed, and can be
+ "auto", "native", "emulate", "paravirt", or "smpsafe".
+ Other timers are always emulated.
+ present
present
attribute can be "yes" or "no" to
+ specify whether a particular timer is available to the guest.
+