Changeset 99155 in vbox for trunk/doc/manual/en_US

Timestamp:

Mar 23, 2023 10:30:48 PM (2 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

156520

Message:

manual/man_*: Corrections. bugref:10302

Location:

trunk/doc/manual/en_US

Files:

• man_VBoxHeadless.xml (modified) (5 diffs)
• man_VBoxManage-bandwidthctl.xml (modified) (1 diff)
• man_VBoxManage-checkmediumpwd.xml (modified) (1 diff)
• man_VBoxManage-clonemedium.xml (modified) (2 diffs)
• man_VBoxManage-createmedium.xml (modified) (2 diffs)
• man_vboximg-mount.xml (modified) (1 diff)

trunk/doc/manual/en_US/man_VBoxHeadless.xml

@@ -58 +58 @@
           <arg choice="plain">config</arg>
         </group></arg>
-      <arg>--vrdeproperty=<replaceable>prop-name</replaceable>=[<replaceable>prop-value</replaceable>]</arg>
-      <arg>--settingspw=[<replaceable>password</replaceable>]</arg>
+      <arg>--vrdeproperty=<replaceable>prop-name</replaceable>=<arg><replaceable>prop-value</replaceable></arg></arg>
+      <arg>--settingspw=<replaceable>password</replaceable></arg>
       <arg>--settingspwfile=<replaceable>password-file</replaceable></arg>
-      <arg>--start-paused=<replaceable>vmname</replaceable></arg>
+      <arg>--start-paused</arg>
       <arg>--capture</arg>
       <arg>--width=<replaceable>width</replaceable></arg>
@@ -94 +94 @@
               obtain VM information.
             </para><para>
-              The short versions of this option are <option>-s</option>
-              and <option>-startvm</option>.
+              The short versions of this option is <option>-s</option>.
             </para></listitem>
         </varlistentry>
@@ -119 +118 @@
         </varlistentry>
         <varlistentry>
-          <term><option>--vrdeproperty=<replaceable>prop-name</replaceable>=<replaceable>prop-value</replaceable></option></term>
+          <term><option>--vrdeproperty=<replaceable>prop-name</replaceable>=[<replaceable>prop-value</replaceable>]</option></term>
           <listitem><para>
               Specifies a value for one of the following properties:
@@ -137 +136 @@
         </varlistentry>
         <varlistentry>
-          <term><option>--settingspw=[<replaceable>password</replaceable>]</option></term>
+          <term><option>--settingspw=<replaceable>password</replaceable></option></term>
           <listitem><para>
               Specifies a settings password to access encrypted
@@ -157 +156 @@
         </varlistentry>
         <varlistentry>
-          <term><option>--start-paused=<replaceable>vmname</replaceable></option></term>
+          <term><option>--start-paused</option></term>
           <listitem><para>
               Starts the specified VM in the paused state.

trunk/doc/manual/en_US/man_VBoxManage-bandwidthctl.xml

@@ -57 +57 @@
       <arg choice="req"><replaceable>bandwidth-group-name</replaceable></arg>
       <arg choice="req">--limit=<replaceable>bandwidth-limit</replaceable>[k|m|g|K|M|G]</arg>
-      <arg choice="req">--type=disk|network</arg>
+      <arg choice="req">--type=<group choice="plain">
+          <arg choice="plain">disk</arg>
+          <arg choice="plain">network</arg>
+        </group></arg>
     </cmdsynopsis>
 

trunk/doc/manual/en_US/man_VBoxManage-checkmediumpwd.xml

@@ -71 +71 @@
     <variablelist>
       <varlistentry>
-        <term><replaceable>uuid</replaceable>|<replaceable>filename</replaceable></term>
+        <term><replaceable>uuid</replaceable> | <replaceable>filename</replaceable></term>
         <listitem><para>
             Specifies the Universally Unique Identifier (UUID) or the

trunk/doc/manual/en_US/man_VBoxManage-clonemedium.xml

@@ -71 +71 @@
           <arg choice="plain"><replaceable>other</replaceable></arg>
         </group></arg>
-      <arg>--variant=Standard,Fixed,Split2G,Stream,ESX</arg>
+      <arg rep="repeat" role="compact">--variant=<group choice="plain">
+          <arg choice="plain">Standard</arg>
+          <arg choice="plain">Fixed</arg>
+          <arg choice="plain">Split2G</arg>
+          <arg choice="plain">Stream</arg>
+          <arg choice="plain">ESX</arg>
+      </group></arg> <!-- Value can be repated with comma separator. Difficult to express with docbook. -->
     </cmdsynopsis>
   </refsynopsisdiv>
@@ -146 +152 @@
       </varlistentry>
       <varlistentry>
-        <term><option>--variant=Standard,Fixed,Split2G,Stream,ESX</option></term>
+        <term><option>--variant=Standard | Fixed | Split2G | Stream | ESX [,...]</option></term>
         <listitem><para>
             Specifies the file format variant for the target medium,

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

@@ -69 +69 @@
           <arg choice="plain"><replaceable>VHD</replaceable></arg>
         </group></arg>
-      <arg>--variant Standard,Fixed,Split2G,Stream,ESX,Formatted,RawDisk</arg>
+      <arg rep="repeat" role="compact">--variant=<group choice="plain">
+          <arg choice="plain">Standard</arg>
+          <arg choice="plain">Fixed</arg>
+          <arg choice="plain">Split2G</arg>
+          <arg choice="plain">Stream</arg>
+          <arg choice="plain">ESX</arg>
+          <arg choice="plain">Formatted</arg>
+          <arg choice="plain">RawDisk</arg>
+      </group></arg> <!-- Value can be repated with comma separator. Difficult to express with docbook. -->
       <arg rep="repeat">--property <replaceable>name</replaceable>=<replaceable>value</replaceable></arg>
       <arg rep="repeat">--property-file <replaceable>name</replaceable>=<replaceable>/path/to/file/with/value</replaceable></arg>
@@ -136 +144 @@
       </varlistentry>
       <varlistentry>
-        <term><option>--variant=Standard,Fixed,Split2G,Stream,ESX,Formatted,RawDisk</option></term>
+        <term><option>--variant=Standard | Fixed | Split2G | Stream | ESX | Formatted | RawDisk [,...]</option></term>
         <listitem><para>
             Specifies the file format variant for the target medium,

trunk/doc/manual/en_US/man_vboximg-mount.xml

@@ -61 +61 @@
       <arg choice="req">--image=<replaceable>image-UUID</replaceable></arg>
       <arg>--guest-filesystem</arg>
-      <arg>-o=<replaceable>FUSE-option</replaceable>[,<replaceable>FUSE-option</replaceable>]</arg>
+      <arg>-o=<replaceable>FUSE-option</replaceable><arg rep="repeat">,<replaceable>FUSE-option</replaceable></arg></arg>
       <arg>--root</arg>
       <arg>--rw</arg>