VirtualBox

source: vbox/trunk/doc/manual/en_US/man_VBoxManage-usbdevsource.xml@ 85919

Last change on this file since 85919 was 82969, checked in by vboxsync, 5 years ago

Copyright year updates - manual ones.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 4.2 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3 manpage, user manual, usage: VBoxManage usbdevsource
4
5 Copyright (C) 2006-2020 Oracle Corporation
6
7 This file is part of VirtualBox Open Source Edition (OSE), as
8 available from http://www.virtualbox.org. This file is free software;
9 you can redistribute it and/or modify it under the terms of the GNU
10 General Public License (GPL) as published by the Free Software
11 Foundation, in version 2 as it comes in the "COPYING" file of the
12 VirtualBox OSE distribution. VirtualBox OSE is distributed in the
13 hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
14 -->
15<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
16 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"[
17<!ENTITY % all.entities SYSTEM "all-entities.ent">
18%all.entities;
19]>
20<refentry id="vboxmanage-usbdevsource" lang="en">
21 <refentryinfo>
22 <pubdate>September 2019</pubdate>
23 <title>VBoxManage usbdevsource</title>
24 </refentryinfo>
25
26 <refmeta>
27 <refentrytitle>VBoxManage-usbdevsource</refentrytitle>
28 <manvolnum>1</manvolnum>
29 </refmeta>
30
31 <refnamediv>
32 <refname>vboxmanage-usbdevsource</refname>
33 <refpurpose>add and remove USB device sources</refpurpose>
34 <refclass>Oracle VM VirtualBox</refclass>
35 </refnamediv>
36
37 <refsynopsisdiv>
38 <cmdsynopsis id="synopsis-vboxmanage-usbdevsource-add">
39 <command>VBoxManage usbdevsource add</command>
40 <arg choice="req"><replaceable>source-name</replaceable></arg>
41 <arg choice="req">--backend=<replaceable>backend</replaceable></arg>
42 <arg choice="req">--address=<replaceable>address</replaceable></arg>
43 </cmdsynopsis>
44
45 <cmdsynopsis id="synopsis-vboxmanage-usbdevsource-remove">
46 <command>VBoxManage usbdevsource remove</command>
47 <arg choice="req"><replaceable>source-name</replaceable></arg>
48 </cmdsynopsis>
49 </refsynopsisdiv>
50
51 <refsect1>
52 <title>Description</title>
53 <para>
54 The <command>VBoxManage usbdevsource</command> command adds a USB
55 device source and makes it available to the guests on the host
56 system. You can also use this command to remove the USB device
57 source.
58 </para>
59 <refsect2 id="vboxmanage-usbdevsource-add">
60 <title>Add a USB Device Source</title>
61 <remark role="help-copy-synopsis"/>
62 <para>
63 The <command>VBoxManage usbdevsource add</command> command adds
64 a USB device source, which is available to all guests on the
65 host system.
66 </para>
67 <variablelist>
68 <varlistentry>
69 <term><replaceable>source-name</replaceable></term>
70 <listitem><para>
71 Specifies a unique name for the USB device source.
72 </para></listitem>
73 </varlistentry>
74 <varlistentry>
75 <term>--address=<replaceable>address</replaceable></term>
76 <listitem><para>
77 Specifies the address of the USB backend.
78 </para></listitem>
79 </varlistentry>
80 <varlistentry>
81 <term>--backend=<replaceable>backend</replaceable></term>
82 <listitem><para>
83 Specifies the USB proxy service backend to use.
84 </para><remark>
85 What is the USB proxy service? How do you
86 determine the backend to use?
87 </remark></listitem>
88 </varlistentry>
89 </variablelist>
90 </refsect2>
91 <refsect2 id="vboxmanage-usbdevsource-remove">
92 <title>Remove a USB Device</title>
93 <remark role="help-copy-synopsis"/>
94 <para>
95 The <command>VBoxManage usbdevsource remove</command> command
96 removes a USB device.
97 </para>
98 <variablelist>
99 <varlistentry>
100 <term><replaceable>source-name</replaceable></term>
101 <listitem><para>
102 Specifies the name of the USB device source to remove.
103 </para></listitem>
104 </varlistentry>
105 </variablelist>
106 </refsect2>
107 </refsect1>
108
109 <refsect1>
110 <title>Examples</title>
111 <remark role="help-scope" condition="GLOBAL" />
112 <para>
113 The following command adds a USB device server called
114 <filename>hostusb01</filename>.
115 </para>
116<screen>$ VBoxManage usbdevsource add hostusb01 --backend USBIP --address 10.0.1.16</screen>
117 </refsect1>
118</refentry>
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette