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

Timestamp:

Mar 13, 2022 8:57:16 PM (3 years ago)

Author:

vboxsync

Message:

doc/manual,FE/VBoxManage: Convert usbdevsource command to refentry documentation, ​bugref:9186

Location:

trunk/doc/manual/en_US

Files:

• man_VBoxManage-usbdevsource.xml (modified) (3 diffs)
• user_VBoxManage.xml (modified) (1 diff)

trunk/doc/manual/en_US/man_VBoxManage-usbdevsource.xml

@@ -20 +20 @@
 <refentry id="vboxmanage-usbdevsource" lang="en">
   <refentryinfo>
-    <pubdate>September 2019</pubdate>
+    <pubdate>$Date$</pubdate>
     <title>VBoxManage usbdevsource</title>
   </refentryinfo>
 
   <refmeta>
-    <refentrytitle>VBoxManage-usbdevsource</refentrytitle>
+    <refentrytitle>vboxmanage-usbdevsource</refentrytitle>
     <manvolnum>1</manvolnum>
   </refmeta>
@@ -32 +32 @@
     <refname>vboxmanage-usbdevsource</refname>
     <refpurpose>add and remove USB device sources</refpurpose>
-    <refclass>Oracle VM VirtualBox</refclass>
+    <refclass>&product-name;</refclass>
   </refnamediv>
 
@@ -82 +82 @@
           <listitem><para>
               Specifies the USB proxy service backend to use.
-            </para><remark>
-              What is the USB proxy service? How do you
-              determine the backend to use?
-            </remark></listitem>
+            </para><para>
+              For now only USBIP is supported to specify a remote
+              server using the USB/IP protocol.
+            </para></listitem>
         </varlistentry>
       </variablelist>

trunk/doc/manual/en_US/user_VBoxManage.xml

@@ -1127 +1127 @@
   <xi:include href="user_man_VBoxManage-dhcpserver.xml"     xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
 
-  <sect1 id="vboxmanage-usbdevsource">
-
-    <title>VBoxManage usbdevsource</title>
-
-    <para>
-      The <command>usbdevsource</command> commands enable you to add and
-      remove USB devices globally.
-    </para>
-
-    <para>
-      The following command adds a USB device.
-    </para>
-
-<screen>VBoxManage usbdevsource add &lt;source name&gt;
-                            --backend &lt;backend&gt;
-                            --address &lt;address&gt;
-    </screen>
-
-    <para>
-      Where the command line options are as follows:
-    </para>
-
-    <itemizedlist>
-
-      <listitem>
-        <para>
-          <computeroutput>&lt;source name&gt;</computeroutput>:
-          Specifies the ID of the source USB device to be added.
-          Mandatory.
-        </para>
-      </listitem>
-
-      <listitem>
-        <para>
-          <computeroutput>--backend &lt;backend&gt;</computeroutput>:
-          Specifies the USB proxy service backend to use. Mandatory.
-        </para>
-      </listitem>
-
-      <listitem>
-        <para>
-          <computeroutput> --address &lt;address&gt;</computeroutput>:
-          Specifies the backend specific address. Mandatory.
-        </para>
-      </listitem>
-
-    </itemizedlist>
-
-    <para>
-      The following command removes a USB device.
-    </para>
-
-<screen>VBoxManage usbdevsource remove &lt;source name&gt;
-    </screen>
-
-    <para>
-      Where the command line options are as follows:
-    </para>
-
-    <itemizedlist>
-
-      <listitem>
-        <para>
-          <computeroutput>&lt;source name&gt;</computeroutput>:
-          Specifies the ID of the source USB device to be removed.
-          Mandatory.
-        </para>
-      </listitem>
-
-    </itemizedlist>
-
-  </sect1>
+  <xi:include href="user_man_VBoxManage-usbdevsource.xml"   xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
 
   <xi:include href="user_man_VBoxManage-extpack.xml"        xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />