[vbox-dev] Latest updated manual
MENGUAL Jean-Philippe
mengualjeanphi at free.fr
Sat Nov 9 13:54:38 GMT 2013
Hi,
Could you, instead, give me a diff between 4.3 branch and latest trunk?
it'd be easier to maintain.
Thanks.
Best regards,
Le 04/11/2013 12:38, Michael Thayer a écrit :
> Hello Jean-Philippe,
>
> On 02/11/13 03:52, MENGUAL Jean-Philippe wrote:
>> Here's the manual updated (according to the trunk changes):
>> http://manager.accelibreinfo.eu/vbox.tar.gz
>
> Applied the changes, many thanks!
>
> If it is of interest, the following is the difference between the
> 4.3.0 manual and the current state of the 4.3 branch. Please tell me
> whether the diff format is usable for you!
>
> Regards,
>
> Michael
>
> Index: doc/manual/en_US/user_VBoxManage.xml
> ===================================================================
> --- doc/manual/en_US/user_VBoxManage.xml (revision 89689)
> +++ doc/manual/en_US/user_VBoxManage.xml (working copy)
> @@ -582,6 +582,14 @@
> </listitem>
>
> <listitem>
> + <para><computeroutput>--triplefaultreset
> on|off</computeroutput>:
> + This setting allows to reset the guest instead of
> triggering a
> + Guru Meditation. Some guests raise a triple fault to
> reset the
> + CPU so sometimes this is desired behavior. Works only for
> non-SMP
> + guests.</para>
> + </listitem>
> +
> + <listitem>
> <para><computeroutput>--nestedpaging
> on|off</computeroutput>: If
> hardware virtualization is enabled, this additional setting
> enables or disables the use of the nested paging feature
> in the
> @@ -1986,7 +1994,7 @@
> [--add <ide/sata/scsi/floppy>]
> [--controller
> <LsiLogic|LSILogicSAS|BusLogic|
>
> IntelAhci|PIIX3|PIIX4|ICH6|I82078>]
> - [--sataportcount <1-30>]
> + [--portcount <1-30>]
> [--hostiocache on|off]
> [--bootable on|off]
> [--remove]</screen>
> @@ -2027,7 +2035,7 @@
> </glossentry>
>
> <glossentry>
> - <glossterm><computeroutput>--sataportcount</computeroutput></glossterm>
> + <glossterm><computeroutput>--portcount</computeroutput></glossterm>
>
> <glossdef>
> <para>This determines how many ports the SATA controller
> should
> Index: doc/manual/en_US/user_AdvancedTopics.xml
> ===================================================================
> --- doc/manual/en_US/user_AdvancedTopics.xml (revision 89689)
> +++ doc/manual/en_US/user_AdvancedTopics.xml (working copy)
> @@ -857,6 +857,102 @@
> </sect1>
>
> <sect1>
> + <title>Webcam passthrough</title>
> +
> + <sect2 id="webcam-passthrough">
> + <title>Using a host webcam in the guest</title>
> +
> + <para>VirtualBox 4.3 includes an experimental feature which
> allows a guest to use
> + a host webcam. This complements the general USB passthrough
> support which was the
> + typical way of using host webcams in ealier versions. The
> webcam passthrough support
> + can handle non-USB video sources in theory, but this is
> completely untested.</para>
> +
> + <note>
> + <para>The webcam passthrough module is shipped as part of the
> Oracle VM VirtualBox
> + extension pack, which must be installed separately. See <xref
> + linkend="intro-installing" /> for more information.</para>
> + </note>
> +
> + <para>The VBoxManage command line tool must be used to enable
> webcam passthrough.
> + Please see the host-specific sections below for additional
> details.
> + The following commands are available:
> + <itemizedlist>
> + <listitem><para>Get a list of host webcams (or other video
> input devices):
> + <screen>VBoxManage list webcams</screen>
> + The output format:
> + <screen>alias "user friendly name"
> +host path or identifier</screen>
> + The alias can be used as a shortcut in other commands.
> Alias '.0' means
> + default video input device on the host, '.1', '.2', etc
> mean first, second, etc
> + video input device. The device order is host-specific.
> + </para></listitem>
> + <listitem><para>Attach a webcam to a running VM:
> + <screen>VBoxManage controlvm "VM name" webcam attach
> [host_path|alias [settings]]</screen>
> + This will attach a USB webcam device to the guest.</para>
> +
> + <para>The <computeroutput>settings</computeroutput>
> parameter is a string
> + <computeroutput>Setting1=Value1;Setting2=Value2</computeroutput>,
> which allows to
> + configure the emulated webcam device. The following
> settings are supported:
> + <itemizedlist>
> + <listitem>
> + <computeroutput>MaxFramerate</computeroutput> The highest rate at
> which video frames
> + are sent to the guest. A higher frame rate requires
> more CPU power. Therefore sometimes
> + it is useful to set a lower limit. Default is no
> limit and allow the guest to use all
> + frame rates supported by the host webcam.
> + </listitem>
> + <listitem>
> + <computeroutput>MaxPayloadTransferSize</computeroutput> How many
> bytes the emulated
> + webcam can send to the guest at a time. Default value
> is 3060 bytes, which is used by
> + some webcams. Higher values can slightly reduce CPU
> load, if the guest is able to use
> + larger buffers. However a high
> <computeroutput>MaxPayloadTransferSize</computeroutput>
> + might be not supported by some guests.
> + </listitem>
> + </itemizedlist>
> + </para></listitem>
> + <listitem><para>Detach a webcam from a running VM:
> + <screen>VBoxManage controlvm "VM name" webcam detach
> [host_path|alias]</screen>
> + </para></listitem>
> + <listitem><para>List webcams attached to a running VM:
> + <screen>VBoxManage controlvm "VM name" webcam list</screen>
> + The output contains path or alias which was used in
> 'webcam attach' command for
> + each attached webcam.
> + </para></listitem>
> + </itemizedlist>
> + </para>
> + </sect2>
> +
> + <sect2>
> + <title>Windows hosts</title>
> +
> + <para>When the webcam device is detached from the host, the
> emulated webcam device is
> + automatically detached from the guest.</para>
> + </sect2>
> +
> + <sect2>
> + <title>Mac OS X hosts</title>
> +
> + <para>OS X version 10.7 or newer is required.</para>
> +
> + <para>When the webcam device is detached from the host, the
> emulated webcam device
> + remains attached to the guest and must be manually detached
> using the
> + <computeroutput>VBoxManage controlvm "VM name" webcam detach
> ...</computeroutput> command.</para>
> + </sect2>
> +
> + <sect2>
> + <title>Linux hosts</title>
> +
> + <para>When the webcam is detached from the host the emulated
> webcam device is
> + automatically detached from the guest only if the webcam is
> streaming video.
> + If the emulated webcam is inactive it should be manually
> detached using the
> + <computeroutput>VBoxManage controlvm "VM name" webcam detach
> ...</computeroutput> command.</para>
> +
> + <para>Aliases <computeroutput>.0</computeroutput> and
> <computeroutput>.1</computeroutput> are mapped
> + to <computeroutput>/dev/video0</computeroutput>, alias
> <computeroutput>.2</computeroutput> is mapped
> + to <computeroutput>/dev/video1</computeroutput> and so
> forth.</para>
> + </sect2>
> + </sect1>
> +
> + <sect1>
> <title>Advanced display configuration</title>
>
> <sect2>
> Index: doc/manual/en_US/user_KnownIssues.xml
> ===================================================================
> --- doc/manual/en_US/user_KnownIssues.xml (revision 89689)
> +++ doc/manual/en_US/user_KnownIssues.xml (working copy)
> @@ -213,12 +213,6 @@
> </listitem>
>
> <listitem>
> - <para>Even when idle, Mac OS X guests currently burn
> 100% CPU.
> - This is a power management issue that will be
> addressed in a
> - future release.</para>
> - </listitem>
> -
> - <listitem>
> <para>Mac OS X guests only work with one CPU assigned
> to the
> VM. Support for SMP will be provided in a future
> release.</para>
> </listitem>
> Index: doc/manual/en_US/SDKRef.xml
> ===================================================================
> --- doc/manual/en_US/SDKRef.xml (revision 89689)
> +++ doc/manual/en_US/SDKRef.xml (working copy)
> @@ -3543,6 +3543,12 @@
> </listitem>
>
> <listitem>
> + <para>The parameter list of <xref linkend="IAppliance__write"
> + xreflabel="IAppliance::write()" /> has been changed
> slightly, to
> + allow multiple flags to be passed.</para>
> + </listitem>
> +
> + <listitem>
> <para><computeroutput>IMachine::delete</computeroutput>
> has been renamed to <xref linkend="IMachine__deleteConfig"
> xreflabel="IMachine::deleteConfig()" />, to improve API client
> Index: doc/manual/user_ChangeLogImpl.xml
> ===================================================================
> --- doc/manual/user_ChangeLogImpl.xml (revision 89689)
> +++ doc/manual/user_ChangeLogImpl.xml (working copy)
> @@ -1,8 +1,45 @@
> <?xml version="1.0" encoding="UTF-8"?>
>
> <sect1>
> - <title>Version 4.3.0 Release Candidate 1 (2013-10-08)</title>
> + <title>Version 4.3.2 (2013-xx-xx)</title>
>
> + <para>This is a maintenance release. The following items were
> fixed and/or
> + added:</para>
> +
> + <itemizedlist>
> +
> + <listitem>
> + <para>VMM: fixed restoring of the auxillary TSC MSR in VT-x
> that caused host
> + BSODs on Windows 8.1 hosts and unpredictable behaviour on
> other hosts
> + (bug #12237)</para>
> + </listitem>
> +
> + <listitem>
> + <para>VMM: fixed detection of VT-x on certain machines where
> the BIOS would
> + not set the VMX LOCK feature bit, which affected the VM
> settings in the GUI</para>
> + </listitem>
> +
> + <listitem>
> + <para>Storage: fixed detection of CD/DVD media when switching
> from an empty
> + to a host drive with passthrough enabled</para>
> + </listitem>
> +
> + <listitem>
> + <para>Linux Additions: correctly set umask before installing
> + (bug #12166)</para>
> + </listitem>
> +
> + <listitem>
> + <para>X11 Additions/3D: fix freezes starting 3D desktop (bug
> #11503,
> + thank you Sam Spilsbury)</para>
> + </listitem>
> +
> + </itemizedlist>
> + </sect1>
> +
> + <sect1>
> + <title>Version 4.3.0 (2013-10-15)</title>
> +
> <para>This is a major update. The following major new features
> were added:</para>
>
> @@ -38,6 +75,11 @@
> </listitem>
>
> <listitem>
> + <para>Added experimental support for webcam passthrough
> + complementing USB passthrough (see <xref
> linkend="webcam-passthrough" />)</para>
> + </listitem>
> +
> + <listitem>
> <para>Added SCSI CD-ROM emulation, including boot support</para>
> </listitem>
>
> @@ -51,7 +93,8 @@
> </listitem>
>
> <listitem>
> - <para>Guest Control: implemented IGuestFile support</para>
> + <para>Guest Control: implemented
> <computeroutput>IGuestFile</computeroutput>
> + support</para>
> </listitem>
>
> <listitem>
> @@ -82,6 +125,11 @@
> </listitem>
>
> <listitem>
> + <para>VMM: allow to activate VT-x while in SMX mode and
> provide more
> + information if that is not possible</para>
> + </listitem>
> +
> + <listitem>
> <para>GUI: update check uses https</para>
> </listitem>
>
> @@ -90,6 +138,11 @@
> </listitem>
>
> <listitem>
> + <para>GUI: HID LEDs synchronization when switching between
> guest window(s)
> + and host (Mac OS X hosts only)</para>
> + </listitem>
> +
> + <listitem>
> <para>GUI, VBoxManage: when unregistering a VM, also
> unregister the
> hard disk images which are used exclusively (bug
> #10311)</para>
> </listitem>
> @@ -203,6 +256,12 @@
> </listitem>
>
> <listitem>
> + <para>VBoxManage: added <computeroutput>modifyvm
> --triplefaultreset</computeroutput>
> + to make the VM reset on triple fault instead of triggering
> a Guru Meditation
> + (see <xref linkend="vboxmanage-modifyvm"/>)</para>
> + </listitem>
> +
> + <listitem>
> <para>3D support: several fixes</para>
> </listitem>
>
> @@ -226,10 +285,19 @@
>
> <listitem>
> <para>Shared Clipboard/X11: support for BMP-format images,
> contributed
> - by François Revol</para>
> + by François Revol</para>
> </listitem>
>
> <listitem>
> + <para>Mac OS X hosts: limited support for Mac OS X 10.9
> (Mavericks)</para>
> + </listitem>
> +
> + <listitem>
> + <para>Mac OS X hosts: use a launchd script instead of the
> deprecated
> + StartupItem mechanism (bug #8940)</para>
> + </listitem>
> +
> + <listitem>
> <para>Windows hosts: don't cause massive DPC latency (only on
> certain
> hosts; still needs improving; bug #6242)</para>
> </listitem>
> @@ -255,13 +323,13 @@
> </listitem>
>
> <listitem>
> - <para>Linux Additions: fixed udev detection in the init script
> - with Linux 3.x kernels</para>
> + <para>Windows Additions: ability to track guest user idle
> times through
> + the newly introduced event
> <emphasis>IGuestUserStateChangedEvent</emphasis></para>
> </listitem>
>
> <listitem>
> - <para>Windows guests: ability to track guest user idle times
> through
> - the newly introduced event
> <emphasis>IGuestUserStateChangedEvent</emphasis></para>
> + <para>Linux Additions: fixed udev detection in the init script
> + with Linux 3.x kernels</para>
> </listitem>
>
> </itemizedlist>
--
Jean-Philippe MENGUAL
accelibreinfo, votre partenaire en informatique adaptée aux déficients visuels
Mail: texou at accelibreinfo.eu
Site Web: http://www.accelibreinfo.eu
More information about the vbox-dev
mailing list