VirtualBox

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

Last change on this file since 103068 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: 4.2 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3 manpage, user manual, usage: VBoxManage setextradata
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-setextradata" lang="en">
32 <refentryinfo>
33 <pubdate>$Date: 2023-04-21 21:59:02 +0000 (Fri, 21 Apr 2023) $</pubdate>
34 <title>VBoxManage setextradata</title>
35 </refentryinfo>
36
37 <refmeta>
38 <refentrytitle>VBoxManage-setextradata</refentrytitle>
39 <manvolnum>1</manvolnum>
40 </refmeta>
41
42 <refnamediv>
43 <refname>VBoxManage-setextradata</refname>
44 <refpurpose>set a keyword value that is associated with a virtual machine or
45 configuration</refpurpose>
46 <refclass>&product-name;</refclass>
47 </refnamediv>
48
49 <refsynopsisdiv>
50 <cmdsynopsis id="synopsis-vboxmanage-setextradata">
51<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
52 <command>VBoxManage setextradata</command>
53 <group choice="req">
54 <arg choice="plain">global</arg>
55 <arg choice="plain"><replaceable>uuid</replaceable></arg>
56 <arg choice="plain"><replaceable>vmname</replaceable></arg>
57 </group>
58 <arg choice="req"><replaceable>keyword</replaceable></arg>
59 <arg><replaceable>value</replaceable></arg>
60 </cmdsynopsis>
61 </refsynopsisdiv>
62
63 <refsect1 id="vboxmanage-setextradata-description">
64 <title>Description</title>
65 <para>
66 The <command>VBoxManage setextradata</command> command enables you
67 to set a keyword value that is associated with a virtual machine
68 (VM) or with an &product-name; configuration.
69 </para>
70 <variablelist>
71 <varlistentry>
72 <term><literal>global</literal></term>
73 <listitem><para>
74 Sets information about the configuration rather than a VM.
75 </para></listitem>
76 </varlistentry>
77 <varlistentry>
78 <term><option><replaceable>uuid</replaceable> | <replaceable>vmname</replaceable></option></term>
79 <listitem><para>
80 Specifies the Universally Unique Identifier (UUID) or name
81 of the VM.
82 </para></listitem>
83 </varlistentry>
84 <varlistentry>
85 <term><replaceable>keyword</replaceable></term>
86 <listitem><para>
87 Specifies the keyword for which to set its value.
88 </para></listitem>
89 </varlistentry>
90 <varlistentry>
91 <term><replaceable>value</replaceable></term>
92 <listitem><para>
93 Specifies the keyword value. Specifying no value removes the
94 keyword.
95 </para></listitem>
96 </varlistentry>
97 </variablelist>
98 </refsect1>
99
100 <refsect1 id="vboxmanage-setextradata-examples">
101 <title>Examples</title>
102 <remark role="help-scope" condition="GLOBAL"/>
103 <para>
104 The following command sets the <literal>installdate</literal>
105 keyword value for the <literal>Fedora5</literal> VM to
106 <literal>2019.01.01</literal>:
107 </para>
108<screen>$ VBoxManage setextradata Fedora5 installdate 2019.01.01</screen>
109 <para>
110 The following command unsets the value of the
111 <literal>installdate</literal> keyword for the
112 <literal>Fedora5</literal> VM:
113 </para>
114<screen>$ VBoxManage setextradata Fedora5 installdate</screen>
115 </refsect1>
116
117 <refsect1 id="vboxmanage-setextradata-see-also">
118 <title>See Also</title>
119 <para>
120 <xref linkend="vboxmanage-getextradata" />
121 </para>
122 </refsect1>
123</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