VirtualBox

Changeset 94197 in vbox for trunk


Ignore:
Timestamp:
Mar 12, 2022 6:48:39 PM (3 years ago)
Author:
vboxsync
Message:

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

Location:
trunk
Files:
7 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/manual/Config.kmk

    r94181 r94197  
    6666        man_VBoxManage-closemedium.xml \
    6767        man_VBoxManage-storagectl.xml \
    68         man_VBoxManage-bandwidthctl.xml
     68        man_VBoxManage-bandwidthctl.xml \
     69        man_VBoxManage-showmediuminfo.xml
    6970
    7071## List of user manual XML files.
  • trunk/doc/manual/en_US/man_VBoxManage-showmediuminfo.xml

    r87075 r94197  
    2020<refentry id="vboxmanage-showmediuminfo" lang="en">
    2121  <refentryinfo>
    22     <pubdate>August 2019</pubdate>
     22    <pubdate>$Date$</pubdate>
    2323    <title>VBoxManage showmediuminfo</title>
    2424  </refentryinfo>
     
    3232    <refname>VBoxManage-showmediuminfo</refname>
    3333    <refpurpose>show information about a medium</refpurpose>
    34     <refclass>Oracle VM VirtualBox</refclass>
     34    <refclass>&product-name;</refclass>
    3535  </refnamediv>
    3636
  • trunk/doc/manual/en_US/user_VBoxManage.xml

    r94181 r94197  
    929929  <xi:include href="user_man_VBoxManage-bandwidthctl.xml"  xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
    930930
    931   <sect1 id="vboxmanage-showmediuminfo">
    932 
    933     <title>VBoxManage showmediuminfo</title>
    934 
    935     <para>
    936       This command shows information about a medium, notably its size,
    937       its size on disk, its type, and the virtual machines which use it.
    938     </para>
    939 
    940     <note>
    941       <para>
    942         For compatibility with earlier versions of &product-name;, the
    943         <command>showvdiinfo</command> command is also supported and
    944         mapped internally to the <command>showmediuminfo</command>
    945         command.
    946       </para>
    947     </note>
    948 
    949 <screen>VBoxManage showmediuminfo     [disk|dvd|floppy] &lt;uuid|filename&gt;</screen>
    950 
    951     <para>
    952       The medium must be specified either by its UUID, if the medium is
    953       registered, or by its filename. Registered images can be listed
    954       using <command>VBoxManage list hdds</command>, <command>VBoxManage
    955       list dvds</command>, or <command>VBoxManage list
    956       floppies</command>, as appropriate. See
    957       <xref linkend="vboxmanage-list" />.
    958     </para>
    959 
    960   </sect1>
     931  <xi:include href="user_man_VBoxManage-showmediuminfo.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
    961932
    962933  <sect1 id="vboxmanage-createmedium">
  • trunk/src/VBox/Frontends/VBoxManage/VBoxManage.cpp

    r94181 r94197  
    222222    { "storageattach",      USAGE_STORAGEATTACH,    VBMG_CMD_TODO, handleStorageAttach,        0 },
    223223    { "storagectl",         USAGE_S_NEWCMD,   HELP_CMD_STORAGECTL, handleStorageController,    0 },
    224     { "showmediuminfo",     USAGE_SHOWMEDIUMINFO,   VBMG_CMD_TODO, handleShowMediumInfo,       0 },
    225     { "showhdinfo",         USAGE_SHOWMEDIUMINFO,   VBMG_CMD_TODO, handleShowMediumInfo,       0 }, /* backward compatibility */
    226     { "showvdiinfo",        USAGE_SHOWMEDIUMINFO,   VBMG_CMD_TODO, handleShowMediumInfo,       0 }, /* backward compatibility */
     224    { "showmediuminfo",     USAGE_S_NEWCMD,HELP_CMD_SHOWMEDIUMINFO, handleShowMediumInfo,       0 },
     225    { "showhdinfo",         USAGE_S_NEWCMD,HELP_CMD_SHOWMEDIUMINFO, handleShowMediumInfo,       0 }, /* backward compatibility */
     226    { "showvdiinfo",        USAGE_S_NEWCMD,HELP_CMD_SHOWMEDIUMINFO, handleShowMediumInfo,       0 }, /* backward compatibility */
    227227    { "mediumio",           USAGE_S_NEWCMD,     HELP_CMD_MEDIUMIO, handleMediumIO,             0 },
    228228    { "getextradata",       USAGE_GETEXTRADATA,     VBMG_CMD_TODO, handleGetExtraData,         0 },
  • trunk/src/VBox/Frontends/VBoxManage/VBoxManage.h

    r94181 r94197  
    9898{
    9999    USAGE_INVALID = 0,
    100     USAGE_SHOWMEDIUMINFO,
    101100    USAGE_CREATEMEDIUM,
    102101    USAGE_MODIFYMEDIUM,
  • trunk/src/VBox/Frontends/VBoxManage/VBoxManageDisk.cpp

    r94177 r94197  
    16601660            case 'd':   // disk
    16611661                if (cmd != CMD_NONE)
    1662                     return errorSyntax(USAGE_SHOWMEDIUMINFO, Disk::tr("Only one command can be specified: '%s'"), ValueUnion.psz);
     1662                    return errorSyntax(Disk::tr("Only one command can be specified: '%s'"), ValueUnion.psz);
    16631663                cmd = CMD_DISK;
    16641664                break;
     
    16661666            case 'D':   // DVD
    16671667                if (cmd != CMD_NONE)
    1668                     return errorSyntax(USAGE_SHOWMEDIUMINFO, Disk::tr("Only one command can be specified: '%s'"), ValueUnion.psz);
     1668                    return errorSyntax(Disk::tr("Only one command can be specified: '%s'"), ValueUnion.psz);
    16691669                cmd = CMD_DVD;
    16701670                break;
     
    16721672            case 'f':   // floppy
    16731673                if (cmd != CMD_NONE)
    1674                     return errorSyntax(USAGE_SHOWMEDIUMINFO, Disk::tr("Only one command can be specified: '%s'"), ValueUnion.psz);
     1674                    return errorSyntax(Disk::tr("Only one command can be specified: '%s'"), ValueUnion.psz);
    16751675                cmd = CMD_FLOPPY;
    16761676                break;
     
    16801680                    pszFilenameOrUuid = ValueUnion.psz;
    16811681                else
    1682                     return errorSyntax(USAGE_SHOWMEDIUMINFO, Disk::tr("Invalid parameter '%s'"), ValueUnion.psz);
     1682                    return errorSyntax(Disk::tr("Invalid parameter '%s'"), ValueUnion.psz);
    16831683                break;
    16841684
     
    16871687                {
    16881688                    if (RT_C_IS_PRINT(c))
    1689                         return errorSyntax(USAGE_SHOWMEDIUMINFO, Disk::tr("Invalid option -%c"), c);
     1689                        return errorSyntax(Disk::tr("Invalid option -%c"), c);
    16901690                    else
    1691                         return errorSyntax(USAGE_SHOWMEDIUMINFO, Disk::tr("Invalid option case %i"), c);
     1691                        return errorSyntax(Disk::tr("Invalid option case %i"), c);
    16921692                }
    16931693                else if (c == VERR_GETOPT_UNKNOWN_OPTION)
    1694                     return errorSyntax(USAGE_SHOWMEDIUMINFO, Disk::tr("unknown option: %s\n"), ValueUnion.psz);
     1694                    return errorSyntax(Disk::tr("unknown option: %s\n"), ValueUnion.psz);
    16951695                else if (ValueUnion.pDef)
    1696                     return errorSyntax(USAGE_SHOWMEDIUMINFO, "%s: %Rrs", ValueUnion.pDef->pszLong, c);
     1696                    return errorSyntax("%s: %Rrs", ValueUnion.pDef->pszLong, c);
    16971697                else
    1698                     return errorSyntax(USAGE_SHOWMEDIUMINFO, Disk::tr("error: %Rrs"), c);
     1698                    return errorSyntax(Disk::tr("error: %Rrs"), c);
    16991699        }
    17001700    }
     
    17051705    /* check for required options */
    17061706    if (!pszFilenameOrUuid)
    1707         return errorSyntax(USAGE_SHOWMEDIUMINFO, Disk::tr("Medium name or UUID required"));
     1707        return errorSyntax(Disk::tr("Medium name or UUID required"));
    17081708
    17091709    HRESULT rc = S_OK; /* Prevents warning. */
  • trunk/src/VBox/Frontends/VBoxManage/VBoxManageHelp.cpp

    r94181 r94197  
    625625                     "\n", SEP);
    626626
    627     if (enmCommand == USAGE_SHOWMEDIUMINFO || enmCommand == USAGE_S_ALL)
    628         RTStrmPrintf(pStrm,
    629                            "%s showmediuminfo %s  [disk|dvd|floppy] <uuid|filename>\n"
    630                      "\n", SEP);
    631 
    632627    if (enmCommand == USAGE_CREATEMEDIUM || enmCommand == USAGE_S_ALL)
    633628        RTStrmPrintf(pStrm,
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