|
3 | 3 | ##
|
4 | 4 | # = Introduction
|
5 | 5 | #
|
6 |
| -# This document describes all commands currently supported by QMP. |
| 6 | +# This manual describes the commands and events supported by the QEMU |
| 7 | +# Monitor Protocol (QMP). |
7 | 8 | #
|
8 | 9 | # For locating a particular item, please see the `qapi-qmp-index`.
|
9 | 10 | #
|
10 |
| -# Most of the time their usage is exactly the same as in the user |
11 |
| -# Monitor, this means that any other document which also describe |
12 |
| -# commands (the manpage, QEMU's manual, etc) can and should be |
13 |
| -# consulted. |
14 |
| -# |
15 |
| -# QMP has two types of commands: regular and query commands. Regular |
16 |
| -# commands usually change the Virtual Machine's state someway, while |
17 |
| -# query commands just return information. The sections below are |
18 |
| -# divided accordingly. |
19 |
| -# |
20 |
| -# It's important to observe that all communication examples are |
21 |
| -# formatted in a reader-friendly way, so that they're easier to |
22 |
| -# understand. However, in real protocol usage, they're emitted as a |
23 |
| -# single line. |
24 |
| -# |
25 |
| -# Also, the following notation is used to denote data flow: |
26 |
| -# |
27 |
| -# Example: |
| 11 | +# The following notation is used in examples: |
28 | 12 | #
|
29 | 13 | # .. qmp-example::
|
30 | 14 | #
|
31 | 15 | # -> ... text sent by client (commands) ...
|
32 | 16 | # <- ... text sent by server (command responses and events) ...
|
33 | 17 | #
|
| 18 | +# Example text is formatted for readability. However, in real |
| 19 | +# protocol usage, its commonly emitted as a single line. |
| 20 | +# |
34 | 21 | # Please refer to the
|
35 | 22 | # :doc:`QEMU Machine Protocol Specification </interop/qmp-spec>`
|
36 |
| -# for detailed information on the Server command and response formats. |
| 23 | +# for the general format of commands, responses, and events. |
37 | 24 | ##
|
38 | 25 |
|
39 | 26 | { 'include': 'pragma.json' }
|
|
0 commit comments