Adding upstream version 7.0.14-dfsg.upstream/7.0.14-dfsg

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

1 files changed, 230 insertions, 0 deletions

diff --git a/doc/manual/en_US/man_VBoxManage-setproperty.xml b/doc/manual/en_US/man_VBoxManage-setproperty.xml
new file mode 100644
index 00000000..731edf2a
--- /dev/null
+++ b/doc/manual/en_US/man_VBoxManage-setproperty.xml
@@ -0,0 +1,230 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+    manpage, user manual, usage: VBoxManage setproperty
+-->
+<!--
+    Copyright (C) 2006-2023 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-setproperty" lang="en">
+  <refentryinfo>
+    <pubdate>$Date: 2023-01-17 15:15:46 +0100 (Tue, 17 Jan 2023) $</pubdate>
+    <title>VBoxManage setproperty</title>
+  </refentryinfo>
+
+  <refmeta>
+    <refentrytitle>VBoxManage-setproperty</refentrytitle>
+    <manvolnum>1</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>VBoxManage-setproperty</refname>
+    <refpurpose>change global settings</refpurpose>
+    <refclass>&product-name;</refclass>
+  </refnamediv>
+
+  <refsynopsisdiv>
+<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
+    <cmdsynopsis id="synopsis-vboxmanage-setproperty">
+      <command>VBoxManage setproperty</command>
+      <arg choice="req"><replaceable>property-name</replaceable></arg>
+      <arg choice="req"><replaceable>property-value</replaceable></arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>Description</title>
+    <para>
+      The <command>VBoxManage setproperty</command> command enables you
+      to change global settings that affect the entire &product-name;
+      installation. Some of these settings correspond to the settings in
+      the <emphasis role="bold">Preferences</emphasis> dialog in the
+      VirtualBox Manager.
+    </para>
+    <para>
+      The following properties are available:
+    </para>
+    <variablelist>
+      <varlistentry>
+        <term><literal>autostartdbpath</literal></term>
+        <listitem><para>
+            Specifies the path to the autostart database. Valid values
+            are <literal>null</literal>, which disables the autostart
+            database, or the name of the folder that contains the
+            database. See <xref linkend="autostart" />.
+          </para></listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><literal>defaultfrontend</literal></term>
+        <listitem><para>
+            Specifies the global default VM frontend. Valid values are
+            <literal>default</literal>, which specifies the default
+            frontend, or the name of the frontend to use.
+          </para></listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><literal>hwvirtexclusive</literal></term>
+        <listitem><para>
+            Specifies whether &product-name; makes exclusive use of the
+            Intel VT-x or AMD-V hardware virtualization extensions of
+            the host system's processor. See <xref linkend="hwvirt" />.
+          </para><para>
+            Valid values are as follows:
+          </para><itemizedlist>
+            <listitem><para>
+                <literal>on</literal> enables &product-name; to make
+                exclusive use of these extensions. This is the default
+                value.
+              </para></listitem>
+            <listitem><para>
+                <literal>off</literal> shares these extensions with
+                other hypervisors that run simultaneously. Note that
+                disabling this setting has negative performance
+                implications.
+              </para></listitem>
+          </itemizedlist></listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><literal>language</literal></term>
+        <listitem><para>
+            Specifies the user language used to translate API messages.
+            Valid values are <literal>C</literal>, which means no
+            translation or language code in form either <literal>ll</literal>
+            or <literal>ll_CC</literal>, where <literal>ll</literal> is
+            language 2 letters code in lower case and
+            <literal>CC</literal> is country 2 letter code in upper case.
+          </para></listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><literal>logginglevel</literal></term>
+        <listitem><para>
+            Specifies the VBoxSVC release logging details. See
+            <ulink url="http://www.virtualbox.org/wiki/VBoxLogging" />.
+          </para></listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><literal>loghistorycount</literal></term>
+        <listitem><para>
+            Specifies the number of rotated VM logs to retain.
+          </para></listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><literal>machinefolder</literal></term>
+        <listitem><para>
+            Specifies the default folder in which virtual machine (VM)
+            definitions are stored. Valid values are
+            <literal>default</literal>, which specifies the default
+            storage folder, or the name of the folder to use. See
+            <xref linkend="vboxconfigdata" />.
+          </para></listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><literal>proxymode</literal></term>
+        <listitem><para>
+            Configures the mode for an HTTP proxy server. Valid values
+            are as follows:
+          </para><variablelist>
+            <varlistentry>
+              <term><literal>manual</literal></term>
+              <listitem><para>
+                  Configure the URL of a HTTP proxy server manually,
+                  using the <literal>proxyurl</literal> property value.
+                </para></listitem>
+            </varlistentry>
+            <varlistentry>
+              <term><literal>noproxy</literal></term>
+              <listitem><para>
+                  Do not use an HTTP proxy server. A direct connection
+                  to the Internet is used.
+                </para></listitem>
+            </varlistentry>
+            <varlistentry>
+              <term><literal>system</literal></term>
+              <listitem><para>
+                  Detect the proxy settings automatically for the host
+                  network. This is the default value.
+                </para></listitem>
+            </varlistentry>
+          </variablelist></listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><literal>proxyurl</literal></term>
+        <listitem><para>
+            Specifies the URL for an HTTP proxy server when you specify
+            a manual proxy by setting the <literal>proxymode</literal>
+            property to <literal>manual</literal>.
+          </para></listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><literal>vrdeauthlibrary</literal></term>
+        <listitem><para>
+            Specifies which library to use when external authentication
+            has been configured for a particular VM. Valid values are
+            <literal>default</literal>, which specifies the default
+            library, or the name of the library to use. See
+            <xref linkend="vbox-auth" />.
+          </para></listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><literal>vrdeextpack</literal></term>
+        <listitem><para>
+            Specifies the library that implements the VirtualBox Remote
+            Desktop Extension (RDE). Valid values are
+            <literal>null</literal>, which disables the RDE, or the name
+            of the library to use.
+          </para></listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><literal>websrvauthlibrary</literal></term>
+        <listitem><para>
+            Specifies which library the web service uses to authenticate
+            users. Valid values are <literal>default</literal>, which
+            specifies the default library, <literal>null</literal>,
+            which disables authentication, or the name of the library to
+            use. For information about the &product-name; web service,
+            see <xref linkend="VirtualBoxAPI" />.
+          </para></listitem>
+      </varlistentry>
+    </variablelist>
+  </refsect1>
+
+  <refsect1>
+    <title>Examples</title>
+    <remark role="help-scope" condition="GLOBAL" />
+    <para>
+      The following command configures &product-name; to use the
+      specified HTTP proxy server.
+    </para>
+<screen>$ VBoxManage setproperty proxymode manual
+$ VBoxManage setproperty proxyurl "http://myproxy.com:8080"</screen>
+  </refsect1>
+
+  <refsect1>
+    <title>See Also</title>
+    <para>
+      <xref linkend="vboxmanage-startvm" />
+    </para>
+  </refsect1>
+</refentry>