VirtualBox

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


Ignore:
Timestamp:
Jun 16, 2015 11:46:25 PM (10 years ago)
Author:
vboxsync
Message:

debugvm manpage, refsect2 titles, bunch of other hacking.

Location:
trunk/doc/manual/en_US
Files:
3 edited

Legend:

Unmodified
Added
Removed

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

    r56445 r56466  
    141141
    142142    <refsect2 id="vboxmanage-debugvm-dumpvmcore">
    143       <cmdsynopsis>
    144         <command>VBoxManage debugvm</command>
    145         <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
    146         <arg choice="plain">dumpvmcore</arg>
    147         <arg>--filename <replaceable>name</replaceable></arg>
    148       </cmdsynopsis>
     143      <title>VBoxManage debugvm dumpvmcore</title>
     144      <remark role="help-copy-synopsis"/>
    149145      <para>
    150146        Creates a system dump file of the specified VM.  This file will have
    … …  
    164160
    165161    <refsect2 id="vboxmanage-debugvm-info">
    166       <cmdsynopsis>
    167         <command>VBoxManage debugvm</command>
    168         <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
    169         <arg choice="plain">info</arg>
    170         <arg choice="req"><replaceable>item</replaceable></arg>
    171         <arg rep="repeat"><replaceable>args</replaceable></arg>
    172       </cmdsynopsis>
     162      <title>VBoxManage debugvm info</title>
     163      <remark role="help-copy-synopsis"/>
    173164      <para>
    174165        Displays info items relating to the VMM, device emulations and
    … …  
    199190
    200191    <refsect2 id="vboxmanage-debugvm-injectnmi">
    201       <cmdsynopsis>
    202         <command>VBoxManage debugvm</command>
    203         <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
    204         <arg choice="plain">injectnmi</arg>
    205       </cmdsynopsis>
     192      <title>VBoxManage debugvm injectnmi</title>
     193      <remark role="help-copy-synopsis"/>
    206194      <para>
    207195        Causes a non-maskable interrupt (NMI) to be injected into the guest. This
    … …  
    213201
    214202    <refsect2 id="vboxmanage-debugvm-log">
    215       <cmdsynopsis>
    216         <command>VBoxManage debugvm</command>
    217         <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
    218         <arg choice="plain">log</arg>
    219         <group><arg>--release</arg><arg>--debug</arg></group>
    220         <arg rep="repeat"><replaceable>group-settings</replaceable></arg>
    221       </cmdsynopsis>
     203      <title>VBoxManage debugvm log</title>
     204      <remark role="help-copy-synopsis"/>
    222205      <para>
    223206        TODO
    … …  
    226209
    227210    <refsect2 id="vboxmanage-debugvm-logdest">
    228       <cmdsynopsis>
    229         <command>VBoxManage debugvm</command>
    230         <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
    231         <arg choice="plain">logdest</arg>
    232         <group><arg>--release</arg><arg>--debug</arg></group>
    233         <arg rep="repeat"><replaceable>destinations</replaceable></arg>
    234       </cmdsynopsis>
     211      <title>VBoxManage debugvm logdest</title>
     212      <remark role="help-copy-synopsis"/>
    235213      <para>
    236214        TODO
    … …  
    239217
    240218    <refsect2 id="vboxmanage-debugvm-logflags">
    241       <cmdsynopsis>
    242         <command>VBoxManage debugvm</command>
    243         <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
    244         <arg choice="plain">logflags</arg>
    245         <group><arg>--release</arg><arg>--debug</arg></group>
    246         <arg rep="repeat"><replaceable>flags</replaceable></arg>
    247       </cmdsynopsis>
     219      <title>VBoxManage debugvm logflags</title>
     220      <remark role="help-copy-synopsis"/>
    248221      <para>
    249222        TODO
    … …  
    252225
    253226    <refsect2 id="vboxmanage-debugvm-osdetect">
    254       <cmdsynopsis>
    255         <command>VBoxManage debugvm</command>
    256         <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
    257         <arg choice="plain">osdetect</arg>
    258       </cmdsynopsis>
     227      <title>VBoxManage debugvm osdetect</title>
     228      <remark role="help-copy-synopsis"/>
    259229      <para>
    260230        Make the VMM's debugger facility (re)-detect the guest operating system (OS).
    … …  
    267237
    268238    <refsect2 id="vboxmanage-debugvm-osinfo">
    269       <cmdsynopsis>
    270         <command>VBoxManage debugvm</command>
    271         <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
    272         <arg choice="plain">osinfo</arg>
    273       </cmdsynopsis>
     239      <title>VBoxManage debugvm osinfo</title>
     240      <remark role="help-copy-synopsis"/>
    274241      <para>
    275242        Displays information about the guest operating system (OS) previously
    … …  
    279246
    280247    <refsect2 id="vboxmanage-debugvm-osdmesg">
    281       <cmdsynopsis>
    282         <command>VBoxManage debugvm</command>
    283         <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
    284         <arg choice="plain">osdmesg</arg>
    285         <arg>--lines <replaceable>lines</replaceable></arg>
    286       </cmdsynopsis>
     248      <title>VBoxManage debugvm osdmesg</title>
     249      <remark role="help-copy-synopsis"/>
    287250      <para>
    288251        Displays the guest OS kernel log, if detected and supported.
    … …  
    298261
    299262    <refsect2 id="vboxmanage-debugvm-getregisters">
    300       <cmdsynopsis>
    301         <command>VBoxManage debugvm</command>
    302         <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
    303         <arg choice="plain">getregisters</arg>
    304         <arg>--cpu <replaceable>id</replaceable></arg>
    305         <arg rep="repeat"><replaceable>reg-set.reg-name</replaceable></arg>
    306       </cmdsynopsis>
     263      <title>VBoxManage debugvm getregisters</title>
     264      <remark role="help-copy-synopsis"/>
    307265      <para>
    308266        Retrieves register values for guest CPUs and emulated devices.
    … …  
    333291
    334292    <refsect2 id="vboxmanage-debugvm-setregisters">
    335       <cmdsynopsis>
    336         <command>VBoxManage debugvm</command>
    337         <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
    338         <arg choice="plain">setregisters</arg>
    339         <arg>--cpu <replaceable>id</replaceable></arg>
    340         <arg rep="repeat"><replaceable>reg-set.reg-name=value</replaceable></arg>
    341       </cmdsynopsis>
     293      <title>VBoxManage debugvm setregisters</title>
     294      <remark role="help-copy-synopsis"/>
    342295      <para>
    343296        Changes register values for guest CPUs and emulated devices.
    … …  
    368321
    369322    <refsect2 id="vboxmanage-debugvm-show">
    370       <cmdsynopsis>
    371         <command>VBoxManage debugvm</command>
    372         <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
    373         <arg choice="plain">show</arg>
    374         <group><arg>--human-readable</arg><arg>--sh-export</arg><arg>--sh-eval</arg><arg>--cmd-set</arg></group>
    375         <arg rep="repeat"><replaceable>settings-item</replaceable></arg>
    376       </cmdsynopsis>
     323      <title>VBoxManage debugvm show</title>
     324      <remark role="help-copy-synopsis"/>
    377325      <para>
    378326        TODO
    … …  
    381329
    382330    <refsect2 id="vboxmanage-debugvm-statistics">
    383       <cmdsynopsis>
    384         <command>VBoxManage debugvm</command>
    385         <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
    386         <arg choice="plain">statistics</arg>
    387         <arg>--reset</arg>
    388         <arg>--descriptions</arg>
    389         <arg>--pattern <replaceable>pattern</replaceable></arg>
    390       </cmdsynopsis>
     331      <title>VBoxManage debugvm statistics</title>
     332      <remark role="help-copy-synopsis"/>
    391333      <para>
    392334        Displays or resets VMM statistics.

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

    r56434 r56466  
    5252
    5353    <refsect2 id="vboxmanage-extpack-install">
    54       <cmdsynopsis>
    55         <command>VBoxManage extpack install</command>
    56         <arg>--replace</arg>
    57         <arg choice="req"><replaceable>tarball</replaceable></arg>
    58       </cmdsynopsis>
     54      <title>VBoxManage extpack install</title>
     55      <remark role="help-copy-synopsis"/>
    5956      <para>
    6057        Installs a new extension pack on the system.  This command will fail if an older
    … …  
    7774
    7875    <refsect2 id="vboxmanage-extpack-uninstall">
    79       <cmdsynopsis>
    80         <command>VBoxManage extpack uninstall</command>
    81         <arg>--force</arg>
    82         <arg choice="req"><replaceable>name</replaceable></arg>
    83       </cmdsynopsis>
     76      <title>VBoxManage extpack uninstall</title>
     77      <remark role="help-copy-synopsis"/>
    8478      <para>
    8579        Uninstalls an extension pack from the system.  The subcommand will also succeed
    … …  
    10599
    106100    <refsect2 id="vboxmanage-extpack-cleanup">
    107       <cmdsynopsis>
    108         <command>VBoxManage extpack cleanup</command>
    109       </cmdsynopsis>
     101      <title>VBoxManage extpack cleanup</title>
     102      <remark role="help-copy-synopsis"/>
    110103      <para>
    111104        Used to remove temporary files and directories that may have been left behind

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

    r56451 r56466  
    158158    for the commands available on your particular host.</para>
    159159
    160     <screen>$VBOX_MANAGE_OUTPUT</screen>
     160    <screen>@VBOX_MANAGE_OUTPUT@</screen> <!-- the whole line is replaced later -->
    161161    <xi:include href="../user_VBoxManage_CommandsOverview.xml" xpointer="element(/1)"
    162162      xmlns:xi="http://www.w3.org/2001/XInclude" />
    … …  
    42544254  </sect1>
    42554255
    4256   <sect1 id="vboxmanage-debugvm">
    4257     <title>VBoxManage debugvm</title>
    4258 
    4259     <para>The "debugvm" commands are for experts who want to tinker with the
    4260     exact details of virtual machine execution. Like the VM debugger described
    4261     in <xref linkend="ts_debugger" />, these commands are only useful if you are
    4262     very familiar with the details of the PC architecture and how to debug
    4263     software.</para>
    4264 
    4265     <para>The subcommands of "debugvm" all operate on a running virtual
    4266     machine. The following are available:<itemizedlist>
    4267         <listitem>
    4268           <para>With <computeroutput>dumpguestcore --filename
    4269           &lt;name&gt;</computeroutput>, you can create a system dump of the
    4270           running VM, which will be written into the given file. This file
    4271           will have the standard ELF core format (with custom sections); see
    4272           <xref linkend="ts_guest-core-format" />.</para>
    4273 
    4274           <para>This corresponds to the
    4275           <computeroutput>writecore</computeroutput> command in the debugger.
    4276           </para>
    4277         </listitem>
    4278 
    4279         <listitem>
    4280           <para>The <computeroutput>info</computeroutput> command is used to
    4281           display info items relating to the VMM, device emulations and
    4282           associated drivers.  This command takes one or two arguments: the
    4283           name of the info item, optionally followed by a string containing
    4284           arguments specific to the info item.
    4285           The <computeroutput>help</computeroutput> info item provides a
    4286           listning of the available items and hints about any optional
    4287           arguments.</para>
    4288 
    4289           <para>This corresponds to the <computeroutput>info</computeroutput>
    4290           command in the debugger.</para>
    4291         </listitem>
    4292 
    4293         <listitem>
    4294           <para>The <computeroutput>injectnmi</computeroutput> command causes
    4295           a non-maskable interrupt (NMI) in the guest, which might be useful
    4296           for certain debugging scenarios. What happens exactly is dependent
    4297           on the guest operating system, but an NMI can crash the whole guest
    4298           operating system. Do not use unless you know what you're
    4299           doing.</para>
    4300         </listitem>
    4301 
    4302         <listitem>
    4303           <para>The <computeroutput>osdetect</computeroutput> command makes the
    4304           VMM's debugger facility (re-)detection the guest operation
    4305           system.</para>
    4306 
    4307           <para>This corresponds to the <computeroutput>detect</computeroutput>
    4308           command in the debugger.</para>
    4309         </listitem>
    4310 
    4311         <listitem>
    4312           <para>The <computeroutput>osinfo</computeroutput> command is used to
    4313           display info about the operating system (OS) detected by the VMM's
    4314           debugger facility.</para>
    4315         </listitem>
    4316 
    4317         <listitem>
    4318           <para>The <computeroutput>getregisters</computeroutput> command is
    4319           used to display CPU and device registers.  The command takes a list
    4320           of registers, each having one of the following forms:
    4321           <itemizedlist>
    4322             <listitem><para><computeroutput>register-set.register-name.sub-field</computeroutput></para></listitem>
    4323             <listitem><para><computeroutput>register-set.register-name</computeroutput></para></listitem>
    4324             <listitem><para><computeroutput>cpu-register-name.sub-field</computeroutput></para></listitem>
    4325             <listitem><para><computeroutput>cpu-register-name</computeroutput></para></listitem>
    4326             <listitem><para><computeroutput>all</computeroutput></para></listitem>
    4327           </itemizedlist>
    4328           The <computeroutput>all</computeroutput> form will cause all
    4329           registers to be shown (no sub-fields).  The registers names are
    4330           case-insensitive.  When requesting a CPU register the register set
    4331           can be omitted, it will be selected using the value of the
    4332           <computeroutput>--cpu</computeroutput> option (defaulting to 0).
    4333           </para>
    4334         </listitem>
    4335 
    4336         <listitem>
    4337           <para>The <computeroutput>setregisters</computeroutput> command is
    4338           used to change CPU and device registers.  The command takes a list
    4339           of register assignments, each having one of the following forms:
    4340           <itemizedlist>
    4341             <listitem><para><computeroutput>register-set.register-name.sub-field=value</computeroutput></para></listitem>
    4342             <listitem><para><computeroutput>register-set.register-name=value</computeroutput></para></listitem>
    4343             <listitem><para><computeroutput>cpu-register-name.sub-field=value</computeroutput></para></listitem>
    4344             <listitem><para><computeroutput>cpu-register-name=value</computeroutput></para></listitem>
    4345           </itemizedlist>
    4346           The value format should be in the same style as what
    4347           <computeroutput>getregisters</computeroutput> displays, with the
    4348           exception that both octal and decimal can be used instead of
    4349           hexadecimal.  The register naming and the default CPU register set
    4350           are handled the same way as with the
    4351           <computeroutput>getregisters</computeroutput> command.</para>
    4352         </listitem>
    4353 
    4354         <listitem>
    4355           <para>The <computeroutput>statistics</computeroutput> command can be
    4356           used to display VMM statistics on the command line. The
    4357           <computeroutput>--reset</computeroutput> option will reset
    4358           statistics. The affected statistics can be filtered with the
    4359           <computeroutput>--pattern</computeroutput> option, which accepts
    4360           DOS/NT-style wildcards (<computeroutput>?</computeroutput> and
    4361           <computeroutput>*</computeroutput>).</para>
    4362         </listitem>
    4363       </itemizedlist></para>
    4364   </sect1>
    4365 
    43664256  <sect1 id="metrics">
    43674257    <title>VBoxManage metrics</title>
    … …  
    46324522  </sect1>
    46334523
     4524  <xi:include href="man_VBoxManage_debugvm.xml" xpointer="element(/1)"
     4525    xmlns:xi="http://www.w3.org/2001/XInclude" />
     4526
    46344527  <xi:include href="man_VBoxManage_extpack.xml" xpointer="element(/1)"
    46354528    xmlns:xi="http://www.w3.org/2001/XInclude" />
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