1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
manpage, user manual, usage: VBoxManage extpack
-->
<!--
Copyright (C) 2006-2024 Oracle and/or its affiliates.
This file is part of VirtualBox base platform packages, as
available from https://www.virtualbox.org.
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation, in version 3 of the
License.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, see <https://www.gnu.org/licenses>.
SPDX-License-Identifier: GPL-3.0-only
-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"[
<!ENTITY % all.entities SYSTEM "all-entities.ent">
%all.entities;
]>
<refentry id="vboxmanage-extpack" lang="en">
<refentryinfo>
<pubdate>$Date: 2024-09-16 16:03:52 +0200 (Mon, 16 Sep 2024) $</pubdate>
<title>VBoxManage extpack</title>
</refentryinfo>
<refmeta>
<refentrytitle>VBoxManage-extpack</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>VBoxManage-extpack</refname>
<refpurpose>extension package management</refpurpose>
<refclass>&product-name;</refclass>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis id="synopsis-vboxmanage-extpack-install"> <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
<command>VBoxManage extpack install</command>
<arg>--replace</arg>
<arg>--accept-license=<replaceable>sha256</replaceable></arg>
<arg choice="req"><replaceable>tarball</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis id="synopsis-vboxmanage-extpack-uninstall">
<command>VBoxManage extpack uninstall</command>
<arg>--force</arg>
<arg choice="req"><replaceable>name</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis id="synopsis-vboxmanage-extpack-cleanup">
<command>VBoxManage extpack cleanup</command>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="vboxmanage-extpack-description">
<title>Description</title>
<refsect2 id="vboxmanage-extpack-install">
<title>extpack install</title>
<remark role="help-copy-synopsis"/>
<para>
Installs a new extension pack on the system. This command will fail if an older
version of the same extension pack type is already installed and the
<option>--replace</option> isn't supplied. The <option>--replace</option> option
uninstalls any previously installed extension packs of the same type being installed
before the new extension pack is installed.
</para>
<variablelist>
<varlistentry>
<term><option>--replace</option></term><listitem><para>Uninstall existing extension
pack before installing the specified extension pack.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--accept-license=<replaceable>sha256</replaceable></option></term>
<listitem>
<para>Accept the license text with the given SHA-256 hash value.</para>
<para>VBoxManage will display the SHA-256 value when performing a manual
installation. The hash can be calculated manually by extracting the license
file from the extension pack using tar(1) and running sha256sum or similar to
generate the hash value.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>tarball</replaceable></term>
<listitem>
<para>The file containing the extension pack to be installed.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="vboxmanage-extpack-uninstall">
<title>extpack uninstall</title>
<remark role="help-copy-synopsis"/>
<para>
Uninstalls an extension pack from the system. The subcommand will also succeed
in the case where the specified extension pack is not present on the system.
You can use <computeroutput>VBoxManage list extpacks</computeroutput> to list
the names of the extension packs which are currently installed.
</para>
<variablelist>
<varlistentry>
<term><option>--force</option></term>
<listitem>
<para>Overrides most refusals to uninstall an extension pack</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>name</replaceable></term>
<listitem>
<para>The name of the extension pack to be uninstalled.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="vboxmanage-extpack-cleanup">
<title>extpack cleanup</title>
<remark role="help-copy-synopsis"/>
<para>
Used to remove temporary files and directories that may have been left behind
if a previous install or uninstall command failed.
</para>
</refsect2>
</refsect1>
<refsect1 id="vboxmanage-extpack-examples">
<title>Examples</title>
<remark role="help-scope" condition="EXTPACK_UNINSTALL,EXTPACK"/>
<para>
How to list extension packs:
<screen>$ VBoxManage list extpacks
Extension Packs: 1
Pack no. 0: &extpack-name;
Version: 4.1.12
Revision: 77218
Edition:
Description: USB 2.0 Host Controller, VirtualBox RDP, PXE ROM with E1000 support.
VRDE Module: VBoxVRDP
Usable: true
Why unusable:</screen></para>
<para>How to remove an extension pack:
<screen>$ VBoxManage extpack uninstall "&extpack-name;"
0%...10%...20%...30%...40%...50%...60%...70%...80%...90%...100%
Successfully uninstalled "&extpack-name;".</screen></para>
</refsect1>
</refentry>
|
