blob: 51c76736b790d5693f31687fd0fe4e2f67b63669 [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 Capitulinoaf4ce882009-10-07 13:41:52 -0300290 .mhandler.cmd = do_stop,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300291 },
292
Blue Swirl23130862009-06-06 08:22:04 +0000293STEXI
294@item stop
295Stop emulation.
296ETEXI
297
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300298 {
299 .name = "c|cont",
300 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300301 .params = "",
302 .help = "resume emulation",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300303 .mhandler.cmd = do_cont,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300304 },
305
Blue Swirl23130862009-06-06 08:22:04 +0000306STEXI
307@item c or cont
308Resume emulation.
309ETEXI
310
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300311 {
312 .name = "gdbserver",
313 .args_type = "device:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300314 .params = "[device]",
315 .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300316 .mhandler.cmd = do_gdbserver,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300317 },
318
Blue Swirl23130862009-06-06 08:22:04 +0000319STEXI
320@item gdbserver [@var{port}]
321Start gdbserver session (default @var{port}=1234)
322ETEXI
323
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300324 {
325 .name = "x",
326 .args_type = "fmt:/,addr:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300327 .params = "/fmt addr",
328 .help = "virtual memory dump starting at 'addr'",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300329 .mhandler.cmd = do_memory_dump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300330 },
331
Blue Swirl23130862009-06-06 08:22:04 +0000332STEXI
333@item x/fmt @var{addr}
334Virtual memory dump starting at @var{addr}.
335ETEXI
336
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300337 {
338 .name = "xp",
339 .args_type = "fmt:/,addr:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300340 .params = "/fmt addr",
341 .help = "physical memory dump starting at 'addr'",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300342 .mhandler.cmd = do_physical_memory_dump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300343 },
344
Blue Swirl23130862009-06-06 08:22:04 +0000345STEXI
346@item xp /@var{fmt} @var{addr}
347Physical memory dump starting at @var{addr}.
348
349@var{fmt} is a format which tells the command how to format the
350data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
351
352@table @var
353@item count
354is the number of items to be dumped.
355
356@item format
357can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
358c (char) or i (asm instruction).
359
360@item size
361can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
362@code{h} or @code{w} can be specified with the @code{i} format to
363respectively select 16 or 32 bit code instruction size.
364
365@end table
366
367Examples:
368@itemize
369@item
370Dump 10 instructions at the current instruction pointer:
371@example
372(qemu) x/10i $eip
3730x90107063: ret
3740x90107064: sti
3750x90107065: lea 0x0(%esi,1),%esi
3760x90107069: lea 0x0(%edi,1),%edi
3770x90107070: ret
3780x90107071: jmp 0x90107080
3790x90107073: nop
3800x90107074: nop
3810x90107075: nop
3820x90107076: nop
383@end example
384
385@item
386Dump 80 16 bit values at the start of the video memory.
387@smallexample
388(qemu) xp/80hx 0xb8000
3890x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
3900x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
3910x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
3920x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
3930x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
3940x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
3950x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
3960x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
3970x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
3980x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
399@end smallexample
400@end itemize
401ETEXI
402
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300403 {
404 .name = "p|print",
405 .args_type = "fmt:/,val:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300406 .params = "/fmt expr",
407 .help = "print expression value (use $reg for CPU register access)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300408 .mhandler.cmd = do_print,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300409 },
410
Blue Swirl23130862009-06-06 08:22:04 +0000411STEXI
412@item p or print/@var{fmt} @var{expr}
413
414Print expression value. Only the @var{format} part of @var{fmt} is
415used.
416ETEXI
417
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300418 {
419 .name = "i",
420 .args_type = "fmt:/,addr:i,index:i.",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300421 .params = "/fmt addr",
422 .help = "I/O port read",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300423 .mhandler.cmd = do_ioport_read,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300424 },
425
Blue Swirl23130862009-06-06 08:22:04 +0000426STEXI
427Read I/O port.
428ETEXI
429
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300430 {
431 .name = "o",
432 .args_type = "fmt:/,addr:i,val:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300433 .params = "/fmt addr value",
434 .help = "I/O port write",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300435 .mhandler.cmd = do_ioport_write,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300436 },
437
Jan Kiszkaf1147842009-07-14 10:20:11 +0200438STEXI
439Write to I/O port.
440ETEXI
Blue Swirl23130862009-06-06 08:22:04 +0000441
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300442 {
443 .name = "sendkey",
444 .args_type = "string:s,hold_time:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300445 .params = "keys [hold_ms]",
446 .help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300447 .mhandler.cmd = do_sendkey,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300448 },
449
Blue Swirl23130862009-06-06 08:22:04 +0000450STEXI
451@item sendkey @var{keys}
452
453Send @var{keys} to the emulator. @var{keys} could be the name of the
454key or @code{#} followed by the raw value in either decimal or hexadecimal
455format. Use @code{-} to press several keys simultaneously. Example:
456@example
457sendkey ctrl-alt-f1
458@end example
459
460This command is useful to send keys that your graphical user interface
461intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
462ETEXI
463
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300464 {
465 .name = "system_reset",
466 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300467 .params = "",
468 .help = "reset the system",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300469 .mhandler.cmd = do_system_reset,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300470 },
471
Blue Swirl23130862009-06-06 08:22:04 +0000472STEXI
473@item system_reset
474
475Reset the system.
476ETEXI
477
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300478 {
479 .name = "system_powerdown",
480 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300481 .params = "",
482 .help = "send system power down event",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300483 .mhandler.cmd = do_system_powerdown,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300484 },
485
Blue Swirl23130862009-06-06 08:22:04 +0000486STEXI
487@item system_powerdown
488
489Power down the system (if supported).
490ETEXI
491
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300492 {
493 .name = "sum",
494 .args_type = "start:i,size:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300495 .params = "addr size",
496 .help = "compute the checksum of a memory region",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300497 .mhandler.cmd = do_sum,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300498 },
499
Blue Swirl23130862009-06-06 08:22:04 +0000500STEXI
501@item sum @var{addr} @var{size}
502
503Compute the checksum of a memory region.
504ETEXI
505
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300506 {
507 .name = "usb_add",
508 .args_type = "devname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300509 .params = "device",
510 .help = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300511 .mhandler.cmd = do_usb_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300512 },
513
Blue Swirl23130862009-06-06 08:22:04 +0000514STEXI
515@item usb_add @var{devname}
516
517Add the USB device @var{devname}. For details of available devices see
518@ref{usb_devices}
519ETEXI
520
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300521 {
522 .name = "usb_del",
523 .args_type = "devname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300524 .params = "device",
525 .help = "remove USB device 'bus.addr'",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300526 .mhandler.cmd = do_usb_del,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300527 },
528
Blue Swirl23130862009-06-06 08:22:04 +0000529STEXI
530@item usb_del @var{devname}
531
532Remove the USB device @var{devname} from the QEMU virtual USB
533hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
534command @code{info usb} to see the devices you can remove.
535ETEXI
536
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300537 {
538 .name = "device_add",
539 .args_type = "config:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300540 .params = "device",
541 .help = "add device, like -device on the command line",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300542 .mhandler.cmd = do_device_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300543 },
544
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200545STEXI
546@item device_add @var{config}
547
548Add device.
549ETEXI
550
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300551 {
552 .name = "device_del",
553 .args_type = "id:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300554 .params = "device",
555 .help = "remove device",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300556 .mhandler.cmd = do_device_del,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300557 },
558
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200559STEXI
560@item device_del @var{id}
561
562Remove device @var{id}.
563ETEXI
564
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300565 {
566 .name = "cpu",
567 .args_type = "index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300568 .params = "index",
569 .help = "set the default CPU",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300570 .mhandler.cmd = do_cpu_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300571 },
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200572
Blue Swirl23130862009-06-06 08:22:04 +0000573STEXI
574Set the default CPU.
575ETEXI
576
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300577 {
578 .name = "mouse_move",
579 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300580 .params = "dx dy [dz]",
581 .help = "send mouse move events",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300582 .mhandler.cmd = do_mouse_move,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300583 },
584
Blue Swirl23130862009-06-06 08:22:04 +0000585STEXI
586@item mouse_move @var{dx} @var{dy} [@var{dz}]
587Move the active mouse to the specified coordinates @var{dx} @var{dy}
588with optional scroll axis @var{dz}.
589ETEXI
590
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300591 {
592 .name = "mouse_button",
593 .args_type = "button_state:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300594 .params = "state",
595 .help = "change mouse button state (1=L, 2=M, 4=R)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300596 .mhandler.cmd = do_mouse_button,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300597 },
598
Blue Swirl23130862009-06-06 08:22:04 +0000599STEXI
600@item mouse_button @var{val}
601Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
602ETEXI
603
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300604 {
605 .name = "mouse_set",
606 .args_type = "index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300607 .params = "index",
608 .help = "set which mouse device receives events",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300609 .mhandler.cmd = do_mouse_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300610 },
611
Blue Swirl23130862009-06-06 08:22:04 +0000612STEXI
613@item mouse_set @var{index}
614Set which mouse device receives events at given @var{index}, index
615can be obtained with
616@example
617info mice
618@end example
619ETEXI
620
621#ifdef HAS_AUDIO
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300622 {
623 .name = "wavcapture",
624 .args_type = "path:F,freq:i?,bits:i?,nchannels:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300625 .params = "path [frequency [bits [channels]]]",
626 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300627 .mhandler.cmd = do_wav_capture,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300628 },
Blue Swirl23130862009-06-06 08:22:04 +0000629#endif
630STEXI
631@item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
632Capture audio into @var{filename}. Using sample rate @var{frequency}
633bits per sample @var{bits} and number of channels @var{channels}.
634
635Defaults:
636@itemize @minus
637@item Sample rate = 44100 Hz - CD quality
638@item Bits = 16
639@item Number of channels = 2 - Stereo
640@end itemize
641ETEXI
642
643#ifdef HAS_AUDIO
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300644 {
645 .name = "stopcapture",
646 .args_type = "n:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300647 .params = "capture index",
648 .help = "stop capture",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300649 .mhandler.cmd = do_stop_capture,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300650 },
Blue Swirl23130862009-06-06 08:22:04 +0000651#endif
652STEXI
653@item stopcapture @var{index}
654Stop capture with a given @var{index}, index can be obtained with
655@example
656info capture
657@end example
658ETEXI
659
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300660 {
661 .name = "memsave",
662 .args_type = "val:l,size:i,filename:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300663 .params = "addr size file",
664 .help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300665 .mhandler.cmd = do_memory_save,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300666 },
667
Blue Swirl23130862009-06-06 08:22:04 +0000668STEXI
669@item memsave @var{addr} @var{size} @var{file}
670save to disk virtual memory dump starting at @var{addr} of size @var{size}.
671ETEXI
672
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300673 {
674 .name = "pmemsave",
675 .args_type = "val:l,size:i,filename:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300676 .params = "addr size file",
677 .help = "save to disk physical memory dump starting at 'addr' of size 'size'",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300678 .mhandler.cmd = do_physical_memory_save,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300679 },
680
Blue Swirl23130862009-06-06 08:22:04 +0000681STEXI
682@item pmemsave @var{addr} @var{size} @var{file}
683save to disk physical memory dump starting at @var{addr} of size @var{size}.
684ETEXI
685
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300686 {
687 .name = "boot_set",
688 .args_type = "bootdevice:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300689 .params = "bootdevice",
690 .help = "define new values for the boot device list",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300691 .mhandler.cmd = do_boot_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300692 },
693
Blue Swirl23130862009-06-06 08:22:04 +0000694STEXI
695@item boot_set @var{bootdevicelist}
696
697Define new values for the boot device list. Those values will override
698the values specified on the command line through the @code{-boot} option.
699
700The values that can be specified here depend on the machine type, but are
701the same that can be specified in the @code{-boot} command line option.
702ETEXI
703
704#if defined(TARGET_I386)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300705 {
706 .name = "nmi",
707 .args_type = "cpu_index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300708 .params = "cpu",
709 .help = "inject an NMI on the given CPU",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300710 .mhandler.cmd = do_inject_nmi,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300711 },
Blue Swirl23130862009-06-06 08:22:04 +0000712#endif
713STEXI
714@item nmi @var{cpu}
715Inject an NMI on the given CPU (x86 only).
716ETEXI
717
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300718 {
719 .name = "migrate",
720 .args_type = "detach:-d,uri:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300721 .params = "[-d] uri",
722 .help = "migrate to URI (using -d to not wait for completion)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300723 .mhandler.cmd = do_migrate,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300724 },
725
Blue Swirl23130862009-06-06 08:22:04 +0000726STEXI
727@item migrate [-d] @var{uri}
728Migrate to @var{uri} (using -d to not wait for completion).
729ETEXI
730
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300731 {
732 .name = "migrate_cancel",
733 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300734 .params = "",
735 .help = "cancel the current VM migration",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300736 .mhandler.cmd = do_migrate_cancel,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300737 },
738
Blue Swirl23130862009-06-06 08:22:04 +0000739STEXI
740@item migrate_cancel
741Cancel the current VM migration.
742ETEXI
743
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300744 {
745 .name = "migrate_set_speed",
746 .args_type = "value:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300747 .params = "value",
748 .help = "set maximum speed (in bytes) for migrations",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300749 .mhandler.cmd = do_migrate_set_speed,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300750 },
751
Blue Swirl23130862009-06-06 08:22:04 +0000752STEXI
753@item migrate_set_speed @var{value}
754Set maximum speed to @var{value} (in bytes) for migrations.
755ETEXI
756
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300757 {
758 .name = "migrate_set_downtime",
759 .args_type = "value:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300760 .params = "value",
761 .help = "set maximum tolerated downtime (in seconds) for migrations",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300762 .mhandler.cmd = do_migrate_set_downtime,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300763 },
Glauber Costa2ea42952009-05-28 15:22:58 -0400764
765STEXI
766@item migrate_set_downtime @var{second}
767Set maximum tolerated downtime (in seconds) for migration.
768ETEXI
769
Blue Swirl23130862009-06-06 08:22:04 +0000770#if defined(TARGET_I386)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300771 {
772 .name = "drive_add",
773 .args_type = "pci_addr:s,opts:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300774 .params = "[[<domain>:]<bus>:]<slot>\n"
775 "[file=file][,if=type][,bus=n]\n"
776 "[,unit=m][,media=d][index=i]\n"
777 "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
778 "[snapshot=on|off][,cache=on|off]",
779 .help = "add drive to PCI storage controller",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300780 .mhandler.cmd = drive_hot_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300781 },
Blue Swirl23130862009-06-06 08:22:04 +0000782#endif
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300783
Blue Swirl23130862009-06-06 08:22:04 +0000784STEXI
785@item drive_add
786Add drive to PCI storage controller.
787ETEXI
788
789#if defined(TARGET_I386)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300790 {
791 .name = "pci_add",
792 .args_type = "pci_addr:s,type:s,opts:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300793 .params = "auto|[[<domain>:]<bus>:]<slot> nic|storage [[vlan=n][,macaddr=addr][,model=type]] [file=file][,if=type][,bus=nr]...",
794 .help = "hot-add PCI device",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300795 .mhandler.cmd = pci_device_hot_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300796 },
Blue Swirl23130862009-06-06 08:22:04 +0000797#endif
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300798
Blue Swirl23130862009-06-06 08:22:04 +0000799STEXI
800@item pci_add
801Hot-add PCI device.
802ETEXI
803
804#if defined(TARGET_I386)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300805 {
806 .name = "pci_del",
807 .args_type = "pci_addr:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300808 .params = "[[<domain>:]<bus>:]<slot>",
809 .help = "hot remove PCI device",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300810 .mhandler.cmd = do_pci_device_hot_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300811 },
Blue Swirl23130862009-06-06 08:22:04 +0000812#endif
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300813
Blue Swirl23130862009-06-06 08:22:04 +0000814STEXI
815@item pci_del
816Hot remove PCI device.
817ETEXI
818
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300819 {
820 .name = "host_net_add",
821 .args_type = "device:s,opts:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300822 .params = "tap|user|socket|vde|dump [options]",
823 .help = "add host VLAN client",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300824 .mhandler.cmd = net_host_device_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300825 },
826
Blue Swirl23130862009-06-06 08:22:04 +0000827STEXI
828@item host_net_add
829Add host VLAN client.
830ETEXI
831
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300832 {
833 .name = "host_net_remove",
834 .args_type = "vlan_id:i,device:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300835 .params = "vlan_id name",
836 .help = "remove host VLAN client",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300837 .mhandler.cmd = net_host_device_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300838 },
839
Blue Swirl23130862009-06-06 08:22:04 +0000840STEXI
841@item host_net_remove
842Remove host VLAN client.
843ETEXI
844
845#ifdef CONFIG_SLIRP
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300846 {
847 .name = "hostfwd_add",
848 .args_type = "arg1:s,arg2:s?,arg3:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300849 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
850 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300851 .mhandler.cmd = net_slirp_hostfwd_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300852 },
853
854 {
855 .name = "hostfwd_remove",
856 .args_type = "arg1:s,arg2:s?,arg3:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300857 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
858 .help = "remove host-to-guest TCP or UDP redirection",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300859 .mhandler.cmd = net_slirp_hostfwd_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300860 },
861
Blue Swirl23130862009-06-06 08:22:04 +0000862#endif
863STEXI
864@item host_net_redir
865Redirect TCP or UDP connections from host to guest (requires -net user).
866ETEXI
867
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300868 {
869 .name = "balloon",
870 .args_type = "value:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300871 .params = "target",
872 .help = "request VM to change it's memory allocation (in MB)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300873 .mhandler.cmd = do_balloon,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300874 },
875
Blue Swirl23130862009-06-06 08:22:04 +0000876STEXI
877@item balloon @var{value}
878Request VM to change its memory allocation to @var{value} (in MB).
879ETEXI
880
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300881 {
882 .name = "set_link",
883 .args_type = "name:s,up_or_down:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300884 .params = "name up|down",
885 .help = "change the link status of a network adapter",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300886 .mhandler.cmd = do_set_link,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300887 },
888
Blue Swirl23130862009-06-06 08:22:04 +0000889STEXI
890@item set_link @var{name} [up|down]
891Set link @var{name} up or down.
892ETEXI
893
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300894 {
895 .name = "watchdog_action",
896 .args_type = "action:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300897 .params = "[reset|shutdown|poweroff|pause|debug|none]",
898 .help = "change watchdog action",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300899 .mhandler.cmd = do_watchdog_action,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300900 },
901
Blue Swirl23130862009-06-06 08:22:04 +0000902STEXI
903@item watchdog_action
904Change watchdog action.
905ETEXI
906
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300907 {
908 .name = "acl_show",
909 .args_type = "aclname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300910 .params = "aclname",
911 .help = "list rules in the access control list",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300912 .mhandler.cmd = do_acl_show,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300913 },
914
Blue Swirl23130862009-06-06 08:22:04 +0000915STEXI
Jan Kiszka15dfcd42009-06-25 08:22:08 +0200916@item acl_show @var{aclname}
917List all the matching rules in the access control list, and the default
918policy. There are currently two named access control lists,
919@var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
920certificate distinguished name, and SASL username respectively.
921ETEXI
Blue Swirl23130862009-06-06 08:22:04 +0000922
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300923 {
924 .name = "acl_policy",
925 .args_type = "aclname:s,policy:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300926 .params = "aclname allow|deny",
927 .help = "set default access control list policy",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300928 .mhandler.cmd = do_acl_policy,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300929 },
930
Jan Kiszka15dfcd42009-06-25 08:22:08 +0200931STEXI
Jan Kiszkacbbfacc2009-07-03 08:46:05 +0200932@item acl_policy @var{aclname} @code{allow|deny}
Jan Kiszka15dfcd42009-06-25 08:22:08 +0200933Set the default access control list policy, used in the event that
Blue Swirl23130862009-06-06 08:22:04 +0000934none of the explicit rules match. The default policy at startup is
Jan Kiszka15dfcd42009-06-25 08:22:08 +0200935always @code{deny}.
936ETEXI
937
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300938 {
939 .name = "acl_add",
940 .args_type = "aclname:s,match:s,policy:s,index:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300941 .params = "aclname match allow|deny [index]",
942 .help = "add a match rule to the access control list",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300943 .mhandler.cmd = do_acl_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300944 },
945
Jan Kiszka15dfcd42009-06-25 08:22:08 +0200946STEXI
947@item acl_allow @var{aclname} @var{match} @code{allow|deny} [@var{index}]
948Add a match rule to the access control list, allowing or denying access.
949The match will normally be an exact username or x509 distinguished name,
950but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
951allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
Blue Swirl23130862009-06-06 08:22:04 +0000952normally be appended to the end of the ACL, but can be inserted
Jan Kiszka15dfcd42009-06-25 08:22:08 +0200953earlier in the list if the optional @var{index} parameter is supplied.
954ETEXI
955
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300956 {
957 .name = "acl_remove",
958 .args_type = "aclname:s,match:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300959 .params = "aclname match",
960 .help = "remove a match rule from the access control list",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300961 .mhandler.cmd = do_acl_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300962 },
963
Jan Kiszka15dfcd42009-06-25 08:22:08 +0200964STEXI
965@item acl_remove @var{aclname} @var{match}
966Remove the specified match rule from the access control list.
967ETEXI
968
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300969 {
970 .name = "acl_reset",
971 .args_type = "aclname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300972 .params = "aclname",
973 .help = "reset the access control list",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300974 .mhandler.cmd = do_acl_reset,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300975 },
976
Jan Kiszka15dfcd42009-06-25 08:22:08 +0200977STEXI
978@item acl_remove @var{aclname} @var{match}
979Remove all matches from the access control list, and set the default
Blue Swirl23130862009-06-06 08:22:04 +0000980policy back to @code{deny}.
Blue Swirl23130862009-06-06 08:22:04 +0000981ETEXI
982
Huang Ying79c4f6b2009-06-23 10:05:14 +0800983#if defined(TARGET_I386)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300984
985 {
986 .name = "mce",
987 .args_type = "cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300988 .params = "cpu bank status mcgstatus addr misc",
989 .help = "inject a MCE on the given CPU",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300990 .mhandler.cmd = do_inject_mce,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300991 },
992
Huang Ying79c4f6b2009-06-23 10:05:14 +0800993#endif
994STEXI
995@item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
996Inject an MCE on the given CPU (x86 only).
997ETEXI
998
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300999 {
1000 .name = "getfd",
1001 .args_type = "fdname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001002 .params = "getfd name",
1003 .help = "receive a file descriptor via SCM rights and assign it a name",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001004 .mhandler.cmd = do_getfd,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001005 },
1006
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001007STEXI
1008@item getfd @var{fdname}
1009If a file descriptor is passed alongside this command using the SCM_RIGHTS
1010mechanism on unix sockets, it is stored using the name @var{fdname} for
1011later use by other monitor commands.
1012ETEXI
1013
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001014 {
1015 .name = "closefd",
1016 .args_type = "fdname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001017 .params = "closefd name",
1018 .help = "close a file descriptor previously passed via SCM rights",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001019 .mhandler.cmd = do_closefd,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001020 },
1021
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001022STEXI
1023@item closefd @var{fdname}
1024Close the file descriptor previously assigned to @var{fdname} using the
1025@code{getfd} command. This is only needed if the file descriptor was never
1026used by another monitor command.
1027ETEXI
1028
Blue Swirl23130862009-06-06 08:22:04 +00001029STEXI
1030@end table
1031ETEXI