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         .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         .cmd        = hmp_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 If the backing file is smaller than the snapshot, then the backing file will be
  39 resized to be the same size as the snapshot.  If the snapshot is smaller than
  40 the backing file, the backing file will not be truncated.  If you want the
  41 backing file to match the size of the smaller snapshot, you can safely truncate
  42 it yourself once the commit operation successfully completes.
  43 ETEXI
  44
  45     {
  46         .name       = "q|quit",
  47         .args_type  = "",
  48         .params     = "",
  49         .help       = "quit the emulator",
  50         .cmd        = hmp_quit,
  51     },
  52
  53 STEXI
  54 @item q or quit
  55 @findex quit
  56 Quit the emulator.
  57 ETEXI
  58
  59     {
  60         .name       = "block_resize",
  61         .args_type  = "device:B,size:o",
  62         .params     = "device size",
  63         .help       = "resize a block image",
  64         .cmd        = hmp_block_resize,
  65     },
  66
  67 STEXI
  68 @item block_resize
  69 @findex block_resize
  70 Resize a block image while a guest is running.  Usually requires guest
  71 action to see the updated size.  Resize to a lower size is supported,
  72 but should be used with extreme caution.  Note that this command only
  73 resizes image files, it can not resize block devices like LVM volumes.
  74 ETEXI
  75
  76     {
  77         .name       = "block_stream",
  78         .args_type  = "device:B,speed:o?,base:s?",
  79         .params     = "device [speed [base]]",
  80         .help       = "copy data from a backing file into a block device",
  81         .cmd        = hmp_block_stream,
  82     },
  83
  84 STEXI
  85 @item block_stream
  86 @findex block_stream
  87 Copy data from a backing file into a block device.
  88 ETEXI
  89
  90     {
  91         .name       = "block_job_set_speed",
  92         .args_type  = "device:B,speed:o",
  93         .params     = "device speed",
  94         .help       = "set maximum speed for a background block operation",
  95         .cmd        = hmp_block_job_set_speed,
  96     },
  97
  98 STEXI
  99 @item block_job_set_speed
 100 @findex block_job_set_speed
 101 Set maximum speed for a background block operation.
 102 ETEXI
 103
 104     {
 105         .name       = "block_job_cancel",
 106         .args_type  = "force:-f,device:B",
 107         .params     = "[-f] device",
 108         .help       = "stop an active background block operation (use -f"
 109                       "\n\t\t\t if the operation is currently paused)",
 110         .cmd        = hmp_block_job_cancel,
 111     },
 112
 113 STEXI
 114 @item block_job_cancel
 115 @findex block_job_cancel
 116 Stop an active background block operation (streaming, mirroring).
 117 ETEXI
 118
 119     {
 120         .name       = "block_job_complete",
 121         .args_type  = "device:B",
 122         .params     = "device",
 123         .help       = "stop an active background block operation",
 124         .cmd        = hmp_block_job_complete,
 125     },
 126
 127 STEXI
 128 @item block_job_complete
 129 @findex block_job_complete
 130 Manually trigger completion of an active background block operation.
 131 For mirroring, this will switch the device to the destination path.
 132 ETEXI
 133
 134     {
 135         .name       = "block_job_pause",
 136         .args_type  = "device:B",
 137         .params     = "device",
 138         .help       = "pause an active background block operation",
 139         .cmd        = hmp_block_job_pause,
 140     },
 141
 142 STEXI
 143 @item block_job_pause
 144 @findex block_job_pause
 145 Pause an active block streaming operation.
 146 ETEXI
 147
 148     {
 149         .name       = "block_job_resume",
 150         .args_type  = "device:B",
 151         .params     = "device",
 152         .help       = "resume a paused background block operation",
 153         .cmd        = hmp_block_job_resume,
 154     },
 155
 156 STEXI
 157 @item block_job_resume
 158 @findex block_job_resume
 159 Resume a paused block streaming operation.
 160 ETEXI
 161
 162     {
 163         .name       = "eject",
 164         .args_type  = "force:-f,device:B",
 165         .params     = "[-f] device",
 166         .help       = "eject a removable medium (use -f to force it)",
 167         .cmd        = hmp_eject,
 168     },
 169
 170 STEXI
 171 @item eject [-f] @var{device}
 172 @findex eject
 173 Eject a removable medium (use -f to force it).
 174 ETEXI
 175
 176     {
 177         .name       = "drive_del",
 178         .args_type  = "id:B",
 179         .params     = "device",
 180         .help       = "remove host block device",
 181         .cmd        = hmp_drive_del,
 182     },
 183
 184 STEXI
 185 @item drive_del @var{device}
 186 @findex drive_del
 187 Remove host block device.  The result is that guest generated IO is no longer
 188 submitted against the host device underlying the disk.  Once a drive has
 189 been deleted, the QEMU Block layer returns -EIO which results in IO
 190 errors in the guest for applications that are reading/writing to the device.
 191 These errors are always reported to the guest, regardless of the drive's error
 192 actions (drive options rerror, werror).
 193 ETEXI
 194
 195     {
 196         .name       = "change",
 197         .args_type  = "device:B,target:F,arg:s?,read-only-mode:s?",
 198         .params     = "device filename [format [read-only-mode]]",
 199         .help       = "change a removable medium, optional format",
 200         .cmd        = hmp_change,
 201     },
 202
 203 STEXI
 204 @item change @var{device} @var{setting}
 205 @findex change
 206 Change the configuration of a device.
 207
 208 @table @option
 209 @item change @var{diskdevice} @var{filename} [@var{format} [@var{read-only-mode}]]
 210 Change the medium for a removable disk device to point to @var{filename}. eg
 211
 212 @example
 213 (qemu) change ide1-cd0 /path/to/some.iso
 214 @end example
 215
 216 @var{format} is optional.
 217
 218 @var{read-only-mode} may be used to change the read-only status of the device.
 219 It accepts the following values:
 220
 221 @table @var
 222 @item retain
 223 Retains the current status; this is the default.
 224
 225 @item read-only
 226 Makes the device read-only.
 227
 228 @item read-write
 229 Makes the device writable.
 230 @end table
 231
 232 @item change vnc @var{display},@var{options}
 233 Change the configuration of the VNC server. The valid syntax for @var{display}
 234 and @var{options} are described at @ref{sec_invocation}. eg
 235
 236 @example
 237 (qemu) change vnc localhost:1
 238 @end example
 239
 240 @item change vnc password [@var{password}]
 241
 242 Change the password associated with the VNC server. If the new password is not
 243 supplied, the monitor will prompt for it to be entered. VNC passwords are only
 244 significant up to 8 letters. eg
 245
 246 @example
 247 (qemu) change vnc password
 248 Password: ********
 249 @end example
 250
 251 @end table
 252 ETEXI
 253
 254     {
 255         .name       = "screendump",
 256         .args_type  = "filename:F",
 257         .params     = "filename",
 258         .help       = "save screen into PPM image 'filename'",
 259         .cmd        = hmp_screendump,
 260     },
 261
 262 STEXI
 263 @item screendump @var{filename}
 264 @findex screendump
 265 Save screen into PPM image @var{filename}.
 266 ETEXI
 267
 268     {
 269         .name       = "logfile",
 270         .args_type  = "filename:F",
 271         .params     = "filename",
 272         .help       = "output logs to 'filename'",
 273         .cmd        = hmp_logfile,
 274     },
 275
 276 STEXI
 277 @item logfile @var{filename}
 278 @findex logfile
 279 Output logs to @var{filename}.
 280 ETEXI
 281
 282     {
 283         .name       = "trace-event",
 284         .args_type  = "name:s,option:b,vcpu:i?",
 285         .params     = "name on|off [vcpu]",
 286         .help       = "changes status of a specific trace event "
 287                       "(vcpu: vCPU to set, default is all)",
 288         .cmd = hmp_trace_event,
 289         .command_completion = trace_event_completion,
 290     },
 291
 292 STEXI
 293 @item trace-event
 294 @findex trace-event
 295 changes status of a trace event
 296 ETEXI
 297
 298 #if defined(CONFIG_TRACE_SIMPLE)
 299     {
 300         .name       = "trace-file",
 301         .args_type  = "op:s?,arg:F?",
 302         .params     = "on|off|flush|set [arg]",
 303         .help       = "open, close, or flush trace file, or set a new file name",
 304         .cmd        = hmp_trace_file,
 305     },
 306
 307 STEXI
 308 @item trace-file on|off|flush
 309 @findex trace-file
 310 Open, close, or flush the trace file.  If no argument is given, the status of the trace file is displayed.
 311 ETEXI
 312 #endif
 313
 314     {
 315         .name       = "log",
 316         .args_type  = "items:s",
 317         .params     = "item1[,...]",
 318         .help       = "activate logging of the specified items",
 319         .cmd        = hmp_log,
 320     },
 321
 322 STEXI
 323 @item log @var{item1}[,...]
 324 @findex log
 325 Activate logging of the specified items.
 326 ETEXI
 327
 328     {
 329         .name       = "savevm",
 330         .args_type  = "name:s?",
 331         .params     = "[tag|id]",
 332         .help       = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
 333         .cmd        = hmp_savevm,
 334     },
 335
 336 STEXI
 337 @item savevm [@var{tag}|@var{id}]
 338 @findex savevm
 339 Create a snapshot of the whole virtual machine. If @var{tag} is
 340 provided, it is used as human readable identifier. If there is already
 341 a snapshot with the same tag or ID, it is replaced. More info at
 342 @ref{vm_snapshots}.
 343 ETEXI
 344
 345     {
 346         .name       = "loadvm",
 347         .args_type  = "name:s",
 348         .params     = "tag|id",
 349         .help       = "restore a VM snapshot from its tag or id",
 350         .cmd        = hmp_loadvm,
 351         .command_completion = loadvm_completion,
 352     },
 353
 354 STEXI
 355 @item loadvm @var{tag}|@var{id}
 356 @findex loadvm
 357 Set the whole virtual machine to the snapshot identified by the tag
 358 @var{tag} or the unique snapshot ID @var{id}.
 359 ETEXI
 360
 361     {
 362         .name       = "delvm",
 363         .args_type  = "name:s",
 364         .params     = "tag|id",
 365         .help       = "delete a VM snapshot from its tag or id",
 366         .cmd        = hmp_delvm,
 367         .command_completion = delvm_completion,
 368     },
 369
 370 STEXI
 371 @item delvm @var{tag}|@var{id}
 372 @findex delvm
 373 Delete the snapshot identified by @var{tag} or @var{id}.
 374 ETEXI
 375
 376     {
 377         .name       = "singlestep",
 378         .args_type  = "option:s?",
 379         .params     = "[on|off]",
 380         .help       = "run emulation in singlestep mode or switch to normal mode",
 381         .cmd        = hmp_singlestep,
 382     },
 383
 384 STEXI
 385 @item singlestep [off]
 386 @findex singlestep
 387 Run the emulation in single step mode.
 388 If called with option off, the emulation returns to normal mode.
 389 ETEXI
 390
 391     {
 392         .name       = "stop",
 393         .args_type  = "",
 394         .params     = "",
 395         .help       = "stop emulation",
 396         .cmd        = hmp_stop,
 397     },
 398
 399 STEXI
 400 @item stop
 401 @findex stop
 402 Stop emulation.
 403 ETEXI
 404
 405     {
 406         .name       = "c|cont",
 407         .args_type  = "",
 408         .params     = "",
 409         .help       = "resume emulation",
 410         .cmd        = hmp_cont,
 411     },
 412
 413 STEXI
 414 @item c or cont
 415 @findex cont
 416 Resume emulation.
 417 ETEXI
 418
 419     {
 420         .name       = "system_wakeup",
 421         .args_type  = "",
 422         .params     = "",
 423         .help       = "wakeup guest from suspend",
 424         .cmd        = hmp_system_wakeup,
 425     },
 426
 427 STEXI
 428 @item system_wakeup
 429 @findex system_wakeup
 430 Wakeup guest from suspend.
 431 ETEXI
 432
 433     {
 434         .name       = "gdbserver",
 435         .args_type  = "device:s?",
 436         .params     = "[device]",
 437         .help       = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
 438         .cmd        = hmp_gdbserver,
 439     },
 440
 441 STEXI
 442 @item gdbserver [@var{port}]
 443 @findex gdbserver
 444 Start gdbserver session (default @var{port}=1234)
 445 ETEXI
 446
 447     {
 448         .name       = "x",
 449         .args_type  = "fmt:/,addr:l",
 450         .params     = "/fmt addr",
 451         .help       = "virtual memory dump starting at 'addr'",
 452         .cmd        = hmp_memory_dump,
 453     },
 454
 455 STEXI
 456 @item x/fmt @var{addr}
 457 @findex x
 458 Virtual memory dump starting at @var{addr}.
 459 ETEXI
 460
 461     {
 462         .name       = "xp",
 463         .args_type  = "fmt:/,addr:l",
 464         .params     = "/fmt addr",
 465         .help       = "physical memory dump starting at 'addr'",
 466         .cmd        = hmp_physical_memory_dump,
 467     },
 468
 469 STEXI
 470 @item xp /@var{fmt} @var{addr}
 471 @findex xp
 472 Physical memory dump starting at @var{addr}.
 473
 474 @var{fmt} is a format which tells the command how to format the
 475 data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
 476
 477 @table @var
 478 @item count
 479 is the number of items to be dumped.
 480
 481 @item format
 482 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
 483 c (char) or i (asm instruction).
 484
 485 @item size
 486 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
 487 @code{h} or @code{w} can be specified with the @code{i} format to
 488 respectively select 16 or 32 bit code instruction size.
 489
 490 @end table
 491
 492 Examples:
 493 @itemize
 494 @item
 495 Dump 10 instructions at the current instruction pointer:
 496 @example
 497 (qemu) x/10i $eip
 498 0x90107063:  ret
 499 0x90107064:  sti
 500 0x90107065:  lea    0x0(%esi,1),%esi
 501 0x90107069:  lea    0x0(%edi,1),%edi
 502 0x90107070:  ret
 503 0x90107071:  jmp    0x90107080
 504 0x90107073:  nop
 505 0x90107074:  nop
 506 0x90107075:  nop
 507 0x90107076:  nop
 508 @end example
 509
 510 @item
 511 Dump 80 16 bit values at the start of the video memory.
 512 @smallexample
 513 (qemu) xp/80hx 0xb8000
 514 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
 515 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
 516 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
 517 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
 518 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
 519 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
 520 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
 521 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
 522 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
 523 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
 524 @end smallexample
 525 @end itemize
 526 ETEXI
 527
 528     {
 529         .name       = "gpa2hva",
 530         .args_type  = "addr:l",
 531         .params     = "addr",
 532         .help       = "print the host virtual address corresponding to a guest physical address",
 533         .cmd        = hmp_gpa2hva,
 534     },
 535
 536 STEXI
 537 @item gpa2hva @var{addr}
 538 @findex gpa2hva
 539 Print the host virtual address at which the guest's physical address @var{addr}
 540 is mapped.
 541 ETEXI
 542
 543 #ifdef CONFIG_LINUX
 544     {
 545         .name       = "gpa2hpa",
 546         .args_type  = "addr:l",
 547         .params     = "addr",
 548         .help       = "print the host physical address corresponding to a guest physical address",
 549         .cmd        = hmp_gpa2hpa,
 550     },
 551 #endif
 552
 553 STEXI
 554 @item gpa2hpa @var{addr}
 555 @findex gpa2hpa
 556 Print the host physical address at which the guest's physical address @var{addr}
 557 is mapped.
 558 ETEXI
 559
 560     {
 561         .name       = "p|print",
 562         .args_type  = "fmt:/,val:l",
 563         .params     = "/fmt expr",
 564         .help       = "print expression value (use $reg for CPU register access)",
 565         .cmd        = do_print,
 566     },
 567
 568 STEXI
 569 @item p or print/@var{fmt} @var{expr}
 570 @findex print
 571 Print expression value. Only the @var{format} part of @var{fmt} is
 572 used.
 573 ETEXI
 574
 575     {
 576         .name       = "i",
 577         .args_type  = "fmt:/,addr:i,index:i.",
 578         .params     = "/fmt addr",
 579         .help       = "I/O port read",
 580         .cmd        = hmp_ioport_read,
 581     },
 582
 583 STEXI
 584 @item i/@var{fmt} @var{addr} [.@var{index}]
 585 @findex i
 586 Read I/O port.
 587 ETEXI
 588
 589     {
 590         .name       = "o",
 591         .args_type  = "fmt:/,addr:i,val:i",
 592         .params     = "/fmt addr value",
 593         .help       = "I/O port write",
 594         .cmd        = hmp_ioport_write,
 595     },
 596
 597 STEXI
 598 @item o/@var{fmt} @var{addr} @var{val}
 599 @findex o
 600 Write to I/O port.
 601 ETEXI
 602
 603     {
 604         .name       = "sendkey",
 605         .args_type  = "keys:s,hold-time:i?",
 606         .params     = "keys [hold_ms]",
 607         .help       = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
 608         .cmd        = hmp_sendkey,
 609         .command_completion = sendkey_completion,
 610     },
 611
 612 STEXI
 613 @item sendkey @var{keys}
 614 @findex sendkey
 615 Send @var{keys} to the guest. @var{keys} could be the name of the
 616 key or the raw value in hexadecimal format. Use @code{-} to press
 617 several keys simultaneously. Example:
 618 @example
 619 sendkey ctrl-alt-f1
 620 @end example
 621
 622 This command is useful to send keys that your graphical user interface
 623 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
 624 ETEXI
 625
 626     {
 627         .name       = "system_reset",
 628         .args_type  = "",
 629         .params     = "",
 630         .help       = "reset the system",
 631         .cmd        = hmp_system_reset,
 632     },
 633
 634 STEXI
 635 @item system_reset
 636 @findex system_reset
 637 Reset the system.
 638 ETEXI
 639
 640     {
 641         .name       = "system_powerdown",
 642         .args_type  = "",
 643         .params     = "",
 644         .help       = "send system power down event",
 645         .cmd        = hmp_system_powerdown,
 646     },
 647
 648 STEXI
 649 @item system_powerdown
 650 @findex system_powerdown
 651 Power down the system (if supported).
 652 ETEXI
 653
 654     {
 655         .name       = "sum",
 656         .args_type  = "start:i,size:i",
 657         .params     = "addr size",
 658         .help       = "compute the checksum of a memory region",
 659         .cmd        = hmp_sum,
 660     },
 661
 662 STEXI
 663 @item sum @var{addr} @var{size}
 664 @findex sum
 665 Compute the checksum of a memory region.
 666 ETEXI
 667
 668     {
 669         .name       = "usb_add",
 670         .args_type  = "devname:s",
 671         .params     = "device",
 672         .help       = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
 673         .cmd        = hmp_usb_add,
 674     },
 675
 676 STEXI
 677 @item usb_add @var{devname}
 678 @findex usb_add
 679 Add the USB device @var{devname}. This command is deprecated, please
 680 use @code{device_add} instead. For details of available devices see
 681 @ref{usb_devices}
 682 ETEXI
 683
 684     {
 685         .name       = "usb_del",
 686         .args_type  = "devname:s",
 687         .params     = "device",
 688         .help       = "remove USB device 'bus.addr'",
 689         .cmd        = hmp_usb_del,
 690     },
 691
 692 STEXI
 693 @item usb_del @var{devname}
 694 @findex usb_del
 695 Remove the USB device @var{devname} from the QEMU virtual USB
 696 hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
 697 command @code{info usb} to see the devices you can remove. This
 698 command is deprecated, please use @code{device_del} instead.
 699 ETEXI
 700
 701     {
 702         .name       = "device_add",
 703         .args_type  = "device:O",
 704         .params     = "driver[,prop=value][,...]",
 705         .help       = "add device, like -device on the command line",
 706         .cmd        = hmp_device_add,
 707         .command_completion = device_add_completion,
 708     },
 709
 710 STEXI
 711 @item device_add @var{config}
 712 @findex device_add
 713 Add device.
 714 ETEXI
 715
 716     {
 717         .name       = "device_del",
 718         .args_type  = "id:s",
 719         .params     = "device",
 720         .help       = "remove device",
 721         .cmd        = hmp_device_del,
 722         .command_completion = device_del_completion,
 723     },
 724
 725 STEXI
 726 @item device_del @var{id}
 727 @findex device_del
 728 Remove device @var{id}. @var{id} may be a short ID
 729 or a QOM object path.
 730 ETEXI
 731
 732     {
 733         .name       = "cpu",
 734         .args_type  = "index:i",
 735         .params     = "index",
 736         .help       = "set the default CPU",
 737         .cmd        = hmp_cpu,
 738     },
 739
 740 STEXI
 741 @item cpu @var{index}
 742 @findex cpu
 743 Set the default CPU.
 744 ETEXI
 745
 746     {
 747         .name       = "mouse_move",
 748         .args_type  = "dx_str:s,dy_str:s,dz_str:s?",
 749         .params     = "dx dy [dz]",
 750         .help       = "send mouse move events",
 751         .cmd        = hmp_mouse_move,
 752     },
 753
 754 STEXI
 755 @item mouse_move @var{dx} @var{dy} [@var{dz}]
 756 @findex mouse_move
 757 Move the active mouse to the specified coordinates @var{dx} @var{dy}
 758 with optional scroll axis @var{dz}.
 759 ETEXI
 760
 761     {
 762         .name       = "mouse_button",
 763         .args_type  = "button_state:i",
 764         .params     = "state",
 765         .help       = "change mouse button state (1=L, 2=M, 4=R)",
 766         .cmd        = hmp_mouse_button,
 767     },
 768
 769 STEXI
 770 @item mouse_button @var{val}
 771 @findex mouse_button
 772 Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
 773 ETEXI
 774
 775     {
 776         .name       = "mouse_set",
 777         .args_type  = "index:i",
 778         .params     = "index",
 779         .help       = "set which mouse device receives events",
 780         .cmd        = hmp_mouse_set,
 781     },
 782
 783 STEXI
 784 @item mouse_set @var{index}
 785 @findex mouse_set
 786 Set which mouse device receives events at given @var{index}, index
 787 can be obtained with
 788 @example
 789 info mice
 790 @end example
 791 ETEXI
 792
 793     {
 794         .name       = "wavcapture",
 795         .args_type  = "path:F,freq:i?,bits:i?,nchannels:i?",
 796         .params     = "path [frequency [bits [channels]]]",
 797         .help       = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
 798         .cmd        = hmp_wavcapture,
 799     },
 800 STEXI
 801 @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
 802 @findex wavcapture
 803 Capture audio into @var{filename}. Using sample rate @var{frequency}
 804 bits per sample @var{bits} and number of channels @var{channels}.
 805
 806 Defaults:
 807 @itemize @minus
 808 @item Sample rate = 44100 Hz - CD quality
 809 @item Bits = 16
 810 @item Number of channels = 2 - Stereo
 811 @end itemize
 812 ETEXI
 813
 814     {
 815         .name       = "stopcapture",
 816         .args_type  = "n:i",
 817         .params     = "capture index",
 818         .help       = "stop capture",
 819         .cmd        = hmp_stopcapture,
 820     },
 821 STEXI
 822 @item stopcapture @var{index}
 823 @findex stopcapture
 824 Stop capture with a given @var{index}, index can be obtained with
 825 @example
 826 info capture
 827 @end example
 828 ETEXI
 829
 830     {
 831         .name       = "memsave",
 832         .args_type  = "val:l,size:i,filename:s",
 833         .params     = "addr size file",
 834         .help       = "save to disk virtual memory dump starting at 'addr' of size 'size'",
 835         .cmd        = hmp_memsave,
 836     },
 837
 838 STEXI
 839 @item memsave @var{addr} @var{size} @var{file}
 840 @findex memsave
 841 save to disk virtual memory dump starting at @var{addr} of size @var{size}.
 842 ETEXI
 843
 844     {
 845         .name       = "pmemsave",
 846         .args_type  = "val:l,size:i,filename:s",
 847         .params     = "addr size file",
 848         .help       = "save to disk physical memory dump starting at 'addr' of size 'size'",
 849         .cmd        = hmp_pmemsave,
 850     },
 851
 852 STEXI
 853 @item pmemsave @var{addr} @var{size} @var{file}
 854 @findex pmemsave
 855 save to disk physical memory dump starting at @var{addr} of size @var{size}.
 856 ETEXI
 857
 858     {
 859         .name       = "boot_set",
 860         .args_type  = "bootdevice:s",
 861         .params     = "bootdevice",
 862         .help       = "define new values for the boot device list",
 863         .cmd        = hmp_boot_set,
 864     },
 865
 866 STEXI
 867 @item boot_set @var{bootdevicelist}
 868 @findex boot_set
 869 Define new values for the boot device list. Those values will override
 870 the values specified on the command line through the @code{-boot} option.
 871
 872 The values that can be specified here depend on the machine type, but are
 873 the same that can be specified in the @code{-boot} command line option.
 874 ETEXI
 875
 876     {
 877         .name       = "nmi",
 878         .args_type  = "",
 879         .params     = "",
 880         .help       = "inject an NMI",
 881         .cmd        = hmp_nmi,
 882     },
 883 STEXI
 884 @item nmi @var{cpu}
 885 @findex nmi
 886 Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
 887
 888 ETEXI
 889
 890     {
 891         .name       = "ringbuf_write",
 892         .args_type  = "device:s,data:s",
 893         .params     = "device data",
 894         .help       = "Write to a ring buffer character device",
 895         .cmd        = hmp_ringbuf_write,
 896         .command_completion = ringbuf_write_completion,
 897     },
 898
 899 STEXI
 900 @item ringbuf_write @var{device} @var{data}
 901 @findex ringbuf_write
 902 Write @var{data} to ring buffer character device @var{device}.
 903 @var{data} must be a UTF-8 string.
 904
 905 ETEXI
 906
 907     {
 908         .name       = "ringbuf_read",
 909         .args_type  = "device:s,size:i",
 910         .params     = "device size",
 911         .help       = "Read from a ring buffer character device",
 912         .cmd        = hmp_ringbuf_read,
 913         .command_completion = ringbuf_write_completion,
 914     },
 915
 916 STEXI
 917 @item ringbuf_read @var{device}
 918 @findex ringbuf_read
 919 Read and print up to @var{size} bytes from ring buffer character
 920 device @var{device}.
 921 Certain non-printable characters are printed \uXXXX, where XXXX is the
 922 character code in hexadecimal.  Character \ is printed \\.
 923 Bug: can screw up when the buffer contains invalid UTF-8 sequences,
 924 NUL characters, after the ring buffer lost data, and when reading
 925 stops because the size limit is reached.
 926
 927 ETEXI
 928
 929     {
 930         .name       = "migrate",
 931         .args_type  = "detach:-d,blk:-b,inc:-i,uri:s",
 932         .params     = "[-d] [-b] [-i] uri",
 933         .help       = "migrate to URI (using -d to not wait for completion)"
 934                       "\n\t\t\t -b for migration without shared storage with"
 935                       " full copy of disk\n\t\t\t -i for migration without "
 936                       "shared storage with incremental copy of disk "
 937                       "(base image shared between src and destination)",
 938         .cmd        = hmp_migrate,
 939     },
 940
 941
 942 STEXI
 943 @item migrate [-d] [-b] [-i] @var{uri}
 944 @findex migrate
 945 Migrate to @var{uri} (using -d to not wait for completion).
 946         -b for migration with full copy of disk
 947         -i for migration with incremental copy of disk (base image is shared)
 948 ETEXI
 949
 950     {
 951         .name       = "migrate_cancel",
 952         .args_type  = "",
 953         .params     = "",
 954         .help       = "cancel the current VM migration",
 955         .cmd        = hmp_migrate_cancel,
 956     },
 957
 958 STEXI
 959 @item migrate_cancel
 960 @findex migrate_cancel
 961 Cancel the current VM migration.
 962
 963 ETEXI
 964
 965     {
 966         .name       = "migrate_incoming",
 967         .args_type  = "uri:s",
 968         .params     = "uri",
 969         .help       = "Continue an incoming migration from an -incoming defer",
 970         .cmd        = hmp_migrate_incoming,
 971     },
 972
 973 STEXI
 974 @item migrate_incoming @var{uri}
 975 @findex migrate_incoming
 976 Continue an incoming migration using the @var{uri} (that has the same syntax
 977 as the -incoming option).
 978
 979 ETEXI
 980
 981     {
 982         .name       = "migrate_set_cache_size",
 983         .args_type  = "value:o",
 984         .params     = "value",
 985         .help       = "set cache size (in bytes) for XBZRLE migrations,"
 986                       "the cache size will be rounded down to the nearest "
 987                       "power of 2.\n"
 988                       "The cache size affects the number of cache misses."
 989                       "In case of a high cache miss ratio you need to increase"
 990                       " the cache size",
 991         .cmd        = hmp_migrate_set_cache_size,
 992     },
 993
 994 STEXI
 995 @item migrate_set_cache_size @var{value}
 996 @findex migrate_set_cache_size
 997 Set cache size to @var{value} (in bytes) for xbzrle migrations.
 998 ETEXI
 999
1000     {
1001         .name       = "migrate_set_speed",
1002         .args_type  = "value:o",
1003         .params     = "value",
1004         .help       = "set maximum speed (in bytes) for migrations. "
1005         "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
1006         .cmd        = hmp_migrate_set_speed,
1007     },
1008
1009 STEXI
1010 @item migrate_set_speed @var{value}
1011 @findex migrate_set_speed
1012 Set maximum speed to @var{value} (in bytes) for migrations.
1013 ETEXI
1014
1015     {
1016         .name       = "migrate_set_downtime",
1017         .args_type  = "value:T",
1018         .params     = "value",
1019         .help       = "set maximum tolerated downtime (in seconds) for migrations",
1020         .cmd        = hmp_migrate_set_downtime,
1021     },
1022
1023 STEXI
1024 @item migrate_set_downtime @var{second}
1025 @findex migrate_set_downtime
1026 Set maximum tolerated downtime (in seconds) for migration.
1027 ETEXI
1028
1029     {
1030         .name       = "migrate_set_capability",
1031         .args_type  = "capability:s,state:b",
1032         .params     = "capability state",
1033         .help       = "Enable/Disable the usage of a capability for migration",
1034         .cmd        = hmp_migrate_set_capability,
1035         .command_completion = migrate_set_capability_completion,
1036     },
1037
1038 STEXI
1039 @item migrate_set_capability @var{capability} @var{state}
1040 @findex migrate_set_capability
1041 Enable/Disable the usage of a capability @var{capability} for migration.
1042 ETEXI
1043
1044     {
1045         .name       = "migrate_set_parameter",
1046         .args_type  = "parameter:s,value:s",
1047         .params     = "parameter value",
1048         .help       = "Set the parameter for migration",
1049         .cmd        = hmp_migrate_set_parameter,
1050         .command_completion = migrate_set_parameter_completion,
1051     },
1052
1053 STEXI
1054 @item migrate_set_parameter @var{parameter} @var{value}
1055 @findex migrate_set_parameter
1056 Set the parameter @var{parameter} for migration.
1057 ETEXI
1058
1059     {
1060         .name       = "migrate_start_postcopy",
1061         .args_type  = "",
1062         .params     = "",
1063         .help       = "Followup to a migration command to switch the migration"
1064                       " to postcopy mode. The postcopy-ram capability must "
1065                       "be set before the original migration command.",
1066         .cmd        = hmp_migrate_start_postcopy,
1067     },
1068
1069 STEXI
1070 @item migrate_start_postcopy
1071 @findex migrate_start_postcopy
1072 Switch in-progress migration to postcopy mode. Ignored after the end of
1073 migration (or once already in postcopy).
1074 ETEXI
1075
1076     {
1077         .name       = "x_colo_lost_heartbeat",
1078         .args_type  = "",
1079         .params     = "",
1080         .help       = "Tell COLO that heartbeat is lost,\n\t\t\t"
1081                       "a failover or takeover is needed.",
1082         .cmd = hmp_x_colo_lost_heartbeat,
1083     },
1084
1085 STEXI
1086 @item x_colo_lost_heartbeat
1087 @findex x_colo_lost_heartbeat
1088 Tell COLO that heartbeat is lost, a failover or takeover is needed.
1089 ETEXI
1090
1091     {
1092         .name       = "client_migrate_info",
1093         .args_type  = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
1094         .params     = "protocol hostname port tls-port cert-subject",
1095         .help       = "set migration information for remote display",
1096         .cmd        = hmp_client_migrate_info,
1097     },
1098
1099 STEXI
1100 @item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
1101 @findex client_migrate_info
1102 Set migration information for remote display.  This makes the server
1103 ask the client to automatically reconnect using the new parameters
1104 once migration finished successfully.  Only implemented for SPICE.
1105 ETEXI
1106
1107     {
1108         .name       = "dump-guest-memory",
1109         .args_type  = "paging:-p,detach:-d,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:i?,length:i?",
1110         .params     = "[-p] [-d] [-z|-l|-s] filename [begin length]",
1111         .help       = "dump guest memory into file 'filename'.\n\t\t\t"
1112                       "-p: do paging to get guest's memory mapping.\n\t\t\t"
1113                       "-d: return immediately (do not wait for completion).\n\t\t\t"
1114                       "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
1115                       "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
1116                       "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
1117                       "begin: the starting physical address.\n\t\t\t"
1118                       "length: the memory size, in bytes.",
1119         .cmd        = hmp_dump_guest_memory,
1120     },
1121
1122
1123 STEXI
1124 @item dump-guest-memory [-p] @var{filename} @var{begin} @var{length}
1125 @item dump-guest-memory [-z|-l|-s] @var{filename}
1126 @findex dump-guest-memory
1127 Dump guest memory to @var{protocol}. The file can be processed with crash or
1128 gdb. Without -z|-l|-s, the dump format is ELF.
1129         -p: do paging to get guest's memory mapping.
1130         -z: dump in kdump-compressed format, with zlib compression.
1131         -l: dump in kdump-compressed format, with lzo compression.
1132         -s: dump in kdump-compressed format, with snappy compression.
1133   filename: dump file name.
1134      begin: the starting physical address. It's optional, and should be
1135             specified together with length.
1136     length: the memory size, in bytes. It's optional, and should be specified
1137             together with begin.
1138 ETEXI
1139
1140 #if defined(TARGET_S390X)
1141     {
1142         .name       = "dump-skeys",
1143         .args_type  = "filename:F",
1144         .params     = "",
1145         .help       = "Save guest storage keys into file 'filename'.\n",
1146         .cmd        = hmp_dump_skeys,
1147     },
1148 #endif
1149
1150 STEXI
1151 @item dump-skeys @var{filename}
1152 @findex dump-skeys
1153 Save guest storage keys to a file.
1154 ETEXI
1155
1156     {
1157         .name       = "snapshot_blkdev",
1158         .args_type  = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1159         .params     = "[-n] device [new-image-file] [format]",
1160         .help       = "initiates a live snapshot\n\t\t\t"
1161                       "of device. If a new image file is specified, the\n\t\t\t"
1162                       "new image file will become the new root image.\n\t\t\t"
1163                       "If format is specified, the snapshot file will\n\t\t\t"
1164                       "be created in that format.\n\t\t\t"
1165                       "The default format is qcow2.  The -n flag requests QEMU\n\t\t\t"
1166                       "to reuse the image found in new-image-file, instead of\n\t\t\t"
1167                       "recreating it from scratch.",
1168         .cmd        = hmp_snapshot_blkdev,
1169     },
1170
1171 STEXI
1172 @item snapshot_blkdev
1173 @findex snapshot_blkdev
1174 Snapshot device, using snapshot file as target if provided
1175 ETEXI
1176
1177     {
1178         .name       = "snapshot_blkdev_internal",
1179         .args_type  = "device:B,name:s",
1180         .params     = "device name",
1181         .help       = "take an internal snapshot of device.\n\t\t\t"
1182                       "The format of the image used by device must\n\t\t\t"
1183                       "support it, such as qcow2.\n\t\t\t",
1184         .cmd        = hmp_snapshot_blkdev_internal,
1185     },
1186
1187 STEXI
1188 @item snapshot_blkdev_internal
1189 @findex snapshot_blkdev_internal
1190 Take an internal snapshot on device if it support
1191 ETEXI
1192
1193     {
1194         .name       = "snapshot_delete_blkdev_internal",
1195         .args_type  = "device:B,name:s,id:s?",
1196         .params     = "device name [id]",
1197         .help       = "delete an internal snapshot of device.\n\t\t\t"
1198                       "If id is specified, qemu will try delete\n\t\t\t"
1199                       "the snapshot matching both id and name.\n\t\t\t"
1200                       "The format of the image used by device must\n\t\t\t"
1201                       "support it, such as qcow2.\n\t\t\t",
1202         .cmd        = hmp_snapshot_delete_blkdev_internal,
1203     },
1204
1205 STEXI
1206 @item snapshot_delete_blkdev_internal
1207 @findex snapshot_delete_blkdev_internal
1208 Delete an internal snapshot on device if it support
1209 ETEXI
1210
1211     {
1212         .name       = "drive_mirror",
1213         .args_type  = "reuse:-n,full:-f,device:B,target:s,format:s?",
1214         .params     = "[-n] [-f] device target [format]",
1215         .help       = "initiates live storage\n\t\t\t"
1216                       "migration for a device. The device's contents are\n\t\t\t"
1217                       "copied to the new image file, including data that\n\t\t\t"
1218                       "is written after the command is started.\n\t\t\t"
1219                       "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1220                       "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1221                       "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1222                       "so that the result does not need a backing file.\n\t\t\t",
1223         .cmd        = hmp_drive_mirror,
1224     },
1225 STEXI
1226 @item drive_mirror
1227 @findex drive_mirror
1228 Start mirroring a block device's writes to a new destination,
1229 using the specified target.
1230 ETEXI
1231
1232     {
1233         .name       = "drive_backup",
1234         .args_type  = "reuse:-n,full:-f,compress:-c,device:B,target:s,format:s?",
1235         .params     = "[-n] [-f] [-c] device target [format]",
1236         .help       = "initiates a point-in-time\n\t\t\t"
1237                       "copy for a device. The device's contents are\n\t\t\t"
1238                       "copied to the new image file, excluding data that\n\t\t\t"
1239                       "is written after the command is started.\n\t\t\t"
1240                       "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1241                       "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1242                       "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1243                       "so that the result does not need a backing file.\n\t\t\t"
1244                       "The -c flag requests QEMU to compress backup data\n\t\t\t"
1245                       "(if the target format supports it).\n\t\t\t",
1246         .cmd        = hmp_drive_backup,
1247     },
1248 STEXI
1249 @item drive_backup
1250 @findex drive_backup
1251 Start a point-in-time copy of a block device to a specificed target.
1252 ETEXI
1253
1254     {
1255         .name       = "drive_add",
1256         .args_type  = "node:-n,pci_addr:s,opts:s",
1257         .params     = "[-n] [[<domain>:]<bus>:]<slot>\n"
1258                       "[file=file][,if=type][,bus=n]\n"
1259                       "[,unit=m][,media=d][,index=i]\n"
1260                       "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
1261                       "[,snapshot=on|off][,cache=on|off]\n"
1262                       "[,readonly=on|off][,copy-on-read=on|off]",
1263         .help       = "add drive to PCI storage controller",
1264         .cmd        = hmp_drive_add,
1265     },
1266
1267 STEXI
1268 @item drive_add
1269 @findex drive_add
1270 Add drive to PCI storage controller.
1271 ETEXI
1272
1273     {
1274         .name       = "pcie_aer_inject_error",
1275         .args_type  = "advisory_non_fatal:-a,correctable:-c,"
1276                       "id:s,error_status:s,"
1277                       "header0:i?,header1:i?,header2:i?,header3:i?,"
1278                       "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1279         .params     = "[-a] [-c] id "
1280                       "<error_status> [<tlp header> [<tlp header prefix>]]",
1281         .help       = "inject pcie aer error\n\t\t\t"
1282                       " -a for advisory non fatal error\n\t\t\t"
1283                       " -c for correctable error\n\t\t\t"
1284                       "<id> = qdev device id\n\t\t\t"
1285                       "<error_status> = error string or 32bit\n\t\t\t"
1286                       "<tlb header> = 32bit x 4\n\t\t\t"
1287                       "<tlb header prefix> = 32bit x 4",
1288         .cmd        = hmp_pcie_aer_inject_error,
1289     },
1290
1291 STEXI
1292 @item pcie_aer_inject_error
1293 @findex pcie_aer_inject_error
1294 Inject PCIe AER error
1295 ETEXI
1296
1297     {
1298         .name       = "host_net_add",
1299         .args_type  = "device:s,opts:s?",
1300         .params     = "tap|user|socket|vde|netmap|bridge|vhost-user|dump [options]",
1301         .help       = "add host VLAN client (deprecated, use netdev_add instead)",
1302         .cmd        = hmp_host_net_add,
1303         .command_completion = host_net_add_completion,
1304     },
1305
1306 STEXI
1307 @item host_net_add
1308 @findex host_net_add
1309 Add host VLAN client. Deprecated, please use @code{netdev_add} instead.
1310 ETEXI
1311
1312     {
1313         .name       = "host_net_remove",
1314         .args_type  = "vlan_id:i,device:s",
1315         .params     = "vlan_id name",
1316         .help       = "remove host VLAN client (deprecated, use netdev_del instead)",
1317         .cmd        = hmp_host_net_remove,
1318         .command_completion = host_net_remove_completion,
1319     },
1320
1321 STEXI
1322 @item host_net_remove
1323 @findex host_net_remove
1324 Remove host VLAN client. Deprecated, please use @code{netdev_del} instead.
1325 ETEXI
1326
1327     {
1328         .name       = "netdev_add",
1329         .args_type  = "netdev:O",
1330         .params     = "[user|tap|socket|vde|bridge|hubport|netmap|vhost-user],id=str[,prop=value][,...]",
1331         .help       = "add host network device",
1332         .cmd        = hmp_netdev_add,
1333         .command_completion = netdev_add_completion,
1334     },
1335
1336 STEXI
1337 @item netdev_add
1338 @findex netdev_add
1339 Add host network device.
1340 ETEXI
1341
1342     {
1343         .name       = "netdev_del",
1344         .args_type  = "id:s",
1345         .params     = "id",
1346         .help       = "remove host network device",
1347         .cmd        = hmp_netdev_del,
1348         .command_completion = netdev_del_completion,
1349     },
1350
1351 STEXI
1352 @item netdev_del
1353 @findex netdev_del
1354 Remove host network device.
1355 ETEXI
1356
1357     {
1358         .name       = "object_add",
1359         .args_type  = "object:O",
1360         .params     = "[qom-type=]type,id=str[,prop=value][,...]",
1361         .help       = "create QOM object",
1362         .cmd        = hmp_object_add,
1363         .command_completion = object_add_completion,
1364     },
1365
1366 STEXI
1367 @item object_add
1368 @findex object_add
1369 Create QOM object.
1370 ETEXI
1371
1372     {
1373         .name       = "object_del",
1374         .args_type  = "id:s",
1375         .params     = "id",
1376         .help       = "destroy QOM object",
1377         .cmd        = hmp_object_del,
1378         .command_completion = object_del_completion,
1379     },
1380
1381 STEXI
1382 @item object_del
1383 @findex object_del
1384 Destroy QOM object.
1385 ETEXI
1386
1387 #ifdef CONFIG_SLIRP
1388     {
1389         .name       = "hostfwd_add",
1390         .args_type  = "arg1:s,arg2:s?,arg3:s?",
1391         .params     = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1392         .help       = "redirect TCP or UDP connections from host to guest (requires -net user)",
1393         .cmd        = hmp_hostfwd_add,
1394     },
1395 #endif
1396 STEXI
1397 @item hostfwd_add
1398 @findex hostfwd_add
1399 Redirect TCP or UDP connections from host to guest (requires -net user).
1400 ETEXI
1401
1402 #ifdef CONFIG_SLIRP
1403     {
1404         .name       = "hostfwd_remove",
1405         .args_type  = "arg1:s,arg2:s?,arg3:s?",
1406         .params     = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1407         .help       = "remove host-to-guest TCP or UDP redirection",
1408         .cmd        = hmp_hostfwd_remove,
1409     },
1410
1411 #endif
1412 STEXI
1413 @item hostfwd_remove
1414 @findex hostfwd_remove
1415 Remove host-to-guest TCP or UDP redirection.
1416 ETEXI
1417
1418     {
1419         .name       = "balloon",
1420         .args_type  = "value:M",
1421         .params     = "target",
1422         .help       = "request VM to change its memory allocation (in MB)",
1423         .cmd        = hmp_balloon,
1424     },
1425
1426 STEXI
1427 @item balloon @var{value}
1428 @findex balloon
1429 Request VM to change its memory allocation to @var{value} (in MB).
1430 ETEXI
1431
1432     {
1433         .name       = "set_link",
1434         .args_type  = "name:s,up:b",
1435         .params     = "name on|off",
1436         .help       = "change the link status of a network adapter",
1437         .cmd        = hmp_set_link,
1438         .command_completion = set_link_completion,
1439     },
1440
1441 STEXI
1442 @item set_link @var{name} [on|off]
1443 @findex set_link
1444 Switch link @var{name} on (i.e. up) or off (i.e. down).
1445 ETEXI
1446
1447     {
1448         .name       = "watchdog_action",
1449         .args_type  = "action:s",
1450         .params     = "[reset|shutdown|poweroff|pause|debug|none]",
1451         .help       = "change watchdog action",
1452         .cmd        = hmp_watchdog_action,
1453         .command_completion = watchdog_action_completion,
1454     },
1455
1456 STEXI
1457 @item watchdog_action
1458 @findex watchdog_action
1459 Change watchdog action.
1460 ETEXI
1461
1462     {
1463         .name       = "acl_show",
1464         .args_type  = "aclname:s",
1465         .params     = "aclname",
1466         .help       = "list rules in the access control list",
1467         .cmd        = hmp_acl_show,
1468     },
1469
1470 STEXI
1471 @item acl_show @var{aclname}
1472 @findex acl_show
1473 List all the matching rules in the access control list, and the default
1474 policy. There are currently two named access control lists,
1475 @var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1476 certificate distinguished name, and SASL username respectively.
1477 ETEXI
1478
1479     {
1480         .name       = "acl_policy",
1481         .args_type  = "aclname:s,policy:s",
1482         .params     = "aclname allow|deny",
1483         .help       = "set default access control list policy",
1484         .cmd        = hmp_acl_policy,
1485     },
1486
1487 STEXI
1488 @item acl_policy @var{aclname} @code{allow|deny}
1489 @findex acl_policy
1490 Set the default access control list policy, used in the event that
1491 none of the explicit rules match. The default policy at startup is
1492 always @code{deny}.
1493 ETEXI
1494
1495     {
1496         .name       = "acl_add",
1497         .args_type  = "aclname:s,match:s,policy:s,index:i?",
1498         .params     = "aclname match allow|deny [index]",
1499         .help       = "add a match rule to the access control list",
1500         .cmd        = hmp_acl_add,
1501     },
1502
1503 STEXI
1504 @item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1505 @findex acl_add
1506 Add a match rule to the access control list, allowing or denying access.
1507 The match will normally be an exact username or x509 distinguished name,
1508 but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1509 allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
1510 normally be appended to the end of the ACL, but can be inserted
1511 earlier in the list if the optional @var{index} parameter is supplied.
1512 ETEXI
1513
1514     {
1515         .name       = "acl_remove",
1516         .args_type  = "aclname:s,match:s",
1517         .params     = "aclname match",
1518         .help       = "remove a match rule from the access control list",
1519         .cmd        = hmp_acl_remove,
1520     },
1521
1522 STEXI
1523 @item acl_remove @var{aclname} @var{match}
1524 @findex acl_remove
1525 Remove the specified match rule from the access control list.
1526 ETEXI
1527
1528     {
1529         .name       = "acl_reset",
1530         .args_type  = "aclname:s",
1531         .params     = "aclname",
1532         .help       = "reset the access control list",
1533         .cmd        = hmp_acl_reset,
1534     },
1535
1536 STEXI
1537 @item acl_reset @var{aclname}
1538 @findex acl_reset
1539 Remove all matches from the access control list, and set the default
1540 policy back to @code{deny}.
1541 ETEXI
1542
1543     {
1544         .name       = "nbd_server_start",
1545         .args_type  = "all:-a,writable:-w,uri:s",
1546         .params     = "nbd_server_start [-a] [-w] host:port",
1547         .help       = "serve block devices on the given host and port",
1548         .cmd        = hmp_nbd_server_start,
1549     },
1550 STEXI
1551 @item nbd_server_start @var{host}:@var{port}
1552 @findex nbd_server_start
1553 Start an NBD server on the given host and/or port.  If the @option{-a}
1554 option is included, all of the virtual machine's block devices that
1555 have an inserted media on them are automatically exported; in this case,
1556 the @option{-w} option makes the devices writable too.
1557 ETEXI
1558
1559     {
1560         .name       = "nbd_server_add",
1561         .args_type  = "writable:-w,device:B",
1562         .params     = "nbd_server_add [-w] device",
1563         .help       = "export a block device via NBD",
1564         .cmd        = hmp_nbd_server_add,
1565     },
1566 STEXI
1567 @item nbd_server_add @var{device}
1568 @findex nbd_server_add
1569 Export a block device through QEMU's NBD server, which must be started
1570 beforehand with @command{nbd_server_start}.  The @option{-w} option makes the
1571 exported device writable too.
1572 ETEXI
1573
1574     {
1575         .name       = "nbd_server_stop",
1576         .args_type  = "",
1577         .params     = "nbd_server_stop",
1578         .help       = "stop serving block devices using the NBD protocol",
1579         .cmd        = hmp_nbd_server_stop,
1580     },
1581 STEXI
1582 @item nbd_server_stop
1583 @findex nbd_server_stop
1584 Stop the QEMU embedded NBD server.
1585 ETEXI
1586
1587
1588 #if defined(TARGET_I386)
1589
1590     {
1591         .name       = "mce",
1592         .args_type  = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1593         .params     = "[-b] cpu bank status mcgstatus addr misc",
1594         .help       = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1595         .cmd        = hmp_mce,
1596     },
1597
1598 #endif
1599 STEXI
1600 @item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
1601 @findex mce (x86)
1602 Inject an MCE on the given CPU (x86 only).
1603 ETEXI
1604
1605     {
1606         .name       = "getfd",
1607         .args_type  = "fdname:s",
1608         .params     = "getfd name",
1609         .help       = "receive a file descriptor via SCM rights and assign it a name",
1610         .cmd        = hmp_getfd,
1611     },
1612
1613 STEXI
1614 @item getfd @var{fdname}
1615 @findex getfd
1616 If a file descriptor is passed alongside this command using the SCM_RIGHTS
1617 mechanism on unix sockets, it is stored using the name @var{fdname} for
1618 later use by other monitor commands.
1619 ETEXI
1620
1621     {
1622         .name       = "closefd",
1623         .args_type  = "fdname:s",
1624         .params     = "closefd name",
1625         .help       = "close a file descriptor previously passed via SCM rights",
1626         .cmd        = hmp_closefd,
1627     },
1628
1629 STEXI
1630 @item closefd @var{fdname}
1631 @findex closefd
1632 Close the file descriptor previously assigned to @var{fdname} using the
1633 @code{getfd} command. This is only needed if the file descriptor was never
1634 used by another monitor command.
1635 ETEXI
1636
1637     {
1638         .name       = "block_passwd",
1639         .args_type  = "device:B,password:s",
1640         .params     = "block_passwd device password",
1641         .help       = "set the password of encrypted block devices",
1642         .cmd        = hmp_block_passwd,
1643     },
1644
1645 STEXI
1646 @item block_passwd @var{device} @var{password}
1647 @findex block_passwd
1648 Set the encrypted device @var{device} password to @var{password}
1649 ETEXI
1650
1651     {
1652         .name       = "block_set_io_throttle",
1653         .args_type  = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1654         .params     = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1655         .help       = "change I/O throttle limits for a block drive",
1656         .cmd        = hmp_block_set_io_throttle,
1657     },
1658
1659 STEXI
1660 @item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1661 @findex block_set_io_throttle
1662 Change I/O throttle limits for a block drive to @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1663 ETEXI
1664
1665     {
1666         .name       = "set_password",
1667         .args_type  = "protocol:s,password:s,connected:s?",
1668         .params     = "protocol password action-if-connected",
1669         .help       = "set spice/vnc password",
1670         .cmd        = hmp_set_password,
1671     },
1672
1673 STEXI
1674 @item set_password [ vnc | spice ] password [ action-if-connected ]
1675 @findex set_password
1676 Change spice/vnc password.  Use zero to make the password stay valid
1677 forever.  @var{action-if-connected} specifies what should happen in
1678 case a connection is established: @var{fail} makes the password change
1679 fail.  @var{disconnect} changes the password and disconnects the
1680 client.  @var{keep} changes the password and keeps the connection up.
1681 @var{keep} is the default.
1682 ETEXI
1683
1684     {
1685         .name       = "expire_password",
1686         .args_type  = "protocol:s,time:s",
1687         .params     = "protocol time",
1688         .help       = "set spice/vnc password expire-time",
1689         .cmd        = hmp_expire_password,
1690     },
1691
1692 STEXI
1693 @item expire_password [ vnc | spice ] expire-time
1694 @findex expire_password
1695 Specify when a password for spice/vnc becomes
1696 invalid. @var{expire-time} accepts:
1697
1698 @table @var
1699 @item now
1700 Invalidate password instantly.
1701
1702 @item never
1703 Password stays valid forever.
1704
1705 @item +nsec
1706 Password stays valid for @var{nsec} seconds starting now.
1707
1708 @item nsec
1709 Password is invalidated at the given time.  @var{nsec} are the seconds
1710 passed since 1970, i.e. unix epoch.
1711
1712 @end table
1713 ETEXI
1714
1715     {
1716         .name       = "chardev-add",
1717         .args_type  = "args:s",
1718         .params     = "args",
1719         .help       = "add chardev",
1720         .cmd        = hmp_chardev_add,
1721         .command_completion = chardev_add_completion,
1722     },
1723
1724 STEXI
1725 @item chardev-add args
1726 @findex chardev-add
1727 chardev_add accepts the same parameters as the -chardev command line switch.
1728
1729 ETEXI
1730
1731     {
1732         .name       = "chardev-remove",
1733         .args_type  = "id:s",
1734         .params     = "id",
1735         .help       = "remove chardev",
1736         .cmd        = hmp_chardev_remove,
1737         .command_completion = chardev_remove_completion,
1738     },
1739
1740 STEXI
1741 @item chardev-remove id
1742 @findex chardev-remove
1743 Removes the chardev @var{id}.
1744
1745 ETEXI
1746
1747     {
1748         .name       = "qemu-io",
1749         .args_type  = "device:B,command:s",
1750         .params     = "[device] \"[command]\"",
1751         .help       = "run a qemu-io command on a block device",
1752         .cmd        = hmp_qemu_io,
1753     },
1754
1755 STEXI
1756 @item qemu-io @var{device} @var{command}
1757 @findex qemu-io
1758 Executes a qemu-io command on the given block device.
1759
1760 ETEXI
1761
1762     {
1763         .name       = "cpu-add",
1764         .args_type  = "id:i",
1765         .params     = "id",
1766         .help       = "add cpu",
1767         .cmd        = hmp_cpu_add,
1768     },
1769
1770 STEXI
1771 @item cpu-add @var{id}
1772 @findex cpu-add
1773 Add CPU with id @var{id}
1774 ETEXI
1775
1776     {
1777         .name       = "qom-list",
1778         .args_type  = "path:s?",
1779         .params     = "path",
1780         .help       = "list QOM properties",
1781         .cmd        = hmp_qom_list,
1782     },
1783
1784 STEXI
1785 @item qom-list [@var{path}]
1786 Print QOM properties of object at location @var{path}
1787 ETEXI
1788
1789     {
1790         .name       = "qom-set",
1791         .args_type  = "path:s,property:s,value:s",
1792         .params     = "path property value",
1793         .help       = "set QOM property",
1794         .cmd        = hmp_qom_set,
1795     },
1796
1797 STEXI
1798 @item qom-set @var{path} @var{property} @var{value}
1799 Set QOM property @var{property} of object at location @var{path} to value @var{value}
1800 ETEXI
1801
1802     {
1803         .name       = "info",
1804         .args_type  = "item:s?",
1805         .params     = "[subcommand]",
1806         .help       = "show various information about the system state",
1807         .cmd        = hmp_info_help,
1808         .sub_table  = info_cmds,
1809     },
1810
1811 STEXI
1812 @end table
1813 ETEXI