Changeset 52435 in vbox for trunk/doc/manual
- Timestamp:
- Aug 21, 2014 8:59:14 AM (11 years ago)
- svn:sync-xref-src-repo-rev:
- 95635
- File:
-
- 1 edited
-
trunk/doc/manual/en_US/user_AdvancedTopics.xml (modified) (1 diff)
Legend:
- Unmodified
- Added
- Removed
-
trunk/doc/manual/en_US/user_AdvancedTopics.xml ¶
r51030 r52435 2612 2612 <screen>VBoxManage setextradata "VM name" GUI/RestrictedVisualStates</screen> 2613 2613 2614 </sect2> 2615 2616 <sect2> 2614 </sect2> 2615 2616 <sect2> 2617 <title>Host Key customization</title> 2618 2619 <para>To disable all host key combinations, open the preferences and 2620 change the host key to <emphasis>None</emphasis>. This might be useful 2621 when using VirtualBox in a kiosk mode.</para> 2622 2623 <para>To redefine or disable certain host key actions, use the following command:</para> 2624 2625 <screen>VBoxManage setextradata global GUI/Input/MachineShortcuts "FullscreenMode=F,...."</screen> 2626 2627 <para>The following list shows the possible host key actions together with their default 2628 host key shortcut. Setting an action to <emphasis>None</emphasis> will disable 2629 that host key action.</para> 2630 <table> 2617 2631 <title>Host Key customization</title> 2618 2619 <para>To disable all host key combinations, open the preferences and 2620 change the host key to <emphasis>None</emphasis>. This might be useful 2621 when using VirtualBox in a kiosk mode.</para> 2622 2623 <para>To redefine or disable certain host key actions, use the following command:</para> 2624 2625 <screen>VBoxManage setextradata global GUI/Input/MachineShortcuts "FullscreenMode=F,...."</screen> 2626 2627 <para>The following list shows the possible host key actions together with their default 2628 host key shortcut. Setting an action to <emphasis>None</emphasis> will disable 2629 that host key action.</para> 2630 <table> 2631 <title>Host Key customization</title> 2632 <tgroup cols="3"> 2633 <thead> 2634 <row> 2635 <entry><emphasis role="bold">Action</emphasis></entry> 2636 <entry><emphasis role="bold">Default Key</emphasis></entry> 2637 <entry><emphasis role="bold">Action</emphasis></entry> 2638 </row> 2639 </thead> 2640 <tbody> 2641 <row> 2642 <entry><computeroutput>TakeSnapshot</computeroutput></entry> 2643 <entry>T</entry> 2644 <entry>take a snapshot</entry> 2645 </row> 2646 <row> 2647 <entry><computeroutput>TakeScreenshot</computeroutput></entry> 2648 <entry>E</entry> 2649 <entry>take a screenshot</entry> 2650 </row> 2651 <row> 2652 <entry><computeroutput>MouseIntegration</computeroutput></entry> 2653 <entry>I</entry> 2654 <entry>toggle mouse integration</entry> 2655 </row> 2656 <row> 2657 <entry><computeroutput>TypeCAD</computeroutput></entry> 2658 <entry>Del</entry> 2659 <entry>inject Ctrl+Alt+Del</entry> 2660 </row> 2661 <row> 2662 <entry><computeroutput>TypeCABS</computeroutput></entry> 2663 <entry>Backspace</entry> 2664 <entry>inject Ctrl+Alt+Backspace</entry> 2665 </row> 2666 <row> 2667 <entry><computeroutput>Pause</computeroutput></entry> 2668 <entry>P</entry> 2669 <entry>Pause the VM</entry> 2670 </row> 2671 <row> 2672 <entry><computeroutput>Reset</computeroutput></entry> 2673 <entry>R</entry> 2674 <entry>(hard) reset the guest</entry> 2675 </row> 2676 <row> 2677 <entry><computeroutput>SaveState</computeroutput></entry> 2678 <entry></entry> 2679 <entry>save the VM state and terminate the VM</entry> 2680 </row> 2681 <row> 2682 <entry><computeroutput>Shutdown</computeroutput></entry> 2683 <entry>H</entry> 2684 <entry>press the (virtual) ACPI power button</entry> 2685 </row> 2686 <row> 2687 <entry><computeroutput>PowerOff</computeroutput></entry> 2688 <entry></entry> 2689 <entry>power the VM off (without saving the state!)</entry> 2690 </row> 2691 <row> 2692 <entry><computeroutput>Close</computeroutput></entry> 2693 <entry>Q</entry> 2694 <entry>show the VM close dialog</entry> 2695 </row> 2696 <row> 2697 <entry><computeroutput>FullscreenMode</computeroutput></entry> 2698 <entry>F</entry> 2699 <entry>switch the VM into full screen</entry> 2700 </row> 2701 <row> 2702 <entry><computeroutput>SeamlessMode</computeroutput></entry> 2703 <entry>L</entry> 2704 <entry>switch the VM into seamless mode</entry> 2705 </row> 2706 <row> 2707 <entry><computeroutput>ScaleMode</computeroutput></entry> 2708 <entry>C</entry> 2709 <entry>switch the VM into scale mode</entry> 2710 </row> 2711 <row> 2712 <entry><computeroutput>GuestAutoResize</computeroutput></entry> 2713 <entry>G</entry> 2714 <entry>automatically resize the guest window</entry> 2715 </row> 2716 <row> 2717 <entry><computeroutput>WindowAdjust</computeroutput></entry> 2718 <entry>A</entry> 2719 <entry>immediately resize the guest window</entry> 2720 </row> 2721 <row> 2722 <entry><computeroutput>PopupMenu</computeroutput></entry> 2723 <entry>Home</entry> 2724 <entry>show popup menu in full screen / seaml. mode</entry> 2725 </row> 2726 <row> 2727 <entry><computeroutput>SettingsDialog</computeroutput></entry> 2728 <entry>S</entry> 2729 <entry>open the VM settings dialog</entry> 2730 </row> 2731 <row> 2732 <entry><computeroutput>InformationDialog</computeroutput></entry> 2733 <entry>N</entry> 2734 <entry>show the VM information window</entry> 2735 </row> 2736 <row> 2737 <entry><computeroutput>NetworkAdaptersDialog</computeroutput></entry> 2738 <entry></entry> 2739 <entry>show the VM network adapters dialog</entry> 2740 </row> 2741 <row> 2742 <entry><computeroutput>SharedFoldersDialog</computeroutput></entry> 2743 <entry></entry> 2744 <entry>show the VM shared folders dialog</entry> 2745 </row> 2746 <row> 2747 <entry><computeroutput>InstallGuestAdditions</computeroutput></entry> 2748 <entry>D</entry> 2749 <entry>mount the ISO containing the Guest Additions</entry> 2750 </row> 2751 </tbody> 2752 </tgroup> 2753 </table> 2754 2755 <para>To disable the full screen mode as well as the seamless mode, use the following command: 2756 <screen>VBoxManage setextradata global GUI/Input/MachineShortcuts "FullscreenMode=None,SeamlessMode=None"</screen> 2757 </para> 2758 2759 </sect2> 2760 2761 <sect2> 2762 <title>Action when terminating the VM</title> 2763 2764 <para>You can disallow (i.e. black-list) certain actions when terminating a VM. 2765 To disallow specific actions, type:</para> 2766 2767 <para><screen>VBoxManage setextradata "VM name" GUI/RestrictedCloseActions OPTION[,OPTION...]</screen></para> 2768 2769 <para>where <computeroutput>OPTION</computeroutput> is one of the 2770 following keywords:</para><glosslist> 2771 <glossentry> 2772 <glossterm><computeroutput>SaveState</computeroutput></glossterm> 2773 <glossdef> 2774 <para>Don't allow the user to save the VM state when terminating 2775 the VM.</para> 2776 </glossdef> 2777 </glossentry> 2778 2779 <glossentry> 2780 <glossterm><computeroutput>Shutdown</computeroutput></glossterm> 2781 <glossdef> 2782 <para>Don't allow the user to shutdown the VM by sending the ACPI 2783 power-off event to the guest.</para> 2784 </glossdef> 2785 </glossentry> 2786 2787 <glossentry> 2788 <glossterm><computeroutput>PowerOff</computeroutput></glossterm> 2789 <glossdef> 2790 <para>Don't allow the user to power off the VM.</para> 2791 </glossdef> 2792 </glossentry> 2793 2794 <glossentry> 2795 <glossterm><computeroutput>PowerOffRestoringSnapshot</computeroutput></glossterm> 2796 <glossdef> 2797 <para>Don't allow the user to return to the last snapshot when 2798 powering off the VM.</para> 2799 </glossdef> 2800 </glossentry> 2801 </glosslist> 2802 2803 <para>This is a per-VM setting. Any combination of the above is allowed. If all 2804 options are specified, the VM cannot be shut down at all.</para> 2805 </sect2> 2806 2807 <sect2> 2808 <title>Action for handling a Guru Meditation</title> 2809 2810 <para>A VM runs into a Guru Meditation if there is a problem which 2811 cannot be fixed by other means than terminating the process. The 2812 default is to show a message window which instructs the user to 2813 open a bug report.</para> 2814 <para>This behavior can be configured:</para> 2815 2816 <para><screen>VBoxManage setextradata "VM name" GUI/GuruMeditationHandler MODE</screen></para> 2817 2818 <para>where <computeroutput>MODE</computeroutput> is one of the 2819 following keywords:</para><glosslist> 2820 <glossentry> 2821 <glossterm><computeroutput>Default</computeroutput></glossterm> 2822 <glossdef> 2823 <para>A message window is shown. After the user confirmed, the 2824 VM is terminated.</para> 2825 </glossdef> 2826 </glossentry> 2827 2828 <glossentry> 2829 <glossterm><computeroutput>PowerOff</computeroutput></glossterm> 2830 <glossdef> 2831 <para>The VM is immediately powered-off without showing any message 2832 window. The VM logfile will show information about what happend.</para> 2833 </glossdef> 2834 </glossentry> 2835 2836 <glossentry> 2837 <glossterm><computeroutput>Ignore</computeroutput></glossterm> 2838 <glossdef> 2839 <para>The VM is left in stuck mode. Execution is stopped but no 2840 message window is shown. The VM has to be powered off manually.</para> 2841 </glossdef> 2842 </glossentry> 2843 </glosslist> 2844 2845 <para>This is a per-VM setting.</para> 2846 </sect2> 2632 <tgroup cols="3"> 2633 <thead> 2634 <row> 2635 <entry><emphasis role="bold">Action</emphasis></entry> 2636 <entry><emphasis role="bold">Default Key</emphasis></entry> 2637 <entry><emphasis role="bold">Action</emphasis></entry> 2638 </row> 2639 </thead> 2640 <tbody> 2641 <row> 2642 <entry><computeroutput>TakeSnapshot</computeroutput></entry> 2643 <entry>T</entry> 2644 <entry>take a snapshot</entry> 2645 </row> 2646 <row> 2647 <entry><computeroutput>TakeScreenshot</computeroutput></entry> 2648 <entry>E</entry> 2649 <entry>take a screenshot</entry> 2650 </row> 2651 <row> 2652 <entry><computeroutput>MouseIntegration</computeroutput></entry> 2653 <entry>I</entry> 2654 <entry>toggle mouse integration</entry> 2655 </row> 2656 <row> 2657 <entry><computeroutput>TypeCAD</computeroutput></entry> 2658 <entry>Del</entry> 2659 <entry>inject Ctrl+Alt+Del</entry> 2660 </row> 2661 <row> 2662 <entry><computeroutput>TypeCABS</computeroutput></entry> 2663 <entry>Backspace</entry> 2664 <entry>inject Ctrl+Alt+Backspace</entry> 2665 </row> 2666 <row> 2667 <entry><computeroutput>Pause</computeroutput></entry> 2668 <entry>P</entry> 2669 <entry>Pause the VM</entry> 2670 </row> 2671 <row> 2672 <entry><computeroutput>Reset</computeroutput></entry> 2673 <entry>R</entry> 2674 <entry>(hard) reset the guest</entry> 2675 </row> 2676 <row> 2677 <entry><computeroutput>SaveState</computeroutput></entry> 2678 <entry></entry> 2679 <entry>save the VM state and terminate the VM</entry> 2680 </row> 2681 <row> 2682 <entry><computeroutput>Shutdown</computeroutput></entry> 2683 <entry>H</entry> 2684 <entry>press the (virtual) ACPI power button</entry> 2685 </row> 2686 <row> 2687 <entry><computeroutput>PowerOff</computeroutput></entry> 2688 <entry></entry> 2689 <entry>power the VM off (without saving the state!)</entry> 2690 </row> 2691 <row> 2692 <entry><computeroutput>Close</computeroutput></entry> 2693 <entry>Q</entry> 2694 <entry>show the VM close dialog</entry> 2695 </row> 2696 <row> 2697 <entry><computeroutput>FullscreenMode</computeroutput></entry> 2698 <entry>F</entry> 2699 <entry>switch the VM into full screen</entry> 2700 </row> 2701 <row> 2702 <entry><computeroutput>SeamlessMode</computeroutput></entry> 2703 <entry>L</entry> 2704 <entry>switch the VM into seamless mode</entry> 2705 </row> 2706 <row> 2707 <entry><computeroutput>ScaleMode</computeroutput></entry> 2708 <entry>C</entry> 2709 <entry>switch the VM into scale mode</entry> 2710 </row> 2711 <row> 2712 <entry><computeroutput>GuestAutoResize</computeroutput></entry> 2713 <entry>G</entry> 2714 <entry>automatically resize the guest window</entry> 2715 </row> 2716 <row> 2717 <entry><computeroutput>WindowAdjust</computeroutput></entry> 2718 <entry>A</entry> 2719 <entry>immediately resize the guest window</entry> 2720 </row> 2721 <row> 2722 <entry><computeroutput>PopupMenu</computeroutput></entry> 2723 <entry>Home</entry> 2724 <entry>show popup menu in full screen / seaml. mode</entry> 2725 </row> 2726 <row> 2727 <entry><computeroutput>SettingsDialog</computeroutput></entry> 2728 <entry>S</entry> 2729 <entry>open the VM settings dialog</entry> 2730 </row> 2731 <row> 2732 <entry><computeroutput>InformationDialog</computeroutput></entry> 2733 <entry>N</entry> 2734 <entry>show the VM information window</entry> 2735 </row> 2736 <row> 2737 <entry><computeroutput>NetworkAdaptersDialog</computeroutput></entry> 2738 <entry></entry> 2739 <entry>show the VM network adapters dialog</entry> 2740 </row> 2741 <row> 2742 <entry><computeroutput>SharedFoldersDialog</computeroutput></entry> 2743 <entry></entry> 2744 <entry>show the VM shared folders dialog</entry> 2745 </row> 2746 <row> 2747 <entry><computeroutput>InstallGuestAdditions</computeroutput></entry> 2748 <entry>D</entry> 2749 <entry>mount the ISO containing the Guest Additions</entry> 2750 </row> 2751 </tbody> 2752 </tgroup> 2753 </table> 2754 2755 <para>To disable the full screen mode as well as the seamless mode, use the following command: 2756 <screen>VBoxManage setextradata global GUI/Input/MachineShortcuts "FullscreenMode=None,SeamlessMode=None"</screen> 2757 </para> 2758 2759 </sect2> 2760 2761 <sect2> 2762 <title>Action when terminating the VM</title> 2763 2764 <para>You can disallow (i.e. black-list) certain actions when terminating a VM. 2765 To disallow specific actions, type:</para> 2766 2767 <para><screen>VBoxManage setextradata "VM name" GUI/RestrictedCloseActions OPTION[,OPTION...]</screen></para> 2768 2769 <para>where <computeroutput>OPTION</computeroutput> is one of the 2770 following keywords:</para><glosslist> 2771 <glossentry> 2772 <glossterm><computeroutput>SaveState</computeroutput></glossterm> 2773 <glossdef> 2774 <para>Don't allow the user to save the VM state when terminating 2775 the VM.</para> 2776 </glossdef> 2777 </glossentry> 2778 2779 <glossentry> 2780 <glossterm><computeroutput>Shutdown</computeroutput></glossterm> 2781 <glossdef> 2782 <para>Don't allow the user to shutdown the VM by sending the ACPI 2783 power-off event to the guest.</para> 2784 </glossdef> 2785 </glossentry> 2786 2787 <glossentry> 2788 <glossterm><computeroutput>PowerOff</computeroutput></glossterm> 2789 <glossdef> 2790 <para>Don't allow the user to power off the VM.</para> 2791 </glossdef> 2792 </glossentry> 2793 2794 <glossentry> 2795 <glossterm><computeroutput>PowerOffRestoringSnapshot</computeroutput></glossterm> 2796 <glossdef> 2797 <para>Don't allow the user to return to the last snapshot when 2798 powering off the VM.</para> 2799 </glossdef> 2800 </glossentry> 2801 </glosslist> 2802 2803 <para>This is a per-VM setting. Any combination of the above is allowed. If all 2804 options are specified, the VM cannot be shut down at all.</para> 2805 </sect2> 2806 2807 <sect2> 2808 <title>Action for handling a Guru Meditation</title> 2809 2810 <para>A VM runs into a Guru Meditation if there is a problem which 2811 cannot be fixed by other means than terminating the process. The 2812 default is to show a message window which instructs the user to 2813 open a bug report.</para> 2814 <para>This behavior can be configured:</para> 2815 2816 <para><screen>VBoxManage setextradata "VM name" GUI/GuruMeditationHandler MODE</screen></para> 2817 2818 <para>where <computeroutput>MODE</computeroutput> is one of the 2819 following keywords:</para><glosslist> 2820 <glossentry> 2821 <glossterm><computeroutput>Default</computeroutput></glossterm> 2822 <glossdef> 2823 <para>A message window is shown. After the user confirmed, the 2824 VM is terminated.</para> 2825 </glossdef> 2826 </glossentry> 2827 2828 <glossentry> 2829 <glossterm><computeroutput>PowerOff</computeroutput></glossterm> 2830 <glossdef> 2831 <para>The VM is immediately powered-off without showing any message 2832 window. The VM logfile will show information about what happend.</para> 2833 </glossdef> 2834 </glossentry> 2835 2836 <glossentry> 2837 <glossterm><computeroutput>Ignore</computeroutput></glossterm> 2838 <glossdef> 2839 <para>The VM is left in stuck mode. Execution is stopped but no 2840 message window is shown. The VM has to be powered off manually.</para> 2841 </glossdef> 2842 </glossentry> 2843 </glosslist> 2844 2845 <para>This is a per-VM setting.</para> 2846 </sect2> 2847 2848 <sect2> 2849 <title>Configuring automatic mouse capturing</title> 2850 2851 <para> 2852 By default, the mouse is captured if the user clicks on the guest window 2853 and the guest expects relative mouse coordiantes at this time. This 2854 happens if the pointing device is configured as PS/2 mouse and the guest did 2855 not (yet) start the VirtualBox Guest Additions (for instance, the guest is 2856 booting or no Guest Additions installed at all) or if the pointing device 2857 is configured as USB tablet but the guest has no USB driver loaded yet. 2858 Once the Guest Additions become active or the USB guest driver is started, 2859 the mouse capture is automatically released. 2860 </para> 2861 <para> 2862 The default behavior is sometimes not desired. Therefore it can be configured: 2863 </para> 2864 <para><screen>VBoxManage setextradata "VM name" GUI/MouseCapturePolicy MODE</screen></para> 2865 2866 <para>where <computeroutput>MODE</computeroutput> is one of the 2867 following keywords:</para><glosslist> 2868 <glossentry> 2869 <glossterm><computeroutput>Default</computeroutput></glossterm> 2870 <glossdef> 2871 <para>The default behavior as described above.</para> 2872 </glossdef> 2873 </glossentry> 2874 <glossentry> 2875 <glossterm><computeroutput>HostComboOnly</computeroutput></glossterm> 2876 <glossdef> 2877 <para>The mouse is only captured if the Host Key is toggled.</para> 2878 </glossdef> 2879 </glossentry> 2880 <glossentry> 2881 <glossterm><computeroutput>Disabled</computeroutput></glossterm> 2882 <glossdef> 2883 <para>The mouse is never captured, also not by toggling the Host Key</para> 2884 </glossdef> 2885 </glossentry> 2886 </glosslist> 2887 2888 <para>This is a per-VM setting.</para> 2889 2890 </sect2> 2891 2847 2892 </sect1> 2848 2893
Note:
See TracChangeset
for help on using the changeset viewer.
