Statistics
| Branch: | Revision:

root / qemu-monitor.hx @ d7f9b689

History | View | Annotate | Download (25.9 kB)

1 2313086a Blue Swirl
HXCOMM Use DEFHEADING() to define headings in both help text and texi
2 2313086a Blue Swirl
HXCOMM Text between STEXI and ETEXI are copied to texi version and
3 2313086a Blue Swirl
HXCOMM discarded from C version
4 2313086a Blue Swirl
HXCOMM DEF(command, args, callback, arg_string, help) is used to construct
5 2313086a Blue Swirl
HXCOMM monitor commands
6 2313086a Blue Swirl
HXCOMM HXCOMM can be used for comments, discarded from both texi and C
7 2313086a Blue Swirl
8 2313086a Blue Swirl
STEXI
9 2313086a Blue Swirl
@table @option
10 2313086a Blue Swirl
ETEXI
11 2313086a Blue Swirl
12 d7f9b689 Luiz Capitulino
    {
13 d7f9b689 Luiz Capitulino
        .name       = "help|?",
14 d7f9b689 Luiz Capitulino
        .args_type  = "name:s?",
15 d7f9b689 Luiz Capitulino
        .handler    = do_help_cmd,
16 d7f9b689 Luiz Capitulino
        .params     = "[cmd]",
17 d7f9b689 Luiz Capitulino
        .help       = "show the help",
18 d7f9b689 Luiz Capitulino
    },
19 d7f9b689 Luiz Capitulino
20 2313086a Blue Swirl
STEXI
21 2313086a Blue Swirl
@item help or ? [@var{cmd}]
22 2313086a Blue Swirl
Show the help for all commands or just for command @var{cmd}.
23 2313086a Blue Swirl
ETEXI
24 2313086a Blue Swirl
25 d7f9b689 Luiz Capitulino
    {
26 d7f9b689 Luiz Capitulino
        .name       = "commit",
27 d7f9b689 Luiz Capitulino
        .args_type  = "device:B",
28 d7f9b689 Luiz Capitulino
        .handler    = do_commit,
29 d7f9b689 Luiz Capitulino
        .params     = "device|all",
30 d7f9b689 Luiz Capitulino
        .help       = "commit changes to the disk images (if -snapshot is used) or backing files",
31 d7f9b689 Luiz Capitulino
    },
32 d7f9b689 Luiz Capitulino
33 2313086a Blue Swirl
STEXI
34 2313086a Blue Swirl
@item commit
35 2313086a Blue Swirl
Commit changes to the disk images (if -snapshot is used) or backing files.
36 2313086a Blue Swirl
ETEXI
37 2313086a Blue Swirl
38 d7f9b689 Luiz Capitulino
    {
39 d7f9b689 Luiz Capitulino
        .name       = "info",
40 d7f9b689 Luiz Capitulino
        .args_type  = "item:s?",
41 d7f9b689 Luiz Capitulino
        .handler    = do_info,
42 d7f9b689 Luiz Capitulino
        .params     = "[subcommand]",
43 d7f9b689 Luiz Capitulino
        .help       = "show various information about the system state",
44 d7f9b689 Luiz Capitulino
    },
45 d7f9b689 Luiz Capitulino
46 2313086a Blue Swirl
STEXI
47 2313086a Blue Swirl
@item info @var{subcommand}
48 2313086a Blue Swirl
Show various information about the system state.
49 2313086a Blue Swirl
50 2313086a Blue Swirl
@table @option
51 2313086a Blue Swirl
@item info version
52 2313086a Blue Swirl
show the version of QEMU
53 2313086a Blue Swirl
@item info network
54 2313086a Blue Swirl
show the various VLANs and the associated devices
55 2313086a Blue Swirl
@item info chardev
56 2313086a Blue Swirl
show the character devices
57 2313086a Blue Swirl
@item info block
58 2313086a Blue Swirl
show the block devices
59 2313086a Blue Swirl
@item info block
60 2313086a Blue Swirl
show block device statistics
61 2313086a Blue Swirl
@item info registers
62 2313086a Blue Swirl
show the cpu registers
63 2313086a Blue Swirl
@item info cpus
64 2313086a Blue Swirl
show infos for each CPU
65 2313086a Blue Swirl
@item info history
66 2313086a Blue Swirl
show the command line history
67 2313086a Blue Swirl
@item info irq
68 2313086a Blue Swirl
show the interrupts statistics (if available)
69 2313086a Blue Swirl
@item info pic
70 2313086a Blue Swirl
show i8259 (PIC) state
71 2313086a Blue Swirl
@item info pci
72 2313086a Blue Swirl
show emulated PCI device info
73 2313086a Blue Swirl
@item info tlb
74 2313086a Blue Swirl
show virtual to physical memory mappings (i386 only)
75 2313086a Blue Swirl
@item info mem
76 2313086a Blue Swirl
show the active virtual memory mappings (i386 only)
77 2313086a Blue Swirl
@item info hpet
78 2313086a Blue Swirl
show state of HPET (i386 only)
79 2313086a Blue Swirl
@item info kvm
80 2313086a Blue Swirl
show KVM information
81 2313086a Blue Swirl
@item info usb
82 2313086a Blue Swirl
show USB devices plugged on the virtual USB hub
83 2313086a Blue Swirl
@item info usbhost
84 2313086a Blue Swirl
show all USB host devices
85 2313086a Blue Swirl
@item info profile
86 2313086a Blue Swirl
show profiling information
87 2313086a Blue Swirl
@item info capture
88 2313086a Blue Swirl
show information about active capturing
89 2313086a Blue Swirl
@item info snapshots
90 2313086a Blue Swirl
show list of VM snapshots
91 2313086a Blue Swirl
@item info status
92 2313086a Blue Swirl
show the current VM status (running|paused)
93 2313086a Blue Swirl
@item info pcmcia
94 2313086a Blue Swirl
show guest PCMCIA status
95 2313086a Blue Swirl
@item info mice
96 2313086a Blue Swirl
show which guest mouse is receiving events
97 2313086a Blue Swirl
@item info vnc
98 2313086a Blue Swirl
show the vnc server status
99 2313086a Blue Swirl
@item info name
100 2313086a Blue Swirl
show the current VM name
101 2313086a Blue Swirl
@item info uuid
102 2313086a Blue Swirl
show the current VM UUID
103 2313086a Blue Swirl
@item info cpustats
104 2313086a Blue Swirl
show CPU statistics
105 6dbe553f Jan Kiszka
@item info usernet
106 6dbe553f Jan Kiszka
show user network stack connection states
107 2313086a Blue Swirl
@item info migrate
108 2313086a Blue Swirl
show migration status
109 2313086a Blue Swirl
@item info balloon
110 2313086a Blue Swirl
show balloon information
111 2313086a Blue Swirl
@item info qtree
112 2313086a Blue Swirl
show device tree
113 2313086a Blue Swirl
@end table
114 2313086a Blue Swirl
ETEXI
115 2313086a Blue Swirl
116 d7f9b689 Luiz Capitulino
    {
117 d7f9b689 Luiz Capitulino
        .name       = "q|quit",
118 d7f9b689 Luiz Capitulino
        .args_type  = "",
119 d7f9b689 Luiz Capitulino
        .handler    = do_quit,
120 d7f9b689 Luiz Capitulino
        .params     = "",
121 d7f9b689 Luiz Capitulino
        .help       = "quit the emulator",
122 d7f9b689 Luiz Capitulino
    },
123 d7f9b689 Luiz Capitulino
124 2313086a Blue Swirl
STEXI
125 2313086a Blue Swirl
@item q or quit
126 2313086a Blue Swirl
Quit the emulator.
127 2313086a Blue Swirl
ETEXI
128 2313086a Blue Swirl
129 d7f9b689 Luiz Capitulino
    {
130 d7f9b689 Luiz Capitulino
        .name       = "eject",
131 d7f9b689 Luiz Capitulino
        .args_type  = "force:-f,filename:B",
132 d7f9b689 Luiz Capitulino
        .handler    = do_eject,
133 d7f9b689 Luiz Capitulino
        .params     = "[-f] device",
134 d7f9b689 Luiz Capitulino
        .help       = "eject a removable medium (use -f to force it)",
135 d7f9b689 Luiz Capitulino
    },
136 d7f9b689 Luiz Capitulino
137 2313086a Blue Swirl
STEXI
138 2313086a Blue Swirl
@item eject [-f] @var{device}
139 2313086a Blue Swirl
Eject a removable medium (use -f to force it).
140 2313086a Blue Swirl
ETEXI
141 2313086a Blue Swirl
142 d7f9b689 Luiz Capitulino
    {
143 d7f9b689 Luiz Capitulino
        .name       = "change",
144 d7f9b689 Luiz Capitulino
        .args_type  = "device:B,target:F,arg:s?",
145 d7f9b689 Luiz Capitulino
        .handler    = do_change,
146 d7f9b689 Luiz Capitulino
        .params     = "device filename [format]",
147 d7f9b689 Luiz Capitulino
        .help       = "change a removable medium, optional format",
148 d7f9b689 Luiz Capitulino
    },
149 d7f9b689 Luiz Capitulino
150 2313086a Blue Swirl
STEXI
151 2313086a Blue Swirl
@item change @var{device} @var{setting}
152 2313086a Blue Swirl
153 2313086a Blue Swirl
Change the configuration of a device.
154 2313086a Blue Swirl
155 2313086a Blue Swirl
@table @option
156 2313086a Blue Swirl
@item change @var{diskdevice} @var{filename} [@var{format}]
157 2313086a Blue Swirl
Change the medium for a removable disk device to point to @var{filename}. eg
158 2313086a Blue Swirl
159 2313086a Blue Swirl
@example
160 2313086a Blue Swirl
(qemu) change ide1-cd0 /path/to/some.iso
161 2313086a Blue Swirl
@end example
162 2313086a Blue Swirl
163 2313086a Blue Swirl
@var{format} is optional.
164 2313086a Blue Swirl
165 2313086a Blue Swirl
@item change vnc @var{display},@var{options}
166 2313086a Blue Swirl
Change the configuration of the VNC server. The valid syntax for @var{display}
167 2313086a Blue Swirl
and @var{options} are described at @ref{sec_invocation}. eg
168 2313086a Blue Swirl
169 2313086a Blue Swirl
@example
170 2313086a Blue Swirl
(qemu) change vnc localhost:1
171 2313086a Blue Swirl
@end example
172 2313086a Blue Swirl
173 2313086a Blue Swirl
@item change vnc password [@var{password}]
174 2313086a Blue Swirl
175 2313086a Blue Swirl
Change the password associated with the VNC server. If the new password is not
176 2313086a Blue Swirl
supplied, the monitor will prompt for it to be entered. VNC passwords are only
177 2313086a Blue Swirl
significant up to 8 letters. eg
178 2313086a Blue Swirl
179 2313086a Blue Swirl
@example
180 2313086a Blue Swirl
(qemu) change vnc password
181 2313086a Blue Swirl
Password: ********
182 2313086a Blue Swirl
@end example
183 2313086a Blue Swirl
184 2313086a Blue Swirl
@end table
185 2313086a Blue Swirl
ETEXI
186 2313086a Blue Swirl
187 d7f9b689 Luiz Capitulino
    {
188 d7f9b689 Luiz Capitulino
        .name       = "screendump",
189 d7f9b689 Luiz Capitulino
        .args_type  = "filename:F",
190 d7f9b689 Luiz Capitulino
        .handler    = do_screen_dump,
191 d7f9b689 Luiz Capitulino
        .params     = "filename",
192 d7f9b689 Luiz Capitulino
        .help       = "save screen into PPM image 'filename'",
193 d7f9b689 Luiz Capitulino
    },
194 d7f9b689 Luiz Capitulino
195 2313086a Blue Swirl
STEXI
196 2313086a Blue Swirl
@item screendump @var{filename}
197 2313086a Blue Swirl
Save screen into PPM image @var{filename}.
198 2313086a Blue Swirl
ETEXI
199 2313086a Blue Swirl
200 d7f9b689 Luiz Capitulino
    {
201 d7f9b689 Luiz Capitulino
        .name       = "logfile",
202 d7f9b689 Luiz Capitulino
        .args_type  = "filename:F",
203 d7f9b689 Luiz Capitulino
        .handler    = do_logfile,
204 d7f9b689 Luiz Capitulino
        .params     = "filename",
205 d7f9b689 Luiz Capitulino
        .help       = "output logs to 'filename'",
206 d7f9b689 Luiz Capitulino
    },
207 d7f9b689 Luiz Capitulino
208 2313086a Blue Swirl
STEXI
209 2313086a Blue Swirl
@item logfile @var{filename}
210 2313086a Blue Swirl
Output logs to @var{filename}.
211 2313086a Blue Swirl
ETEXI
212 2313086a Blue Swirl
213 d7f9b689 Luiz Capitulino
    {
214 d7f9b689 Luiz Capitulino
        .name       = "log",
215 d7f9b689 Luiz Capitulino
        .args_type  = "items:s",
216 d7f9b689 Luiz Capitulino
        .handler    = do_log,
217 d7f9b689 Luiz Capitulino
        .params     = "item1[,...]",
218 d7f9b689 Luiz Capitulino
        .help       = "activate logging of the specified items to '/tmp/qemu.log'",
219 d7f9b689 Luiz Capitulino
    },
220 d7f9b689 Luiz Capitulino
221 2313086a Blue Swirl
STEXI
222 2313086a Blue Swirl
@item log @var{item1}[,...]
223 2313086a Blue Swirl
Activate logging of the specified items to @file{/tmp/qemu.log}.
224 2313086a Blue Swirl
ETEXI
225 2313086a Blue Swirl
226 d7f9b689 Luiz Capitulino
    {
227 d7f9b689 Luiz Capitulino
        .name       = "savevm",
228 d7f9b689 Luiz Capitulino
        .args_type  = "name:s?",
229 d7f9b689 Luiz Capitulino
        .handler    = do_savevm,
230 d7f9b689 Luiz Capitulino
        .params     = "[tag|id]",
231 d7f9b689 Luiz Capitulino
        .help       = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
232 d7f9b689 Luiz Capitulino
    },
233 d7f9b689 Luiz Capitulino
234 2313086a Blue Swirl
STEXI
235 2313086a Blue Swirl
@item savevm [@var{tag}|@var{id}]
236 2313086a Blue Swirl
Create a snapshot of the whole virtual machine. If @var{tag} is
237 2313086a Blue Swirl
provided, it is used as human readable identifier. If there is already
238 2313086a Blue Swirl
a snapshot with the same tag or ID, it is replaced. More info at
239 2313086a Blue Swirl
@ref{vm_snapshots}.
240 2313086a Blue Swirl
ETEXI
241 2313086a Blue Swirl
242 d7f9b689 Luiz Capitulino
    {
243 d7f9b689 Luiz Capitulino
        .name       = "loadvm",
244 d7f9b689 Luiz Capitulino
        .args_type  = "name:s",
245 d7f9b689 Luiz Capitulino
        .handler    = do_loadvm,
246 d7f9b689 Luiz Capitulino
        .params     = "tag|id",
247 d7f9b689 Luiz Capitulino
        .help       = "restore a VM snapshot from its tag or id",
248 d7f9b689 Luiz Capitulino
    },
249 d7f9b689 Luiz Capitulino
250 2313086a Blue Swirl
STEXI
251 2313086a Blue Swirl
@item loadvm @var{tag}|@var{id}
252 2313086a Blue Swirl
Set the whole virtual machine to the snapshot identified by the tag
253 2313086a Blue Swirl
@var{tag} or the unique snapshot ID @var{id}.
254 2313086a Blue Swirl
ETEXI
255 2313086a Blue Swirl
256 d7f9b689 Luiz Capitulino
    {
257 d7f9b689 Luiz Capitulino
        .name       = "delvm",
258 d7f9b689 Luiz Capitulino
        .args_type  = "name:s",
259 d7f9b689 Luiz Capitulino
        .handler    = do_delvm,
260 d7f9b689 Luiz Capitulino
        .params     = "tag|id",
261 d7f9b689 Luiz Capitulino
        .help       = "delete a VM snapshot from its tag or id",
262 d7f9b689 Luiz Capitulino
    },
263 d7f9b689 Luiz Capitulino
264 2313086a Blue Swirl
STEXI
265 2313086a Blue Swirl
@item delvm @var{tag}|@var{id}
266 2313086a Blue Swirl
Delete the snapshot identified by @var{tag} or @var{id}.
267 2313086a Blue Swirl
ETEXI
268 2313086a Blue Swirl
269 d7f9b689 Luiz Capitulino
    {
270 d7f9b689 Luiz Capitulino
        .name       = "singlestep",
271 d7f9b689 Luiz Capitulino
        .args_type  = "option:s?",
272 d7f9b689 Luiz Capitulino
        .handler    = do_singlestep,
273 d7f9b689 Luiz Capitulino
        .params     = "[on|off]",
274 d7f9b689 Luiz Capitulino
        .help       = "run emulation in singlestep mode or switch to normal mode",
275 d7f9b689 Luiz Capitulino
    },
276 d7f9b689 Luiz Capitulino
277 2313086a Blue Swirl
STEXI
278 2313086a Blue Swirl
@item singlestep [off]
279 2313086a Blue Swirl
Run the emulation in single step mode.
280 2313086a Blue Swirl
If called with option off, the emulation returns to normal mode.
281 2313086a Blue Swirl
ETEXI
282 2313086a Blue Swirl
283 d7f9b689 Luiz Capitulino
    {
284 d7f9b689 Luiz Capitulino
        .name       = "stop",
285 d7f9b689 Luiz Capitulino
        .args_type  = "",
286 d7f9b689 Luiz Capitulino
        .handler    = do_stop,
287 d7f9b689 Luiz Capitulino
        .params     = "",
288 d7f9b689 Luiz Capitulino
        .help       = "stop emulation",
289 d7f9b689 Luiz Capitulino
    },
290 d7f9b689 Luiz Capitulino
291 2313086a Blue Swirl
STEXI
292 2313086a Blue Swirl
@item stop
293 2313086a Blue Swirl
Stop emulation.
294 2313086a Blue Swirl
ETEXI
295 2313086a Blue Swirl
296 d7f9b689 Luiz Capitulino
    {
297 d7f9b689 Luiz Capitulino
        .name       = "c|cont",
298 d7f9b689 Luiz Capitulino
        .args_type  = "",
299 d7f9b689 Luiz Capitulino
        .handler    = do_cont,
300 d7f9b689 Luiz Capitulino
        .params     = "",
301 d7f9b689 Luiz Capitulino
        .help       = "resume emulation",
302 d7f9b689 Luiz Capitulino
    },
303 d7f9b689 Luiz Capitulino
304 2313086a Blue Swirl
STEXI
305 2313086a Blue Swirl
@item c or cont
306 2313086a Blue Swirl
Resume emulation.
307 2313086a Blue Swirl
ETEXI
308 2313086a Blue Swirl
309 d7f9b689 Luiz Capitulino
    {
310 d7f9b689 Luiz Capitulino
        .name       = "gdbserver",
311 d7f9b689 Luiz Capitulino
        .args_type  = "device:s?",
312 d7f9b689 Luiz Capitulino
        .handler    = do_gdbserver,
313 d7f9b689 Luiz Capitulino
        .params     = "[device]",
314 d7f9b689 Luiz Capitulino
        .help       = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
315 d7f9b689 Luiz Capitulino
    },
316 d7f9b689 Luiz Capitulino
317 2313086a Blue Swirl
STEXI
318 2313086a Blue Swirl
@item gdbserver [@var{port}]
319 2313086a Blue Swirl
Start gdbserver session (default @var{port}=1234)
320 2313086a Blue Swirl
ETEXI
321 2313086a Blue Swirl
322 d7f9b689 Luiz Capitulino
    {
323 d7f9b689 Luiz Capitulino
        .name       = "x",
324 d7f9b689 Luiz Capitulino
        .args_type  = "fmt:/,addr:l",
325 d7f9b689 Luiz Capitulino
        .handler    = do_memory_dump,
326 d7f9b689 Luiz Capitulino
        .params     = "/fmt addr",
327 d7f9b689 Luiz Capitulino
        .help       = "virtual memory dump starting at 'addr'",
328 d7f9b689 Luiz Capitulino
    },
329 d7f9b689 Luiz Capitulino
330 2313086a Blue Swirl
STEXI
331 2313086a Blue Swirl
@item x/fmt @var{addr}
332 2313086a Blue Swirl
Virtual memory dump starting at @var{addr}.
333 2313086a Blue Swirl
ETEXI
334 2313086a Blue Swirl
335 d7f9b689 Luiz Capitulino
    {
336 d7f9b689 Luiz Capitulino
        .name       = "xp",
337 d7f9b689 Luiz Capitulino
        .args_type  = "fmt:/,addr:l",
338 d7f9b689 Luiz Capitulino
        .handler    = do_physical_memory_dump,
339 d7f9b689 Luiz Capitulino
        .params     = "/fmt addr",
340 d7f9b689 Luiz Capitulino
        .help       = "physical memory dump starting at 'addr'",
341 d7f9b689 Luiz Capitulino
    },
342 d7f9b689 Luiz Capitulino
343 2313086a Blue Swirl
STEXI
344 2313086a Blue Swirl
@item xp /@var{fmt} @var{addr}
345 2313086a Blue Swirl
Physical memory dump starting at @var{addr}.
346 2313086a Blue Swirl
347 2313086a Blue Swirl
@var{fmt} is a format which tells the command how to format the
348 2313086a Blue Swirl
data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
349 2313086a Blue Swirl
350 2313086a Blue Swirl
@table @var
351 2313086a Blue Swirl
@item count
352 2313086a Blue Swirl
is the number of items to be dumped.
353 2313086a Blue Swirl
354 2313086a Blue Swirl
@item format
355 2313086a Blue Swirl
can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
356 2313086a Blue Swirl
c (char) or i (asm instruction).
357 2313086a Blue Swirl
358 2313086a Blue Swirl
@item size
359 2313086a Blue Swirl
can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
360 2313086a Blue Swirl
@code{h} or @code{w} can be specified with the @code{i} format to
361 2313086a Blue Swirl
respectively select 16 or 32 bit code instruction size.
362 2313086a Blue Swirl
363 2313086a Blue Swirl
@end table
364 2313086a Blue Swirl
365 2313086a Blue Swirl
Examples:
366 2313086a Blue Swirl
@itemize
367 2313086a Blue Swirl
@item
368 2313086a Blue Swirl
Dump 10 instructions at the current instruction pointer:
369 2313086a Blue Swirl
@example
370 2313086a Blue Swirl
(qemu) x/10i $eip
371 2313086a Blue Swirl
0x90107063:  ret
372 2313086a Blue Swirl
0x90107064:  sti
373 2313086a Blue Swirl
0x90107065:  lea    0x0(%esi,1),%esi
374 2313086a Blue Swirl
0x90107069:  lea    0x0(%edi,1),%edi
375 2313086a Blue Swirl
0x90107070:  ret
376 2313086a Blue Swirl
0x90107071:  jmp    0x90107080
377 2313086a Blue Swirl
0x90107073:  nop
378 2313086a Blue Swirl
0x90107074:  nop
379 2313086a Blue Swirl
0x90107075:  nop
380 2313086a Blue Swirl
0x90107076:  nop
381 2313086a Blue Swirl
@end example
382 2313086a Blue Swirl
383 2313086a Blue Swirl
@item
384 2313086a Blue Swirl
Dump 80 16 bit values at the start of the video memory.
385 2313086a Blue Swirl
@smallexample
386 2313086a Blue Swirl
(qemu) xp/80hx 0xb8000
387 2313086a Blue Swirl
0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
388 2313086a Blue Swirl
0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
389 2313086a Blue Swirl
0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
390 2313086a Blue Swirl
0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
391 2313086a Blue Swirl
0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
392 2313086a Blue Swirl
0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
393 2313086a Blue Swirl
0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
394 2313086a Blue Swirl
0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
395 2313086a Blue Swirl
0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
396 2313086a Blue Swirl
0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
397 2313086a Blue Swirl
@end smallexample
398 2313086a Blue Swirl
@end itemize
399 2313086a Blue Swirl
ETEXI
400 2313086a Blue Swirl
401 d7f9b689 Luiz Capitulino
    {
402 d7f9b689 Luiz Capitulino
        .name       = "p|print",
403 d7f9b689 Luiz Capitulino
        .args_type  = "fmt:/,val:l",
404 d7f9b689 Luiz Capitulino
        .handler    = do_print,
405 d7f9b689 Luiz Capitulino
        .params     = "/fmt expr",
406 d7f9b689 Luiz Capitulino
        .help       = "print expression value (use $reg for CPU register access)",
407 d7f9b689 Luiz Capitulino
    },
408 d7f9b689 Luiz Capitulino
409 2313086a Blue Swirl
STEXI
410 2313086a Blue Swirl
@item p or print/@var{fmt} @var{expr}
411 2313086a Blue Swirl
412 2313086a Blue Swirl
Print expression value. Only the @var{format} part of @var{fmt} is
413 2313086a Blue Swirl
used.
414 2313086a Blue Swirl
ETEXI
415 2313086a Blue Swirl
416 d7f9b689 Luiz Capitulino
    {
417 d7f9b689 Luiz Capitulino
        .name       = "i",
418 d7f9b689 Luiz Capitulino
        .args_type  = "fmt:/,addr:i,index:i.",
419 d7f9b689 Luiz Capitulino
        .handler    = do_ioport_read,
420 d7f9b689 Luiz Capitulino
        .params     = "/fmt addr",
421 d7f9b689 Luiz Capitulino
        .help       = "I/O port read",
422 d7f9b689 Luiz Capitulino
    },
423 d7f9b689 Luiz Capitulino
424 2313086a Blue Swirl
STEXI
425 2313086a Blue Swirl
Read I/O port.
426 2313086a Blue Swirl
ETEXI
427 2313086a Blue Swirl
428 d7f9b689 Luiz Capitulino
    {
429 d7f9b689 Luiz Capitulino
        .name       = "o",
430 d7f9b689 Luiz Capitulino
        .args_type  = "fmt:/,addr:i,val:i",
431 d7f9b689 Luiz Capitulino
        .handler    = do_ioport_write,
432 d7f9b689 Luiz Capitulino
        .params     = "/fmt addr value",
433 d7f9b689 Luiz Capitulino
        .help       = "I/O port write",
434 d7f9b689 Luiz Capitulino
    },
435 d7f9b689 Luiz Capitulino
436 f114784f Jan Kiszka
STEXI
437 f114784f Jan Kiszka
Write to I/O port.
438 f114784f Jan Kiszka
ETEXI
439 2313086a Blue Swirl
440 d7f9b689 Luiz Capitulino
    {
441 d7f9b689 Luiz Capitulino
        .name       = "sendkey",
442 d7f9b689 Luiz Capitulino
        .args_type  = "string:s,hold_time:i?",
443 d7f9b689 Luiz Capitulino
        .handler    = do_sendkey,
444 d7f9b689 Luiz Capitulino
        .params     = "keys [hold_ms]",
445 d7f9b689 Luiz Capitulino
        .help       = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
446 d7f9b689 Luiz Capitulino
    },
447 d7f9b689 Luiz Capitulino
448 2313086a Blue Swirl
STEXI
449 2313086a Blue Swirl
@item sendkey @var{keys}
450 2313086a Blue Swirl
451 2313086a Blue Swirl
Send @var{keys} to the emulator. @var{keys} could be the name of the
452 2313086a Blue Swirl
key or @code{#} followed by the raw value in either decimal or hexadecimal
453 2313086a Blue Swirl
format. Use @code{-} to press several keys simultaneously. Example:
454 2313086a Blue Swirl
@example
455 2313086a Blue Swirl
sendkey ctrl-alt-f1
456 2313086a Blue Swirl
@end example
457 2313086a Blue Swirl
458 2313086a Blue Swirl
This command is useful to send keys that your graphical user interface
459 2313086a Blue Swirl
intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
460 2313086a Blue Swirl
ETEXI
461 2313086a Blue Swirl
462 d7f9b689 Luiz Capitulino
    {
463 d7f9b689 Luiz Capitulino
        .name       = "system_reset",
464 d7f9b689 Luiz Capitulino
        .args_type  = "",
465 d7f9b689 Luiz Capitulino
        .handler    = do_system_reset,
466 d7f9b689 Luiz Capitulino
        .params     = "",
467 d7f9b689 Luiz Capitulino
        .help       = "reset the system",
468 d7f9b689 Luiz Capitulino
    },
469 d7f9b689 Luiz Capitulino
470 2313086a Blue Swirl
STEXI
471 2313086a Blue Swirl
@item system_reset
472 2313086a Blue Swirl
473 2313086a Blue Swirl
Reset the system.
474 2313086a Blue Swirl
ETEXI
475 2313086a Blue Swirl
476 d7f9b689 Luiz Capitulino
    {
477 d7f9b689 Luiz Capitulino
        .name       = "system_powerdown",
478 d7f9b689 Luiz Capitulino
        .args_type  = "",
479 d7f9b689 Luiz Capitulino
        .handler    = do_system_powerdown,
480 d7f9b689 Luiz Capitulino
        .params     = "",
481 d7f9b689 Luiz Capitulino
        .help       = "send system power down event",
482 d7f9b689 Luiz Capitulino
    },
483 d7f9b689 Luiz Capitulino
484 2313086a Blue Swirl
STEXI
485 2313086a Blue Swirl
@item system_powerdown
486 2313086a Blue Swirl
487 2313086a Blue Swirl
Power down the system (if supported).
488 2313086a Blue Swirl
ETEXI
489 2313086a Blue Swirl
490 d7f9b689 Luiz Capitulino
    {
491 d7f9b689 Luiz Capitulino
        .name       = "sum",
492 d7f9b689 Luiz Capitulino
        .args_type  = "start:i,size:i",
493 d7f9b689 Luiz Capitulino
        .handler    = do_sum,
494 d7f9b689 Luiz Capitulino
        .params     = "addr size",
495 d7f9b689 Luiz Capitulino
        .help       = "compute the checksum of a memory region",
496 d7f9b689 Luiz Capitulino
    },
497 d7f9b689 Luiz Capitulino
498 2313086a Blue Swirl
STEXI
499 2313086a Blue Swirl
@item sum @var{addr} @var{size}
500 2313086a Blue Swirl
501 2313086a Blue Swirl
Compute the checksum of a memory region.
502 2313086a Blue Swirl
ETEXI
503 2313086a Blue Swirl
504 d7f9b689 Luiz Capitulino
    {
505 d7f9b689 Luiz Capitulino
        .name       = "usb_add",
506 d7f9b689 Luiz Capitulino
        .args_type  = "devname:s",
507 d7f9b689 Luiz Capitulino
        .handler    = do_usb_add,
508 d7f9b689 Luiz Capitulino
        .params     = "device",
509 d7f9b689 Luiz Capitulino
        .help       = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
510 d7f9b689 Luiz Capitulino
    },
511 d7f9b689 Luiz Capitulino
512 2313086a Blue Swirl
STEXI
513 2313086a Blue Swirl
@item usb_add @var{devname}
514 2313086a Blue Swirl
515 2313086a Blue Swirl
Add the USB device @var{devname}.  For details of available devices see
516 2313086a Blue Swirl
@ref{usb_devices}
517 2313086a Blue Swirl
ETEXI
518 2313086a Blue Swirl
519 d7f9b689 Luiz Capitulino
    {
520 d7f9b689 Luiz Capitulino
        .name       = "usb_del",
521 d7f9b689 Luiz Capitulino
        .args_type  = "devname:s",
522 d7f9b689 Luiz Capitulino
        .handler    = do_usb_del,
523 d7f9b689 Luiz Capitulino
        .params     = "device",
524 d7f9b689 Luiz Capitulino
        .help       = "remove USB device 'bus.addr'",
525 d7f9b689 Luiz Capitulino
    },
526 d7f9b689 Luiz Capitulino
527 2313086a Blue Swirl
STEXI
528 2313086a Blue Swirl
@item usb_del @var{devname}
529 2313086a Blue Swirl
530 2313086a Blue Swirl
Remove the USB device @var{devname} from the QEMU virtual USB
531 2313086a Blue Swirl
hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
532 2313086a Blue Swirl
command @code{info usb} to see the devices you can remove.
533 2313086a Blue Swirl
ETEXI
534 2313086a Blue Swirl
535 d7f9b689 Luiz Capitulino
    {
536 d7f9b689 Luiz Capitulino
        .name       = "device_add",
537 d7f9b689 Luiz Capitulino
        .args_type  = "config:s",
538 d7f9b689 Luiz Capitulino
        .handler    = do_device_add,
539 d7f9b689 Luiz Capitulino
        .params     = "device",
540 d7f9b689 Luiz Capitulino
        .help       = "add device, like -device on the command line",
541 d7f9b689 Luiz Capitulino
    },
542 d7f9b689 Luiz Capitulino
543 3418bd25 Gerd Hoffmann
STEXI
544 3418bd25 Gerd Hoffmann
@item device_add @var{config}
545 3418bd25 Gerd Hoffmann
546 3418bd25 Gerd Hoffmann
Add device.
547 3418bd25 Gerd Hoffmann
ETEXI
548 3418bd25 Gerd Hoffmann
549 d7f9b689 Luiz Capitulino
    {
550 d7f9b689 Luiz Capitulino
        .name       = "device_del",
551 d7f9b689 Luiz Capitulino
        .args_type  = "id:s",
552 d7f9b689 Luiz Capitulino
        .handler    = do_device_del,
553 d7f9b689 Luiz Capitulino
        .params     = "device",
554 d7f9b689 Luiz Capitulino
        .help       = "remove device",
555 d7f9b689 Luiz Capitulino
    },
556 d7f9b689 Luiz Capitulino
557 3418bd25 Gerd Hoffmann
STEXI
558 3418bd25 Gerd Hoffmann
@item device_del @var{id}
559 3418bd25 Gerd Hoffmann
560 3418bd25 Gerd Hoffmann
Remove device @var{id}.
561 3418bd25 Gerd Hoffmann
ETEXI
562 3418bd25 Gerd Hoffmann
563 d7f9b689 Luiz Capitulino
    {
564 d7f9b689 Luiz Capitulino
        .name       = "cpu",
565 d7f9b689 Luiz Capitulino
        .args_type  = "index:i",
566 d7f9b689 Luiz Capitulino
        .handler    = do_cpu_set,
567 d7f9b689 Luiz Capitulino
        .params     = "index",
568 d7f9b689 Luiz Capitulino
        .help       = "set the default CPU",
569 d7f9b689 Luiz Capitulino
    },
570 3418bd25 Gerd Hoffmann
571 2313086a Blue Swirl
STEXI
572 2313086a Blue Swirl
Set the default CPU.
573 2313086a Blue Swirl
ETEXI
574 2313086a Blue Swirl
575 d7f9b689 Luiz Capitulino
    {
576 d7f9b689 Luiz Capitulino
        .name       = "mouse_move",
577 d7f9b689 Luiz Capitulino
        .args_type  = "dx_str:s,dy_str:s,dz_str:s?",
578 d7f9b689 Luiz Capitulino
        .handler    = do_mouse_move,
579 d7f9b689 Luiz Capitulino
        .params     = "dx dy [dz]",
580 d7f9b689 Luiz Capitulino
        .help       = "send mouse move events",
581 d7f9b689 Luiz Capitulino
    },
582 d7f9b689 Luiz Capitulino
583 2313086a Blue Swirl
STEXI
584 2313086a Blue Swirl
@item mouse_move @var{dx} @var{dy} [@var{dz}]
585 2313086a Blue Swirl
Move the active mouse to the specified coordinates @var{dx} @var{dy}
586 2313086a Blue Swirl
with optional scroll axis @var{dz}.
587 2313086a Blue Swirl
ETEXI
588 2313086a Blue Swirl
589 d7f9b689 Luiz Capitulino
    {
590 d7f9b689 Luiz Capitulino
        .name       = "mouse_button",
591 d7f9b689 Luiz Capitulino
        .args_type  = "button_state:i",
592 d7f9b689 Luiz Capitulino
        .handler    = do_mouse_button,
593 d7f9b689 Luiz Capitulino
        .params     = "state",
594 d7f9b689 Luiz Capitulino
        .help       = "change mouse button state (1=L, 2=M, 4=R)",
595 d7f9b689 Luiz Capitulino
    },
596 d7f9b689 Luiz Capitulino
597 2313086a Blue Swirl
STEXI
598 2313086a Blue Swirl
@item mouse_button @var{val}
599 2313086a Blue Swirl
Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
600 2313086a Blue Swirl
ETEXI
601 2313086a Blue Swirl
602 d7f9b689 Luiz Capitulino
    {
603 d7f9b689 Luiz Capitulino
        .name       = "mouse_set",
604 d7f9b689 Luiz Capitulino
        .args_type  = "index:i",
605 d7f9b689 Luiz Capitulino
        .handler    = do_mouse_set,
606 d7f9b689 Luiz Capitulino
        .params     = "index",
607 d7f9b689 Luiz Capitulino
        .help       = "set which mouse device receives events",
608 d7f9b689 Luiz Capitulino
    },
609 d7f9b689 Luiz Capitulino
610 2313086a Blue Swirl
STEXI
611 2313086a Blue Swirl
@item mouse_set @var{index}
612 2313086a Blue Swirl
Set which mouse device receives events at given @var{index}, index
613 2313086a Blue Swirl
can be obtained with
614 2313086a Blue Swirl
@example
615 2313086a Blue Swirl
info mice
616 2313086a Blue Swirl
@end example
617 2313086a Blue Swirl
ETEXI
618 2313086a Blue Swirl
619 2313086a Blue Swirl
#ifdef HAS_AUDIO
620 d7f9b689 Luiz Capitulino
    {
621 d7f9b689 Luiz Capitulino
        .name       = "wavcapture",
622 d7f9b689 Luiz Capitulino
        .args_type  = "path:F,freq:i?,bits:i?,nchannels:i?",
623 d7f9b689 Luiz Capitulino
        .handler    = do_wav_capture,
624 d7f9b689 Luiz Capitulino
        .params     = "path [frequency [bits [channels]]]",
625 d7f9b689 Luiz Capitulino
        .help       = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
626 d7f9b689 Luiz Capitulino
    },
627 2313086a Blue Swirl
#endif
628 2313086a Blue Swirl
STEXI
629 2313086a Blue Swirl
@item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
630 2313086a Blue Swirl
Capture audio into @var{filename}. Using sample rate @var{frequency}
631 2313086a Blue Swirl
bits per sample @var{bits} and number of channels @var{channels}.
632 2313086a Blue Swirl
633 2313086a Blue Swirl
Defaults:
634 2313086a Blue Swirl
@itemize @minus
635 2313086a Blue Swirl
@item Sample rate = 44100 Hz - CD quality
636 2313086a Blue Swirl
@item Bits = 16
637 2313086a Blue Swirl
@item Number of channels = 2 - Stereo
638 2313086a Blue Swirl
@end itemize
639 2313086a Blue Swirl
ETEXI
640 2313086a Blue Swirl
641 2313086a Blue Swirl
#ifdef HAS_AUDIO
642 d7f9b689 Luiz Capitulino
    {
643 d7f9b689 Luiz Capitulino
        .name       = "stopcapture",
644 d7f9b689 Luiz Capitulino
        .args_type  = "n:i",
645 d7f9b689 Luiz Capitulino
        .handler    = do_stop_capture,
646 d7f9b689 Luiz Capitulino
        .params     = "capture index",
647 d7f9b689 Luiz Capitulino
        .help       = "stop capture",
648 d7f9b689 Luiz Capitulino
    },
649 2313086a Blue Swirl
#endif
650 2313086a Blue Swirl
STEXI
651 2313086a Blue Swirl
@item stopcapture @var{index}
652 2313086a Blue Swirl
Stop capture with a given @var{index}, index can be obtained with
653 2313086a Blue Swirl
@example
654 2313086a Blue Swirl
info capture
655 2313086a Blue Swirl
@end example
656 2313086a Blue Swirl
ETEXI
657 2313086a Blue Swirl
658 d7f9b689 Luiz Capitulino
    {
659 d7f9b689 Luiz Capitulino
        .name       = "memsave",
660 d7f9b689 Luiz Capitulino
        .args_type  = "val:l,size:i,filename:s",
661 d7f9b689 Luiz Capitulino
        .handler    = do_memory_save,
662 d7f9b689 Luiz Capitulino
        .params     = "addr size file",
663 d7f9b689 Luiz Capitulino
        .help       = "save to disk virtual memory dump starting at 'addr' of size 'size'",
664 d7f9b689 Luiz Capitulino
    },
665 d7f9b689 Luiz Capitulino
666 2313086a Blue Swirl
STEXI
667 2313086a Blue Swirl
@item memsave @var{addr} @var{size} @var{file}
668 2313086a Blue Swirl
save to disk virtual memory dump starting at @var{addr} of size @var{size}.
669 2313086a Blue Swirl
ETEXI
670 2313086a Blue Swirl
671 d7f9b689 Luiz Capitulino
    {
672 d7f9b689 Luiz Capitulino
        .name       = "pmemsave",
673 d7f9b689 Luiz Capitulino
        .args_type  = "val:l,size:i,filename:s",
674 d7f9b689 Luiz Capitulino
        .handler    = do_physical_memory_save,
675 d7f9b689 Luiz Capitulino
        .params     = "addr size file",
676 d7f9b689 Luiz Capitulino
        .help       = "save to disk physical memory dump starting at 'addr' of size 'size'",
677 d7f9b689 Luiz Capitulino
    },
678 d7f9b689 Luiz Capitulino
679 2313086a Blue Swirl
STEXI
680 2313086a Blue Swirl
@item pmemsave @var{addr} @var{size} @var{file}
681 2313086a Blue Swirl
save to disk physical memory dump starting at @var{addr} of size @var{size}.
682 2313086a Blue Swirl
ETEXI
683 2313086a Blue Swirl
684 d7f9b689 Luiz Capitulino
    {
685 d7f9b689 Luiz Capitulino
        .name       = "boot_set",
686 d7f9b689 Luiz Capitulino
        .args_type  = "bootdevice:s",
687 d7f9b689 Luiz Capitulino
        .handler    = do_boot_set,
688 d7f9b689 Luiz Capitulino
        .params     = "bootdevice",
689 d7f9b689 Luiz Capitulino
        .help       = "define new values for the boot device list",
690 d7f9b689 Luiz Capitulino
    },
691 d7f9b689 Luiz Capitulino
692 2313086a Blue Swirl
STEXI
693 2313086a Blue Swirl
@item boot_set @var{bootdevicelist}
694 2313086a Blue Swirl
695 2313086a Blue Swirl
Define new values for the boot device list. Those values will override
696 2313086a Blue Swirl
the values specified on the command line through the @code{-boot} option.
697 2313086a Blue Swirl
698 2313086a Blue Swirl
The values that can be specified here depend on the machine type, but are
699 2313086a Blue Swirl
the same that can be specified in the @code{-boot} command line option.
700 2313086a Blue Swirl
ETEXI
701 2313086a Blue Swirl
702 2313086a Blue Swirl
#if defined(TARGET_I386)
703 d7f9b689 Luiz Capitulino
    {
704 d7f9b689 Luiz Capitulino
        .name       = "nmi",
705 d7f9b689 Luiz Capitulino
        .args_type  = "cpu_index:i",
706 d7f9b689 Luiz Capitulino
        .handler    = do_inject_nmi,
707 d7f9b689 Luiz Capitulino
        .params     = "cpu",
708 d7f9b689 Luiz Capitulino
        .help       = "inject an NMI on the given CPU",
709 d7f9b689 Luiz Capitulino
    },
710 2313086a Blue Swirl
#endif
711 2313086a Blue Swirl
STEXI
712 2313086a Blue Swirl
@item nmi @var{cpu}
713 2313086a Blue Swirl
Inject an NMI on the given CPU (x86 only).
714 2313086a Blue Swirl
ETEXI
715 2313086a Blue Swirl
716 d7f9b689 Luiz Capitulino
    {
717 d7f9b689 Luiz Capitulino
        .name       = "migrate",
718 d7f9b689 Luiz Capitulino
        .args_type  = "detach:-d,uri:s",
719 d7f9b689 Luiz Capitulino
        .handler    = do_migrate,
720 d7f9b689 Luiz Capitulino
        .params     = "[-d] uri",
721 d7f9b689 Luiz Capitulino
        .help       = "migrate to URI (using -d to not wait for completion)",
722 d7f9b689 Luiz Capitulino
    },
723 d7f9b689 Luiz Capitulino
724 2313086a Blue Swirl
STEXI
725 2313086a Blue Swirl
@item migrate [-d] @var{uri}
726 2313086a Blue Swirl
Migrate to @var{uri} (using -d to not wait for completion).
727 2313086a Blue Swirl
ETEXI
728 2313086a Blue Swirl
729 d7f9b689 Luiz Capitulino
    {
730 d7f9b689 Luiz Capitulino
        .name       = "migrate_cancel",
731 d7f9b689 Luiz Capitulino
        .args_type  = "",
732 d7f9b689 Luiz Capitulino
        .handler    = do_migrate_cancel,
733 d7f9b689 Luiz Capitulino
        .params     = "",
734 d7f9b689 Luiz Capitulino
        .help       = "cancel the current VM migration",
735 d7f9b689 Luiz Capitulino
    },
736 d7f9b689 Luiz Capitulino
737 2313086a Blue Swirl
STEXI
738 2313086a Blue Swirl
@item migrate_cancel
739 2313086a Blue Swirl
Cancel the current VM migration.
740 2313086a Blue Swirl
ETEXI
741 2313086a Blue Swirl
742 d7f9b689 Luiz Capitulino
    {
743 d7f9b689 Luiz Capitulino
        .name       = "migrate_set_speed",
744 d7f9b689 Luiz Capitulino
        .args_type  = "value:s",
745 d7f9b689 Luiz Capitulino
        .handler    = do_migrate_set_speed,
746 d7f9b689 Luiz Capitulino
        .params     = "value",
747 d7f9b689 Luiz Capitulino
        .help       = "set maximum speed (in bytes) for migrations",
748 d7f9b689 Luiz Capitulino
    },
749 d7f9b689 Luiz Capitulino
750 2313086a Blue Swirl
STEXI
751 2313086a Blue Swirl
@item migrate_set_speed @var{value}
752 2313086a Blue Swirl
Set maximum speed to @var{value} (in bytes) for migrations.
753 2313086a Blue Swirl
ETEXI
754 2313086a Blue Swirl
755 d7f9b689 Luiz Capitulino
    {
756 d7f9b689 Luiz Capitulino
        .name       = "migrate_set_downtime",
757 d7f9b689 Luiz Capitulino
        .args_type  = "value:s",
758 d7f9b689 Luiz Capitulino
        .handler    = do_migrate_set_downtime,
759 d7f9b689 Luiz Capitulino
        .params     = "value",
760 d7f9b689 Luiz Capitulino
        .help       = "set maximum tolerated downtime (in seconds) for migrations",
761 d7f9b689 Luiz Capitulino
    },
762 2ea42952 Glauber Costa
763 2ea42952 Glauber Costa
STEXI
764 2ea42952 Glauber Costa
@item migrate_set_downtime @var{second}
765 2ea42952 Glauber Costa
Set maximum tolerated downtime (in seconds) for migration.
766 2ea42952 Glauber Costa
ETEXI
767 2ea42952 Glauber Costa
768 2313086a Blue Swirl
#if defined(TARGET_I386)
769 d7f9b689 Luiz Capitulino
    {
770 d7f9b689 Luiz Capitulino
        .name       = "drive_add",
771 d7f9b689 Luiz Capitulino
        .args_type  = "pci_addr:s,opts:s",
772 d7f9b689 Luiz Capitulino
        .handler    = drive_hot_add,
773 d7f9b689 Luiz Capitulino
        .params     = "[[<domain>:]<bus>:]<slot>\n"
774 d7f9b689 Luiz Capitulino
                      "[file=file][,if=type][,bus=n]\n"
775 d7f9b689 Luiz Capitulino
                      "[,unit=m][,media=d][index=i]\n"
776 d7f9b689 Luiz Capitulino
                      "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
777 d7f9b689 Luiz Capitulino
                      "[snapshot=on|off][,cache=on|off]",
778 d7f9b689 Luiz Capitulino
        .help       = "add drive to PCI storage controller",
779 d7f9b689 Luiz Capitulino
    },
780 2313086a Blue Swirl
#endif
781 d7f9b689 Luiz Capitulino
782 2313086a Blue Swirl
STEXI
783 2313086a Blue Swirl
@item drive_add
784 2313086a Blue Swirl
Add drive to PCI storage controller.
785 2313086a Blue Swirl
ETEXI
786 2313086a Blue Swirl
787 2313086a Blue Swirl
#if defined(TARGET_I386)
788 d7f9b689 Luiz Capitulino
    {
789 d7f9b689 Luiz Capitulino
        .name       = "pci_add",
790 d7f9b689 Luiz Capitulino
        .args_type  = "pci_addr:s,type:s,opts:s?",
791 d7f9b689 Luiz Capitulino
        .handler    = pci_device_hot_add,
792 d7f9b689 Luiz Capitulino
        .params     = "auto|[[<domain>:]<bus>:]<slot> nic|storage [[vlan=n][,macaddr=addr][,model=type]] [file=file][,if=type][,bus=nr]...",
793 d7f9b689 Luiz Capitulino
        .help       = "hot-add PCI device",
794 d7f9b689 Luiz Capitulino
    },
795 2313086a Blue Swirl
#endif
796 d7f9b689 Luiz Capitulino
797 2313086a Blue Swirl
STEXI
798 2313086a Blue Swirl
@item pci_add
799 2313086a Blue Swirl
Hot-add PCI device.
800 2313086a Blue Swirl
ETEXI
801 2313086a Blue Swirl
802 2313086a Blue Swirl
#if defined(TARGET_I386)
803 d7f9b689 Luiz Capitulino
    {
804 d7f9b689 Luiz Capitulino
        .name       = "pci_del",
805 d7f9b689 Luiz Capitulino
        .args_type  = "pci_addr:s",
806 d7f9b689 Luiz Capitulino
        .handler    = do_pci_device_hot_remove,
807 d7f9b689 Luiz Capitulino
        .params     = "[[<domain>:]<bus>:]<slot>",
808 d7f9b689 Luiz Capitulino
        .help       = "hot remove PCI device",
809 d7f9b689 Luiz Capitulino
    },
810 2313086a Blue Swirl
#endif
811 d7f9b689 Luiz Capitulino
812 2313086a Blue Swirl
STEXI
813 2313086a Blue Swirl
@item pci_del
814 2313086a Blue Swirl
Hot remove PCI device.
815 2313086a Blue Swirl
ETEXI
816 2313086a Blue Swirl
817 d7f9b689 Luiz Capitulino
    {
818 d7f9b689 Luiz Capitulino
        .name       = "host_net_add",
819 d7f9b689 Luiz Capitulino
        .args_type  = "device:s,opts:s?",
820 d7f9b689 Luiz Capitulino
        .handler    = net_host_device_add,
821 d7f9b689 Luiz Capitulino
        .params     = "tap|user|socket|vde|dump [options]",
822 d7f9b689 Luiz Capitulino
        .help       = "add host VLAN client",
823 d7f9b689 Luiz Capitulino
    },
824 d7f9b689 Luiz Capitulino
825 2313086a Blue Swirl
STEXI
826 2313086a Blue Swirl
@item host_net_add
827 2313086a Blue Swirl
Add host VLAN client.
828 2313086a Blue Swirl
ETEXI
829 2313086a Blue Swirl
830 d7f9b689 Luiz Capitulino
    {
831 d7f9b689 Luiz Capitulino
        .name       = "host_net_remove",
832 d7f9b689 Luiz Capitulino
        .args_type  = "vlan_id:i,device:s",
833 d7f9b689 Luiz Capitulino
        .handler    = net_host_device_remove,
834 d7f9b689 Luiz Capitulino
        .params     = "vlan_id name",
835 d7f9b689 Luiz Capitulino
        .help       = "remove host VLAN client",
836 d7f9b689 Luiz Capitulino
    },
837 d7f9b689 Luiz Capitulino
838 2313086a Blue Swirl
STEXI
839 2313086a Blue Swirl
@item host_net_remove
840 2313086a Blue Swirl
Remove host VLAN client.
841 2313086a Blue Swirl
ETEXI
842 2313086a Blue Swirl
843 2313086a Blue Swirl
#ifdef CONFIG_SLIRP
844 d7f9b689 Luiz Capitulino
    {
845 d7f9b689 Luiz Capitulino
        .name       = "hostfwd_add",
846 d7f9b689 Luiz Capitulino
        .args_type  = "arg1:s,arg2:s?,arg3:s?",
847 d7f9b689 Luiz Capitulino
        .handler    = net_slirp_hostfwd_add,
848 d7f9b689 Luiz Capitulino
        .params     = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
849 d7f9b689 Luiz Capitulino
        .help       = "redirect TCP or UDP connections from host to guest (requires -net user)",
850 d7f9b689 Luiz Capitulino
    },
851 d7f9b689 Luiz Capitulino
852 d7f9b689 Luiz Capitulino
    {
853 d7f9b689 Luiz Capitulino
        .name       = "hostfwd_remove",
854 d7f9b689 Luiz Capitulino
        .args_type  = "arg1:s,arg2:s?,arg3:s?",
855 d7f9b689 Luiz Capitulino
        .handler    = net_slirp_hostfwd_remove,
856 d7f9b689 Luiz Capitulino
        .params     = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
857 d7f9b689 Luiz Capitulino
        .help       = "remove host-to-guest TCP or UDP redirection",
858 d7f9b689 Luiz Capitulino
    },
859 d7f9b689 Luiz Capitulino
860 2313086a Blue Swirl
#endif
861 2313086a Blue Swirl
STEXI
862 2313086a Blue Swirl
@item host_net_redir
863 2313086a Blue Swirl
Redirect TCP or UDP connections from host to guest (requires -net user).
864 2313086a Blue Swirl
ETEXI
865 2313086a Blue Swirl
866 d7f9b689 Luiz Capitulino
    {
867 d7f9b689 Luiz Capitulino
        .name       = "balloon",
868 d7f9b689 Luiz Capitulino
        .args_type  = "value:i",
869 d7f9b689 Luiz Capitulino
        .handler    = do_balloon,
870 d7f9b689 Luiz Capitulino
        .params     = "target",
871 d7f9b689 Luiz Capitulino
        .help       = "request VM to change it's memory allocation (in MB)",
872 d7f9b689 Luiz Capitulino
    },
873 d7f9b689 Luiz Capitulino
874 2313086a Blue Swirl
STEXI
875 2313086a Blue Swirl
@item balloon @var{value}
876 2313086a Blue Swirl
Request VM to change its memory allocation to @var{value} (in MB).
877 2313086a Blue Swirl
ETEXI
878 2313086a Blue Swirl
879 d7f9b689 Luiz Capitulino
    {
880 d7f9b689 Luiz Capitulino
        .name       = "set_link",
881 d7f9b689 Luiz Capitulino
        .args_type  = "name:s,up_or_down:s",
882 d7f9b689 Luiz Capitulino
        .handler    = do_set_link,
883 d7f9b689 Luiz Capitulino
        .params     = "name up|down",
884 d7f9b689 Luiz Capitulino
        .help       = "change the link status of a network adapter",
885 d7f9b689 Luiz Capitulino
    },
886 d7f9b689 Luiz Capitulino
887 2313086a Blue Swirl
STEXI
888 2313086a Blue Swirl
@item set_link @var{name} [up|down]
889 2313086a Blue Swirl
Set link @var{name} up or down.
890 2313086a Blue Swirl
ETEXI
891 2313086a Blue Swirl
892 d7f9b689 Luiz Capitulino
    {
893 d7f9b689 Luiz Capitulino
        .name       = "watchdog_action",
894 d7f9b689 Luiz Capitulino
        .args_type  = "action:s",
895 d7f9b689 Luiz Capitulino
        .handler    = do_watchdog_action,
896 d7f9b689 Luiz Capitulino
        .params     = "[reset|shutdown|poweroff|pause|debug|none]",
897 d7f9b689 Luiz Capitulino
        .help       = "change watchdog action",
898 d7f9b689 Luiz Capitulino
    },
899 d7f9b689 Luiz Capitulino
900 2313086a Blue Swirl
STEXI
901 2313086a Blue Swirl
@item watchdog_action
902 2313086a Blue Swirl
Change watchdog action.
903 2313086a Blue Swirl
ETEXI
904 2313086a Blue Swirl
905 d7f9b689 Luiz Capitulino
    {
906 d7f9b689 Luiz Capitulino
        .name       = "acl_show",
907 d7f9b689 Luiz Capitulino
        .args_type  = "aclname:s",
908 d7f9b689 Luiz Capitulino
        .handler    = do_acl_show,
909 d7f9b689 Luiz Capitulino
        .params     = "aclname",
910 d7f9b689 Luiz Capitulino
        .help       = "list rules in the access control list",
911 d7f9b689 Luiz Capitulino
    },
912 d7f9b689 Luiz Capitulino
913 2313086a Blue Swirl
STEXI
914 15dfcd45 Jan Kiszka
@item acl_show @var{aclname}
915 15dfcd45 Jan Kiszka
List all the matching rules in the access control list, and the default
916 15dfcd45 Jan Kiszka
policy. There are currently two named access control lists,
917 15dfcd45 Jan Kiszka
@var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
918 15dfcd45 Jan Kiszka
certificate distinguished name, and SASL username respectively.
919 15dfcd45 Jan Kiszka
ETEXI
920 2313086a Blue Swirl
921 d7f9b689 Luiz Capitulino
    {
922 d7f9b689 Luiz Capitulino
        .name       = "acl_policy",
923 d7f9b689 Luiz Capitulino
        .args_type  = "aclname:s,policy:s",
924 d7f9b689 Luiz Capitulino
        .handler    = do_acl_policy,
925 d7f9b689 Luiz Capitulino
        .params     = "aclname allow|deny",
926 d7f9b689 Luiz Capitulino
        .help       = "set default access control list policy",
927 d7f9b689 Luiz Capitulino
    },
928 d7f9b689 Luiz Capitulino
929 15dfcd45 Jan Kiszka
STEXI
930 cbbfacc6 Jan Kiszka
@item acl_policy @var{aclname} @code{allow|deny}
931 15dfcd45 Jan Kiszka
Set the default access control list policy, used in the event that
932 2313086a Blue Swirl
none of the explicit rules match. The default policy at startup is
933 15dfcd45 Jan Kiszka
always @code{deny}.
934 15dfcd45 Jan Kiszka
ETEXI
935 15dfcd45 Jan Kiszka
936 d7f9b689 Luiz Capitulino
    {
937 d7f9b689 Luiz Capitulino
        .name       = "acl_add",
938 d7f9b689 Luiz Capitulino
        .args_type  = "aclname:s,match:s,policy:s,index:i?",
939 d7f9b689 Luiz Capitulino
        .handler    = do_acl_add,
940 d7f9b689 Luiz Capitulino
        .params     = "aclname match allow|deny [index]",
941 d7f9b689 Luiz Capitulino
        .help       = "add a match rule to the access control list",
942 d7f9b689 Luiz Capitulino
    },
943 d7f9b689 Luiz Capitulino
944 15dfcd45 Jan Kiszka
STEXI
945 15dfcd45 Jan Kiszka
@item acl_allow @var{aclname} @var{match} @code{allow|deny} [@var{index}]
946 15dfcd45 Jan Kiszka
Add a match rule to the access control list, allowing or denying access.
947 15dfcd45 Jan Kiszka
The match will normally be an exact username or x509 distinguished name,
948 15dfcd45 Jan Kiszka
but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
949 15dfcd45 Jan Kiszka
allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
950 2313086a Blue Swirl
normally be appended to the end of the ACL, but can be inserted
951 15dfcd45 Jan Kiszka
earlier in the list if the optional @var{index} parameter is supplied.
952 15dfcd45 Jan Kiszka
ETEXI
953 15dfcd45 Jan Kiszka
954 d7f9b689 Luiz Capitulino
    {
955 d7f9b689 Luiz Capitulino
        .name       = "acl_remove",
956 d7f9b689 Luiz Capitulino
        .args_type  = "aclname:s,match:s",
957 d7f9b689 Luiz Capitulino
        .handler    = do_acl_remove,
958 d7f9b689 Luiz Capitulino
        .params     = "aclname match",
959 d7f9b689 Luiz Capitulino
        .help       = "remove a match rule from the access control list",
960 d7f9b689 Luiz Capitulino
    },
961 d7f9b689 Luiz Capitulino
962 15dfcd45 Jan Kiszka
STEXI
963 15dfcd45 Jan Kiszka
@item acl_remove @var{aclname} @var{match}
964 15dfcd45 Jan Kiszka
Remove the specified match rule from the access control list.
965 15dfcd45 Jan Kiszka
ETEXI
966 15dfcd45 Jan Kiszka
967 d7f9b689 Luiz Capitulino
    {
968 d7f9b689 Luiz Capitulino
        .name       = "acl_reset",
969 d7f9b689 Luiz Capitulino
        .args_type  = "aclname:s",
970 d7f9b689 Luiz Capitulino
        .handler    = do_acl_reset,
971 d7f9b689 Luiz Capitulino
        .params     = "aclname",
972 d7f9b689 Luiz Capitulino
        .help       = "reset the access control list",
973 d7f9b689 Luiz Capitulino
    },
974 d7f9b689 Luiz Capitulino
975 15dfcd45 Jan Kiszka
STEXI
976 15dfcd45 Jan Kiszka
@item acl_remove @var{aclname} @var{match}
977 15dfcd45 Jan Kiszka
Remove all matches from the access control list, and set the default
978 2313086a Blue Swirl
policy back to @code{deny}.
979 2313086a Blue Swirl
ETEXI
980 2313086a Blue Swirl
981 79c4f6b0 Huang Ying
#if defined(TARGET_I386)
982 d7f9b689 Luiz Capitulino
983 d7f9b689 Luiz Capitulino
    {
984 d7f9b689 Luiz Capitulino
        .name       = "mce",
985 d7f9b689 Luiz Capitulino
        .args_type  = "cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
986 d7f9b689 Luiz Capitulino
        .handler    = do_inject_mce,
987 d7f9b689 Luiz Capitulino
        .params     = "cpu bank status mcgstatus addr misc",
988 d7f9b689 Luiz Capitulino
        .help       = "inject a MCE on the given CPU",
989 d7f9b689 Luiz Capitulino
    },
990 d7f9b689 Luiz Capitulino
991 79c4f6b0 Huang Ying
#endif
992 79c4f6b0 Huang Ying
STEXI
993 79c4f6b0 Huang Ying
@item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
994 79c4f6b0 Huang Ying
Inject an MCE on the given CPU (x86 only).
995 79c4f6b0 Huang Ying
ETEXI
996 79c4f6b0 Huang Ying
997 d7f9b689 Luiz Capitulino
    {
998 d7f9b689 Luiz Capitulino
        .name       = "getfd",
999 d7f9b689 Luiz Capitulino
        .args_type  = "fdname:s",
1000 d7f9b689 Luiz Capitulino
        .handler    = do_getfd,
1001 d7f9b689 Luiz Capitulino
        .params     = "getfd name",
1002 d7f9b689 Luiz Capitulino
        .help       = "receive a file descriptor via SCM rights and assign it a name",
1003 d7f9b689 Luiz Capitulino
    },
1004 d7f9b689 Luiz Capitulino
1005 f07918fd Mark McLoughlin
STEXI
1006 f07918fd Mark McLoughlin
@item getfd @var{fdname}
1007 f07918fd Mark McLoughlin
If a file descriptor is passed alongside this command using the SCM_RIGHTS
1008 f07918fd Mark McLoughlin
mechanism on unix sockets, it is stored using the name @var{fdname} for
1009 f07918fd Mark McLoughlin
later use by other monitor commands.
1010 f07918fd Mark McLoughlin
ETEXI
1011 f07918fd Mark McLoughlin
1012 d7f9b689 Luiz Capitulino
    {
1013 d7f9b689 Luiz Capitulino
        .name       = "closefd",
1014 d7f9b689 Luiz Capitulino
        .args_type  = "fdname:s",
1015 d7f9b689 Luiz Capitulino
        .handler    = do_closefd,
1016 d7f9b689 Luiz Capitulino
        .params     = "closefd name",
1017 d7f9b689 Luiz Capitulino
        .help       = "close a file descriptor previously passed via SCM rights",
1018 d7f9b689 Luiz Capitulino
    },
1019 d7f9b689 Luiz Capitulino
1020 f07918fd Mark McLoughlin
STEXI
1021 f07918fd Mark McLoughlin
@item closefd @var{fdname}
1022 f07918fd Mark McLoughlin
Close the file descriptor previously assigned to @var{fdname} using the
1023 f07918fd Mark McLoughlin
@code{getfd} command. This is only needed if the file descriptor was never
1024 f07918fd Mark McLoughlin
used by another monitor command.
1025 f07918fd Mark McLoughlin
ETEXI
1026 f07918fd Mark McLoughlin
1027 2313086a Blue Swirl
STEXI
1028 2313086a Blue Swirl
@end table
1029 2313086a Blue Swirl
ETEXI