hmp-commands.hx

   1 HXCOMM Use DEFHEADING() to define headings in both help text and texi
   2 HXCOMM Text between STEXI and ETEXI are copied to texi version and
   3 HXCOMM discarded from C version
   4 HXCOMM DEF(command, args, callback, arg_string, help) is used to construct
   5 HXCOMM monitor commands
   6 HXCOMM HXCOMM can be used for comments, discarded from both texi and C
   7
   8 STEXI
   9 @table @option
  10 ETEXI
  11
  12     {
  13         .name       = "help|?",
  14         .args_type  = "name:s?",
  15         .params     = "[cmd]",
  16         .help       = "show the help",
  17         .mhandler.cmd = do_help_cmd,
  18     },
  19
  20 STEXI
  21 @item help or ? [@var{cmd}]
  22 @findex help
  23 Show the help for all commands or just for command @var{cmd}.
  24 ETEXI
  25
  26     {
  27         .name       = "commit",
  28         .args_type  = "device:B",
  29         .params     = "device|all",
  30         .help       = "commit changes to the disk images (if -snapshot is used) or backing files",
  31         .mhandler.cmd = do_commit,
  32     },
  33
  34 STEXI
  35 @item commit
  36 @findex commit
  37 Commit changes to the disk images (if -snapshot is used) or backing files.
  38 ETEXI
  39
  40     {
  41         .name       = "q|quit",
  42         .args_type  = "",
  43         .params     = "",
  44         .help       = "quit the emulator",
  45         .user_print = monitor_user_noop,
  46         .mhandler.cmd_new = do_quit,
  47     },
  48
  49 STEXI
  50 @item q or quit
  51 @findex quit
  52 Quit the emulator.
  53 ETEXI
  54
  55     {
  56         .name       = "eject",
  57         .args_type  = "force:-f,device:B",
  58         .params     = "[-f] device",
  59         .help       = "eject a removable medium (use -f to force it)",
  60         .user_print = monitor_user_noop,
  61         .mhandler.cmd_new = do_eject,
  62     },
  63
  64 STEXI
  65 @item eject [-f] @var{device}
  66 @findex eject
  67 Eject a removable medium (use -f to force it).
  68 ETEXI
  69
  70     {
  71         .name       = "change",
  72         .args_type  = "device:B,target:F,arg:s?",
  73         .params     = "device filename [format]",
  74         .help       = "change a removable medium, optional format",
  75         .user_print = monitor_user_noop,
  76         .mhandler.cmd_new = do_change,
  77     },
  78
  79 STEXI
  80 @item change @var{device} @var{setting}
  81 @findex change
  82
  83 Change the configuration of a device.
  84
  85 @table @option
  86 @item change @var{diskdevice} @var{filename} [@var{format}]
  87 Change the medium for a removable disk device to point to @var{filename}. eg
  88
  89 @example
  90 (qemu) change ide1-cd0 /path/to/some.iso
  91 @end example
  92
  93 @var{format} is optional.
  94
  95 @item change vnc @var{display},@var{options}
  96 Change the configuration of the VNC server. The valid syntax for @var{display}
  97 and @var{options} are described at @ref{sec_invocation}. eg
  98
  99 @example
 100 (qemu) change vnc localhost:1
 101 @end example
 102
 103 @item change vnc password [@var{password}]
 104
 105 Change the password associated with the VNC server. If the new password is not
 106 supplied, the monitor will prompt for it to be entered. VNC passwords are only
 107 significant up to 8 letters. eg
 108
 109 @example
 110 (qemu) change vnc password
 111 Password: ********
 112 @end example
 113
 114 @end table
 115 ETEXI
 116
 117     {
 118         .name       = "screendump",
 119         .args_type  = "filename:F",
 120         .params     = "filename",
 121         .help       = "save screen into PPM image 'filename'",
 122         .user_print = monitor_user_noop,
 123         .mhandler.cmd_new = do_screen_dump,
 124     },
 125
 126 STEXI
 127 @item screendump @var{filename}
 128 @findex screendump
 129 Save screen into PPM image @var{filename}.
 130 ETEXI
 131
 132     {
 133         .name       = "logfile",
 134         .args_type  = "filename:F",
 135         .params     = "filename",
 136         .help       = "output logs to 'filename'",
 137         .mhandler.cmd = do_logfile,
 138     },
 139
 140 STEXI
 141 @item logfile @var{filename}
 142 @findex logfile
 143 Output logs to @var{filename}.
 144 ETEXI
 145
 146 #ifdef CONFIG_SIMPLE_TRACE
 147     {
 148         .name       = "trace-event",
 149         .args_type  = "name:s,option:b",
 150         .params     = "name on|off",
 151         .help       = "changes status of a specific trace event",
 152         .mhandler.cmd = do_change_trace_event_state,
 153     },
 154
 155 STEXI
 156 @item trace-event
 157 @findex trace-event
 158 changes status of a trace event
 159 ETEXI
 160
 161     {
 162         .name       = "trace-file",
 163         .args_type  = "op:s?,arg:F?",
 164         .params     = "on|off|flush|set [arg]",
 165         .help       = "open, close, or flush trace file, or set a new file name",
 166         .mhandler.cmd = do_trace_file,
 167     },
 168
 169 STEXI
 170 @item trace-file on|off|flush
 171 @findex trace-file
 172 Open, close, or flush the trace file.  If no argument is given, the status of the trace file is displayed.
 173 ETEXI
 174 #endif
 175
 176     {
 177         .name       = "log",
 178         .args_type  = "items:s",
 179         .params     = "item1[,...]",
 180         .help       = "activate logging of the specified items to '/tmp/qemu.log'",
 181         .mhandler.cmd = do_log,
 182     },
 183
 184 STEXI
 185 @item log @var{item1}[,...]
 186 @findex log
 187 Activate logging of the specified items to @file{/tmp/qemu.log}.
 188 ETEXI
 189
 190     {
 191         .name       = "savevm",
 192         .args_type  = "name:s?",
 193         .params     = "[tag|id]",
 194         .help       = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
 195         .mhandler.cmd = do_savevm,
 196     },
 197
 198 STEXI
 199 @item savevm [@var{tag}|@var{id}]
 200 @findex savevm
 201 Create a snapshot of the whole virtual machine. If @var{tag} is
 202 provided, it is used as human readable identifier. If there is already
 203 a snapshot with the same tag or ID, it is replaced. More info at
 204 @ref{vm_snapshots}.
 205 ETEXI
 206
 207     {
 208         .name       = "loadvm",
 209         .args_type  = "name:s",
 210         .params     = "tag|id",
 211         .help       = "restore a VM snapshot from its tag or id",
 212         .mhandler.cmd = do_loadvm,
 213     },
 214
 215 STEXI
 216 @item loadvm @var{tag}|@var{id}
 217 @findex loadvm
 218 Set the whole virtual machine to the snapshot identified by the tag
 219 @var{tag} or the unique snapshot ID @var{id}.
 220 ETEXI
 221
 222     {
 223         .name       = "delvm",
 224         .args_type  = "name:s",
 225         .params     = "tag|id",
 226         .help       = "delete a VM snapshot from its tag or id",
 227         .mhandler.cmd = do_delvm,
 228     },
 229
 230 STEXI
 231 @item delvm @var{tag}|@var{id}
 232 @findex delvm
 233 Delete the snapshot identified by @var{tag} or @var{id}.
 234 ETEXI
 235
 236     {
 237         .name       = "singlestep",
 238         .args_type  = "option:s?",
 239         .params     = "[on|off]",
 240         .help       = "run emulation in singlestep mode or switch to normal mode",
 241         .mhandler.cmd = do_singlestep,
 242     },
 243
 244 STEXI
 245 @item singlestep [off]
 246 @findex singlestep
 247 Run the emulation in single step mode.
 248 If called with option off, the emulation returns to normal mode.
 249 ETEXI
 250
 251     {
 252         .name       = "stop",
 253         .args_type  = "",
 254         .params     = "",
 255         .help       = "stop emulation",
 256         .user_print = monitor_user_noop,
 257         .mhandler.cmd_new = do_stop,
 258     },
 259
 260 STEXI
 261 @item stop
 262 @findex stop
 263 Stop emulation.
 264 ETEXI
 265
 266     {
 267         .name       = "c|cont",
 268         .args_type  = "",
 269         .params     = "",
 270         .help       = "resume emulation",
 271         .user_print = monitor_user_noop,
 272         .mhandler.cmd_new = do_cont,
 273     },
 274
 275 STEXI
 276 @item c or cont
 277 @findex cont
 278 Resume emulation.
 279 ETEXI
 280
 281     {
 282         .name       = "gdbserver",
 283         .args_type  = "device:s?",
 284         .params     = "[device]",
 285         .help       = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
 286         .mhandler.cmd = do_gdbserver,
 287     },
 288
 289 STEXI
 290 @item gdbserver [@var{port}]
 291 @findex gdbserver
 292 Start gdbserver session (default @var{port}=1234)
 293 ETEXI
 294
 295     {
 296         .name       = "x",
 297         .args_type  = "fmt:/,addr:l",
 298         .params     = "/fmt addr",
 299         .help       = "virtual memory dump starting at 'addr'",
 300         .mhandler.cmd = do_memory_dump,
 301     },
 302
 303 STEXI
 304 @item x/fmt @var{addr}
 305 @findex x
 306 Virtual memory dump starting at @var{addr}.
 307 ETEXI
 308
 309     {
 310         .name       = "xp",
 311         .args_type  = "fmt:/,addr:l",
 312         .params     = "/fmt addr",
 313         .help       = "physical memory dump starting at 'addr'",
 314         .mhandler.cmd = do_physical_memory_dump,
 315     },
 316
 317 STEXI
 318 @item xp /@var{fmt} @var{addr}
 319 @findex xp
 320 Physical memory dump starting at @var{addr}.
 321
 322 @var{fmt} is a format which tells the command how to format the
 323 data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
 324
 325 @table @var
 326 @item count
 327 is the number of items to be dumped.
 328
 329 @item format
 330 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
 331 c (char) or i (asm instruction).
 332
 333 @item size
 334 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
 335 @code{h} or @code{w} can be specified with the @code{i} format to
 336 respectively select 16 or 32 bit code instruction size.
 337
 338 @end table
 339
 340 Examples:
 341 @itemize
 342 @item
 343 Dump 10 instructions at the current instruction pointer:
 344 @example
 345 (qemu) x/10i $eip
 346 0x90107063:  ret
 347 0x90107064:  sti
 348 0x90107065:  lea    0x0(%esi,1),%esi
 349 0x90107069:  lea    0x0(%edi,1),%edi
 350 0x90107070:  ret
 351 0x90107071:  jmp    0x90107080
 352 0x90107073:  nop
 353 0x90107074:  nop
 354 0x90107075:  nop
 355 0x90107076:  nop
 356 @end example
 357
 358 @item
 359 Dump 80 16 bit values at the start of the video memory.
 360 @smallexample
 361 (qemu) xp/80hx 0xb8000
 362 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
 363 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
 364 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
 365 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
 366 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
 367 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
 368 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
 369 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
 370 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
 371 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
 372 @end smallexample
 373 @end itemize
 374 ETEXI
 375
 376     {
 377         .name       = "p|print",
 378         .args_type  = "fmt:/,val:l",
 379         .params     = "/fmt expr",
 380         .help       = "print expression value (use $reg for CPU register access)",
 381         .mhandler.cmd = do_print,
 382     },
 383
 384 STEXI
 385 @item p or print/@var{fmt} @var{expr}
 386 @findex print
 387
 388 Print expression value. Only the @var{format} part of @var{fmt} is
 389 used.
 390 ETEXI
 391
 392     {
 393         .name       = "i",
 394         .args_type  = "fmt:/,addr:i,index:i.",
 395         .params     = "/fmt addr",
 396         .help       = "I/O port read",
 397         .mhandler.cmd = do_ioport_read,
 398     },
 399
 400 STEXI
 401 Read I/O port.
 402 ETEXI
 403
 404     {
 405         .name       = "o",
 406         .args_type  = "fmt:/,addr:i,val:i",
 407         .params     = "/fmt addr value",
 408         .help       = "I/O port write",
 409         .mhandler.cmd = do_ioport_write,
 410     },
 411
 412 STEXI
 413 Write to I/O port.
 414 ETEXI
 415
 416     {
 417         .name       = "sendkey",
 418         .args_type  = "string:s,hold_time:i?",
 419         .params     = "keys [hold_ms]",
 420         .help       = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
 421         .mhandler.cmd = do_sendkey,
 422     },
 423
 424 STEXI
 425 @item sendkey @var{keys}
 426 @findex sendkey
 427
 428 Send @var{keys} to the emulator. @var{keys} could be the name of the
 429 key or @code{#} followed by the raw value in either decimal or hexadecimal
 430 format. Use @code{-} to press several keys simultaneously. Example:
 431 @example
 432 sendkey ctrl-alt-f1
 433 @end example
 434
 435 This command is useful to send keys that your graphical user interface
 436 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
 437 ETEXI
 438
 439     {
 440         .name       = "system_reset",
 441         .args_type  = "",
 442         .params     = "",
 443         .help       = "reset the system",
 444         .user_print = monitor_user_noop,
 445         .mhandler.cmd_new = do_system_reset,
 446     },
 447
 448 STEXI
 449 @item system_reset
 450 @findex system_reset
 451
 452 Reset the system.
 453 ETEXI
 454
 455     {
 456         .name       = "system_powerdown",
 457         .args_type  = "",
 458         .params     = "",
 459         .help       = "send system power down event",
 460         .user_print = monitor_user_noop,
 461         .mhandler.cmd_new = do_system_powerdown,
 462     },
 463
 464 STEXI
 465 @item system_powerdown
 466 @findex system_powerdown
 467
 468 Power down the system (if supported).
 469 ETEXI
 470
 471     {
 472         .name       = "sum",
 473         .args_type  = "start:i,size:i",
 474         .params     = "addr size",
 475         .help       = "compute the checksum of a memory region",
 476         .mhandler.cmd = do_sum,
 477     },
 478
 479 STEXI
 480 @item sum @var{addr} @var{size}
 481 @findex sum
 482
 483 Compute the checksum of a memory region.
 484 ETEXI
 485
 486     {
 487         .name       = "usb_add",
 488         .args_type  = "devname:s",
 489         .params     = "device",
 490         .help       = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
 491         .mhandler.cmd = do_usb_add,
 492     },
 493
 494 STEXI
 495 @item usb_add @var{devname}
 496 @findex usb_add
 497
 498 Add the USB device @var{devname}.  For details of available devices see
 499 @ref{usb_devices}
 500 ETEXI
 501
 502     {
 503         .name       = "usb_del",
 504         .args_type  = "devname:s",
 505         .params     = "device",
 506         .help       = "remove USB device 'bus.addr'",
 507         .mhandler.cmd = do_usb_del,
 508     },
 509
 510 STEXI
 511 @item usb_del @var{devname}
 512 @findex usb_del
 513
 514 Remove the USB device @var{devname} from the QEMU virtual USB
 515 hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
 516 command @code{info usb} to see the devices you can remove.
 517 ETEXI
 518
 519     {
 520         .name       = "device_add",
 521         .args_type  = "device:O",
 522         .params     = "driver[,prop=value][,...]",
 523         .help       = "add device, like -device on the command line",
 524         .user_print = monitor_user_noop,
 525         .mhandler.cmd_new = do_device_add,
 526     },
 527
 528 STEXI
 529 @item device_add @var{config}
 530 @findex device_add
 531
 532 Add device.
 533 ETEXI
 534
 535     {
 536         .name       = "device_del",
 537         .args_type  = "id:s",
 538         .params     = "device",
 539         .help       = "remove device",
 540         .user_print = monitor_user_noop,
 541         .mhandler.cmd_new = do_device_del,
 542     },
 543
 544 STEXI
 545 @item device_del @var{id}
 546 @findex device_del
 547
 548 Remove device @var{id}.
 549 ETEXI
 550
 551     {
 552         .name       = "cpu",
 553         .args_type  = "index:i",
 554         .params     = "index",
 555         .help       = "set the default CPU",
 556         .user_print = monitor_user_noop,
 557         .mhandler.cmd_new = do_cpu_set,
 558     },
 559
 560 STEXI
 561 @item cpu @var{index}
 562 @findex cpu
 563 Set the default CPU.
 564 ETEXI
 565
 566     {
 567         .name       = "mouse_move",
 568         .args_type  = "dx_str:s,dy_str:s,dz_str:s?",
 569         .params     = "dx dy [dz]",
 570         .help       = "send mouse move events",
 571         .mhandler.cmd = do_mouse_move,
 572     },
 573
 574 STEXI
 575 @item mouse_move @var{dx} @var{dy} [@var{dz}]
 576 @findex mouse_move
 577 Move the active mouse to the specified coordinates @var{dx} @var{dy}
 578 with optional scroll axis @var{dz}.
 579 ETEXI
 580
 581     {
 582         .name       = "mouse_button",
 583         .args_type  = "button_state:i",
 584         .params     = "state",
 585         .help       = "change mouse button state (1=L, 2=M, 4=R)",
 586         .mhandler.cmd = do_mouse_button,
 587     },
 588
 589 STEXI
 590 @item mouse_button @var{val}
 591 @findex mouse_button
 592 Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
 593 ETEXI
 594
 595     {
 596         .name       = "mouse_set",
 597         .args_type  = "index:i",
 598         .params     = "index",
 599         .help       = "set which mouse device receives events",
 600         .mhandler.cmd = do_mouse_set,
 601     },
 602
 603 STEXI
 604 @item mouse_set @var{index}
 605 @findex mouse_set
 606 Set which mouse device receives events at given @var{index}, index
 607 can be obtained with
 608 @example
 609 info mice
 610 @end example
 611 ETEXI
 612
 613 #ifdef HAS_AUDIO
 614     {
 615         .name       = "wavcapture",
 616         .args_type  = "path:F,freq:i?,bits:i?,nchannels:i?",
 617         .params     = "path [frequency [bits [channels]]]",
 618         .help       = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
 619         .mhandler.cmd = do_wav_capture,
 620     },
 621 #endif
 622 STEXI
 623 @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
 624 @findex wavcapture
 625 Capture audio into @var{filename}. Using sample rate @var{frequency}
 626 bits per sample @var{bits} and number of channels @var{channels}.
 627
 628 Defaults:
 629 @itemize @minus
 630 @item Sample rate = 44100 Hz - CD quality
 631 @item Bits = 16
 632 @item Number of channels = 2 - Stereo
 633 @end itemize
 634 ETEXI
 635
 636 #ifdef HAS_AUDIO
 637     {
 638         .name       = "stopcapture",
 639         .args_type  = "n:i",
 640         .params     = "capture index",
 641         .help       = "stop capture",
 642         .mhandler.cmd = do_stop_capture,
 643     },
 644 #endif
 645 STEXI
 646 @item stopcapture @var{index}
 647 @findex stopcapture
 648 Stop capture with a given @var{index}, index can be obtained with
 649 @example
 650 info capture
 651 @end example
 652 ETEXI
 653
 654     {
 655         .name       = "memsave",
 656         .args_type  = "val:l,size:i,filename:s",
 657         .params     = "addr size file",
 658         .help       = "save to disk virtual memory dump starting at 'addr' of size 'size'",
 659         .user_print = monitor_user_noop,
 660         .mhandler.cmd_new = do_memory_save,
 661     },
 662
 663 STEXI
 664 @item memsave @var{addr} @var{size} @var{file}
 665 @findex memsave
 666 save to disk virtual memory dump starting at @var{addr} of size @var{size}.
 667 ETEXI
 668
 669     {
 670         .name       = "pmemsave",
 671         .args_type  = "val:l,size:i,filename:s",
 672         .params     = "addr size file",
 673         .help       = "save to disk physical memory dump starting at 'addr' of size 'size'",
 674         .user_print = monitor_user_noop,
 675         .mhandler.cmd_new = do_physical_memory_save,
 676     },
 677
 678 STEXI
 679 @item pmemsave @var{addr} @var{size} @var{file}
 680 @findex pmemsave
 681 save to disk physical memory dump starting at @var{addr} of size @var{size}.
 682 ETEXI
 683
 684     {
 685         .name       = "boot_set",
 686         .args_type  = "bootdevice:s",
 687         .params     = "bootdevice",
 688         .help       = "define new values for the boot device list",
 689         .mhandler.cmd = do_boot_set,
 690     },
 691
 692 STEXI
 693 @item boot_set @var{bootdevicelist}
 694 @findex boot_set
 695
 696 Define new values for the boot device list. Those values will override
 697 the values specified on the command line through the @code{-boot} option.
 698
 699 The values that can be specified here depend on the machine type, but are
 700 the same that can be specified in the @code{-boot} command line option.
 701 ETEXI
 702
 703 #if defined(TARGET_I386)
 704     {
 705         .name       = "nmi",
 706         .args_type  = "cpu_index:i",
 707         .params     = "cpu",
 708         .help       = "inject an NMI on the given CPU",
 709         .mhandler.cmd = do_inject_nmi,
 710     },
 711 #endif
 712 STEXI
 713 @item nmi @var{cpu}
 714 @findex nmi
 715 Inject an NMI on the given CPU (x86 only).
 716 ETEXI
 717
 718     {
 719         .name       = "migrate",
 720         .args_type  = "detach:-d,blk:-b,inc:-i,uri:s",
 721         .params     = "[-d] [-b] [-i] uri",
 722         .help       = "migrate to URI (using -d to not wait for completion)"
 723                       "\n\t\t\t -b for migration without shared storage with"
 724                       " full copy of disk\n\t\t\t -i for migration without "
 725                       "shared storage with incremental copy of disk "
 726                       "(base image shared between src and destination)",
 727         .user_print = monitor_user_noop,
 728         .mhandler.cmd_new = do_migrate,
 729     },
 730
 731
 732 STEXI
 733 @item migrate [-d] [-b] [-i] @var{uri}
 734 @findex migrate
 735 Migrate to @var{uri} (using -d to not wait for completion).
 736         -b for migration with full copy of disk
 737         -i for migration with incremental copy of disk (base image is shared)
 738 ETEXI
 739
 740     {
 741         .name       = "migrate_cancel",
 742         .args_type  = "",
 743         .params     = "",
 744         .help       = "cancel the current VM migration",
 745         .user_print = monitor_user_noop,
 746         .mhandler.cmd_new = do_migrate_cancel,
 747     },
 748
 749 STEXI
 750 @item migrate_cancel
 751 @findex migrate_cancel
 752 Cancel the current VM migration.
 753 ETEXI
 754
 755     {
 756         .name       = "migrate_set_speed",
 757         .args_type  = "value:o",
 758         .params     = "value",
 759         .help       = "set maximum speed (in bytes) for migrations. "
 760         "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
 761         .user_print = monitor_user_noop,
 762         .mhandler.cmd_new = do_migrate_set_speed,
 763     },
 764
 765 STEXI
 766 @item migrate_set_speed @var{value}
 767 @findex migrate_set_speed
 768 Set maximum speed to @var{value} (in bytes) for migrations.
 769 ETEXI
 770
 771     {
 772         .name       = "migrate_set_downtime",
 773         .args_type  = "value:T",
 774         .params     = "value",
 775         .help       = "set maximum tolerated downtime (in seconds) for migrations",
 776         .user_print = monitor_user_noop,
 777         .mhandler.cmd_new = do_migrate_set_downtime,
 778     },
 779
 780 STEXI
 781 @item migrate_set_downtime @var{second}
 782 @findex migrate_set_downtime
 783 Set maximum tolerated downtime (in seconds) for migration.
 784 ETEXI
 785
 786 #if defined(TARGET_I386)
 787     {
 788         .name       = "drive_add",
 789         .args_type  = "pci_addr:s,opts:s",
 790         .params     = "[[<domain>:]<bus>:]<slot>\n"
 791                       "[file=file][,if=type][,bus=n]\n"
 792                       "[,unit=m][,media=d][index=i]\n"
 793                       "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
 794                       "[snapshot=on|off][,cache=on|off]",
 795         .help       = "add drive to PCI storage controller",
 796         .mhandler.cmd = drive_hot_add,
 797     },
 798 #endif
 799
 800 STEXI
 801 @item drive_add
 802 @findex drive_add
 803 Add drive to PCI storage controller.
 804 ETEXI
 805
 806 #if defined(TARGET_I386)
 807     {
 808         .name       = "pci_add",
 809         .args_type  = "pci_addr:s,type:s,opts:s?",
 810         .params     = "auto|[[<domain>:]<bus>:]<slot> nic|storage [[vlan=n][,macaddr=addr][,model=type]] [file=file][,if=type][,bus=nr]...",
 811         .help       = "hot-add PCI device",
 812         .mhandler.cmd = pci_device_hot_add,
 813     },
 814 #endif
 815
 816 STEXI
 817 @item pci_add
 818 @findex pci_add
 819 Hot-add PCI device.
 820 ETEXI
 821
 822 #if defined(TARGET_I386)
 823     {
 824         .name       = "pci_del",
 825         .args_type  = "pci_addr:s",
 826         .params     = "[[<domain>:]<bus>:]<slot>",
 827         .help       = "hot remove PCI device",
 828         .mhandler.cmd = do_pci_device_hot_remove,
 829     },
 830 #endif
 831
 832 STEXI
 833 @item pci_del
 834 @findex pci_del
 835 Hot remove PCI device.
 836 ETEXI
 837
 838     {
 839         .name       = "host_net_add",
 840         .args_type  = "device:s,opts:s?",
 841         .params     = "tap|user|socket|vde|dump [options]",
 842         .help       = "add host VLAN client",
 843         .mhandler.cmd = net_host_device_add,
 844     },
 845
 846 STEXI
 847 @item host_net_add
 848 @findex host_net_add
 849 Add host VLAN client.
 850 ETEXI
 851
 852     {
 853         .name       = "host_net_remove",
 854         .args_type  = "vlan_id:i,device:s",
 855         .params     = "vlan_id name",
 856         .help       = "remove host VLAN client",
 857         .mhandler.cmd = net_host_device_remove,
 858     },
 859
 860 STEXI
 861 @item host_net_remove
 862 @findex host_net_remove
 863 Remove host VLAN client.
 864 ETEXI
 865
 866     {
 867         .name       = "netdev_add",
 868         .args_type  = "netdev:O",
 869         .params     = "[user|tap|socket],id=str[,prop=value][,...]",
 870         .help       = "add host network device",
 871         .user_print = monitor_user_noop,
 872         .mhandler.cmd_new = do_netdev_add,
 873     },
 874
 875 STEXI
 876 @item netdev_add
 877 @findex netdev_add
 878 Add host network device.
 879 ETEXI
 880
 881     {
 882         .name       = "netdev_del",
 883         .args_type  = "id:s",
 884         .params     = "id",
 885         .help       = "remove host network device",
 886         .user_print = monitor_user_noop,
 887         .mhandler.cmd_new = do_netdev_del,
 888     },
 889
 890 STEXI
 891 @item netdev_del
 892 @findex netdev_del
 893 Remove host network device.
 894 ETEXI
 895
 896 #ifdef CONFIG_SLIRP
 897     {
 898         .name       = "hostfwd_add",
 899         .args_type  = "arg1:s,arg2:s?,arg3:s?",
 900         .params     = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
 901         .help       = "redirect TCP or UDP connections from host to guest (requires -net user)",
 902         .mhandler.cmd = net_slirp_hostfwd_add,
 903     },
 904 #endif
 905 STEXI
 906 @item hostfwd_add
 907 @findex hostfwd_add
 908 Redirect TCP or UDP connections from host to guest (requires -net user).
 909 ETEXI
 910
 911 #ifdef CONFIG_SLIRP
 912     {
 913         .name       = "hostfwd_remove",
 914         .args_type  = "arg1:s,arg2:s?,arg3:s?",
 915         .params     = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
 916         .help       = "remove host-to-guest TCP or UDP redirection",
 917         .mhandler.cmd = net_slirp_hostfwd_remove,
 918     },
 919
 920 #endif
 921 STEXI
 922 @item hostfwd_remove
 923 @findex hostfwd_remove
 924 Remove host-to-guest TCP or UDP redirection.
 925 ETEXI
 926
 927     {
 928         .name       = "balloon",
 929         .args_type  = "value:M",
 930         .params     = "target",
 931         .help       = "request VM to change its memory allocation (in MB)",
 932         .user_print = monitor_user_noop,
 933         .mhandler.cmd_async = do_balloon,
 934         .flags      = MONITOR_CMD_ASYNC,
 935     },
 936
 937 STEXI
 938 @item balloon @var{value}
 939 @findex balloon
 940 Request VM to change its memory allocation to @var{value} (in MB).
 941 ETEXI
 942
 943     {
 944         .name       = "set_link",
 945         .args_type  = "name:s,up:b",
 946         .params     = "name on|off",
 947         .help       = "change the link status of a network adapter",
 948         .user_print = monitor_user_noop,
 949         .mhandler.cmd_new = do_set_link,
 950     },
 951
 952 STEXI
 953 @item set_link @var{name} [on|off]
 954 @findex set_link
 955 Switch link @var{name} on (i.e. up) or off (i.e. down).
 956 ETEXI
 957
 958     {
 959         .name       = "watchdog_action",
 960         .args_type  = "action:s",
 961         .params     = "[reset|shutdown|poweroff|pause|debug|none]",
 962         .help       = "change watchdog action",
 963         .mhandler.cmd = do_watchdog_action,
 964     },
 965
 966 STEXI
 967 @item watchdog_action
 968 @findex watchdog_action
 969 Change watchdog action.
 970 ETEXI
 971
 972     {
 973         .name       = "acl_show",
 974         .args_type  = "aclname:s",
 975         .params     = "aclname",
 976         .help       = "list rules in the access control list",
 977         .mhandler.cmd = do_acl_show,
 978     },
 979
 980 STEXI
 981 @item acl_show @var{aclname}
 982 @findex acl_show
 983 List all the matching rules in the access control list, and the default
 984 policy. There are currently two named access control lists,
 985 @var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
 986 certificate distinguished name, and SASL username respectively.
 987 ETEXI
 988
 989     {
 990         .name       = "acl_policy",
 991         .args_type  = "aclname:s,policy:s",
 992         .params     = "aclname allow|deny",
 993         .help       = "set default access control list policy",
 994         .mhandler.cmd = do_acl_policy,
 995     },
 996
 997 STEXI
 998 @item acl_policy @var{aclname} @code{allow|deny}
 999 @findex acl_policy
1000 Set the default access control list policy, used in the event that
1001 none of the explicit rules match. The default policy at startup is
1002 always @code{deny}.
1003 ETEXI
1004
1005     {
1006         .name       = "acl_add",
1007         .args_type  = "aclname:s,match:s,policy:s,index:i?",
1008         .params     = "aclname match allow|deny [index]",
1009         .help       = "add a match rule to the access control list",
1010         .mhandler.cmd = do_acl_add,
1011     },
1012
1013 STEXI
1014 @item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1015 @findex acl_add
1016 Add a match rule to the access control list, allowing or denying access.
1017 The match will normally be an exact username or x509 distinguished name,
1018 but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1019 allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
1020 normally be appended to the end of the ACL, but can be inserted
1021 earlier in the list if the optional @var{index} parameter is supplied.
1022 ETEXI
1023
1024     {
1025         .name       = "acl_remove",
1026         .args_type  = "aclname:s,match:s",
1027         .params     = "aclname match",
1028         .help       = "remove a match rule from the access control list",
1029         .mhandler.cmd = do_acl_remove,
1030     },
1031
1032 STEXI
1033 @item acl_remove @var{aclname} @var{match}
1034 @findex acl_remove
1035 Remove the specified match rule from the access control list.
1036 ETEXI
1037
1038     {
1039         .name       = "acl_reset",
1040         .args_type  = "aclname:s",
1041         .params     = "aclname",
1042         .help       = "reset the access control list",
1043         .mhandler.cmd = do_acl_reset,
1044     },
1045
1046 STEXI
1047 @item acl_reset @var{aclname}
1048 @findex acl_reset
1049 Remove all matches from the access control list, and set the default
1050 policy back to @code{deny}.
1051 ETEXI
1052
1053 #if defined(TARGET_I386)
1054
1055     {
1056         .name       = "mce",
1057         .args_type  = "cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1058         .params     = "cpu bank status mcgstatus addr misc",
1059         .help       = "inject a MCE on the given CPU",
1060         .mhandler.cmd = do_inject_mce,
1061     },
1062
1063 #endif
1064 STEXI
1065 @item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
1066 @findex mce (x86)
1067 Inject an MCE on the given CPU (x86 only).
1068 ETEXI
1069
1070     {
1071         .name       = "getfd",
1072         .args_type  = "fdname:s",
1073         .params     = "getfd name",
1074         .help       = "receive a file descriptor via SCM rights and assign it a name",
1075         .user_print = monitor_user_noop,
1076         .mhandler.cmd_new = do_getfd,
1077     },
1078
1079 STEXI
1080 @item getfd @var{fdname}
1081 @findex getfd
1082 If a file descriptor is passed alongside this command using the SCM_RIGHTS
1083 mechanism on unix sockets, it is stored using the name @var{fdname} for
1084 later use by other monitor commands.
1085 ETEXI
1086
1087     {
1088         .name       = "closefd",
1089         .args_type  = "fdname:s",
1090         .params     = "closefd name",
1091         .help       = "close a file descriptor previously passed via SCM rights",
1092         .user_print = monitor_user_noop,
1093         .mhandler.cmd_new = do_closefd,
1094     },
1095
1096 STEXI
1097 @item closefd @var{fdname}
1098 @findex closefd
1099 Close the file descriptor previously assigned to @var{fdname} using the
1100 @code{getfd} command. This is only needed if the file descriptor was never
1101 used by another monitor command.
1102 ETEXI
1103
1104     {
1105         .name       = "block_passwd",
1106         .args_type  = "device:B,password:s",
1107         .params     = "block_passwd device password",
1108         .help       = "set the password of encrypted block devices",
1109         .user_print = monitor_user_noop,
1110         .mhandler.cmd_new = do_block_set_passwd,
1111     },
1112
1113 STEXI
1114 @item block_passwd @var{device} @var{password}
1115 @findex block_passwd
1116 Set the encrypted device @var{device} password to @var{password}
1117 ETEXI
1118
1119     {
1120         .name       = "info",
1121         .args_type  = "item:s?",
1122         .params     = "[subcommand]",
1123         .help       = "show various information about the system state",
1124         .mhandler.cmd = do_info,
1125     },
1126
1127 STEXI
1128 @item info @var{subcommand}
1129 @findex info
1130 Show various information about the system state.
1131
1132 @table @option
1133 @item info version
1134 show the version of QEMU
1135 @item info network
1136 show the various VLANs and the associated devices
1137 @item info chardev
1138 show the character devices
1139 @item info block
1140 show the block devices
1141 @item info blockstats
1142 show block device statistics
1143 @item info registers
1144 show the cpu registers
1145 @item info cpus
1146 show infos for each CPU
1147 @item info history
1148 show the command line history
1149 @item info irq
1150 show the interrupts statistics (if available)
1151 @item info pic
1152 show i8259 (PIC) state
1153 @item info pci
1154 show emulated PCI device info
1155 @item info tlb
1156 show virtual to physical memory mappings (i386 only)
1157 @item info mem
1158 show the active virtual memory mappings (i386 only)
1159 @item info jit
1160 show dynamic compiler info
1161 @item info kvm
1162 show KVM information
1163 @item info numa
1164 show NUMA information
1165 @item info kvm
1166 show KVM information
1167 @item info usb
1168 show USB devices plugged on the virtual USB hub
1169 @item info usbhost
1170 show all USB host devices
1171 @item info profile
1172 show profiling information
1173 @item info capture
1174 show information about active capturing
1175 @item info snapshots
1176 show list of VM snapshots
1177 @item info status
1178 show the current VM status (running|paused)
1179 @item info pcmcia
1180 show guest PCMCIA status
1181 @item info mice
1182 show which guest mouse is receiving events
1183 @item info vnc
1184 show the vnc server status
1185 @item info name
1186 show the current VM name
1187 @item info uuid
1188 show the current VM UUID
1189 @item info cpustats
1190 show CPU statistics
1191 @item info usernet
1192 show user network stack connection states
1193 @item info migrate
1194 show migration status
1195 @item info balloon
1196 show balloon information
1197 @item info qtree
1198 show device tree
1199 @item info qdm
1200 show qdev device model list
1201 @item info roms
1202 show roms
1203 @end table
1204 ETEXI
1205
1206 #ifdef CONFIG_SIMPLE_TRACE
1207 STEXI
1208 @item info trace
1209 show contents of trace buffer
1210 @item info trace-events
1211 show available trace events and their state
1212 ETEXI
1213 #endif
1214
1215     {
1216         .name       = "agent_viewfile",
1217         .args_type  = "filepath:s",
1218         .params     = "filepath",
1219         .help       = "Echo a file from the guest filesystem",
1220         .user_print = do_agent_viewfile_print,
1221         .mhandler.cmd_async = do_agent_viewfile,
1222         .flags      = MONITOR_CMD_ASYNC,
1223     },
1224
1225 STEXI
1226 @item agent_viewfile @var{filepath}
1227 @findex agent_viewfile
1228 Echo the file identified by @var{filepath} on the guest filesystem
1229 ETEXI
1230
1231     {
1232         .name       = "agent_viewdmesg",
1233         .args_type  = "",
1234         .params     = "",
1235         .help       = "View guest dmesg output",
1236         .user_print = do_agent_viewdmesg_print,
1237         .mhandler.cmd_async = do_agent_viewdmesg,
1238         .flags      = MONITOR_CMD_ASYNC,
1239     },
1240
1241 STEXI
1242 @item agent_viewdmesg
1243 @findex agent_viewdmesg
1244 View guest dmesg output
1245 ETEXI
1246
1247     {
1248         .name       = "agent_shutdown",
1249         .args_type  = "shutdown_type:s",
1250         .params     = "[reboot|shutdown|poweroff]",
1251         .help       = "Shutdown/reboot a guest locally",
1252         .user_print = monitor_user_noop,
1253         .mhandler.cmd_async = do_agent_shutdown,
1254         .flags      = MONITOR_CMD_ASYNC,
1255     },
1256
1257 STEXI
1258 @item agent_shutdown
1259 @findex agent_shutdown
1260 Shutdown/reboot a guest locally
1261 ETEXI
1262
1263     {
1264         .name       = "agent_ping",
1265         .args_type  = "",
1266         .params     = "",
1267         .help       = "Ping a guest",
1268         .user_print = do_agent_ping_print,
1269         .mhandler.cmd_async = do_agent_ping,
1270         .flags      = MONITOR_CMD_ASYNC,
1271     },
1272
1273 STEXI
1274 @item agent_ping
1275 @findex agent_ping
1276 Ping a guest
1277 ETEXI
1278
1279     {
1280         .name       = "agent_capabilities",
1281         .args_type  = "",
1282         .params     = "",
1283         .help       = "Fetch and re-negotiate guest agent capabilities",
1284         .user_print = do_agent_capabilities_print,
1285         .mhandler.cmd_async = do_agent_capabilities,
1286         .flags      = MONITOR_CMD_ASYNC,
1287     },
1288
1289 STEXI
1290 @item agent_capabilities
1291 @findex agent_capabilities
1292 Fetch and re-negotiate guest agent capabilties
1293 ETEXI
1294
1295 STEXI
1296 @end table
1297 ETEXI