Changeset 103992 in vbox

Timestamp:

Mar 21, 2024 3:44:54 PM (10 months ago)

Author:

vboxsync

Message:

doc/manual: Improve the User Manual documentation around the behaviour
of symbolic links created inside a Shared Folder on the host and then
viewed from inside a guest which doesn't have Shared Folder symlink
support. bugref:10619 ticketref:21809

File:

• trunk/doc/manual/en_US/dita/topics/sharedfolders.dita (modified) (2 diffs)

trunk/doc/manual/en_US/dita/topics/sharedfolders.dita

@@ -101 +101 @@
                   <li>
                      <p>
-          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.
         </p>
                   </li>
@@ -109 +110 @@
           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:
         </p>
-                     <pre xml:space="preserve">VBoxManage setextradata "VM name" VBoxInternal2/SharedFoldersEnableSymlinksCreate/<varname>sharename</varname> 1</pre>
+                     <pre xml:space="preserve">VBoxManage setextradata <varname>VM-name</varname> VBoxInternal2/SharedFoldersEnableSymlinksCreate/<varname>sharename</varname> 1</pre>
                   </li>
                </ul>
+               <p>
+          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:
+        </p>
+               <p>
+                     <pre xml:space="preserve">$ cd /SharedFolder &amp;&amp; ln -s filename symlink-to-filename</pre>
+        </p>
+               <p>
+          And then the shared folder is viewed on a Windows guest there
+          will be two identical files listed, <userinput>filename</userinput>
+          and <userinput>symlink-to-filename</userinput>.
+        </p>
             </body>