VirtualBox

source: vbox/trunk/doc/manual/en_US/man_VBoxManage-extpack.xml@ 79060

Last change on this file since 79060 was 73276, checked in by vboxsync, 6 years ago

doc/manual: Big build system overhaul, because the use of entities and catalogs eliminates the need to have placeholders in XML which previously needed separate preprocessing. Many cleanups, including replacing almost all pattern rules (since their dependencies had to be too generous) and using defines instead. Also integrated many cleanups for the user manual text (which needs careful review, couldn't check yet if it uses any additional tags which some of our XSLT would ignore).

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 4.8 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3 manpage, user manual, usage: VBoxManage extpack
4
5 Copyright (C) 2006-2015 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" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
16<refentry id="vboxmanage-extpack" lang="en">
17
18 <refentryinfo>
19 <pubdate>$Date: 2018-07-20 17:42:10 +0000 (Fri, 20 Jul 2018) $</pubdate>
20 <title>VBoxManage extpack</title>
21 </refentryinfo>
22
23 <refmeta>
24 <refentrytitle>VBoxManage-extpack</refentrytitle>
25 <manvolnum>1</manvolnum>
26 </refmeta>
27
28 <refnamediv>
29 <refname>VBoxManage-extpack</refname>
30 <refpurpose>extension package management</refpurpose>
31 <refclass>Oracle VM VirtualBox</refclass>
32 </refnamediv>
33
34 <refsynopsisdiv>
35 <cmdsynopsis id="synopsis-vboxmanage-extpack-install"> <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
36 <command>VBoxManage extpack install</command>
37 <arg>--replace</arg>
38 <arg choice="req"><replaceable>tarball</replaceable></arg>
39 </cmdsynopsis>
40 <cmdsynopsis id="synopsis-vboxmanage-extpack-uninstall">
41 <command>VBoxManage extpack uninstall</command>
42 <arg>--force</arg>
43 <arg choice="req"><replaceable>name</replaceable></arg>
44 </cmdsynopsis>
45 <cmdsynopsis id="synopsis-vboxmanage-extpack-cleanup">
46 <command>VBoxManage extpack cleanup</command>
47 </cmdsynopsis>
48 </refsynopsisdiv>
49
50 <refsect1>
51 <title>Description</title>
52
53 <refsect2 id="vboxmanage-extpack-install">
54 <title>extpack install</title>
55 <remark role="help-copy-synopsis"/>
56 <para>
57 Installs a new extension pack on the system. This command will fail if an older
58 version of the same extension pack is already installed. The
59 <option>--replace</option> option can be used to uninstall any
60 old package before the new one is installed.
61 </para>
62 <variablelist>
63 <varlistentry>
64 <term><option>--replace</option></term><listitem><para>Uninstall existing extension pack version.</para></listitem>
65 </varlistentry>
66 <varlistentry>
67 <term><replaceable>tarball</replaceable></term>
68 <listitem>
69 <para>The file containing the extension pack to be installed.</para>
70 </listitem>
71 </varlistentry>
72 </variablelist>
73 </refsect2>
74
75 <refsect2 id="vboxmanage-extpack-uninstall">
76 <title>extpack uninstall</title>
77 <remark role="help-copy-synopsis"/>
78 <para>
79 Uninstalls an extension pack from the system. The subcommand will also succeed
80 in the case where the specified extension pack is not present on the system.
81 You can use <computeroutput>VBoxManage list extpacks</computeroutput> to show
82 the names of the extension packs which are currently installed.
83 </para>
84 <variablelist>
85 <varlistentry>
86 <term><option>--force</option></term>
87 <listitem>
88 <para>Overrides most refusals to uninstall an extension pack</para>
89 </listitem>
90 </varlistentry>
91 <varlistentry>
92 <term><replaceable>name</replaceable></term>
93 <listitem>
94 <para>The name of the extension pack to be uninstalled.</para>
95 </listitem>
96 </varlistentry>
97 </variablelist>
98 </refsect2>
99
100 <refsect2 id="vboxmanage-extpack-cleanup">
101 <title>extpack cleanup</title>
102 <remark role="help-copy-synopsis"/>
103 <para>
104 Used to remove temporary files and directories that may have been left behind
105 if a previous install or uninstall command failed.
106 </para>
107 </refsect2>
108
109 </refsect1>
110
111 <refsect1>
112 <title>Examples</title>
113 <remark role="help-scope" condition="EXTPACK_UNINSTALL,EXTPACK"/>
114 <para>
115 How to list extension packs:
116<screen>$ VBoxManage list extpacks
117Extension Packs: 1
118Pack no. 0: Oracle VM VirtualBox Extension Pack
119Version: 4.1.12
120Revision: 77218
121Edition:
122Description: USB 2.0 Host Controller, VirtualBox RDP, PXE ROM with E1000 support.
123VRDE Module: VBoxVRDP
124Usable: true
125Why unusable:</screen></para>
126
127 <para>How to remove an extension pack:
128<screen>$ VBoxManage extpack uninstall "Oracle VM VirtualBox Extension Pack"
1290%...10%...20%...30%...40%...50%...60%...70%...80%...90%...100%
130Successfully uninstalled "Oracle VM VirtualBox Extension Pack".</screen></para>
131 </refsect1>
132
133</refentry>
134
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