VirtualBox

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

Last change on this file since 103068 was 99513, checked in by vboxsync, 19 months ago

manual,VBoxManage,isomaker/viso: Require all refsect1 and refsect2 elements to have @id attributes in manpages (refentry) to make these predictable and the split up topic files easier to handle for the docs team. Also requires these @id values to start with the refentry @id + '-'. Corrected a few bogus ones. Because 'controlvm' has too many sub-commands, HELP_SCOPE_ IDs will not be generated for 'See Also' and 'Examples' sections. bugref:10302

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 5.8 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3 manpage, user manual, usage: VBoxManage extpack
4-->
5<!--
6 Copyright (C) 2006-2023 Oracle and/or its affiliates.
7
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
25-->
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]>
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>
38 <refentrytitle>VBoxManage-extpack</refentrytitle>
39 <manvolnum>1</manvolnum>
40 </refmeta>
41
42 <refnamediv>
43 <refname>VBoxManage-extpack</refname>
44 <refpurpose>extension package management</refpurpose>
45 <refclass>&product-name;</refclass>
46 </refnamediv>
47
48 <refsynopsisdiv>
49 <cmdsynopsis id="synopsis-vboxmanage-extpack-install"> <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
50 <command>VBoxManage extpack install</command>
51 <arg>--replace</arg>
52 <arg>--accept-license=<replaceable>sha256</replaceable></arg>
53 <arg choice="req"><replaceable>tarball</replaceable></arg>
54 </cmdsynopsis>
55 <cmdsynopsis id="synopsis-vboxmanage-extpack-uninstall">
56 <command>VBoxManage extpack uninstall</command>
57 <arg>--force</arg>
58 <arg choice="req"><replaceable>name</replaceable></arg>
59 </cmdsynopsis>
60 <cmdsynopsis id="synopsis-vboxmanage-extpack-cleanup">
61 <command>VBoxManage extpack cleanup</command>
62 </cmdsynopsis>
63 </refsynopsisdiv>
64
65 <refsect1 id="vboxmanage-extpack-description">
66 <title>Description</title>
67
68 <refsect2 id="vboxmanage-extpack-install">
69 <title>extpack install</title>
70 <remark role="help-copy-synopsis"/>
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>
79 <term><option>--replace</option></term><listitem><para>Uninstall existing extension pack version.</para></listitem>
80 </varlistentry>
81 <varlistentry>
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>
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">
100 <title>extpack uninstall</title>
101 <remark role="help-copy-synopsis"/>
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">
125 <title>extpack cleanup</title>
126 <remark role="help-copy-synopsis"/>
127 <para>
128 Used to remove temporary files and directories that may have been left behind
129 if a previous install or uninstall command failed.
130 </para>
131 </refsect2>
132
133 </refsect1>
134
135 <refsect1 id="vboxmanage-extpack-examples">
136 <title>Examples</title>
137 <remark role="help-scope" condition="EXTPACK_UNINSTALL,EXTPACK"/>
138 <para>
139 How to list extension packs:
140<screen>$ VBoxManage list extpacks
141Extension Packs: 1
142Pack no. 0: Oracle VM VirtualBox Extension Pack
143Version: 4.1.12
144Revision: 77218
145Edition:
146Description: USB 2.0 Host Controller, VirtualBox RDP, PXE ROM with E1000 support.
147VRDE Module: VBoxVRDP
148Usable: true
149Why unusable:</screen></para>
150
151 <para>How to remove an extension pack:
152<screen>$ VBoxManage extpack uninstall "Oracle VM VirtualBox Extension Pack"
1530%...10%...20%...30%...40%...50%...60%...70%...80%...90%...100%
154Successfully uninstalled "Oracle VM VirtualBox Extension Pack".</screen></para>
155 </refsect1>
156
157</refentry>
158
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