hmp-commands.hx 51.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11
HXCOMM Use DEFHEADING() to define headings in both help text and texi
HXCOMM Text between STEXI and ETEXI are copied to texi version and
HXCOMM discarded from C version
HXCOMM DEF(command, args, callback, arg_string, help) is used to construct
HXCOMM monitor commands
HXCOMM HXCOMM can be used for comments, discarded from both texi and C

STEXI
@table @option
ETEXI

12 13
    {
        .name       = "help|?",
14
        .args_type  = "name:S?",
15 16
        .params     = "[cmd]",
        .help       = "show the help",
17
        .cmd        = do_help_cmd,
18 19
    },

20 21
STEXI
@item help or ? [@var{cmd}]
22
@findex help
23 24 25
Show the help for all commands or just for command @var{cmd}.
ETEXI

26 27 28 29 30
    {
        .name       = "commit",
        .args_type  = "device:B",
        .params     = "device|all",
        .help       = "commit changes to the disk images (if -snapshot is used) or backing files",
31
        .cmd        = hmp_commit,
32 33
    },

34 35
STEXI
@item commit
36
@findex commit
37
Commit changes to the disk images (if -snapshot is used) or backing files.
38 39 40 41 42
If the backing file is smaller than the snapshot, then the backing file will be
resized to be the same size as the snapshot.  If the snapshot is smaller than
the backing file, the backing file will not be truncated.  If you want the
backing file to match the size of the smaller snapshot, you can safely truncate
it yourself once the commit operation successfully completes.
43 44
ETEXI

45 46 47 48 49
    {
        .name       = "q|quit",
        .args_type  = "",
        .params     = "",
        .help       = "quit the emulator",
50
        .cmd        = hmp_quit,
51 52
    },

53 54
STEXI
@item q or quit
55
@findex quit
56 57 58
Quit the emulator.
ETEXI

59 60 61 62 63
    {
        .name       = "block_resize",
        .args_type  = "device:B,size:o",
        .params     = "device size",
        .help       = "resize a block image",
64
        .cmd        = hmp_block_resize,
65 66 67 68 69 70 71 72 73 74 75
    },

STEXI
@item block_resize
@findex block_resize
Resize a block image while a guest is running.  Usually requires guest
action to see the updated size.  Resize to a lower size is supported,
but should be used with extreme caution.  Note that this command only
resizes image files, it can not resize block devices like LVM volumes.
ETEXI

76 77
    {
        .name       = "block_stream",
78 79
        .args_type  = "device:B,speed:o?,base:s?",
        .params     = "device [speed [base]]",
80
        .help       = "copy data from a backing file into a block device",
81
        .cmd        = hmp_block_stream,
82 83 84 85 86 87
    },

STEXI
@item block_stream
@findex block_stream
Copy data from a backing file into a block device.
88 89 90 91
ETEXI

    {
        .name       = "block_job_set_speed",
92 93
        .args_type  = "device:B,speed:o",
        .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 100
@item block_job_set_speed
@findex block_job_set_speed
101
Set maximum speed for a background block operation.
102 103 104 105
ETEXI

    {
        .name       = "block_job_cancel",
106 107 108 109
        .args_type  = "force:-f,device:B",
        .params     = "[-f] device",
        .help       = "stop an active background block operation (use -f"
                      "\n\t\t\t if the operation is currently paused)",
110
        .cmd        = hmp_block_job_cancel,
111 112 113 114 115
    },

STEXI
@item block_job_cancel
@findex block_job_cancel
116 117 118 119 120 121 122 123
Stop an active background block operation (streaming, mirroring).
ETEXI

    {
        .name       = "block_job_complete",
        .args_type  = "device:B",
        .params     = "device",
        .help       = "stop an active background block operation",
124
        .cmd        = hmp_block_job_complete,
125 126 127 128 129 130 131
    },

STEXI
@item block_job_complete
@findex block_job_complete
Manually trigger completion of an active background block operation.
For mirroring, this will switch the device to the destination path.
132 133 134 135 136 137 138
ETEXI

    {
        .name       = "block_job_pause",
        .args_type  = "device:B",
        .params     = "device",
        .help       = "pause an active background block operation",
139
        .cmd        = hmp_block_job_pause,
140 141 142 143 144 145 146 147 148 149 150 151 152
    },

STEXI
@item block_job_pause
@findex block_job_pause
Pause an active block streaming operation.
ETEXI

    {
        .name       = "block_job_resume",
        .args_type  = "device:B",
        .params     = "device",
        .help       = "resume a paused background block operation",
153
        .cmd        = hmp_block_job_resume,
154 155 156 157 158 159
    },

STEXI
@item block_job_resume
@findex block_job_resume
Resume a paused block streaming operation.
160
ETEXI
161

162 163
    {
        .name       = "eject",
164
        .args_type  = "force:-f,device:B",
165 166
        .params     = "[-f] device",
        .help       = "eject a removable medium (use -f to force it)",
167
        .cmd        = hmp_eject,
168 169
    },

170 171
STEXI
@item eject [-f] @var{device}
172
@findex eject
173
Eject a removable medium (use -f to force it).
174 175 176 177
ETEXI

    {
        .name       = "drive_del",
178
        .args_type  = "id:B",
179 180
        .params     = "device",
        .help       = "remove host block device",
181
        .cmd        = hmp_drive_del,
182 183 184 185 186 187 188 189 190
    },

STEXI
@item drive_del @var{device}
@findex drive_del
Remove host block device.  The result is that guest generated IO is no longer
submitted against the host device underlying the disk.  Once a drive has
been deleted, the QEMU Block layer returns -EIO which results in IO
errors in the guest for applications that are reading/writing to the device.
191 192
These errors are always reported to the guest, regardless of the drive's error
actions (drive options rerror, werror).
193 194
ETEXI

195 196
    {
        .name       = "change",
197 198
        .args_type  = "device:B,target:F,arg:s?,read-only-mode:s?",
        .params     = "device filename [format [read-only-mode]]",
199
        .help       = "change a removable medium, optional format",
200
        .cmd        = hmp_change,
201 202
    },

203 204
STEXI
@item change @var{device} @var{setting}
205
@findex change
206 207 208
Change the configuration of a device.

@table @option
209
@item change @var{diskdevice} @var{filename} [@var{format} [@var{read-only-mode}]]
210 211 212 213 214 215 216 217
Change the medium for a removable disk device to point to @var{filename}. eg

@example
(qemu) change ide1-cd0 /path/to/some.iso
@end example

@var{format} is optional.

218 219 220 221 222 223 224 225 226 227 228 229 230 231
@var{read-only-mode} may be used to change the read-only status of the device.
It accepts the following values:

@table @var
@item retain
Retains the current status; this is the default.

@item read-only
Makes the device read-only.

@item read-write
Makes the device writable.
@end table

232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
@item change vnc @var{display},@var{options}
Change the configuration of the VNC server. The valid syntax for @var{display}
and @var{options} are described at @ref{sec_invocation}. eg

@example
(qemu) change vnc localhost:1
@end example

@item change vnc password [@var{password}]

Change the password associated with the VNC server. If the new password is not
supplied, the monitor will prompt for it to be entered. VNC passwords are only
significant up to 8 letters. eg

@example
(qemu) change vnc password
Password: ********
@end example

@end table
ETEXI

254 255 256 257 258
    {
        .name       = "screendump",
        .args_type  = "filename:F",
        .params     = "filename",
        .help       = "save screen into PPM image 'filename'",
259
        .cmd        = hmp_screendump,
260 261
    },

262 263
STEXI
@item screendump @var{filename}
264
@findex screendump
265 266 267
Save screen into PPM image @var{filename}.
ETEXI

268 269 270 271 272
    {
        .name       = "logfile",
        .args_type  = "filename:F",
        .params     = "filename",
        .help       = "output logs to 'filename'",
273
        .cmd        = hmp_logfile,
274 275
    },

276 277
STEXI
@item logfile @var{filename}
278
@findex logfile
279 280 281
Output logs to @var{filename}.
ETEXI

282 283
    {
        .name       = "trace-event",
284 285 286 287
        .args_type  = "name:s,option:b,vcpu:i?",
        .params     = "name on|off [vcpu]",
        .help       = "changes status of a specific trace event "
                      "(vcpu: vCPU to set, default is all)",
288
        .cmd = hmp_trace_event,
289
        .command_completion = trace_event_completion,
290 291 292 293 294 295
    },

STEXI
@item trace-event
@findex trace-event
changes status of a trace event
296 297
ETEXI

298
#if defined(CONFIG_TRACE_SIMPLE)
299 300 301 302 303
    {
        .name       = "trace-file",
        .args_type  = "op:s?,arg:F?",
        .params     = "on|off|flush|set [arg]",
        .help       = "open, close, or flush trace file, or set a new file name",
304
        .cmd        = hmp_trace_file,
305 306 307 308 309 310
    },

STEXI
@item trace-file on|off|flush
@findex trace-file
Open, close, or flush the trace file.  If no argument is given, the status of the trace file is displayed.
311 312 313
ETEXI
#endif

314 315 316 317
    {
        .name       = "log",
        .args_type  = "items:s",
        .params     = "item1[,...]",
318
        .help       = "activate logging of the specified items",
319
        .cmd        = hmp_log,
320 321
    },

322 323
STEXI
@item log @var{item1}[,...]
324
@findex log
325
Activate logging of the specified items.
326 327
ETEXI

328 329 330 331 332
    {
        .name       = "savevm",
        .args_type  = "name:s?",
        .params     = "[tag|id]",
        .help       = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
333
        .cmd        = hmp_savevm,
334 335
    },

336 337
STEXI
@item savevm [@var{tag}|@var{id}]
338
@findex savevm
339 340 341 342 343 344
Create a snapshot of the whole virtual machine. If @var{tag} is
provided, it is used as human readable identifier. If there is already
a snapshot with the same tag or ID, it is replaced. More info at
@ref{vm_snapshots}.
ETEXI

345 346 347 348 349
    {
        .name       = "loadvm",
        .args_type  = "name:s",
        .params     = "tag|id",
        .help       = "restore a VM snapshot from its tag or id",
350
        .cmd        = hmp_loadvm,
351
        .command_completion = loadvm_completion,
352 353
    },

354 355
STEXI
@item loadvm @var{tag}|@var{id}
356
@findex loadvm
357 358 359 360
Set the whole virtual machine to the snapshot identified by the tag
@var{tag} or the unique snapshot ID @var{id}.
ETEXI

361 362 363 364 365
    {
        .name       = "delvm",
        .args_type  = "name:s",
        .params     = "tag|id",
        .help       = "delete a VM snapshot from its tag or id",
366
        .cmd        = hmp_delvm,
367
        .command_completion = delvm_completion,
368 369
    },

370 371
STEXI
@item delvm @var{tag}|@var{id}
372
@findex delvm
373 374 375
Delete the snapshot identified by @var{tag} or @var{id}.
ETEXI

376 377 378 379 380
    {
        .name       = "singlestep",
        .args_type  = "option:s?",
        .params     = "[on|off]",
        .help       = "run emulation in singlestep mode or switch to normal mode",
381
        .cmd        = hmp_singlestep,
382 383
    },

384 385
STEXI
@item singlestep [off]
386
@findex singlestep
387 388 389 390
Run the emulation in single step mode.
If called with option off, the emulation returns to normal mode.
ETEXI

391 392 393 394 395
    {
        .name       = "stop",
        .args_type  = "",
        .params     = "",
        .help       = "stop emulation",
396
        .cmd        = hmp_stop,
397 398
    },

399 400
STEXI
@item stop
401
@findex stop
402 403 404
Stop emulation.
ETEXI

405 406 407 408 409
    {
        .name       = "c|cont",
        .args_type  = "",
        .params     = "",
        .help       = "resume emulation",
410
        .cmd        = hmp_cont,
411 412
    },

413 414
STEXI
@item c or cont
415
@findex cont
416
Resume emulation.
417 418 419 420 421 422 423
ETEXI

    {
        .name       = "system_wakeup",
        .args_type  = "",
        .params     = "",
        .help       = "wakeup guest from suspend",
424
        .cmd        = hmp_system_wakeup,
425 426 427 428 429 430
    },

STEXI
@item system_wakeup
@findex system_wakeup
Wakeup guest from suspend.
431 432
ETEXI

433 434 435 436 437
    {
        .name       = "gdbserver",
        .args_type  = "device:s?",
        .params     = "[device]",
        .help       = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
438
        .cmd        = hmp_gdbserver,
439 440
    },

441 442
STEXI
@item gdbserver [@var{port}]
443
@findex gdbserver
444 445 446
Start gdbserver session (default @var{port}=1234)
ETEXI

447 448 449 450 451
    {
        .name       = "x",
        .args_type  = "fmt:/,addr:l",
        .params     = "/fmt addr",
        .help       = "virtual memory dump starting at 'addr'",
452
        .cmd        = hmp_memory_dump,
453 454
    },

455 456
STEXI
@item x/fmt @var{addr}
457
@findex x
458 459 460
Virtual memory dump starting at @var{addr}.
ETEXI

461 462 463 464 465
    {
        .name       = "xp",
        .args_type  = "fmt:/,addr:l",
        .params     = "/fmt addr",
        .help       = "physical memory dump starting at 'addr'",
466
        .cmd        = hmp_physical_memory_dump,
467 468
    },

469 470
STEXI
@item xp /@var{fmt} @var{addr}
471
@findex xp
472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525
Physical memory dump starting at @var{addr}.

@var{fmt} is a format which tells the command how to format the
data. Its syntax is: @option{/@{count@}@{format@}@{size@}}

@table @var
@item count
is the number of items to be dumped.

@item format
can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
c (char) or i (asm instruction).

@item size
can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
@code{h} or @code{w} can be specified with the @code{i} format to
respectively select 16 or 32 bit code instruction size.

@end table

Examples:
@itemize
@item
Dump 10 instructions at the current instruction pointer:
@example
(qemu) x/10i $eip
0x90107063:  ret
0x90107064:  sti
0x90107065:  lea    0x0(%esi,1),%esi
0x90107069:  lea    0x0(%edi,1),%edi
0x90107070:  ret
0x90107071:  jmp    0x90107080
0x90107073:  nop
0x90107074:  nop
0x90107075:  nop
0x90107076:  nop
@end example

@item
Dump 80 16 bit values at the start of the video memory.
@smallexample
(qemu) xp/80hx 0xb8000
0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
@end smallexample
@end itemize
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557
ETEXI

    {
        .name       = "gpa2hva",
        .args_type  = "addr:l",
        .params     = "addr",
        .help       = "print the host virtual address corresponding to a guest physical address",
        .cmd        = hmp_gpa2hva,
    },

STEXI
@item gpa2hva @var{addr}
@findex gpa2hva
Print the host virtual address at which the guest's physical address @var{addr}
is mapped.
ETEXI

#ifdef CONFIG_LINUX
    {
        .name       = "gpa2hpa",
        .args_type  = "addr:l",
        .params     = "addr",
        .help       = "print the host physical address corresponding to a guest physical address",
        .cmd        = hmp_gpa2hpa,
    },
#endif

STEXI
@item gpa2hpa @var{addr}
@findex gpa2hpa
Print the host physical address at which the guest's physical address @var{addr}
is mapped.
558 559
ETEXI

560 561 562 563 564
    {
        .name       = "p|print",
        .args_type  = "fmt:/,val:l",
        .params     = "/fmt expr",
        .help       = "print expression value (use $reg for CPU register access)",
565
        .cmd        = do_print,
566 567
    },

568 569
STEXI
@item p or print/@var{fmt} @var{expr}
570
@findex print
571 572 573 574
Print expression value. Only the @var{format} part of @var{fmt} is
used.
ETEXI

575 576 577 578 579
    {
        .name       = "i",
        .args_type  = "fmt:/,addr:i,index:i.",
        .params     = "/fmt addr",
        .help       = "I/O port read",
580
        .cmd        = hmp_ioport_read,
581 582
    },

583
STEXI
584 585
@item i/@var{fmt} @var{addr} [.@var{index}]
@findex i
586 587 588
Read I/O port.
ETEXI

589 590 591 592 593
    {
        .name       = "o",
        .args_type  = "fmt:/,addr:i,val:i",
        .params     = "/fmt addr value",
        .help       = "I/O port write",
594
        .cmd        = hmp_ioport_write,
595 596
    },

597
STEXI
598 599
@item o/@var{fmt} @var{addr} @var{val}
@findex o
600 601
Write to I/O port.
ETEXI
602

603 604
    {
        .name       = "sendkey",
Amos Kong's avatar
Amos Kong committed
605
        .args_type  = "keys:s,hold-time:i?",
606 607
        .params     = "keys [hold_ms]",
        .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 613
STEXI
@item sendkey @var{keys}
614
@findex sendkey
615 616 617
Send @var{keys} to the guest. @var{keys} could be the name of the
key or the raw value in hexadecimal format. Use @code{-} to press
several keys simultaneously. Example:
618 619 620 621 622 623 624 625
@example
sendkey ctrl-alt-f1
@end example

This command is useful to send keys that your graphical user interface
intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
ETEXI

626 627 628 629 630
    {
        .name       = "system_reset",
        .args_type  = "",
        .params     = "",
        .help       = "reset the system",
631
        .cmd        = hmp_system_reset,
632 633
    },

634 635
STEXI
@item system_reset
636
@findex system_reset
637 638 639
Reset the system.
ETEXI

640 641 642 643 644
    {
        .name       = "system_powerdown",
        .args_type  = "",
        .params     = "",
        .help       = "send system power down event",
645
        .cmd        = hmp_system_powerdown,
646 647
    },

648 649
STEXI
@item system_powerdown
650
@findex system_powerdown
651 652 653
Power down the system (if supported).
ETEXI

654 655 656 657 658
    {
        .name       = "sum",
        .args_type  = "start:i,size:i",
        .params     = "addr size",
        .help       = "compute the checksum of a memory region",
659
        .cmd        = hmp_sum,
660 661
    },

662 663
STEXI
@item sum @var{addr} @var{size}
664
@findex sum
665 666 667
Compute the checksum of a memory region.
ETEXI

668 669 670 671 672
    {
        .name       = "usb_add",
        .args_type  = "devname:s",
        .params     = "device",
        .help       = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
673
        .cmd        = hmp_usb_add,
674 675
    },

676 677
STEXI
@item usb_add @var{devname}
678
@findex usb_add
679 680
Add the USB device @var{devname}. This command is deprecated, please
use @code{device_add} instead. For details of available devices see
681 682 683
@ref{usb_devices}
ETEXI

684 685 686 687 688
    {
        .name       = "usb_del",
        .args_type  = "devname:s",
        .params     = "device",
        .help       = "remove USB device 'bus.addr'",
689
        .cmd        = hmp_usb_del,
690 691
    },

692 693
STEXI
@item usb_del @var{devname}
694
@findex usb_del
695 696
Remove the USB device @var{devname} from the QEMU virtual USB
hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
697 698
command @code{info usb} to see the devices you can remove. This
command is deprecated, please use @code{device_del} instead.
699 700
ETEXI

701 702
    {
        .name       = "device_add",
703 704
        .args_type  = "device:O",
        .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 711
STEXI
@item device_add @var{config}
712
@findex device_add
713 714 715
Add device.
ETEXI

716 717 718 719 720
    {
        .name       = "device_del",
        .args_type  = "id:s",
        .params     = "device",
        .help       = "remove device",
721
        .cmd        = hmp_device_del,
722
        .command_completion = device_del_completion,
723 724
    },

725 726
STEXI
@item device_del @var{id}
727
@findex device_del
728 729
Remove device @var{id}. @var{id} may be a short ID
or a QOM object path.
730 731
ETEXI

732 733 734 735 736
    {
        .name       = "cpu",
        .args_type  = "index:i",
        .params     = "index",
        .help       = "set the default CPU",
737
        .cmd        = hmp_cpu,
738
    },
739

740
STEXI
741 742
@item cpu @var{index}
@findex cpu
743 744 745
Set the default CPU.
ETEXI

746 747 748 749 750
    {
        .name       = "mouse_move",
        .args_type  = "dx_str:s,dy_str:s,dz_str:s?",
        .params     = "dx dy [dz]",
        .help       = "send mouse move events",
751
        .cmd        = hmp_mouse_move,
752 753
    },

754 755
STEXI
@item mouse_move @var{dx} @var{dy} [@var{dz}]
756
@findex mouse_move
757 758 759 760
Move the active mouse to the specified coordinates @var{dx} @var{dy}
with optional scroll axis @var{dz}.
ETEXI

761 762 763 764 765
    {
        .name       = "mouse_button",
        .args_type  = "button_state:i",
        .params     = "state",
        .help       = "change mouse button state (1=L, 2=M, 4=R)",
766
        .cmd        = hmp_mouse_button,
767 768
    },

769 770
STEXI
@item mouse_button @var{val}
771
@findex mouse_button
772 773 774
Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
ETEXI

775 776 777 778 779
    {
        .name       = "mouse_set",
        .args_type  = "index:i",
        .params     = "index",
        .help       = "set which mouse device receives events",
780
        .cmd        = hmp_mouse_set,
781 782
    },

783 784
STEXI
@item mouse_set @var{index}
785
@findex mouse_set
786 787 788 789 790 791 792
Set which mouse device receives events at given @var{index}, index
can be obtained with
@example
info mice
@end example
ETEXI

793 794 795 796 797
    {
        .name       = "wavcapture",
        .args_type  = "path:F,freq:i?,bits:i?,nchannels:i?",
        .params     = "path [frequency [bits [channels]]]",
        .help       = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
798
        .cmd        = hmp_wavcapture,
799
    },
800 801
STEXI
@item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
802
@findex wavcapture
803 804 805 806 807 808 809 810 811 812 813
Capture audio into @var{filename}. Using sample rate @var{frequency}
bits per sample @var{bits} and number of channels @var{channels}.

Defaults:
@itemize @minus
@item Sample rate = 44100 Hz - CD quality
@item Bits = 16
@item Number of channels = 2 - Stereo
@end itemize
ETEXI

814 815 816 817 818
    {
        .name       = "stopcapture",
        .args_type  = "n:i",
        .params     = "capture index",
        .help       = "stop capture",
819
        .cmd        = hmp_stopcapture,
820
    },
821 822
STEXI
@item stopcapture @var{index}
823
@findex stopcapture
824 825 826 827 828 829
Stop capture with a given @var{index}, index can be obtained with
@example
info capture
@end example
ETEXI

830 831 832 833 834
    {
        .name       = "memsave",
        .args_type  = "val:l,size:i,filename:s",
        .params     = "addr size file",
        .help       = "save to disk virtual memory dump starting at 'addr' of size 'size'",
835
        .cmd        = hmp_memsave,
836 837
    },

838 839
STEXI
@item memsave @var{addr} @var{size} @var{file}
840
@findex memsave
841 842 843
save to disk virtual memory dump starting at @var{addr} of size @var{size}.
ETEXI

844 845 846 847 848
    {
        .name       = "pmemsave",
        .args_type  = "val:l,size:i,filename:s",
        .params     = "addr size file",
        .help       = "save to disk physical memory dump starting at 'addr' of size 'size'",
849
        .cmd        = hmp_pmemsave,
850 851
    },

852 853
STEXI
@item pmemsave @var{addr} @var{size} @var{file}
854
@findex pmemsave
855 856 857
save to disk physical memory dump starting at @var{addr} of size @var{size}.
ETEXI

858 859 860 861 862
    {
        .name       = "boot_set",
        .args_type  = "bootdevice:s",
        .params     = "bootdevice",
        .help       = "define new values for the boot device list",
863
        .cmd        = hmp_boot_set,
864 865
    },

866 867
STEXI
@item boot_set @var{bootdevicelist}
868
@findex boot_set
869 870 871 872 873 874 875
Define new values for the boot device list. Those values will override
the values specified on the command line through the @code{-boot} option.

The values that can be specified here depend on the machine type, but are
the same that can be specified in the @code{-boot} command line option.
ETEXI

876 877
    {
        .name       = "nmi",
878 879
        .args_type  = "",
        .params     = "",
880
        .help       = "inject an NMI",
881
        .cmd        = hmp_nmi,
882
    },
883 884
STEXI
@item nmi @var{cpu}
885
@findex nmi
886
Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
887 888 889 890

ETEXI

    {
891
        .name       = "ringbuf_write",
892 893
        .args_type  = "device:s,data:s",
        .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 901 902 903
@item ringbuf_write @var{device} @var{data}
@findex ringbuf_write
Write @var{data} to ring buffer character device @var{device}.
@var{data} must be a UTF-8 string.
904

905 906 907
ETEXI

    {
908
        .name       = "ringbuf_read",
909 910
        .args_type  = "device:s,size:i",
        .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 918 919 920
@item ringbuf_read @var{device}
@findex ringbuf_read
Read and print up to @var{size} bytes from ring buffer character
device @var{device}.
921 922
Certain non-printable characters are printed \uXXXX, where XXXX is the
character code in hexadecimal.  Character \ is printed \\.
923 924 925
Bug: can screw up when the buffer contains invalid UTF-8 sequences,
NUL characters, after the ring buffer lost data, and when reading
stops because the size limit is reached.
926

927 928
ETEXI

929 930
    {
        .name       = "migrate",
931 932 933 934 935 936 937
        .args_type  = "detach:-d,blk:-b,inc:-i,uri:s",
        .params     = "[-d] [-b] [-i] uri",
        .help       = "migrate to URI (using -d to not wait for completion)"
		      "\n\t\t\t -b for migration without shared storage with"
		      " full copy of disk\n\t\t\t -i for migration without "
		      "shared storage with incremental copy of disk "
		      "(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 947
	-b for migration with full copy of disk
	-i for migration with incremental copy of disk (base image is shared)
948 949
ETEXI

950 951 952 953 954
    {
        .name       = "migrate_cancel",
        .args_type  = "",
        .params     = "",
        .help       = "cancel the current VM migration",
955
        .cmd        = hmp_migrate_cancel,
956 957
    },

958 959
STEXI
@item migrate_cancel
960
@findex migrate_cancel
961
Cancel the current VM migration.
962

963 964 965 966 967 968 969
ETEXI

    {
        .name       = "migrate_incoming",
        .args_type  = "uri:s",
        .params     = "uri",
        .help       = "Continue an incoming migration from an -incoming defer",
970
        .cmd        = hmp_migrate_incoming,
971 972 973 974 975 976 977 978
    },

STEXI
@item migrate_incoming @var{uri}
@findex migrate_incoming
Continue an incoming migration using the @var{uri} (that has the same syntax
as the -incoming option).

979 980 981 982 983 984 985 986 987 988 989 990
ETEXI

    {
        .name       = "migrate_set_cache_size",
        .args_type  = "value:o",
        .params     = "value",
        .help       = "set cache size (in bytes) for XBZRLE migrations,"
                      "the cache size will be rounded down to the nearest "
                      "power of 2.\n"
                      "The cache size affects the number of cache misses."
                      "In case of a high cache miss ratio you need to increase"
                      " the cache size",
991
        .cmd        = hmp_migrate_set_cache_size,
992 993 994 995 996 997
    },

STEXI
@item migrate_set_cache_size @var{value}
@findex migrate_set_cache_size
Set cache size to @var{value} (in bytes) for xbzrle migrations.
998 999
ETEXI

1000 1001
    {
        .name       = "migrate_set_speed",
1002
        .args_type  = "value:o",
1003
        .params     = "value",
1004 1005
        .help       = "set maximum speed (in bytes) for migrations. "
	"Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
1006
        .cmd        = hmp_migrate_set_speed,
1007 1008
    },

1009 1010
STEXI
@item migrate_set_speed @var{value}
1011
@findex migrate_set_speed
1012
Set maximum speed to @var{value} (in bytes) for migrations.
1013 1014
ETEXI

1015 1016
    {
        .name       = "migrate_set_downtime",
1017
        .args_type  = "value:T",
1018 1019
        .params     = "value",
        .help       = "set maximum tolerated downtime (in seconds) for migrations",
1020
        .cmd        = hmp_migrate_set_downtime,
1021
    },
1022 1023 1024

STEXI
@item migrate_set_downtime @var{second}
1025
@findex migrate_set_downtime
1026
Set maximum tolerated downtime (in seconds) for migration.
1027 1028 1029 1030 1031 1032 1033
ETEXI

    {
        .name       = "migrate_set_capability",
        .args_type  = "capability:s,state:b",
        .params     = "capability state",
        .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 1039 1040 1041
    },

STEXI
@item migrate_set_capability @var{capability} @var{state}
@findex migrate_set_capability
Enable/Disable the usage of a capability @var{capability} for migration.
1042 1043 1044 1045
ETEXI

    {
        .name       = "migrate_set_parameter",
1046
        .args_type  = "parameter:s,value:s",
1047 1048
        .params     = "parameter value",
        .help       = "Set the parameter for migration",
1049
        .cmd        = hmp_migrate_set_parameter,
1050 1051 1052 1053 1054 1055 1056
        .command_completion = migrate_set_parameter_completion,
    },

STEXI
@item migrate_set_parameter @var{parameter} @var{value}
@findex migrate_set_parameter
Set the parameter @var{parameter} for migration.
1057 1058 1059 1060 1061 1062
ETEXI

    {
        .name       = "migrate_start_postcopy",
        .args_type  = "",
        .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 1070 1071 1072 1073
    },

STEXI
@item migrate_start_postcopy
@findex migrate_start_postcopy
Switch in-progress migration to postcopy mode. Ignored after the end of
migration (or once already in postcopy).
1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088
ETEXI

    {
        .name       = "x_colo_lost_heartbeat",
        .args_type  = "",
        .params     = "",
        .help       = "Tell COLO that heartbeat is lost,\n\t\t\t"
                      "a failover or takeover is needed.",
        .cmd = hmp_x_colo_lost_heartbeat,
    },

STEXI
@item x_colo_lost_heartbeat
@findex x_colo_lost_heartbeat
Tell COLO that heartbeat is lost, a failover or takeover is needed.
1089 1090 1091
ETEXI

    {
1092 1093 1094
        .name       = "client_migrate_info",
        .args_type  = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
        .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 1100 1101
STEXI
@item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
@findex client_migrate_info
1102 1103 1104
Set migration information for remote display.  This makes the server
ask the client to automatically reconnect using the new parameters
once migration finished successfully.  Only implemented for SPICE.
1105 1106
ETEXI

1107 1108
    {
        .name       = "dump-guest-memory",
1109 1110
        .args_type  = "paging:-p,detach:-d,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:i?,length:i?",
        .params     = "[-p] [-d] [-z|-l|-s] filename [begin length]",
1111 1112
        .help       = "dump guest memory into file 'filename'.\n\t\t\t"
                      "-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 1115 1116
                      "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
                      "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
                      "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
1117 1118
                      "begin: the starting physical address.\n\t\t\t"
                      "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 1127
@findex dump-guest-memory
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 1131 1132
        -z: dump in kdump-compressed format, with zlib compression.
        -l: dump in kdump-compressed format, with lzo compression.
        -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 1139
ETEXI

1140 1141 1142 1143 1144 1145
#if defined(TARGET_S390X)
    {
        .name       = "dump-skeys",
        .args_type  = "filename:F",
        .params     = "",
        .help       = "Save guest storage keys into file 'filename'.\n",
1146
        .cmd        = hmp_dump_skeys,
1147 1148 1149 1150 1151 1152 1153 1154 1155
    },
#endif

STEXI
@item dump-skeys @var{filename}
@findex dump-skeys
Save guest storage keys to a file.
ETEXI

1156
    {
1157
        .name       = "snapshot_blkdev",
1158 1159
        .args_type  = "reuse:-n,device:B,snapshot-file:s?,format:s?",
        .params     = "[-n] device [new-image-file] [format]",
1160 1161 1162 1163
        .help       = "initiates a live snapshot\n\t\t\t"
                      "of device. If a new image file is specified, the\n\t\t\t"
                      "new image file will become the new root image.\n\t\t\t"
                      "If format is specified, the snapshot file will\n\t\t\t"
1164
                      "be created in that format.\n\t\t\t"
1165 1166 1167
                      "The default format is qcow2.  The -n flag requests QEMU\n\t\t\t"
                      "to reuse the image found in new-image-file, instead of\n\t\t\t"
                      "recreating it from scratch.",
1168
        .cmd        = hmp_snapshot_blkdev,
1169 1170
    },

1171 1172 1173 1174
STEXI
@item snapshot_blkdev
@findex snapshot_blkdev
Snapshot device, using snapshot file as target if provided
1175 1176 1177 1178 1179 1180 1181 1182 1183
ETEXI

    {
        .name       = "snapshot_blkdev_internal",
        .args_type  = "device:B,name:s",
        .params     = "device name",
        .help       = "take an internal snapshot of device.\n\t\t\t"
                      "The format of the image used by device must\n\t\t\t"
                      "support it, such as qcow2.\n\t\t\t",
1184
        .cmd        = hmp_snapshot_blkdev_internal,
1185 1186 1187 1188 1189 1190
    },

STEXI
@item snapshot_blkdev_internal
@findex snapshot_blkdev_internal
Take an internal snapshot on device if it support
1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201
ETEXI

    {
        .name       = "snapshot_delete_blkdev_internal",
        .args_type  = "device:B,name:s,id:s?",
        .params     = "device name [id]",
        .help       = "delete an internal snapshot of device.\n\t\t\t"
                      "If id is specified, qemu will try delete\n\t\t\t"
                      "the snapshot matching both id and name.\n\t\t\t"
                      "The format of the image used by device must\n\t\t\t"
                      "support it, such as qcow2.\n\t\t\t",
1202
        .cmd        = hmp_snapshot_delete_blkdev_internal,
1203 1204 1205 1206 1207 1208
    },

STEXI
@item snapshot_delete_blkdev_internal
@findex snapshot_delete_blkdev_internal
Delete an internal snapshot on device if it support
1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222
ETEXI

    {
        .name       = "drive_mirror",
        .args_type  = "reuse:-n,full:-f,device:B,target:s,format:s?",
        .params     = "[-n] [-f] device target [format]",
        .help       = "initiates live storage\n\t\t\t"
                      "migration for a device. The device's contents are\n\t\t\t"
                      "copied to the new image file, including data that\n\t\t\t"
                      "is written after the command is started.\n\t\t\t"
                      "The -n flag requests QEMU to reuse the image found\n\t\t\t"
                      "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
                      "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
                      "so that the result does not need a backing file.\n\t\t\t",
1223
        .cmd        = hmp_drive_mirror,
1224 1225 1226 1227 1228 1229
    },
STEXI
@item drive_mirror
@findex drive_mirror
Start mirroring a block device's writes to a new destination,
using the specified target.
1230 1231 1232 1233
ETEXI

    {
        .name       = "drive_backup",
1234 1235
        .args_type  = "reuse:-n,full:-f,compress:-c,device:B,target:s,format:s?",
        .params     = "[-n] [-f] [-c] device target [format]",
1236 1237 1238 1239 1240 1241 1242
        .help       = "initiates a point-in-time\n\t\t\t"
                      "copy for a device. The device's contents are\n\t\t\t"
                      "copied to the new image file, excluding data that\n\t\t\t"
                      "is written after the command is started.\n\t\t\t"
                      "The -n flag requests QEMU to reuse the image found\n\t\t\t"
                      "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
                      "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1243 1244 1245
                      "so that the result does not need a backing file.\n\t\t\t"
                      "The -c flag requests QEMU to compress backup data\n\t\t\t"
                      "(if the target format supports it).\n\t\t\t",
1246
        .cmd        = hmp_drive_backup,
1247 1248 1249 1250 1251
    },
STEXI
@item drive_backup
@findex drive_backup
Start a point-in-time copy of a block device to a specificed target.
1252 1253
ETEXI

1254 1255
    {
        .name       = "drive_add",
1256 1257
        .args_type  = "node:-n,pci_addr:s,opts:s",
        .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 1262
                      "[,snapshot=on|off][,cache=on|off]\n"
                      "[,readonly=on|off][,copy-on-read=on|off]",
1263
        .help       = "add drive to PCI storage controller",
1264
        .cmd        = hmp_drive_add,
1265 1266
    },

1267 1268
STEXI
@item drive_add
1269
@findex drive_add
1270
Add drive to PCI storage controller.
1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287
ETEXI

    {
        .name       = "pcie_aer_inject_error",
        .args_type  = "advisory_non_fatal:-a,correctable:-c,"
	              "id:s,error_status:s,"
	              "header0:i?,header1:i?,header2:i?,header3:i?,"
	              "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
        .params     = "[-a] [-c] id "
                      "<error_status> [<tlp header> [<tlp header prefix>]]",
        .help       = "inject pcie aer error\n\t\t\t"
	              " -a for advisory non fatal error\n\t\t\t"
	              " -c for correctable error\n\t\t\t"
                      "<id> = qdev device id\n\t\t\t"
                      "<error_status> = error string or 32bit\n\t\t\t"
                      "<tlb header> = 32bit x 4\n\t\t\t"
                      "<tlb header prefix> = 32bit x 4",
1288
        .cmd        = hmp_pcie_aer_inject_error,
1289 1290 1291 1292 1293 1294
    },

STEXI
@item pcie_aer_inject_error
@findex pcie_aer_inject_error
Inject PCIe AER error
1295 1296
ETEXI

1297 1298 1299
    {
        .name       = "host_net_add",
        .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 1307
STEXI
@item host_net_add
1308
@findex host_net_add
1309
Add host VLAN client. Deprecated, please use @code{netdev_add} instead.
1310 1311
ETEXI

1312 1313 1314 1315
    {
        .name       = "host_net_remove",
        .args_type  = "vlan_id:i,device:s",
        .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 1322
STEXI
@item host_net_remove
1323
@findex host_net_remove
1324
Remove host VLAN client. Deprecated, please use @code{netdev_del} instead.
1325 1326 1327 1328 1329
ETEXI

    {
        .name       = "netdev_add",
        .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 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346
    },

STEXI
@item netdev_add
@findex netdev_add
Add host network device.
ETEXI

    {
        .name       = "netdev_del",
        .args_type  = "id:s",
        .params     = "id",
        .help       = "remove host network device",
1347
        .cmd        = hmp_netdev_del,
1348
        .command_completion = netdev_del_completion,
1349 1350 1351 1352 1353 1354
    },

STEXI
@item netdev_del
@findex netdev_del
Remove host network device.
1355 1356 1357 1358 1359 1360 1361
ETEXI

    {
        .name       = "object_add",
        .args_type  = "object:O",
        .params     = "[qom-type=]type,id=str[,prop=value][,...]",
        .help       = "create QOM object",
1362
        .cmd        = hmp_object_add,
1363
        .command_completion = object_add_completion,
1364 1365 1366 1367 1368 1369
    },

STEXI
@item object_add
@findex object_add
Create QOM object.
1370 1371 1372 1373 1374 1375 1376
ETEXI

    {
        .name       = "object_del",
        .args_type  = "id:s",
        .params     = "id",
        .help       = "destroy QOM object",
1377
        .cmd        = hmp_object_del,
1378
        .command_completion = object_del_completion,
1379 1380 1381 1382 1383 1384
    },

STEXI
@item object_del
@findex object_del
Destroy QOM object.
1385 1386 1387
ETEXI

#ifdef CONFIG_SLIRP
1388 1389 1390 1391 1392
    {
        .name       = "hostfwd_add",
        .args_type  = "arg1:s,arg2:s?,arg3:s?",
        .params     = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
        .help       = "redirect TCP or UDP connections from host to guest (requires -net user)",
1393
        .cmd        = hmp_hostfwd_add,
1394
    },
1395 1396 1397 1398 1399 1400
#endif
STEXI
@item hostfwd_add
@findex hostfwd_add
Redirect TCP or UDP connections from host to guest (requires -net user).
ETEXI
1401

1402
#ifdef CONFIG_SLIRP
1403 1404 1405 1406 1407
    {
        .name       = "hostfwd_remove",
        .args_type  = "arg1:s,arg2:s?,arg3:s?",
        .params     = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
        .help       = "remove host-to-guest TCP or UDP redirection",
1408
        .cmd        = hmp_hostfwd_remove,
1409 1410
    },

1411 1412
#endif
STEXI
1413 1414 1415
@item hostfwd_remove
@findex hostfwd_remove
Remove host-to-guest TCP or UDP redirection.
1416 1417
ETEXI

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 1427
STEXI
@item balloon @var{value}
1428
@findex balloon
1429 1430 1431
Request VM to change its memory allocation to @var{value} (in MB).
ETEXI

1432 1433
    {
        .name       = "set_link",
1434 1435
        .args_type  = "name:s,up:b",
        .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 1446
ETEXI

1447 1448 1449 1450 1451
    {
        .name       = "watchdog_action",
        .args_type  = "action:s",
        .params     = "[reset|shutdown|poweroff|pause|debug|none]",
        .help       = "change watchdog action",
1452
        .cmd        = hmp_watchdog_action,
1453
        .command_completion = watchdog_action_completion,
1454 1455
    },

1456 1457
STEXI
@item watchdog_action
1458
@findex watchdog_action
1459 1460 1461
Change watchdog action.
ETEXI

1462 1463 1464 1465 1466
    {
        .name       = "acl_show",
        .args_type  = "aclname:s",
        .params     = "aclname",
        .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 1474 1475 1476 1477
List all the matching rules in the access control list, and the default
policy. There are currently two named access control lists,
@var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
certificate distinguished name, and SASL username respectively.
ETEXI
1478

1479 1480 1481 1482 1483
    {
        .name       = "acl_policy",
        .args_type  = "aclname:s,policy:s",
        .params     = "aclname allow|deny",
        .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 1493 1494
always @code{deny}.
ETEXI

1495 1496 1497 1498 1499
    {
        .name       = "acl_add",
        .args_type  = "aclname:s,match:s,policy:s,index:i?",
        .params     = "aclname match allow|deny [index]",
        .help       = "add a match rule to the access control list",
1500
        .cmd        = hmp_acl_add,
1501 1502
    },

1503
STEXI
1504 1505
@item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
@findex acl_add
1506 1507 1508 1509
Add a match rule to the access control list, allowing or denying access.
The match will normally be an exact username or x509 distinguished name,
but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
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