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       = "p|print",
 530         .args_type  = "fmt:/,val:l",
 531         .params     = "/fmt expr",
 532         .help       = "print expression value (use $reg for CPU register access)",
 533         .cmd        = do_print,
 534     },
 535
 536 STEXI
 537 @item p or print/@var{fmt} @var{expr}
 538 @findex print
 539 Print expression value. Only the @var{format} part of @var{fmt} is
 540 used.
 541 ETEXI
 542
 543     {
 544         .name       = "i",
 545         .args_type  = "fmt:/,addr:i,index:i.",
 546         .params     = "/fmt addr",
 547         .help       = "I/O port read",
 548         .cmd        = hmp_ioport_read,
 549     },
 550
 551 STEXI
 552 @item i/@var{fmt} @var{addr} [.@var{index}]
 553 @findex i
 554 Read I/O port.
 555 ETEXI
 556
 557     {
 558         .name       = "o",
 559         .args_type  = "fmt:/,addr:i,val:i",
 560         .params     = "/fmt addr value",
 561         .help       = "I/O port write",
 562         .cmd        = hmp_ioport_write,
 563     },
 564
 565 STEXI
 566 @item o/@var{fmt} @var{addr} @var{val}
 567 @findex o
 568 Write to I/O port.
 569 ETEXI
 570
 571     {
 572         .name       = "sendkey",
 573         .args_type  = "keys:s,hold-time:i?",
 574         .params     = "keys [hold_ms]",
 575         .help       = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
 576         .cmd        = hmp_sendkey,
 577         .command_completion = sendkey_completion,
 578     },
 579
 580 STEXI
 581 @item sendkey @var{keys}
 582 @findex sendkey
 583 Send @var{keys} to the guest. @var{keys} could be the name of the
 584 key or the raw value in hexadecimal format. Use @code{-} to press
 585 several keys simultaneously. Example:
 586 @example
 587 sendkey ctrl-alt-f1
 588 @end example
 589
 590 This command is useful to send keys that your graphical user interface
 591 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
 592 ETEXI
 593
 594     {
 595         .name       = "system_reset",
 596         .args_type  = "",
 597         .params     = "",
 598         .help       = "reset the system",
 599         .cmd        = hmp_system_reset,
 600     },
 601
 602 STEXI
 603 @item system_reset
 604 @findex system_reset
 605 Reset the system.
 606 ETEXI
 607
 608     {
 609         .name       = "system_powerdown",
 610         .args_type  = "",
 611         .params     = "",
 612         .help       = "send system power down event",
 613         .cmd        = hmp_system_powerdown,
 614     },
 615
 616 STEXI
 617 @item system_powerdown
 618 @findex system_powerdown
 619 Power down the system (if supported).
 620 ETEXI
 621
 622     {
 623         .name       = "sum",
 624         .args_type  = "start:i,size:i",
 625         .params     = "addr size",
 626         .help       = "compute the checksum of a memory region",
 627         .cmd        = hmp_sum,
 628     },
 629
 630 STEXI
 631 @item sum @var{addr} @var{size}
 632 @findex sum
 633 Compute the checksum of a memory region.
 634 ETEXI
 635
 636     {
 637         .name       = "usb_add",
 638         .args_type  = "devname:s",
 639         .params     = "device",
 640         .help       = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
 641         .cmd        = hmp_usb_add,
 642     },
 643
 644 STEXI
 645 @item usb_add @var{devname}
 646 @findex usb_add
 647 Add the USB device @var{devname}.  For details of available devices see
 648 @ref{usb_devices}
 649 ETEXI
 650
 651     {
 652         .name       = "usb_del",
 653         .args_type  = "devname:s",
 654         .params     = "device",
 655         .help       = "remove USB device 'bus.addr'",
 656         .cmd        = hmp_usb_del,
 657     },
 658
 659 STEXI
 660 @item usb_del @var{devname}
 661 @findex usb_del
 662 Remove the USB device @var{devname} from the QEMU virtual USB
 663 hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
 664 command @code{info usb} to see the devices you can remove.
 665 ETEXI
 666
 667     {
 668         .name       = "device_add",
 669         .args_type  = "device:O",
 670         .params     = "driver[,prop=value][,...]",
 671         .help       = "add device, like -device on the command line",
 672         .cmd        = hmp_device_add,
 673         .command_completion = device_add_completion,
 674     },
 675
 676 STEXI
 677 @item device_add @var{config}
 678 @findex device_add
 679 Add device.
 680 ETEXI
 681
 682     {
 683         .name       = "device_del",
 684         .args_type  = "id:s",
 685         .params     = "device",
 686         .help       = "remove device",
 687         .cmd        = hmp_device_del,
 688         .command_completion = device_del_completion,
 689     },
 690
 691 STEXI
 692 @item device_del @var{id}
 693 @findex device_del
 694 Remove device @var{id}. @var{id} may be a short ID
 695 or a QOM object path.
 696 ETEXI
 697
 698     {
 699         .name       = "cpu",
 700         .args_type  = "index:i",
 701         .params     = "index",
 702         .help       = "set the default CPU",
 703         .cmd        = hmp_cpu,
 704     },
 705
 706 STEXI
 707 @item cpu @var{index}
 708 @findex cpu
 709 Set the default CPU.
 710 ETEXI
 711
 712     {
 713         .name       = "mouse_move",
 714         .args_type  = "dx_str:s,dy_str:s,dz_str:s?",
 715         .params     = "dx dy [dz]",
 716         .help       = "send mouse move events",
 717         .cmd        = hmp_mouse_move,
 718     },
 719
 720 STEXI
 721 @item mouse_move @var{dx} @var{dy} [@var{dz}]
 722 @findex mouse_move
 723 Move the active mouse to the specified coordinates @var{dx} @var{dy}
 724 with optional scroll axis @var{dz}.
 725 ETEXI
 726
 727     {
 728         .name       = "mouse_button",
 729         .args_type  = "button_state:i",
 730         .params     = "state",
 731         .help       = "change mouse button state (1=L, 2=M, 4=R)",
 732         .cmd        = hmp_mouse_button,
 733     },
 734
 735 STEXI
 736 @item mouse_button @var{val}
 737 @findex mouse_button
 738 Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
 739 ETEXI
 740
 741     {
 742         .name       = "mouse_set",
 743         .args_type  = "index:i",
 744         .params     = "index",
 745         .help       = "set which mouse device receives events",
 746         .cmd        = hmp_mouse_set,
 747     },
 748
 749 STEXI
 750 @item mouse_set @var{index}
 751 @findex mouse_set
 752 Set which mouse device receives events at given @var{index}, index
 753 can be obtained with
 754 @example
 755 info mice
 756 @end example
 757 ETEXI
 758
 759     {
 760         .name       = "wavcapture",
 761         .args_type  = "path:F,freq:i?,bits:i?,nchannels:i?",
 762         .params     = "path [frequency [bits [channels]]]",
 763         .help       = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
 764         .cmd        = hmp_wavcapture,
 765     },
 766 STEXI
 767 @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
 768 @findex wavcapture
 769 Capture audio into @var{filename}. Using sample rate @var{frequency}
 770 bits per sample @var{bits} and number of channels @var{channels}.
 771
 772 Defaults:
 773 @itemize @minus
 774 @item Sample rate = 44100 Hz - CD quality
 775 @item Bits = 16
 776 @item Number of channels = 2 - Stereo
 777 @end itemize
 778 ETEXI
 779
 780     {
 781         .name       = "stopcapture",
 782         .args_type  = "n:i",
 783         .params     = "capture index",
 784         .help       = "stop capture",
 785         .cmd        = hmp_stopcapture,
 786     },
 787 STEXI
 788 @item stopcapture @var{index}
 789 @findex stopcapture
 790 Stop capture with a given @var{index}, index can be obtained with
 791 @example
 792 info capture
 793 @end example
 794 ETEXI
 795
 796     {
 797         .name       = "memsave",
 798         .args_type  = "val:l,size:i,filename:s",
 799         .params     = "addr size file",
 800         .help       = "save to disk virtual memory dump starting at 'addr' of size 'size'",
 801         .cmd        = hmp_memsave,
 802     },
 803
 804 STEXI
 805 @item memsave @var{addr} @var{size} @var{file}
 806 @findex memsave
 807 save to disk virtual memory dump starting at @var{addr} of size @var{size}.
 808 ETEXI
 809
 810     {
 811         .name       = "pmemsave",
 812         .args_type  = "val:l,size:i,filename:s",
 813         .params     = "addr size file",
 814         .help       = "save to disk physical memory dump starting at 'addr' of size 'size'",
 815         .cmd        = hmp_pmemsave,
 816     },
 817
 818 STEXI
 819 @item pmemsave @var{addr} @var{size} @var{file}
 820 @findex pmemsave
 821 save to disk physical memory dump starting at @var{addr} of size @var{size}.
 822 ETEXI
 823
 824     {
 825         .name       = "boot_set",
 826         .args_type  = "bootdevice:s",
 827         .params     = "bootdevice",
 828         .help       = "define new values for the boot device list",
 829         .cmd        = hmp_boot_set,
 830     },
 831
 832 STEXI
 833 @item boot_set @var{bootdevicelist}
 834 @findex boot_set
 835 Define new values for the boot device list. Those values will override
 836 the values specified on the command line through the @code{-boot} option.
 837
 838 The values that can be specified here depend on the machine type, but are
 839 the same that can be specified in the @code{-boot} command line option.
 840 ETEXI
 841
 842     {
 843         .name       = "nmi",
 844         .args_type  = "",
 845         .params     = "",
 846         .help       = "inject an NMI",
 847         .cmd        = hmp_nmi,
 848     },
 849 STEXI
 850 @item nmi @var{cpu}
 851 @findex nmi
 852 Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
 853
 854 ETEXI
 855
 856     {
 857         .name       = "ringbuf_write",
 858         .args_type  = "device:s,data:s",
 859         .params     = "device data",
 860         .help       = "Write to a ring buffer character device",
 861         .cmd        = hmp_ringbuf_write,
 862         .command_completion = ringbuf_write_completion,
 863     },
 864
 865 STEXI
 866 @item ringbuf_write @var{device} @var{data}
 867 @findex ringbuf_write
 868 Write @var{data} to ring buffer character device @var{device}.
 869 @var{data} must be a UTF-8 string.
 870
 871 ETEXI
 872
 873     {
 874         .name       = "ringbuf_read",
 875         .args_type  = "device:s,size:i",
 876         .params     = "device size",
 877         .help       = "Read from a ring buffer character device",
 878         .cmd        = hmp_ringbuf_read,
 879         .command_completion = ringbuf_write_completion,
 880     },
 881
 882 STEXI
 883 @item ringbuf_read @var{device}
 884 @findex ringbuf_read
 885 Read and print up to @var{size} bytes from ring buffer character
 886 device @var{device}.
 887 Certain non-printable characters are printed \uXXXX, where XXXX is the
 888 character code in hexadecimal.  Character \ is printed \\.
 889 Bug: can screw up when the buffer contains invalid UTF-8 sequences,
 890 NUL characters, after the ring buffer lost data, and when reading
 891 stops because the size limit is reached.
 892
 893 ETEXI
 894
 895     {
 896         .name       = "migrate",
 897         .args_type  = "detach:-d,blk:-b,inc:-i,uri:s",
 898         .params     = "[-d] [-b] [-i] uri",
 899         .help       = "migrate to URI (using -d to not wait for completion)"
 900                       "\n\t\t\t -b for migration without shared storage with"
 901                       " full copy of disk\n\t\t\t -i for migration without "
 902                       "shared storage with incremental copy of disk "
 903                       "(base image shared between src and destination)",
 904         .cmd        = hmp_migrate,
 905     },
 906
 907
 908 STEXI
 909 @item migrate [-d] [-b] [-i] @var{uri}
 910 @findex migrate
 911 Migrate to @var{uri} (using -d to not wait for completion).
 912         -b for migration with full copy of disk
 913         -i for migration with incremental copy of disk (base image is shared)
 914 ETEXI
 915
 916     {
 917         .name       = "migrate_cancel",
 918         .args_type  = "",
 919         .params     = "",
 920         .help       = "cancel the current VM migration",
 921         .cmd        = hmp_migrate_cancel,
 922     },
 923
 924 STEXI
 925 @item migrate_cancel
 926 @findex migrate_cancel
 927 Cancel the current VM migration.
 928
 929 ETEXI
 930
 931     {
 932         .name       = "migrate_incoming",
 933         .args_type  = "uri:s",
 934         .params     = "uri",
 935         .help       = "Continue an incoming migration from an -incoming defer",
 936         .cmd        = hmp_migrate_incoming,
 937     },
 938
 939 STEXI
 940 @item migrate_incoming @var{uri}
 941 @findex migrate_incoming
 942 Continue an incoming migration using the @var{uri} (that has the same syntax
 943 as the -incoming option).
 944
 945 ETEXI
 946
 947     {
 948         .name       = "migrate_set_cache_size",
 949         .args_type  = "value:o",
 950         .params     = "value",
 951         .help       = "set cache size (in bytes) for XBZRLE migrations,"
 952                       "the cache size will be rounded down to the nearest "
 953                       "power of 2.\n"
 954                       "The cache size affects the number of cache misses."
 955                       "In case of a high cache miss ratio you need to increase"
 956                       " the cache size",
 957         .cmd        = hmp_migrate_set_cache_size,
 958     },
 959
 960 STEXI
 961 @item migrate_set_cache_size @var{value}
 962 @findex migrate_set_cache_size
 963 Set cache size to @var{value} (in bytes) for xbzrle migrations.
 964 ETEXI
 965
 966     {
 967         .name       = "migrate_set_speed",
 968         .args_type  = "value:o",
 969         .params     = "value",
 970         .help       = "set maximum speed (in bytes) for migrations. "
 971         "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
 972         .cmd        = hmp_migrate_set_speed,
 973     },
 974
 975 STEXI
 976 @item migrate_set_speed @var{value}
 977 @findex migrate_set_speed
 978 Set maximum speed to @var{value} (in bytes) for migrations.
 979 ETEXI
 980
 981     {
 982         .name       = "migrate_set_downtime",
 983         .args_type  = "value:T",
 984         .params     = "value",
 985         .help       = "set maximum tolerated downtime (in seconds) for migrations",
 986         .cmd        = hmp_migrate_set_downtime,
 987     },
 988
 989 STEXI
 990 @item migrate_set_downtime @var{second}
 991 @findex migrate_set_downtime
 992 Set maximum tolerated downtime (in seconds) for migration.
 993 ETEXI
 994
 995     {
 996         .name       = "migrate_set_capability",
 997         .args_type  = "capability:s,state:b",
 998         .params     = "capability state",
 999         .help       = "Enable/Disable the usage of a capability for migration",
1000         .cmd        = hmp_migrate_set_capability,
1001         .command_completion = migrate_set_capability_completion,
1002     },
1003
1004 STEXI
1005 @item migrate_set_capability @var{capability} @var{state}
1006 @findex migrate_set_capability
1007 Enable/Disable the usage of a capability @var{capability} for migration.
1008 ETEXI
1009
1010     {
1011         .name       = "migrate_set_parameter",
1012         .args_type  = "parameter:s,value:s",
1013         .params     = "parameter value",
1014         .help       = "Set the parameter for migration",
1015         .cmd        = hmp_migrate_set_parameter,
1016         .command_completion = migrate_set_parameter_completion,
1017     },
1018
1019 STEXI
1020 @item migrate_set_parameter @var{parameter} @var{value}
1021 @findex migrate_set_parameter
1022 Set the parameter @var{parameter} for migration.
1023 ETEXI
1024
1025     {
1026         .name       = "migrate_start_postcopy",
1027         .args_type  = "",
1028         .params     = "",
1029         .help       = "Followup to a migration command to switch the migration"
1030                       " to postcopy mode. The postcopy-ram capability must "
1031                       "be set before the original migration command.",
1032         .cmd        = hmp_migrate_start_postcopy,
1033     },
1034
1035 STEXI
1036 @item migrate_start_postcopy
1037 @findex migrate_start_postcopy
1038 Switch in-progress migration to postcopy mode. Ignored after the end of
1039 migration (or once already in postcopy).
1040 ETEXI
1041
1042     {
1043         .name       = "client_migrate_info",
1044         .args_type  = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
1045         .params     = "protocol hostname port tls-port cert-subject",
1046         .help       = "set migration information for remote display",
1047         .cmd        = hmp_client_migrate_info,
1048     },
1049
1050 STEXI
1051 @item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
1052 @findex client_migrate_info
1053 Set migration information for remote display.  This makes the server
1054 ask the client to automatically reconnect using the new parameters
1055 once migration finished successfully.  Only implemented for SPICE.
1056 ETEXI
1057
1058     {
1059         .name       = "dump-guest-memory",
1060         .args_type  = "paging:-p,detach:-d,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:i?,length:i?",
1061         .params     = "[-p] [-d] [-z|-l|-s] filename [begin length]",
1062         .help       = "dump guest memory into file 'filename'.\n\t\t\t"
1063                       "-p: do paging to get guest's memory mapping.\n\t\t\t"
1064                       "-d: return immediately (do not wait for completion).\n\t\t\t"
1065                       "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
1066                       "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
1067                       "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
1068                       "begin: the starting physical address.\n\t\t\t"
1069                       "length: the memory size, in bytes.",
1070         .cmd        = hmp_dump_guest_memory,
1071     },
1072
1073
1074 STEXI
1075 @item dump-guest-memory [-p] @var{filename} @var{begin} @var{length}
1076 @item dump-guest-memory [-z|-l|-s] @var{filename}
1077 @findex dump-guest-memory
1078 Dump guest memory to @var{protocol}. The file can be processed with crash or
1079 gdb. Without -z|-l|-s, the dump format is ELF.
1080         -p: do paging to get guest's memory mapping.
1081         -z: dump in kdump-compressed format, with zlib compression.
1082         -l: dump in kdump-compressed format, with lzo compression.
1083         -s: dump in kdump-compressed format, with snappy compression.
1084   filename: dump file name.
1085      begin: the starting physical address. It's optional, and should be
1086             specified together with length.
1087     length: the memory size, in bytes. It's optional, and should be specified
1088             together with begin.
1089 ETEXI
1090
1091 #if defined(TARGET_S390X)
1092     {
1093         .name       = "dump-skeys",
1094         .args_type  = "filename:F",
1095         .params     = "",
1096         .help       = "Save guest storage keys into file 'filename'.\n",
1097         .cmd        = hmp_dump_skeys,
1098     },
1099 #endif
1100
1101 STEXI
1102 @item dump-skeys @var{filename}
1103 @findex dump-skeys
1104 Save guest storage keys to a file.
1105 ETEXI
1106
1107     {
1108         .name       = "snapshot_blkdev",
1109         .args_type  = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1110         .params     = "[-n] device [new-image-file] [format]",
1111         .help       = "initiates a live snapshot\n\t\t\t"
1112                       "of device. If a new image file is specified, the\n\t\t\t"
1113                       "new image file will become the new root image.\n\t\t\t"
1114                       "If format is specified, the snapshot file will\n\t\t\t"
1115                       "be created in that format.\n\t\t\t"
1116                       "The default format is qcow2.  The -n flag requests QEMU\n\t\t\t"
1117                       "to reuse the image found in new-image-file, instead of\n\t\t\t"
1118                       "recreating it from scratch.",
1119         .cmd        = hmp_snapshot_blkdev,
1120     },
1121
1122 STEXI
1123 @item snapshot_blkdev
1124 @findex snapshot_blkdev
1125 Snapshot device, using snapshot file as target if provided
1126 ETEXI
1127
1128     {
1129         .name       = "snapshot_blkdev_internal",
1130         .args_type  = "device:B,name:s",
1131         .params     = "device name",
1132         .help       = "take an internal snapshot of device.\n\t\t\t"
1133                       "The format of the image used by device must\n\t\t\t"
1134                       "support it, such as qcow2.\n\t\t\t",
1135         .cmd        = hmp_snapshot_blkdev_internal,
1136     },
1137
1138 STEXI
1139 @item snapshot_blkdev_internal
1140 @findex snapshot_blkdev_internal
1141 Take an internal snapshot on device if it support
1142 ETEXI
1143
1144     {
1145         .name       = "snapshot_delete_blkdev_internal",
1146         .args_type  = "device:B,name:s,id:s?",
1147         .params     = "device name [id]",
1148         .help       = "delete an internal snapshot of device.\n\t\t\t"
1149                       "If id is specified, qemu will try delete\n\t\t\t"
1150                       "the snapshot matching both id and name.\n\t\t\t"
1151                       "The format of the image used by device must\n\t\t\t"
1152                       "support it, such as qcow2.\n\t\t\t",
1153         .cmd        = hmp_snapshot_delete_blkdev_internal,
1154     },
1155
1156 STEXI
1157 @item snapshot_delete_blkdev_internal
1158 @findex snapshot_delete_blkdev_internal
1159 Delete an internal snapshot on device if it support
1160 ETEXI
1161
1162     {
1163         .name       = "drive_mirror",
1164         .args_type  = "reuse:-n,full:-f,device:B,target:s,format:s?",
1165         .params     = "[-n] [-f] device target [format]",
1166         .help       = "initiates live storage\n\t\t\t"
1167                       "migration for a device. The device's contents are\n\t\t\t"
1168                       "copied to the new image file, including data that\n\t\t\t"
1169                       "is written after the command is started.\n\t\t\t"
1170                       "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1171                       "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1172                       "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1173                       "so that the result does not need a backing file.\n\t\t\t",
1174         .cmd        = hmp_drive_mirror,
1175     },
1176 STEXI
1177 @item drive_mirror
1178 @findex drive_mirror
1179 Start mirroring a block device's writes to a new destination,
1180 using the specified target.
1181 ETEXI
1182
1183     {
1184         .name       = "drive_backup",
1185         .args_type  = "reuse:-n,full:-f,compress:-c,device:B,target:s,format:s?",
1186         .params     = "[-n] [-f] [-c] device target [format]",
1187         .help       = "initiates a point-in-time\n\t\t\t"
1188                       "copy for a device. The device's contents are\n\t\t\t"
1189                       "copied to the new image file, excluding data that\n\t\t\t"
1190                       "is written after the command is started.\n\t\t\t"
1191                       "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1192                       "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1193                       "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1194                       "so that the result does not need a backing file.\n\t\t\t"
1195                       "The -c flag requests QEMU to compress backup data\n\t\t\t"
1196                       "(if the target format supports it).\n\t\t\t",
1197         .cmd        = hmp_drive_backup,
1198     },
1199 STEXI
1200 @item drive_backup
1201 @findex drive_backup
1202 Start a point-in-time copy of a block device to a specificed target.
1203 ETEXI
1204
1205     {
1206         .name       = "drive_add",
1207         .args_type  = "node:-n,pci_addr:s,opts:s",
1208         .params     = "[-n] [[<domain>:]<bus>:]<slot>\n"
1209                       "[file=file][,if=type][,bus=n]\n"
1210                       "[,unit=m][,media=d][,index=i]\n"
1211                       "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
1212                       "[,snapshot=on|off][,cache=on|off]\n"
1213                       "[,readonly=on|off][,copy-on-read=on|off]",
1214         .help       = "add drive to PCI storage controller",
1215         .cmd        = hmp_drive_add,
1216     },
1217
1218 STEXI
1219 @item drive_add
1220 @findex drive_add
1221 Add drive to PCI storage controller.
1222 ETEXI
1223
1224     {
1225         .name       = "pcie_aer_inject_error",
1226         .args_type  = "advisory_non_fatal:-a,correctable:-c,"
1227                       "id:s,error_status:s,"
1228                       "header0:i?,header1:i?,header2:i?,header3:i?,"
1229                       "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1230         .params     = "[-a] [-c] id "
1231                       "<error_status> [<tlp header> [<tlp header prefix>]]",
1232         .help       = "inject pcie aer error\n\t\t\t"
1233                       " -a for advisory non fatal error\n\t\t\t"
1234                       " -c for correctable error\n\t\t\t"
1235                       "<id> = qdev device id\n\t\t\t"
1236                       "<error_status> = error string or 32bit\n\t\t\t"
1237                       "<tlb header> = 32bit x 4\n\t\t\t"
1238                       "<tlb header prefix> = 32bit x 4",
1239         .cmd        = hmp_pcie_aer_inject_error,
1240     },
1241
1242 STEXI
1243 @item pcie_aer_inject_error
1244 @findex pcie_aer_inject_error
1245 Inject PCIe AER error
1246 ETEXI
1247
1248     {
1249         .name       = "host_net_add",
1250         .args_type  = "device:s,opts:s?",
1251         .params     = "tap|user|socket|vde|netmap|bridge|vhost-user|dump [options]",
1252         .help       = "add host VLAN client",
1253         .cmd        = hmp_host_net_add,
1254         .command_completion = host_net_add_completion,
1255     },
1256
1257 STEXI
1258 @item host_net_add
1259 @findex host_net_add
1260 Add host VLAN client.
1261 ETEXI
1262
1263     {
1264         .name       = "host_net_remove",
1265         .args_type  = "vlan_id:i,device:s",
1266         .params     = "vlan_id name",
1267         .help       = "remove host VLAN client",
1268         .cmd        = hmp_host_net_remove,
1269         .command_completion = host_net_remove_completion,
1270     },
1271
1272 STEXI
1273 @item host_net_remove
1274 @findex host_net_remove
1275 Remove host VLAN client.
1276 ETEXI
1277
1278     {
1279         .name       = "netdev_add",
1280         .args_type  = "netdev:O",
1281         .params     = "[user|tap|socket|vde|bridge|hubport|netmap|vhost-user],id=str[,prop=value][,...]",
1282         .help       = "add host network device",
1283         .cmd        = hmp_netdev_add,
1284         .command_completion = netdev_add_completion,
1285     },
1286
1287 STEXI
1288 @item netdev_add
1289 @findex netdev_add
1290 Add host network device.
1291 ETEXI
1292
1293     {
1294         .name       = "netdev_del",
1295         .args_type  = "id:s",
1296         .params     = "id",
1297         .help       = "remove host network device",
1298         .cmd        = hmp_netdev_del,
1299         .command_completion = netdev_del_completion,
1300     },
1301
1302 STEXI
1303 @item netdev_del
1304 @findex netdev_del
1305 Remove host network device.
1306 ETEXI
1307
1308     {
1309         .name       = "object_add",
1310         .args_type  = "object:O",
1311         .params     = "[qom-type=]type,id=str[,prop=value][,...]",
1312         .help       = "create QOM object",
1313         .cmd        = hmp_object_add,
1314         .command_completion = object_add_completion,
1315     },
1316
1317 STEXI
1318 @item object_add
1319 @findex object_add
1320 Create QOM object.
1321 ETEXI
1322
1323     {
1324         .name       = "object_del",
1325         .args_type  = "id:s",
1326         .params     = "id",
1327         .help       = "destroy QOM object",
1328         .cmd        = hmp_object_del,
1329         .command_completion = object_del_completion,
1330     },
1331
1332 STEXI
1333 @item object_del
1334 @findex object_del
1335 Destroy QOM object.
1336 ETEXI
1337
1338 #ifdef CONFIG_SLIRP
1339     {
1340         .name       = "hostfwd_add",
1341         .args_type  = "arg1:s,arg2:s?,arg3:s?",
1342         .params     = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1343         .help       = "redirect TCP or UDP connections from host to guest (requires -net user)",
1344         .cmd        = hmp_hostfwd_add,
1345     },
1346 #endif
1347 STEXI
1348 @item hostfwd_add
1349 @findex hostfwd_add
1350 Redirect TCP or UDP connections from host to guest (requires -net user).
1351 ETEXI
1352
1353 #ifdef CONFIG_SLIRP
1354     {
1355         .name       = "hostfwd_remove",
1356         .args_type  = "arg1:s,arg2:s?,arg3:s?",
1357         .params     = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1358         .help       = "remove host-to-guest TCP or UDP redirection",
1359         .cmd        = hmp_hostfwd_remove,
1360     },
1361
1362 #endif
1363 STEXI
1364 @item hostfwd_remove
1365 @findex hostfwd_remove
1366 Remove host-to-guest TCP or UDP redirection.
1367 ETEXI
1368
1369     {
1370         .name       = "balloon",
1371         .args_type  = "value:M",
1372         .params     = "target",
1373         .help       = "request VM to change its memory allocation (in MB)",
1374         .cmd        = hmp_balloon,
1375     },
1376
1377 STEXI
1378 @item balloon @var{value}
1379 @findex balloon
1380 Request VM to change its memory allocation to @var{value} (in MB).
1381 ETEXI
1382
1383     {
1384         .name       = "set_link",
1385         .args_type  = "name:s,up:b",
1386         .params     = "name on|off",
1387         .help       = "change the link status of a network adapter",
1388         .cmd        = hmp_set_link,
1389         .command_completion = set_link_completion,
1390     },
1391
1392 STEXI
1393 @item set_link @var{name} [on|off]
1394 @findex set_link
1395 Switch link @var{name} on (i.e. up) or off (i.e. down).
1396 ETEXI
1397
1398     {
1399         .name       = "watchdog_action",
1400         .args_type  = "action:s",
1401         .params     = "[reset|shutdown|poweroff|pause|debug|none]",
1402         .help       = "change watchdog action",
1403         .cmd        = hmp_watchdog_action,
1404         .command_completion = watchdog_action_completion,
1405     },
1406
1407 STEXI
1408 @item watchdog_action
1409 @findex watchdog_action
1410 Change watchdog action.
1411 ETEXI
1412
1413     {
1414         .name       = "acl_show",
1415         .args_type  = "aclname:s",
1416         .params     = "aclname",
1417         .help       = "list rules in the access control list",
1418         .cmd        = hmp_acl_show,
1419     },
1420
1421 STEXI
1422 @item acl_show @var{aclname}
1423 @findex acl_show
1424 List all the matching rules in the access control list, and the default
1425 policy. There are currently two named access control lists,
1426 @var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1427 certificate distinguished name, and SASL username respectively.
1428 ETEXI
1429
1430     {
1431         .name       = "acl_policy",
1432         .args_type  = "aclname:s,policy:s",
1433         .params     = "aclname allow|deny",
1434         .help       = "set default access control list policy",
1435         .cmd        = hmp_acl_policy,
1436     },
1437
1438 STEXI
1439 @item acl_policy @var{aclname} @code{allow|deny}
1440 @findex acl_policy
1441 Set the default access control list policy, used in the event that
1442 none of the explicit rules match. The default policy at startup is
1443 always @code{deny}.
1444 ETEXI
1445
1446     {
1447         .name       = "acl_add",
1448         .args_type  = "aclname:s,match:s,policy:s,index:i?",
1449         .params     = "aclname match allow|deny [index]",
1450         .help       = "add a match rule to the access control list",
1451         .cmd        = hmp_acl_add,
1452     },
1453
1454 STEXI
1455 @item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1456 @findex acl_add
1457 Add a match rule to the access control list, allowing or denying access.
1458 The match will normally be an exact username or x509 distinguished name,
1459 but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1460 allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
1461 normally be appended to the end of the ACL, but can be inserted
1462 earlier in the list if the optional @var{index} parameter is supplied.
1463 ETEXI
1464
1465     {
1466         .name       = "acl_remove",
1467         .args_type  = "aclname:s,match:s",
1468         .params     = "aclname match",
1469         .help       = "remove a match rule from the access control list",
1470         .cmd        = hmp_acl_remove,
1471     },
1472
1473 STEXI
1474 @item acl_remove @var{aclname} @var{match}
1475 @findex acl_remove
1476 Remove the specified match rule from the access control list.
1477 ETEXI
1478
1479     {
1480         .name       = "acl_reset",
1481         .args_type  = "aclname:s",
1482         .params     = "aclname",
1483         .help       = "reset the access control list",
1484         .cmd        = hmp_acl_reset,
1485     },
1486
1487 STEXI
1488 @item acl_reset @var{aclname}
1489 @findex acl_reset
1490 Remove all matches from the access control list, and set the default
1491 policy back to @code{deny}.
1492 ETEXI
1493
1494     {
1495         .name       = "nbd_server_start",
1496         .args_type  = "all:-a,writable:-w,uri:s",
1497         .params     = "nbd_server_start [-a] [-w] host:port",
1498         .help       = "serve block devices on the given host and port",
1499         .cmd        = hmp_nbd_server_start,
1500     },
1501 STEXI
1502 @item nbd_server_start @var{host}:@var{port}
1503 @findex nbd_server_start
1504 Start an NBD server on the given host and/or port.  If the @option{-a}
1505 option is included, all of the virtual machine's block devices that
1506 have an inserted media on them are automatically exported; in this case,
1507 the @option{-w} option makes the devices writable too.
1508 ETEXI
1509
1510     {
1511         .name       = "nbd_server_add",
1512         .args_type  = "writable:-w,device:B",
1513         .params     = "nbd_server_add [-w] device",
1514         .help       = "export a block device via NBD",
1515         .cmd        = hmp_nbd_server_add,
1516     },
1517 STEXI
1518 @item nbd_server_add @var{device}
1519 @findex nbd_server_add
1520 Export a block device through QEMU's NBD server, which must be started
1521 beforehand with @command{nbd_server_start}.  The @option{-w} option makes the
1522 exported device writable too.
1523 ETEXI
1524
1525     {
1526         .name       = "nbd_server_stop",
1527         .args_type  = "",
1528         .params     = "nbd_server_stop",
1529         .help       = "stop serving block devices using the NBD protocol",
1530         .cmd        = hmp_nbd_server_stop,
1531     },
1532 STEXI
1533 @item nbd_server_stop
1534 @findex nbd_server_stop
1535 Stop the QEMU embedded NBD server.
1536 ETEXI
1537
1538
1539 #if defined(TARGET_I386)
1540
1541     {
1542         .name       = "mce",
1543         .args_type  = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1544         .params     = "[-b] cpu bank status mcgstatus addr misc",
1545         .help       = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1546         .cmd        = hmp_mce,
1547     },
1548
1549 #endif
1550 STEXI
1551 @item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
1552 @findex mce (x86)
1553 Inject an MCE on the given CPU (x86 only).
1554 ETEXI
1555
1556     {
1557         .name       = "getfd",
1558         .args_type  = "fdname:s",
1559         .params     = "getfd name",
1560         .help       = "receive a file descriptor via SCM rights and assign it a name",
1561         .cmd        = hmp_getfd,
1562     },
1563
1564 STEXI
1565 @item getfd @var{fdname}
1566 @findex getfd
1567 If a file descriptor is passed alongside this command using the SCM_RIGHTS
1568 mechanism on unix sockets, it is stored using the name @var{fdname} for
1569 later use by other monitor commands.
1570 ETEXI
1571
1572     {
1573         .name       = "closefd",
1574         .args_type  = "fdname:s",
1575         .params     = "closefd name",
1576         .help       = "close a file descriptor previously passed via SCM rights",
1577         .cmd        = hmp_closefd,
1578     },
1579
1580 STEXI
1581 @item closefd @var{fdname}
1582 @findex closefd
1583 Close the file descriptor previously assigned to @var{fdname} using the
1584 @code{getfd} command. This is only needed if the file descriptor was never
1585 used by another monitor command.
1586 ETEXI
1587
1588     {
1589         .name       = "block_passwd",
1590         .args_type  = "device:B,password:s",
1591         .params     = "block_passwd device password",
1592         .help       = "set the password of encrypted block devices",
1593         .cmd        = hmp_block_passwd,
1594     },
1595
1596 STEXI
1597 @item block_passwd @var{device} @var{password}
1598 @findex block_passwd
1599 Set the encrypted device @var{device} password to @var{password}
1600 ETEXI
1601
1602     {
1603         .name       = "block_set_io_throttle",
1604         .args_type  = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1605         .params     = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1606         .help       = "change I/O throttle limits for a block drive",
1607         .cmd        = hmp_block_set_io_throttle,
1608     },
1609
1610 STEXI
1611 @item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1612 @findex block_set_io_throttle
1613 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}
1614 ETEXI
1615
1616     {
1617         .name       = "set_password",
1618         .args_type  = "protocol:s,password:s,connected:s?",
1619         .params     = "protocol password action-if-connected",
1620         .help       = "set spice/vnc password",
1621         .cmd        = hmp_set_password,
1622     },
1623
1624 STEXI
1625 @item set_password [ vnc | spice ] password [ action-if-connected ]
1626 @findex set_password
1627 Change spice/vnc password.  Use zero to make the password stay valid
1628 forever.  @var{action-if-connected} specifies what should happen in
1629 case a connection is established: @var{fail} makes the password change
1630 fail.  @var{disconnect} changes the password and disconnects the
1631 client.  @var{keep} changes the password and keeps the connection up.
1632 @var{keep} is the default.
1633 ETEXI
1634
1635     {
1636         .name       = "expire_password",
1637         .args_type  = "protocol:s,time:s",
1638         .params     = "protocol time",
1639         .help       = "set spice/vnc password expire-time",
1640         .cmd        = hmp_expire_password,
1641     },
1642
1643 STEXI
1644 @item expire_password [ vnc | spice ] expire-time
1645 @findex expire_password
1646 Specify when a password for spice/vnc becomes
1647 invalid. @var{expire-time} accepts:
1648
1649 @table @var
1650 @item now
1651 Invalidate password instantly.
1652
1653 @item never
1654 Password stays valid forever.
1655
1656 @item +nsec
1657 Password stays valid for @var{nsec} seconds starting now.
1658
1659 @item nsec
1660 Password is invalidated at the given time.  @var{nsec} are the seconds
1661 passed since 1970, i.e. unix epoch.
1662
1663 @end table
1664 ETEXI
1665
1666     {
1667         .name       = "chardev-add",
1668         .args_type  = "args:s",
1669         .params     = "args",
1670         .help       = "add chardev",
1671         .cmd        = hmp_chardev_add,
1672         .command_completion = chardev_add_completion,
1673     },
1674
1675 STEXI
1676 @item chardev-add args
1677 @findex chardev-add
1678 chardev_add accepts the same parameters as the -chardev command line switch.
1679
1680 ETEXI
1681
1682     {
1683         .name       = "chardev-remove",
1684         .args_type  = "id:s",
1685         .params     = "id",
1686         .help       = "remove chardev",
1687         .cmd        = hmp_chardev_remove,
1688         .command_completion = chardev_remove_completion,
1689     },
1690
1691 STEXI
1692 @item chardev-remove id
1693 @findex chardev-remove
1694 Removes the chardev @var{id}.
1695
1696 ETEXI
1697
1698     {
1699         .name       = "qemu-io",
1700         .args_type  = "device:B,command:s",
1701         .params     = "[device] \"[command]\"",
1702         .help       = "run a qemu-io command on a block device",
1703         .cmd        = hmp_qemu_io,
1704     },
1705
1706 STEXI
1707 @item qemu-io @var{device} @var{command}
1708 @findex qemu-io
1709 Executes a qemu-io command on the given block device.
1710
1711 ETEXI
1712
1713     {
1714         .name       = "cpu-add",
1715         .args_type  = "id:i",
1716         .params     = "id",
1717         .help       = "add cpu",
1718         .cmd        = hmp_cpu_add,
1719     },
1720
1721 STEXI
1722 @item cpu-add @var{id}
1723 @findex cpu-add
1724 Add CPU with id @var{id}
1725 ETEXI
1726
1727     {
1728         .name       = "qom-list",
1729         .args_type  = "path:s?",
1730         .params     = "path",
1731         .help       = "list QOM properties",
1732         .cmd        = hmp_qom_list,
1733     },
1734
1735 STEXI
1736 @item qom-list [@var{path}]
1737 Print QOM properties of object at location @var{path}
1738 ETEXI
1739
1740     {
1741         .name       = "qom-set",
1742         .args_type  = "path:s,property:s,value:s",
1743         .params     = "path property value",
1744         .help       = "set QOM property",
1745         .cmd        = hmp_qom_set,
1746     },
1747
1748 STEXI
1749 @item qom-set @var{path} @var{property} @var{value}
1750 Set QOM property @var{property} of object at location @var{path} to value @var{value}
1751 ETEXI
1752
1753     {
1754         .name       = "info",
1755         .args_type  = "item:s?",
1756         .params     = "[subcommand]",
1757         .help       = "show various information about the system state",
1758         .cmd        = hmp_info_help,
1759         .sub_table  = info_cmds,
1760     },
1761
1762 STEXI
1763 @end table
1764 ETEXI