diff options
Diffstat (limited to '')
-rw-r--r-- | doc/manual/en_US/man_VBoxManage-setextradata.xml | 112 |
1 files changed, 112 insertions, 0 deletions
diff --git a/doc/manual/en_US/man_VBoxManage-setextradata.xml b/doc/manual/en_US/man_VBoxManage-setextradata.xml new file mode 100644 index 00000000..4cf52ff3 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-setextradata.xml @@ -0,0 +1,112 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + manpage, user manual, usage: VBoxManage setextradata + + Copyright (C) 2006-2020 Oracle Corporation + + This file is part of VirtualBox Open Source Edition (OSE), as + available from http://www.virtualbox.org. This file is free software; + you can redistribute it and/or modify it under the terms of the GNU + General Public License (GPL) as published by the Free Software + Foundation, in version 2 as it comes in the "COPYING" file of the + VirtualBox OSE distribution. VirtualBox OSE is distributed in the + hope that it will be useful, but WITHOUT ANY WARRANTY of any kind. + --> +<!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-setextradata" lang="en"> + <refentryinfo> + <pubdate>August 2019</pubdate> + <title>VBoxManage setextradata</title> + </refentryinfo> + + <refmeta> + <refentrytitle>VBoxManage-setextradata</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>VBoxManage-setextradata</refname> + <refpurpose>set a keyword value that is associated with a virtual machine or + configuration</refpurpose> + <refclass>Oracle VM VirtualBox</refclass> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis id="synopsis-vboxmanage-setextradata"> +<!-- The 'id' is mandatory and must start with 'synopsis-'. --> + <command>VBoxManage setextradata</command> + <group choice="req"> + <arg choice="plain">global</arg> + <arg choice="plain"><replaceable>uuid</replaceable></arg> + <arg choice="plain"><replaceable>vmname</replaceable></arg> + </group> + <arg choice="req"><replaceable>keyword</replaceable></arg> + <arg><replaceable>value</replaceable></arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + <para> + The <command>VBoxManage setextradata</command> command enables you + to set a keyword value that is associated with a virtual machine + (VM) or with an &product-name; configuration. + </para> + <variablelist> + <varlistentry> + <term><literal>global</literal></term> + <listitem><para> + Sets information about the configuration rather than a VM. + </para></listitem> + </varlistentry> + <varlistentry> + <term><replaceable>uuid</replaceable>|<replaceable>vmname</replaceable></term> + <listitem><para> + Specifies the Universally Unique Identifier (UUID) or name + of the VM. + </para></listitem> + </varlistentry> + <varlistentry> + <term><replaceable>keyword</replaceable></term> + <listitem><para> + Specifies the keyword for which to set its value. + </para></listitem> + </varlistentry> + <varlistentry> + <term><replaceable>value</replaceable></term> + <listitem><para> + Specifies the keyword value. Specifying no value removes the + keyword. + </para></listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Examples</title> + <remark role="help-scope" condition="GLOBAL"/> + <para> + The following command sets the <literal>installdate</literal> + keyword value for the <literal>Fedora5</literal> VM to + <literal>2019.01.01</literal>: + </para> +<screen>$ VBoxManage setextradata Fedora5 installdate 2019.01.01</screen> + <para> + The following command unsets the value of the + <literal>installdate</literal> keyword for the + <literal>Fedora5</literal> VM: + </para> +<screen>$ VBoxManage setextradata Fedora5 installdate</screen> + </refsect1> + + <refsect1> + <title>See Also</title> + <para> + <xref linkend="vboxmanage-getextradata" /> + </para> + </refsect1> +</refentry> |