summaryrefslogtreecommitdiffstats
path: root/doc/manual/en_US
diff options
context:
space:
mode:
Diffstat (limited to 'doc/manual/en_US')
-rw-r--r--doc/manual/en_US/man_VBoxManage-createvm.xml6
-rw-r--r--doc/manual/en_US/man_VBoxManage-modifyvm.xml6
-rw-r--r--doc/manual/en_US/user_GuestAdditions.xml27
-rw-r--r--doc/manual/en_US/user_Installation.xml72
-rw-r--r--doc/manual/en_US/user_Introduction.xml2
5 files changed, 71 insertions, 42 deletions
diff --git a/doc/manual/en_US/man_VBoxManage-createvm.xml b/doc/manual/en_US/man_VBoxManage-createvm.xml
index dea674a6..dd5439ba 100644
--- a/doc/manual/en_US/man_VBoxManage-createvm.xml
+++ b/doc/manual/en_US/man_VBoxManage-createvm.xml
@@ -30,7 +30,7 @@
]>
<refentry id="vboxmanage-createvm" lang="en">
<refentryinfo>
- <pubdate>$Date: 2023-01-17 15:15:46 +0100 (Tue, 17 Jan 2023) $</pubdate>
+ <pubdate>$Date: 2024-02-19 17:23:30 +0100 (Mon, 19 Feb 2024) $</pubdate>
<title>VBoxManage createvm</title>
</refentryinfo>
@@ -52,7 +52,7 @@
<arg choice="req">--name=<replaceable>name</replaceable></arg>
<arg>--basefolder=<replaceable>basefolder</replaceable></arg>
<arg>--default</arg>
- <arg>--group=<replaceable>group-ID</replaceable>,...</arg>
+ <arg>--groups=<replaceable>group-ID</replaceable>,...</arg>
<arg>--ostype=<replaceable>ostype</replaceable></arg>
<arg>--register</arg>
<arg>--uuid=<replaceable>uuid</replaceable></arg>
@@ -112,7 +112,7 @@
</para></listitem>
</varlistentry>
<varlistentry>
- <term><option>--group=<replaceable>group-ID</replaceable>,...</option></term>
+ <term><option>--groups=<replaceable>group-ID</replaceable>[,...]</option></term>
<listitem><para>
Assigns the VM to the specified groups. If you specify more
than one group, separate each group name with a comma.
diff --git a/doc/manual/en_US/man_VBoxManage-modifyvm.xml b/doc/manual/en_US/man_VBoxManage-modifyvm.xml
index 9916b604..299e788c 100644
--- a/doc/manual/en_US/man_VBoxManage-modifyvm.xml
+++ b/doc/manual/en_US/man_VBoxManage-modifyvm.xml
@@ -30,7 +30,7 @@
]>
<refentry id="vboxmanage-modifyvm" lang="en">
<refentryinfo>
- <pubdate>$Date: 2023-01-17 15:15:46 +0100 (Tue, 17 Jan 2023) $</pubdate>
+ <pubdate>$Date: 2024-02-19 16:32:13 +0100 (Mon, 19 Feb 2024) $</pubdate>
<title>VBoxManage modifyvm</title>
</refentryinfo>
@@ -1103,7 +1103,7 @@ it unless this changes. -->
</para></listitem>
</varlistentry>
<varlistentry>
- <term><option>--accelerated3d=on | off</option></term>
+ <term><option>--accelerate-3d=on | off</option></term>
<listitem><para>
Enables or disables hardware 3D acceleration for the
graphics adapter variants which support it. This option
@@ -1112,7 +1112,7 @@ it unless this changes. -->
</para></listitem>
</varlistentry>
<varlistentry>
- <term><option>--accelerated2dvideo=on | off</option></term>
+ <term><option>--accelerate-2d-video=on | off</option></term>
<listitem><para>
Enables or disables 2D video acceleration for the graphics
adapter variants which support it. This option has an effect
diff --git a/doc/manual/en_US/user_GuestAdditions.xml b/doc/manual/en_US/user_GuestAdditions.xml
index f2d4d5d9..ff5284be 100644
--- a/doc/manual/en_US/user_GuestAdditions.xml
+++ b/doc/manual/en_US/user_GuestAdditions.xml
@@ -1287,8 +1287,9 @@
<listitem>
<para>
- Currently only Linux and Oracle Solaris Guest Additions
- support symlinks.
+ The guest VM must have a version of the Guest Additions
+ installed which supports symlinks. Currently only the Linux and
+ Oracle Solaris Guest Additions support symlinks.
</para>
</listitem>
@@ -1296,15 +1297,31 @@
<para>
For security reasons the guest OS is not allowed to create
symlinks by default. If you trust the guest OS to not abuse
- the functionality, you can enable creation of symlinks for a
- shared folder as follows:
+ the functionality, you can enable the creation of symlinks for
+ a shared folder as follows:
</para>
-<screen>VBoxManage setextradata "VM name" VBoxInternal2/SharedFoldersEnableSymlinksCreate/<replaceable>sharename</replaceable> 1</screen>
+<screen>VBoxManage setextradata <replaceable>VM-name</replaceable> VBoxInternal2/SharedFoldersEnableSymlinksCreate/<replaceable>sharename</replaceable> 1</screen>
</listitem>
</itemizedlist>
+ <para>
+ If a symbolic link is created inside a shared folder on the host
+ and the installed Guest Additions don't support symbolic links
+ then the guest will see the target of the symlink as a file
+ inside the shared folder. For example, if a symlink is created
+ to a file on a Linux host:
+ </para>
+
+<screen>$ cd /SharedFolder &amp;&amp; ln -s filename symlink-to-filename</screen>
+
+ <para>
+ And then the shared folder is viewed on a Windows guest there
+ will be two identical files listed, <emphasis>filename</emphasis>
+ and <emphasis>symlink-to-filename</emphasis>.
+ </para>
+
<sect2 id="sf_mount_manual">
<title>Manual Mounting</title>
diff --git a/doc/manual/en_US/user_Installation.xml b/doc/manual/en_US/user_Installation.xml
index 12a83841..2661b259 100644
--- a/doc/manual/en_US/user_Installation.xml
+++ b/doc/manual/en_US/user_Installation.xml
@@ -1363,60 +1363,72 @@ virtualbox virtualbox/delete-old-modules boolean true</screen>
<sect2 id="solaris-zones">
- <title>Configuring a Zone for Running &product-name;</title>
+ <title>Configuring a Non-Global Zone for Running &product-name;</title>
<para>
- Assuming that &product-name; has already been installed into
- your zone, you need to give the zone access to &product-name;'s
- device node. This is done by performing the following steps.
- Start a root terminal and run the following command:
+ After installing &product-name; in the global zone
+ (see <xref linkend="install-solaris-host"/> for the installation instructions)
+ the first step required to run &product-name; in a
+ non-global zone is to modify the zone's configuration to be able to access the
+ &product-name; device nodes located in the global zone.
+ This is done by performing the following steps as a zone administrator in the global zone.
</para>
-<screen>zonecfg -z <replaceable>vboxzone</replaceable></screen>
+<screen>global$ zonecfg -z <replaceable>vboxzone</replaceable></screen>
<para>
Replace <replaceable>vboxzone</replaceable> with the name of the
- zone where you intend to run &product-name;.
+ non-global zone where you plan to run &product-name;.
</para>
<para>
- Use <command>zonecfg</command> to add the
- <literal>device</literal> resource and <literal>match</literal>
- properties to the zone, as follows:
+ Use <command>zonecfg(8)</command> to add the
+ <literal>device</literal> resource and the <literal>match</literal>
+ property for each &product-name; device node in the global zone to
+ the non-global zone as follows:
</para>
-<screen>zonecfg:vboxzone&gt;add device
-zonecfg:vboxzone:device&gt;set match=/dev/vboxdrv
-zonecfg:vboxzone:device&gt;end
-zonecfg:vboxzone&gt;add device
-zonecfg:vboxzone:device&gt;set match=/dev/vboxdrvu
-zonecfg:vboxzone:device&gt;end
-zonecfg:vboxzone&gt;exit</screen>
+<screen>zonecfg:vboxzone&gt; add device
+zonecfg:vboxzone:device&gt; set match=/dev/vboxdrv
+zonecfg:vboxzone:device&gt; end
+zonecfg:vboxzone&gt; add device
+zonecfg:vboxzone:device&gt; set match=/dev/vboxdrvu
+zonecfg:vboxzone:device&gt; end
+zonecfg:vboxzone&gt; exit</screen>
<para>
- On Oracle Solaris 11 or later, you may also add a device for
- <filename>/dev/vboxusbmon</filename>, similar to that shown
- above.
+ On Oracle Solaris 11 if you plan to use VMs configured to use a USB device, e.g. a USB
+ pointing device or a USB pass-through device, you should also pass through the
+ <filename>/dev/vboxusbmon</filename> device using the steps above.
</para>
<para>
- If you are not using sparse root zones, you will need to
+ Oracle Solaris 11 doesn't support sparse root zones so you will need to
loopback mount <filename>/opt/VirtualBox</filename> from the
global zone into the non-global zone at the same path. This is
- specified below using the <literal>dir</literal> attribute and
- the <literal>special</literal> attribute. For example:
+ done using <command>zonecfg(8)</command> to set the <literal>dir</literal>
+ attribute and the <literal>special</literal> attribute for this directory.
+ For example:
</para>
-<screen>zonecfg:vboxzone&gt;add fs
-zonecfg:vboxzone:device&gt;set dir=/opt/VirtualBox
-zonecfg:vboxzone:device&gt;set special=/opt/VirtualBox
-zonecfg:vboxzone:device&gt;set type=lofs
-zonecfg:vboxzone:device&gt;end
+<screen>zonecfg:vboxzone&gt; add fs
+zonecfg:vboxzone:fs&gt; set dir=/opt/VirtualBox
+zonecfg:vboxzone:fs&gt; set special=/opt/VirtualBox
+zonecfg:vboxzone:fs&gt; set type=lofs
+zonecfg:vboxzone:fs&gt; add options [readonly]
+zonecfg:vboxzone:fs&gt; end
zonecfg:vboxzone&gt;exit</screen>
<para>
- Reboot the zone using <command>zoneadm</command> and you should
- be able to run &product-name; from within the configured zone.
+ After making the above changes using <command>zonecfg(8)</command>, reboot the zone
+ using <command>zoneadm(8)</command> as follows:
+ </para>
+
+<screen>global$ zoneadm -z <replaceable>vboxzone</replaceable> reboot</screen>
+
+ <para>
+ for the changes to take effect. You will then be able to run
+ &product-name; from /opt/VirtualBox within the configured non-global zone.
</para>
</sect2>
diff --git a/doc/manual/en_US/user_Introduction.xml b/doc/manual/en_US/user_Introduction.xml
index f4cae028..3da5ac9e 100644
--- a/doc/manual/en_US/user_Introduction.xml
+++ b/doc/manual/en_US/user_Introduction.xml
@@ -379,7 +379,7 @@
devices, among them many devices that are typically
provided by other virtualization platforms. That includes
IDE, SCSI, and SATA hard disk controllers, several virtual
- network cards and sound cards, virtual serial and parallel
+ network cards and sound cards, virtual serial
ports and an Input/Output Advanced Programmable Interrupt
Controller (I/O APIC), which is found in many computer
systems. This enables easy cloning of disk images from