Remove double error message in qemu_option_set()
[qemu.git] / qemu-monitor.hx
blob784d30e9c9ba8998a079403eef97761fa09c9579
1 HXCOMM Use DEFHEADING() to define headings in both help text and texi
2 HXCOMM Text between STEXI and ETEXI are copied to texi version and
3 HXCOMM discarded from C version
4 HXCOMM DEF(command, args, callback, arg_string, help) is used to construct
5 HXCOMM monitor commands
6 HXCOMM HXCOMM can be used for comments, discarded from both texi and C
8 STEXI
9 @table @option
10 ETEXI
12 { "help|?", "name:s?", do_help_cmd, "[cmd]", "show the help" },
13 STEXI
14 @item help or ? [@var{cmd}]
15 Show the help for all commands or just for command @var{cmd}.
16 ETEXI
18 { "commit", "device:B", do_commit,
19 "device|all", "commit changes to the disk images (if -snapshot is used) or backing files" },
20 STEXI
21 @item commit
22 Commit changes to the disk images (if -snapshot is used) or backing files.
23 ETEXI
25 { "info", "item:s?", do_info,
26 "[subcommand]", "show various information about the system state" },
27 STEXI
28 @item info @var{subcommand}
29 Show various information about the system state.
31 @table @option
32 @item info version
33 show the version of QEMU
34 @item info network
35 show the various VLANs and the associated devices
36 @item info chardev
37 show the character devices
38 @item info block
39 show the block devices
40 @item info block
41 show block device statistics
42 @item info registers
43 show the cpu registers
44 @item info cpus
45 show infos for each CPU
46 @item info history
47 show the command line history
48 @item info irq
49 show the interrupts statistics (if available)
50 @item info pic
51 show i8259 (PIC) state
52 @item info pci
53 show emulated PCI device info
54 @item info tlb
55 show virtual to physical memory mappings (i386 only)
56 @item info mem
57 show the active virtual memory mappings (i386 only)
58 @item info hpet
59 show state of HPET (i386 only)
60 @item info kvm
61 show KVM information
62 @item info usb
63 show USB devices plugged on the virtual USB hub
64 @item info usbhost
65 show all USB host devices
66 @item info profile
67 show profiling information
68 @item info capture
69 show information about active capturing
70 @item info snapshots
71 show list of VM snapshots
72 @item info status
73 show the current VM status (running|paused)
74 @item info pcmcia
75 show guest PCMCIA status
76 @item info mice
77 show which guest mouse is receiving events
78 @item info vnc
79 show the vnc server status
80 @item info name
81 show the current VM name
82 @item info uuid
83 show the current VM UUID
84 @item info cpustats
85 show CPU statistics
86 @item info usernet
87 show user network stack connection states
88 @item info migrate
89 show migration status
90 @item info balloon
91 show balloon information
92 @item info qtree
93 show device tree
94 @end table
95 ETEXI
97 { "q|quit", "", do_quit,
98 "", "quit the emulator" },
99 STEXI
100 @item q or quit
101 Quit the emulator.
102 ETEXI
104 { "eject", "force:-f,filename:B", do_eject,
105 "[-f] device", "eject a removable medium (use -f to force it)" },
106 STEXI
107 @item eject [-f] @var{device}
108 Eject a removable medium (use -f to force it).
109 ETEXI
111 { "change", "device:B,target:F,arg:s?", do_change,
112 "device filename [format]", "change a removable medium, optional format" },
113 STEXI
114 @item change @var{device} @var{setting}
116 Change the configuration of a device.
118 @table @option
119 @item change @var{diskdevice} @var{filename} [@var{format}]
120 Change the medium for a removable disk device to point to @var{filename}. eg
122 @example
123 (qemu) change ide1-cd0 /path/to/some.iso
124 @end example
126 @var{format} is optional.
128 @item change vnc @var{display},@var{options}
129 Change the configuration of the VNC server. The valid syntax for @var{display}
130 and @var{options} are described at @ref{sec_invocation}. eg
132 @example
133 (qemu) change vnc localhost:1
134 @end example
136 @item change vnc password [@var{password}]
138 Change the password associated with the VNC server. If the new password is not
139 supplied, the monitor will prompt for it to be entered. VNC passwords are only
140 significant up to 8 letters. eg
142 @example
143 (qemu) change vnc password
144 Password: ********
145 @end example
147 @end table
148 ETEXI
150 { "screendump", "filename:F", do_screen_dump,
151 "filename", "save screen into PPM image 'filename'" },
152 STEXI
153 @item screendump @var{filename}
154 Save screen into PPM image @var{filename}.
155 ETEXI
157 { "logfile", "filename:F", do_logfile,
158 "filename", "output logs to 'filename'" },
159 STEXI
160 @item logfile @var{filename}
161 Output logs to @var{filename}.
162 ETEXI
164 { "log", "items:s", do_log,
165 "item1[,...]", "activate logging of the specified items to '/tmp/qemu.log'" },
166 STEXI
167 @item log @var{item1}[,...]
168 Activate logging of the specified items to @file{/tmp/qemu.log}.
169 ETEXI
171 { "savevm", "name:s?", do_savevm,
172 "[tag|id]", "save a VM snapshot. If no tag or id are provided, a new snapshot is created" },
173 STEXI
174 @item savevm [@var{tag}|@var{id}]
175 Create a snapshot of the whole virtual machine. If @var{tag} is
176 provided, it is used as human readable identifier. If there is already
177 a snapshot with the same tag or ID, it is replaced. More info at
178 @ref{vm_snapshots}.
179 ETEXI
181 { "loadvm", "name:s", do_loadvm,
182 "tag|id", "restore a VM snapshot from its tag or id" },
183 STEXI
184 @item loadvm @var{tag}|@var{id}
185 Set the whole virtual machine to the snapshot identified by the tag
186 @var{tag} or the unique snapshot ID @var{id}.
187 ETEXI
189 { "delvm", "name:s", do_delvm,
190 "tag|id", "delete a VM snapshot from its tag or id" },
191 STEXI
192 @item delvm @var{tag}|@var{id}
193 Delete the snapshot identified by @var{tag} or @var{id}.
194 ETEXI
196 { "singlestep", "option:s?", do_singlestep,
197 "[on|off]", "run emulation in singlestep mode or switch to normal mode", },
198 STEXI
199 @item singlestep [off]
200 Run the emulation in single step mode.
201 If called with option off, the emulation returns to normal mode.
202 ETEXI
204 { "stop", "", do_stop,
205 "", "stop emulation", },
206 STEXI
207 @item stop
208 Stop emulation.
209 ETEXI
211 { "c|cont", "", do_cont,
212 "", "resume emulation", },
213 STEXI
214 @item c or cont
215 Resume emulation.
216 ETEXI
218 { "gdbserver", "device:s?", do_gdbserver,
219 "[device]", "start gdbserver on given device (default 'tcp::1234'), stop with 'none'", },
220 STEXI
221 @item gdbserver [@var{port}]
222 Start gdbserver session (default @var{port}=1234)
223 ETEXI
225 { "x", "fmt:/,addr:l", do_memory_dump,
226 "/fmt addr", "virtual memory dump starting at 'addr'", },
227 STEXI
228 @item x/fmt @var{addr}
229 Virtual memory dump starting at @var{addr}.
230 ETEXI
232 { "xp", "fmt:/,addr:l", do_physical_memory_dump,
233 "/fmt addr", "physical memory dump starting at 'addr'", },
234 STEXI
235 @item xp /@var{fmt} @var{addr}
236 Physical memory dump starting at @var{addr}.
238 @var{fmt} is a format which tells the command how to format the
239 data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
241 @table @var
242 @item count
243 is the number of items to be dumped.
245 @item format
246 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
247 c (char) or i (asm instruction).
249 @item size
250 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
251 @code{h} or @code{w} can be specified with the @code{i} format to
252 respectively select 16 or 32 bit code instruction size.
254 @end table
256 Examples:
257 @itemize
258 @item
259 Dump 10 instructions at the current instruction pointer:
260 @example
261 (qemu) x/10i $eip
262 0x90107063: ret
263 0x90107064: sti
264 0x90107065: lea 0x0(%esi,1),%esi
265 0x90107069: lea 0x0(%edi,1),%edi
266 0x90107070: ret
267 0x90107071: jmp 0x90107080
268 0x90107073: nop
269 0x90107074: nop
270 0x90107075: nop
271 0x90107076: nop
272 @end example
274 @item
275 Dump 80 16 bit values at the start of the video memory.
276 @smallexample
277 (qemu) xp/80hx 0xb8000
278 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
279 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
280 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
281 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
282 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
283 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
284 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
285 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
286 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
287 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
288 @end smallexample
289 @end itemize
290 ETEXI
292 { "p|print", "fmt:/,val:l", do_print,
293 "/fmt expr", "print expression value (use $reg for CPU register access)", },
294 STEXI
295 @item p or print/@var{fmt} @var{expr}
297 Print expression value. Only the @var{format} part of @var{fmt} is
298 used.
299 ETEXI
301 { "i", "fmt:/,addr:i,index:i.", do_ioport_read,
302 "/fmt addr", "I/O port read" },
303 STEXI
304 Read I/O port.
305 ETEXI
307 { "o", "fmt:/,addr:i,val:i", do_ioport_write,
308 "/fmt addr value", "I/O port write" },
309 STEXI
310 Write to I/O port.
311 ETEXI
313 { "sendkey", "string:s,hold_time:i?", do_sendkey,
314 "keys [hold_ms]", "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)" },
315 STEXI
316 @item sendkey @var{keys}
318 Send @var{keys} to the emulator. @var{keys} could be the name of the
319 key or @code{#} followed by the raw value in either decimal or hexadecimal
320 format. Use @code{-} to press several keys simultaneously. Example:
321 @example
322 sendkey ctrl-alt-f1
323 @end example
325 This command is useful to send keys that your graphical user interface
326 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
327 ETEXI
329 { "system_reset", "", do_system_reset,
330 "", "reset the system" },
331 STEXI
332 @item system_reset
334 Reset the system.
335 ETEXI
337 { "system_powerdown", "", do_system_powerdown,
338 "", "send system power down event" },
339 STEXI
340 @item system_powerdown
342 Power down the system (if supported).
343 ETEXI
345 { "sum", "start:i,size:i", do_sum,
346 "addr size", "compute the checksum of a memory region" },
347 STEXI
348 @item sum @var{addr} @var{size}
350 Compute the checksum of a memory region.
351 ETEXI
353 { "usb_add", "devname:s", do_usb_add,
354 "device", "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')" },
355 STEXI
356 @item usb_add @var{devname}
358 Add the USB device @var{devname}. For details of available devices see
359 @ref{usb_devices}
360 ETEXI
362 { "usb_del", "devname:s", do_usb_del,
363 "device", "remove USB device 'bus.addr'" },
364 STEXI
365 @item usb_del @var{devname}
367 Remove the USB device @var{devname} from the QEMU virtual USB
368 hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
369 command @code{info usb} to see the devices you can remove.
370 ETEXI
372 { "device_add", "config:s", do_device_add,
373 "device", "add device, like -device on the command line" },
374 STEXI
375 @item device_add @var{config}
377 Add device.
378 ETEXI
380 { "device_del", "id:s", do_device_del,
381 "device", "remove device" },
382 STEXI
383 @item device_del @var{id}
385 Remove device @var{id}.
386 ETEXI
388 { "cpu", "index:i", do_cpu_set, "index", "set the default CPU" },
390 STEXI
391 Set the default CPU.
392 ETEXI
394 { "mouse_move", "dx_str:s,dy_str:s,dz_str:s?", do_mouse_move,
395 "dx dy [dz]", "send mouse move events" },
396 STEXI
397 @item mouse_move @var{dx} @var{dy} [@var{dz}]
398 Move the active mouse to the specified coordinates @var{dx} @var{dy}
399 with optional scroll axis @var{dz}.
400 ETEXI
402 { "mouse_button", "button_state:i", do_mouse_button,
403 "state", "change mouse button state (1=L, 2=M, 4=R)" },
404 STEXI
405 @item mouse_button @var{val}
406 Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
407 ETEXI
409 { "mouse_set", "index:i", do_mouse_set,
410 "index", "set which mouse device receives events" },
411 STEXI
412 @item mouse_set @var{index}
413 Set which mouse device receives events at given @var{index}, index
414 can be obtained with
415 @example
416 info mice
417 @end example
418 ETEXI
420 #ifdef HAS_AUDIO
421 { "wavcapture", "path:F,freq:i?,bits:i?,nchannels:i?", do_wav_capture,
422 "path [frequency [bits [channels]]]",
423 "capture audio to a wave file (default frequency=44100 bits=16 channels=2)" },
424 #endif
425 STEXI
426 @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
427 Capture audio into @var{filename}. Using sample rate @var{frequency}
428 bits per sample @var{bits} and number of channels @var{channels}.
430 Defaults:
431 @itemize @minus
432 @item Sample rate = 44100 Hz - CD quality
433 @item Bits = 16
434 @item Number of channels = 2 - Stereo
435 @end itemize
436 ETEXI
438 #ifdef HAS_AUDIO
439 { "stopcapture", "n:i", do_stop_capture,
440 "capture index", "stop capture" },
441 #endif
442 STEXI
443 @item stopcapture @var{index}
444 Stop capture with a given @var{index}, index can be obtained with
445 @example
446 info capture
447 @end example
448 ETEXI
450 { "memsave", "val:l,size:i,filename:s", do_memory_save,
451 "addr size file", "save to disk virtual memory dump starting at 'addr' of size 'size'", },
452 STEXI
453 @item memsave @var{addr} @var{size} @var{file}
454 save to disk virtual memory dump starting at @var{addr} of size @var{size}.
455 ETEXI
457 { "pmemsave", "val:l,size:i,filename:s", do_physical_memory_save,
458 "addr size file", "save to disk physical memory dump starting at 'addr' of size 'size'", },
459 STEXI
460 @item pmemsave @var{addr} @var{size} @var{file}
461 save to disk physical memory dump starting at @var{addr} of size @var{size}.
462 ETEXI
464 { "boot_set", "bootdevice:s", do_boot_set,
465 "bootdevice", "define new values for the boot device list" },
466 STEXI
467 @item boot_set @var{bootdevicelist}
469 Define new values for the boot device list. Those values will override
470 the values specified on the command line through the @code{-boot} option.
472 The values that can be specified here depend on the machine type, but are
473 the same that can be specified in the @code{-boot} command line option.
474 ETEXI
476 #if defined(TARGET_I386)
477 { "nmi", "cpu_index:i", do_inject_nmi,
478 "cpu", "inject an NMI on the given CPU", },
479 #endif
480 STEXI
481 @item nmi @var{cpu}
482 Inject an NMI on the given CPU (x86 only).
483 ETEXI
485 { "migrate", "detach:-d,uri:s", do_migrate,
486 "[-d] uri", "migrate to URI (using -d to not wait for completion)" },
487 STEXI
488 @item migrate [-d] @var{uri}
489 Migrate to @var{uri} (using -d to not wait for completion).
490 ETEXI
492 { "migrate_cancel", "", do_migrate_cancel,
493 "", "cancel the current VM migration" },
494 STEXI
495 @item migrate_cancel
496 Cancel the current VM migration.
497 ETEXI
499 { "migrate_set_speed", "value:s", do_migrate_set_speed,
500 "value", "set maximum speed (in bytes) for migrations" },
501 STEXI
502 @item migrate_set_speed @var{value}
503 Set maximum speed to @var{value} (in bytes) for migrations.
504 ETEXI
506 { "migrate_set_downtime", "value:s", do_migrate_set_downtime,
507 "value", "set maximum tolerated downtime (in seconds) for migrations" },
509 STEXI
510 @item migrate_set_downtime @var{second}
511 Set maximum tolerated downtime (in seconds) for migration.
512 ETEXI
514 #if defined(TARGET_I386)
515 { "drive_add", "pci_addr:s,opts:s", drive_hot_add,
516 "[[<domain>:]<bus>:]<slot>\n"
517 "[file=file][,if=type][,bus=n]\n"
518 "[,unit=m][,media=d][index=i]\n"
519 "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
520 "[snapshot=on|off][,cache=on|off]",
521 "add drive to PCI storage controller" },
522 #endif
523 STEXI
524 @item drive_add
525 Add drive to PCI storage controller.
526 ETEXI
528 #if defined(TARGET_I386)
529 { "pci_add", "pci_addr:s,type:s,opts:s?", pci_device_hot_add, "auto|[[<domain>:]<bus>:]<slot> nic|storage [[vlan=n][,macaddr=addr][,model=type]] [file=file][,if=type][,bus=nr]...", "hot-add PCI device" },
530 #endif
531 STEXI
532 @item pci_add
533 Hot-add PCI device.
534 ETEXI
536 #if defined(TARGET_I386)
537 { "pci_del", "pci_addr:s", do_pci_device_hot_remove, "[[<domain>:]<bus>:]<slot>", "hot remove PCI device" },
538 #endif
539 STEXI
540 @item pci_del
541 Hot remove PCI device.
542 ETEXI
544 { "host_net_add", "device:s,opts:s?", net_host_device_add,
545 "tap|user|socket|vde|dump [options]", "add host VLAN client" },
546 STEXI
547 @item host_net_add
548 Add host VLAN client.
549 ETEXI
551 { "host_net_remove", "vlan_id:i,device:s", net_host_device_remove,
552 "vlan_id name", "remove host VLAN client" },
553 STEXI
554 @item host_net_remove
555 Remove host VLAN client.
556 ETEXI
558 #ifdef CONFIG_SLIRP
559 { "hostfwd_add", "arg1:s,arg2:s?,arg3:s?", net_slirp_hostfwd_add,
560 "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
561 "redirect TCP or UDP connections from host to guest (requires -net user)" },
562 { "hostfwd_remove", "arg1:s,arg2:s?,arg3:s?", net_slirp_hostfwd_remove,
563 "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
564 "remove host-to-guest TCP or UDP redirection" },
565 #endif
566 STEXI
567 @item host_net_redir
568 Redirect TCP or UDP connections from host to guest (requires -net user).
569 ETEXI
571 { "balloon", "value:i", do_balloon,
572 "target", "request VM to change it's memory allocation (in MB)" },
573 STEXI
574 @item balloon @var{value}
575 Request VM to change its memory allocation to @var{value} (in MB).
576 ETEXI
578 { "set_link", "name:s,up_or_down:s", do_set_link,
579 "name up|down", "change the link status of a network adapter" },
580 STEXI
581 @item set_link @var{name} [up|down]
582 Set link @var{name} up or down.
583 ETEXI
585 { "watchdog_action", "action:s", do_watchdog_action,
586 "[reset|shutdown|poweroff|pause|debug|none]", "change watchdog action" },
587 STEXI
588 @item watchdog_action
589 Change watchdog action.
590 ETEXI
592 { "acl_show", "aclname:s", do_acl_show, "aclname",
593 "list rules in the access control list" },
594 STEXI
595 @item acl_show @var{aclname}
596 List all the matching rules in the access control list, and the default
597 policy. There are currently two named access control lists,
598 @var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
599 certificate distinguished name, and SASL username respectively.
600 ETEXI
602 { "acl_policy", "aclname:s,policy:s", do_acl_policy, "aclname allow|deny",
603 "set default access control list policy" },
604 STEXI
605 @item acl_policy @var{aclname} @code{allow|deny}
606 Set the default access control list policy, used in the event that
607 none of the explicit rules match. The default policy at startup is
608 always @code{deny}.
609 ETEXI
611 { "acl_add", "aclname:s,match:s,policy:s,index:i?", do_acl_add, "aclname match allow|deny [index]",
612 "add a match rule to the access control list" },
613 STEXI
614 @item acl_allow @var{aclname} @var{match} @code{allow|deny} [@var{index}]
615 Add a match rule to the access control list, allowing or denying access.
616 The match will normally be an exact username or x509 distinguished name,
617 but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
618 allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
619 normally be appended to the end of the ACL, but can be inserted
620 earlier in the list if the optional @var{index} parameter is supplied.
621 ETEXI
623 { "acl_remove", "aclname:s,match:s", do_acl_remove, "aclname match",
624 "remove a match rule from the access control list" },
625 STEXI
626 @item acl_remove @var{aclname} @var{match}
627 Remove the specified match rule from the access control list.
628 ETEXI
630 { "acl_reset", "aclname:s", do_acl_reset, "aclname",
631 "reset the access control list" },
632 STEXI
633 @item acl_remove @var{aclname} @var{match}
634 Remove all matches from the access control list, and set the default
635 policy back to @code{deny}.
636 ETEXI
638 #if defined(TARGET_I386)
639 { "mce", "cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l", do_inject_mce, "cpu bank status mcgstatus addr misc", "inject a MCE on the given CPU"},
640 #endif
641 STEXI
642 @item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
643 Inject an MCE on the given CPU (x86 only).
644 ETEXI
646 { "getfd", "fdname:s", do_getfd, "getfd name",
647 "receive a file descriptor via SCM rights and assign it a name" },
648 STEXI
649 @item getfd @var{fdname}
650 If a file descriptor is passed alongside this command using the SCM_RIGHTS
651 mechanism on unix sockets, it is stored using the name @var{fdname} for
652 later use by other monitor commands.
653 ETEXI
655 { "closefd", "fdname:s", do_closefd, "closefd name",
656 "close a file descriptor previously passed via SCM rights" },
657 STEXI
658 @item closefd @var{fdname}
659 Close the file descriptor previously assigned to @var{fdname} using the
660 @code{getfd} command. This is only needed if the file descriptor was never
661 used by another monitor command.
662 ETEXI
664 STEXI
665 @end table
666 ETEXI