Changeset 82044 in vbox for trunk/doc/manual/en_US

Timestamp:

Nov 20, 2019 7:50:02 PM (5 years ago)

Author:

vboxsync

Message:

doc/manual: Add all new manpages (the new VBoxManage ones are not yet used, it needs reviewing and proper integrating), and integrate the one for VBoxManage and vboximg-mount.

Location:

trunk/doc/manual/en_US

Files:

• man_VBoxHeadless.xml (added)
• man_VBoxManage-adoptstate.xml (added)
• man_VBoxManage-bandwidthctl.xml (added)
• man_VBoxManage-checkmediumpwd.xml (added)
• man_VBoxManage-clonemedium.xml (added)
• man_VBoxManage-closemedium.xml (added)
• man_VBoxManage-controlvm.xml (added)
• man_VBoxManage-convertfromraw.xml (added)
• man_VBoxManage-createmedium.xml (added)
• man_VBoxManage-createvm.xml (added)
• man_VBoxManage-discardstate.xml (added)
• man_VBoxManage-encryptmedium.xml (added)
• man_VBoxManage-export.xml (added)
• man_VBoxManage-getextradata.xml (added)
• man_VBoxManage-guestcontrol.xml (added)
• man_VBoxManage-guestproperty.xml (added)
• man_VBoxManage-hostonlyif.xml (added)
• man_VBoxManage-import.xml (added)
• man_VBoxManage-list.xml (added)
• man_VBoxManage-mediumproperty.xml (added)
• man_VBoxManage-metrics.xml (added)
• man_VBoxManage-modifymedium.xml (added)
• man_VBoxManage-modifyvm.xml (added)
• man_VBoxManage-movevm.xml (added)
• man_VBoxManage-natnetwork.xml (added)
• man_VBoxManage-registervm.xml (added)
• man_VBoxManage-setextradata.xml (added)
• man_VBoxManage-setproperty.xml (added)
• man_VBoxManage-sharedfolder.xml (added)
• man_VBoxManage-showmediuminfo.xml (added)
• man_VBoxManage-showvminfo.xml (added)
• man_VBoxManage-startvm.xml (added)
• man_VBoxManage-storageattach.xml (added)
• man_VBoxManage-storagectl.xml (added)
• man_VBoxManage-unregistervm.xml (added)
• man_VBoxManage-usbdevsource.xml (added)
• man_VBoxManage-usbfilter.xml (added)
• man_VBoxManage.xml (added)
• man_vboximg-mount.xml (added)
• user_Frontends.xml (modified) (3 diffs)
• user_Storage.xml (modified) (1 diff)
• user_VBoxManage.xml (modified) (1 diff)

trunk/doc/manual/en_US/user_Frontends.xml

@@ -255 +255 @@
         &product-name; therefore comes with a front-end called
         <computeroutput>VBoxHeadless</computeroutput>, which produces no
-        visible output on the host at all, but still can deliver VRDP
-        data. This front-end has no dependencies on the X Window system
+        visible output on the host at all, but still can optionally deliver
+        VRDP data. This front-end has no dependencies on the X Window system
         on Linux and Oracle Solaris hosts.
       </para>
@@ -309 +309 @@
             directly as a background process which has to be done
             explicitly when directly starting with
-            <computeroutput>VBoxHeadless</computeroutput>.
+            <computeroutput>VBoxHeadless</computeroutput>. The full
+            documentation of the command is in
+            <xref linkend="vboxmanage-vboxheadless"/>.
           </para>
         </listitem>
@@ -1240 +1242 @@
   </sect1>
 
+  <xi:include href="user_man_VBoxHeadless.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+
 </chapter>

trunk/doc/manual/en_US/user_Storage.xml

@@ -1561 +1561 @@
     <para>
       Use the <option>--help</option> option to view information about
-      the <command>vboximg-mount</command> command usage.
+      the <command>vboximg-mount</command> command usage. The complete
+      command reference is described in <xref linkend="man_vboximg-mount" />.
     </para>
 

trunk/doc/manual/en_US/user_VBoxManage.xml

@@ -9032 +9032 @@
   <xi:include href="user_man_VBoxManage-cloudinstance.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
   <xi:include href="user_man_VBoxManage-cloudimage.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+  <!-- TODO: Figure out how we can handle other manpages. The xml is bolted to
+             sect1, so it's not possible to have them "in place" -->
+  <xi:include href="user_man_vboximg-mount.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
 </chapter>