VirtualBox

Changeset 63707 in vbox


Ignore:
Timestamp:
Sep 2, 2016 8:47:07 PM (9 years ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
110479
Message:

bugref:6417 Further checkin general tidy up.

File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r63680 r63707  
    562562
    563563          <listitem>
    564             <para><computeroutput>--pciattach &lt;host PCI address [@ guest PCI bus address]&gt;</computeroutput>:
    565             Attaches a specified PCI network controller on the host to a PCI bus (can specify) on the guest.
     564            <para><computeroutput>--pciattach &lt;host PCI address [@ guest
     565            PCI bus address]&gt;</computeroutput>: Attaches a specified PCI network
     566            controller on the host to a PCI bus (can specify) on the guest.
    566567            See <xref linkend="pcipassthrough" /> for details. </para>
    567568          </listitem>
    … …  
    569570          <listitem>
    570571            <para><computeroutput>--pcidetach &lt;host PCI address&gt;</computeroutput>:
    571             Detaches a specified PCI network controller on the host from the attached PCI bus on the guest.
    572             See <xref linkend="pcipassthrough" /> for details. </para>
     572            Detaches a specified PCI network controller on the host from the attached
     573            PCI bus on the guest. See <xref linkend="pcipassthrough" />
     574            for details. </para>
    573575          </listitem>
    574576
    … …  
    617619          <listitem>
    618620            <para><computeroutput>--pae on|off</computeroutput>: This
    619             enables/disables PAE (see <xref
    620             linkend="settings-processor" />).</para>
     621            enables/disables PAE. See <xref linkend="settings-processor" />.</para>
    621622          </listitem>
    622623
    623624          <listitem>
    624625            <para><computeroutput>--longmode on|off</computeroutput>: This
    625             enables/disables long mode (see <xref
    626             linkend="settings-processor" />).</para>
     626            enables/disables long mode. See <xref linkend="settings-processor" />.</para>
    627627          </listitem>
    628628
    629629          <listitem>
    630630            <para><computeroutput>--cpu-profile &lt;host|intel 80[86|286|386]&gt;</computeroutput>:
    631             Indicate the use of a profile for guest cpu emulation. Specify either one based 
    632             on the host system CPU (host), or one from a number of older Intel
    633             Micro-architectures - 8086, 80286, 80386.</para>
     631            This enables specification of a profile for guest cpu emulation.
     632            Specify either one based on the host system CPU (host), or one from
     633            a number of older Intel Micro-architectures - 8086, 80286, 80386.</para>
    634634          </listitem>
    635635
    … …  
    644644            <para><computeroutput>--hwvirtex on|off</computeroutput>: This
    645645            enables or disables the use of hardware virtualization extensions
    646             (Intel VT-x or AMD-V) in the processor of your host system; see
    647             <xref linkend="hwvirt" />.</para>
     646            (Intel VT-x or AMD-V) in the processor of your host system;
     647            see <xref linkend="hwvirt" />.</para>
    648648          </listitem>
    649649
    650650          <listitem>
    651651            <para><computeroutput>--triplefaultreset on|off</computeroutput>:
    652             This setting allows to reset the guest instead of triggering a
     652            This setting enables resetting of the guest instead of triggering a
    653653            Guru Meditation. Some guests raise a triple fault to reset the
    654654            CPU so sometimes this is desired behavior. Works only for non-SMP
    … …  
    736736
    737737          <listitem>
    738             <para><computeroutput>--accelerate3d on|off</computeroutput>: This
    739             enables, if the Guest Additions are installed, whether hardware 3D
    740             acceleration should be available; see <xref
     738            <para><computeroutput>--accelerate3d on|off</computeroutput>:
     739            If the Guest Additions are installed, this setting enables or
     740            disables hardware 3D acceleration; see <xref
    741741            linkend="guestadd-3d" />.</para>
    742742          </listitem>
    … …  
    744744          <listitem>
    745745            <para><computeroutput>--accelerate2dvideo on|off</computeroutput>:
    746             This enables, if the Guest Additions are installed, whether 2D video
    747             acceleration should be available; see <xref
     746            If the Guest Additions are installed, this setting enables or
     747            disables 2D video acceleration; see <xref
    748748            linkend="guestadd-2d" />.</para>
    749749          </listitem>
    … …  
    752752            <para><computeroutput>--chipset piix3|ich9</computeroutput>:
    753753            By default VirtualBox emulates an Intel PIIX3 chipset. Usually there
    754             is no reason to change the default setting unless it is required to
     754            is no reason to change the default setting unless this is required to
    755755            relax some of its constraints; see <xref
    756756            linkend="settings-motherboard" />.</para>
    … …  
    759759          <listitem>
    760760            <para>You can influence the BIOS logo that is displayed when a
    761             virtual machine starts up with a number of settings. Per default,
     761            virtual machine starts up with a number of settings. By default,
    762762            a VirtualBox logo is displayed.</para>
    763763
    … …  
    795795
    796796            <para>Note that if x2apic is specified and x2apic is unsupported by the
    797             VCPU, biosapic downgrades to apic, if supported - otherwise to 'disabled'.
    798             Similarly, if apic is specified, and apic is unsupported results in a
    799             downgrade to 'disabled'.</para>
     797            VCPU, biosapic downgrades to apic, if supported - otherwise down to 'disabled'.
     798            Similarly, if apic is specified, and apic is unsupported a
     799            downgrade to 'disabled' results.</para>
    800800          </listitem>
    801801
    … …  
    824824          <listitem>
    825825            <para><computeroutput>--rtcuseutc on|off</computeroutput>: This
    826             option lets the real-time clock (RTC) operate in UTC time (see
     826            option lets the real-time clock (RTC) operate in UTC time. See
     827            <xref linkend="settings-motherboard" />.</para>
     828          </listitem>
     829
     830          <listitem>
     831            <para><computeroutput>--graphicscontroller none|vboxvga|vmsvga</computeroutput>: This
     832            option specifies use of a graphics controller, and type chosen from vboxvga or vmsvga.
    827833            <xref linkend="settings-motherboard" />).</para>
    828834          </listitem>
    829835
    830836          <listitem>
    831             <para><computeroutput>--graphicscontroller none|vboxvga|vmsvga</computeroutput>: This
    832             option specifies use of a graphics controller, and type chosen from vboxvga or vmsvga.
    833             <xref linkend="settings-motherboard" />).</para>
    834           </listitem>
    835 
    836           <listitem>
    837837            <para><computeroutput>--snapshotfolder
    838             default|&lt;path&gt;</computeroutput>: This allows you to specify
    839             the folder in which snapshots will be kept for a virtual
    840             machine.</para>
     838            default|&lt;path&gt;</computeroutput>: This option specifies the folder in which
     839            snapshots will be kept for a virtual machine.</para>
    841840          </listitem>
    842841
    843842          <listitem>
    844843            <para><computeroutput>--firmware bios|efi|efi32|efi64</computeroutput>:
    845             Specifies which firmware to be used to boot the VM:
    846             Available options are BIOS, or one of the EFI options: efi, efi32 or efi64.
     844            This option specifies which firmware to be used to boot the VM:
     845            Available options are: BIOS, or one of the EFI options: efi, efi32 or efi64.
    847846            Use EFI options with care.</para>
    848847          </listitem>
    … …  
    850849          <listitem>
    851850            <para><computeroutput>--guestmemoryballoon
    852             &lt;size&gt;</computeroutput> sets the default size of the guest
     851            &lt;size&gt;</computeroutput> This option sets the default size of the guest
    853852            memory balloon, that is, memory allocated by the VirtualBox Guest
    854853            Additions from the guest operating system and returned to the
    … …  
    861860          <listitem>
    862861            <para><computeroutput>--defaultfrontend
    863             default|&lt;name&gt;</computeroutput>: This allows you to specify
    864             the default frontend which will be used when starting this VM; see
    865             <xref linkend="vboxmanage-startvm" /> for details.</para>
     862            default|&lt;name&gt;</computeroutput>: This option specifies
     863            the default frontend to be used when starting this VM;
     864            see <xref linkend="vboxmanage-startvm" /> for details.</para>
    866865          </listitem>
    867866        </itemizedlist></para>
    … …  
    899898            <para><computeroutput>--nictype&lt;1-N&gt;
    900899            Am79C970A|Am79C973|82540EM|82543GC|82545EM|virtio</computeroutput>:
    901             This allows you, for each of the VM's virtual network cards, to
    902             specify which networking hardware VirtualBox presents to the
    903             guest; see <xref linkend="nichardware" />.</para>
     900            This enables you to specify which networking hardware VirtualBox presents
     901            to the guest for a specified VM virtual network card;
     902            see <xref linkend="nichardware" />.</para>
    904903          </listitem>
    905904
    906905          <listitem>
    907906            <para><computeroutput>--cableconnected&lt;1-N&gt;
    908             on|off</computeroutput>: This allows you to temporarily disconnect
     907            on|off</computeroutput>: This enables you to temporarily disconnect
    909908            a virtual network interface, as if a network cable had been pulled
    910             from a real network card. This might be useful for resetting
     909            from a real network card. This might be useful e.g. for resetting
    911910            certain software components in the VM.</para>
    912911          </listitem>
    … …  
    923922            <para>If enabled, you must specify with
    924923            <computeroutput>--nictracefile&lt;1-N&gt;
    925             &lt;filename&gt;</computeroutput> what file the trace should be
     924            &lt;filename&gt;</computeroutput> the absolute path of the file the trace should be
    926925            logged to.</para>
    927926          </listitem>
    … …  
    933932            pass parameters to rarely-used network backends.</para>
    934933
    935             <para>Those parameters are backend engine-specific, and are different
    936             between UDP Tunnel and the VDE backend drivers. For example,
     934            <para>These parameters are backend engine-specific, and are different
     935            between UDP Tunnel and the VDE backend drivers. For examples,
    937936            please see <xref linkend="network_udp_tunnel" />.
    938937            </para>
    … …  
    941940          <listitem>
    942941            <para><computeroutput>--nicspeed&lt;1-N&gt; &lt;kbps&gt;</computeroutput>:
    943             If generic networking has been enabled for a virtual network card (see the
    944             <computeroutput>--nic</computeroutput> option above; otherwise
    945             this setting has no effect), this mode enables access
    946             to rarely used networking sub-modes, such as VDE network or UDP Tunnel.
    947             This option specifies the throughput rate in KBytes/sec.
     942            If generic networking has been enabled for a particular virtual network
     943            card (see the <computeroutput>--nic</computeroutput> option above - otherwise
     944            this setting has no effect), this mode enables access to rarely used networking
     945            sub-modes, such as VDE network or UDP Tunnel. This option specifies the
     946            throughput rate in KBytes/sec.
    948947            </para>
    949948          </listitem>
    … …  
    964963            <para><computeroutput>--nicpromisc&lt;1-N&gt;
    965964            deny|allow-vms|allow-all</computeroutput>:
    966             This allows you, for each of the VM's virtual network cards, to
    967             specify how the promiscuous mode is handled. This setting is only
    968             relevant for bridged networking.
     965            This ernables you to specify how the promiscuous mode is handled for
     966            the specified VM virtual network card.
     967            This setting is only relevant for bridged networking.
    969968            <computeroutput>deny</computeroutput> (default setting) hides
    970969            any traffic not intended for this VM.
    … …  
    10251024            <computeroutput>natnetwork</computeroutput> (not
    10261025            <computeroutput>nat</computeroutput>) then this setting specifies
    1027             the name of the NAT network this adapter is connected to.</para>
     1026            the name of the NAT network this adapter is connected to. Optional.</para>
    10281027          </listitem>
    10291028
    … …  
    10341033            <computeroutput>--nic</computeroutput> option above; otherwise
    10351034            this setting has no effect), this mode allows you to access
    1036             rarely used networking sub-modes, such as VDE network or UDP Tunnel.
     1035            rarely used networking sub-modes, such as VDE network or UDP Tunnel. 
    10371036            </para>
    10381037          </listitem>
    … …  
    10691068              <para><computeroutput>--natpf&lt;1-N&gt;
    10701069              [&lt;name&gt;],tcp|udp,[&lt;hostip&gt;],&lt;hostport&gt;,[&lt;guestip&gt;],
    1071               &lt;guestport&gt;</computeroutput>: This option defines a NAT
    1072               port-forwarding rule (please see <xref linkend="natforward" />
    1073               for details).</para>
     1070              &lt;guestport&gt;</computeroutput>: This setting defines a NAT
     1071              port-forwarding rule. See <xref linkend="natforward" />
     1072              for details.</para>
    10741073            </listitem>
    10751074
    10761075            <listitem>
    10771076              <para><computeroutput>--natpf&lt;1-N&gt; delete
    1078               &lt;name&gt;</computeroutput>: This option deletes a NAT
    1079               port-forwarding rule (please see <xref linkend="natforward" />
    1080               for details).</para>
     1077              &lt;name&gt;</computeroutput>: This setting deletes a NAT
     1078              port-forwarding rule. See <xref linkend="natforward" />
     1079              for details.</para>
    10811080            </listitem>
    10821081
    10831082            <listitem>
    10841083              <para><computeroutput>--nattftpprefix&lt;1-N&gt;
    1085               &lt;prefix&gt;</computeroutput>: This option defines a prefix
     1084              &lt;prefix&gt;</computeroutput>: This setting defines a prefix
    10861085              for the built-in TFTP server, i.e. where the boot file is
    1087               located (please see <xref linkend="nat-tftp" /> and <xref
    1088               linkend="nat-adv-tftp" /> for details).</para>
     1086              located. See <xref linkend="nat-tftp" /> and <xref
     1087              linkend="nat-adv-tftp" /> for details.</para>
    10891088            </listitem>
    10901089
    10911090            <listitem>
    10921091              <para><computeroutput>--nattftpfile&lt;1-N&gt;
    1093               &lt;bootfile&gt;</computeroutput>: This option defines the TFT
    1094               boot file (please see <xref linkend="nat-adv-tftp" /> for
    1095               details).</para>
     1092              &lt;bootfile&gt;</computeroutput>: This setting defines the TFT
     1093              boot file. See <xref linkend="nat-adv-tftp" /> for
     1094              details.</para>
    10961095            </listitem>
    10971096
    10981097            <listitem>
    10991098              <para><computeroutput>--nattftpserver&lt;1-N&gt;
    1100               &lt;tftpserver&gt;</computeroutput>: This option defines the
    1101               TFTP server address to boot from (please see <xref
    1102               linkend="nat-adv-tftp" /> for details).</para>
     1099              &lt;tftpserver&gt;</computeroutput>: This setting defines the
     1100              TFTP server address to boot from. Please see <xref
     1101              linkend="nat-adv-tftp" /> for details.</para>
    11031102            </listitem>
    11041103
    … …  
    11071106              &lt;ip;&gt;</computeroutput>: VirtualBox's NAT engine normally routes
    11081107              TCP/IP packets through the default interface assigned by the host's
    1109               TCP/IP stack. Use this option to instruct the NAT engine to bind
    1110               to a specified IP address instead. (Please see <xref
    1111               linkend="nat-adv-settings" /> for details).</para>
     1108              TCP/IP stack. Use this setting to instruct the NAT engine to bind
     1109              to a specified IP address instead. Please see <xref
     1110              linkend="nat-adv-settings" /> for details.</para>
    11121111            </listitem>
    11131112
    11141113            <listitem>
    11151114              <para><computeroutput>--natdnspassdomain&lt;1-N&gt;
    1116               on|off</computeroutput>: This option specifies whether the
     1115              on|off</computeroutput>: This setting specifies whether the
    11171116              built-in DHCP server passes the domain name for network name
    11181117              resolution.</para>
    … …  
    11211120            <listitem>
    11221121              <para><computeroutput>--natdnsproxy&lt;1-N&gt;
    1123               on|off</computeroutput>: This option makes the NAT engine proxy
    1124               all guest DNS requests to the host's DNS servers (please see
    1125               <xref linkend="nat-adv-dns" /> for details).</para>
     1122              on|off</computeroutput>: This setting makes the NAT engine proxy
     1123              all guest DNS requests to the host's DNS servers. Please see
     1124              <xref linkend="nat-adv-dns" /> for details.</para>
    11261125            </listitem>
    11271126
    11281127            <listitem>
    11291128              <para><computeroutput>--natdnshostresolver&lt;1-N&gt;
    1130               on|off</computeroutput>: This option makes the NAT engine use
    1131               the host's resolver mechanisms to handle DNS requests (please
    1132               see <xref linkend="nat-adv-dns" /> for details).</para>
     1129              on|off</computeroutput>: This setting makes the NAT engine use
     1130              the host's resolver mechanisms to handle DNS requests. Please
     1131              see <xref linkend="nat-adv-dns" /> for detailsx).</para>
    11331132            </listitem>
    11341133
    … …  
    11361135              <para><computeroutput>--natsettings&lt;1-N&gt;
    11371136              [&lt;mtu&gt;],[&lt;socksnd&gt;],[&lt;sockrcv&gt;],[&lt;tcpsnd&gt;],
    1138               [&lt;tcprcv&gt;]</computeroutput>: This option controls several
    1139               NAT settings (please see <xref linkend="nat-adv-settings" /> for
    1140               details).</para>
     1137              [&lt;tcprcv&gt;]</computeroutput>: This setting controls several
     1138              NAT settings. Please see <xref linkend="nat-adv-settings" /> for
     1139              details.</para>
    11411140            </listitem>
    11421141
    … …  
    11441143              <para><computeroutput>--nataliasmode&lt;1-N&gt;
    11451144              default|[log],[proxyonly],[sameports]</computeroutput>: This
    1146               option defines behaviour of NAT engine core: log - enables
     1145              setting defines behaviour of NAT engine core: log - enables
    11471146              logging, proxyonly - switches of aliasing mode makes NAT
    11481147              transparent, sameports enforces NAT engine to send packets via
    11491148              the same port as they originated on, default - disable all
    1150               mentioned modes above . (please see <xref
    1151               linkend="nat-adv-alias" /> for details).</para>
     1149              mentioned modes above. Please see <xref
     1150              linkend="nat-adv-alias" /> for details.</para>
    11521151            </listitem>
    11531152          </itemizedlist></para>
    … …  
    11751174        <listitem>
    11761175          <para><computeroutput>--uart&lt;1-N&gt; off|&lt;I/O base&gt;
    1177           &lt;IRQ&gt;</computeroutput>: With this option you can configure
    1178           virtual serial ports for the VM; see <xref
     1176          &lt;IRQ&gt;</computeroutput>: With this setting you can configure
     1177          virtual serial ports for the VM. See <xref
    11791178          linkend="serialports" /> for an introduction.</para>
    11801179        </listitem>
    … …  
    11851184          connects a given virtual serial port (previously configured with
    11861185          the <computeroutput>--uartX</computeroutput> setting, see above)
    1187           to the host on which the virtual machine is running. As described
    1188           in detail in <xref linkend="serialports" />, for each such port,
    1189           you can specify <computeroutput>&lt;arg&gt;</computeroutput> as
    1190           one of the following options:<itemizedlist>
     1186          to the host on which the virtual machine is running. As
     1187          described in detail in <xref linkend="serialports" />, for each
     1188          such port, you can specify <computeroutput>&lt;arg&gt;</computeroutput>
     1189          as one of the following options:<itemizedlist>
    11911190            <listitem>
    11921191              <para><computeroutput>disconnected</computeroutput>: Even
    … …  
    12681267          &lt;I/O base&gt; &lt;IRQ&gt;</computeroutput>:
    12691268          Specifies the I/O address of the parallel port and the IRQ
    1270           number that the Parallel Port feature will be using. Use this <emphasis>after</emphasis>
    1271           <computeroutput>--lptmod</computeroutput>. I/O base address and IRQ are
    1272           the values that guest sees i.e. the values avalable under guest Device Manager.</para>
     1269          number that the Parallel Port feature will be using.  Optional. Use this
     1270          <emphasis>after</emphasis> <computeroutput>--lptmod</computeroutput>.
     1271          I/O base address and IRQ are the values that guest sees i.e. the values
     1272          avalable under guest Device Manager.</para>
    12731273        </listitem>
    12741274
    12751275        <listitem>
    12761276          <para><computeroutput>--audio none|null|oss|alsa|pulse</computeroutput>: With
    1277           this option, you can set whether the VM should have audio
     1277          this setting, you can specify whether the VM should have audio
    12781278          support, and if so - which type.</para>
    12791279        </listitem>
    … …  
    12811281        <listitem>
    12821282          <para><computeroutput>--audiocontroller ac97|hda|sb16</computeroutput>: With
    1283           this option, you can specify the audio controller to be used with this VM.
     1283          this setting, you can specify the audio controller to be used with this
     1284          VM.
    12841285          </para>
    12851286        </listitem>
    … …  
    12871288        <listitem>
    12881289          <para><computeroutput>--audiocodec stac9700|ad1980|stac9221|sb16</computeroutput>: With
    1289           this option, you can specify the audio codec to be used with this VM.
     1290          this setting, you can specify the audio codec to be used with this VM.
    12901291          </para>
    12911292        </listitem>
    … …  
    12951296          disabled|hosttoguest|guesttohost|bidirectional</computeroutput>:
    12961297          With this setting, you can select if and how the guest or host
    1297           operating system's clipboard should be shared with the host or guest;
    1298           see <xref linkend="generalsettings" />. This requires that the Guest
     1298          operating system's clipboard should be shared with the host or guest.
     1299          See <xref linkend="generalsettings" />. This requires that the Guest
    12991300          Additions be installed in the virtual machine.</para>
    13001301        </listitem>
    … …  
    13031304          <para><computeroutput>--draganddrop
    13041305          disabled|hosttoguest|guesttohost|bidirectional</computeroutput>:
    1305           With this setting, you can select the current drag and drop mode
    1306           being used between the host and the virtual machine;
    1307           see <xref linkend="guestadd-dnd" />. This requires that the Guest
     1306          With this setting, you can specify the current drag and drop mode
     1307          being used between the host and the virtual machine.
     1308          See <xref linkend="guestadd-dnd" />. This requires that the Guest
    13081309          Additions be installed in the virtual machine.</para>
    13091310        </listitem>
    … …  
    13121313          <para><computeroutput>--monitorcount
    13131314          &lt;count&gt;</computeroutput>: This enables multi-monitor
    1314           support; see <xref linkend="settings-display" />.</para>
    1315         </listitem>
    1316 
    1317         <listitem>
    1318           <para><computeroutput>--usb on|off</computeroutput>: This option
    1319           enables or disables the VM's virtual USB controller; see <xref
     1315          support. See <xref linkend="settings-display" />.</para>
     1316        </listitem>
     1317
     1318        <listitem>
     1319          <para><computeroutput>--usb on|off</computeroutput>: This setting
     1320          enables or disables the VM's virtual USB controller. See <xref
    13201321          linkend="settings-usb" /> for details.</para>
    13211322        </listitem>
    … …  
    13231324        <listitem>
    13241325          <para><computeroutput>--usbehci on|off</computeroutput>: This
    1325           option enables or disables the VM's virtual USB 2.0 controller;
    1326           see <xref linkend="settings-usb" /> for details.</para>
     1326          setting enables or disables the VM's virtual USB 2.0 controller.
     1327          See <xref linkend="settings-usb" /> for details.</para>
    13271328        </listitem>
    13281329
    13291330        <listitem>
    13301331          <para><computeroutput>--usbxhci on|off</computeroutput>: This
    1331           option enables or disables the VM's virtual USB 3.0 controller;
    1332           see <xref linkend="settings-usb" /> for details.</para>
     1332          setting enables or disables the VM's virtual USB 3.0 controller.
     1333          See <xref linkend="settings-usb" /> for details.</para>
    13331334        </listitem>
    13341335
    … …  
    13361337          <para><computeroutput>--usbrename
    13371338          &lt;oldname&gt; &lt;newname&gt;</computeroutput>: This
    1338           option enables renaming of the VM's virtual USB controller from &lt;oldname&gt;
     1339          setting enables renaming of the VM's virtual USB controller from &lt;oldname&gt;
    13391340          to &lt;newname&gt;.</para>
    13401341        </listitem>
    … …  
    15701571          <listitem>
    15711572            <para><computeroutput>--vrdeextpack default|&lt;name&gt;</computeroutput>:
    1572             Allows to specify the library to use for to access the VM
     1573            Enables specification of the library for accessing the VM
    15731574            remotely. The default is to use the RDP code which is part of the
    15741575            Oracle VM VirtualBox Extension Pack.</para>
    … …  
    15821583            ports or ranges of ports. Use a dash between two port numbers to
    15831584            specify a range. The VRDE server will bind to <emphasis
    1584             role="bold">one</emphasis> of available ports from the specified
     1585            role="bold">one</emphasis> of the available ports from the specified
    15851586            list. Only one machine can use a given port at a time. For
    15861587            example, the option <computeroutput> --vrdeport
    … …  
    15961597            interface.</para>
    15971598            <para>The setting can be used to specify whether the VRDP server
    1598             should accept either IPv4 or IPv6 or both connections:
     1599            should accept either IPv4, IPv6 or both connections:
    15991600            <itemizedlist>
    16001601              <listitem>
    … …  
    16151616          <listitem>
    16161617            <para><computeroutput>--vrdeauthtype
    1617             null|external|guest</computeroutput>: This allows you to choose
    1618             whether and how authorization will be performed; see <xref
    1619             linkend="vbox-auth" /> for details.</para>
     1618            null|external|guest</computeroutput>: This enables you to indicate
     1619            use of authorization, and specify how authorization will be performed;
     1620            see <xref linkend="vbox-auth" /> for details.</para>
    16201621          </listitem>
    16211622
    16221623          <listitem>
    16231624            <para><computeroutput>--vrdeauthlibrary
    1624             default|&lt;name&gt;</computeroutput>: This allos to set the
     1625            default|&lt;name&gt;</computeroutput>: This specifies the
    16251626            library used for RDP authentication, see <xref lang=""
    16261627            linkend="vbox-auth" /> for details.</para>
    … …  
    16291630          <listitem>
    16301631            <para><computeroutput>--vrdemulticon on|off</computeroutput>: This
    1631             enables multiple connections to the same VRDE server, if the
     1632            enables multiple connections to be made to the same VRDE server, if the
    16321633            server supports this feature; see <xref lang=""
    16331634            linkend="vrde-multiconnection" />.</para>
    … …  
    16521653          <listitem>
    16531654            <para><computeroutput>--vrdevideochannelquality
    1654             &lt;percent&gt;</computeroutput>: Sets the image quality for video
     1655            &lt;percent&gt;</computeroutput>: Specifies the image quality for video
    16551656            redirection; see <xref lang=""
    16561657            linkend="vrde-videochannel" />.</para>
    … …  
    16671668      introduction.<itemizedlist>
    16681669          <listitem>
    1669             <para><computeroutput>--teleporter on|off</computeroutput>: With
    1670             this setting you turn on or off whether a machine waits for a
    1671             teleporting request to come in on the network when it is started.
    1672             If "on", when the machine is started, it does not boot the virtual
    1673             machine as it would normally; instead, it then waits for a
    1674             teleporting request to come in on the port and address listed with
    1675             the next two parameters.</para>
     1670            <para><computeroutput>--teleporter on|off</computeroutput>:
     1671            This setting enables/disables the teleporter feature whereby when the
     1672            machine is started, it waits to receieve a teleporting request from the
     1673            network instead of booting normally; teleporting requests are received on the
     1674            port and address specified using the following two parameters.</para>
    16761675          </listitem>
    16771676
    … …  
    16791678            <para><computeroutput>--teleporterport
    16801679            &lt;port&gt;</computeroutput>, <computeroutput>--teleporteraddress
    1681             &lt;address&gt;</computeroutput>: these must be used with
    1682             --teleporter and tell the virtual machine on which port and
    1683             address it should listen for a teleporting request from another
    1684             virtual machine. <computeroutput>&lt;port&gt;</computeroutput> can
     1680            &lt;address&gt;</computeroutput>: these settings must be used with
     1681            --teleporter and they specify the port and address the virtual machine should
     1682            listen to to receive a teleporting request sent from another virtual machine.
     1683            <computeroutput>&lt;port&gt;</computeroutput> can
    16851684            be any free TCP/IP port number (e.g. 6000);
    16861685            <computeroutput>&lt;address&gt;</computeroutput> can be any IP
    … …  
    16911690          <listitem>
    16921691            <para><computeroutput>--teleporterpassword
    1693             &lt;password&gt;</computeroutput>: if this optional argument is
     1692            &lt;password&gt;</computeroutput>: if this optional setting is
    16941693            given, then the teleporting request will only succeed if the
    16951694            source machine specifies the same password as the one given with
    … …  
    16991698          <listitem>
    17001699            <para><computeroutput>--teleporterpasswordfile
    1701             &lt;password&gt;</computeroutput>: if this optional argument is
     1700            &lt;password&gt;</computeroutput>: if this optional setting is
    17021701            given, then the teleporting request will only succeed if the
    17031702            source machine specifies the same password as the one specified
    … …  
    17091708            <para><computeroutput>--cpuid &lt;leaf&gt; &lt;eax&gt; &lt;ebx&gt;
    17101709            &lt;ecx&gt; &lt;edx&gt;</computeroutput>: Advanced users can use
    1711             this command before a teleporting operation to restrict the
     1710            this setting before a teleporting operation to restrict the
    17121711            virtual CPU capabilities that VirtualBox presents to the guest
    17131712            operating system. This must be run on both the source and the
    … …  
    17351734          <listitem>
    17361735            <para><computeroutput>--tracing-config &lt;config-string&gt;</computeroutput>:
    1737             Allows to configure tracing. In particular this defines which group of
     1736            Enables tracing configuration. In particular, this defines which group of
    17381737            tracepoints are enabled.</para>
    17391738          </listitem>
    … …  
    18121811           Allows additional fine tuning of the clone operation. The first
    18131812           option defines that a linked clone should be created, which is
    1814            only possible for a machine clone from a snapshot. The next two
    1815            options allow to define how the MAC addresses of every virtual
    1816            network card should be handled. They can either be reinitialized
     1813           only possible for a machine cloned from a snapshot. The next two
     1814           options enable specification of the handling of MAC addresses of
     1815           every virtual network card. They can either be reinitialized
    18171816           (the default), left unchanged
    18181817           (<computeroutput>keepallmacs</computeroutput>) or left unchanged
    … …  
    21582157      <listitem>
    21592158        <para><computeroutput>nic&lt;1-N&gt;
    2160         null|nat|bridged|intnet|hostonly|generic|natnetwork[&lt;devicename&gt;]</computeroutput>: With this, you can
    2161         set, for each of the VM's virtual network cards, what type of
    2162         networking should be available. They can be not connected to the host
     2159        null|nat|bridged|intnet|hostonly|generic|natnetwork[&lt;devicename&gt;]</computeroutput>:
     2160        specifies the type of networking that should be made available on the specified VM
     2161        virtual network card.
     2162        They can be: not connected to the host
    21632163        (<computeroutput>null</computeroutput>), use network address
    21642164        translation (<computeroutput>nat</computeroutput>), bridged networking
    … …  
    21752175
    21762176      <listitem>
    2177         <para>With the "nictrace" options, you can optionally trace
    2178         network traffic by dumping it to a file, for debugging
    2179         purposes.</para>
     2177        <para>With the "nictrace" options, you can optionally trace network traffic by dumping
     2178        it to a file, for debugging purposes.</para>
    21802179
    21812180        <para>With <computeroutput>nictrace&lt;1-N&gt;
    2182         on|off</computeroutput>, you can enable network tracing for a
    2183         particular virtual network card.</para>
     2181        on|off</computeroutput>, you can enable network tracing for a particular virtual
     2182        network card.</para>
    21842183
    21852184        <para>If enabled, you must specify with
    21862185        <computeroutput>--nictracefile&lt;1-N&gt;
    2187         &lt;filename&gt;</computeroutput> what file the trace should be
    2188         logged to.</para>
     2186        &lt;filename&gt;</computeroutput> the pathname of the file to which the trace should be
     2187        logged.</para>
    21892188      </listitem>
    21902189
    … …  
    21922191        <para><computeroutput>nicpromisc&lt;1-N&gt;
    21932192        deny|allow-vms|allow-all</computeroutput>:
    2194         This allows you, for each of the VM's virtual network cards, to
    2195         specify how the promiscious mode is handled. This setting is only
    2196         relevant for bridged networking.
     2193        This specifies how the promiscious mode is handled for the specified VM
     2194        virtual network card. This setting is only relevant for bridged networking.
    21972195        <computeroutput>deny</computeroutput> (default setting) hides
    21982196        any traffic not intended for this VM.
    … …  
    22072205        <para><computeroutput>nicproperty&lt;1-N&gt;
    22082206        &lt;paramname&gt;="paramvalue"</computeroutput>:
    2209         This option, in combination with "nicgenericdrv" allows you to
     2207        This option, in combination with "nicgenericdrv" enables you to
    22102208        pass parameters to rarely-used network backends.</para><para>
    22112209        Those parameters are backend engine-specific, and are different
    … …  
    22182216        <para><computeroutput>natpf&lt;1-N&gt;
    22192217        [&lt;name&gt;],tcp|udp,[&lt;hostip&gt;],&lt;hostport&gt;,[&lt;guestip&gt;],
    2220         &lt;guestport&gt;</computeroutput>: This option defines a NAT
     2218        &lt;guestport&gt;</computeroutput>: This option specifies a NAT
    22212219        port-forwarding rule (please see <xref linkend="natforward"/>
    22222220        for details).
    … …  
    22862284      <listitem>
    22872285        <para><computeroutput>vrdeproperty "TCP/Ports|Address=&lt;value&gt;"</computeroutput>
    2288         sets the port number(s) and IP address on the VM that the VRDE server can bind to.</para>
     2286        sets the port number(s) and IP address on the VM to which the VRDE server can bind.</para>
    22892287
    22902288        <itemizedlist>
    22912289          <listitem>
    2292             <para>For TCP/Ports, &lt;value&gt; should be a port or a range of ports that the VRDE
    2293             server can bind to; "default" or "0" means port 3389, the standard port for RDP.
     2290            <para>For TCP/Ports, &lt;value&gt; should be a port or a range of ports to which
     2291            the VRDE server can bind; "default" or "0" means port 3389, the standard port for RDP.
    22942292            For details, see the description for the
    22952293            <computeroutput>--vrdeport</computeroutput> option in <xref
    … …  
    23242322
    23252323          <listitem>
    2326             <para>For VideoChannel/DownscaleProtection, &lt;value&gt; can be set to "1" to
    2327             enable the videochannel downscale protection feature. When enabled, if a video's size equals the shadow buffer
    2328             size, then it is regarded as a full screen video, and is displayed; but if its size is between fullscreen and the downscale
    2329             threshold - it is NOT displayed, as it could be an application window, which would be unreadable when downscaled.
     2324            <para>For VideoChannel/DownscaleProtection, &lt;value&gt; can be set to "1" to enable the
     2325            videochannel downscale protection feature. When enabled, if a video's size equals the shadow
     2326            buffer size, then it is regarded as a full screen video, and is displayed; but if its size
     2327            is between fullscreen and the downscale threshold - it is NOT displayed, as it could be an
     2328            application window, which would be unreadable when downscaled.
    23302329            When the downscale protection feature is disabled, an attempt is always made to display videos.</para>
    23312330          </listitem>
    … …  
    24142413            <itemizedlist>
    24152414              <listitem>
    2416                 <para> <computeroutput>VRDP_AUDIO_MODE_VOID</computeroutput> - no mode specified, use to unset any Audio mode already set.</para>
     2415                <para> <computeroutput>VRDP_AUDIO_MODE_VOID</computeroutput> - no mode specified, use to
     2416                unset any Audio mode already set.</para>
    24172417              </listitem>
    24182418              <listitem>
    … …  
    24232423              </listitem>
    24242424              <listitem>
    2425                 <para> <computeroutput>VRDP_AUDIO_MODE_CS</computeroutput> - client sync mode to prevent under/overflow of the client queue.</para>
     2425                <para> <computeroutput>VRDP_AUDIO_MODE_CS</computeroutput> - client sync mode to prevent
     2426                under/overflow of the client queue.</para>
    24262427              </listitem>
    24272428            </itemizedlist></para>
    … …  
    25282529        can be used to configure a VM as a target for teleporting.
    25292530        &lt;name&gt; specifies the virtual machine name. &lt;port&gt; specifies the port on the
    2530         virtual machine which should listen for a teleporting request from another
    2531         virtual machine. It can be any free TCP/IP port number (e.g. 6000);
     2531        virtual machine which should listen for teleporting requests from other
     2532        virtual machines. It can be any free TCP/IP port number (e.g. 6000);
    25322533        See <xref linkend="teleporting" /> for an introduction.</para>
    25332534        <itemizedlist>
    25342535          <listitem>
    25352536            <para><computeroutput>--maxdowntime &lt;msec&gt;</computeroutput>:
    2536             Optional - specifies the maximum downtime (milliseconds) for the
    2537             teleporting target VM.</para>
     2537            specifies the maximum downtime (milliseconds) for the
     2538            teleporting target VM. Optional.</para>
    25382539          </listitem>
    25392540
    … …  
    25412542            <para><computeroutput>--password
    25422543            &lt;password&gt;</computeroutput>:
    2543             Optional - indicates that the teleporting request will only succeed if the
     2544            indicates that the teleporting request will only succeed if the
    25442545            source machine specifies the same password as the one given with
    2545             this command.</para>
     2546            this command. Optional.</para>
    25462547          </listitem>
    25472548
    … …  
    25492550            <para><computeroutput>--passwordfile
    25502551            &lt;password file&gt;</computeroutput>:
    2551             Optional - indicates that the teleporting request will only succeed if the
     2552            indicates that the teleporting request will only succeed if the
    25522553            source machine specifies the same password as the one specified
    2553             in the file given with this command. Use <computeroutput>stdin</computeroutput>
    2554             to read the password from stdin.</para>
     2554            in the password file with the path specified with this command.
     2555            Use <computeroutput>stdin</computeroutput> to read the password
     2556            from stdin. Optional.</para>
    25552557          </listitem>
    25562558        </itemizedlist>
    … …  
    30223024              <listitem>
    30233025                <para>VirtualBox will only trim whole 1MB blocks. The VDIs themselves are organized
    3024                 into 1MB blocks, so this will only work if the space being TRIM-med is at least
     3026                into 1MB blocks, so this will only work if the space being TRIM-ed is at least
    30253027                a 1MB contiguous block at a 1MB boundary. On Windows, occasional defrag (with "defrag.exe /D"),
    30263028                or under Linux running "btrfs filesystem defrag" as a background cron job may be
    … …  
    30903092
    30913093          <glossdef>
    3092             <para>TCP/IP port number of the iSCSI service on the target
    3093             (optional).</para>
     3094            <para>TCP/IP port number of the iSCSI service on the target.
     3095            Optional.</para>
    30943096          </glossdef>
    30953097        </glossentry>
    … …  
    30993101
    31003102          <glossdef>
    3101             <para>Logical Unit Number of the target resource (optional).
     3103            <para>Logical Unit Number of the target resource. Optional.
    31023104            Often, this value is zero.</para>
    31033105          </glossdef>
    … …  
    31083110
    31093111          <glossdef>
    3110             <para>Hex encoded Logical Unit Number of the target resource (optional).
     3112            <para>Hex encoded Logical Unit Number of the target resource. Optional.
    31113113            Often, this value is zero.</para>
    31123114          </glossdef>
    … …  
    31183120          <glossdef>
    31193121            <para>Username and password (initiator secret) for target
    3120                 authentication, if required (optional).<note>
     3122                authentication, if required. Optional.<note>
    31213123                <para>Username and password are stored without
    31223124                encryption (i.e. in clear text) in the XML machine
    … …  
    31423144
    31433145            <para>A gigabit Ethernet adapter that transmits 1000 megabits per second (Mbps) is recommended for the connection to an iSCSI target. Like
    3144             standard 10/100 adapters, most gigabit adapters use a preexisting Category 5 or Category 6E cable that. Each port on the adapter is
     3146            standard 10/100 adapters, most gigabit adapters use a pre-existing Category 5 or Category 6E cable. Each port on the adapter is
    31453147            identified by a unique IP address.</para>
    31463148
    … …  
    31973199
    31983200          <glossdef>
    3199             <para>Name of the storage controller. Mandatory.</para>
     3201            <para>Specifies the name of the storage controller. Mandatory.</para>
    32003202          </glossdef>
    32013203        </glossentry>
    … …  
    32053207
    32063208          <glossdef>
    3207             <para>Define the type of the system bus to which the storage
     3209            <para>Specifies the type of the system bus to which the storage
    32083210            controller must be connected.</para>
    32093211          </glossdef>
    … …  
    32143216
    32153217          <glossdef>
    3216             <para>Allows to choose the type of chipset being emulated for the
     3218            <para>Enables a choice of chipset type being emulated for the
    32173219            given storage controller.</para>
    32183220          </glossdef>
    … …  
    32233225
    32243226          <glossdef>
    3225             <para>This determines how many ports the storage controller should
     3227            <para>This specifies the number of ports the storage controller should
    32263228            support.</para>
    32273229          </glossdef>
    … …  
    32423244
    32433245          <glossdef>
    3244             <para>Selects whether this controller is bootable.</para>
     3246            <para>Specifies whether this controller is bootable.</para>
    32453247          </glossdef>
    32463248        </glossentry>
    … …  
    32503252
    32513253          <glossdef>
    3252             <para>Sets the name of the storage controller.</para>
     3254            <para>Specifies a new name for the storage controller.</para>
    32533255          </glossdef>
    32543256        </glossentry>
    … …  
    32783280      <listitem>
    32793281        <para><computeroutput>add</computeroutput>, creates a new bandwidth
    3280         group of given type.</para>
     3282        group of a given type.</para>
    32813283      </listitem>
    32823284      <listitem>
    … …  
    32863288      <listitem>
    32873289        <para><computeroutput>remove</computeroutput>, destroys a bandwidth
    3288           group.</para>
     3290        group.</para>
    32893291      </listitem>
    32903292      <listitem>
    32913293        <para><computeroutput>list</computeroutput>, shows all bandwidth groups
    3292         defined for the given VM. Use <computeroutput>--machinereadable</computeroutput>
     3294        defined for the given VM. Use the <computeroutput>--machinereadable</computeroutput>
    32933295        option to produce the same output, but in machine readable format. This is of the
    32943296        form: name="value" on a line by line basis.</para>
    … …  
    33213323            <computeroutput>network</computeroutput>. See
    33223324            <xref linkend="storage-bandwidth-limit" /> or
    3323             <xref linkend="network_bandwidth_limit" /> for a description of a
     3325            <xref linkend="network_bandwidth_limit" /> for the description of a
    33243326            particular type.</para>
    33253327          </glossdef>
    … …  
    33303332
    33313333          <glossdef>
    3332             <para>Specifies the limit for the given group. Can be changed
     3334            <para>Specifies the limit for the given bandwidth group. This can be changed
    33333335            while the VM is running. The default unit is megabytes per
    33343336            second. The unit can be changed by specifying one of the
    … …  
    33483350      <note>
    33493351        <para>To remove a bandwidth group it must not be referenced by any disks
    3350         or adapters in running VM.</para>
     3352        or adapters in the running VM.</para>
    33513353      </note>
    33523354    </para>
    … …  
    33753377  </sect1>
    33763378
    3377   <sect1 id="vboxmanage-createvdi">
    3378     <title>VBoxManage createhd</title>
     3379  <sect1 id="vboxmanage-createmedium">
     3380    <title>VBoxManage createmedium</title>
    33793381
    33803382    <para>This command creates a new medium. The syntax is as follows:</para>
    … …  
    33923394          <glossdef>
    33933395            <para>Specifies a file name &lt;filename&gt; as an absolute path on the host file
    3394             system.. Mandatory.</para>
     3396            system. Mandatory.</para>
    33953397          </glossdef>
    33963398        </glossentry>
    … …  
    34283430
    34293431          <glossdef>
    3430             <para>Specifies any required file format variant(s) for the output file.
    3431             It is a comma-separated list of variant flags. Not all
    3432             combinations are supported, and specifying mutually incompatible
    3433             flags results in an error message. Optional.</para>
     3432            <para>Specifies any required file format variant(s) for the output file.  It is a
     3433            comma-separated list of variant flags. Not all combinations are supported, and specifying
     3434            mutually incompatible flags results in an error message. Optional.</para>
    34343435          </glossdef>
    34353436        </glossentry>
    34363437      </glosslist> <note>
    3437         <para>For compatibility with earlier versions of VirtualBox, the
    3438         "createvdi" command is also supported and mapped internally to the
    3439         "createmedium" command.</para>
     3438        <para>For compatibility with earlier versions of VirtualBox, the "createvdi"  and "createhd" commands
     3439        are also supported and mapped internally to the "createmedium" command.</para>
    34403440      </note></para>
    34413441  </sect1>
    … …  
    34813481
    34823482        <listitem>
    3483           <para>The <computeroutput>--compact</computeroutput> option,
     3483          <para>The <computeroutput>--compact</computeroutput> option
    34843484          can be used to compact disk images, i.e. remove blocks that only
    34853485          contains zeroes. This will shrink a dynamically allocated image
    … …  
    41094109</screen>
    41104110
    4111 
    41124111    <para>This command allows you to share folders on the host computer with
    41134112    guest operating systems. For this, the guest systems must have a version
    … …  
    41974196
    41984197
    4199     <para>Shared folders are described in detail in <xref
    4200     linkend="sharedfolders" />.</para>
     4198    <para>Shared folders are described in detail in <xref linkend="sharedfolders" />.</para>
    42014199  </sect1>
    42024200
Note: See TracChangeset for help on using the changeset viewer.

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