VirtualBox

source: vbox/trunk/doc/manual/en_US/man_VBoxManage-setproperty.xml@ 93707

Last change on this file since 93707 was 92432, checked in by vboxsync, 3 years ago

Main" bugref:1909: Removed translation marks form printUsage and its callees. Added missed help for "VBoxManage setproperty language"

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 8.6 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3 manpage, user manual, usage: VBoxManage setproperty
4
5 Copyright (C) 2006-2020 Oracle Corporation
6
7 This file is part of VirtualBox Open Source Edition (OSE), as
8 available from http://www.virtualbox.org. This file is free software;
9 you can redistribute it and/or modify it under the terms of the GNU
10 General Public License (GPL) as published by the Free Software
11 Foundation, in version 2 as it comes in the "COPYING" file of the
12 VirtualBox OSE distribution. VirtualBox OSE is distributed in the
13 hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
14 -->
15<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
16 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"[
17<!ENTITY % all.entities SYSTEM "all-entities.ent">
18%all.entities;
19]>
20<refentry id="vboxmanage-setproperty" lang="en">
21 <refentryinfo>
22 <pubdate>August 2019</pubdate>
23 <title>VBoxManage setproperty</title>
24 </refentryinfo>
25
26 <refmeta>
27 <refentrytitle>VBoxManage-setproperty</refentrytitle>
28 <manvolnum>1</manvolnum>
29 </refmeta>
30
31 <refnamediv>
32 <refname>VBoxManage-setproperty</refname>
33 <refpurpose>change global settings</refpurpose>
34 <refclass>Oracle VM VirtualBox</refclass>
35 </refnamediv>
36
37 <refsynopsisdiv>
38<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
39 <cmdsynopsis id="synopsis-vboxmanage-setproperty">
40 <command>VBoxManage setproperty</command>
41 <arg choice="req"><replaceable>property-name</replaceable></arg>
42 <arg choice="req"><replaceable>property-value</replaceable></arg>
43 </cmdsynopsis>
44 </refsynopsisdiv>
45
46 <refsect1>
47 <title>Description</title>
48 <para>
49 The <command>VBoxManage setproperty</command> command enables you
50 to change global settings that affect the entire &product-name;
51 installation. Some of these settings correspond to the settings in
52 the <emphasis role="bold">Preferences</emphasis> dialog in the
53 VirtualBox Manager.
54 </para>
55 <para>
56 The following properties are available:
57 </para>
58 <variablelist>
59 <varlistentry>
60 <term><literal>autostartdbpath</literal></term>
61 <listitem><para>
62 Specifies the path to the autostart database. Valid values
63 are <literal>null</literal>, which disables the autostart
64 database, or the name of the folder that contains the
65 database. See <xref linkend="autostart" />.
66 </para></listitem>
67 </varlistentry>
68 <varlistentry>
69 <term><literal>defaultfrontend</literal></term>
70 <listitem><para>
71 Specifies the global default VM frontend. Valid values are
72 <literal>default</literal>, which specifies the default
73 frontend, or the name of the frontend to use.
74 </para></listitem>
75 </varlistentry>
76 <varlistentry>
77 <term><literal>hwvirtexclusive</literal></term>
78 <listitem><para>
79 Specifies whether &product-name; makes exclusive use of the
80 Intel VT-x or AMD-V hardware virtualization extensions of
81 the host system's processor. See <xref linkend="hwvirt" />.
82 </para><para>
83 Valid values are as follows:
84 </para><itemizedlist>
85 <listitem><para>
86 <literal>on</literal> enables &product-name; to make
87 exclusive use of these extensions. This is the default
88 value.
89 </para></listitem>
90 <listitem><para>
91 <literal>off</literal> shares these extensions with
92 other hypervisors that run simultaneously. Note that
93 disabling this setting has negative performance
94 implications.
95 </para></listitem>
96 </itemizedlist></listitem>
97 </varlistentry>
98 <varlistentry>
99 <term><literal>language</literal></term>
100 <listitem><para>
101 Specifies the user language used to translate API messages.
102 Valid values are <literal>C</literal>, which means no
103 translation or language code in form either <literal>ll</literal>
104 or <literal>ll_CC</literal>, where <literal>ll</literal> is
105 language 2 letters code in lower case and
106 <literal>CC</literal> is country 2 letter code in upper case.
107 </para></listitem>
108 </varlistentry>
109 <varlistentry>
110 <term><literal>logginglevel</literal></term>
111 <listitem><para>
112 Specifies the VBoxSVC release logging details. See
113 <ulink url="http://www.virtualbox.org/wiki/VBoxLogging" />.
114 </para></listitem>
115 </varlistentry>
116 <varlistentry>
117 <term><literal>loghistorycount</literal></term>
118 <listitem><para>
119 Specifies the number of rotated VM logs to retain.
120 </para></listitem>
121 </varlistentry>
122 <varlistentry>
123 <term><literal>machinefolder</literal></term>
124 <listitem><para>
125 Specifies the default folder in which virtual machine (VM)
126 definitions are stored. Valid values are
127 <literal>default</literal>, which specifies the default
128 storage folder, or the name of the folder to use. See
129 <xref linkend="vboxconfigdata" />.
130 </para></listitem>
131 </varlistentry>
132 <varlistentry>
133 <term><literal>proxymode</literal></term>
134 <listitem><para>
135 Configures the mode for an HTTP proxy server. Valid values
136 are as follows:
137 </para><variablelist>
138 <varlistentry>
139 <term><literal>manual</literal></term>
140 <listitem><para>
141 Configure the URL of a HTTP proxy server manually,
142 using the <literal>proxyurl</literal> property value.
143 </para></listitem>
144 </varlistentry>
145 <varlistentry>
146 <term><literal>noproxy</literal></term>
147 <listitem><para>
148 Do not use an HTTP proxy server. A direct connection
149 to the Internet is used.
150 </para></listitem>
151 </varlistentry>
152 <varlistentry>
153 <term><literal>system</literal></term>
154 <listitem><para>
155 Detect the proxy settings automatically for the host
156 network. This is the default value.
157 </para></listitem>
158 </varlistentry>
159 </variablelist></listitem>
160 </varlistentry>
161 <varlistentry>
162 <term><literal>proxyurl</literal></term>
163 <listitem><para>
164 Specifies the URL for an HTTP proxy server when you specify
165 a manual proxy by setting the <literal>proxymode</literal>
166 property to <literal>manual</literal>.
167 </para></listitem>
168 </varlistentry>
169 <varlistentry>
170 <term><literal>vrdeauthlibrary</literal></term>
171 <listitem><para>
172 Specifies which library to use when external authentication
173 has been configured for a particular VM. Valid values are
174 <literal>default</literal>, which specifies the default
175 library, or the name of the library to use. See
176 <xref linkend="vbox-auth" />.
177 </para></listitem>
178 </varlistentry>
179 <varlistentry>
180 <term><literal>vrdeextpack</literal></term>
181 <listitem><para>
182 Specifies the library that implements the VirtualBox Remote
183 Desktop Extension (RDE). Valid values are
184 <literal>null</literal>, which disables the RDE, or the name
185 of the library to use.
186 </para></listitem>
187 </varlistentry>
188 <varlistentry>
189 <term><literal>websrvauthlibrary</literal></term>
190 <listitem><para>
191 Specifies which library the web service uses to authenticate
192 users. Valid values are <literal>default</literal>, which
193 specifies the default library, <literal>null</literal>,
194 which disables authentication, or the name of the library to
195 use. For information about the &product-name; web service,
196 see <xref linkend="VirtualBoxAPI" />.
197 </para></listitem>
198 </varlistentry>
199 </variablelist>
200 </refsect1>
201
202 <refsect1>
203 <title>Examples</title>
204 <remark role="help-scope" condition="GLOBAL" />
205 <para>
206 The following command configures &product-name; to use the
207 specified HTTP proxy server.
208 </para>
209<screen>$ VBoxManage setproperty proxymode manual
210$ VBoxManage setproperty proxyurl "http://myproxy.com:8080"</screen>
211 </refsect1>
212
213 <refsect1>
214 <title>See Also</title>
215 <para>
216 <xref linkend="vboxmanage-startvm" />
217 </para>
218 </refsect1>
219</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