Index: /trunk/doc/manual/en_US/man_VBoxManage_debugvm.xml =================================================================== --- /trunk/doc/manual/en_US/man_VBoxManage_debugvm.xml (revision 56441) +++ /trunk/doc/manual/en_US/man_VBoxManage_debugvm.xml (revision 56442) @@ -22,4 +22,5 @@ + VBoxManage-debugvm 1 @@ -27,88 +28,358 @@ VBoxManage-debugvm - extension package management + introspection and guest debugging Oracle VM VirtualBox - - VBoxManage debugvm install - --replace - tarball - - - VBoxManage debugvm uninstall - --force - name - - - VBoxManage debugvm cleanup + + VBoxManage debugvm + uuid|vmname + dumpguestcore + --filename name + + + VBoxManage debugvm + uuid|vmname + info + item + args + + + VBoxManage debugvm + uuid|vmname + injectnmi + + + VBoxManage debugvm + uuid|vmname + log + --release--debug + group-settings + + + VBoxManage debugvm + uuid|vmname + logdest + --release--debug + destinations + + + VBoxManage debugvm + uuid|vmname + logflags + --release--debug + flags + + + VBoxManage debugvm + uuid|vmname + osdetect + + + VBoxManage debugvm + uuid|vmname + osinfo + + + VBoxManage debugvm + uuid|vmname + getregisters + --cpu id + reg-set.reg-name + + + VBoxManage debugvm + uuid|vmname + setregisters + --cpu id + reg-set.reg-name=value + + + VBoxManage debugvm + uuid|vmname + show + --human-readable--sh-export--sh-eval--cmd-set + settings-item + + + VBoxManage debugvm + uuid|vmname + statistics + --reset + --descriptions + --pattern pattern - Description - - - VBoxManage debugvm install - --replace - tarball - - - Installs a new extension pack on the system. This command will fail if an older - version of the same extension pack is already installed. The - option can be used to uninstall any - old package before the new one is installed. - - - - Uninstall existing extension pack version. - - - tarball + The "debugvm" commands are for experts who want to tinker with the + exact details of virtual machine execution. Like the VM debugger + described in , these commands are only useful if you are + very familiar with the details of the PC architecture and how to debug + software. + + + Common options + + The subcommands of debugvm all operate on a running virtual + machine: + + + uuid|vmname + Either the UUID or the name (case sensitive) of a VM. + + + + + + + VBoxManage debugvm + uuid|vmname + dumpguestcore + --filename name + + + Creates a system dump file of the specified VM. This file will have + the standard ELF core format (with custom sections); see + . + + + This corresponds to the writecore command in the debugger. + + + + + The name of the output file. + + + + + + + VBoxManage debugvm + uuid|vmname + info + item + args + + + Displays info items relating to the VMM, device emulations and + associated drivers. + + + This corresponds to the info command in the debugger. + + + + info - The file containing the extension pack to be installed. - - - - - - - - VBoxManage debugvm uninstall - --force - name - - - Uninstalls an extension pack from the system. The subcommand will also succeed - in the case where the specified extension pack is not present on the system. - You can use VBoxManage list debugvms to show - the names of the extension packs which are currently installed. - - - - + Name of the info item to display. The special name + will list all the available info items and + hints about optional arguments. + + + + args - Overrides most refusals to uninstall an extension pack - - - - name - - The name of the extension pack to be uninstalled. - - - - - - - - VBoxManage debugvm cleanup - - - Used to remove temporariy files and directories that may have been left behind - if a previous install or uninstall command failed. - + Optional argument string for the info item handler. Most info items + does not take any extra arguments. Arguments not recognized are generally + ignored. + + + + + + + + VBoxManage debugvm + uuid|vmname + injectnmi + + + Causes a non-maskable interrupt (NMI) to be injected into the guest. This + might be useful for certain debugging scenarios. What happens exactly is + dependent on the guest operating system, but an NMI can crash the whole + guest operating system. Do not use unless you know what you're doing. + + + + + + VBoxManage debugvm + uuid|vmname + log + --release--debug + group-settings + + + TODO + + + + + + VBoxManage debugvm + uuid|vmname + logdest + --release--debug + destinations + + + TODO + + + + + + VBoxManage debugvm + uuid|vmname + logflags + --release--debug + flags + + + TODO + + + + + + VBoxManage debugvm + uuid|vmname + osdetect + + + Make the VMM's debugger facility (re)-detect the guest operating system (OS). + + + This corresponds to the detect command in the debugger. + + + + + + VBoxManage debugvm + uuid|vmname + osinfo + + + Displays information about the guest operating system (OS) previously + detected by the VMM's debugger facility. + + + + + + VBoxManage debugvm + uuid|vmname + getregisters + --cpu id + reg-set.reg-name + + + Retrieves register values for guest CPUs and emulated devices. + + + + reg-set.reg-name + One of more registers, each having one of the following forms: + + register-set.register-name.sub-field + register-set.register-name + cpu-register-name.sub-field + cpu-register-name + all + + The all form will cause all registers + to be shown (no sub-fields). The registers names are case-insensitive. + + + + + Selects the CPU register set when specifying just a + CPU register (3rd and 4th form). The default is 0. + + + + + + + + VBoxManage debugvm + uuid|vmname + setregisters + --cpu id + reg-set.reg-name=value + + + Changes register values for guest CPUs and emulated devices. + + + + reg-set.reg-name=value + One of more register assignment, each having one of the following forms: + + register-set.register-name.sub-field=value + register-set.register-name=value + cpu-register-name.sub-field=value + cpu-register-name=value + + The value format should be in the same style as what getregisters + displays, with the exception that both octal and decimal can be used instead of + hexadecimal. + + + + + Selects the CPU register set when specifying just a + CPU register (3rd and 4th form). The default is 0. + + + + + + + + VBoxManage debugvm + uuid|vmname + show + --human-readable--sh-export--sh-eval--cmd-set + settings-item + + + TODO + + + + + + VBoxManage debugvm + uuid|vmname + statistics + --reset + --descriptions + --pattern pattern + + + Displays or resets VMM statistics. + + + Retrieves register values for guest CPUs and emulated devices. + + + + + DOS/NT-style wildcards patterns for selecting statistics. Multiple + patterns can be specified by using the '|' (pipe) character as separator. + + + + + Select reset instead of display mode. + + +