Statistics
| Branch: | Revision:

root / hmp-commands.hx @ e6e055c9

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