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