Changeset 44553 in vbox

Timestamp:

Feb 5, 2013 8:51:09 PM (12 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

83611

Message:

Main/doc: prefer <HOME>/.config/VirtualBox over <HOME>/.VirtualBox for new users on platforms where XDG is relevant, user manual and change log changes.

Location:

trunk/doc/manual

Files:

• en_US/SDKRef.xml (modified) (3 diffs)
• en_US/user_Technical.xml (modified) (2 diffs)
• en_US/user_Troubleshooting.xml (modified) (1 diff)
• en_US/user_VBoxManage.xml (modified) (3 diffs)
• user_ChangeLogImpl.xml (modified) (1 diff)

trunk/doc/manual/en_US/SDKRef.xml

@@ -309 +309 @@
       virtual machines and other data represented by the VirtualBox data of
       that user (for example, on a Linux machine, under
-      <computeroutput>/home/user1/.VirtualBox</computeroutput>; see the
+      <computeroutput>/home/user1/.config/VirtualBox</computeroutput>; see the
       VirtualBox User Manual for details on where this data is stored).</para>
 
@@ -2217 +2217 @@
 
     <para>You can easily extend this shell with your own commands. Create a
-    subdirectory named <computeroutput>.VirtualBox/shexts</computeroutput>
-    below your home directory and put a Python file implementing your shell
+    subdirectory named <computeroutput>.config/VirtualBox/shexts</computeroutput>
+    below your home directory (respectively <computeroutput>.VirtualBox/shexts</computeroutput> on a Windows system and <computeroutput>Library/VirtualBox/shexts</computeroutput> on OS X) and put a Python file implementing your shell
     extension commands in this directory. This file must contain an array
     named <computeroutput>commands</computeroutput> containing your command
@@ -2267 +2267 @@
       </screen> Just store the above text in the file
     <computeroutput>createHdd</computeroutput> (or any other meaningful name)
-    in <computeroutput>.VirtualBox/shexts/</computeroutput>. Start the
+    in <computeroutput>.config/VirtualBox/shexts/</computeroutput>. Start the
     VirtualBox shell, or just issue the
     <computeroutput>reloadExts</computeroutput> command, if the shell is

trunk/doc/manual/en_US/user_Technical.xml

@@ -149 +149 @@
 
       <para>In addition to the files of the virtual machines, VirtualBox
-      maintains global configuration data. On Windows, Linux and Solaris, this
-      is in <computeroutput>$HOME/.VirtualBox</computeroutput> (which makes it
-      hidden on Linux and Solaris), whereas on a Mac this resides in
+      maintains global configuration data. On Linux and Solaris as of VirtualBox 4.3, this
+      is in the hidden directory <computeroutput>$HOME/.config/VirtualBox</computeroutput>, although <computeroutput>$HOME/.VirtualBox</computeroutput> will be used if it exists for compatibility with earlier versions; on Windows (and on Linux and Solaris with VirtualBox 4.2 and earlier) this is in <computeroutput>$HOME/.VirtualBox</computeroutput>; on a Mac it resides in
       <computeroutput>$HOME/Library/VirtualBox</computeroutput>.</para>
 
@@ -158 +157 @@
       directory by setting the
       <computeroutput><literal>VBOX_USER_HOME</literal></computeroutput>
-      environment variable. (Since the global
+      environment variable, or additionally on Linux or Solaris by using the standard <computeroutput><literal>XDG_CONFIG_HOME</literal></computeroutput> variable. (Since the global
       <computeroutput>VirtualBox.xml</computeroutput> settings file points to
       all other configuration files, this allows for switching between several

trunk/doc/manual/en_US/user_Troubleshooting.xml

@@ -1282 +1282 @@
       running under. <computeroutput>VBoxSVC</computeroutput> owns the
       VirtualBox configuration database which normally resides in
-      <computeroutput>~/.VirtualBox</computeroutput>. While it is running, the
+      <computeroutput>~/.config/VirtualBox</computeroutput>, or the appropriate configuration directory for your operating system. While it is running, the
       configuration files are locked. Communication between the various
       VirtualBox components and <computeroutput>VBoxSVC</computeroutput> is

trunk/doc/manual/en_US/user_VBoxManage.xml

@@ -84 +84 @@
 Virtual machine 'SUSE 10.2' is created.
 UUID: c89fc351-8ec6-4f02-a048-57f4d25288e5
-Settings file: '/home/username/.VirtualBox/Machines/SUSE 10.2/SUSE 10.2.xml'
+Settings file: '/home/username/.config/VirtualBox/Machines/SUSE 10.2/SUSE 10.2.xml'
 </screen>
 
@@ -311 +311 @@
 Guest OS:        Other/Unknown
 UUID:            1bf3464d-57c6-4d49-92a9-a5cc3816b7e7
-Config file:     /home/username/.VirtualBox/Machines/Windows XP/Windows XP.xml
+Config file:     /home/username/.config/VirtualBox/Machines/Windows XP/Windows XP.xml
 Memory size:     512MB
 VRAM size:       12MB
@@ -424 +424 @@
     used by default as the file name of the settings file (with the extension
     <computeroutput>.xml</computeroutput>) and the machine folder (a subfolder
-    of the <computeroutput>.VirtualBox/Machines</computeroutput> folder), it
+    of the <computeroutput>.config/VirtualBox/Machines</computeroutput> folder - this folder name may vary depending on the operating system and the version of VirtualBox which you are using), it
     must conform to your host operating system's requirements for file name
     specifications. If the VM is later renamed, the file and folder names will

trunk/doc/manual/user_ChangeLogImpl.xml

@@ -21 +21 @@
       <listitem>
         <para>dummy</para>
+      </listitem>
+
+      <listitem>
+        <para>Main: use the XDG standard configuration folder instead of
+           .VirtualBox on systems where it is appropriate (bug #5099)</para>
       </listitem>