hmp-commands.hx 48.2 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
        .mhandler.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
        .mhandler.cmd = do_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
        .user_print = monitor_user_noop,
Luiz Capitulino's avatar
Luiz Capitulino committed
51
        .mhandler.cmd = hmp_quit,
52 53
    },

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

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

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

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

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

    {
        .name       = "block_job_set_speed",
93 94
        .args_type  = "device:B,speed:o",
        .params     = "device speed",
95 96 97 98 99
        .help       = "set maximum speed for a background block operation",
        .mhandler.cmd = hmp_block_job_set_speed,
    },

STEXI
100 101
@item block_job_set_speed
@findex block_job_set_speed
102
Set maximum speed for a background block operation.
103 104 105 106
ETEXI

    {
        .name       = "block_job_cancel",
107 108 109 110
        .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)",
111 112 113 114 115 116
        .mhandler.cmd = hmp_block_job_cancel,
    },

STEXI
@item block_job_cancel
@findex block_job_cancel
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
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",
        .mhandler.cmd = hmp_block_job_complete,
    },

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.
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
ETEXI

    {
        .name       = "block_job_pause",
        .args_type  = "device:B",
        .params     = "device",
        .help       = "pause an active background block operation",
        .mhandler.cmd = hmp_block_job_pause,
    },

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",
        .mhandler.cmd = hmp_block_job_resume,
    },

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

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

171 172
STEXI
@item eject [-f] @var{device}
173
@findex eject
174
Eject a removable medium (use -f to force it).
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
ETEXI

    {
        .name       = "drive_del",
        .args_type  = "id:s",
        .params     = "device",
        .help       = "remove host block device",
        .user_print = monitor_user_noop,
        .mhandler.cmd_new = do_drive_del,
    },

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.
193 194
These errors are always reported to the guest, regardless of the drive's error
actions (drive options rerror, werror).
195 196
ETEXI

197 198 199 200 201
    {
        .name       = "change",
        .args_type  = "device:B,target:F,arg:s?",
        .params     = "device filename [format]",
        .help       = "change a removable medium, optional format",
Luiz Capitulino's avatar
Luiz Capitulino committed
202
        .mhandler.cmd = hmp_change,
203 204
    },

205 206
STEXI
@item change @var{device} @var{setting}
207
@findex change
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242

Change the configuration of a device.

@table @option
@item change @var{diskdevice} @var{filename} [@var{format}]
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.

@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

243 244 245 246 247
    {
        .name       = "screendump",
        .args_type  = "filename:F",
        .params     = "filename",
        .help       = "save screen into PPM image 'filename'",
Luiz Capitulino's avatar
Luiz Capitulino committed
248
        .mhandler.cmd = hmp_screen_dump,
249 250
    },

251 252
STEXI
@item screendump @var{filename}
253
@findex screendump
254 255 256
Save screen into PPM image @var{filename}.
ETEXI

257 258 259 260 261
    {
        .name       = "logfile",
        .args_type  = "filename:F",
        .params     = "filename",
        .help       = "output logs to 'filename'",
262
        .mhandler.cmd = do_logfile,
263 264
    },

265 266
STEXI
@item logfile @var{filename}
267
@findex logfile
268 269 270
Output logs to @var{filename}.
ETEXI

271 272 273 274 275
    {
        .name       = "trace-event",
        .args_type  = "name:s,option:b",
        .params     = "name on|off",
        .help       = "changes status of a specific trace event",
276
        .mhandler.cmd = do_trace_event_set_state,
277 278 279 280 281 282
    },

STEXI
@item trace-event
@findex trace-event
changes status of a trace event
283 284
ETEXI

285
#if defined(CONFIG_TRACE_SIMPLE)
286 287 288 289 290 291 292 293 294 295 296 297
    {
        .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",
        .mhandler.cmd = do_trace_file,
    },

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.
298 299 300
ETEXI
#endif

301 302 303 304
    {
        .name       = "log",
        .args_type  = "items:s",
        .params     = "item1[,...]",
305
        .help       = "activate logging of the specified items",
306
        .mhandler.cmd = do_log,
307 308
    },

309 310
STEXI
@item log @var{item1}[,...]
311
@findex log
312
Activate logging of the specified items.
313 314
ETEXI

315 316 317 318 319
    {
        .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",
320
        .mhandler.cmd = do_savevm,
321 322
    },

323 324
STEXI
@item savevm [@var{tag}|@var{id}]
325
@findex savevm
326 327 328 329 330 331
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

332 333 334 335 336
    {
        .name       = "loadvm",
        .args_type  = "name:s",
        .params     = "tag|id",
        .help       = "restore a VM snapshot from its tag or id",
337
        .mhandler.cmd = do_loadvm,
338 339
    },

340 341
STEXI
@item loadvm @var{tag}|@var{id}
342
@findex loadvm
343 344 345 346
Set the whole virtual machine to the snapshot identified by the tag
@var{tag} or the unique snapshot ID @var{id}.
ETEXI

347 348 349 350 351
    {
        .name       = "delvm",
        .args_type  = "name:s",
        .params     = "tag|id",
        .help       = "delete a VM snapshot from its tag or id",
352
        .mhandler.cmd = do_delvm,
353 354
    },

355 356
STEXI
@item delvm @var{tag}|@var{id}
357
@findex delvm
358 359 360
Delete the snapshot identified by @var{tag} or @var{id}.
ETEXI

361 362 363 364 365
    {
        .name       = "singlestep",
        .args_type  = "option:s?",
        .params     = "[on|off]",
        .help       = "run emulation in singlestep mode or switch to normal mode",
366
        .mhandler.cmd = do_singlestep,
367 368
    },

369 370
STEXI
@item singlestep [off]
371
@findex singlestep
372 373 374 375
Run the emulation in single step mode.
If called with option off, the emulation returns to normal mode.
ETEXI

376 377 378 379 380
    {
        .name       = "stop",
        .args_type  = "",
        .params     = "",
        .help       = "stop emulation",
Luiz Capitulino's avatar
Luiz Capitulino committed
381
        .mhandler.cmd = hmp_stop,
382 383
    },

384 385
STEXI
@item stop
386
@findex stop
387 388 389
Stop emulation.
ETEXI

390 391 392 393 394
    {
        .name       = "c|cont",
        .args_type  = "",
        .params     = "",
        .help       = "resume emulation",
Luiz Capitulino's avatar
Luiz Capitulino committed
395
        .mhandler.cmd = hmp_cont,
396 397
    },

398 399
STEXI
@item c or cont
400
@findex cont
401
Resume emulation.
402 403 404 405 406 407 408 409 410 411 412 413 414 415
ETEXI

    {
        .name       = "system_wakeup",
        .args_type  = "",
        .params     = "",
        .help       = "wakeup guest from suspend",
        .mhandler.cmd = hmp_system_wakeup,
    },

STEXI
@item system_wakeup
@findex system_wakeup
Wakeup guest from suspend.
416 417
ETEXI

418 419 420 421 422
    {
        .name       = "gdbserver",
        .args_type  = "device:s?",
        .params     = "[device]",
        .help       = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
423
        .mhandler.cmd = do_gdbserver,
424 425
    },

426 427
STEXI
@item gdbserver [@var{port}]
428
@findex gdbserver
429 430 431
Start gdbserver session (default @var{port}=1234)
ETEXI

432 433 434 435 436
    {
        .name       = "x",
        .args_type  = "fmt:/,addr:l",
        .params     = "/fmt addr",
        .help       = "virtual memory dump starting at 'addr'",
437
        .mhandler.cmd = do_memory_dump,
438 439
    },

440 441
STEXI
@item x/fmt @var{addr}
442
@findex x
443 444 445
Virtual memory dump starting at @var{addr}.
ETEXI

446 447 448 449 450
    {
        .name       = "xp",
        .args_type  = "fmt:/,addr:l",
        .params     = "/fmt addr",
        .help       = "physical memory dump starting at 'addr'",
451
        .mhandler.cmd = do_physical_memory_dump,
452 453
    },

454 455
STEXI
@item xp /@var{fmt} @var{addr}
456
@findex xp
457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 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
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
ETEXI

513 514 515 516 517
    {
        .name       = "p|print",
        .args_type  = "fmt:/,val:l",
        .params     = "/fmt expr",
        .help       = "print expression value (use $reg for CPU register access)",
518
        .mhandler.cmd = do_print,
519 520
    },

521 522
STEXI
@item p or print/@var{fmt} @var{expr}
523
@findex print
524 525 526 527 528

Print expression value. Only the @var{format} part of @var{fmt} is
used.
ETEXI

529 530 531 532 533
    {
        .name       = "i",
        .args_type  = "fmt:/,addr:i,index:i.",
        .params     = "/fmt addr",
        .help       = "I/O port read",
534
        .mhandler.cmd = do_ioport_read,
535 536
    },

537 538 539 540
STEXI
Read I/O port.
ETEXI

541 542 543 544 545
    {
        .name       = "o",
        .args_type  = "fmt:/,addr:i,val:i",
        .params     = "/fmt addr value",
        .help       = "I/O port write",
546
        .mhandler.cmd = do_ioport_write,
547 548
    },

Jan Kiszka's avatar
Jan Kiszka committed
549 550 551
STEXI
Write to I/O port.
ETEXI
552

553 554
    {
        .name       = "sendkey",
Amos Kong's avatar
Amos Kong committed
555
        .args_type  = "keys:s,hold-time:i?",
556 557
        .params     = "keys [hold_ms]",
        .help       = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
Amos Kong's avatar
Amos Kong committed
558
        .mhandler.cmd = hmp_send_key,
559 560
    },

561 562
STEXI
@item sendkey @var{keys}
563
@findex sendkey
564

565 566 567
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:
568 569 570 571 572 573 574 575
@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

576 577 578 579 580
    {
        .name       = "system_reset",
        .args_type  = "",
        .params     = "",
        .help       = "reset the system",
Luiz Capitulino's avatar
Luiz Capitulino committed
581
        .mhandler.cmd = hmp_system_reset,
582 583
    },

584 585
STEXI
@item system_reset
586
@findex system_reset
587 588 589 590

Reset the system.
ETEXI

591 592 593 594 595
    {
        .name       = "system_powerdown",
        .args_type  = "",
        .params     = "",
        .help       = "send system power down event",
596
        .mhandler.cmd = hmp_system_powerdown,
597 598
    },

599 600
STEXI
@item system_powerdown
601
@findex system_powerdown
602 603 604 605

Power down the system (if supported).
ETEXI

606 607 608 609 610
    {
        .name       = "sum",
        .args_type  = "start:i,size:i",
        .params     = "addr size",
        .help       = "compute the checksum of a memory region",
611
        .mhandler.cmd = do_sum,
612 613
    },

614 615
STEXI
@item sum @var{addr} @var{size}
616
@findex sum
617 618 619 620

Compute the checksum of a memory region.
ETEXI

621 622 623 624 625
    {
        .name       = "usb_add",
        .args_type  = "devname:s",
        .params     = "device",
        .help       = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
626
        .mhandler.cmd = do_usb_add,
627 628
    },

629 630
STEXI
@item usb_add @var{devname}
631
@findex usb_add
632 633 634 635 636

Add the USB device @var{devname}.  For details of available devices see
@ref{usb_devices}
ETEXI

637 638 639 640 641
    {
        .name       = "usb_del",
        .args_type  = "devname:s",
        .params     = "device",
        .help       = "remove USB device 'bus.addr'",
642
        .mhandler.cmd = do_usb_del,
643 644
    },

645 646
STEXI
@item usb_del @var{devname}
647
@findex usb_del
648 649 650 651 652 653

Remove the USB device @var{devname} from the QEMU virtual USB
hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
command @code{info usb} to see the devices you can remove.
ETEXI

654 655
    {
        .name       = "device_add",
656 657
        .args_type  = "device:O",
        .params     = "driver[,prop=value][,...]",
658
        .help       = "add device, like -device on the command line",
659 660
        .user_print = monitor_user_noop,
        .mhandler.cmd_new = do_device_add,
661 662
    },

663 664
STEXI
@item device_add @var{config}
665
@findex device_add
666 667 668 669

Add device.
ETEXI

670 671 672 673 674
    {
        .name       = "device_del",
        .args_type  = "id:s",
        .params     = "device",
        .help       = "remove device",
Luiz Capitulino's avatar
Luiz Capitulino committed
675
        .mhandler.cmd = hmp_device_del,
676 677
    },

678 679
STEXI
@item device_del @var{id}
680
@findex device_del
681 682 683 684

Remove device @var{id}.
ETEXI

685 686 687 688 689
    {
        .name       = "cpu",
        .args_type  = "index:i",
        .params     = "index",
        .help       = "set the default CPU",
690
        .mhandler.cmd = hmp_cpu,
691
    },
692

693
STEXI
694 695
@item cpu @var{index}
@findex cpu
696 697 698
Set the default CPU.
ETEXI

699 700 701 702 703
    {
        .name       = "mouse_move",
        .args_type  = "dx_str:s,dy_str:s,dz_str:s?",
        .params     = "dx dy [dz]",
        .help       = "send mouse move events",
704
        .mhandler.cmd = do_mouse_move,
705 706
    },

707 708
STEXI
@item mouse_move @var{dx} @var{dy} [@var{dz}]
709
@findex mouse_move
710 711 712 713
Move the active mouse to the specified coordinates @var{dx} @var{dy}
with optional scroll axis @var{dz}.
ETEXI

714 715 716 717 718
    {
        .name       = "mouse_button",
        .args_type  = "button_state:i",
        .params     = "state",
        .help       = "change mouse button state (1=L, 2=M, 4=R)",
719
        .mhandler.cmd = do_mouse_button,
720 721
    },

722 723
STEXI
@item mouse_button @var{val}
724
@findex mouse_button
725 726 727
Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
ETEXI

728 729 730 731 732
    {
        .name       = "mouse_set",
        .args_type  = "index:i",
        .params     = "index",
        .help       = "set which mouse device receives events",
733
        .mhandler.cmd = do_mouse_set,
734 735
    },

736 737
STEXI
@item mouse_set @var{index}
738
@findex mouse_set
739 740 741 742 743 744 745
Set which mouse device receives events at given @var{index}, index
can be obtained with
@example
info mice
@end example
ETEXI

746 747 748 749 750
    {
        .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)",
751
        .mhandler.cmd = do_wav_capture,
752
    },
753 754
STEXI
@item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
755
@findex wavcapture
756 757 758 759 760 761 762 763 764 765 766
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

767 768 769 770 771
    {
        .name       = "stopcapture",
        .args_type  = "n:i",
        .params     = "capture index",
        .help       = "stop capture",
772
        .mhandler.cmd = do_stop_capture,
773
    },
774 775
STEXI
@item stopcapture @var{index}
776
@findex stopcapture
777 778 779 780 781 782
Stop capture with a given @var{index}, index can be obtained with
@example
info capture
@end example
ETEXI

783 784 785 786 787
    {
        .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'",
Luiz Capitulino's avatar
Luiz Capitulino committed
788
        .mhandler.cmd = hmp_memsave,
789 790
    },

791 792
STEXI
@item memsave @var{addr} @var{size} @var{file}
793
@findex memsave
794 795 796
save to disk virtual memory dump starting at @var{addr} of size @var{size}.
ETEXI

797 798 799 800 801
    {
        .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'",
Luiz Capitulino's avatar
Luiz Capitulino committed
802
        .mhandler.cmd = hmp_pmemsave,
803 804
    },

805 806
STEXI
@item pmemsave @var{addr} @var{size} @var{file}
807
@findex pmemsave
808 809 810
save to disk physical memory dump starting at @var{addr} of size @var{size}.
ETEXI

811 812 813 814 815
    {
        .name       = "boot_set",
        .args_type  = "bootdevice:s",
        .params     = "bootdevice",
        .help       = "define new values for the boot device list",
816
        .mhandler.cmd = do_boot_set,
817 818
    },

819 820
STEXI
@item boot_set @var{bootdevicelist}
821
@findex boot_set
822 823 824 825 826 827 828 829

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

830
#if defined(TARGET_I386) || defined(TARGET_S390X)
831 832
    {
        .name       = "nmi",
833 834 835
        .args_type  = "",
        .params     = "",
        .help       = "inject an NMI on all guest's CPUs",
Luiz Capitulino's avatar
Luiz Capitulino committed
836
        .mhandler.cmd = hmp_inject_nmi,
837
    },
838 839 840
#endif
STEXI
@item nmi @var{cpu}
841
@findex nmi
842
Inject an NMI (x86) or RESTART (s390x) on the given CPU.
843 844 845 846

ETEXI

    {
847
        .name       = "ringbuf_write",
848 849
        .args_type  = "device:s,data:s",
        .params     = "device data",
850 851
        .help       = "Write to a ring buffer character device",
        .mhandler.cmd = hmp_ringbuf_write,
852 853 854
    },

STEXI
855 856 857 858
@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.
859

860 861 862
ETEXI

    {
863
        .name       = "ringbuf_read",
864 865
        .args_type  = "device:s,size:i",
        .params     = "device size",
866 867
        .help       = "Read from a ring buffer character device",
        .mhandler.cmd = hmp_ringbuf_read,
868 869 870
    },

STEXI
871 872 873 874
@item ringbuf_read @var{device}
@findex ringbuf_read
Read and print up to @var{size} bytes from ring buffer character
device @var{device}.
875 876
Certain non-printable characters are printed \uXXXX, where XXXX is the
character code in hexadecimal.  Character \ is printed \\.
877 878 879
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.
880

881 882
ETEXI

883 884
    {
        .name       = "migrate",
885 886 887 888 889 890 891
        .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)",
Luiz Capitulino's avatar
Luiz Capitulino committed
892
        .mhandler.cmd = hmp_migrate,
893 894
    },

895

896
STEXI
897
@item migrate [-d] [-b] [-i] @var{uri}
898
@findex migrate
899
Migrate to @var{uri} (using -d to not wait for completion).
900 901
	-b for migration with full copy of disk
	-i for migration with incremental copy of disk (base image is shared)
902 903
ETEXI

904 905 906 907 908
    {
        .name       = "migrate_cancel",
        .args_type  = "",
        .params     = "",
        .help       = "cancel the current VM migration",
909
        .mhandler.cmd = hmp_migrate_cancel,
910 911
    },

912 913
STEXI
@item migrate_cancel
914
@findex migrate_cancel
915
Cancel the current VM migration.
916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935

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",
        .mhandler.cmd = hmp_migrate_set_cache_size,
    },

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

938 939
    {
        .name       = "migrate_set_speed",
940
        .args_type  = "value:o",
941
        .params     = "value",
942 943
        .help       = "set maximum speed (in bytes) for migrations. "
	"Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
944
        .mhandler.cmd = hmp_migrate_set_speed,
945 946
    },

947 948
STEXI
@item migrate_set_speed @var{value}
949
@findex migrate_set_speed
950
Set maximum speed to @var{value} (in bytes) for migrations.
Glauber Costa's avatar
Glauber Costa committed
951 952
ETEXI

953 954
    {
        .name       = "migrate_set_downtime",
955
        .args_type  = "value:T",
956 957
        .params     = "value",
        .help       = "set maximum tolerated downtime (in seconds) for migrations",
958
        .mhandler.cmd = hmp_migrate_set_downtime,
959
    },
Glauber Costa's avatar
Glauber Costa committed
960 961 962

STEXI
@item migrate_set_downtime @var{second}
963
@findex migrate_set_downtime
Glauber Costa's avatar
Glauber Costa committed
964
Set maximum tolerated downtime (in seconds) for migration.
965 966 967 968 969 970 971 972 973 974 975 976 977 978
ETEXI

    {
        .name       = "migrate_set_capability",
        .args_type  = "capability:s,state:b",
        .params     = "capability state",
        .help       = "Enable/Disable the usage of a capability for migration",
        .mhandler.cmd = hmp_migrate_set_capability,
    },

STEXI
@item migrate_set_capability @var{capability} @var{state}
@findex migrate_set_capability
Enable/Disable the usage of a capability @var{capability} for migration.
979 980 981
ETEXI

    {
982 983 984 985 986
        .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",
        .help       = "send migration info to spice/vnc client",
        .user_print = monitor_user_noop,
987 988
        .mhandler.cmd_async = client_migrate_info,
        .flags      = MONITOR_CMD_ASYNC,
989 990
    },

Gerd Hoffmann's avatar
Gerd Hoffmann committed
991 992 993 994 995 996 997 998
STEXI
@item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
@findex client_migrate_info
Set the spice/vnc connection info for the migration target.  The spice/vnc
server will ask the spice/vnc client to automatically reconnect using the
new parameters (if specified) once the vm migration finished successfully.
ETEXI

999 1000
    {
        .name       = "dump-guest-memory",
1001 1002
        .args_type  = "paging:-p,filename:F,begin:i?,length:i?",
        .params     = "[-p] filename [begin] [length]",
1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
        .help       = "dump guest memory to file"
                      "\n\t\t\t begin(optional): the starting physical address"
                      "\n\t\t\t length(optional): the memory size, in bytes",
        .mhandler.cmd = hmp_dump_guest_memory,
    },


STEXI
@item dump-guest-memory [-p] @var{protocol} @var{begin} @var{length}
@findex dump-guest-memory
Dump guest memory to @var{protocol}. The file can be processed with crash or
gdb.
1015
  filename: dump file name
1016 1017 1018 1019 1020 1021 1022
    paging: do paging to get guest's memory mapping
     begin: the starting physical address. It's optional, and should be
            specified with length together.
    length: the memory size, in bytes. It's optional, and should be specified
            with begin together.
ETEXI

Gerd Hoffmann's avatar
Gerd Hoffmann committed
1023
    {
1024
        .name       = "snapshot_blkdev",
1025 1026
        .args_type  = "reuse:-n,device:B,snapshot-file:s?,format:s?",
        .params     = "[-n] device [new-image-file] [format]",
1027 1028 1029 1030
        .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"
1031
                      "be created in that format.\n\t\t\t"
1032 1033 1034
                      "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.",
1035
        .mhandler.cmd = hmp_snapshot_blkdev,
Gerd Hoffmann's avatar
Gerd Hoffmann committed
1036 1037
    },

1038 1039 1040 1041
STEXI
@item snapshot_blkdev
@findex snapshot_blkdev
Snapshot device, using snapshot file as target if provided
1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057
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",
        .mhandler.cmd = hmp_snapshot_blkdev_internal,
    },

STEXI
@item snapshot_blkdev_internal
@findex snapshot_blkdev_internal
Take an internal snapshot on device if it support
1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075
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",
        .mhandler.cmd = hmp_snapshot_delete_blkdev_internal,
    },

STEXI
@item snapshot_delete_blkdev_internal
@findex snapshot_delete_blkdev_internal
Delete an internal snapshot on device if it support
1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096
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",
        .mhandler.cmd = hmp_drive_mirror,
    },
STEXI
@item drive_mirror
@findex drive_mirror
Start mirroring a block device's writes to a new destination,
using the specified target.
1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116
ETEXI

    {
        .name       = "drive_backup",
        .args_type  = "reuse:-n,full:-f,device:B,target:s,format:s?",
        .params     = "[-n] [-f] device target [format]",
        .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"
                      "so that the result does not need a backing file.\n\t\t\t",
        .mhandler.cmd = hmp_drive_backup,
    },
STEXI
@item drive_backup
@findex drive_backup
Start a point-in-time copy of a block device to a specificed target.
1117 1118
ETEXI

1119 1120 1121 1122 1123
    {
        .name       = "drive_add",
        .args_type  = "pci_addr:s,opts:s",
        .params     = "[[<domain>:]<bus>:]<slot>\n"
                      "[file=file][,if=type][,bus=n]\n"
1124
                      "[,unit=m][,media=d][,index=i]\n"
1125
                      "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
1126 1127
                      "[,snapshot=on|off][,cache=on|off]\n"
                      "[,readonly=on|off][,copy-on-read=on|off]",
1128
        .help       = "add drive to PCI storage controller",
1129
        .mhandler.cmd = drive_hot_add,
1130 1131
    },

1132 1133
STEXI
@item drive_add
1134
@findex drive_add
1135 1136 1137
Add drive to PCI storage controller.
ETEXI

1138
#if defined(CONFIG_PCI_HOTPLUG_OLD)
1139 1140 1141 1142 1143
    {
        .name       = "pci_add",
        .args_type  = "pci_addr:s,type:s,opts:s?",
        .params     = "auto|[[<domain>:]<bus>:]<slot> nic|storage [[vlan=n][,macaddr=addr][,model=type]] [file=file][,if=type][,bus=nr]...",
        .help       = "hot-add PCI device",
1144
        .mhandler.cmd = pci_device_hot_add,
1145
    },
1146
#endif
1147

1148 1149
STEXI
@item pci_add
1150
@findex pci_add
1151 1152 1153
Hot-add PCI device.
ETEXI

1154
#if defined(CONFIG_PCI_HOTPLUG_OLD)
1155 1156 1157 1158 1159
    {
        .name       = "pci_del",
        .args_type  = "pci_addr:s",
        .params     = "[[<domain>:]<bus>:]<slot>",
        .help       = "hot remove PCI device",
1160
        .mhandler.cmd = do_pci_device_hot_remove,
1161
    },
1162
#endif
1163

1164 1165
STEXI
@item pci_del
1166
@findex pci_del
1167
Hot remove PCI device.
1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185
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",
        .user_print  = pcie_aer_inject_error_print,
1186
        .mhandler.cmd_new = do_pcie_aer_inject_error,
1187 1188 1189 1190 1191 1192
    },

STEXI
@item pcie_aer_inject_error
@findex pcie_aer_inject_error
Inject PCIe AER error
1193 1194
ETEXI

1195 1196 1197
    {
        .name       = "host_net_add",
        .args_type  = "device:s,opts:s?",
1198
        .params     = "tap|user|socket|vde|netmap|dump [options]",
1199
        .help       = "add host VLAN client",
1200
        .mhandler.cmd = net_host_device_add,
1201 1202
    },

1203 1204
STEXI
@item host_net_add
1205
@findex host_net_add
1206 1207 1208
Add host VLAN client.
ETEXI

1209 1210 1211 1212 1213
    {
        .name       = "host_net_remove",
        .args_type  = "vlan_id:i,device:s",
        .params     = "vlan_id name",
        .help       = "remove host VLAN client",
1214
        .mhandler.cmd = net_host_device_remove,
1215 1216
    },

1217 1218
STEXI
@item host_net_remove
1219
@findex host_net_remove
1220
Remove host VLAN client.
1221 1222 1223 1224 1225
ETEXI

    {
        .name       = "netdev_add",
        .args_type  = "netdev:O",
1226
        .params     = "[user|tap|socket|hubport|netmap],id=str[,prop=value][,...]",
1227
        .help       = "add host network device",
Luiz Capitulino's avatar
Luiz Capitulino committed
1228
        .mhandler.cmd = hmp_netdev_add,
1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241
    },

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",
Luiz Capitulino's avatar
Luiz Capitulino committed
1242
        .mhandler.cmd = hmp_netdev_del,
1243 1244 1245 1246 1247 1248
    },

STEXI
@item netdev_del
@findex netdev_del
Remove host network device.
1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262
ETEXI

    {
        .name       = "object_add",
        .args_type  = "object:O",
        .params     = "[qom-type=]type,id=str[,prop=value][,...]",
        .help       = "create QOM object",
        .mhandler.cmd = hmp_object_add,
    },

STEXI
@item object_add
@findex object_add
Create QOM object.
1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276
ETEXI

    {
        .name       = "object_del",
        .args_type  = "id:s",
        .params     = "id",
        .help       = "destroy QOM object",
        .mhandler.cmd = hmp_object_del,
    },

STEXI
@item object_del
@findex object_del
Destroy QOM object.
1277 1278 1279
ETEXI

#ifdef CONFIG_SLIRP
1280 1281 1282 1283 1284
    {
        .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)",
1285
        .mhandler.cmd = net_slirp_hostfwd_add,
1286
    },
1287 1288 1289 1290 1291 1292
#endif
STEXI
@item hostfwd_add
@findex hostfwd_add
Redirect TCP or UDP connections from host to guest (requires -net user).
ETEXI
1293

1294
#ifdef CONFIG_SLIRP
1295 1296 1297 1298 1299
    {
        .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",
1300
        .mhandler.cmd = net_slirp_hostfwd_remove,
1301 1302
    },

1303 1304
#endif
STEXI
1305 1306 1307
@item hostfwd_remove
@findex hostfwd_remove
Remove host-to-guest TCP or UDP redirection.
1308 1309
ETEXI

1310 1311
    {
        .name       = "balloon",
1312
        .args_type  = "value:M",
1313
        .params     = "target",
1314
        .help       = "request VM to change its memory allocation (in MB)",
Luiz Capitulino's avatar
Luiz Capitulino committed
1315
        .mhandler.cmd = hmp_balloon,
1316 1317
    },

1318 1319
STEXI
@item balloon @var{value}
1320
@findex balloon
1321 1322 1323
Request VM to change its memory allocation to @var{value} (in MB).
ETEXI

1324 1325
    {
        .name       = "set_link",
1326 1327
        .args_type  = "name:s,up:b",
        .params     = "name on|off",
1328
        .help       = "change the link status of a network adapter",
Luiz Capitulino's avatar
Luiz Capitulino committed
1329
        .mhandler.cmd = hmp_set_link,
1330 1331
    },

1332
STEXI
1333
@item set_link @var{name} [on|off]
1334
@findex set_link
1335
Switch link @var{name} on (i.e. up) or off (i.e. down).
1336 1337
ETEXI

1338 1339 1340 1341 1342
    {
        .name       = "watchdog_action",
        .args_type  = "action:s",
        .params     = "[reset|shutdown|poweroff|pause|debug|none]",
        .help       = "change watchdog action",
1343
        .mhandler.cmd = do_watchdog_action,
1344 1345
    },

1346 1347
STEXI
@item watchdog_action
1348
@findex watchdog_action
1349 1350 1351
Change watchdog action.
ETEXI

1352 1353 1354 1355 1356
    {
        .name       = "acl_show",
        .args_type  = "aclname:s",
        .params     = "aclname",
        .help       = "list rules in the access control list",
1357
        .mhandler.cmd = do_acl_show,
1358 1359
    },

1360
STEXI
Jan Kiszka's avatar
Jan Kiszka committed
1361
@item acl_show @var{aclname}
1362
@findex acl_show
Jan Kiszka's avatar
Jan Kiszka committed
1363 1364 1365 1366 1367
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
1368

1369 1370 1371 1372 1373
    {
        .name       = "acl_policy",
        .args_type  = "aclname:s,policy:s",
        .params     = "aclname allow|deny",
        .help       = "set default access control list policy",
1374
        .mhandler.cmd = do_acl_policy,
1375 1376
    },

Jan Kiszka's avatar
Jan Kiszka committed
1377
STEXI
1378
@item acl_policy @var{aclname} @code{allow|deny}
1379
@findex acl_policy
Jan Kiszka's avatar
Jan Kiszka committed
1380
Set the default access control list policy, used in the event that
1381
none of the explicit rules match. The default policy at startup is
Jan Kiszka's avatar
Jan Kiszka committed
1382 1383 1384
always @code{deny}.
ETEXI

1385 1386 1387 1388 1389
    {
        .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",
1390
        .mhandler.cmd = do_acl_add,
1391 1392
    },

Jan Kiszka's avatar
Jan Kiszka committed
1393
STEXI
1394 1395
@item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
@findex acl_add
Jan Kiszka's avatar
Jan Kiszka committed
1396 1397 1398 1399
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
1400
normally be appended to the end of the ACL, but can be inserted
Jan Kiszka's avatar
Jan Kiszka committed
1401 1402 1403
earlier in the list if the optional @var{index} parameter is supplied.
ETEXI

1404 1405 1406 1407 1408
    {
        .name       = "acl_remove",
        .args_type  = "aclname:s,match:s",
        .params     = "aclname match",
        .help       = "remove a match rule from the access control list",
1409
        .mhandler.cmd = do_acl_remove,
1410 1411
    },

Jan Kiszka's avatar
Jan Kiszka committed
1412 1413
STEXI
@item acl_remove @var{aclname} @var{match}
1414
@findex acl_remove
Jan Kiszka's avatar
Jan Kiszka committed
1415 1416 1417
Remove the specified match rule from the access control list.
ETEXI

1418 1419 1420 1421 1422
    {
        .name       = "acl_reset",
        .args_type  = "aclname:s",
        .params     = "aclname",
        .help       = "reset the access control list",
1423
        .mhandler.cmd = do_acl_reset,
1424 1425
    },