VirtualBox

Changeset 94198 in vbox for trunk/doc/manual


Ignore:
Timestamp:
Mar 12, 2022 6:56:13 PM (3 years ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
150454
Message:

doc/manual,FE/VBoxManage: Convert createmedium command to refentry documentation, ​bugref:9186

Location:
trunk/doc/manual
Files:
3 edited

Legend:

Unmodified
Added
Removed

  • trunk/doc/manual/Config.kmk

    r94197 r94198  
    6767        man_VBoxManage-storagectl.xml \
    6868        man_VBoxManage-bandwidthctl.xml \
    69         man_VBoxManage-showmediuminfo.xml
     69        man_VBoxManage-showmediuminfo.xml \
     70        man_VBoxManage-createmedium.xml
    7071
    7172## List of user manual XML files.

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

    r92985 r94198  
    3232    <refname>VBoxManage-createmedium</refname>
    3333    <refpurpose>create a new medium</refpurpose>
    34     <refclass>Oracle VM VirtualBox</refclass>
     34    <refclass>&product-name;</refclass>
    3535  </refnamediv>
    3636

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

    r94197 r94198  
    931931  <xi:include href="user_man_VBoxManage-showmediuminfo.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
    932932
    933   <sect1 id="vboxmanage-createmedium">
    934 
    935     <title>VBoxManage createmedium</title>
    936 
    937     <para>
    938       This command creates a new medium. The syntax is as follows:
    939     </para>
    940 
    941 <screen>VBoxManage createmedium     [disk|dvd|floppy]    --filename &lt;filename&gt;
    942                             [--size &lt;megabytes&gt;|--sizebyte &lt;bytes&gt;]
    943                             [--diffparent &lt;uuid&gt;|&lt;filename&gt;
    944                             [--format VDI|VMDK|VHD] (default: VDI)
    945                             [--variant Standard,Fixed,Split2G,Stream,ESX,RawDisk]
    946                             [[--property &lt;name&gt;=&lt;value&gt;]
    947                              --property &lt;name&gt;=&lt;value&gt;]...
    948                             [[--property-file &lt;name&gt;=&lt;/path/to/file/with/value&gt;]
    949                              --property-file &lt;name&gt;=&lt;/path/to/file/with/value&gt;]...</screen>
    950 
    951     <para>
    952       The parameters are as follows:
    953     </para>
    954 
    955     <variablelist>
    956 
    957       <varlistentry>
    958         <term>
    959           <computeroutput>--filename &lt;filename&gt;</computeroutput>
    960         </term>
    961 
    962         <listitem>
    963           <para>
    964             Specifies a file name &lt;filename&gt; as an absolute path
    965             on the host file system. Mandatory.
    966           </para>
    967         </listitem>
    968       </varlistentry>
    969 
    970       <varlistentry>
    971         <term>
    972           <computeroutput>--size &lt;megabytes&gt;</computeroutput>
    973         </term>
    974 
    975         <listitem>
    976           <para>
    977             Specifies the image capacity, in 1 MB units. Optional.
    978           </para>
    979         </listitem>
    980       </varlistentry>
    981 
    982       <varlistentry>
    983         <term>
    984           <computeroutput>--diffparent
    985           &lt;uuid&gt;|&lt;filename&gt;</computeroutput>
    986         </term>
    987 
    988         <listitem>
    989           <para>
    990             Specifies the differencing image parent, either as a UUID or
    991             by the absolute pathname of the file on the host file
    992             system. Useful for sharing a base box disk image among
    993             several VMs.
    994           </para>
    995         </listitem>
    996       </varlistentry>
    997 
    998       <varlistentry>
    999         <term>
    1000           <computeroutput>--format VDI|VMDK|VHD</computeroutput>
    1001         </term>
    1002 
    1003         <listitem>
    1004           <para>
    1005             Specifies the file format for the output file. Available
    1006             options are VDI, VMDK, VHD. The default format is VDI.
    1007             Optional.
    1008           </para>
    1009         </listitem>
    1010       </varlistentry>
    1011 
    1012       <varlistentry>
    1013         <term>
    1014           <computeroutput>--variant</computeroutput>
    1015         </term>
    1016 
    1017         <listitem>
    1018           <para>
    1019             Specifies any required file format variants for the output
    1020             file. This is a comma-separated list of variant flags.
    1021             Options are Standard,Fixed,Split2G,Stream,ESX,RawDisk. Not all
    1022             combinations are supported, and specifying mutually
    1023             incompatible flags results in an error message. Optional.
    1024           </para>
    1025         </listitem>
    1026       </varlistentry>
    1027 
    1028       <varlistentry>
    1029         <term>
    1030           <computeroutput>--property &lt;name&gt;=&lt;value&gt;</computeroutput>
    1031         </term>
    1032 
    1033         <listitem>
    1034           <para>
    1035             Specifies any required file format dependent parameters in
    1036             <literal>key=value</literal> form. Optional.
    1037           </para>
    1038         </listitem>
    1039       </varlistentry>
    1040 
    1041       <varlistentry>
    1042         <term>
    1043           <computeroutput>--property-file &lt;name&gt;=&lt;/path/to/file/with/value&gt;</computeroutput>
    1044         </term>
    1045 
    1046         <listitem>
    1047           <para>
    1048             Specifies any required file format dependent parameters in
    1049             <literal>key=file/with/value</literal> form. The value is
    1050             taken from the file. Optional.
    1051           </para>
    1052         </listitem>
    1053       </varlistentry>
    1054 
    1055     </variablelist>
    1056 
    1057     <note>
    1058       <para>
    1059         For compatibility with earlier versions of &product-name;, the
    1060         <command>createvdi</command> and <command>createhd</command>
    1061         commands are also supported and mapped internally to the
    1062         <command>createmedium</command> command.
    1063       </para>
    1064     </note>
    1065 
    1066   </sect1>
     933  <xi:include href="user_man_VBoxManage-createmedium.xml"   xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
    1067934
    1068935  <sect1 id="vboxmanage-modifymedium">
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