VirtualBox

source: vbox/trunk/doc/manual/en_US/man_VBoxManage-discardstate.xml@ 103131

Last change on this file since 103131 was 99513, checked in by vboxsync, 20 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: 3.4 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3 manpage, user manual, usage: VBoxManage discardstate
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-discardstate" lang="en">
32 <refentryinfo>
33 <pubdate>$Date: 2023-04-21 21:59:02 +0000 (Fri, 21 Apr 2023) $</pubdate>
34 <title>VBoxManage discardstate</title>
35 </refentryinfo>
36
37 <refmeta>
38 <refentrytitle>VBoxManage-discardstate</refentrytitle>
39 <manvolnum>1</manvolnum>
40 </refmeta>
41
42 <refnamediv>
43 <refname>VBoxManage-discardstate</refname>
44 <refpurpose>discard the saved state of a virtual machine</refpurpose>
45 <refclass>&product-name;</refclass>
46 </refnamediv>
47
48 <refsynopsisdiv>
49 <cmdsynopsis id="synopsis-vboxmanage-discardstate">
50<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
51 <command>VBoxManage discardstate</command>
52 <group choice="req">
53 <arg choice="plain"><replaceable>uuid</replaceable></arg>
54 <arg choice="plain"><replaceable>vmname</replaceable></arg>
55 </group>
56 </cmdsynopsis>
57 </refsynopsisdiv>
58
59 <refsect1 id="vboxmanage-discardstate-description">
60 <title>Description</title>
61 <para>
62 The <command>VBoxManage discardstate</command> command discards
63 the saved state of a virtual machine (VM) that is not currently
64 running. This command causes the VM's operating system to restart
65 the next time you start the VM.
66 </para>
67 <note>
68 <para>
69 Where possible, avoid performing this action. The effects of
70 this command are equivalent to unplugging the power cable on a
71 physical machine.
72 </para>
73 </note>
74 <variablelist>
75 <varlistentry>
76 <term><option><replaceable>uuid</replaceable> | <replaceable>vmname</replaceable></option></term>
77 <listitem><para>
78 Specifies the Universally Unique Identifier (UUID) or name
79 of the VM.
80 </para></listitem>
81 </varlistentry>
82 </variablelist>
83 </refsect1>
84
85 <refsect1 id="vboxmanage-discardstate-examples">
86 <title>Examples</title>
87 <remark role="help-scope" condition="GLOBAL" />
88 <para>
89 The following command discards the saved state file for the VM
90 called <filename>vm2</filename>. When you next start the VM, the
91 VM's operating system is restarted.
92 </para>
93<screen>$ VBoxManage discardstate vm2</screen>
94 </refsect1>
95
96 <refsect1 id="vboxmanage-discardstate-see-also">
97 <title>See Also</title>
98 <para>
99 <xref linkend="vboxmanage-adoptstate"/>
100 </para>
101 </refsect1>
102</refentry>
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