Changeset 51030 in vbox for trunk/doc

Timestamp:

Apr 10, 2014 11:14:55 AM (11 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

93245

Message:

doc/manual: document GUI/GuruMeditationHandler

File:

• trunk/doc/manual/en_US/user_AdvancedTopics.xml (modified) (15 diffs)

trunk/doc/manual/en_US/user_AdvancedTopics.xml

@@ -1667 +1667 @@
           <glossentry>
             <glossterm><computeroutput>--timesync-interval</computeroutput></glossterm>
-
             <glossdef>
               <para>Specifies the interval at which to synchronize the time
@@ -1676 +1675 @@
           <glossentry>
             <glossterm><computeroutput>--timesync-min-adjust</computeroutput></glossterm>
-
             <glossdef>
               <para>The minimum absolute drift value measured in milliseconds
@@ -1683 +1681 @@
             </glossdef>
           </glossentry>
-
           <glossentry>
             <glossterm><computeroutput>--timesync-latency-factor</computeroutput></glossterm>
-
             <glossdef>
               <para>The factor to multiply the time query latency with to
@@ -1701 +1697 @@
           <glossentry>
             <glossterm><computeroutput>--timesync-max-latency</computeroutput></glossterm>
-
             <glossdef>
               <para>The max host timer query latency to accept. The default is
@@ -1710 +1705 @@
           <glossentry>
             <glossterm><computeroutput>--timesync-set-threshold</computeroutput></glossterm>
-
             <glossdef>
               <para>The absolute drift threshold, given as milliseconds where
@@ -1720 +1714 @@
           <glossentry>
             <glossterm><computeroutput>--timesync-set-start</computeroutput></glossterm>
-
             <glossdef>
               <para>Set the time when starting the time sync service.</para>
@@ -1729 +1722 @@
             <glossterm><computeroutput>--timesync-set-on-restore
             0|1</computeroutput></glossterm>
-
             <glossdef>
               <para>Set the time after the VM was restored from a saved state
@@ -1937 +1929 @@
           <glossentry>
             <glossterm><computeroutput>noSelector</computeroutput></glossterm>
-
             <glossdef>
               <para>Don't allow to start the VirtualBox manager. Trying to do so
@@ -1946 +1937 @@
           <glossentry>
             <glossterm><computeroutput>noMenuBar</computeroutput></glossterm>
-
             <glossdef>
               <para>VM windows will not contain a menu bar.</para>
@@ -1954 +1944 @@
           <glossentry>
             <glossterm><computeroutput>noStatusBar</computeroutput></glossterm>
-
             <glossdef>
               <para>VM windows will not contain a status bar.</para>
@@ -2782 +2771 @@
           <glossentry>
             <glossterm><computeroutput>SaveState</computeroutput></glossterm>
-
             <glossdef>
               <para>Don't allow the user to save the VM state when terminating
@@ -2791 +2779 @@
           <glossentry>
             <glossterm><computeroutput>Shutdown</computeroutput></glossterm>
-
             <glossdef>
               <para>Don't allow the user to shutdown the VM by sending the ACPI
@@ -2800 +2787 @@
           <glossentry>
             <glossterm><computeroutput>PowerOff</computeroutput></glossterm>
-
             <glossdef>
               <para>Don't allow the user to power off the VM.</para>
@@ -2808 +2794 @@
           <glossentry>
             <glossterm><computeroutput>PowerOffRestoringSnapshot</computeroutput></glossterm>
-
             <glossdef>
               <para>Don't allow the user to return to the last snapshot when
@@ -2818 +2803 @@
         <para>This is a per-VM setting. Any combination of the above is allowed. If all
           options are specified, the VM cannot be shut down at all.</para>
+      </sect2>
+
+      <sect2>
+        <title>Action for handling a Guru Meditation</title>
+
+        <para>A VM runs into a Guru Meditation if there is a problem which
+          cannot be fixed by other means than terminating the process. The
+          default is to show a message window which instructs the user to
+          open a bug report.</para>
+        <para>This behavior can be configured:</para>
+          
+        <para><screen>VBoxManage setextradata "VM name" GUI/GuruMeditationHandler MODE</screen></para>
+
+        <para>where <computeroutput>MODE</computeroutput> is one of the
+          following keywords:</para><glosslist>
+          <glossentry>
+            <glossterm><computeroutput>Default</computeroutput></glossterm>
+            <glossdef>
+              <para>A message window is shown. After the user confirmed, the
+                VM is terminated.</para>
+            </glossdef>
+          </glossentry>
+
+          <glossentry>
+            <glossterm><computeroutput>PowerOff</computeroutput></glossterm>
+            <glossdef>
+              <para>The VM is immediately powered-off without showing any message
+                window. The VM logfile will show information about what happend.</para>
+            </glossdef>
+          </glossentry>
+
+          <glossentry>
+            <glossterm><computeroutput>Ignore</computeroutput></glossterm>
+            <glossdef>
+              <para>The VM is left in stuck mode. Execution is stopped but no
+              message window is shown. The VM has to be powered off manually.</para>
+            </glossdef>
+          </glossentry>
+        </glosslist>
+
+        <para>This is a per-VM setting.</para>
     </sect2>
   </sect1>