Adding upstream version 7.0.6-dfsg.upstream/7.0.6-dfsgupstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 132 insertions, 0 deletions

diff --git a/doc/manual/en_US/man_VBoxManage-unregistervm.xml b/doc/manual/en_US/man_VBoxManage-unregistervm.xml
new file mode 100644
index 00000000..4923c8f0
--- /dev/null
+++ b/doc/manual/en_US/man_VBoxManage-unregistervm.xml
@@ -0,0 +1,132 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+    manpage, user manual, usage: VBoxManage unregistervm
+-->
+<!--
+    Copyright (C) 2006-2022 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-unregistervm" lang="en">
+  <refentryinfo>
+    <pubdate>$Date: 2023-01-10 07:35:56 +0100 (Tue, 10 Jan 2023) $</pubdate>
+    <title>VBoxManage unregistervm</title>
+  </refentryinfo>
+
+  <refmeta>
+    <refentrytitle>VBoxManage-unregistervm</refentrytitle>
+    <manvolnum>1</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>VBoxManage-unregistervm</refname>
+    <refpurpose>unregister a virtual machine</refpurpose>
+    <refclass>&product-name;</refclass>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <cmdsynopsis id="synopsis-vboxmanage-unregistervm">
+<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
+      <command>VBoxManage unregistervm</command>
+      <group choice="req">
+        <arg choice="plain"><replaceable>uuid</replaceable></arg>
+        <arg choice="plain"><replaceable>vmname</replaceable></arg>
+      </group>
+      <arg>--delete</arg>
+      <arg>--delete-all</arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>Description</title>
+    <para>
+      The <command>VBoxManage unregistervm</command> command unregisters
+      a virtual machine (VM).
+    </para>
+    <variablelist>
+      <varlistentry>
+        <term><replaceable>uuid</replaceable>|<replaceable>vmname</replaceable></term>
+        <listitem><para>
+            Specifies the name or Universally Unique Identifier (UUID)
+            of the VM.
+          </para></listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><option>--delete</option></term>
+        <listitem><para>
+            Deletes the following files related to the VM automatically:
+          </para><itemizedlist>
+            <listitem><para>
+                All hard disk image files, including differencing files.
+              </para></listitem>
+            <listitem><para>
+                All saved state files that the machine created,
+                including one for each snapshot.
+              </para></listitem>
+            <listitem><para>
+                XML VM machine definition file and its backups.
+              </para></listitem>
+            <listitem><para>
+                VM log files.
+              </para></listitem>
+            <listitem><para>
+                The empty directory associated with the unregistered VM.
+              </para></listitem>
+          </itemizedlist></listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><option>--delete-all</option></term>
+        <listitem><para>
+            Deletes the files described in the <option>--delete</option> option,
+            as well as all DVDs and Floppy disks located in the VM folder and
+            attached only to this VM.
+          </para></listitem>
+      </varlistentry>
+    </variablelist>
+  </refsect1>
+
+  <refsect1>
+    <title>Examples</title>
+    <remark role="help-scope" condition="GLOBAL" />
+    <para>
+      The following command unregisters a VM called
+      <literal>vm2</literal>.
+    </para>
+<screen>$ VBoxManage unregistervm vm2</screen>
+    <para>
+      The following command unregisters a VM called
+      <literal>vm3</literal>. All files associated with the VM are
+      deleted.
+    </para>
+<screen>$ VBoxManage unregistervm vm3 --delete
+%...10%...20%...30%...40%...50%...60%...70%...80%...90%...100%</screen>
+  </refsect1>
+
+  <refsect1>
+    <title>See Also</title>
+    <para>
+      <xref linkend="vboxmanage-registervm" />
+    </para>
+  </refsect1>
+</refentry>