jcs.org
qemu with hax to log dma reads & writes
jcs.org/2018/11/12/vfio
docs: Split out sections for the manpage into .rst.inc files
Sphinx doesn't have very good facilities for marking chunks
of documentation as "put this in the manpage only". So instead
we move the parts we want to put into both the HTML manuals
and the manpage into their own .rst.inc files, which we can
include from both the main manual rst files and a new toplevel
rst file that will be the skeleton of the qemu.1 manpage.
In this commit, just split out the parts of the documentation
that go in the manpage.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
Tested-by: Alex Bennée <alex.bennee@linaro.org>
Message-id: 20200228153619.9906-29-peter.maydell@linaro.org
+356
-351
+228
docs/system/device-url-syntax.rst.inc
+228
docs/system/device-url-syntax.rst.inc
···
1
+
2
+
In addition to using normal file images for the emulated storage
3
+
devices, QEMU can also use networked resources such as iSCSI devices.
4
+
These are specified using a special URL syntax.
5
+
6
+
``iSCSI``
7
+
iSCSI support allows QEMU to access iSCSI resources directly and use
8
+
as images for the guest storage. Both disk and cdrom images are
9
+
supported.
10
+
11
+
Syntax for specifying iSCSI LUNs is
12
+
"iscsi://<target-ip>[:<port>]/<target-iqn>/<lun>"
13
+
14
+
By default qemu will use the iSCSI initiator-name
15
+
'iqn.2008-11.org.linux-kvm[:<name>]' but this can also be set from
16
+
the command line or a configuration file.
17
+
18
+
Since version Qemu 2.4 it is possible to specify a iSCSI request
19
+
timeout to detect stalled requests and force a reestablishment of the
20
+
session. The timeout is specified in seconds. The default is 0 which
21
+
means no timeout. Libiscsi 1.15.0 or greater is required for this
22
+
feature.
23
+
24
+
Example (without authentication):
25
+
26
+
.. parsed-literal::
27
+
28
+
|qemu_system| -iscsi initiator-name=iqn.2001-04.com.example:my-initiator \
29
+
-cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \
30
+
-drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1
31
+
32
+
Example (CHAP username/password via URL):
33
+
34
+
.. parsed-literal::
35
+
36
+
|qemu_system| -drive file=iscsi://user%password@192.0.2.1/iqn.2001-04.com.example/1
37
+
38
+
Example (CHAP username/password via environment variables):
39
+
40
+
.. parsed-literal::
41
+
42
+
LIBISCSI_CHAP_USERNAME="user" \
43
+
LIBISCSI_CHAP_PASSWORD="password" \
44
+
|qemu_system| -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1
45
+
46
+
``NBD``
47
+
QEMU supports NBD (Network Block Devices) both using TCP protocol as
48
+
well as Unix Domain Sockets. With TCP, the default port is 10809.
49
+
50
+
Syntax for specifying a NBD device using TCP, in preferred URI form:
51
+
"nbd://<server-ip>[:<port>]/[<export>]"
52
+
53
+
Syntax for specifying a NBD device using Unix Domain Sockets;
54
+
remember that '?' is a shell glob character and may need quoting:
55
+
"nbd+unix:///[<export>]?socket=<domain-socket>"
56
+
57
+
Older syntax that is also recognized:
58
+
"nbd:<server-ip>:<port>[:exportname=<export>]"
59
+
60
+
Syntax for specifying a NBD device using Unix Domain Sockets
61
+
"nbd:unix:<domain-socket>[:exportname=<export>]"
62
+
63
+
Example for TCP
64
+
65
+
.. parsed-literal::
66
+
67
+
|qemu_system| --drive file=nbd:192.0.2.1:30000
68
+
69
+
Example for Unix Domain Sockets
70
+
71
+
.. parsed-literal::
72
+
73
+
|qemu_system| --drive file=nbd:unix:/tmp/nbd-socket
74
+
75
+
``SSH``
76
+
QEMU supports SSH (Secure Shell) access to remote disks.
77
+
78
+
Examples:
79
+
80
+
.. parsed-literal::
81
+
82
+
|qemu_system| -drive file=ssh://user@host/path/to/disk.img
83
+
|qemu_system| -drive file.driver=ssh,file.user=user,file.host=host,file.port=22,file.path=/path/to/disk.img
84
+
85
+
Currently authentication must be done using ssh-agent. Other
86
+
authentication methods may be supported in future.
87
+
88
+
``Sheepdog``
89
+
Sheepdog is a distributed storage system for QEMU. QEMU supports
90
+
using either local sheepdog devices or remote networked devices.
91
+
92
+
Syntax for specifying a sheepdog device
93
+
94
+
::
95
+
96
+
sheepdog[+tcp|+unix]://[host:port]/vdiname[?socket=path][#snapid|#tag]
97
+
98
+
Example
99
+
100
+
.. parsed-literal::
101
+
102
+
|qemu_system| --drive file=sheepdog://192.0.2.1:30000/MyVirtualMachine
103
+
104
+
See also https://sheepdog.github.io/sheepdog/.
105
+
106
+
``GlusterFS``
107
+
GlusterFS is a user space distributed file system. QEMU supports the
108
+
use of GlusterFS volumes for hosting VM disk images using TCP, Unix
109
+
Domain Sockets and RDMA transport protocols.
110
+
111
+
Syntax for specifying a VM disk image on GlusterFS volume is
112
+
113
+
.. parsed-literal::
114
+
115
+
URI:
116
+
gluster[+type]://[host[:port]]/volume/path[?socket=...][,debug=N][,logfile=...]
117
+
118
+
JSON:
119
+
'json:{"driver":"qcow2","file":{"driver":"gluster","volume":"testvol","path":"a.img","debug":N,"logfile":"...",
120
+
"server":[{"type":"tcp","host":"...","port":"..."},
121
+
{"type":"unix","socket":"..."}]}}'
122
+
123
+
Example
124
+
125
+
.. parsed-literal::
126
+
127
+
URI:
128
+
|qemu_system| --drive file=gluster://192.0.2.1/testvol/a.img,
129
+
file.debug=9,file.logfile=/var/log/qemu-gluster.log
130
+
131
+
JSON:
132
+
|qemu_system| 'json:{"driver":"qcow2",
133
+
"file":{"driver":"gluster",
134
+
"volume":"testvol","path":"a.img",
135
+
"debug":9,"logfile":"/var/log/qemu-gluster.log",
136
+
"server":[{"type":"tcp","host":"1.2.3.4","port":24007},
137
+
{"type":"unix","socket":"/var/run/glusterd.socket"}]}}'
138
+
|qemu_system| -drive driver=qcow2,file.driver=gluster,file.volume=testvol,file.path=/path/a.img,
139
+
file.debug=9,file.logfile=/var/log/qemu-gluster.log,
140
+
file.server.0.type=tcp,file.server.0.host=1.2.3.4,file.server.0.port=24007,
141
+
file.server.1.type=unix,file.server.1.socket=/var/run/glusterd.socket
142
+
143
+
See also http://www.gluster.org.
144
+
145
+
``HTTP/HTTPS/FTP/FTPS``
146
+
QEMU supports read-only access to files accessed over http(s) and
147
+
ftp(s).
148
+
149
+
Syntax using a single filename:
150
+
151
+
::
152
+
153
+
<protocol>://[<username>[:<password>]@]<host>/<path>
154
+
155
+
where:
156
+
157
+
``protocol``
158
+
'http', 'https', 'ftp', or 'ftps'.
159
+
160
+
``username``
161
+
Optional username for authentication to the remote server.
162
+
163
+
``password``
164
+
Optional password for authentication to the remote server.
165
+
166
+
``host``
167
+
Address of the remote server.
168
+
169
+
``path``
170
+
Path on the remote server, including any query string.
171
+
172
+
The following options are also supported:
173
+
174
+
``url``
175
+
The full URL when passing options to the driver explicitly.
176
+
177
+
``readahead``
178
+
The amount of data to read ahead with each range request to the
179
+
remote server. This value may optionally have the suffix 'T', 'G',
180
+
'M', 'K', 'k' or 'b'. If it does not have a suffix, it will be
181
+
assumed to be in bytes. The value must be a multiple of 512 bytes.
182
+
It defaults to 256k.
183
+
184
+
``sslverify``
185
+
Whether to verify the remote server's certificate when connecting
186
+
over SSL. It can have the value 'on' or 'off'. It defaults to
187
+
'on'.
188
+
189
+
``cookie``
190
+
Send this cookie (it can also be a list of cookies separated by
191
+
';') with each outgoing request. Only supported when using
192
+
protocols such as HTTP which support cookies, otherwise ignored.
193
+
194
+
``timeout``
195
+
Set the timeout in seconds of the CURL connection. This timeout is
196
+
the time that CURL waits for a response from the remote server to
197
+
get the size of the image to be downloaded. If not set, the
198
+
default timeout of 5 seconds is used.
199
+
200
+
Note that when passing options to qemu explicitly, ``driver`` is the
201
+
value of <protocol>.
202
+
203
+
Example: boot from a remote Fedora 20 live ISO image
204
+
205
+
.. parsed-literal::
206
+
207
+
|qemu_system_x86| --drive media=cdrom,file=https://archives.fedoraproject.org/pub/archive/fedora/linux/releases/20/Live/x86_64/Fedora-Live-Desktop-x86_64-20-1.iso,readonly
208
+
209
+
|qemu_system_x86| --drive media=cdrom,file.driver=http,file.url=http://archives.fedoraproject.org/pub/fedora/linux/releases/20/Live/x86_64/Fedora-Live-Desktop-x86_64-20-1.iso,readonly
210
+
211
+
Example: boot from a remote Fedora 20 cloud image using a local
212
+
overlay for writes, copy-on-read, and a readahead of 64k
213
+
214
+
.. parsed-literal::
215
+
216
+
qemu-img create -f qcow2 -o backing_file='json:{"file.driver":"http",, "file.url":"http://archives.fedoraproject.org/pub/archive/fedora/linux/releases/20/Images/x86_64/Fedora-x86_64-20-20131211.1-sda.qcow2",, "file.readahead":"64k"}' /tmp/Fedora-x86_64-20-20131211.1-sda.qcow2
217
+
218
+
|qemu_system_x86| -drive file=/tmp/Fedora-x86_64-20-20131211.1-sda.qcow2,copy-on-read=on
219
+
220
+
Example: boot from an image stored on a VMware vSphere server with a
221
+
self-signed certificate using a local overlay for writes, a readahead
222
+
of 64k and a timeout of 10 seconds.
223
+
224
+
.. parsed-literal::
225
+
226
+
qemu-img create -f qcow2 -o backing_file='json:{"file.driver":"https",, "file.url":"https://user:password@vsphere.example.com/folder/test/test-flat.vmdk?dcPath=Datacenter&dsName=datastore1",, "file.sslverify":"off",, "file.readahead":"64k",, "file.timeout":10}' /tmp/test.qcow2
227
+
228
+
|qemu_system_x86| -drive file=/tmp/test.qcow2
+1
-227
docs/system/invocation.rst
+1
-227
docs/system/invocation.rst
···
15
15
Device URL Syntax
16
16
~~~~~~~~~~~~~~~~~
17
17
18
-
In addition to using normal file images for the emulated storage
19
-
devices, QEMU can also use networked resources such as iSCSI devices.
20
-
These are specified using a special URL syntax.
21
-
22
-
``iSCSI``
23
-
iSCSI support allows QEMU to access iSCSI resources directly and use
24
-
as images for the guest storage. Both disk and cdrom images are
25
-
supported.
26
-
27
-
Syntax for specifying iSCSI LUNs is
28
-
"iscsi://<target-ip>[:<port>]/<target-iqn>/<lun>"
29
-
30
-
By default qemu will use the iSCSI initiator-name
31
-
'iqn.2008-11.org.linux-kvm[:<name>]' but this can also be set from
32
-
the command line or a configuration file.
33
-
34
-
Since version Qemu 2.4 it is possible to specify a iSCSI request
35
-
timeout to detect stalled requests and force a reestablishment of the
36
-
session. The timeout is specified in seconds. The default is 0 which
37
-
means no timeout. Libiscsi 1.15.0 or greater is required for this
38
-
feature.
39
-
40
-
Example (without authentication):
41
-
42
-
.. parsed-literal::
43
-
44
-
|qemu_system| -iscsi initiator-name=iqn.2001-04.com.example:my-initiator \
45
-
-cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \
46
-
-drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1
47
-
48
-
Example (CHAP username/password via URL):
49
-
50
-
.. parsed-literal::
51
-
52
-
|qemu_system| -drive file=iscsi://user%password@192.0.2.1/iqn.2001-04.com.example/1
53
-
54
-
Example (CHAP username/password via environment variables):
55
-
56
-
.. parsed-literal::
57
-
58
-
LIBISCSI_CHAP_USERNAME="user" \
59
-
LIBISCSI_CHAP_PASSWORD="password" \
60
-
|qemu_system| -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1
61
-
62
-
``NBD``
63
-
QEMU supports NBD (Network Block Devices) both using TCP protocol as
64
-
well as Unix Domain Sockets. With TCP, the default port is 10809.
65
-
66
-
Syntax for specifying a NBD device using TCP, in preferred URI form:
67
-
"nbd://<server-ip>[:<port>]/[<export>]"
68
-
69
-
Syntax for specifying a NBD device using Unix Domain Sockets;
70
-
remember that '?' is a shell glob character and may need quoting:
71
-
"nbd+unix:///[<export>]?socket=<domain-socket>"
72
-
73
-
Older syntax that is also recognized:
74
-
"nbd:<server-ip>:<port>[:exportname=<export>]"
75
-
76
-
Syntax for specifying a NBD device using Unix Domain Sockets
77
-
"nbd:unix:<domain-socket>[:exportname=<export>]"
78
-
79
-
Example for TCP
80
-
81
-
.. parsed-literal::
82
-
83
-
|qemu_system| --drive file=nbd:192.0.2.1:30000
84
-
85
-
Example for Unix Domain Sockets
86
-
87
-
.. parsed-literal::
88
-
89
-
|qemu_system| --drive file=nbd:unix:/tmp/nbd-socket
90
-
91
-
``SSH``
92
-
QEMU supports SSH (Secure Shell) access to remote disks.
93
-
94
-
Examples:
95
-
96
-
.. parsed-literal::
97
-
98
-
|qemu_system| -drive file=ssh://user@host/path/to/disk.img
99
-
|qemu_system| -drive file.driver=ssh,file.user=user,file.host=host,file.port=22,file.path=/path/to/disk.img
100
-
101
-
Currently authentication must be done using ssh-agent. Other
102
-
authentication methods may be supported in future.
103
-
104
-
``Sheepdog``
105
-
Sheepdog is a distributed storage system for QEMU. QEMU supports
106
-
using either local sheepdog devices or remote networked devices.
107
-
108
-
Syntax for specifying a sheepdog device
109
-
110
-
::
111
-
112
-
sheepdog[+tcp|+unix]://[host:port]/vdiname[?socket=path][#snapid|#tag]
113
-
114
-
Example
115
-
116
-
.. parsed-literal::
117
-
118
-
|qemu_system| --drive file=sheepdog://192.0.2.1:30000/MyVirtualMachine
119
-
120
-
See also https://sheepdog.github.io/sheepdog/.
121
-
122
-
``GlusterFS``
123
-
GlusterFS is a user space distributed file system. QEMU supports the
124
-
use of GlusterFS volumes for hosting VM disk images using TCP, Unix
125
-
Domain Sockets and RDMA transport protocols.
126
-
127
-
Syntax for specifying a VM disk image on GlusterFS volume is
128
-
129
-
.. parsed-literal::
130
-
131
-
URI:
132
-
gluster[+type]://[host[:port]]/volume/path[?socket=...][,debug=N][,logfile=...]
133
-
134
-
JSON:
135
-
'json:{"driver":"qcow2","file":{"driver":"gluster","volume":"testvol","path":"a.img","debug":N,"logfile":"...",
136
-
"server":[{"type":"tcp","host":"...","port":"..."},
137
-
{"type":"unix","socket":"..."}]}}'
138
-
139
-
Example
140
-
141
-
.. parsed-literal::
142
-
143
-
URI:
144
-
|qemu_system| --drive file=gluster://192.0.2.1/testvol/a.img,
145
-
file.debug=9,file.logfile=/var/log/qemu-gluster.log
146
-
147
-
JSON:
148
-
|qemu_system| 'json:{"driver":"qcow2",
149
-
"file":{"driver":"gluster",
150
-
"volume":"testvol","path":"a.img",
151
-
"debug":9,"logfile":"/var/log/qemu-gluster.log",
152
-
"server":[{"type":"tcp","host":"1.2.3.4","port":24007},
153
-
{"type":"unix","socket":"/var/run/glusterd.socket"}]}}'
154
-
|qemu_system| -drive driver=qcow2,file.driver=gluster,file.volume=testvol,file.path=/path/a.img,
155
-
file.debug=9,file.logfile=/var/log/qemu-gluster.log,
156
-
file.server.0.type=tcp,file.server.0.host=1.2.3.4,file.server.0.port=24007,
157
-
file.server.1.type=unix,file.server.1.socket=/var/run/glusterd.socket
158
-
159
-
See also http://www.gluster.org.
160
-
161
-
``HTTP/HTTPS/FTP/FTPS``
162
-
QEMU supports read-only access to files accessed over http(s) and
163
-
ftp(s).
164
-
165
-
Syntax using a single filename:
166
-
167
-
::
168
-
169
-
<protocol>://[<username>[:<password>]@]<host>/<path>
170
-
171
-
where:
172
-
173
-
``protocol``
174
-
'http', 'https', 'ftp', or 'ftps'.
175
-
176
-
``username``
177
-
Optional username for authentication to the remote server.
178
-
179
-
``password``
180
-
Optional password for authentication to the remote server.
181
-
182
-
``host``
183
-
Address of the remote server.
184
-
185
-
``path``
186
-
Path on the remote server, including any query string.
187
-
188
-
The following options are also supported:
189
-
190
-
``url``
191
-
The full URL when passing options to the driver explicitly.
192
-
193
-
``readahead``
194
-
The amount of data to read ahead with each range request to the
195
-
remote server. This value may optionally have the suffix 'T', 'G',
196
-
'M', 'K', 'k' or 'b'. If it does not have a suffix, it will be
197
-
assumed to be in bytes. The value must be a multiple of 512 bytes.
198
-
It defaults to 256k.
199
-
200
-
``sslverify``
201
-
Whether to verify the remote server's certificate when connecting
202
-
over SSL. It can have the value 'on' or 'off'. It defaults to
203
-
'on'.
204
-
205
-
``cookie``
206
-
Send this cookie (it can also be a list of cookies separated by
207
-
';') with each outgoing request. Only supported when using
208
-
protocols such as HTTP which support cookies, otherwise ignored.
209
-
210
-
``timeout``
211
-
Set the timeout in seconds of the CURL connection. This timeout is
212
-
the time that CURL waits for a response from the remote server to
213
-
get the size of the image to be downloaded. If not set, the
214
-
default timeout of 5 seconds is used.
215
-
216
-
Note that when passing options to qemu explicitly, ``driver`` is the
217
-
value of <protocol>.
218
-
219
-
Example: boot from a remote Fedora 20 live ISO image
220
-
221
-
.. parsed-literal::
222
-
223
-
|qemu_system_x86| --drive media=cdrom,file=https://archives.fedoraproject.org/pub/archive/fedora/linux/releases/20/Live/x86_64/Fedora-Live-Desktop-x86_64-20-1.iso,readonly
224
-
225
-
|qemu_system_x86| --drive media=cdrom,file.driver=http,file.url=http://archives.fedoraproject.org/pub/fedora/linux/releases/20/Live/x86_64/Fedora-Live-Desktop-x86_64-20-1.iso,readonly
226
-
227
-
Example: boot from a remote Fedora 20 cloud image using a local
228
-
overlay for writes, copy-on-read, and a readahead of 64k
229
-
230
-
.. parsed-literal::
231
-
232
-
qemu-img create -f qcow2 -o backing_file='json:{"file.driver":"http",, "file.url":"http://archives.fedoraproject.org/pub/archive/fedora/linux/releases/20/Images/x86_64/Fedora-x86_64-20-20131211.1-sda.qcow2",, "file.readahead":"64k"}' /tmp/Fedora-x86_64-20-20131211.1-sda.qcow2
233
-
234
-
|qemu_system_x86| -drive file=/tmp/Fedora-x86_64-20-20131211.1-sda.qcow2,copy-on-read=on
235
-
236
-
Example: boot from an image stored on a VMware vSphere server with a
237
-
self-signed certificate using a local overlay for writes, a readahead
238
-
of 64k and a timeout of 10 seconds.
239
-
240
-
.. parsed-literal::
241
-
242
-
qemu-img create -f qcow2 -o backing_file='json:{"file.driver":"https",, "file.url":"https://user:password@vsphere.example.com/folder/test/test-flat.vmdk?dcPath=Datacenter&dsName=datastore1",, "file.sslverify":"off",, "file.readahead":"64k",, "file.timeout":10}' /tmp/test.qcow2
243
-
244
-
|qemu_system_x86| -drive file=/tmp/test.qcow2
18
+
.. include:: device-url-syntax.rst.inc
+1
-35
docs/system/keys.rst
+1
-35
docs/system/keys.rst
···
3
3
Keys in the graphical frontends
4
4
-------------------------------
5
5
6
-
During the graphical emulation, you can use special key combinations to
7
-
change modes. The default key mappings are shown below, but if you use
8
-
``-alt-grab`` then the modifier is Ctrl-Alt-Shift (instead of Ctrl-Alt)
9
-
and if you use ``-ctrl-grab`` then the modifier is the right Ctrl key
10
-
(instead of Ctrl-Alt):
11
-
12
-
Ctrl-Alt-f
13
-
Toggle full screen
14
-
15
-
Ctrl-Alt-+
16
-
Enlarge the screen
17
-
18
-
Ctrl-Alt\--
19
-
Shrink the screen
20
-
21
-
Ctrl-Alt-u
22
-
Restore the screen's un-scaled dimensions
23
-
24
-
Ctrl-Alt-n
25
-
Switch to virtual console 'n'. Standard console mappings are:
26
-
27
-
*1*
28
-
Target system display
29
-
30
-
*2*
31
-
Monitor
32
-
33
-
*3*
34
-
Serial port
35
-
36
-
Ctrl-Alt
37
-
Toggle mouse and keyboard grab.
38
-
39
-
In the virtual consoles, you can use Ctrl-Up, Ctrl-Down, Ctrl-PageUp and
40
-
Ctrl-PageDown to move in the back log.
6
+
.. include:: keys.rst.inc
+35
docs/system/keys.rst.inc
+35
docs/system/keys.rst.inc
···
1
+
During the graphical emulation, you can use special key combinations to
2
+
change modes. The default key mappings are shown below, but if you use
3
+
``-alt-grab`` then the modifier is Ctrl-Alt-Shift (instead of Ctrl-Alt)
4
+
and if you use ``-ctrl-grab`` then the modifier is the right Ctrl key
5
+
(instead of Ctrl-Alt):
6
+
7
+
Ctrl-Alt-f
8
+
Toggle full screen
9
+
10
+
Ctrl-Alt-+
11
+
Enlarge the screen
12
+
13
+
Ctrl-Alt\--
14
+
Shrink the screen
15
+
16
+
Ctrl-Alt-u
17
+
Restore the screen's un-scaled dimensions
18
+
19
+
Ctrl-Alt-n
20
+
Switch to virtual console 'n'. Standard console mappings are:
21
+
22
+
*1*
23
+
Target system display
24
+
25
+
*2*
26
+
Monitor
27
+
28
+
*3*
29
+
Serial port
30
+
31
+
Ctrl-Alt
32
+
Toggle mouse and keyboard grab.
33
+
34
+
In the virtual consoles, you can use Ctrl-Up, Ctrl-Down, Ctrl-PageUp and
35
+
Ctrl-PageDown to move in the back log.
+1
-27
docs/system/mux-chardev.rst
+1
-27
docs/system/mux-chardev.rst
···
3
3
Keys in the character backend multiplexer
4
4
-----------------------------------------
5
5
6
-
During emulation, if you are using a character backend multiplexer
7
-
(which is the default if you are using ``-nographic``) then several
8
-
commands are available via an escape sequence. These key sequences all
9
-
start with an escape character, which is Ctrl-a by default, but can be
10
-
changed with ``-echr``. The list below assumes you're using the default.
11
-
12
-
Ctrl-a h
13
-
Print this help
14
-
15
-
Ctrl-a x
16
-
Exit emulator
17
-
18
-
Ctrl-a s
19
-
Save disk data back to file (if -snapshot)
20
-
21
-
Ctrl-a t
22
-
Toggle console timestamps
23
-
24
-
Ctrl-a b
25
-
Send break (magic sysrq in Linux)
26
-
27
-
Ctrl-a c
28
-
Rotate between the frontends connected to the multiplexer (usually
29
-
this switches between the monitor and the console)
30
-
31
-
Ctrl-a Ctrl-a
32
-
Send the escape character to the frontend
6
+
.. include:: mux-chardev.rst.inc
+27
docs/system/mux-chardev.rst.inc
+27
docs/system/mux-chardev.rst.inc
···
1
+
During emulation, if you are using a character backend multiplexer
2
+
(which is the default if you are using ``-nographic``) then several
3
+
commands are available via an escape sequence. These key sequences all
4
+
start with an escape character, which is Ctrl-a by default, but can be
5
+
changed with ``-echr``. The list below assumes you're using the default.
6
+
7
+
Ctrl-a h
8
+
Print this help
9
+
10
+
Ctrl-a x
11
+
Exit emulator
12
+
13
+
Ctrl-a s
14
+
Save disk data back to file (if -snapshot)
15
+
16
+
Ctrl-a t
17
+
Toggle console timestamps
18
+
19
+
Ctrl-a b
20
+
Send break (magic sysrq in Linux)
21
+
22
+
Ctrl-a c
23
+
Rotate between the frontends connected to the multiplexer (usually
24
+
this switches between the monitor and the console)
25
+
26
+
Ctrl-a Ctrl-a
27
+
Send the escape character to the frontend
+62
docs/system/target-i386-desc.rst.inc
+62
docs/system/target-i386-desc.rst.inc
···
1
+
The QEMU PC System emulator simulates the following peripherals:
2
+
3
+
- i440FX host PCI bridge and PIIX3 PCI to ISA bridge
4
+
5
+
- Cirrus CLGD 5446 PCI VGA card or dummy VGA card with Bochs VESA
6
+
extensions (hardware level, including all non standard modes).
7
+
8
+
- PS/2 mouse and keyboard
9
+
10
+
- 2 PCI IDE interfaces with hard disk and CD-ROM support
11
+
12
+
- Floppy disk
13
+
14
+
- PCI and ISA network adapters
15
+
16
+
- Serial ports
17
+
18
+
- IPMI BMC, either and internal or external one
19
+
20
+
- Creative SoundBlaster 16 sound card
21
+
22
+
- ENSONIQ AudioPCI ES1370 sound card
23
+
24
+
- Intel 82801AA AC97 Audio compatible sound card
25
+
26
+
- Intel HD Audio Controller and HDA codec
27
+
28
+
- Adlib (OPL2) - Yamaha YM3812 compatible chip
29
+
30
+
- Gravis Ultrasound GF1 sound card
31
+
32
+
- CS4231A compatible sound card
33
+
34
+
- PCI UHCI, OHCI, EHCI or XHCI USB controller and a virtual USB-1.1
35
+
hub.
36
+
37
+
SMP is supported with up to 255 CPUs.
38
+
39
+
QEMU uses the PC BIOS from the Seabios project and the Plex86/Bochs LGPL
40
+
VGA BIOS.
41
+
42
+
QEMU uses YM3812 emulation by Tatsuyuki Satoh.
43
+
44
+
QEMU uses GUS emulation (GUSEMU32 http://www.deinmeister.de/gusemu/) by
45
+
Tibor \"TS\" Schütz.
46
+
47
+
Note that, by default, GUS shares IRQ(7) with parallel ports and so QEMU
48
+
must be told to not have parallel ports to have working GUS.
49
+
50
+
.. parsed-literal::
51
+
52
+
|qemu_system_x86| dos.img -soundhw gus -parallel none
53
+
54
+
Alternatively:
55
+
56
+
.. parsed-literal::
57
+
58
+
|qemu_system_x86| dos.img -device gus,irq=5
59
+
60
+
Or some other unclaimed IRQ.
61
+
62
+
CS4231A is the chip used in Windows Sound System and GUSMAX products
+1
-62
docs/system/target-i386.rst
+1
-62
docs/system/target-i386.rst
···
8
8
Peripherals
9
9
~~~~~~~~~~~
10
10
11
-
The QEMU PC System emulator simulates the following peripherals:
12
-
13
-
- i440FX host PCI bridge and PIIX3 PCI to ISA bridge
14
-
15
-
- Cirrus CLGD 5446 PCI VGA card or dummy VGA card with Bochs VESA
16
-
extensions (hardware level, including all non standard modes).
17
-
18
-
- PS/2 mouse and keyboard
19
-
20
-
- 2 PCI IDE interfaces with hard disk and CD-ROM support
21
-
22
-
- Floppy disk
23
-
24
-
- PCI and ISA network adapters
25
-
26
-
- Serial ports
27
-
28
-
- IPMI BMC, either and internal or external one
29
-
30
-
- Creative SoundBlaster 16 sound card
31
-
32
-
- ENSONIQ AudioPCI ES1370 sound card
33
-
34
-
- Intel 82801AA AC97 Audio compatible sound card
35
-
36
-
- Intel HD Audio Controller and HDA codec
37
-
38
-
- Adlib (OPL2) - Yamaha YM3812 compatible chip
39
-
40
-
- Gravis Ultrasound GF1 sound card
41
-
42
-
- CS4231A compatible sound card
43
-
44
-
- PCI UHCI, OHCI, EHCI or XHCI USB controller and a virtual USB-1.1
45
-
hub.
46
-
47
-
SMP is supported with up to 255 CPUs.
48
-
49
-
QEMU uses the PC BIOS from the Seabios project and the Plex86/Bochs LGPL
50
-
VGA BIOS.
51
-
52
-
QEMU uses YM3812 emulation by Tatsuyuki Satoh.
53
-
54
-
QEMU uses GUS emulation (GUSEMU32 http://www.deinmeister.de/gusemu/) by
55
-
Tibor \"TS\" Schütz.
56
-
57
-
Note that, by default, GUS shares IRQ(7) with parallel ports and so QEMU
58
-
must be told to not have parallel ports to have working GUS.
59
-
60
-
.. parsed-literal::
61
-
62
-
|qemu_system_x86| dos.img -soundhw gus -parallel none
63
-
64
-
Alternatively:
65
-
66
-
.. parsed-literal::
67
-
68
-
|qemu_system_x86| dos.img -device gus,irq=5
69
-
70
-
Or some other unclaimed IRQ.
71
-
72
-
CS4231A is the chip used in Windows Sound System and GUSMAX products
11
+
.. include:: target-i386-desc.rst.inc
73
12
74
13
.. include:: cpu-models-x86.rst.inc
75
14