VirtualBox

Changeset 46899 in vbox


Ignore:
Timestamp:
Jul 2, 2013 11:59:45 AM (12 years ago)
Author:
vboxsync
Message:

doc/manual: document certain GUI customization

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/doc/manual/en_US/user_AdvancedTopics.xml

    r46821 r46899  
    19041904
    19051905    <sect2>
    1906       <title>GUI customization</title>
     1906      <title>Customizing the VM manager</title>
    19071907
    19081908      <para>There are several advanced customization settings for locking down
    … …  
    19401940        </glosslist></para>
    19411941
    1942       <para>To disable any GUI customization do
     1942      <para>To disable any of these VM manager customizations do
    19431943        <screen>VBoxManage setextradata global GUI/Customizations</screen></para>
     1944
     1945    </sect2>
     1946    <sect2>
    19441947
    19451948      <title>VM selector customization</title>
    19461949      <para>The following per-machine VM extradata settings can be used to change the
    19471950        behavior of the VM selector window in respect of certain VMs:</para>
    1948       <screen>VBoxManage setextradata VM_NAME SETTING true</screen>
     1951      <screen>VBoxManage setextradata "VM name" true</screen>
    19491952      <para>where <computeroutput>SETTING</computeroutput> can be:</para>
    19501953      <glosslist>
    … …  
    19631966        </glossentry>
    19641967        <glossentry>
     1968          <glossterm><computeroutput>GUI/PreventSnapshotOperations</computeroutput></glossterm>
     1969          <glossdef>
     1970            <para>Prevent snapshot operations for a VM from the GUI, either at runtime or when
     1971              the VM is powered off.</para>
     1972          </glossdef>
     1973        </glossentry>
     1974        <glossentry>
    19651975          <glossterm><computeroutput>GUI/HideFromManager</computeroutput></glossterm>
    19661976          <glossdef>
    … …  
    19681978          </glossdef>
    19691979        </glossentry>
     1980        <glossentry>
     1981          <glossterm><computeroutput>GUI/PreventApplicationUpdate</computeroutput></glossterm>
     1982          <glossdef>
     1983            <para>Disable the automatic update check and hide the corresponding menu item.</para>
     1984          </glossdef>
     1985        </glossentry>
    19701986      </glosslist>
    19711987      <para>Please note that these settings wouldn't prevent the user from
    19721988        reconfiguring the VM by <computeroutput>VBoxManage modifyvm</computeroutput>.</para>
    19731989
    1974       </sect2>
     1990    </sect2>
     1991
     1992    <sect2>
     1993      <title>Configure VM selector menu entries</title>
     1994      <para>You can disable (i.e. black-list) certain entries in the global settings
     1995        page of the VM selector:</para>
     1996      <screen>VBoxManage setextradata global GUI/RestrictedGlobalSettingsPages OPTION[,OPTION...]</screen>
     1997      <para>where <computeroutput>OPTION</computeroutput> is one of the
     1998        following keywords:</para><glosslist>
     1999        <glossentry>
     2000          <glossterm><computeroutput>General</computeroutput></glossterm>
     2001          <glossdef>
     2002            <para>Don't show the <emphasis>General</emphasis> settings pane.</para>
     2003          </glossdef>
     2004        </glossentry>
     2005     
     2006        <glossentry>
     2007          <glossterm><computeroutput>Input</computeroutput></glossterm>
     2008          <glossdef>
     2009            <para>Don't show the <emphasis>Input</emphasis> settings pane.</para>
     2010          </glossdef>
     2011        </glossentry>
     2012     
     2013        <glossentry>
     2014          <glossterm><computeroutput>Update</computeroutput></glossterm>
     2015          <glossdef>
     2016            <para>Don't show the <emphasis>Update</emphasis> settings pane.</para>
     2017          </glossdef>
     2018        </glossentry>
     2019     
     2020        <glossentry>
     2021          <glossterm><computeroutput>Language</computeroutput></glossterm>
     2022          <glossdef>
     2023            <para>Don't show the <emphasis>Language</emphasis> settings pane.</para>
     2024          </glossdef>
     2025        </glossentry>
     2026     
     2027        <glossentry>
     2028          <glossterm><computeroutput>Display</computeroutput></glossterm>
     2029          <glossdef>
     2030            <para>Don't show the <emphasis>Display</emphasis> settings pane.</para>
     2031          </glossdef>
     2032        </glossentry>
     2033     
     2034        <glossentry>
     2035          <glossterm><computeroutput>Network</computeroutput></glossterm>
     2036          <glossdef>
     2037            <para>Don't show the <emphasis>Network</emphasis> settings pane.</para>
     2038          </glossdef>
     2039        </glossentry>
     2040     
     2041        <glossentry>
     2042          <glossterm><computeroutput>Extensions</computeroutput></glossterm>
     2043          <glossdef>
     2044            <para>Don't show the <emphasis>Extensions</emphasis> settings pane.</para>
     2045          </glossdef>
     2046        </glossentry>
     2047     
     2048        <glossentry>
     2049          <glossterm><computeroutput>Proxy</computeroutput></glossterm>
     2050          <glossdef>
     2051            <para>Don't show the <emphasis>Proxy</emphasis> settings pane.</para>
     2052          </glossdef>
     2053        </glossentry>
     2054
     2055      </glosslist>
     2056
     2057      <para>This is a global setting. Any combination of the above is allowed.
     2058         To restore the default behavior, use</para>
     2059      <screen>VBoxManage setextradata global GUI/RestrictedGlobalSettingsPages</screen>
     2060
     2061    </sect2>
     2062     
     2063
     2064    <sect2>
     2065      <title>Configure VM window menu entries</title>
     2066      <para>You can disable (i.e. black-list) certain menu actions in the VM window:</para>
     2067      <screen>VBoxManage setextradata "VM name" GUI/RestrictedRuntimeMenus OPTION[,OPTION...]</screen>
     2068
     2069      <para>where <computeroutput>OPTION</computeroutput> is one of the
     2070        following keywords:</para><glosslist>
     2071        <glossentry>
     2072          <glossterm><computeroutput>All</computeroutput></glossterm>
     2073          <glossdef>
     2074            <para>Don't show any menu in the VM window.</para>
     2075          </glossdef>
     2076        </glossentry>
     2077
     2078        <glossentry>
     2079          <glossterm><computeroutput>Machine</computeroutput></glossterm>
     2080          <glossdef>
     2081            <para>Don't show the <emphasis>Machine</emphasis> menu in the VM window.</para>
     2082          </glossdef>
     2083        </glossentry>
     2084
     2085        <glossentry>
     2086          <glossterm><computeroutput>View</computeroutput></glossterm>
     2087          <glossdef>
     2088            <para>Don't show the <emphasis>View</emphasis> menu in the VM window.</para>
     2089          </glossdef>
     2090        </glossentry>
     2091
     2092        <glossentry>
     2093          <glossterm><computeroutput>Devices</computeroutput></glossterm>
     2094          <glossdef>
     2095            <para>Don't show the <emphasis>Devices</emphasis> menu in the VM window.</para>
     2096          </glossdef>
     2097        </glossentry>
     2098
     2099        <glossentry>
     2100          <glossterm><computeroutput>Help</computeroutput></glossterm>
     2101          <glossdef>
     2102            <para>Don't show the <emphasis>Help</emphasis> menu in the VM window.</para>
     2103          </glossdef>
     2104        </glossentry>
     2105
     2106        <glossentry>
     2107          <glossterm><computeroutput>Debug</computeroutput></glossterm>
     2108          <glossdef>
     2109            <para>Don't show the <emphasis>Debug</emphasis> menu in the VM window. The debug
     2110              menu is only visible if the GUI was started with special command line parameters
     2111              or environment variable settings.</para>
     2112          </glossdef>
     2113        </glossentry>
     2114
     2115      </glosslist>
     2116
     2117      <para>This is a per-VM setting. Any combination of the above is allowed. To restore
     2118      the default behavior, use</para>
     2119      <screen>VBoxManage setextradata "VM name" GUI/RestrictedRuntimeMenus</screen>
     2120
     2121    </sect2>
     2122
     2123    <sect2>
     2124
     2125      <title>Configure VM window status bar entries</title>
     2126
     2127      <para>You can disable (i.e. black-list) certain status bar items:</para>
     2128      <screen>VBoxManage setextradata "VM name" GUI/RestrictedStatusBarIndicators OPTION[,OPTION...]</screen>
     2129
     2130      <para>where <computeroutput>OPTION</computeroutput> is one of the
     2131        following keywords:</para><glosslist>
     2132        <glossentry>
     2133          <glossterm><computeroutput>HardDisks</computeroutput></glossterm>
     2134          <glossdef>
     2135            <para>Don't show the hard disk icon in the VM window status bar. By default
     2136              the hard disk icon is only shown if the VM configuration contains one or
     2137              more hard disks.</para>
     2138          </glossdef>
     2139        </glossentry>
     2140
     2141        <glossentry>
     2142          <glossterm><computeroutput>OpticalDisks</computeroutput></glossterm>
     2143          <glossdef>
     2144            <para>Don't show the CD icon in the VM window status bar. By default the
     2145              CD icon is only shown if the VM configuration contains one or more CD
     2146            drives.</para>
     2147          </glossdef>
     2148        </glossentry>
     2149
     2150        <glossentry>
     2151          <glossterm><computeroutput>FloppyDisks</computeroutput></glossterm>
     2152          <glossdef>
     2153            <para>Don't show the floppy icon in the VM window status bar. By default the
     2154              floppy icon is only shown if the VM configuration contains one more
     2155              more floppy drives.</para>
     2156          </glossdef>
     2157        </glossentry>
     2158
     2159        <glossentry>
     2160          <glossterm><computeroutput>Network</computeroutput></glossterm>
     2161          <glossdef>
     2162            <para>Don't show the network icon in the VM window status bar. By default
     2163              the network icon is only shown if the VM configuration contains one or more
     2164            active network adapters.</para>
     2165          </glossdef>
     2166        </glossentry>
     2167
     2168        <glossentry>
     2169          <glossterm><computeroutput>USB</computeroutput></glossterm>
     2170          <glossdef>
     2171            <para>Don't show the USB icon in the status bar. </para>
     2172          </glossdef>
     2173        </glossentry>
     2174
     2175        <glossentry>
     2176          <glossterm><computeroutput>SharedFolders</computeroutput></glossterm>
     2177          <glossdef>
     2178            <para>Don't show the shared folders icon in the status bar.</para>
     2179          </glossdef>
     2180        </glossentry>
     2181
     2182        <glossentry>
     2183          <glossterm><computeroutput>VideoCapture</computeroutput></glossterm>
     2184          <glossdef>
     2185            <para>Don't show the video capture icon in the status bar.</para>
     2186          </glossdef>
     2187        </glossentry>
     2188
     2189        <glossentry>
     2190          <glossterm><computeroutput>Features</computeroutput></glossterm>
     2191          <glossdef>
     2192            <para>Don't show the CPU features icon in the status bar.</para>
     2193          </glossdef>
     2194        </glossentry>
     2195
     2196        <glossentry>
     2197          <glossterm><computeroutput>Mouse</computeroutput></glossterm>
     2198          <glossdef>
     2199            <para>Don't show the mouse icon in the status bar.</para>
     2200          </glossdef>
     2201        </glossentry>
     2202
     2203        <glossentry>
     2204          <glossterm><computeroutput>Keyboard</computeroutput></glossterm>
     2205          <glossdef>
     2206            <para>Don't show the keyboard icon in the status bar.</para>
     2207          </glossdef>
     2208        </glossentry>
     2209
     2210      </glosslist>
     2211
     2212      <para>This is a per-VM setting. Any combination of the above is allowed. If all options
     2213        are specified, no icons are displayed in the status bar of the VM window. To restore
     2214        the default behavior, use</para>
     2215
     2216      <screen>VBoxManage setextradata "VM name" GUI/RestrictedStatusBarIndicators</screen>
     2217
     2218  </sect2>
    19752219
    19762220      <sect2>
    … …  
    19982242              </row>
    19992243              <row>
    2000                 <entry>TakeSnapshot</entry>
     2244                <entry><computeroutput>TakeSnapshot</computeroutput></entry>
    20012245                <entry>T</entry>
    20022246                <entry>take a snapshot</entry>
    20032247              </row>
    20042248              <row>
    2005                 <entry>TakeScreenshot</entry>
     2249                <entry><computeroutput>TakeScreenshot</computeroutput></entry>
    20062250                <entry>E</entry>
    20072251                <entry>take a screenshot</entry>
    20082252              </row>
    20092253              <row>
    2010                 <entry>MouseIntegration</entry>
     2254                <entry><computeroutput>MouseIntegration</computeroutput></entry>
    20112255                <entry>I</entry>
    20122256                <entry>toggle mouse integration</entry>
    20132257              </row>
    20142258              <row>
    2015                 <entry>TypeCAD</entry>
     2259                <entry><computeroutput>TypeCAD</computeroutput></entry>
    20162260                <entry>Del</entry>
    20172261                <entry>inject Ctrl+Alt+Del</entry>
    20182262              </row>
    20192263              <row>
    2020                 <entry>TypeCABS</entry>
     2264                <entry><computeroutput>TypeCABS</computeroutput></entry>
    20212265                <entry>Backspace</entry>
    20222266                <entry>inject Ctrl+Alt+Backspace</entry>
    20232267              </row>
    20242268              <row>
    2025                 <entry>Pause</entry>
     2269                <entry><computeroutput>Pause</computeroutput></entry>
    20262270                <entry>P</entry>
    20272271                <entry>Pause the VM</entry>
    20282272              </row>
    20292273              <row>
    2030                 <entry>Reset</entry>
     2274                <entry><computeroutput>Reset</computeroutput></entry>
    20312275                <entry>R</entry>
    20322276                <entry>(hard) reset the guest</entry>
    20332277              </row>
    20342278              <row>
    2035                 <entry>Save</entry>
     2279                <entry><computeroutput>SaveState</computeroutput></entry>
    20362280                <entry></entry>
    20372281                <entry>save the VM state and terminate the VM</entry>
    20382282              </row>
    20392283              <row>
    2040                 <entry>Shutdown</entry>
     2284                <entry><computeroutput>Shutdown</computeroutput></entry>
    20412285                <entry>H</entry>
    20422286                <entry>press the (virtual) ACPI power button</entry>
    20432287              </row>
    20442288              <row>
    2045                 <entry>PowerOff</entry>
     2289                <entry><computeroutput>PowerOff</computeroutput></entry>
    20462290                <entry></entry>
    20472291                <entry>power the VM off (without saving the state!)</entry>
    20482292              </row>
    20492293              <row>
    2050                 <entry>Close</entry>
     2294                <entry><computeroutput>Close</computeroutput></entry>
    20512295                <entry>Q</entry>
    20522296                <entry>show the VM close dialog</entry>
    20532297              </row>
    20542298              <row>
    2055                 <entry>FullscreenMode</entry>
     2299                <entry><computeroutput>FullscreenMode</computeroutput></entry>
    20562300                <entry>F</entry>
    20572301                <entry>switch the VM into fullscreen</entry>
    20582302              </row>
    20592303              <row>
    2060                 <entry>SeamlessMode</entry>
     2304                <entry><computeroutput>SeamlessMode</computeroutput></entry>
    20612305                <entry>L</entry>
    20622306                <entry>switch the VM into seamless mode</entry>
    20632307              </row>
    20642308              <row>
    2065                 <entry>ScaleMode</entry>
     2309                <entry><computeroutput>ScaleMode</computeroutput></entry>
    20662310                <entry>C</entry>
    20672311                <entry>switch the VM into scale mode</entry>
    20682312              </row>
    20692313              <row>
    2070                 <entry>GuestAutoResize</entry>
     2314                <entry><computeroutput>GuestAutoResize</computeroutput></entry>
    20712315                <entry>G</entry>
    20722316                <entry>automatically resize the guest window</entry>
    20732317              </row>
    20742318              <row>
    2075                 <entry>WindowAdjust</entry>
     2319                <entry><computeroutput>WindowAdjust</computeroutput></entry>
    20762320                <entry>A</entry>
    20772321                <entry>immediately resize the guest window</entry>
    20782322              </row>
    20792323              <row>
    2080                 <entry>PopupMenu</entry>
     2324                <entry><computeroutput>PopupMenu</computeroutput></entry>
    20812325                <entry>Home</entry>
    2082                 <entry>show popup menu in fullscreen / seamless mode</entry>
     2326                <entry>show popup menu in fullscreen / seaml. mode</entry>
    20832327              </row>
    20842328              <row>
    2085                 <entry>SettingsDialog</entry>
     2329                <entry><computeroutput>SettingsDialog</computeroutput></entry>
    20862330                <entry>S</entry>
    20872331                <entry>open the VM settings dialog</entry>
    20882332              </row>
    20892333              <row>
    2090                 <entry>InformationsDialog</entry>
     2334                <entry><computeroutput>InformationsDialog</computeroutput></entry>
    20912335                <entry>N</entry>
    20922336                <entry>show the VM information window</entry>
    20932337              </row>
    20942338              <row>
    2095                 <entry>NetworkAdaptersDialog</entry>
     2339                <entry><computeroutput>NetworkAdaptersDialog</computeroutput></entry>
    20962340                <entry></entry>
    20972341                <entry>show the VM network adapters dialog</entry>
    20982342              </row>
    20992343              <row>
    2100                 <entry>SharedFoldersDialog</entry>
     2344                <entry><computeroutput>SharedFoldersDialog</computeroutput></entry>
    21012345                <entry></entry>
    21022346                <entry>show the VM shared folders dialog</entry>
    21032347              </row>
    21042348              <row>
    2105                 <entry>InstallGuestAdditions</entry>
     2349                <entry><computeroutput>InstallGuestAdditions</computeroutput></entry>
    21062350                <entry>D</entry>
    21072351                <entry>mount the ISO containing the Guest Additions</entry>
    … …  
    21192363        <title>Action when terminating the VM</title>
    21202364
    2121         <para>You can disallow certain actions when terminating a VM. To disallow specific actions, type:</para>
     2365        <para>You can disallow (i.e. black-list) certain actions when terminating a VM.
     2366          To disallow specific actions, type:</para>
    21222367
    21232368        <para><screen>VBoxManage setextradata "VM name" GUI/RestrictedCloseActions OPTION[,OPTION...]</screen></para>
    21242369
    21252370        <para>where <computeroutput>OPTION</computeroutput> is one of the
    2126           following keywords:<glosslist>
     2371          following keywords:</para><glosslist>
    21272372          <glossentry>
    21282373            <glossterm><computeroutput>SaveState</computeroutput></glossterm>
    … …  
    21592404            </glossdef>
    21602405          </glossentry>
    2161         </glosslist></para>
    2162 
    2163       <para>Any combination of the above is allowed. If all options are
    2164         specified, the VM cannot be shut down at all.</para>
     2406        </glosslist>
     2407
     2408        <para>This is a per-VM setting. Any combination of the above is allowed. If all
     2409          options are specified, the VM cannot be shut down at all.</para>
    21652410    </sect2>
    21662411  </sect1>
Note: See TracChangeset for help on using the changeset viewer.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette