blob: 3efc71698980120bddd0267d7996ecf0c2ed3890 [file] [log] [blame]
Blue Swirl23130862009-06-06 08:22:04 +00001HXCOMM Use DEFHEADING() to define headings in both help text and texi
2HXCOMM Text between STEXI and ETEXI are copied to texi version and
3HXCOMM discarded from C version
4HXCOMM DEF(command, args, callback, arg_string, help) is used to construct
5HXCOMM monitor commands
6HXCOMM HXCOMM can be used for comments, discarded from both texi and C
7
8STEXI
9@table @option
10ETEXI
11
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030012 {
13 .name = "help|?",
14 .args_type = "name:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030015 .params = "[cmd]",
16 .help = "show the help",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -030017 .mhandler.cmd = do_help_cmd,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030018 },
19
Blue Swirl23130862009-06-06 08:22:04 +000020STEXI
21@item help or ? [@var{cmd}]
22Show the help for all commands or just for command @var{cmd}.
23ETEXI
24
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030025 {
26 .name = "commit",
27 .args_type = "device:B",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030028 .params = "device|all",
29 .help = "commit changes to the disk images (if -snapshot is used) or backing files",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -030030 .mhandler.cmd = do_commit,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030031 },
32
Blue Swirl23130862009-06-06 08:22:04 +000033STEXI
34@item commit
35Commit changes to the disk images (if -snapshot is used) or backing files.
36ETEXI
37
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030038 {
39 .name = "info",
40 .args_type = "item:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030041 .params = "[subcommand]",
42 .help = "show various information about the system state",
Luiz Capitulino13c74252009-10-07 13:41:55 -030043 .user_print = monitor_user_noop,
44 .mhandler.cmd_new = do_info,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030045 },
46
Blue Swirl23130862009-06-06 08:22:04 +000047STEXI
48@item info @var{subcommand}
49Show various information about the system state.
50
51@table @option
52@item info version
53show the version of QEMU
54@item info network
55show the various VLANs and the associated devices
56@item info chardev
57show the character devices
58@item info block
59show the block devices
60@item info block
61show block device statistics
62@item info registers
63show the cpu registers
64@item info cpus
65show infos for each CPU
66@item info history
67show the command line history
68@item info irq
69show the interrupts statistics (if available)
70@item info pic
71show i8259 (PIC) state
72@item info pci
73show emulated PCI device info
74@item info tlb
75show virtual to physical memory mappings (i386 only)
76@item info mem
77show the active virtual memory mappings (i386 only)
78@item info hpet
79show state of HPET (i386 only)
Blue Swirl23130862009-06-06 08:22:04 +000080@item info kvm
81show KVM information
82@item info usb
83show USB devices plugged on the virtual USB hub
84@item info usbhost
85show all USB host devices
86@item info profile
87show profiling information
88@item info capture
89show information about active capturing
90@item info snapshots
91show list of VM snapshots
92@item info status
93show the current VM status (running|paused)
94@item info pcmcia
95show guest PCMCIA status
96@item info mice
97show which guest mouse is receiving events
98@item info vnc
99show the vnc server status
100@item info name
101show the current VM name
102@item info uuid
103show the current VM UUID
104@item info cpustats
105show CPU statistics
Jan Kiszka6dbe5532009-06-24 14:42:29 +0200106@item info usernet
107show user network stack connection states
Blue Swirl23130862009-06-06 08:22:04 +0000108@item info migrate
109show migration status
110@item info balloon
111show balloon information
112@item info qtree
113show device tree
114@end table
115ETEXI
116
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300117 {
118 .name = "q|quit",
119 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300120 .params = "",
121 .help = "quit the emulator",
Luiz Capitulinob223f352009-10-07 13:41:56 -0300122 .user_print = monitor_user_noop,
123 .mhandler.cmd_new = do_quit,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300124 },
125
Blue Swirl23130862009-06-06 08:22:04 +0000126STEXI
127@item q or quit
128Quit the emulator.
129ETEXI
130
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300131 {
132 .name = "eject",
133 .args_type = "force:-f,filename:B",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300134 .params = "[-f] device",
135 .help = "eject a removable medium (use -f to force it)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300136 .mhandler.cmd = do_eject,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300137 },
138
Blue Swirl23130862009-06-06 08:22:04 +0000139STEXI
140@item eject [-f] @var{device}
141Eject a removable medium (use -f to force it).
142ETEXI
143
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300144 {
145 .name = "change",
146 .args_type = "device:B,target:F,arg:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300147 .params = "device filename [format]",
148 .help = "change a removable medium, optional format",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300149 .mhandler.cmd = do_change,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300150 },
151
Blue Swirl23130862009-06-06 08:22:04 +0000152STEXI
153@item change @var{device} @var{setting}
154
155Change the configuration of a device.
156
157@table @option
158@item change @var{diskdevice} @var{filename} [@var{format}]
159Change the medium for a removable disk device to point to @var{filename}. eg
160
161@example
162(qemu) change ide1-cd0 /path/to/some.iso
163@end example
164
165@var{format} is optional.
166
167@item change vnc @var{display},@var{options}
168Change the configuration of the VNC server. The valid syntax for @var{display}
169and @var{options} are described at @ref{sec_invocation}. eg
170
171@example
172(qemu) change vnc localhost:1
173@end example
174
175@item change vnc password [@var{password}]
176
177Change the password associated with the VNC server. If the new password is not
178supplied, the monitor will prompt for it to be entered. VNC passwords are only
179significant up to 8 letters. eg
180
181@example
182(qemu) change vnc password
183Password: ********
184@end example
185
186@end table
187ETEXI
188
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300189 {
190 .name = "screendump",
191 .args_type = "filename:F",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300192 .params = "filename",
193 .help = "save screen into PPM image 'filename'",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300194 .mhandler.cmd = do_screen_dump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300195 },
196
Blue Swirl23130862009-06-06 08:22:04 +0000197STEXI
198@item screendump @var{filename}
199Save screen into PPM image @var{filename}.
200ETEXI
201
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300202 {
203 .name = "logfile",
204 .args_type = "filename:F",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300205 .params = "filename",
206 .help = "output logs to 'filename'",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300207 .mhandler.cmd = do_logfile,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300208 },
209
Blue Swirl23130862009-06-06 08:22:04 +0000210STEXI
211@item logfile @var{filename}
212Output logs to @var{filename}.
213ETEXI
214
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300215 {
216 .name = "log",
217 .args_type = "items:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300218 .params = "item1[,...]",
219 .help = "activate logging of the specified items to '/tmp/qemu.log'",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300220 .mhandler.cmd = do_log,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300221 },
222
Blue Swirl23130862009-06-06 08:22:04 +0000223STEXI
224@item log @var{item1}[,...]
225Activate logging of the specified items to @file{/tmp/qemu.log}.
226ETEXI
227
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300228 {
229 .name = "savevm",
230 .args_type = "name:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300231 .params = "[tag|id]",
232 .help = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300233 .mhandler.cmd = do_savevm,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300234 },
235
Blue Swirl23130862009-06-06 08:22:04 +0000236STEXI
237@item savevm [@var{tag}|@var{id}]
238Create a snapshot of the whole virtual machine. If @var{tag} is
239provided, it is used as human readable identifier. If there is already
240a snapshot with the same tag or ID, it is replaced. More info at
241@ref{vm_snapshots}.
242ETEXI
243
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300244 {
245 .name = "loadvm",
246 .args_type = "name:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300247 .params = "tag|id",
248 .help = "restore a VM snapshot from its tag or id",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300249 .mhandler.cmd = do_loadvm,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300250 },
251
Blue Swirl23130862009-06-06 08:22:04 +0000252STEXI
253@item loadvm @var{tag}|@var{id}
254Set the whole virtual machine to the snapshot identified by the tag
255@var{tag} or the unique snapshot ID @var{id}.
256ETEXI
257
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300258 {
259 .name = "delvm",
260 .args_type = "name:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300261 .params = "tag|id",
262 .help = "delete a VM snapshot from its tag or id",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300263 .mhandler.cmd = do_delvm,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300264 },
265
Blue Swirl23130862009-06-06 08:22:04 +0000266STEXI
267@item delvm @var{tag}|@var{id}
268Delete the snapshot identified by @var{tag} or @var{id}.
269ETEXI
270
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300271 {
272 .name = "singlestep",
273 .args_type = "option:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300274 .params = "[on|off]",
275 .help = "run emulation in singlestep mode or switch to normal mode",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300276 .mhandler.cmd = do_singlestep,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300277 },
278
Blue Swirl23130862009-06-06 08:22:04 +0000279STEXI
280@item singlestep [off]
281Run the emulation in single step mode.
282If called with option off, the emulation returns to normal mode.
283ETEXI
284
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300285 {
286 .name = "stop",
287 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300288 .params = "",
289 .help = "stop emulation",
Luiz Capitulinoe0c97bd2009-10-07 13:41:57 -0300290 .user_print = monitor_user_noop,
291 .mhandler.cmd_new = do_stop,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300292 },
293
Blue Swirl23130862009-06-06 08:22:04 +0000294STEXI
295@item stop
296Stop emulation.
297ETEXI
298
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300299 {
300 .name = "c|cont",
301 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300302 .params = "",
303 .help = "resume emulation",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300304 .mhandler.cmd = do_cont,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300305 },
306
Blue Swirl23130862009-06-06 08:22:04 +0000307STEXI
308@item c or cont
309Resume emulation.
310ETEXI
311
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300312 {
313 .name = "gdbserver",
314 .args_type = "device:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300315 .params = "[device]",
316 .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300317 .mhandler.cmd = do_gdbserver,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300318 },
319
Blue Swirl23130862009-06-06 08:22:04 +0000320STEXI
321@item gdbserver [@var{port}]
322Start gdbserver session (default @var{port}=1234)
323ETEXI
324
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300325 {
326 .name = "x",
327 .args_type = "fmt:/,addr:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300328 .params = "/fmt addr",
329 .help = "virtual memory dump starting at 'addr'",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300330 .mhandler.cmd = do_memory_dump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300331 },
332
Blue Swirl23130862009-06-06 08:22:04 +0000333STEXI
334@item x/fmt @var{addr}
335Virtual memory dump starting at @var{addr}.
336ETEXI
337
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300338 {
339 .name = "xp",
340 .args_type = "fmt:/,addr:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300341 .params = "/fmt addr",
342 .help = "physical memory dump starting at 'addr'",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300343 .mhandler.cmd = do_physical_memory_dump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300344 },
345
Blue Swirl23130862009-06-06 08:22:04 +0000346STEXI
347@item xp /@var{fmt} @var{addr}
348Physical memory dump starting at @var{addr}.
349
350@var{fmt} is a format which tells the command how to format the
351data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
352
353@table @var
354@item count
355is the number of items to be dumped.
356
357@item format
358can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
359c (char) or i (asm instruction).
360
361@item size
362can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
363@code{h} or @code{w} can be specified with the @code{i} format to
364respectively select 16 or 32 bit code instruction size.
365
366@end table
367
368Examples:
369@itemize
370@item
371Dump 10 instructions at the current instruction pointer:
372@example
373(qemu) x/10i $eip
3740x90107063: ret
3750x90107064: sti
3760x90107065: lea 0x0(%esi,1),%esi
3770x90107069: lea 0x0(%edi,1),%edi
3780x90107070: ret
3790x90107071: jmp 0x90107080
3800x90107073: nop
3810x90107074: nop
3820x90107075: nop
3830x90107076: nop
384@end example
385
386@item
387Dump 80 16 bit values at the start of the video memory.
388@smallexample
389(qemu) xp/80hx 0xb8000
3900x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
3910x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
3920x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
3930x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
3940x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
3950x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
3960x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
3970x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
3980x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
3990x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
400@end smallexample
401@end itemize
402ETEXI
403
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300404 {
405 .name = "p|print",
406 .args_type = "fmt:/,val:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300407 .params = "/fmt expr",
408 .help = "print expression value (use $reg for CPU register access)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300409 .mhandler.cmd = do_print,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300410 },
411
Blue Swirl23130862009-06-06 08:22:04 +0000412STEXI
413@item p or print/@var{fmt} @var{expr}
414
415Print expression value. Only the @var{format} part of @var{fmt} is
416used.
417ETEXI
418
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300419 {
420 .name = "i",
421 .args_type = "fmt:/,addr:i,index:i.",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300422 .params = "/fmt addr",
423 .help = "I/O port read",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300424 .mhandler.cmd = do_ioport_read,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300425 },
426
Blue Swirl23130862009-06-06 08:22:04 +0000427STEXI
428Read I/O port.
429ETEXI
430
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300431 {
432 .name = "o",
433 .args_type = "fmt:/,addr:i,val:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300434 .params = "/fmt addr value",
435 .help = "I/O port write",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300436 .mhandler.cmd = do_ioport_write,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300437 },
438
Jan Kiszkaf1147842009-07-14 10:20:11 +0200439STEXI
440Write to I/O port.
441ETEXI
Blue Swirl23130862009-06-06 08:22:04 +0000442
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300443 {
444 .name = "sendkey",
445 .args_type = "string:s,hold_time:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300446 .params = "keys [hold_ms]",
447 .help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300448 .mhandler.cmd = do_sendkey,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300449 },
450
Blue Swirl23130862009-06-06 08:22:04 +0000451STEXI
452@item sendkey @var{keys}
453
454Send @var{keys} to the emulator. @var{keys} could be the name of the
455key or @code{#} followed by the raw value in either decimal or hexadecimal
456format. Use @code{-} to press several keys simultaneously. Example:
457@example
458sendkey ctrl-alt-f1
459@end example
460
461This command is useful to send keys that your graphical user interface
462intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
463ETEXI
464
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300465 {
466 .name = "system_reset",
467 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300468 .params = "",
469 .help = "reset the system",
Luiz Capitulinoc80d2592009-10-07 13:41:58 -0300470 .user_print = monitor_user_noop,
471 .mhandler.cmd_new = do_system_reset,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300472 },
473
Blue Swirl23130862009-06-06 08:22:04 +0000474STEXI
475@item system_reset
476
477Reset the system.
478ETEXI
479
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300480 {
481 .name = "system_powerdown",
482 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300483 .params = "",
484 .help = "send system power down event",
Luiz Capitulino43076662009-10-07 13:41:59 -0300485 .user_print = monitor_user_noop,
486 .mhandler.cmd_new = do_system_powerdown,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300487 },
488
Blue Swirl23130862009-06-06 08:22:04 +0000489STEXI
490@item system_powerdown
491
492Power down the system (if supported).
493ETEXI
494
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300495 {
496 .name = "sum",
497 .args_type = "start:i,size:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300498 .params = "addr size",
499 .help = "compute the checksum of a memory region",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300500 .mhandler.cmd = do_sum,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300501 },
502
Blue Swirl23130862009-06-06 08:22:04 +0000503STEXI
504@item sum @var{addr} @var{size}
505
506Compute the checksum of a memory region.
507ETEXI
508
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300509 {
510 .name = "usb_add",
511 .args_type = "devname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300512 .params = "device",
513 .help = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300514 .mhandler.cmd = do_usb_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300515 },
516
Blue Swirl23130862009-06-06 08:22:04 +0000517STEXI
518@item usb_add @var{devname}
519
520Add the USB device @var{devname}. For details of available devices see
521@ref{usb_devices}
522ETEXI
523
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300524 {
525 .name = "usb_del",
526 .args_type = "devname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300527 .params = "device",
528 .help = "remove USB device 'bus.addr'",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300529 .mhandler.cmd = do_usb_del,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300530 },
531
Blue Swirl23130862009-06-06 08:22:04 +0000532STEXI
533@item usb_del @var{devname}
534
535Remove the USB device @var{devname} from the QEMU virtual USB
536hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
537command @code{info usb} to see the devices you can remove.
538ETEXI
539
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300540 {
541 .name = "device_add",
542 .args_type = "config:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300543 .params = "device",
544 .help = "add device, like -device on the command line",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300545 .mhandler.cmd = do_device_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300546 },
547
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200548STEXI
549@item device_add @var{config}
550
551Add device.
552ETEXI
553
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300554 {
555 .name = "device_del",
556 .args_type = "id:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300557 .params = "device",
558 .help = "remove device",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300559 .mhandler.cmd = do_device_del,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300560 },
561
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200562STEXI
563@item device_del @var{id}
564
565Remove device @var{id}.
566ETEXI
567
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300568 {
569 .name = "cpu",
570 .args_type = "index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300571 .params = "index",
572 .help = "set the default CPU",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300573 .mhandler.cmd = do_cpu_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300574 },
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200575
Blue Swirl23130862009-06-06 08:22:04 +0000576STEXI
577Set the default CPU.
578ETEXI
579
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300580 {
581 .name = "mouse_move",
582 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300583 .params = "dx dy [dz]",
584 .help = "send mouse move events",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300585 .mhandler.cmd = do_mouse_move,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300586 },
587
Blue Swirl23130862009-06-06 08:22:04 +0000588STEXI
589@item mouse_move @var{dx} @var{dy} [@var{dz}]
590Move the active mouse to the specified coordinates @var{dx} @var{dy}
591with optional scroll axis @var{dz}.
592ETEXI
593
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300594 {
595 .name = "mouse_button",
596 .args_type = "button_state:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300597 .params = "state",
598 .help = "change mouse button state (1=L, 2=M, 4=R)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300599 .mhandler.cmd = do_mouse_button,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300600 },
601
Blue Swirl23130862009-06-06 08:22:04 +0000602STEXI
603@item mouse_button @var{val}
604Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
605ETEXI
606
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300607 {
608 .name = "mouse_set",
609 .args_type = "index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300610 .params = "index",
611 .help = "set which mouse device receives events",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300612 .mhandler.cmd = do_mouse_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300613 },
614
Blue Swirl23130862009-06-06 08:22:04 +0000615STEXI
616@item mouse_set @var{index}
617Set which mouse device receives events at given @var{index}, index
618can be obtained with
619@example
620info mice
621@end example
622ETEXI
623
624#ifdef HAS_AUDIO
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300625 {
626 .name = "wavcapture",
627 .args_type = "path:F,freq:i?,bits:i?,nchannels:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300628 .params = "path [frequency [bits [channels]]]",
629 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300630 .mhandler.cmd = do_wav_capture,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300631 },
Blue Swirl23130862009-06-06 08:22:04 +0000632#endif
633STEXI
634@item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
635Capture audio into @var{filename}. Using sample rate @var{frequency}
636bits per sample @var{bits} and number of channels @var{channels}.
637
638Defaults:
639@itemize @minus
640@item Sample rate = 44100 Hz - CD quality
641@item Bits = 16
642@item Number of channels = 2 - Stereo
643@end itemize
644ETEXI
645
646#ifdef HAS_AUDIO
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300647 {
648 .name = "stopcapture",
649 .args_type = "n:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300650 .params = "capture index",
651 .help = "stop capture",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300652 .mhandler.cmd = do_stop_capture,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300653 },
Blue Swirl23130862009-06-06 08:22:04 +0000654#endif
655STEXI
656@item stopcapture @var{index}
657Stop capture with a given @var{index}, index can be obtained with
658@example
659info capture
660@end example
661ETEXI
662
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300663 {
664 .name = "memsave",
665 .args_type = "val:l,size:i,filename:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300666 .params = "addr size file",
667 .help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300668 .mhandler.cmd = do_memory_save,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300669 },
670
Blue Swirl23130862009-06-06 08:22:04 +0000671STEXI
672@item memsave @var{addr} @var{size} @var{file}
673save to disk virtual memory dump starting at @var{addr} of size @var{size}.
674ETEXI
675
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300676 {
677 .name = "pmemsave",
678 .args_type = "val:l,size:i,filename:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300679 .params = "addr size file",
680 .help = "save to disk physical memory dump starting at 'addr' of size 'size'",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300681 .mhandler.cmd = do_physical_memory_save,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300682 },
683
Blue Swirl23130862009-06-06 08:22:04 +0000684STEXI
685@item pmemsave @var{addr} @var{size} @var{file}
686save to disk physical memory dump starting at @var{addr} of size @var{size}.
687ETEXI
688
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300689 {
690 .name = "boot_set",
691 .args_type = "bootdevice:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300692 .params = "bootdevice",
693 .help = "define new values for the boot device list",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300694 .mhandler.cmd = do_boot_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300695 },
696
Blue Swirl23130862009-06-06 08:22:04 +0000697STEXI
698@item boot_set @var{bootdevicelist}
699
700Define new values for the boot device list. Those values will override
701the values specified on the command line through the @code{-boot} option.
702
703The values that can be specified here depend on the machine type, but are
704the same that can be specified in the @code{-boot} command line option.
705ETEXI
706
707#if defined(TARGET_I386)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300708 {
709 .name = "nmi",
710 .args_type = "cpu_index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300711 .params = "cpu",
712 .help = "inject an NMI on the given CPU",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300713 .mhandler.cmd = do_inject_nmi,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300714 },
Blue Swirl23130862009-06-06 08:22:04 +0000715#endif
716STEXI
717@item nmi @var{cpu}
718Inject an NMI on the given CPU (x86 only).
719ETEXI
720
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300721 {
722 .name = "migrate",
723 .args_type = "detach:-d,uri:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300724 .params = "[-d] uri",
725 .help = "migrate to URI (using -d to not wait for completion)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300726 .mhandler.cmd = do_migrate,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300727 },
728
Blue Swirl23130862009-06-06 08:22:04 +0000729STEXI
730@item migrate [-d] @var{uri}
731Migrate to @var{uri} (using -d to not wait for completion).
732ETEXI
733
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300734 {
735 .name = "migrate_cancel",
736 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300737 .params = "",
738 .help = "cancel the current VM migration",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300739 .mhandler.cmd = do_migrate_cancel,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300740 },
741
Blue Swirl23130862009-06-06 08:22:04 +0000742STEXI
743@item migrate_cancel
744Cancel the current VM migration.
745ETEXI
746
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300747 {
748 .name = "migrate_set_speed",
749 .args_type = "value:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300750 .params = "value",
751 .help = "set maximum speed (in bytes) for migrations",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300752 .mhandler.cmd = do_migrate_set_speed,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300753 },
754
Blue Swirl23130862009-06-06 08:22:04 +0000755STEXI
756@item migrate_set_speed @var{value}
757Set maximum speed to @var{value} (in bytes) for migrations.
758ETEXI
759
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300760 {
761 .name = "migrate_set_downtime",
762 .args_type = "value:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300763 .params = "value",
764 .help = "set maximum tolerated downtime (in seconds) for migrations",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300765 .mhandler.cmd = do_migrate_set_downtime,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300766 },
Glauber Costa2ea42952009-05-28 15:22:58 -0400767
768STEXI
769@item migrate_set_downtime @var{second}
770Set maximum tolerated downtime (in seconds) for migration.
771ETEXI
772
Blue Swirl23130862009-06-06 08:22:04 +0000773#if defined(TARGET_I386)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300774 {
775 .name = "drive_add",
776 .args_type = "pci_addr:s,opts:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300777 .params = "[[<domain>:]<bus>:]<slot>\n"
778 "[file=file][,if=type][,bus=n]\n"
779 "[,unit=m][,media=d][index=i]\n"
780 "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
781 "[snapshot=on|off][,cache=on|off]",
782 .help = "add drive to PCI storage controller",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300783 .mhandler.cmd = drive_hot_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300784 },
Blue Swirl23130862009-06-06 08:22:04 +0000785#endif
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300786
Blue Swirl23130862009-06-06 08:22:04 +0000787STEXI
788@item drive_add
789Add drive to PCI storage controller.
790ETEXI
791
792#if defined(TARGET_I386)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300793 {
794 .name = "pci_add",
795 .args_type = "pci_addr:s,type:s,opts:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300796 .params = "auto|[[<domain>:]<bus>:]<slot> nic|storage [[vlan=n][,macaddr=addr][,model=type]] [file=file][,if=type][,bus=nr]...",
797 .help = "hot-add PCI device",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300798 .mhandler.cmd = pci_device_hot_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300799 },
Blue Swirl23130862009-06-06 08:22:04 +0000800#endif
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300801
Blue Swirl23130862009-06-06 08:22:04 +0000802STEXI
803@item pci_add
804Hot-add PCI device.
805ETEXI
806
807#if defined(TARGET_I386)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300808 {
809 .name = "pci_del",
810 .args_type = "pci_addr:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300811 .params = "[[<domain>:]<bus>:]<slot>",
812 .help = "hot remove PCI device",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300813 .mhandler.cmd = do_pci_device_hot_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300814 },
Blue Swirl23130862009-06-06 08:22:04 +0000815#endif
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300816
Blue Swirl23130862009-06-06 08:22:04 +0000817STEXI
818@item pci_del
819Hot remove PCI device.
820ETEXI
821
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300822 {
823 .name = "host_net_add",
824 .args_type = "device:s,opts:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300825 .params = "tap|user|socket|vde|dump [options]",
826 .help = "add host VLAN client",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300827 .mhandler.cmd = net_host_device_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300828 },
829
Blue Swirl23130862009-06-06 08:22:04 +0000830STEXI
831@item host_net_add
832Add host VLAN client.
833ETEXI
834
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300835 {
836 .name = "host_net_remove",
837 .args_type = "vlan_id:i,device:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300838 .params = "vlan_id name",
839 .help = "remove host VLAN client",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300840 .mhandler.cmd = net_host_device_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300841 },
842
Blue Swirl23130862009-06-06 08:22:04 +0000843STEXI
844@item host_net_remove
845Remove host VLAN client.
846ETEXI
847
848#ifdef CONFIG_SLIRP
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300849 {
850 .name = "hostfwd_add",
851 .args_type = "arg1:s,arg2:s?,arg3:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300852 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
853 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300854 .mhandler.cmd = net_slirp_hostfwd_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300855 },
856
857 {
858 .name = "hostfwd_remove",
859 .args_type = "arg1:s,arg2:s?,arg3:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300860 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
861 .help = "remove host-to-guest TCP or UDP redirection",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300862 .mhandler.cmd = net_slirp_hostfwd_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300863 },
864
Blue Swirl23130862009-06-06 08:22:04 +0000865#endif
866STEXI
867@item host_net_redir
868Redirect TCP or UDP connections from host to guest (requires -net user).
869ETEXI
870
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300871 {
872 .name = "balloon",
873 .args_type = "value:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300874 .params = "target",
875 .help = "request VM to change it's memory allocation (in MB)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300876 .mhandler.cmd = do_balloon,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300877 },
878
Blue Swirl23130862009-06-06 08:22:04 +0000879STEXI
880@item balloon @var{value}
881Request VM to change its memory allocation to @var{value} (in MB).
882ETEXI
883
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300884 {
885 .name = "set_link",
886 .args_type = "name:s,up_or_down:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300887 .params = "name up|down",
888 .help = "change the link status of a network adapter",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300889 .mhandler.cmd = do_set_link,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300890 },
891
Blue Swirl23130862009-06-06 08:22:04 +0000892STEXI
893@item set_link @var{name} [up|down]
894Set link @var{name} up or down.
895ETEXI
896
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300897 {
898 .name = "watchdog_action",
899 .args_type = "action:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300900 .params = "[reset|shutdown|poweroff|pause|debug|none]",
901 .help = "change watchdog action",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300902 .mhandler.cmd = do_watchdog_action,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300903 },
904
Blue Swirl23130862009-06-06 08:22:04 +0000905STEXI
906@item watchdog_action
907Change watchdog action.
908ETEXI
909
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300910 {
911 .name = "acl_show",
912 .args_type = "aclname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300913 .params = "aclname",
914 .help = "list rules in the access control list",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300915 .mhandler.cmd = do_acl_show,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300916 },
917
Blue Swirl23130862009-06-06 08:22:04 +0000918STEXI
Jan Kiszka15dfcd42009-06-25 08:22:08 +0200919@item acl_show @var{aclname}
920List all the matching rules in the access control list, and the default
921policy. There are currently two named access control lists,
922@var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
923certificate distinguished name, and SASL username respectively.
924ETEXI
Blue Swirl23130862009-06-06 08:22:04 +0000925
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300926 {
927 .name = "acl_policy",
928 .args_type = "aclname:s,policy:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300929 .params = "aclname allow|deny",
930 .help = "set default access control list policy",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300931 .mhandler.cmd = do_acl_policy,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300932 },
933
Jan Kiszka15dfcd42009-06-25 08:22:08 +0200934STEXI
Jan Kiszkacbbfacc2009-07-03 08:46:05 +0200935@item acl_policy @var{aclname} @code{allow|deny}
Jan Kiszka15dfcd42009-06-25 08:22:08 +0200936Set the default access control list policy, used in the event that
Blue Swirl23130862009-06-06 08:22:04 +0000937none of the explicit rules match. The default policy at startup is
Jan Kiszka15dfcd42009-06-25 08:22:08 +0200938always @code{deny}.
939ETEXI
940
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300941 {
942 .name = "acl_add",
943 .args_type = "aclname:s,match:s,policy:s,index:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300944 .params = "aclname match allow|deny [index]",
945 .help = "add a match rule to the access control list",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300946 .mhandler.cmd = do_acl_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300947 },
948
Jan Kiszka15dfcd42009-06-25 08:22:08 +0200949STEXI
950@item acl_allow @var{aclname} @var{match} @code{allow|deny} [@var{index}]
951Add a match rule to the access control list, allowing or denying access.
952The match will normally be an exact username or x509 distinguished name,
953but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
954allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
Blue Swirl23130862009-06-06 08:22:04 +0000955normally be appended to the end of the ACL, but can be inserted
Jan Kiszka15dfcd42009-06-25 08:22:08 +0200956earlier in the list if the optional @var{index} parameter is supplied.
957ETEXI
958
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300959 {
960 .name = "acl_remove",
961 .args_type = "aclname:s,match:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300962 .params = "aclname match",
963 .help = "remove a match rule from the access control list",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300964 .mhandler.cmd = do_acl_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300965 },
966
Jan Kiszka15dfcd42009-06-25 08:22:08 +0200967STEXI
968@item acl_remove @var{aclname} @var{match}
969Remove the specified match rule from the access control list.
970ETEXI
971
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300972 {
973 .name = "acl_reset",
974 .args_type = "aclname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300975 .params = "aclname",
976 .help = "reset the access control list",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300977 .mhandler.cmd = do_acl_reset,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300978 },
979
Jan Kiszka15dfcd42009-06-25 08:22:08 +0200980STEXI
981@item acl_remove @var{aclname} @var{match}
982Remove all matches from the access control list, and set the default
Blue Swirl23130862009-06-06 08:22:04 +0000983policy back to @code{deny}.
Blue Swirl23130862009-06-06 08:22:04 +0000984ETEXI
985
Huang Ying79c4f6b2009-06-23 10:05:14 +0800986#if defined(TARGET_I386)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300987
988 {
989 .name = "mce",
990 .args_type = "cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300991 .params = "cpu bank status mcgstatus addr misc",
992 .help = "inject a MCE on the given CPU",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300993 .mhandler.cmd = do_inject_mce,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300994 },
995
Huang Ying79c4f6b2009-06-23 10:05:14 +0800996#endif
997STEXI
998@item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
999Inject an MCE on the given CPU (x86 only).
1000ETEXI
1001
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001002 {
1003 .name = "getfd",
1004 .args_type = "fdname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001005 .params = "getfd name",
1006 .help = "receive a file descriptor via SCM rights and assign it a name",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001007 .mhandler.cmd = do_getfd,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001008 },
1009
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001010STEXI
1011@item getfd @var{fdname}
1012If a file descriptor is passed alongside this command using the SCM_RIGHTS
1013mechanism on unix sockets, it is stored using the name @var{fdname} for
1014later use by other monitor commands.
1015ETEXI
1016
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001017 {
1018 .name = "closefd",
1019 .args_type = "fdname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001020 .params = "closefd name",
1021 .help = "close a file descriptor previously passed via SCM rights",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001022 .mhandler.cmd = do_closefd,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001023 },
1024
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001025STEXI
1026@item closefd @var{fdname}
1027Close the file descriptor previously assigned to @var{fdname} using the
1028@code{getfd} command. This is only needed if the file descriptor was never
1029used by another monitor command.
1030ETEXI
1031
Blue Swirl23130862009-06-06 08:22:04 +00001032STEXI
1033@end table
1034ETEXI