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