Revision 70fcbbe7 qemu-monitor.hx

b/qemu-monitor.hx
19 19

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

  
......
32 33

  
33 34
STEXI
34 35
@item commit
36
@findex commit
35 37
Commit changes to the disk images (if -snapshot is used) or backing files.
36 38
ETEXI
37 39

  
......
46 48

  
47 49
STEXI
48 50
@item info @var{subcommand}
51
@findex info
49 52
Show various information about the system state.
50 53

  
51 54
@table @option
......
125 128

  
126 129
STEXI
127 130
@item q or quit
131
@findex quit
128 132
Quit the emulator.
129 133
ETEXI
130 134

  
......
139 143

  
140 144
STEXI
141 145
@item eject [-f] @var{device}
146
@findex eject
142 147
Eject a removable medium (use -f to force it).
143 148
ETEXI
144 149

  
......
153 158

  
154 159
STEXI
155 160
@item change @var{device} @var{setting}
161
@findex change
156 162

  
157 163
Change the configuration of a device.
158 164

  
......
198 204

  
199 205
STEXI
200 206
@item screendump @var{filename}
207
@findex screendump
201 208
Save screen into PPM image @var{filename}.
202 209
ETEXI
203 210

  
......
211 218

  
212 219
STEXI
213 220
@item logfile @var{filename}
221
@findex logfile
214 222
Output logs to @var{filename}.
215 223
ETEXI
216 224

  
......
224 232

  
225 233
STEXI
226 234
@item log @var{item1}[,...]
235
@findex log
227 236
Activate logging of the specified items to @file{/tmp/qemu.log}.
228 237
ETEXI
229 238

  
......
237 246

  
238 247
STEXI
239 248
@item savevm [@var{tag}|@var{id}]
249
@findex savevm
240 250
Create a snapshot of the whole virtual machine. If @var{tag} is
241 251
provided, it is used as human readable identifier. If there is already
242 252
a snapshot with the same tag or ID, it is replaced. More info at
......
253 263

  
254 264
STEXI
255 265
@item loadvm @var{tag}|@var{id}
266
@findex loadvm
256 267
Set the whole virtual machine to the snapshot identified by the tag
257 268
@var{tag} or the unique snapshot ID @var{id}.
258 269
ETEXI
......
267 278

  
268 279
STEXI
269 280
@item delvm @var{tag}|@var{id}
281
@findex delvm
270 282
Delete the snapshot identified by @var{tag} or @var{id}.
271 283
ETEXI
272 284

  
......
280 292

  
281 293
STEXI
282 294
@item singlestep [off]
295
@findex singlestep
283 296
Run the emulation in single step mode.
284 297
If called with option off, the emulation returns to normal mode.
285 298
ETEXI
......
295 308

  
296 309
STEXI
297 310
@item stop
311
@findex stop
298 312
Stop emulation.
299 313
ETEXI
300 314

  
......
309 323

  
310 324
STEXI
311 325
@item c or cont
326
@findex cont
312 327
Resume emulation.
313 328
ETEXI
314 329

  
......
322 337

  
323 338
STEXI
324 339
@item gdbserver [@var{port}]
340
@findex gdbserver
325 341
Start gdbserver session (default @var{port}=1234)
326 342
ETEXI
327 343

  
......
335 351

  
336 352
STEXI
337 353
@item x/fmt @var{addr}
354
@findex x
338 355
Virtual memory dump starting at @var{addr}.
339 356
ETEXI
340 357

  
......
348 365

  
349 366
STEXI
350 367
@item xp /@var{fmt} @var{addr}
368
@findex xp
351 369
Physical memory dump starting at @var{addr}.
352 370

  
353 371
@var{fmt} is a format which tells the command how to format the
......
355 373

  
356 374
@table @var
357 375
@item count
376
@findex count
358 377
is the number of items to be dumped.
359 378

  
360 379
@item format
380
@findex format
361 381
can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
362 382
c (char) or i (asm instruction).
363 383

  
364 384
@item size
385
@findex size
365 386
can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
366 387
@code{h} or @code{w} can be specified with the @code{i} format to
367 388
respectively select 16 or 32 bit code instruction size.
......
414 435

  
415 436
STEXI
416 437
@item p or print/@var{fmt} @var{expr}
438
@findex print
417 439

  
418 440
Print expression value. Only the @var{format} part of @var{fmt} is
419 441
used.
......
453 475

  
454 476
STEXI
455 477
@item sendkey @var{keys}
478
@findex sendkey
456 479

  
457 480
Send @var{keys} to the emulator. @var{keys} could be the name of the
458 481
key or @code{#} followed by the raw value in either decimal or hexadecimal
......
476 499

  
477 500
STEXI
478 501
@item system_reset
502
@findex system_reset
479 503

  
480 504
Reset the system.
481 505
ETEXI
......
491 515

  
492 516
STEXI
493 517
@item system_powerdown
518
@findex system_powerdown
494 519

  
495 520
Power down the system (if supported).
496 521
ETEXI
......
505 530

  
506 531
STEXI
507 532
@item sum @var{addr} @var{size}
533
@findex sum
508 534

  
509 535
Compute the checksum of a memory region.
510 536
ETEXI
......
519 545

  
520 546
STEXI
521 547
@item usb_add @var{devname}
548
@findex usb_add
522 549

  
523 550
Add the USB device @var{devname}.  For details of available devices see
524 551
@ref{usb_devices}
......
534 561

  
535 562
STEXI
536 563
@item usb_del @var{devname}
564
@findex usb_del
537 565

  
538 566
Remove the USB device @var{devname} from the QEMU virtual USB
539 567
hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
......
550 578

  
551 579
STEXI
552 580
@item device_add @var{config}
581
@findex device_add
553 582

  
554 583
Add device.
555 584
ETEXI
......
564 593

  
565 594
STEXI
566 595
@item device_del @var{id}
596
@findex device_del
567 597

  
568 598
Remove device @var{id}.
569 599
ETEXI
......
591 621

  
592 622
STEXI
593 623
@item mouse_move @var{dx} @var{dy} [@var{dz}]
624
@findex mouse_move
594 625
Move the active mouse to the specified coordinates @var{dx} @var{dy}
595 626
with optional scroll axis @var{dz}.
596 627
ETEXI
......
605 636

  
606 637
STEXI
607 638
@item mouse_button @var{val}
639
@findex mouse_button
608 640
Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
609 641
ETEXI
610 642

  
......
618 650

  
619 651
STEXI
620 652
@item mouse_set @var{index}
653
@findex mouse_set
621 654
Set which mouse device receives events at given @var{index}, index
622 655
can be obtained with
623 656
@example
......
636 669
#endif
637 670
STEXI
638 671
@item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
672
@findex wavcapture
639 673
Capture audio into @var{filename}. Using sample rate @var{frequency}
640 674
bits per sample @var{bits} and number of channels @var{channels}.
641 675

  
......
658 692
#endif
659 693
STEXI
660 694
@item stopcapture @var{index}
695
@findex stopcapture
661 696
Stop capture with a given @var{index}, index can be obtained with
662 697
@example
663 698
info capture
......
675 710

  
676 711
STEXI
677 712
@item memsave @var{addr} @var{size} @var{file}
713
@findex memsave
678 714
save to disk virtual memory dump starting at @var{addr} of size @var{size}.
679 715
ETEXI
680 716

  
......
689 725

  
690 726
STEXI
691 727
@item pmemsave @var{addr} @var{size} @var{file}
728
@findex pmemsave
692 729
save to disk physical memory dump starting at @var{addr} of size @var{size}.
693 730
ETEXI
694 731

  
......
702 739

  
703 740
STEXI
704 741
@item boot_set @var{bootdevicelist}
742
@findex boot_set
705 743

  
706 744
Define new values for the boot device list. Those values will override
707 745
the values specified on the command line through the @code{-boot} option.
......
721 759
#endif
722 760
STEXI
723 761
@item nmi @var{cpu}
762
@findex nmi
724 763
Inject an NMI on the given CPU (x86 only).
725 764
ETEXI
726 765

  
......
740 779

  
741 780
STEXI
742 781
@item migrate [-d] [-b] [-i] @var{uri}
782
@findex migrate
743 783
Migrate to @var{uri} (using -d to not wait for completion).
744 784
	-b for migration with full copy of disk
745 785
	-i for migration with incremental copy of disk (base image is shared)
......
756 796

  
757 797
STEXI
758 798
@item migrate_cancel
799
@findex migrate_cancel
759 800
Cancel the current VM migration.
760 801
ETEXI
761 802

  
......
770 811

  
771 812
STEXI
772 813
@item migrate_set_speed @var{value}
814
@findex migrate_set_speed
773 815
Set maximum speed to @var{value} (in bytes) for migrations.
774 816
ETEXI
775 817

  
......
784 826

  
785 827
STEXI
786 828
@item migrate_set_downtime @var{second}
829
@findex migrate_set_downtime
787 830
Set maximum tolerated downtime (in seconds) for migration.
788 831
ETEXI
789 832

  
......
803 846

  
804 847
STEXI
805 848
@item drive_add
849
@findex drive_add
806 850
Add drive to PCI storage controller.
807 851
ETEXI
808 852

  
......
819 863

  
820 864
STEXI
821 865
@item pci_add
866
@findex pci_add
822 867
Hot-add PCI device.
823 868
ETEXI
824 869

  
......
835 880

  
836 881
STEXI
837 882
@item pci_del
883
@findex pci_del
838 884
Hot remove PCI device.
839 885
ETEXI
840 886

  
......
848 894

  
849 895
STEXI
850 896
@item host_net_add
897
@findex host_net_add
851 898
Add host VLAN client.
852 899
ETEXI
853 900

  
......
861 908

  
862 909
STEXI
863 910
@item host_net_remove
911
@findex host_net_remove
864 912
Remove host VLAN client.
865 913
ETEXI
866 914

  
......
884 932
#endif
885 933
STEXI
886 934
@item host_net_redir
935
@findex host_net_redir
887 936
Redirect TCP or UDP connections from host to guest (requires -net user).
888 937
ETEXI
889 938

  
......
899 948

  
900 949
STEXI
901 950
@item balloon @var{value}
951
@findex balloon
902 952
Request VM to change its memory allocation to @var{value} (in MB).
903 953
ETEXI
904 954

  
......
912 962

  
913 963
STEXI
914 964
@item set_link @var{name} [up|down]
965
@findex set_link
915 966
Set link @var{name} up or down.
916 967
ETEXI
917 968

  
......
925 976

  
926 977
STEXI
927 978
@item watchdog_action
979
@findex watchdog_action
928 980
Change watchdog action.
929 981
ETEXI
930 982

  
......
938 990

  
939 991
STEXI
940 992
@item acl_show @var{aclname}
993
@findex acl_show
941 994
List all the matching rules in the access control list, and the default
942 995
policy. There are currently two named access control lists,
943 996
@var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
......
954 1007

  
955 1008
STEXI
956 1009
@item acl_policy @var{aclname} @code{allow|deny}
1010
@findex acl_policy
957 1011
Set the default access control list policy, used in the event that
958 1012
none of the explicit rules match. The default policy at startup is
959 1013
always @code{deny}.
......
969 1023

  
970 1024
STEXI
971 1025
@item acl_allow @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1026
@findex acl_allow
972 1027
Add a match rule to the access control list, allowing or denying access.
973 1028
The match will normally be an exact username or x509 distinguished name,
974 1029
but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
......
987 1042

  
988 1043
STEXI
989 1044
@item acl_remove @var{aclname} @var{match}
1045
@findex acl_remove
990 1046
Remove the specified match rule from the access control list.
991 1047
ETEXI
992 1048

  
......
999 1055
    },
1000 1056

  
1001 1057
STEXI
1002
@item acl_remove @var{aclname} @var{match}
1058
@item acl_remove @var{aclname}
1003 1059
Remove all matches from the access control list, and set the default
1004 1060
policy back to @code{deny}.
1005 1061
ETEXI
......
1017 1073
#endif
1018 1074
STEXI
1019 1075
@item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
1076
@findex mce (x86)
1020 1077
Inject an MCE on the given CPU (x86 only).
1021 1078
ETEXI
1022 1079

  
......
1031 1088

  
1032 1089
STEXI
1033 1090
@item getfd @var{fdname}
1091
@findex getfd
1034 1092
If a file descriptor is passed alongside this command using the SCM_RIGHTS
1035 1093
mechanism on unix sockets, it is stored using the name @var{fdname} for
1036 1094
later use by other monitor commands.
......
1047 1105

  
1048 1106
STEXI
1049 1107
@item closefd @var{fdname}
1108
@findex closefd
1050 1109
Close the file descriptor previously assigned to @var{fdname} using the
1051 1110
@code{getfd} command. This is only needed if the file descriptor was never
1052 1111
used by another monitor command.
......
1063 1122

  
1064 1123
STEXI
1065 1124
@item block_passwd @var{device} @var{password}
1125
@findex block_passwd
1066 1126
Set the encrypted device @var{device} password to @var{password}
1067 1127
ETEXI
1068 1128

  

Also available in: Unified diff