summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorFelix Geyer <debfx-pkg@fobos.de>2011-05-17 13:57:57 +0200
committerFelix Geyer <debfx-pkg@fobos.de>2011-05-17 13:57:57 +0200
commit0056814bdb2f8a457b56803fd24c72347173250d (patch)
tree0a0f513bb8030d6bcdff405a5caab73fcb1399ce /doc
parent3c3b014d3682252dbc133a6d2cd5dd2f8a028bbe (diff)
downloadvirtualbox-0056814bdb2f8a457b56803fd24c72347173250d.tar.gz
Imported Upstream version 4.0.8-dfsgupstream/4.0.8-dfsg
Diffstat (limited to 'doc')
-rw-r--r--doc/manual/Makefile.kmk34
-rw-r--r--doc/manual/en_US/SDKRef.xml37
-rw-r--r--doc/manual/en_US/user_AdvancedTopics.xml27
-rw-r--r--doc/manual/en_US/user_Networking.xml17
-rw-r--r--doc/manual/en_US/user_Security.xml2
-rw-r--r--doc/manual/en_US/user_Troubleshooting.xml7
-rw-r--r--doc/manual/en_US/user_VBoxManage.xml5
-rw-r--r--doc/manual/user_ChangeLogImpl.xml131
8 files changed, 204 insertions, 56 deletions
diff --git a/doc/manual/Makefile.kmk b/doc/manual/Makefile.kmk
index a52b56fbf..f07afcf2e 100644
--- a/doc/manual/Makefile.kmk
+++ b/doc/manual/Makefile.kmk
@@ -4,7 +4,7 @@
#
#
-# Copyright (C) 2006-2007 Oracle Corporation
+# Copyright (C) 2006-2011 Oracle Corporation
#
# This file is part of VirtualBox Open Source Edition (OSE), as
# available from http://www.virtualbox.org. This file is free software;
@@ -508,11 +508,15 @@ $(foreach f,$(VBOX_MANUAL_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$f/UserManual.p
$(foreach f,$(VBOX_MANUAL_LANGUAGES),\
$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/$f/,$(VBOX_MANUAL_PNG_FILES_$(f)))) | $$(dir $$@)
# PDF generation via Latex: generate the .tex file
- $(call MSG_L1,pdflatex $< (three passes) -> $@)
+ $(call MSG_L1,pdflatex $< (four passes) -> $@)
$(QUIET)$(REDIRECT) -w+ti /dev/null -C $(@D) -- $(PDFLATEX) UserManual.tex
$(QUIET)$(REDIRECT) -w+ti /dev/null -C $(@D) -- $(PDFLATEX) UserManual.tex
$(QUIET)$(REDIRECT) -w+ti /dev/null -C $(@D) -- $(PDFLATEX) UserManual.tex
$(QUIET)$(REDIRECT) -w+ti /dev/null -C $(@D) -- $(PDFLATEX) UserManual.tex
+ $(QUIET)$(SED) -n \
+ -e '/Warning: There were \(undefined references\|multiply-defined labels\)/{p; q 1}' \
+ $(basename $@).log
+
##@todo restore this when above has been converted to INSTALLS target. $(call MSG_L1,Fresh LaTeX-generated PDF is now at $@)
# generate temporary LaTeX source from processed XML
@@ -553,6 +557,9 @@ $(VBOX_PATH_SDK)/docs/SDKRef.pdf: \
$(QUIET)$(REDIRECT) -C $(<D) -- $(PDFLATEX) SDKRef.tex
$(QUIET)$(REDIRECT) -C $(<D) -- $(PDFLATEX) SDKRef.tex
$(QUIET)$(REDIRECT) -C $(<D) -- $(PDFLATEX) SDKRef.tex
+ $(QUIET)$(SED) -n \
+ -e '/Warning: There were \(undefined references\|multiply-defined labels\)/{p; q 1}' \
+ $(basename $<).log
$(QUIET)$(CP) $(<D)/SDKRef.pdf $@
$(call MSG_L1,Fresh LaTeX-generated PDF is now at $@)
@@ -717,28 +724,19 @@ $(VBOX_PATH_MANUAL_OUTBASE)/en_US/docbook-changelog-formatcfg.xsl: \
-e 's|\$$TARGETPATH|$(@D)|g' --output $@.tmp $<
$(QUIET)$(MV) -f $@.tmp $@
-$(VBOX_PATH_MANUAL_OUTBASE)/en_US/ChangeLog.xml: ChangeLog.xml
- $(QUIET)$(CP) $< $@
-
-$(VBOX_PATH_MANUAL_OUTBASE)/user_ChangeLogImpl_1.xml: $(VBOX_PATH_MANUAL_SRC)/user_ChangeLogImpl.xml
- $(QUIET)$(RM) -f $@.tmp $@
- $(QUIET)$(SED) -e 's|para|simpara|g' \
- --output $@.tmp $<
- $(QUIET)$(MV) -f $@.tmp $@
-
+# This XSLT rule depends on $(VBOX_PATH_MANUAL_OUTBASE)/en_US/user_ChangeLog.xml, which is build by the complex rule
+# $(foreach f,$(VBOX_MANUAL_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$f/user_ChangeLog.xml): ...
+# much further above. That rule takes en_US/user_ChangeLog.xml and replaces $VIRTUALBOX_CHANGELOG_IMPL
+# with the actual change log contained in user_ChangeLogImpl.xml
$(VBOX_PATH_MANUAL_OUTBASE)/en_US/ChangeLog.html: \
- $(VBOX_PATH_MANUAL_OUTBASE)/user_ChangeLogImpl_1.xml \
$(VBOX_PATH_MANUAL_OUTBASE)/en_US/docbook-changelog-formatcfg.xsl \
- $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ChangeLog.xml
+ $(VBOX_PATH_MANUAL_OUTBASE)/en_US/user_ChangeLog.xml
$(QUIET)$(VBOX_XSLTPROC) --xinclude --nonet --output $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ChangeLog.html \
$(@D)/docbook-changelog-formatcfg.xsl \
- $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ChangeLog.xml
-
-$(PATH_BIN)/ChangeLog.html: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ChangeLog.html
- $(QUIET)$(CP) $< $@
+ $(VBOX_PATH_MANUAL_OUTBASE)/en_US/user_ChangeLog.xml
$(call MSG_L1,Fresh ChangeLog.html is now at $@)
-cl-html: $(PATH_BIN)/ChangeLog.html
+cl-html: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/ChangeLog.html
include $(KBUILD_PATH)/subfooter.kmk
diff --git a/doc/manual/en_US/SDKRef.xml b/doc/manual/en_US/SDKRef.xml
index 8f72c26f4..60039d81b 100644
--- a/doc/manual/en_US/SDKRef.xml
+++ b/doc/manual/en_US/SDKRef.xml
@@ -1456,7 +1456,7 @@ if mach is None:
else:
session = mgr.getSessionObject(vbox)
# one can also start headless session with "headless" instead of "gui"
- progress = vb.openRemoteSession(session, mach.id, "gui", "")
+ progress = mach.launchVMProcess(session, mach.id, "gui", "")
progress.waitForCompletion(-1)
session.close()
</screen>
@@ -1746,19 +1746,18 @@ IFoo *foo;
rc = object-&gt;vtbl-&gt;Method(object, args, ..., &amp;foo);</screen>
<para>As a real-world example of a method invocation, let's call
- <xref linkend="IVirtualBox__openRemoteSession"
- xreflabel="IVirtualBox::openRemoteSession" /> which returns an
+ <xref linkend="IMachine__launchVMProcess"
+ xreflabel="IMachine::launchVMProcess" /> which returns an
IProgress object. Note again that the method name is
capitalized.</para>
<screen>IProgress *progress;
...
-rc = vbox-&gt;vtbl-&gt;OpenRemoteSession(
- vbox, /* this */
+rc = vbox-&gt;vtbl-&gt;LaunchVMProcess(
+ machine, /* this */
session, /* arg 1 */
- id, /* arg 2 */
- sessionType, /* arg 3 */
- env, /* arg 4 */
+ sessionType, /* arg 2 */
+ env, /* arg 3 */
&amp;progress /* Out */
);
</screen>
@@ -4002,20 +4001,20 @@ AuthResult AUTHCALL AuthEntry(
</listitem>
<listitem>
- <para>The <xref linkend="IVRDPServer" xreflabel="IVRDPServer" />,
- <xref linkend="IRemoteDisplayInfo" xreflabel="IRemoteDisplayInfo" />
- and IConsoleCallback interfaces were changed to reflect VRDP server
- ability to bind to one of available ports from a list of
- ports.</para>
+ <para>The <computeroutput>IVRDPServer</computeroutput>,
+ <computeroutput>IRemoteDisplayInfo</computeroutput> and
+ <computeroutput>IConsoleCallback</computeroutput> interfaces were
+ changed to reflect VRDP server ability to bind to one of available
+ ports from a list of ports.</para>
<para>The <computeroutput>IVRDPServer::port</computeroutput>
- attribute has been replaced with <xref linkend="IVRDPServer__ports"
- xreflabel="IVRDPServer::ports" />, which is a comma-separated list
- of ports or ranges of ports.</para>
+ attribute has been replaced with
+ <computeroutput>IVRDPServer::ports</computeroutput>, which is a
+ comma-separated list of ports or ranges of ports.</para>
- <para>An <xref linkend="IRemoteDisplayInfo__port"
- xreflabel="IRemoteDisplayInfo::port" /> attribute has been added for
- querying the actual port VRDP server listens on.</para>
+ <para>An <computeroutput>IRemoteDisplayInfo::port</computeroutput>
+ attribute has been added for querying the actual port VRDP server
+ listens on.</para>
<para>An IConsoleCallback::onRemoteDisplayInfoChange() notification
callback has been added.</para>
diff --git a/doc/manual/en_US/user_AdvancedTopics.xml b/doc/manual/en_US/user_AdvancedTopics.xml
index ac33d7ece..c1cb7e23d 100644
--- a/doc/manual/en_US/user_AdvancedTopics.xml
+++ b/doc/manual/en_US/user_AdvancedTopics.xml
@@ -1421,4 +1421,31 @@ VBoxManage setextradata "VM name" VBoxInternal2/CoreDumpLive 1</screen>At
</listitem>
</itemizedlist></para>
</sect1>
+
+ <sect1 id="vboxballoonctrl">
+ <title>Memory Ballooning Service</title>
+
+ <para>Starting at VirtualBox 4.0.8 a new host executable called <computeroutput>VBoxBalloonCtrl</computeroutput> is
+ available to automatically take care of a VM's configured memory balloon (see <xref linkend="guestadd-balloon" />
+ for an introduction to memory ballooning). This especially is useful for server environments where VMs may dynamically
+ require more or less memory during runtime.</para>
+
+ <para>VBoxBalloonCtrl periodically checks a VM's current memory balloon and its free guest RAM and automatically adjusts
+ the current memory balloon by inflating or deflating it accordingly. This handling only applies to running VMs having recent
+ Guest Additions installed.</para>
+
+ <para>To set up VBoxBalloonCtrl and adjust the maximum ballooning size a VM can reach the following parameters will be checked in the following
+ order:
+ <itemizedlist>
+ <listitem>specified via VBoxBalloonCtrl command line parameter <computeroutput>--balloon-max</computeroutput></listitem>
+ <listitem>per-VM parameter using <screen>VBoxManage setextradata "VM-Name" VBoxInternal/Guest/BalloonSizeMax &lt;Size in MB&gt;</screen></listitem>
+ <listitem>global parameter for all VMs using <screen>VBoxManage setextradata global VBoxInternal/Guest/BalloonSizeMax &lt;Size in MB&gt;</screen></listitem>
+ </itemizedlist>
+ <note>
+ <para>If no maximum ballooning size is specified by at least one of the parameters above, no ballooning will be performed at all.</para>
+ </note>
+ </para>
+
+ <para>For more options and parameters check the built-in command line help accessible with <computeroutput>--help</computeroutput>.</para>
+ </sect1>
</chapter>
diff --git a/doc/manual/en_US/user_Networking.xml b/doc/manual/en_US/user_Networking.xml
index aadb0f2d1..5ae181c0d 100644
--- a/doc/manual/en_US/user_Networking.xml
+++ b/doc/manual/en_US/user_Networking.xml
@@ -42,7 +42,7 @@
</listitem>
<listitem>
- <para>Intel PRO/1000 MT Desktop (82540OEM);</para>
+ <para>Intel PRO/1000 MT Desktop (82540EM);</para>
</listitem>
<listitem>
@@ -62,15 +62,12 @@
all operating systems out of the box, as well as the GNU GRUB boot
manager. As an exception, the Intel PRO/1000 family adapters are chosen
for some guest operating system types that no longer ship with drivers for
- the PCNet card, such as Windows Vista; see <xref
- linkend="vista_networking" /> for details.<footnote>
- <para>Support for the Intel PRO/1000 MT Desktop type was added with
- VirtualBox 1.6. The T Server variant of the Intel PRO/1000 card was
- added with VirtualBox 1.6.2 because this one is recognized by Windows
- XP guests without additional driver installation. The MT Server
- variant was added with VirtualBox 2.2 to facilitate OVF imports from
- other platforms.</para>
- </footnote></para>
+ the PCNet card, such as Windows Vista.</para>
+
+ <para>The Intel PRO/1000 MT Desktop type works with Windows Vista and later
+ versions. The T Server variant of the Intel PRO/1000 card is recognized by
+ Windows XP guests without additional driver installation. The MT Server
+ variant facilitates OVF imports from other platforms.</para>
<para>The <emphasis role="bold">"Paravirtualized network adapter
(virtio-net)"</emphasis> is special. If you select this, then VirtualBox
diff --git a/doc/manual/en_US/user_Security.xml b/doc/manual/en_US/user_Security.xml
index 51d5d8aa6..e28c23b75 100644
--- a/doc/manual/en_US/user_Security.xml
+++ b/doc/manual/en_US/user_Security.xml
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
-<chapter id="Troubleshooting">
+<chapter id="Security">
<title>Security considerations</title>
<sect1>
diff --git a/doc/manual/en_US/user_Troubleshooting.xml b/doc/manual/en_US/user_Troubleshooting.xml
index d954a61f6..192f50d08 100644
--- a/doc/manual/en_US/user_Troubleshooting.xml
+++ b/doc/manual/en_US/user_Troubleshooting.xml
@@ -710,9 +710,10 @@
before version 1.6.0. For Windows Vista guests, VirtualBox now uses an
Intel E1000 card by default.</para>
- <para>If, for some reason, you still want to use the AMD card,
- VirtualBox ships a 32-bit driver for that card with the Windows Guest
- Additions; see <xref linkend="vista_networking" />.</para>
+ <para>If, for some reason, you still want to use the AMD card, you need
+ to download the PCNet driver from the AMD website (available for 32-bit
+ Windows only). You can transfer it into the virtual machine using a
+ shared folder, see (see <xref linkend="sharedfolders" />).</para>
</sect2>
<sect2>
diff --git a/doc/manual/en_US/user_VBoxManage.xml b/doc/manual/en_US/user_VBoxManage.xml
index bc240a225..92b2e6003 100644
--- a/doc/manual/en_US/user_VBoxManage.xml
+++ b/doc/manual/en_US/user_VBoxManage.xml
@@ -1365,6 +1365,11 @@ Virtual system 0:
</listitem>
<listitem>
+ <para><computeroutput>screenshotpng</computeroutput> takes a screenshot
+ of the guest display and saves it in PNG format.</para>
+ </listitem>
+
+ <listitem>
<para>The <computeroutput>setcredentials</computeroutput> operation is
used for remote logons in Windows guests. For details, please refer to
<xref linkend="autologon" />.</para>
diff --git a/doc/manual/user_ChangeLogImpl.xml b/doc/manual/user_ChangeLogImpl.xml
index c988d71a7..968d4feb1 100644
--- a/doc/manual/user_ChangeLogImpl.xml
+++ b/doc/manual/user_ChangeLogImpl.xml
@@ -1,6 +1,127 @@
<?xml version="1.0" encoding="UTF-8"?>
<sect1>
+ <title>Version 4.0.8 (2011-05-16)</title>
+
+ <para>This is a maintenance release. The following items were fixed and/or
+ added:</para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>Mac OS X hosts: fixed incompatibility with recent Mac OS X
+ versions in 64-bit mode (bug #8474)</para>
+ </listitem>
+
+ <listitem>
+ <para>Mac OS X hosts: fixed incompatibility with hosts with more
+ than 16 cores (bug #8389)</para>
+ </listitem>
+
+ <listitem>
+ <para>Mac OS X hosts: fixed painting corruptions on a second monitor in
+ 64-bit mode (bug #7606)</para>
+ </listitem>
+
+ <listitem>
+ <para>GUI: restored functionality to set an empty host key to disallow any
+ host key combination (4.0.6 regression; bug #8793)</para>
+ </listitem>
+
+ <listitem>
+ <para>GUI: more expressive error messages for USB proxy permission
+ problems (mainly Linux hosts; bug #8823)</para>
+ </listitem>
+
+ <listitem>
+ <para>VBoxManage: added <computeroutput>controlvm screenshotpng</computeroutput>
+ subcommand for saving the screenshot of a running VM in PNG format</para>
+ </listitem>
+
+ <listitem>
+ <para>VBoxHeadless: fixed potential crash during shutdown
+ (Windows hosts only)</para>
+ </listitem>
+
+ <listitem>
+ <para>NAT: built-in services use the correct Ethernet addresses in
+ Ethernet header and in ARP requests</para>
+ </listitem>
+
+ <listitem>
+ <para>Host-only networking: fixed adapter reference counting</para>
+ </listitem>
+
+ <listitem>
+ <para>E1000: fixed rare guest crashes with Linux SMP guests (bug #8755)</para>
+ </listitem>
+
+ <listitem>
+ <para>SATA: fixed guest disk corruption under rare circumstances
+ (only relevant for guests with more than 2GB RAM; bug #8826)</para>
+ </listitem>
+
+ <listitem>
+ <para>Storage: fixed data corruption after a snapshot was taken with
+ asynchronous I/O enabled (bug #8498)</para>
+ </listitem>
+
+ <listitem>
+ <para>Floppy: several improvement</para>
+ </listitem>
+
+ <listitem>
+ <para>HPET: another fix for time jumps (bug #8707)</para>
+ </listitem>
+
+ <listitem>
+ <para>USB: use correct permissions when creating /dev/vboxusb
+ (Linux hosts only)</para>
+ </listitem>
+
+ <listitem>
+ <para>USB: removed assumption that string descriptors are null-terminated
+ (Windows hosts only)</para>
+ </listitem>
+
+ <listitem>
+ <para>3D support: fixed a potential crash when resizing the guest
+ window</para>
+ </listitem>
+
+ <listitem>
+ <para>3D support: fixed GNOME 3 rendering under Ubuntu 11.04 and
+ Fedora 15</para>
+ </listitem>
+
+ <listitem>
+ <para>Snapshots: fixed another bug which could lose entries in the media
+ registry when restoring a snapshot (bug #8363)</para>
+ </listitem>
+
+ <listitem>
+ <para>Shared Folders: don't stop mounting the other valid folders if one
+ host folder is inaccessible (4.0.6 regression)</para>
+ </listitem>
+
+ <listitem>
+ <para>Linux Additions: check whether gcc and make are installed before
+ building kernel modules (bug #8795)</para>
+ </listitem>
+
+ <listitem>
+ <para>Solaris Additions: added support for X.Org Server 1.10</para>
+ </listitem>
+
+ <listitem>
+ <para>Guest Additions: fixed inappropriate Guest Additions update
+ notification when using vendor-specific version suffixes (bug #8844)</para>
+ </listitem>
+
+ </itemizedlist>
+ </sect1>
+
+ <sect1>
<title>Version 4.0.6 (2011-04-21)</title>
<para>This is a maintenance release. The following items were fixed and/or
@@ -235,7 +356,7 @@
<listitem>
<para>Windows Additions: fixed driver bugcheck error when handling PnP
- messages (4.0 regression; bug 8367)</para>
+ messages (4.0 regression; bug #8367)</para>
</listitem>
<listitem>
@@ -544,7 +665,7 @@
<listitem>
<para>Storage: fixed possible crashes with VMDK/VHD images with snapshots
- and async I/O (4.0 regression)</para>
+ and asynchronous I/O (4.0 regression)</para>
</listitem>
<listitem>
@@ -1418,7 +1539,7 @@
</listitem>
<listitem>
- <para>GUI: switch to native file dialogs (Windows hosts only; bug 5459)</para>
+ <para>GUI: switch to native file dialogs (Windows hosts only; bug #5459)</para>
</listitem>
<listitem>
@@ -1650,7 +1771,7 @@
<listitem>
<para>Storage: fixed hang with images located on filesystems which
- don't support async I/O (bug #6905)</para>
+ don't support asynchronous I/O (bug #6905)</para>
</listitem>
<listitem>
@@ -3917,7 +4038,7 @@
</listitem>
<listitem>
- <para>NAT: fixed ethernet address corruptions (bug #4839)</para>
+ <para>NAT: fixed Ethernet address corruptions (bug #4839)</para>
</listitem>
<listitem>