VirtualBox

Changeset 94206 in vbox


Ignore:
Timestamp:
Mar 13, 2022 7:17:33 PM (3 years ago)
Author:
vboxsync
Message:

doc/manual,FE/VBoxManage: Convert setproperty commands to refentry documentation, ​bugref:9186

Location:
trunk
Files:
7 edited

Legend:

Unmodified
Added
Removed

  • trunk/doc/manual/Config.kmk

    r94204 r94206  
    7575        man_VBoxManage-convertfromraw.xml \
    7676        man_VBoxManage-setextradata.xml \
    77         man_VBoxManage-getextradata.xml
     77        man_VBoxManage-getextradata.xml \
     78        man_VBoxManage-setproperty.xml
    7879
    7980## List of user manual XML files.

  • trunk/doc/manual/en_US/man_VBoxManage-setproperty.xml

    r92432 r94206  
    2020<refentry id="vboxmanage-setproperty" lang="en">
    2121  <refentryinfo>
    22     <pubdate>August 2019</pubdate>
     22    <pubdate>$Date$</pubdate>
    2323    <title>VBoxManage setproperty</title>
    2424  </refentryinfo>
    … …  
    3232    <refname>VBoxManage-setproperty</refname>
    3333    <refpurpose>change global settings</refpurpose>
    34     <refclass>Oracle VM VirtualBox</refclass>
     34    <refclass>&product-name;</refclass>
    3535  </refnamediv>
    3636

  • trunk/doc/manual/en_US/user_VBoxManage.xml

    r94204 r94206  
    11051105  <xi:include href="user_man_VBoxManage-getextradata.xml"   xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
    11061106
    1107   <sect1 id="vboxmanage-setproperty">
    1108 
    1109     <title>VBoxManage setproperty</title>
    1110 
    1111     <para>
    1112       This command is used to change global settings which affect the
    1113       entire &product-name; installation. Some of these correspond to
    1114       the settings in the <emphasis role="bold">Preferences</emphasis>
    1115       dialog in the VirtualBox Manager. The following properties are
    1116       available:
    1117     </para>
    1118 
    1119     <variablelist>
    1120 
    1121       <varlistentry>
    1122         <term>
    1123           <computeroutput>machinefolder</computeroutput>
    1124         </term>
    1125 
    1126         <listitem>
    1127           <para>
    1128             Specifies the default folder in which virtual machine
    1129             definitions are kept. See <xref linkend="vboxconfigdata" />.
    1130           </para>
    1131         </listitem>
    1132       </varlistentry>
    1133 
    1134       <varlistentry>
    1135         <term>
    1136           <computeroutput>hwvirtexclusive</computeroutput>
    1137         </term>
    1138 
    1139         <listitem>
    1140           <para>
    1141             Specifies whether &product-name; will make exclusive use of
    1142             the hardware virtualization extensions (Intel VT-x or AMD-V)
    1143             of the host system's processor. See
    1144             <xref linkend="hwvirt" />. If you wish to share these
    1145             extensions with other hypervisors running at the same time,
    1146             you must disable this setting. Doing so has negative
    1147             performance implications.
    1148           </para>
    1149         </listitem>
    1150       </varlistentry>
    1151 
    1152       <varlistentry>
    1153         <term>
    1154           <computeroutput>vrdeauthlibrary</computeroutput>
    1155         </term>
    1156 
    1157         <listitem>
    1158           <para>
    1159             Specifies which library to use when external authentication
    1160             has been selected for a particular virtual machine. See
    1161             <xref linkend="vbox-auth" />.
    1162           </para>
    1163         </listitem>
    1164       </varlistentry>
    1165 
    1166       <varlistentry>
    1167         <term>
    1168           <computeroutput>websrvauthlibrary</computeroutput>
    1169         </term>
    1170 
    1171         <listitem>
    1172           <para>
    1173             Specifies which library the web service uses to authenticate
    1174             users. For details about the &product-name; web service, see
    1175             the &product-name; SDK reference,
    1176             <xref
    1177             linkend="VirtualBoxAPI" />.
    1178           </para>
    1179         </listitem>
    1180       </varlistentry>
    1181 
    1182       <varlistentry>
    1183         <term>
    1184           <computeroutput>vrdeextpack</computeroutput>
    1185         </term>
    1186 
    1187         <listitem>
    1188           <para>
    1189             Specifies which library implements the VirtualBox Remote
    1190             Desktop Extension.
    1191           </para>
    1192         </listitem>
    1193       </varlistentry>
    1194 
    1195       <varlistentry>
    1196         <term>
    1197           <computeroutput>loghistorycount</computeroutput>
    1198         </term>
    1199 
    1200         <listitem>
    1201           <para>
    1202             Selects how many rotated VM logs are retained.
    1203           </para>
    1204         </listitem>
    1205       </varlistentry>
    1206 
    1207       <varlistentry>
    1208         <term>
    1209           <computeroutput>autostartdbpath</computeroutput>
    1210         </term>
    1211 
    1212         <listitem>
    1213           <para>
    1214             Selects the path to the autostart database. See
    1215             <xref linkend="autostart" />.
    1216           </para>
    1217         </listitem>
    1218       </varlistentry>
    1219 
    1220       <varlistentry>
    1221         <term>
    1222           <computeroutput>defaultfrontend</computeroutput>
    1223         </term>
    1224 
    1225         <listitem>
    1226           <para>
    1227             Selects the global default VM frontend setting. See
    1228             <xref linkend="vboxmanage-startvm" />.
    1229           </para>
    1230         </listitem>
    1231       </varlistentry>
    1232 
    1233       <varlistentry>
    1234         <term>
    1235           <computeroutput>logginglevel</computeroutput>
    1236         </term>
    1237 
    1238         <listitem>
    1239           <para>
    1240             Configures the VBoxSVC release logging details. See
    1241             <ulink url="http://www.virtualbox.org/wiki/VBoxLogging" />.
    1242           </para>
    1243         </listitem>
    1244       </varlistentry>
    1245 
    1246       <varlistentry>
    1247         <term>
    1248           <computeroutput>proxymode</computeroutput>
    1249         </term>
    1250 
    1251         <listitem>
    1252           <para>
    1253             Configures the mode for an HTTP proxy server.
    1254           </para>
    1255         </listitem>
    1256       </varlistentry>
    1257 
    1258       <varlistentry>
    1259         <term>
    1260           <computeroutput>proxyurl</computeroutput>
    1261         </term>
    1262 
    1263         <listitem>
    1264           <para>
    1265             Configures the URL for an HTTP proxy server. Used when a
    1266             manual proxy is configured using the
    1267             <computeroutput>manual</computeroutput> setting of the
    1268             <computeroutput>proxymode</computeroutput> property.
    1269           </para>
    1270         </listitem>
    1271       </varlistentry>
    1272 
    1273       <varlistentry>
    1274         <term>
    1275           <computeroutput>language</computeroutput>
    1276         </term>
    1277 
    1278         <listitem>
    1279           <para>
    1280             Specifies the user language used to translate API messages.
    1281             Valid values are <literal>C</literal>, which means no
    1282             translation or language code in form either <literal>ll</literal>
    1283             or <literal>ll_CC</literal>, where <literal>ll</literal> is
    1284             language 2 letters code in lower case and
    1285             <literal>CC</literal> is country 2 letter code in upper case.
    1286           </para>
    1287         </listitem>
    1288       </varlistentry>
    1289 
    1290     </variablelist>
    1291 
    1292   </sect1>
     1107  <xi:include href="user_man_VBoxManage-setproperty.xml"    xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
    12931108
    12941109  <sect1 id="vboxmanage-usbfilter">

  • trunk/src/VBox/Frontends/VBoxManage/VBoxManage.cpp

    r94204 r94206  
    228228    { "getextradata",       USAGE_S_NEWCMD, HELP_CMD_GETEXTRADATA, handleGetExtraData,         0 },
    229229    { "setextradata",       USAGE_S_NEWCMD, HELP_CMD_SETEXTRADATA, handleSetExtraData,         0 },
    230     { "setproperty",        USAGE_SETPROPERTY,      VBMG_CMD_TODO, handleSetProperty,          0 },
     230    { "setproperty",        USAGE_S_NEWCMD,  HELP_CMD_SETPROPERTY, handleSetProperty,          0 },
    231231    { "usbfilter",          USAGE_USBFILTER,        VBMG_CMD_TODO, handleUSBFilter,            0 },
    232232    { "sharedfolder",       USAGE_S_NEWCMD, HELP_CMD_SHAREDFOLDER, handleSharedFolder,         0 },

  • trunk/src/VBox/Frontends/VBoxManage/VBoxManage.h

    r94204 r94206  
    101101    USAGE_CREATEHOSTIF,
    102102    USAGE_REMOVEHOSTIF,
    103     USAGE_SETPROPERTY,
    104103    USAGE_USBFILTER,
    105104    USAGE_I_LOADSYMS,

  • trunk/src/VBox/Frontends/VBoxManage/VBoxManageHelp.cpp

    r94204 r94206  
    639639                     "\n", SEP);
    640640
    641     if (enmCommand == USAGE_SETPROPERTY || enmCommand == USAGE_S_ALL)
    642     {
    643         RTStrmPrintf(pStrm,
    644                            "%s setproperty %s     machinefolder default|<folder> |\n"
    645                      "                            hwvirtexclusive on|off |\n"
    646                      "                            vrdeauthlibrary default|<library> |\n"
    647                      "                            websrvauthlibrary default|null|<library> |\n"
    648                      "                            vrdeextpack null|<library> |\n"
    649                      "                            autostartdbpath null|<folder> |\n"
    650                      "                            loghistorycount <value>\n"
    651                      "                            defaultfrontend default|<name>\n"
    652                      "                            logginglevel <log setting>\n"
    653                      "                            proxymode system|noproxy|manual\n"
    654                      "                            proxyurl <url>\n", SEP);
    655 #ifdef VBOX_WITH_MAIN_NLS
    656         RTStrmPrintf(pStrm,
    657                      "                            language <language id>\n");
    658 #endif
    659         RTStrmPrintf(pStrm,
    660                      "\n");
    661     }
    662641    if (enmCommand == USAGE_USBFILTER || enmCommand == USAGE_S_ALL)
    663642    {

  • trunk/src/VBox/Frontends/VBoxManage/VBoxManageMisc.cpp

    r94204 r94206  
    950950    /* there must be two arguments: property name and value */
    951951    if (a->argc != 2)
    952         return errorSyntax(USAGE_SETPROPERTY, Misc::tr("Incorrect number of parameters"));
     952        return errorSyntax(Misc::tr("Incorrect number of parameters"));
    953953
    954954    ComPtr<ISystemProperties> systemProperties;
    … …  
    10751075#endif
    10761076    else
    1077         return errorSyntax(USAGE_SETPROPERTY, Misc::tr("Invalid parameter '%s'"), a->argv[0]);
     1077        return errorSyntax(Misc::tr("Invalid parameter '%s'"), a->argv[0]);
    10781078
    10791079    return SUCCEEDED(rc) ? RTEXITCODE_SUCCESS : RTEXITCODE_FAILURE;
Note: See TracChangeset for help on using the changeset viewer.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette