Changeset 56568 in vbox for trunk/doc/manual/en_US
- Timestamp:
- Jun 20, 2015 8:36:01 PM (10 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/doc/manual/en_US/man_VBoxManage-debugvm.xml
r56565 r56568 37 37 <arg choice="req"><replaceable>uuid|vmname</replaceable></arg> 38 38 <arg choice="plain">dumpvmcore</arg> 39 <arg>--filename 39 <arg>--filename=<replaceable>name</replaceable></arg> 40 40 </cmdsynopsis> 41 41 <cmdsynopsis id="synopsis-vboxmanage-debugvm-info"> … … 86 86 <arg choice="req"><replaceable>uuid|vmname</replaceable></arg> 87 87 <arg choice="plain">osdmesg</arg> 88 <arg>--lines 88 <arg>--lines=<replaceable>lines</replaceable></arg> 89 89 </cmdsynopsis> 90 90 <cmdsynopsis id="synopsis-vboxmanage-debugvm-getregisters"> … … 92 92 <arg choice="req"><replaceable>uuid|vmname</replaceable></arg> 93 93 <arg choice="plain">getregisters</arg> 94 <arg>--cpu 94 <arg>--cpu=<replaceable>id</replaceable></arg> 95 95 <arg rep="repeat"><replaceable>reg-set.reg-name</replaceable></arg> 96 96 </cmdsynopsis> … … 99 99 <arg choice="req"><replaceable>uuid|vmname</replaceable></arg> 100 100 <arg choice="plain">setregisters</arg> 101 <arg>--cpu 101 <arg>--cpu=<replaceable>id</replaceable></arg> 102 102 <arg rep="repeat"><replaceable>reg-set.reg-name=value</replaceable></arg> 103 103 </cmdsynopsis> … … 115 115 <arg>--reset</arg> 116 116 <arg>--descriptions</arg> 117 <arg>--pattern 117 <arg>--pattern=<replaceable>pattern</replaceable></arg> 118 118 </cmdsynopsis> 119 119 </refsynopsisdiv> … … 153 153 <variablelist> 154 154 <varlistentry> 155 <term><option>--filename 155 <term><option>--filename=<replaceable>filename</replaceable></option></term> 156 156 <listitem><para>The name of the output file.</para></listitem> 157 157 </varlistentry> … … 204 204 <remark role="help-copy-synopsis"/> 205 205 <para> 206 TODO 206 Changes the group settings for either debug (<option>--debug</option>) 207 or release (<option>--release</option>) logger of the VM process. 208 </para> 209 <para> 210 The <replaceable>group-settings</replaceable> are typically strings on the form 211 <computeroutput>em.e.f.l</computeroutput>, <computeroutput>hm=~0</computeroutput> 212 and <computeroutput>-em.f</computeroutput>. Basic wildcards are supported for 213 group matching. The <computeroutput>all</computeroutput> group is an alias for 214 all the groups. 215 </para> 216 <para> 217 Please do keep in mind that the group settings are applied as modifications 218 to the current ones. 219 </para> 220 <para> 221 This corresponds to the <command>log</command> command in the debugger. 207 222 </para> 208 223 </refsect2> … … 212 227 <remark role="help-copy-synopsis"/> 213 228 <para> 214 TODO 229 Changes the destination settings for either debug (<option>--debug</option>) 230 or release (<option>--release</option>) logger of the VM process. For details 231 on the destination format, the best source is src/VBox/Runtime/common/log/log.cpp. 232 </para> 233 <para> 234 The <replaceable>destinations</replaceable> is one or more mnemonics, optionally 235 prefixed by "no" to disable them. Some of them take values after a ":" or "=" 236 separator. Multiple mnemonics can be separated by space or given as separate 237 arguments on the command line. 238 </para> 239 <para> 240 List of available destination: 241 </para> 242 <variablelist> 243 <varlistentry> 244 <term><option>file[=<replaceable>file</replaceable>], nofile</option></term> 245 <listitem><para>Specifies a log file. It no filname is given, one will be 246 generated based on the current UTC time and VM process name and placed in 247 the current directory of the VM process. Note that this will currently not 248 have any effect if the log file has already been opened. 249 </para></listitem> 250 </varlistentry> 251 <varlistentry> 252 <term><option>dir=<replaceable>directory</replaceable>, nodir</option></term> 253 <listitem><para>Specifies the output directory for log files. Note that this 254 will currently not have any effect if the log file has already been opened. 255 </para></listitem> 256 </varlistentry> 257 <varlistentry> 258 <term><option>history=<replaceable>count</replaceable>, nohistory</option></term> 259 <listitem><para>A non-zero value enables log historization, with the value 260 specifying how many old log files to keep. 261 </para></listitem> 262 </varlistentry> 263 <varlistentry> 264 <term><option>histsize=<replaceable>bytes</replaceable></option></term> 265 <listitem><para>The max size of a log file before it is historized. Default is infinite.</para></listitem> 266 </varlistentry> 267 <varlistentry> 268 <term><option>histtime=<replaceable>seconds</replaceable></option></term> 269 <listitem><para>The max age (in seconds) of a log file before it is historized. Default is infinite.</para></listitem> 270 </varlistentry> 271 <varlistentry> 272 <term><option>ringbuffer, noringbuffer</option></term> 273 <listitem><para>Only log to the log buffer until an explicit flush (e.g. via an assertion) 274 occurs. This is fast and saves diskspace.</para></listitem> 275 </varlistentry> 276 <varlistentry> 277 <term><option>stdout, nostdout</option></term> 278 <listitem><para>Write the log content to standard output.</para></listitem> 279 </varlistentry> 280 <varlistentry> 281 <term><option>stdout, nostdout</option></term> 282 <listitem><para>Write the log content to standard error.</para></listitem> 283 </varlistentry> 284 <varlistentry> 285 <term><option>debugger, nodebugger</option></term> 286 <listitem><para>Write the log content to the debugger, if supported by the host OS.</para></listitem> 287 </varlistentry> 288 <varlistentry> 289 <term><option>com, nocom</option></term> 290 <listitem><para>Writes logging to the COM port. This is only applicable for raw-mode and ring-0 logging.</para></listitem> 291 </varlistentry> 292 <varlistentry> 293 <term><option>user, nouser</option></term> 294 <listitem><para>Custom destination which has no meaning to VM processes..</para></listitem> 295 </varlistentry> 296 </variablelist> 297 <para> 298 This corresponds to the <command>logdest</command> command in the debugger. 215 299 </para> 216 300 </refsect2> … … 220 304 <remark role="help-copy-synopsis"/> 221 305 <para> 222 TODO 306 Changes the flags on either debug (<option>--debug</option>) or release 307 (<option>--release</option>) logger of the VM process. Please note that the 308 modifications are applied onto the existing changes, they are not replacing them. 309 </para> 310 <para> 311 The <replaceable>flags</replaceable> are a list of flag mnemonics, optionally 312 prefixed by a "no", "!", "~" or "-" to negate their meaning. The "+" prefix 313 can be used to undo previous negation or use as a separator, though better use 314 whitespace or separate arguments for that. 315 </para> 316 <para> 317 List of log flag mnemonics, with their counter form where applicable 318 (asterisk indicates defaults): 319 </para> 320 <variablelist> 321 <varlistentry> 322 <term><option>enabled*, disabled</option></term> 323 <listitem><para>Enables or disables logging.</para></listitem> 324 </varlistentry> 325 <varlistentry> 326 <term><option>buffered, unbuffered*</option></term> 327 <listitem><para>Enabling buffering of log output before it hits the destinations.</para></listitem> 328 </varlistentry> 329 <varlistentry> 330 <term><option>writethrough(/writethru)</option></term> 331 <listitem><para>Whether to open the destination file with writethru buffering settings or not.</para></listitem> 332 </varlistentry> 333 <varlistentry> 334 <term><option>flush</option></term> 335 <listitem><para>Enables flushing of the output file (to disk) after each log statement.</para></listitem> 336 </varlistentry> 337 <!-- Prefixes --> 338 <varlistentry> 339 <term><option>lockcnts</option></term> 340 <listitem><para>Prefix each log line with lock counts for the current thread.</para></listitem> 341 </varlistentry> 342 <varlistentry> 343 <term><option>cpuid</option></term> 344 <listitem><para>Prefix each log line with the ID of the current CPU.</para></listitem> 345 </varlistentry> 346 <varlistentry> 347 <term><option>pid</option></term> 348 <listitem><para>Prefix each log line with the current process ID.</para></listitem> 349 </varlistentry> 350 <varlistentry> 351 <term><option>flagno</option></term> 352 <listitem><para>Prefix each log line with the numberic flags corresponding to the log statement.</para></listitem> 353 </varlistentry> 354 <varlistentry> 355 <term><option>flag</option></term> 356 <listitem><para>Prefix each log line with the flag mnemonics corresponding to the log statement.</para></listitem> 357 </varlistentry> 358 <varlistentry> 359 <term><option>groupno</option></term> 360 <listitem><para>Prefix each log line with the log group number for the log statement producing it.</para></listitem> 361 </varlistentry> 362 <varlistentry> 363 <term><option>group</option></term> 364 <listitem><para>Prefix each log line with the log group name for the log statement producing it.</para></listitem> 365 </varlistentry> 366 <varlistentry> 367 <term><option>tid</option></term> 368 <listitem><para>Prefix each log line with the current thread identifier.</para></listitem> 369 </varlistentry> 370 <varlistentry> 371 <term><option>thread</option></term> 372 <listitem><para>Prefix each log line with the current thread name.</para></listitem> 373 </varlistentry> 374 <varlistentry> 375 <term><option>time</option></term> 376 <listitem><para>Prefix each log line with the current UTC wall time.</para></listitem> 377 </varlistentry> 378 <varlistentry> 379 <term><option>timeprog</option></term> 380 <listitem><para>Prefix each log line with the current monotonic time since the start of the program.</para></listitem> 381 </varlistentry> 382 <varlistentry> 383 <term><option>msprog</option></term> 384 <listitem><para>Prefix each log line with the current monotonic timestamp value in milliseconds since the start of the program.</para></listitem> 385 </varlistentry> 386 <varlistentry> 387 <term><option>ts</option></term> 388 <listitem><para>Prefix each log line with the current monotonic timestamp value in nanoseconds.</para></listitem> 389 </varlistentry> 390 <varlistentry> 391 <term><option>tsc</option></term> 392 <listitem><para>Prefix each log line with the current CPU timestamp counter (TSC) value.</para></listitem> 393 </varlistentry> 394 <varlistentry> 395 <term><option>rel, abs*</option></term> 396 <listitem><para>Selects the whether <computeroutput>ts</computeroutput> and 397 <computeroutput>tsc</computeroutput> prefixes should be displayed as relative to the 398 previous log line or as absolute time.</para></listitem> 399 </varlistentry> 400 <varlistentry> 401 <term><option>hex*, dec</option></term> 402 <listitem><para>Selects the whether the <computeroutput>ts</computeroutput> and 403 <computeroutput>tsc</computeroutput> prefixes should be formatted as hexadecimal 404 or decimal.</para></listitem> 405 </varlistentry> 406 407 <!-- Suffixes and weird stuff. --> 408 <varlistentry> 409 <term><option>custom</option></term> 410 <listitem><para>Custom log prefix, has by default no meaning for VM processes.</para></listitem> 411 </varlistentry> 412 413 <varlistentry> 414 <term><option>usecrlf, uself*</option></term> 415 <listitem><para>Output with DOS style (CRLF) or just UNIX style (LF) line endings.</para></listitem> 416 </varlistentry> 417 <varlistentry> 418 <term><option>overwrite*, append</option></term> 419 <listitem><para>Overwrite the destination file or append to it.</para></listitem> 420 </varlistentry> 421 </variablelist> 422 423 <para> 424 This corresponds to the <command>logflags</command> command in the debugger. 223 425 </para> 224 426 </refsect2> … … 253 455 <variablelist> 254 456 <varlistentry> 255 <term><option>--lines 457 <term><option>--lines=<replaceable>lines</replaceable></option></term> 256 458 <listitem><para>Number of lines of the log to display, counting from 257 459 the end. The default is infinite.</para></listitem> … … 271 473 <listitem> 272 474 <para>One of more registers, each having one of the following forms:</para> 273 < itemizedlist>274 <listitem><para> <replaceable>register-set.register-name.sub-field</replaceable></para></listitem>275 <listitem><para> <replaceable>register-set.register-name</replaceable></para></listitem>276 <listitem><para> <replaceable>cpu-register-name.sub-field</replaceable></para></listitem>277 <listitem><para> <replaceable>cpu-register-name</replaceable></para></listitem>278 <listitem><para> <replaceable>all</replaceable></para></listitem>279 </ itemizedlist>475 <orderedlist> 476 <listitem><para>register-set.register-name.sub-field</para></listitem> 477 <listitem><para>register-set.register-name</para></listitem> 478 <listitem><para>cpu-register-name.sub-field</para></listitem> 479 <listitem><para>cpu-register-name</para></listitem> 480 <listitem><para>all</para></listitem> 481 </orderedlist> 280 482 <para>The <replaceable>all</replaceable> form will cause all registers 281 483 to be shown (no sub-fields). The registers names are case-insensitive. … … 284 486 </varlistentry> 285 487 <varlistentry> 488 <term><option>--cpu=<replaceable>id</replaceable></option></term> 489 <listitem><para>Selects the CPU register set when specifying just a 490 CPU register (3rd and 4th form). The default is 0.</para> 491 </listitem> 492 </varlistentry> 493 </variablelist> 494 </refsect2> 495 496 <refsect2 id="vboxmanage-debugvm-setregisters"> 497 <title>debugvm setregisters</title> 498 <remark role="help-copy-synopsis"/> 499 <para> 500 Changes register values for guest CPUs and emulated devices. 501 </para> 502 <variablelist> 503 <varlistentry> 504 <term><replaceable>reg-set.reg-name=value</replaceable></term> 505 <listitem> 506 <para>One of more register assignment, each having one of the following forms:</para> 507 <orderedlist> 508 <listitem><para>register-set.register-name.sub-field=value</para></listitem> 509 <listitem><para>register-set.register-name=value</para></listitem> 510 <listitem><para>cpu-register-name.sub-field=value</para></listitem> 511 <listitem><para>cpu-register-name=value</para></listitem> 512 </orderedlist> 513 <para>The value format should be in the same style as what 514 <command>getregisters</command> displays, with the exception that 515 both octal and decimal can be used instead of hexadecimal.</para> 516 </listitem> 517 </varlistentry> 518 <varlistentry> 286 519 <term><option>--cpu <replaceable>id</replaceable></option></term> 287 520 <listitem><para>Selects the CPU register set when specifying just a … … 292 525 </refsect2> 293 526 294 <refsect2 id="vboxmanage-debugvm-setregisters">295 <title>debugvm setregisters</title>296 <remark role="help-copy-synopsis"/>297 <para>298 Changes register values for guest CPUs and emulated devices.299 </para>300 <variablelist>301 <varlistentry>302 <term><replaceable>reg-set.reg-name=value</replaceable></term>303 <listitem>304 <para>One of more register assignment, each having one of the following forms:</para>305 <itemizedlist>306 <listitem><para><replaceable>register-set.register-name.sub-field=value</replaceable></para></listitem>307 <listitem><para><replaceable>register-set.register-name=value</replaceable></para></listitem>308 <listitem><para><replaceable>cpu-register-name.sub-field=value</replaceable></para></listitem>309 <listitem><para><replaceable>cpu-register-name=value</replaceable></para></listitem>310 </itemizedlist>311 <para>The value format should be in the same style as what312 <command>getregisters</command> displays, with the exception that313 both octal and decimal can be used instead of hexadecimal.</para>314 </listitem>315 </varlistentry>316 <varlistentry>317 <term><option>--cpu <replaceable>id</replaceable></option></term>318 <listitem><para>Selects the CPU register set when specifying just a319 CPU register (3rd and 4th form). The default is 0.</para>320 </listitem>321 </varlistentry>322 </variablelist>323 </refsect2>324 325 527 <refsect2 id="vboxmanage-debugvm-show"> 326 528 <title>debugvm show</title> 327 529 <remark role="help-copy-synopsis"/> 328 530 <para> 329 TODO 330 </para> 531 Shows logging settings for the VM. 532 </para> 533 <variablelist> 534 <varlistentry> 535 <term><option>--human-readable</option></term> 536 <listitem><para>Selects human readable output.</para></listitem> 537 </varlistentry> 538 <varlistentry> 539 <term><option>--sh-export</option></term> 540 <listitem><para>Selects output format as bourne shell style <command>export</command> commands.</para></listitem> 541 </varlistentry> 542 <varlistentry> 543 <term><option>--sh-eval</option></term> 544 <listitem><para>Selects output format as bourne shell style <command>eval</command> command input.</para></listitem> 545 </varlistentry> 546 <varlistentry> 547 <term><option>--cmd-set</option></term> 548 <listitem><para>Selects output format as DOS style <command>SET</command> commands.</para></listitem> 549 </varlistentry> 550 <varlistentry> 551 <term><replaceable>settings-item</replaceable></term> 552 <listitem> 553 <para>What to display. One or more of the following:</para> 554 <itemizedlist> 555 <listitem><para>logdbg-settings - debug log settings.</para></listitem> 556 <listitem><para>logrel-settings - release log settings.</para></listitem> 557 <listitem><para>log-settings - alias for both debug and release log settings.</para></listitem> 558 </itemizedlist> 559 </listitem> 560 </varlistentry> 561 </variablelist> 562 331 563 </refsect2> 332 564 … … 342 574 <variablelist> 343 575 <varlistentry> 344 <term><option>--pattern 576 <term><option>--pattern=<replaceable>pattern</replaceable></option></term> 345 577 <listitem><para>DOS/NT-style wildcards patterns for selecting statistics. Multiple 346 578 patterns can be specified by using the '|' (pipe) character as separator.</para>
Note:
See TracChangeset
for help on using the changeset viewer.
