]>
Commit | Line | Data |
---|---|---|
da76ee76 PB |
1 | HXCOMM Use DEFHEADING() to define headings in both help text and texi |
2 | HXCOMM Text between STEXI and ETEXI are copied to texi version and | |
3 | HXCOMM discarded from C version | |
4 | HXCOMM DEF(command, args, callback, arg_string, help) is used to construct | |
5 | HXCOMM monitor info commands | |
6 | HXCOMM HXCOMM can be used for comments, discarded from both texi and C | |
7 | ||
8 | STEXI | |
9 | @table @option | |
2cd8af2d PB |
10 | @item info @var{subcommand} |
11 | @findex info | |
12 | Show various information about the system state. | |
13 | @table @option | |
da76ee76 PB |
14 | ETEXI |
15 | ||
16 | { | |
17 | .name = "version", | |
18 | .args_type = "", | |
19 | .params = "", | |
20 | .help = "show the version of QEMU", | |
21 | .mhandler.cmd = hmp_info_version, | |
22 | }, | |
23 | ||
24 | STEXI | |
25 | @item info version | |
26 | @findex version | |
27 | Show the version of QEMU. | |
28 | ETEXI | |
29 | ||
30 | { | |
31 | .name = "network", | |
32 | .args_type = "", | |
33 | .params = "", | |
34 | .help = "show the network state", | |
35 | .mhandler.cmd = hmp_info_network, | |
36 | }, | |
37 | ||
38 | STEXI | |
39 | @item info network | |
40 | @findex network | |
41 | Show the network state. | |
42 | ETEXI | |
43 | ||
44 | { | |
45 | .name = "chardev", | |
46 | .args_type = "", | |
47 | .params = "", | |
48 | .help = "show the character devices", | |
49 | .mhandler.cmd = hmp_info_chardev, | |
50 | }, | |
51 | ||
52 | STEXI | |
53 | @item info chardev | |
54 | @findex chardev | |
55 | Show the character devices. | |
56 | ETEXI | |
57 | ||
58 | { | |
59 | .name = "block", | |
60 | .args_type = "nodes:-n,verbose:-v,device:B?", | |
61 | .params = "[-n] [-v] [device]", | |
62 | .help = "show info of one block device or all block devices " | |
63 | "(-n: show named nodes; -v: show details)", | |
64 | .mhandler.cmd = hmp_info_block, | |
65 | }, | |
66 | ||
67 | STEXI | |
68 | @item info block | |
69 | @findex block | |
70 | Show info of one block device or all block devices. | |
71 | ETEXI | |
72 | ||
73 | { | |
74 | .name = "blockstats", | |
75 | .args_type = "", | |
76 | .params = "", | |
77 | .help = "show block device statistics", | |
78 | .mhandler.cmd = hmp_info_blockstats, | |
79 | }, | |
80 | ||
81 | STEXI | |
82 | @item info blockstats | |
83 | @findex blockstats | |
84 | Show block device statistics. | |
85 | ETEXI | |
86 | ||
87 | { | |
88 | .name = "block-jobs", | |
89 | .args_type = "", | |
90 | .params = "", | |
91 | .help = "show progress of ongoing block device operations", | |
92 | .mhandler.cmd = hmp_info_block_jobs, | |
93 | }, | |
94 | ||
95 | STEXI | |
96 | @item info block-jobs | |
97 | @findex block-jobs | |
98 | Show progress of ongoing block device operations. | |
99 | ETEXI | |
100 | ||
101 | { | |
102 | .name = "registers", | |
103 | .args_type = "", | |
104 | .params = "", | |
105 | .help = "show the cpu registers", | |
106 | .mhandler.cmd = hmp_info_registers, | |
107 | }, | |
108 | ||
109 | STEXI | |
110 | @item info registers | |
111 | @findex registers | |
112 | Show the cpu registers. | |
1f871d49 PB |
113 | ETEXI |
114 | ||
115 | #if defined(TARGET_I386) | |
116 | { | |
117 | .name = "lapic", | |
118 | .args_type = "", | |
119 | .params = "", | |
120 | .help = "show local apic state", | |
121 | .mhandler.cmd = hmp_info_local_apic, | |
122 | }, | |
123 | #endif | |
124 | ||
125 | STEXI | |
126 | @item info lapic | |
127 | @findex lapic | |
128 | Show local APIC state | |
da76ee76 PB |
129 | ETEXI |
130 | ||
131 | { | |
132 | .name = "cpus", | |
133 | .args_type = "", | |
134 | .params = "", | |
135 | .help = "show infos for each CPU", | |
136 | .mhandler.cmd = hmp_info_cpus, | |
137 | }, | |
138 | ||
139 | STEXI | |
140 | @item info cpus | |
141 | @findex cpus | |
142 | Show infos for each CPU. | |
143 | ETEXI | |
144 | ||
145 | { | |
146 | .name = "history", | |
147 | .args_type = "", | |
148 | .params = "", | |
149 | .help = "show the command line history", | |
150 | .mhandler.cmd = hmp_info_history, | |
151 | }, | |
152 | ||
153 | STEXI | |
154 | @item info history | |
155 | @findex history | |
156 | Show the command line history. | |
157 | ETEXI | |
158 | ||
159 | #if defined(TARGET_I386) || defined(TARGET_PPC) || defined(TARGET_MIPS) || \ | |
160 | defined(TARGET_LM32) || (defined(TARGET_SPARC) && !defined(TARGET_SPARC64)) | |
161 | { | |
162 | .name = "irq", | |
163 | .args_type = "", | |
164 | .params = "", | |
165 | .help = "show the interrupts statistics (if available)", | |
166 | #ifdef TARGET_SPARC | |
167 | .mhandler.cmd = sun4m_hmp_info_irq, | |
168 | #elif defined(TARGET_LM32) | |
169 | .mhandler.cmd = lm32_hmp_info_irq, | |
170 | #else | |
171 | .mhandler.cmd = hmp_info_irq, | |
172 | #endif | |
173 | }, | |
174 | ||
175 | STEXI | |
176 | @item info irq | |
177 | @findex irq | |
178 | Show the interrupts statistics (if available). | |
179 | ETEXI | |
180 | ||
181 | { | |
182 | .name = "pic", | |
183 | .args_type = "", | |
184 | .params = "", | |
185 | .help = "show i8259 (PIC) state", | |
186 | #ifdef TARGET_SPARC | |
187 | .mhandler.cmd = sun4m_hmp_info_pic, | |
188 | #elif defined(TARGET_LM32) | |
189 | .mhandler.cmd = lm32_hmp_info_pic, | |
190 | #else | |
191 | .mhandler.cmd = hmp_info_pic, | |
192 | #endif | |
193 | }, | |
194 | #endif | |
195 | ||
196 | STEXI | |
197 | @item info pic | |
198 | @findex pic | |
199 | Show i8259 (PIC) state. | |
abadcbc8 PB |
200 | ETEXI |
201 | ||
202 | { | |
203 | .name = "pci", | |
204 | .args_type = "", | |
205 | .params = "", | |
206 | .help = "show PCI info", | |
207 | .mhandler.cmd = hmp_info_pci, | |
208 | }, | |
209 | ||
210 | STEXI | |
211 | @item info pci | |
212 | @findex pci | |
213 | Show PCI information. | |
da76ee76 PB |
214 | ETEXI |
215 | ||
216 | #if defined(TARGET_I386) || defined(TARGET_SH4) || defined(TARGET_SPARC) || \ | |
217 | defined(TARGET_PPC) || defined(TARGET_XTENSA) | |
218 | { | |
219 | .name = "tlb", | |
220 | .args_type = "", | |
221 | .params = "", | |
222 | .help = "show virtual to physical memory mappings", | |
223 | .mhandler.cmd = hmp_info_tlb, | |
224 | }, | |
225 | #endif | |
226 | ||
227 | STEXI | |
228 | @item info tlb | |
229 | @findex tlb | |
230 | Show virtual to physical memory mappings. | |
231 | ETEXI | |
232 | ||
233 | #if defined(TARGET_I386) | |
234 | { | |
235 | .name = "mem", | |
236 | .args_type = "", | |
237 | .params = "", | |
238 | .help = "show the active virtual memory mappings", | |
239 | .mhandler.cmd = hmp_info_mem, | |
240 | }, | |
241 | #endif | |
242 | ||
243 | STEXI | |
244 | @item info mem | |
245 | @findex mem | |
246 | Show the active virtual memory mappings. | |
247 | ETEXI | |
248 | ||
249 | { | |
250 | .name = "mtree", | |
251 | .args_type = "", | |
252 | .params = "", | |
253 | .help = "show memory tree", | |
254 | .mhandler.cmd = hmp_info_mtree, | |
255 | }, | |
256 | ||
257 | STEXI | |
258 | @item info mtree | |
259 | @findex mtree | |
260 | Show memory tree. | |
261 | ETEXI | |
262 | ||
263 | { | |
264 | .name = "jit", | |
265 | .args_type = "", | |
266 | .params = "", | |
267 | .help = "show dynamic compiler info", | |
268 | .mhandler.cmd = hmp_info_jit, | |
269 | }, | |
270 | ||
271 | STEXI | |
272 | @item info jit | |
273 | @findex jit | |
274 | Show dynamic compiler info. | |
275 | ETEXI | |
276 | ||
277 | { | |
278 | .name = "opcount", | |
279 | .args_type = "", | |
280 | .params = "", | |
281 | .help = "show dynamic compiler opcode counters", | |
282 | .mhandler.cmd = hmp_info_opcount, | |
283 | }, | |
284 | ||
285 | STEXI | |
286 | @item info opcount | |
287 | @findex opcount | |
288 | Show dynamic compiler opcode counters | |
289 | ETEXI | |
290 | ||
291 | { | |
292 | .name = "kvm", | |
293 | .args_type = "", | |
294 | .params = "", | |
295 | .help = "show KVM information", | |
296 | .mhandler.cmd = hmp_info_kvm, | |
297 | }, | |
298 | ||
299 | STEXI | |
300 | @item info kvm | |
301 | @findex kvm | |
302 | Show KVM information. | |
303 | ETEXI | |
304 | ||
305 | { | |
306 | .name = "numa", | |
307 | .args_type = "", | |
308 | .params = "", | |
309 | .help = "show NUMA information", | |
310 | .mhandler.cmd = hmp_info_numa, | |
311 | }, | |
312 | ||
313 | STEXI | |
314 | @item info numa | |
315 | @findex numa | |
316 | Show NUMA information. | |
317 | ETEXI | |
318 | ||
319 | { | |
320 | .name = "usb", | |
321 | .args_type = "", | |
322 | .params = "", | |
323 | .help = "show guest USB devices", | |
324 | .mhandler.cmd = hmp_info_usb, | |
325 | }, | |
326 | ||
327 | STEXI | |
328 | @item info usb | |
329 | @findex usb | |
330 | Show guest USB devices. | |
331 | ETEXI | |
332 | ||
333 | { | |
334 | .name = "usbhost", | |
335 | .args_type = "", | |
336 | .params = "", | |
337 | .help = "show host USB devices", | |
338 | .mhandler.cmd = hmp_info_usbhost, | |
339 | }, | |
340 | ||
341 | STEXI | |
342 | @item info usbhost | |
343 | @findex usbhost | |
344 | Show host USB devices. | |
345 | ETEXI | |
346 | ||
347 | { | |
348 | .name = "profile", | |
349 | .args_type = "", | |
350 | .params = "", | |
351 | .help = "show profiling information", | |
352 | .mhandler.cmd = hmp_info_profile, | |
353 | }, | |
354 | ||
355 | STEXI | |
356 | @item info profile | |
357 | @findex profile | |
358 | Show profiling information. | |
359 | ETEXI | |
360 | ||
361 | { | |
362 | .name = "capture", | |
363 | .args_type = "", | |
364 | .params = "", | |
365 | .help = "show capture information", | |
366 | .mhandler.cmd = hmp_info_capture, | |
367 | }, | |
368 | ||
369 | STEXI | |
370 | @item info capture | |
371 | @findex capture | |
372 | Show capture information. | |
373 | ETEXI | |
374 | ||
375 | { | |
376 | .name = "snapshots", | |
377 | .args_type = "", | |
378 | .params = "", | |
379 | .help = "show the currently saved VM snapshots", | |
380 | .mhandler.cmd = hmp_info_snapshots, | |
381 | }, | |
382 | ||
383 | STEXI | |
384 | @item info snapshots | |
385 | @findex snapshots | |
386 | Show the currently saved VM snapshots. | |
387 | ETEXI | |
388 | ||
389 | { | |
390 | .name = "status", | |
391 | .args_type = "", | |
392 | .params = "", | |
393 | .help = "show the current VM status (running|paused)", | |
394 | .mhandler.cmd = hmp_info_status, | |
395 | }, | |
396 | ||
397 | STEXI | |
398 | @item info status | |
399 | @findex status | |
400 | Show the current VM status (running|paused). | |
401 | ETEXI | |
402 | ||
403 | { | |
404 | .name = "mice", | |
405 | .args_type = "", | |
406 | .params = "", | |
407 | .help = "show which guest mouse is receiving events", | |
408 | .mhandler.cmd = hmp_info_mice, | |
409 | }, | |
410 | ||
411 | STEXI | |
412 | @item info mice | |
413 | @findex mice | |
414 | Show which guest mouse is receiving events. | |
415 | ETEXI | |
416 | ||
417 | { | |
418 | .name = "vnc", | |
419 | .args_type = "", | |
420 | .params = "", | |
421 | .help = "show the vnc server status", | |
422 | .mhandler.cmd = hmp_info_vnc, | |
423 | }, | |
424 | ||
425 | STEXI | |
426 | @item info vnc | |
427 | @findex vnc | |
428 | Show the vnc server status. | |
429 | ETEXI | |
430 | ||
431 | #if defined(CONFIG_SPICE) | |
432 | { | |
433 | .name = "spice", | |
434 | .args_type = "", | |
435 | .params = "", | |
436 | .help = "show the spice server status", | |
437 | .mhandler.cmd = hmp_info_spice, | |
438 | }, | |
439 | #endif | |
440 | ||
441 | STEXI | |
442 | @item info spice | |
443 | @findex spice | |
444 | Show the spice server status. | |
445 | ETEXI | |
446 | ||
447 | { | |
448 | .name = "name", | |
449 | .args_type = "", | |
450 | .params = "", | |
451 | .help = "show the current VM name", | |
452 | .mhandler.cmd = hmp_info_name, | |
453 | }, | |
454 | ||
455 | STEXI | |
456 | @item info name | |
457 | @findex name | |
458 | Show the current VM name. | |
459 | ETEXI | |
460 | ||
461 | { | |
462 | .name = "uuid", | |
463 | .args_type = "", | |
464 | .params = "", | |
465 | .help = "show the current VM UUID", | |
466 | .mhandler.cmd = hmp_info_uuid, | |
467 | }, | |
468 | ||
469 | STEXI | |
470 | @item info uuid | |
471 | @findex uuid | |
472 | Show the current VM UUID. | |
473 | ETEXI | |
474 | ||
475 | { | |
476 | .name = "cpustats", | |
477 | .args_type = "", | |
478 | .params = "", | |
479 | .help = "show CPU statistics", | |
480 | .mhandler.cmd = hmp_info_cpustats, | |
481 | }, | |
482 | ||
483 | STEXI | |
484 | @item info cpustats | |
485 | @findex cpustats | |
486 | Show CPU statistics. | |
487 | ETEXI | |
488 | ||
489 | #if defined(CONFIG_SLIRP) | |
490 | { | |
491 | .name = "usernet", | |
492 | .args_type = "", | |
493 | .params = "", | |
494 | .help = "show user network stack connection states", | |
495 | .mhandler.cmd = hmp_info_usernet, | |
496 | }, | |
497 | #endif | |
498 | ||
499 | STEXI | |
500 | @item info usernet | |
501 | @findex usernet | |
502 | Show user network stack connection states. | |
503 | ETEXI | |
504 | ||
505 | { | |
506 | .name = "migrate", | |
507 | .args_type = "", | |
508 | .params = "", | |
509 | .help = "show migration status", | |
510 | .mhandler.cmd = hmp_info_migrate, | |
511 | }, | |
512 | ||
513 | STEXI | |
514 | @item info migrate | |
515 | @findex migrate | |
516 | Show migration status. | |
517 | ETEXI | |
518 | ||
519 | { | |
520 | .name = "migrate_capabilities", | |
521 | .args_type = "", | |
522 | .params = "", | |
523 | .help = "show current migration capabilities", | |
524 | .mhandler.cmd = hmp_info_migrate_capabilities, | |
525 | }, | |
526 | ||
527 | STEXI | |
528 | @item info migrate_capabilities | |
529 | @findex migrate_capabilities | |
530 | Show current migration capabilities. | |
531 | ETEXI | |
532 | ||
533 | { | |
534 | .name = "migrate_parameters", | |
535 | .args_type = "", | |
536 | .params = "", | |
537 | .help = "show current migration parameters", | |
538 | .mhandler.cmd = hmp_info_migrate_parameters, | |
539 | }, | |
540 | ||
541 | STEXI | |
542 | @item info migrate_parameters | |
543 | @findex migrate_parameters | |
544 | Show current migration parameters. | |
545 | ETEXI | |
546 | ||
547 | { | |
548 | .name = "migrate_cache_size", | |
549 | .args_type = "", | |
550 | .params = "", | |
551 | .help = "show current migration xbzrle cache size", | |
552 | .mhandler.cmd = hmp_info_migrate_cache_size, | |
553 | }, | |
554 | ||
555 | STEXI | |
556 | @item info migrate_cache_size | |
557 | @findex migrate_cache_size | |
558 | Show current migration xbzrle cache size. | |
559 | ETEXI | |
560 | ||
561 | { | |
562 | .name = "balloon", | |
563 | .args_type = "", | |
564 | .params = "", | |
565 | .help = "show balloon information", | |
566 | .mhandler.cmd = hmp_info_balloon, | |
567 | }, | |
568 | ||
569 | STEXI | |
570 | @item info balloon | |
571 | @findex balloon | |
572 | Show balloon information. | |
573 | ETEXI | |
574 | ||
575 | { | |
576 | .name = "qtree", | |
577 | .args_type = "", | |
578 | .params = "", | |
579 | .help = "show device tree", | |
580 | .mhandler.cmd = hmp_info_qtree, | |
581 | }, | |
582 | ||
583 | STEXI | |
584 | @item info qtree | |
585 | @findex qtree | |
586 | Show device tree. | |
587 | ETEXI | |
588 | ||
589 | { | |
590 | .name = "qdm", | |
591 | .args_type = "", | |
592 | .params = "", | |
593 | .help = "show qdev device model list", | |
594 | .mhandler.cmd = hmp_info_qdm, | |
595 | }, | |
596 | ||
597 | STEXI | |
598 | @item info qdm | |
599 | @findex qdm | |
600 | Show qdev device model list. | |
601 | ETEXI | |
602 | ||
603 | { | |
604 | .name = "qom-tree", | |
605 | .args_type = "path:s?", | |
606 | .params = "[path]", | |
607 | .help = "show QOM composition tree", | |
608 | .mhandler.cmd = hmp_info_qom_tree, | |
609 | }, | |
610 | ||
611 | STEXI | |
612 | @item info qom-tree | |
613 | @findex qom-tree | |
614 | Show QOM composition tree. | |
615 | ETEXI | |
616 | ||
617 | { | |
618 | .name = "roms", | |
619 | .args_type = "", | |
620 | .params = "", | |
621 | .help = "show roms", | |
622 | .mhandler.cmd = hmp_info_roms, | |
623 | }, | |
624 | ||
625 | STEXI | |
626 | @item info roms | |
627 | @findex roms | |
628 | Show roms. | |
629 | ETEXI | |
630 | ||
631 | { | |
632 | .name = "trace-events", | |
633 | .args_type = "", | |
634 | .params = "", | |
635 | .help = "show available trace-events & their state", | |
636 | .mhandler.cmd = hmp_info_trace_events, | |
637 | }, | |
638 | ||
639 | STEXI | |
640 | @item info trace-events | |
641 | @findex trace-events | |
642 | Show available trace-events & their state. | |
643 | ETEXI | |
644 | ||
645 | { | |
646 | .name = "tpm", | |
647 | .args_type = "", | |
648 | .params = "", | |
649 | .help = "show the TPM device", | |
650 | .mhandler.cmd = hmp_info_tpm, | |
651 | }, | |
652 | ||
653 | STEXI | |
654 | @item info tpm | |
655 | @findex tpm | |
656 | Show the TPM device. | |
657 | ETEXI | |
658 | ||
659 | { | |
660 | .name = "memdev", | |
661 | .args_type = "", | |
662 | .params = "", | |
663 | .help = "show memory backends", | |
664 | .mhandler.cmd = hmp_info_memdev, | |
665 | }, | |
666 | ||
667 | STEXI | |
668 | @item info memdev | |
669 | @findex memdev | |
670 | Show memory backends | |
671 | ETEXI | |
672 | ||
673 | { | |
674 | .name = "memory-devices", | |
675 | .args_type = "", | |
676 | .params = "", | |
677 | .help = "show memory devices", | |
678 | .mhandler.cmd = hmp_info_memory_devices, | |
679 | }, | |
680 | ||
681 | STEXI | |
682 | @item info memory-devices | |
683 | @findex memory-devices | |
684 | Show memory devices. | |
685 | ETEXI | |
686 | ||
687 | { | |
688 | .name = "iothreads", | |
689 | .args_type = "", | |
690 | .params = "", | |
691 | .help = "show iothreads", | |
692 | .mhandler.cmd = hmp_info_iothreads, | |
693 | }, | |
694 | ||
695 | STEXI | |
696 | @item info iothreads | |
697 | @findex iothreads | |
698 | Show iothread's identifiers. | |
699 | ETEXI | |
700 | ||
701 | { | |
702 | .name = "rocker", | |
703 | .args_type = "name:s", | |
704 | .params = "name", | |
705 | .help = "Show rocker switch", | |
706 | .mhandler.cmd = hmp_rocker, | |
707 | }, | |
708 | ||
709 | STEXI | |
710 | @item info rocker @var{name} | |
711 | @findex rocker | |
712 | Show rocker switch. | |
713 | ETEXI | |
714 | ||
715 | { | |
716 | .name = "rocker-ports", | |
717 | .args_type = "name:s", | |
718 | .params = "name", | |
719 | .help = "Show rocker ports", | |
720 | .mhandler.cmd = hmp_rocker_ports, | |
721 | }, | |
722 | ||
723 | STEXI | |
724 | @item info rocker_ports @var{name}-ports | |
725 | @findex ocker-ports | |
726 | Show rocker ports. | |
727 | ETEXI | |
728 | ||
729 | { | |
730 | .name = "rocker-of-dpa-flows", | |
731 | .args_type = "name:s,tbl_id:i?", | |
732 | .params = "name [tbl_id]", | |
733 | .help = "Show rocker OF-DPA flow tables", | |
734 | .mhandler.cmd = hmp_rocker_of_dpa_flows, | |
735 | }, | |
736 | ||
737 | STEXI | |
738 | @item info rocker_of_dpa_flows @var{name} [@var{tbl_id}] | |
739 | @findex rocker-of-dpa-flows | |
740 | Show rocker OF-DPA flow tables. | |
741 | ETEXI | |
742 | ||
743 | { | |
744 | .name = "rocker-of-dpa-groups", | |
745 | .args_type = "name:s,type:i?", | |
746 | .params = "name [type]", | |
747 | .help = "Show rocker OF-DPA groups", | |
748 | .mhandler.cmd = hmp_rocker_of_dpa_groups, | |
749 | }, | |
750 | ||
751 | STEXI | |
752 | @item info rocker-of-dpa-groups @var{name} [@var{type}] | |
753 | @findex rocker-of-dpa-groups | |
754 | Show rocker OF-DPA groups. | |
755 | ETEXI | |
756 | ||
757 | #if defined(TARGET_S390X) | |
758 | { | |
759 | .name = "skeys", | |
760 | .args_type = "addr:l", | |
761 | .params = "address", | |
762 | .help = "Display the value of a storage key", | |
763 | .mhandler.cmd = hmp_info_skeys, | |
764 | }, | |
765 | #endif | |
766 | ||
767 | STEXI | |
768 | @item info skeys @var{address} | |
769 | @findex skeys | |
770 | Display the value of a storage key (s390 only) | |
771 | ETEXI | |
772 | ||
773 | STEXI | |
774 | @end table | |
775 | ETEXI | |
2cd8af2d PB |
776 | |
777 | STEXI | |
778 | @end table | |
779 | ETEXI |