Statistics
| Branch: | Revision:

root / qemu-doc.texi @ c1713132

History | View | Annotate | Download (62.2 kB)

1 386405f7 bellard
\input texinfo @c -*- texinfo -*-
2 debc7065 bellard
@c %**start of header
3 debc7065 bellard
@setfilename qemu-doc.info
4 8f40c388 bellard
@settitle QEMU Emulator User Documentation
5 debc7065 bellard
@exampleindent 0
6 debc7065 bellard
@paragraphindent 0
7 debc7065 bellard
@c %**end of header
8 386405f7 bellard
9 0806e3f6 bellard
@iftex
10 386405f7 bellard
@titlepage
11 386405f7 bellard
@sp 7
12 8f40c388 bellard
@center @titlefont{QEMU Emulator}
13 debc7065 bellard
@sp 1
14 debc7065 bellard
@center @titlefont{User Documentation}
15 386405f7 bellard
@sp 3
16 386405f7 bellard
@end titlepage
17 0806e3f6 bellard
@end iftex
18 386405f7 bellard
19 debc7065 bellard
@ifnottex
20 debc7065 bellard
@node Top
21 debc7065 bellard
@top
22 debc7065 bellard
23 debc7065 bellard
@menu
24 debc7065 bellard
* Introduction::
25 debc7065 bellard
* Installation::
26 debc7065 bellard
* QEMU PC System emulator::
27 debc7065 bellard
* QEMU System emulator for non PC targets::
28 83195237 bellard
* QEMU User space emulator::
29 debc7065 bellard
* compilation:: Compilation from the sources
30 debc7065 bellard
* Index::
31 debc7065 bellard
@end menu
32 debc7065 bellard
@end ifnottex
33 debc7065 bellard
34 debc7065 bellard
@contents
35 debc7065 bellard
36 debc7065 bellard
@node Introduction
37 386405f7 bellard
@chapter Introduction
38 386405f7 bellard
39 debc7065 bellard
@menu
40 debc7065 bellard
* intro_features:: Features
41 debc7065 bellard
@end menu
42 debc7065 bellard
43 debc7065 bellard
@node intro_features
44 322d0c66 bellard
@section Features
45 386405f7 bellard
46 1f673135 bellard
QEMU is a FAST! processor emulator using dynamic translation to
47 1f673135 bellard
achieve good emulation speed.
48 1eb20527 bellard
49 1eb20527 bellard
QEMU has two operating modes:
50 0806e3f6 bellard
51 0806e3f6 bellard
@itemize @minus
52 0806e3f6 bellard
53 0806e3f6 bellard
@item 
54 1f673135 bellard
Full system emulation. In this mode, QEMU emulates a full system (for
55 3f9f3aa1 bellard
example a PC), including one or several processors and various
56 3f9f3aa1 bellard
peripherals. It can be used to launch different Operating Systems
57 3f9f3aa1 bellard
without rebooting the PC or to debug system code.
58 1eb20527 bellard
59 0806e3f6 bellard
@item 
60 83195237 bellard
User mode emulation. In this mode, QEMU can launch
61 83195237 bellard
processes compiled for one CPU on another CPU. It can be used to
62 1f673135 bellard
launch the Wine Windows API emulator (@url{http://www.winehq.org}) or
63 1f673135 bellard
to ease cross-compilation and cross-debugging.
64 1eb20527 bellard
65 1eb20527 bellard
@end itemize
66 1eb20527 bellard
67 7c3fc84d bellard
QEMU can run without an host kernel driver and yet gives acceptable
68 6f2f2b24 bellard
performance. 
69 322d0c66 bellard
70 52c00a5f bellard
For system emulation, the following hardware targets are supported:
71 52c00a5f bellard
@itemize
72 9d0a8e6f bellard
@item PC (x86 or x86_64 processor)
73 3f9f3aa1 bellard
@item ISA PC (old style PC without PCI bus)
74 52c00a5f bellard
@item PREP (PowerPC processor)
75 9d0a8e6f bellard
@item G3 BW PowerMac (PowerPC processor)
76 9d0a8e6f bellard
@item Mac99 PowerMac (PowerPC processor, in progress)
77 3475187d bellard
@item Sun4m (32-bit Sparc processor)
78 3475187d bellard
@item Sun4u (64-bit Sparc processor, in progress)
79 3f9f3aa1 bellard
@item Malta board (32-bit MIPS processor)
80 ed96ca35 pbrook
@item ARM Integrator/CP (ARM926E or 1026E processor)
81 00a9bf19 pbrook
@item ARM Versatile baseboard (ARM926E)
82 d7739d75 pbrook
@item ARM RealView Emulation baseboard (ARM926EJ-S)
83 52c00a5f bellard
@end itemize
84 386405f7 bellard
85 e6e5906b pbrook
For user emulation, x86, PowerPC, ARM, MIPS, Sparc32/64 and ColdFire(m68k) CPUs are supported.
86 0806e3f6 bellard
87 debc7065 bellard
@node Installation
88 5b9f457a bellard
@chapter Installation
89 5b9f457a bellard
90 15a34c63 bellard
If you want to compile QEMU yourself, see @ref{compilation}.
91 15a34c63 bellard
92 debc7065 bellard
@menu
93 debc7065 bellard
* install_linux::   Linux
94 debc7065 bellard
* install_windows:: Windows
95 debc7065 bellard
* install_mac::     Macintosh
96 debc7065 bellard
@end menu
97 debc7065 bellard
98 debc7065 bellard
@node install_linux
99 1f673135 bellard
@section Linux
100 1f673135 bellard
101 7c3fc84d bellard
If a precompiled package is available for your distribution - you just
102 7c3fc84d bellard
have to install it. Otherwise, see @ref{compilation}.
103 5b9f457a bellard
104 debc7065 bellard
@node install_windows
105 1f673135 bellard
@section Windows
106 8cd0ac2f bellard
107 15a34c63 bellard
Download the experimental binary installer at
108 debc7065 bellard
@url{http://www.free.oszoo.org/@/download.html}.
109 d691f669 bellard
110 debc7065 bellard
@node install_mac
111 1f673135 bellard
@section Mac OS X
112 d691f669 bellard
113 15a34c63 bellard
Download the experimental binary installer at
114 debc7065 bellard
@url{http://www.free.oszoo.org/@/download.html}.
115 df0f11a0 bellard
116 debc7065 bellard
@node QEMU PC System emulator
117 3f9f3aa1 bellard
@chapter QEMU PC System emulator
118 1eb20527 bellard
119 debc7065 bellard
@menu
120 debc7065 bellard
* pcsys_introduction:: Introduction
121 debc7065 bellard
* pcsys_quickstart::   Quick Start
122 debc7065 bellard
* sec_invocation::     Invocation
123 debc7065 bellard
* pcsys_keys::         Keys
124 debc7065 bellard
* pcsys_monitor::      QEMU Monitor
125 debc7065 bellard
* disk_images::        Disk Images
126 debc7065 bellard
* pcsys_network::      Network emulation
127 debc7065 bellard
* direct_linux_boot::  Direct Linux Boot
128 debc7065 bellard
* pcsys_usb::          USB emulation
129 debc7065 bellard
* gdb_usage::          GDB usage
130 debc7065 bellard
* pcsys_os_specific::  Target OS specific information
131 debc7065 bellard
@end menu
132 debc7065 bellard
133 debc7065 bellard
@node pcsys_introduction
134 0806e3f6 bellard
@section Introduction
135 0806e3f6 bellard
136 0806e3f6 bellard
@c man begin DESCRIPTION
137 0806e3f6 bellard
138 3f9f3aa1 bellard
The QEMU PC System emulator simulates the
139 3f9f3aa1 bellard
following peripherals:
140 0806e3f6 bellard
141 0806e3f6 bellard
@itemize @minus
142 15a34c63 bellard
@item 
143 15a34c63 bellard
i440FX host PCI bridge and PIIX3 PCI to ISA bridge
144 0806e3f6 bellard
@item
145 15a34c63 bellard
Cirrus CLGD 5446 PCI VGA card or dummy VGA card with Bochs VESA
146 15a34c63 bellard
extensions (hardware level, including all non standard modes).
147 0806e3f6 bellard
@item
148 0806e3f6 bellard
PS/2 mouse and keyboard
149 0806e3f6 bellard
@item 
150 15a34c63 bellard
2 PCI IDE interfaces with hard disk and CD-ROM support
151 1f673135 bellard
@item
152 1f673135 bellard
Floppy disk
153 0806e3f6 bellard
@item 
154 15a34c63 bellard
NE2000 PCI network adapters
155 0806e3f6 bellard
@item
156 05d5818c bellard
Serial ports
157 05d5818c bellard
@item
158 c0fe3827 bellard
Creative SoundBlaster 16 sound card
159 c0fe3827 bellard
@item
160 c0fe3827 bellard
ENSONIQ AudioPCI ES1370 sound card
161 c0fe3827 bellard
@item
162 c0fe3827 bellard
Adlib(OPL2) - Yamaha YM3812 compatible chip
163 b389dbfb bellard
@item
164 b389dbfb bellard
PCI UHCI USB controller and a virtual USB hub.
165 0806e3f6 bellard
@end itemize
166 0806e3f6 bellard
167 3f9f3aa1 bellard
SMP is supported with up to 255 CPUs.
168 3f9f3aa1 bellard
169 c0fe3827 bellard
Note that adlib is only available when QEMU was configured with
170 c0fe3827 bellard
-enable-adlib
171 c0fe3827 bellard
172 15a34c63 bellard
QEMU uses the PC BIOS from the Bochs project and the Plex86/Bochs LGPL
173 15a34c63 bellard
VGA BIOS.
174 15a34c63 bellard
175 c0fe3827 bellard
QEMU uses YM3812 emulation by Tatsuyuki Satoh.
176 c0fe3827 bellard
177 0806e3f6 bellard
@c man end
178 0806e3f6 bellard
179 debc7065 bellard
@node pcsys_quickstart
180 1eb20527 bellard
@section Quick Start
181 1eb20527 bellard
182 285dc330 bellard
Download and uncompress the linux image (@file{linux.img}) and type:
183 0806e3f6 bellard
184 0806e3f6 bellard
@example
185 285dc330 bellard
qemu linux.img
186 0806e3f6 bellard
@end example
187 0806e3f6 bellard
188 0806e3f6 bellard
Linux should boot and give you a prompt.
189 0806e3f6 bellard
190 6cc721cf bellard
@node sec_invocation
191 ec410fc9 bellard
@section Invocation
192 ec410fc9 bellard
193 ec410fc9 bellard
@example
194 0806e3f6 bellard
@c man begin SYNOPSIS
195 0806e3f6 bellard
usage: qemu [options] [disk_image]
196 0806e3f6 bellard
@c man end
197 ec410fc9 bellard
@end example
198 ec410fc9 bellard
199 0806e3f6 bellard
@c man begin OPTIONS
200 9d4520d0 bellard
@var{disk_image} is a raw hard disk image for IDE hard disk 0.
201 ec410fc9 bellard
202 ec410fc9 bellard
General options:
203 ec410fc9 bellard
@table @option
204 3dbbdc25 bellard
@item -M machine
205 3dbbdc25 bellard
Select the emulated machine (@code{-M ?} for list)
206 3dbbdc25 bellard
207 2be3bc02 bellard
@item -fda file
208 2be3bc02 bellard
@item -fdb file
209 debc7065 bellard
Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can
210 19cb3738 bellard
use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}).
211 2be3bc02 bellard
212 ec410fc9 bellard
@item -hda file
213 ec410fc9 bellard
@item -hdb file
214 181f1558 bellard
@item -hdc file
215 181f1558 bellard
@item -hdd file
216 debc7065 bellard
Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
217 1f47a922 bellard
218 181f1558 bellard
@item -cdrom file
219 181f1558 bellard
Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and and
220 be3edd95 bellard
@option{-cdrom} at the same time). You can use the host CD-ROM by
221 19cb3738 bellard
using @file{/dev/cdrom} as filename (@pxref{host_drives}).
222 181f1558 bellard
223 eec85c2a ths
@item -boot [a|c|d|n]
224 eec85c2a ths
Boot on floppy (a), hard disk (c), CD-ROM (d), or Etherboot (n). Hard disk boot
225 eec85c2a ths
is the default.
226 1f47a922 bellard
227 181f1558 bellard
@item -snapshot
228 1f47a922 bellard
Write to temporary files instead of disk image files. In this case,
229 1f47a922 bellard
the raw disk image you use is not written back. You can however force
230 42550fde ths
the write back by pressing @key{C-a s} (@pxref{disk_images}).
231 ec410fc9 bellard
232 52ca8d6a bellard
@item -no-fd-bootchk
233 52ca8d6a bellard
Disable boot signature checking for floppy disks in Bochs BIOS. It may
234 52ca8d6a bellard
be needed to boot from old floppy disks.
235 52ca8d6a bellard
236 ec410fc9 bellard
@item -m megs
237 15a34c63 bellard
Set virtual RAM size to @var{megs} megabytes. Default is 128 MB.
238 ec410fc9 bellard
239 3f9f3aa1 bellard
@item -smp n
240 3f9f3aa1 bellard
Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
241 3f9f3aa1 bellard
CPUs are supported.
242 3f9f3aa1 bellard
243 0806e3f6 bellard
@item -nographic
244 0806e3f6 bellard
245 0806e3f6 bellard
Normally, QEMU uses SDL to display the VGA output. With this option,
246 0806e3f6 bellard
you can totally disable graphical output so that QEMU is a simple
247 0806e3f6 bellard
command line application. The emulated serial port is redirected on
248 0806e3f6 bellard
the console. Therefore, you can still use QEMU to debug a Linux kernel
249 0806e3f6 bellard
with a serial console.
250 0806e3f6 bellard
251 5f189496 ths
@item -no-frame
252 5f189496 ths
253 5f189496 ths
Do not use decorations for SDL windows and start them using the whole
254 5f189496 ths
available screen space. This makes the using QEMU in a dedicated desktop
255 5f189496 ths
workspace more convenient.
256 5f189496 ths
257 73fc9742 ths
@item -vnc display
258 24236869 bellard
259 24236869 bellard
Normally, QEMU uses SDL to display the VGA output.  With this option,
260 73fc9742 ths
you can have QEMU listen on VNC display @var{display} and redirect the VGA
261 3c656346 bellard
display over the VNC session.  It is very useful to enable the usb
262 3c656346 bellard
tablet device when using this option (option @option{-usbdevice
263 3c656346 bellard
tablet}). When using the VNC display, you must use the @option{-k}
264 73fc9742 ths
option to set the keyboard layout if you are not using en-us.
265 73fc9742 ths
266 73fc9742 ths
@var{display} may be in the form @var{interface:d}, in which case connections
267 73fc9742 ths
will only be allowed from @var{interface} on display @var{d}. Optionally,
268 73fc9742 ths
@var{interface} can be omitted.  @var{display} can also be in the form
269 73fc9742 ths
@var{unix:path} where @var{path} is the location of a unix socket to listen for
270 73fc9742 ths
connections on.
271 73fc9742 ths
272 24236869 bellard
273 3d11d0eb bellard
@item -k language
274 3d11d0eb bellard
275 3d11d0eb bellard
Use keyboard layout @var{language} (for example @code{fr} for
276 3d11d0eb bellard
French). This option is only needed where it is not easy to get raw PC
277 3c656346 bellard
keycodes (e.g. on Macs, with some X11 servers or with a VNC
278 3c656346 bellard
display). You don't normally need to use it on PC/Linux or PC/Windows
279 3c656346 bellard
hosts.
280 3d11d0eb bellard
281 3d11d0eb bellard
The available layouts are:
282 3d11d0eb bellard
@example
283 3d11d0eb bellard
ar  de-ch  es  fo     fr-ca  hu  ja  mk     no  pt-br  sv
284 3d11d0eb bellard
da  en-gb  et  fr     fr-ch  is  lt  nl     pl  ru     th
285 3d11d0eb bellard
de  en-us  fi  fr-be  hr     it  lv  nl-be  pt  sl     tr
286 3d11d0eb bellard
@end example
287 3d11d0eb bellard
288 3d11d0eb bellard
The default is @code{en-us}.
289 3d11d0eb bellard
290 1d14ffa9 bellard
@item -audio-help
291 1d14ffa9 bellard
292 1d14ffa9 bellard
Will show the audio subsystem help: list of drivers, tunable
293 1d14ffa9 bellard
parameters.
294 1d14ffa9 bellard
295 6a36d84e bellard
@item -soundhw card1,card2,... or -soundhw all
296 1d14ffa9 bellard
297 1d14ffa9 bellard
Enable audio and selected sound hardware. Use ? to print all
298 1d14ffa9 bellard
available sound hardware.
299 1d14ffa9 bellard
300 1d14ffa9 bellard
@example
301 1d14ffa9 bellard
qemu -soundhw sb16,adlib hda
302 1d14ffa9 bellard
qemu -soundhw es1370 hda
303 6a36d84e bellard
qemu -soundhw all hda
304 1d14ffa9 bellard
qemu -soundhw ?
305 1d14ffa9 bellard
@end example
306 a8c490cd bellard
307 15a34c63 bellard
@item -localtime
308 15a34c63 bellard
Set the real time clock to local time (the default is to UTC
309 15a34c63 bellard
time). This option is needed to have correct date in MS-DOS or
310 15a34c63 bellard
Windows.
311 15a34c63 bellard
312 d63d307f bellard
@item -full-screen
313 d63d307f bellard
Start in full screen.
314 d63d307f bellard
315 f7cce898 bellard
@item -pidfile file
316 f7cce898 bellard
Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
317 f7cce898 bellard
from a script.
318 f7cce898 bellard
319 71e3ceb8 ths
@item -daemonize
320 71e3ceb8 ths
Daemonize the QEMU process after initialization.  QEMU will not detach from
321 71e3ceb8 ths
standard IO until it is ready to receive connections on any of its devices.
322 71e3ceb8 ths
This option is a useful way for external programs to launch QEMU without having
323 71e3ceb8 ths
to cope with initialization race conditions.
324 71e3ceb8 ths
325 9d0a8e6f bellard
@item -win2k-hack
326 9d0a8e6f bellard
Use it when installing Windows 2000 to avoid a disk full bug. After
327 9d0a8e6f bellard
Windows 2000 is installed, you no longer need this option (this option
328 9d0a8e6f bellard
slows down the IDE transfers).
329 9d0a8e6f bellard
330 9ae02555 ths
@item -option-rom file
331 9ae02555 ths
Load the contents of file as an option ROM.  This option is useful to load
332 9ae02555 ths
things like EtherBoot.
333 9ae02555 ths
334 c35734b2 ths
@item -name string
335 c35734b2 ths
Sets the name of the guest.  This name will be display in the SDL window
336 c35734b2 ths
caption.  The name will also be used for the VNC server.
337 c35734b2 ths
338 0806e3f6 bellard
@end table
339 0806e3f6 bellard
340 b389dbfb bellard
USB options:
341 b389dbfb bellard
@table @option
342 b389dbfb bellard
343 b389dbfb bellard
@item -usb
344 b389dbfb bellard
Enable the USB driver (will be the default soon)
345 b389dbfb bellard
346 b389dbfb bellard
@item -usbdevice devname
347 0aff66b5 pbrook
Add the USB device @var{devname}. @xref{usb_devices}.
348 b389dbfb bellard
@end table
349 b389dbfb bellard
350 1f673135 bellard
Network options:
351 1f673135 bellard
352 1f673135 bellard
@table @option
353 1f673135 bellard
354 a41b2ff2 pbrook
@item -net nic[,vlan=n][,macaddr=addr][,model=type]
355 41d03949 bellard
Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
356 41d03949 bellard
= 0 is the default). The NIC is currently an NE2000 on the PC
357 41d03949 bellard
target. Optionally, the MAC address can be changed. If no
358 41d03949 bellard
@option{-net} option is specified, a single NIC is created.
359 a41b2ff2 pbrook
Qemu can emulate several different models of network card.  Valid values for
360 a41b2ff2 pbrook
@var{type} are @code{ne2k_pci}, @code{ne2k_isa}, @code{rtl8139},
361 a41b2ff2 pbrook
@code{smc91c111} and @code{lance}.  Not all devices are supported on all
362 a41b2ff2 pbrook
targets.
363 41d03949 bellard
364 115defd1 pbrook
@item -net user[,vlan=n][,hostname=name]
365 7e89463d bellard
Use the user mode network stack which requires no administrator
366 a03a6053 pbrook
priviledge to run.  @option{hostname=name} can be used to specify the client
367 115defd1 pbrook
hostname reported by the builtin DHCP server.
368 41d03949 bellard
369 41d03949 bellard
@item -net tap[,vlan=n][,fd=h][,ifname=name][,script=file]
370 41d03949 bellard
Connect the host TAP network interface @var{name} to VLAN @var{n} and
371 41d03949 bellard
use the network script @var{file} to configure it. The default
372 6a1cbf68 ths
network script is @file{/etc/qemu-ifup}. Use @option{script=no} to
373 6a1cbf68 ths
disable script execution. If @var{name} is not
374 41d03949 bellard
provided, the OS automatically provides one.  @option{fd=h} can be
375 41d03949 bellard
used to specify the handle of an already opened host TAP interface. Example:
376 1f673135 bellard
377 41d03949 bellard
@example
378 41d03949 bellard
qemu linux.img -net nic -net tap
379 41d03949 bellard
@end example
380 41d03949 bellard
381 41d03949 bellard
More complicated example (two NICs, each one connected to a TAP device)
382 41d03949 bellard
@example
383 41d03949 bellard
qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
384 41d03949 bellard
               -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
385 41d03949 bellard
@end example
386 3f1a88f4 bellard
387 3f1a88f4 bellard
388 41d03949 bellard
@item -net socket[,vlan=n][,fd=h][,listen=[host]:port][,connect=host:port]
389 1f673135 bellard
390 41d03949 bellard
Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
391 41d03949 bellard
machine using a TCP socket connection. If @option{listen} is
392 41d03949 bellard
specified, QEMU waits for incoming connections on @var{port}
393 41d03949 bellard
(@var{host} is optional). @option{connect} is used to connect to
394 3d830459 bellard
another QEMU instance using the @option{listen} option. @option{fd=h}
395 3d830459 bellard
specifies an already opened TCP socket.
396 1f673135 bellard
397 41d03949 bellard
Example:
398 41d03949 bellard
@example
399 41d03949 bellard
# launch a first QEMU instance
400 debc7065 bellard
qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
401 debc7065 bellard
               -net socket,listen=:1234
402 debc7065 bellard
# connect the VLAN 0 of this instance to the VLAN 0
403 debc7065 bellard
# of the first instance
404 debc7065 bellard
qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
405 debc7065 bellard
               -net socket,connect=127.0.0.1:1234
406 41d03949 bellard
@end example
407 52c00a5f bellard
408 3d830459 bellard
@item -net socket[,vlan=n][,fd=h][,mcast=maddr:port]
409 3d830459 bellard
410 3d830459 bellard
Create a VLAN @var{n} shared with another QEMU virtual
411 3d830459 bellard
machines using a UDP multicast socket, effectively making a bus for 
412 3d830459 bellard
every QEMU with same multicast address @var{maddr} and @var{port}.
413 3d830459 bellard
NOTES:
414 3d830459 bellard
@enumerate
415 3d830459 bellard
@item 
416 3d830459 bellard
Several QEMU can be running on different hosts and share same bus (assuming 
417 3d830459 bellard
correct multicast setup for these hosts).
418 3d830459 bellard
@item
419 3d830459 bellard
mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
420 3d830459 bellard
@url{http://user-mode-linux.sf.net}.
421 3d830459 bellard
@item Use @option{fd=h} to specify an already opened UDP multicast socket.
422 3d830459 bellard
@end enumerate
423 3d830459 bellard
424 3d830459 bellard
Example:
425 3d830459 bellard
@example
426 3d830459 bellard
# launch one QEMU instance
427 debc7065 bellard
qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
428 debc7065 bellard
               -net socket,mcast=230.0.0.1:1234
429 3d830459 bellard
# launch another QEMU instance on same "bus"
430 debc7065 bellard
qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
431 debc7065 bellard
               -net socket,mcast=230.0.0.1:1234
432 3d830459 bellard
# launch yet another QEMU instance on same "bus"
433 debc7065 bellard
qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
434 debc7065 bellard
               -net socket,mcast=230.0.0.1:1234
435 3d830459 bellard
@end example
436 3d830459 bellard
437 3d830459 bellard
Example (User Mode Linux compat.):
438 3d830459 bellard
@example
439 debc7065 bellard
# launch QEMU instance (note mcast address selected
440 debc7065 bellard
# is UML's default)
441 debc7065 bellard
qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
442 debc7065 bellard
               -net socket,mcast=239.192.168.1:1102
443 3d830459 bellard
# launch UML
444 3d830459 bellard
/path/to/linux ubd0=/path/to/root_fs eth0=mcast
445 3d830459 bellard
@end example
446 3d830459 bellard
447 41d03949 bellard
@item -net none
448 41d03949 bellard
Indicate that no network devices should be configured. It is used to
449 039af320 bellard
override the default configuration (@option{-net nic -net user}) which
450 039af320 bellard
is activated if no @option{-net} options are provided.
451 52c00a5f bellard
452 0db1137d ths
@item -tftp dir
453 9bf05444 bellard
When using the user mode network stack, activate a built-in TFTP
454 0db1137d ths
server. The files in @var{dir} will be exposed as the root of a TFTP server.
455 0db1137d ths
The TFTP client on the guest must be configured in binary mode (use the command
456 0db1137d ths
@code{bin} of the Unix TFTP client). The host IP address on the guest is as
457 0db1137d ths
usual 10.0.2.2.
458 9bf05444 bellard
459 47d5d01a ths
@item -bootp file
460 47d5d01a ths
When using the user mode network stack, broadcast @var{file} as the BOOTP
461 47d5d01a ths
filename.  In conjunction with @option{-tftp}, this can be used to network boot
462 47d5d01a ths
a guest from a local directory.
463 47d5d01a ths
464 47d5d01a ths
Example (using pxelinux):
465 47d5d01a ths
@example
466 47d5d01a ths
qemu -hda linux.img -boot n -tftp /path/to/tftp/files -bootp /pxelinux.0
467 47d5d01a ths
@end example
468 47d5d01a ths
469 2518bd0d bellard
@item -smb dir
470 2518bd0d bellard
When using the user mode network stack, activate a built-in SMB
471 2518bd0d bellard
server so that Windows OSes can access to the host files in @file{dir}
472 2518bd0d bellard
transparently.
473 2518bd0d bellard
474 2518bd0d bellard
In the guest Windows OS, the line:
475 2518bd0d bellard
@example
476 2518bd0d bellard
10.0.2.4 smbserver
477 2518bd0d bellard
@end example
478 2518bd0d bellard
must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
479 2518bd0d bellard
or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
480 2518bd0d bellard
481 2518bd0d bellard
Then @file{dir} can be accessed in @file{\\smbserver\qemu}.
482 2518bd0d bellard
483 2518bd0d bellard
Note that a SAMBA server must be installed on the host OS in
484 366dfc52 ths
@file{/usr/sbin/smbd}. QEMU was tested successfully with smbd version
485 6cc721cf bellard
2.2.7a from the Red Hat 9 and version 3.0.10-1.fc3 from Fedora Core 3.
486 2518bd0d bellard
487 9bf05444 bellard
@item -redir [tcp|udp]:host-port:[guest-host]:guest-port
488 9bf05444 bellard
489 9bf05444 bellard
When using the user mode network stack, redirect incoming TCP or UDP
490 9bf05444 bellard
connections to the host port @var{host-port} to the guest
491 9bf05444 bellard
@var{guest-host} on guest port @var{guest-port}. If @var{guest-host}
492 9bf05444 bellard
is not specified, its value is 10.0.2.15 (default address given by the
493 9bf05444 bellard
built-in DHCP server).
494 9bf05444 bellard
495 9bf05444 bellard
For example, to redirect host X11 connection from screen 1 to guest
496 9bf05444 bellard
screen 0, use the following:
497 9bf05444 bellard
498 9bf05444 bellard
@example
499 9bf05444 bellard
# on the host
500 9bf05444 bellard
qemu -redir tcp:6001::6000 [...]
501 9bf05444 bellard
# this host xterm should open in the guest X11 server
502 9bf05444 bellard
xterm -display :1
503 9bf05444 bellard
@end example
504 9bf05444 bellard
505 9bf05444 bellard
To redirect telnet connections from host port 5555 to telnet port on
506 9bf05444 bellard
the guest, use the following:
507 9bf05444 bellard
508 9bf05444 bellard
@example
509 9bf05444 bellard
# on the host
510 9bf05444 bellard
qemu -redir tcp:5555::23 [...]
511 9bf05444 bellard
telnet localhost 5555
512 9bf05444 bellard
@end example
513 9bf05444 bellard
514 9bf05444 bellard
Then when you use on the host @code{telnet localhost 5555}, you
515 9bf05444 bellard
connect to the guest telnet server.
516 9bf05444 bellard
517 1f673135 bellard
@end table
518 1f673135 bellard
519 41d03949 bellard
Linux boot specific: When using these options, you can use a given
520 1f673135 bellard
Linux kernel without installing it in the disk image. It can be useful
521 1f673135 bellard
for easier testing of various kernels.
522 1f673135 bellard
523 0806e3f6 bellard
@table @option
524 0806e3f6 bellard
525 0806e3f6 bellard
@item -kernel bzImage 
526 0806e3f6 bellard
Use @var{bzImage} as kernel image.
527 0806e3f6 bellard
528 0806e3f6 bellard
@item -append cmdline 
529 0806e3f6 bellard
Use @var{cmdline} as kernel command line
530 0806e3f6 bellard
531 0806e3f6 bellard
@item -initrd file
532 0806e3f6 bellard
Use @var{file} as initial ram disk.
533 0806e3f6 bellard
534 ec410fc9 bellard
@end table
535 ec410fc9 bellard
536 15a34c63 bellard
Debug/Expert options:
537 ec410fc9 bellard
@table @option
538 a0a821a4 bellard
539 a0a821a4 bellard
@item -serial dev
540 0bab00f3 bellard
Redirect the virtual serial port to host character device
541 0bab00f3 bellard
@var{dev}. The default device is @code{vc} in graphical mode and
542 0bab00f3 bellard
@code{stdio} in non graphical mode.
543 0bab00f3 bellard
544 0bab00f3 bellard
This option can be used several times to simulate up to 4 serials
545 0bab00f3 bellard
ports.
546 0bab00f3 bellard
547 c03b0f0f bellard
Use @code{-serial none} to disable all serial ports.
548 c03b0f0f bellard
549 0bab00f3 bellard
Available character devices are:
550 a0a821a4 bellard
@table @code
551 a0a821a4 bellard
@item vc
552 a0a821a4 bellard
Virtual console
553 a0a821a4 bellard
@item pty
554 a0a821a4 bellard
[Linux only] Pseudo TTY (a new PTY is automatically allocated)
555 c03b0f0f bellard
@item none
556 c03b0f0f bellard
No device is allocated.
557 a0a821a4 bellard
@item null
558 a0a821a4 bellard
void device
559 f8d179e3 bellard
@item /dev/XXX
560 e57a8c0e bellard
[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
561 f8d179e3 bellard
parameters are set according to the emulated ones.
562 e57a8c0e bellard
@item /dev/parportN
563 e57a8c0e bellard
[Linux only, parallel port only] Use host parallel port
564 5867c88a ths
@var{N}. Currently SPP and EPP parallel port features can be used.
565 f8d179e3 bellard
@item file:filename
566 f8d179e3 bellard
Write output to filename. No character can be read.
567 a0a821a4 bellard
@item stdio
568 a0a821a4 bellard
[Unix only] standard input/output
569 f8d179e3 bellard
@item pipe:filename
570 0bab00f3 bellard
name pipe @var{filename}
571 0bab00f3 bellard
@item COMn
572 0bab00f3 bellard
[Windows only] Use host serial port @var{n}
573 951f1351 bellard
@item udp:[remote_host]:remote_port[@@[src_ip]:src_port]
574 951f1351 bellard
This implements UDP Net Console.  When @var{remote_host} or @var{src_ip} are not specified they default to @code{0.0.0.0}.  When not using a specifed @var{src_port} a random port is automatically chosen.
575 951f1351 bellard
576 951f1351 bellard
If you just want a simple readonly console you can use @code{netcat} or
577 951f1351 bellard
@code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
578 951f1351 bellard
@code{nc -u -l -p 4555}. Any time qemu writes something to that port it
579 951f1351 bellard
will appear in the netconsole session.
580 0bab00f3 bellard
581 0bab00f3 bellard
If you plan to send characters back via netconsole or you want to stop
582 0bab00f3 bellard
and start qemu a lot of times, you should have qemu use the same
583 0bab00f3 bellard
source port each time by using something like @code{-serial
584 951f1351 bellard
udp::4555@@:4556} to qemu. Another approach is to use a patched
585 0bab00f3 bellard
version of netcat which can listen to a TCP port and send and receive
586 0bab00f3 bellard
characters via udp.  If you have a patched version of netcat which
587 0bab00f3 bellard
activates telnet remote echo and single char transfer, then you can
588 0bab00f3 bellard
use the following options to step up a netcat redirector to allow
589 0bab00f3 bellard
telnet on port 5555 to access the qemu port.
590 0bab00f3 bellard
@table @code
591 951f1351 bellard
@item Qemu Options:
592 951f1351 bellard
-serial udp::4555@@:4556
593 951f1351 bellard
@item netcat options:
594 951f1351 bellard
-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
595 951f1351 bellard
@item telnet options:
596 951f1351 bellard
localhost 5555
597 951f1351 bellard
@end table
598 951f1351 bellard
599 951f1351 bellard
600 f7499989 pbrook
@item tcp:[host]:port[,server][,nowait][,nodelay]
601 951f1351 bellard
The TCP Net Console has two modes of operation.  It can send the serial
602 951f1351 bellard
I/O to a location or wait for a connection from a location.  By default
603 951f1351 bellard
the TCP Net Console is sent to @var{host} at the @var{port}.  If you use
604 f542086d bellard
the @var{server} option QEMU will wait for a client socket application
605 f542086d bellard
to connect to the port before continuing, unless the @code{nowait}
606 f7499989 pbrook
option was specified.  The @code{nodelay} option disables the Nagle buffering
607 f7499989 pbrook
algoritm.  If @var{host} is omitted, 0.0.0.0 is assumed. Only
608 951f1351 bellard
one TCP connection at a time is accepted. You can use @code{telnet} to
609 951f1351 bellard
connect to the corresponding character device.
610 951f1351 bellard
@table @code
611 951f1351 bellard
@item Example to send tcp console to 192.168.0.2 port 4444
612 951f1351 bellard
-serial tcp:192.168.0.2:4444
613 951f1351 bellard
@item Example to listen and wait on port 4444 for connection
614 951f1351 bellard
-serial tcp::4444,server
615 951f1351 bellard
@item Example to not wait and listen on ip 192.168.0.100 port 4444
616 951f1351 bellard
-serial tcp:192.168.0.100:4444,server,nowait
617 a0a821a4 bellard
@end table
618 a0a821a4 bellard
619 f7499989 pbrook
@item telnet:host:port[,server][,nowait][,nodelay]
620 951f1351 bellard
The telnet protocol is used instead of raw tcp sockets.  The options
621 951f1351 bellard
work the same as if you had specified @code{-serial tcp}.  The
622 951f1351 bellard
difference is that the port acts like a telnet server or client using
623 951f1351 bellard
telnet option negotiation.  This will also allow you to send the
624 951f1351 bellard
MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
625 951f1351 bellard
sequence.  Typically in unix telnet you do it with Control-] and then
626 951f1351 bellard
type "send break" followed by pressing the enter key.
627 0bab00f3 bellard
628 ffd843bc ths
@item unix:path[,server][,nowait]
629 ffd843bc ths
A unix domain socket is used instead of a tcp socket.  The option works the
630 ffd843bc ths
same as if you had specified @code{-serial tcp} except the unix domain socket
631 ffd843bc ths
@var{path} is used for connections.
632 ffd843bc ths
633 20d8a3ed ths
@item mon:dev_string
634 20d8a3ed ths
This is a special option to allow the monitor to be multiplexed onto
635 20d8a3ed ths
another serial port.  The monitor is accessed with key sequence of
636 20d8a3ed ths
@key{Control-a} and then pressing @key{c}. See monitor access
637 20d8a3ed ths
@ref{pcsys_keys} in the -nographic section for more keys.
638 20d8a3ed ths
@var{dev_string} should be any one of the serial devices specified
639 20d8a3ed ths
above.  An example to multiplex the monitor onto a telnet server
640 20d8a3ed ths
listening on port 4444 would be:
641 20d8a3ed ths
@table @code
642 20d8a3ed ths
@item -serial mon:telnet::4444,server,nowait
643 20d8a3ed ths
@end table
644 20d8a3ed ths
645 0bab00f3 bellard
@end table
646 05d5818c bellard
647 e57a8c0e bellard
@item -parallel dev
648 e57a8c0e bellard
Redirect the virtual parallel port to host device @var{dev} (same
649 e57a8c0e bellard
devices as the serial port). On Linux hosts, @file{/dev/parportN} can
650 e57a8c0e bellard
be used to use hardware devices connected on the corresponding host
651 e57a8c0e bellard
parallel port.
652 e57a8c0e bellard
653 e57a8c0e bellard
This option can be used several times to simulate up to 3 parallel
654 e57a8c0e bellard
ports.
655 e57a8c0e bellard
656 c03b0f0f bellard
Use @code{-parallel none} to disable all parallel ports.
657 c03b0f0f bellard
658 a0a821a4 bellard
@item -monitor dev
659 a0a821a4 bellard
Redirect the monitor to host device @var{dev} (same devices as the
660 a0a821a4 bellard
serial port).
661 a0a821a4 bellard
The default device is @code{vc} in graphical mode and @code{stdio} in
662 a0a821a4 bellard
non graphical mode.
663 a0a821a4 bellard
664 20d8a3ed ths
@item -echr numeric_ascii_value
665 20d8a3ed ths
Change the escape character used for switching to the monitor when using
666 20d8a3ed ths
monitor and serial sharing.  The default is @code{0x01} when using the
667 20d8a3ed ths
@code{-nographic} option.  @code{0x01} is equal to pressing
668 20d8a3ed ths
@code{Control-a}.  You can select a different character from the ascii
669 20d8a3ed ths
control keys where 1 through 26 map to Control-a through Control-z.  For
670 20d8a3ed ths
instance you could use the either of the following to change the escape
671 20d8a3ed ths
character to Control-t.
672 20d8a3ed ths
@table @code
673 20d8a3ed ths
@item -echr 0x14
674 20d8a3ed ths
@item -echr 20
675 20d8a3ed ths
@end table
676 20d8a3ed ths
677 ec410fc9 bellard
@item -s
678 debc7065 bellard
Wait gdb connection to port 1234 (@pxref{gdb_usage}). 
679 ec410fc9 bellard
@item -p port
680 4046d913 pbrook
Change gdb connection port.  @var{port} can be either a decimal number
681 4046d913 pbrook
to specify a TCP port, or a host device (same devices as the serial port).
682 52c00a5f bellard
@item -S
683 52c00a5f bellard
Do not start CPU at startup (you must type 'c' in the monitor).
684 ec410fc9 bellard
@item -d             
685 9d4520d0 bellard
Output log in /tmp/qemu.log
686 46d4767d bellard
@item -hdachs c,h,s,[,t]
687 46d4767d bellard
Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
688 46d4767d bellard
@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
689 46d4767d bellard
translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
690 46d4767d bellard
all thoses parameters. This option is useful for old MS-DOS disk
691 46d4767d bellard
images.
692 7c3fc84d bellard
693 87b47350 bellard
@item -L path
694 87b47350 bellard
Set the directory for the BIOS, VGA BIOS and keymaps.
695 87b47350 bellard
696 15a34c63 bellard
@item -std-vga
697 15a34c63 bellard
Simulate a standard VGA card with Bochs VBE extensions (default is
698 3cb0853a bellard
Cirrus Logic GD5446 PCI VGA). If your guest OS supports the VESA 2.0
699 3cb0853a bellard
VBE extensions (e.g. Windows XP) and if you want to use high
700 3cb0853a bellard
resolution modes (>= 1280x1024x16) then you should use this option.
701 3cb0853a bellard
702 3c656346 bellard
@item -no-acpi
703 3c656346 bellard
Disable ACPI (Advanced Configuration and Power Interface) support. Use
704 3c656346 bellard
it if your guest OS complains about ACPI problems (PC target machine
705 3c656346 bellard
only).
706 3c656346 bellard
707 d1beab82 bellard
@item -no-reboot
708 d1beab82 bellard
Exit instead of rebooting.
709 d1beab82 bellard
710 d63d307f bellard
@item -loadvm file
711 d63d307f bellard
Start right away with a saved state (@code{loadvm} in monitor)
712 8e71621f pbrook
713 8e71621f pbrook
@item -semihosting
714 8e71621f pbrook
Enable "Angel" semihosting interface (ARM target machines only).
715 8e71621f pbrook
Note that this allows guest direct access to the host filesystem,
716 8e71621f pbrook
so should only be used with trusted guest OS.
717 ec410fc9 bellard
@end table
718 ec410fc9 bellard
719 3e11db9a bellard
@c man end
720 3e11db9a bellard
721 debc7065 bellard
@node pcsys_keys
722 3e11db9a bellard
@section Keys
723 3e11db9a bellard
724 3e11db9a bellard
@c man begin OPTIONS
725 3e11db9a bellard
726 a1b74fe8 bellard
During the graphical emulation, you can use the following keys:
727 a1b74fe8 bellard
@table @key
728 f9859310 bellard
@item Ctrl-Alt-f
729 a1b74fe8 bellard
Toggle full screen
730 a0a821a4 bellard
731 f9859310 bellard
@item Ctrl-Alt-n
732 a0a821a4 bellard
Switch to virtual console 'n'. Standard console mappings are:
733 a0a821a4 bellard
@table @emph
734 a0a821a4 bellard
@item 1
735 a0a821a4 bellard
Target system display
736 a0a821a4 bellard
@item 2
737 a0a821a4 bellard
Monitor
738 a0a821a4 bellard
@item 3
739 a0a821a4 bellard
Serial port
740 a1b74fe8 bellard
@end table
741 a1b74fe8 bellard
742 f9859310 bellard
@item Ctrl-Alt
743 a0a821a4 bellard
Toggle mouse and keyboard grab.
744 a0a821a4 bellard
@end table
745 a0a821a4 bellard
746 3e11db9a bellard
In the virtual consoles, you can use @key{Ctrl-Up}, @key{Ctrl-Down},
747 3e11db9a bellard
@key{Ctrl-PageUp} and @key{Ctrl-PageDown} to move in the back log.
748 3e11db9a bellard
749 a0a821a4 bellard
During emulation, if you are using the @option{-nographic} option, use
750 a0a821a4 bellard
@key{Ctrl-a h} to get terminal commands:
751 ec410fc9 bellard
752 ec410fc9 bellard
@table @key
753 a1b74fe8 bellard
@item Ctrl-a h
754 ec410fc9 bellard
Print this help
755 a1b74fe8 bellard
@item Ctrl-a x    
756 366dfc52 ths
Exit emulator
757 a1b74fe8 bellard
@item Ctrl-a s    
758 1f47a922 bellard
Save disk data back to file (if -snapshot)
759 20d8a3ed ths
@item Ctrl-a t
760 20d8a3ed ths
toggle console timestamps
761 a1b74fe8 bellard
@item Ctrl-a b
762 1f673135 bellard
Send break (magic sysrq in Linux)
763 a1b74fe8 bellard
@item Ctrl-a c
764 1f673135 bellard
Switch between console and monitor
765 a1b74fe8 bellard
@item Ctrl-a Ctrl-a
766 a1b74fe8 bellard
Send Ctrl-a
767 ec410fc9 bellard
@end table
768 0806e3f6 bellard
@c man end
769 0806e3f6 bellard
770 0806e3f6 bellard
@ignore
771 0806e3f6 bellard
772 1f673135 bellard
@c man begin SEEALSO
773 1f673135 bellard
The HTML documentation of QEMU for more precise information and Linux
774 1f673135 bellard
user mode emulator invocation.
775 1f673135 bellard
@c man end
776 1f673135 bellard
777 1f673135 bellard
@c man begin AUTHOR
778 1f673135 bellard
Fabrice Bellard
779 1f673135 bellard
@c man end
780 1f673135 bellard
781 1f673135 bellard
@end ignore
782 1f673135 bellard
783 debc7065 bellard
@node pcsys_monitor
784 1f673135 bellard
@section QEMU Monitor
785 1f673135 bellard
786 1f673135 bellard
The QEMU monitor is used to give complex commands to the QEMU
787 1f673135 bellard
emulator. You can use it to:
788 1f673135 bellard
789 1f673135 bellard
@itemize @minus
790 1f673135 bellard
791 1f673135 bellard
@item
792 e598752a ths
Remove or insert removable media images
793 1f673135 bellard
(such as CD-ROM or floppies)
794 1f673135 bellard
795 1f673135 bellard
@item 
796 1f673135 bellard
Freeze/unfreeze the Virtual Machine (VM) and save or restore its state
797 1f673135 bellard
from a disk file.
798 1f673135 bellard
799 1f673135 bellard
@item Inspect the VM state without an external debugger.
800 1f673135 bellard
801 1f673135 bellard
@end itemize
802 1f673135 bellard
803 1f673135 bellard
@subsection Commands
804 1f673135 bellard
805 1f673135 bellard
The following commands are available:
806 1f673135 bellard
807 1f673135 bellard
@table @option
808 1f673135 bellard
809 1f673135 bellard
@item help or ? [cmd]
810 1f673135 bellard
Show the help for all commands or just for command @var{cmd}.
811 1f673135 bellard
812 1f673135 bellard
@item commit  
813 1f673135 bellard
Commit changes to the disk images (if -snapshot is used)
814 1f673135 bellard
815 1f673135 bellard
@item info subcommand 
816 1f673135 bellard
show various information about the system state
817 1f673135 bellard
818 1f673135 bellard
@table @option
819 1f673135 bellard
@item info network
820 41d03949 bellard
show the various VLANs and the associated devices
821 1f673135 bellard
@item info block
822 1f673135 bellard
show the block devices
823 1f673135 bellard
@item info registers
824 1f673135 bellard
show the cpu registers
825 1f673135 bellard
@item info history
826 1f673135 bellard
show the command line history
827 b389dbfb bellard
@item info pci
828 b389dbfb bellard
show emulated PCI device
829 b389dbfb bellard
@item info usb
830 b389dbfb bellard
show USB devices plugged on the virtual USB hub
831 b389dbfb bellard
@item info usbhost
832 b389dbfb bellard
show all USB host devices
833 a3c25997 bellard
@item info capture
834 a3c25997 bellard
show information about active capturing
835 13a2e80f bellard
@item info snapshots
836 13a2e80f bellard
show list of VM snapshots
837 455204eb ths
@item info mice
838 455204eb ths
show which guest mouse is receiving events
839 1f673135 bellard
@end table
840 1f673135 bellard
841 1f673135 bellard
@item q or quit
842 1f673135 bellard
Quit the emulator.
843 1f673135 bellard
844 1f673135 bellard
@item eject [-f] device
845 e598752a ths
Eject a removable medium (use -f to force it).
846 1f673135 bellard
847 1f673135 bellard
@item change device filename
848 e598752a ths
Change a removable medium.
849 1f673135 bellard
850 1f673135 bellard
@item screendump filename
851 1f673135 bellard
Save screen into PPM image @var{filename}.
852 1f673135 bellard
853 455204eb ths
@item mouse_move dx dy [dz]
854 455204eb ths
Move the active mouse to the specified coordinates @var{dx} @var{dy}
855 455204eb ths
with optional scroll axis @var{dz}.
856 455204eb ths
857 455204eb ths
@item mouse_button val
858 455204eb ths
Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
859 455204eb ths
860 455204eb ths
@item mouse_set index
861 455204eb ths
Set which mouse device receives events at given @var{index}, index
862 455204eb ths
can be obtained with
863 455204eb ths
@example
864 455204eb ths
info mice
865 455204eb ths
@end example
866 455204eb ths
867 a3c25997 bellard
@item wavcapture filename [frequency [bits [channels]]]
868 a3c25997 bellard
Capture audio into @var{filename}. Using sample rate @var{frequency}
869 a3c25997 bellard
bits per sample @var{bits} and number of channels @var{channels}.
870 a3c25997 bellard
871 a3c25997 bellard
Defaults:
872 a3c25997 bellard
@itemize @minus
873 a3c25997 bellard
@item Sample rate = 44100 Hz - CD quality
874 a3c25997 bellard
@item Bits = 16
875 a3c25997 bellard
@item Number of channels = 2 - Stereo
876 a3c25997 bellard
@end itemize
877 a3c25997 bellard
878 a3c25997 bellard
@item stopcapture index
879 a3c25997 bellard
Stop capture with a given @var{index}, index can be obtained with
880 a3c25997 bellard
@example
881 a3c25997 bellard
info capture
882 a3c25997 bellard
@end example
883 a3c25997 bellard
884 1f673135 bellard
@item log item1[,...]
885 1f673135 bellard
Activate logging of the specified items to @file{/tmp/qemu.log}.
886 1f673135 bellard
887 13a2e80f bellard
@item savevm [tag|id]
888 13a2e80f bellard
Create a snapshot of the whole virtual machine. If @var{tag} is
889 13a2e80f bellard
provided, it is used as human readable identifier. If there is already
890 13a2e80f bellard
a snapshot with the same tag or ID, it is replaced. More info at
891 13a2e80f bellard
@ref{vm_snapshots}.
892 1f673135 bellard
893 13a2e80f bellard
@item loadvm tag|id
894 13a2e80f bellard
Set the whole virtual machine to the snapshot identified by the tag
895 13a2e80f bellard
@var{tag} or the unique snapshot ID @var{id}.
896 13a2e80f bellard
897 13a2e80f bellard
@item delvm tag|id
898 13a2e80f bellard
Delete the snapshot identified by @var{tag} or @var{id}.
899 1f673135 bellard
900 1f673135 bellard
@item stop
901 1f673135 bellard
Stop emulation.
902 1f673135 bellard
903 1f673135 bellard
@item c or cont
904 1f673135 bellard
Resume emulation.
905 1f673135 bellard
906 1f673135 bellard
@item gdbserver [port]
907 1f673135 bellard
Start gdbserver session (default port=1234)
908 1f673135 bellard
909 1f673135 bellard
@item x/fmt addr
910 1f673135 bellard
Virtual memory dump starting at @var{addr}.
911 1f673135 bellard
912 1f673135 bellard
@item xp /fmt addr
913 1f673135 bellard
Physical memory dump starting at @var{addr}.
914 1f673135 bellard
915 1f673135 bellard
@var{fmt} is a format which tells the command how to format the
916 1f673135 bellard
data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
917 1f673135 bellard
918 1f673135 bellard
@table @var
919 1f673135 bellard
@item count 
920 1f673135 bellard
is the number of items to be dumped.
921 1f673135 bellard
922 1f673135 bellard
@item format
923 1f673135 bellard
can be x (hexa), d (signed decimal), u (unsigned decimal), o (octal),
924 1f673135 bellard
c (char) or i (asm instruction).
925 1f673135 bellard
926 1f673135 bellard
@item size
927 52c00a5f bellard
can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
928 52c00a5f bellard
@code{h} or @code{w} can be specified with the @code{i} format to
929 52c00a5f bellard
respectively select 16 or 32 bit code instruction size.
930 1f673135 bellard
931 1f673135 bellard
@end table
932 1f673135 bellard
933 1f673135 bellard
Examples: 
934 1f673135 bellard
@itemize
935 1f673135 bellard
@item
936 1f673135 bellard
Dump 10 instructions at the current instruction pointer:
937 1f673135 bellard
@example 
938 1f673135 bellard
(qemu) x/10i $eip
939 1f673135 bellard
0x90107063:  ret
940 1f673135 bellard
0x90107064:  sti
941 1f673135 bellard
0x90107065:  lea    0x0(%esi,1),%esi
942 1f673135 bellard
0x90107069:  lea    0x0(%edi,1),%edi
943 1f673135 bellard
0x90107070:  ret
944 1f673135 bellard
0x90107071:  jmp    0x90107080
945 1f673135 bellard
0x90107073:  nop
946 1f673135 bellard
0x90107074:  nop
947 1f673135 bellard
0x90107075:  nop
948 1f673135 bellard
0x90107076:  nop
949 1f673135 bellard
@end example
950 1f673135 bellard
951 1f673135 bellard
@item
952 1f673135 bellard
Dump 80 16 bit values at the start of the video memory.
953 debc7065 bellard
@smallexample 
954 1f673135 bellard
(qemu) xp/80hx 0xb8000
955 1f673135 bellard
0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
956 1f673135 bellard
0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
957 1f673135 bellard
0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
958 1f673135 bellard
0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
959 1f673135 bellard
0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
960 1f673135 bellard
0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
961 1f673135 bellard
0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
962 1f673135 bellard
0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
963 1f673135 bellard
0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
964 1f673135 bellard
0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
965 debc7065 bellard
@end smallexample
966 1f673135 bellard
@end itemize
967 1f673135 bellard
968 1f673135 bellard
@item p or print/fmt expr
969 1f673135 bellard
970 1f673135 bellard
Print expression value. Only the @var{format} part of @var{fmt} is
971 1f673135 bellard
used.
972 0806e3f6 bellard
973 a3a91a35 bellard
@item sendkey keys
974 a3a91a35 bellard
975 a3a91a35 bellard
Send @var{keys} to the emulator. Use @code{-} to press several keys
976 a3a91a35 bellard
simultaneously. Example:
977 a3a91a35 bellard
@example
978 a3a91a35 bellard
sendkey ctrl-alt-f1
979 a3a91a35 bellard
@end example
980 a3a91a35 bellard
981 a3a91a35 bellard
This command is useful to send keys that your graphical user interface
982 a3a91a35 bellard
intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
983 a3a91a35 bellard
984 15a34c63 bellard
@item system_reset
985 15a34c63 bellard
986 15a34c63 bellard
Reset the system.
987 15a34c63 bellard
988 b389dbfb bellard
@item usb_add devname
989 b389dbfb bellard
990 0aff66b5 pbrook
Add the USB device @var{devname}.  For details of available devices see
991 0aff66b5 pbrook
@ref{usb_devices}
992 b389dbfb bellard
993 b389dbfb bellard
@item usb_del devname
994 b389dbfb bellard
995 b389dbfb bellard
Remove the USB device @var{devname} from the QEMU virtual USB
996 b389dbfb bellard
hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
997 b389dbfb bellard
command @code{info usb} to see the devices you can remove.
998 b389dbfb bellard
999 1f673135 bellard
@end table
1000 0806e3f6 bellard
1001 1f673135 bellard
@subsection Integer expressions
1002 1f673135 bellard
1003 1f673135 bellard
The monitor understands integers expressions for every integer
1004 1f673135 bellard
argument. You can use register names to get the value of specifics
1005 1f673135 bellard
CPU registers by prefixing them with @emph{$}.
1006 ec410fc9 bellard
1007 1f47a922 bellard
@node disk_images
1008 1f47a922 bellard
@section Disk Images
1009 1f47a922 bellard
1010 acd935ef bellard
Since version 0.6.1, QEMU supports many disk image formats, including
1011 acd935ef bellard
growable disk images (their size increase as non empty sectors are
1012 13a2e80f bellard
written), compressed and encrypted disk images. Version 0.8.3 added
1013 13a2e80f bellard
the new qcow2 disk image format which is essential to support VM
1014 13a2e80f bellard
snapshots.
1015 1f47a922 bellard
1016 debc7065 bellard
@menu
1017 debc7065 bellard
* disk_images_quickstart::    Quick start for disk image creation
1018 debc7065 bellard
* disk_images_snapshot_mode:: Snapshot mode
1019 13a2e80f bellard
* vm_snapshots::              VM snapshots
1020 debc7065 bellard
* qemu_img_invocation::       qemu-img Invocation
1021 19cb3738 bellard
* host_drives::               Using host drives
1022 debc7065 bellard
* disk_images_fat_images::    Virtual FAT disk images
1023 debc7065 bellard
@end menu
1024 debc7065 bellard
1025 debc7065 bellard
@node disk_images_quickstart
1026 acd935ef bellard
@subsection Quick start for disk image creation
1027 acd935ef bellard
1028 acd935ef bellard
You can create a disk image with the command:
1029 1f47a922 bellard
@example
1030 acd935ef bellard
qemu-img create myimage.img mysize
1031 1f47a922 bellard
@end example
1032 acd935ef bellard
where @var{myimage.img} is the disk image filename and @var{mysize} is its
1033 acd935ef bellard
size in kilobytes. You can add an @code{M} suffix to give the size in
1034 acd935ef bellard
megabytes and a @code{G} suffix for gigabytes.
1035 acd935ef bellard
1036 debc7065 bellard
See @ref{qemu_img_invocation} for more information.
1037 1f47a922 bellard
1038 debc7065 bellard
@node disk_images_snapshot_mode
1039 1f47a922 bellard
@subsection Snapshot mode
1040 1f47a922 bellard
1041 1f47a922 bellard
If you use the option @option{-snapshot}, all disk images are
1042 1f47a922 bellard
considered as read only. When sectors in written, they are written in
1043 1f47a922 bellard
a temporary file created in @file{/tmp}. You can however force the
1044 acd935ef bellard
write back to the raw disk images by using the @code{commit} monitor
1045 acd935ef bellard
command (or @key{C-a s} in the serial console).
1046 1f47a922 bellard
1047 13a2e80f bellard
@node vm_snapshots
1048 13a2e80f bellard
@subsection VM snapshots
1049 13a2e80f bellard
1050 13a2e80f bellard
VM snapshots are snapshots of the complete virtual machine including
1051 13a2e80f bellard
CPU state, RAM, device state and the content of all the writable
1052 13a2e80f bellard
disks. In order to use VM snapshots, you must have at least one non
1053 13a2e80f bellard
removable and writable block device using the @code{qcow2} disk image
1054 13a2e80f bellard
format. Normally this device is the first virtual hard drive.
1055 13a2e80f bellard
1056 13a2e80f bellard
Use the monitor command @code{savevm} to create a new VM snapshot or
1057 13a2e80f bellard
replace an existing one. A human readable name can be assigned to each
1058 19d36792 bellard
snapshot in addition to its numerical ID.
1059 13a2e80f bellard
1060 13a2e80f bellard
Use @code{loadvm} to restore a VM snapshot and @code{delvm} to remove
1061 13a2e80f bellard
a VM snapshot. @code{info snapshots} lists the available snapshots
1062 13a2e80f bellard
with their associated information:
1063 13a2e80f bellard
1064 13a2e80f bellard
@example
1065 13a2e80f bellard
(qemu) info snapshots
1066 13a2e80f bellard
Snapshot devices: hda
1067 13a2e80f bellard
Snapshot list (from hda):
1068 13a2e80f bellard
ID        TAG                 VM SIZE                DATE       VM CLOCK
1069 13a2e80f bellard
1         start                   41M 2006-08-06 12:38:02   00:00:14.954
1070 13a2e80f bellard
2                                 40M 2006-08-06 12:43:29   00:00:18.633
1071 13a2e80f bellard
3         msys                    40M 2006-08-06 12:44:04   00:00:23.514
1072 13a2e80f bellard
@end example
1073 13a2e80f bellard
1074 13a2e80f bellard
A VM snapshot is made of a VM state info (its size is shown in
1075 13a2e80f bellard
@code{info snapshots}) and a snapshot of every writable disk image.
1076 13a2e80f bellard
The VM state info is stored in the first @code{qcow2} non removable
1077 13a2e80f bellard
and writable block device. The disk image snapshots are stored in
1078 13a2e80f bellard
every disk image. The size of a snapshot in a disk image is difficult
1079 13a2e80f bellard
to evaluate and is not shown by @code{info snapshots} because the
1080 13a2e80f bellard
associated disk sectors are shared among all the snapshots to save
1081 19d36792 bellard
disk space (otherwise each snapshot would need a full copy of all the
1082 19d36792 bellard
disk images).
1083 13a2e80f bellard
1084 13a2e80f bellard
When using the (unrelated) @code{-snapshot} option
1085 13a2e80f bellard
(@ref{disk_images_snapshot_mode}), you can always make VM snapshots,
1086 13a2e80f bellard
but they are deleted as soon as you exit QEMU.
1087 13a2e80f bellard
1088 13a2e80f bellard
VM snapshots currently have the following known limitations:
1089 13a2e80f bellard
@itemize
1090 13a2e80f bellard
@item 
1091 13a2e80f bellard
They cannot cope with removable devices if they are removed or
1092 13a2e80f bellard
inserted after a snapshot is done.
1093 13a2e80f bellard
@item 
1094 13a2e80f bellard
A few device drivers still have incomplete snapshot support so their
1095 13a2e80f bellard
state is not saved or restored properly (in particular USB).
1096 13a2e80f bellard
@end itemize
1097 13a2e80f bellard
1098 acd935ef bellard
@node qemu_img_invocation
1099 acd935ef bellard
@subsection @code{qemu-img} Invocation
1100 1f47a922 bellard
1101 acd935ef bellard
@include qemu-img.texi
1102 05efe46e bellard
1103 19cb3738 bellard
@node host_drives
1104 19cb3738 bellard
@subsection Using host drives
1105 19cb3738 bellard
1106 19cb3738 bellard
In addition to disk image files, QEMU can directly access host
1107 19cb3738 bellard
devices. We describe here the usage for QEMU version >= 0.8.3.
1108 19cb3738 bellard
1109 19cb3738 bellard
@subsubsection Linux
1110 19cb3738 bellard
1111 19cb3738 bellard
On Linux, you can directly use the host device filename instead of a
1112 19cb3738 bellard
disk image filename provided you have enough proviledge to access
1113 19cb3738 bellard
it. For example, use @file{/dev/cdrom} to access to the CDROM or
1114 19cb3738 bellard
@file{/dev/fd0} for the floppy.
1115 19cb3738 bellard
1116 f542086d bellard
@table @code
1117 19cb3738 bellard
@item CD
1118 19cb3738 bellard
You can specify a CDROM device even if no CDROM is loaded. QEMU has
1119 19cb3738 bellard
specific code to detect CDROM insertion or removal. CDROM ejection by
1120 19cb3738 bellard
the guest OS is supported. Currently only data CDs are supported.
1121 19cb3738 bellard
@item Floppy
1122 19cb3738 bellard
You can specify a floppy device even if no floppy is loaded. Floppy
1123 19cb3738 bellard
removal is currently not detected accurately (if you change floppy
1124 19cb3738 bellard
without doing floppy access while the floppy is not loaded, the guest
1125 19cb3738 bellard
OS will think that the same floppy is loaded).
1126 19cb3738 bellard
@item Hard disks
1127 19cb3738 bellard
Hard disks can be used. Normally you must specify the whole disk
1128 19cb3738 bellard
(@file{/dev/hdb} instead of @file{/dev/hdb1}) so that the guest OS can
1129 19cb3738 bellard
see it as a partitioned disk. WARNING: unless you know what you do, it
1130 19cb3738 bellard
is better to only make READ-ONLY accesses to the hard disk otherwise
1131 19cb3738 bellard
you may corrupt your host data (use the @option{-snapshot} command
1132 19cb3738 bellard
line option or modify the device permissions accordingly).
1133 19cb3738 bellard
@end table
1134 19cb3738 bellard
1135 19cb3738 bellard
@subsubsection Windows
1136 19cb3738 bellard
1137 01781963 bellard
@table @code
1138 01781963 bellard
@item CD
1139 01781963 bellard
The prefered syntax is the drive letter (e.g. @file{d:}). The
1140 01781963 bellard
alternate syntax @file{\\.\d:} is supported. @file{/dev/cdrom} is
1141 01781963 bellard
supported as an alias to the first CDROM drive.
1142 19cb3738 bellard
1143 e598752a ths
Currently there is no specific code to handle removable media, so it
1144 19cb3738 bellard
is better to use the @code{change} or @code{eject} monitor commands to
1145 19cb3738 bellard
change or eject media.
1146 01781963 bellard
@item Hard disks
1147 01781963 bellard
Hard disks can be used with the syntax: @file{\\.\PhysicalDriveN}
1148 01781963 bellard
where @var{N} is the drive number (0 is the first hard disk).
1149 01781963 bellard
1150 01781963 bellard
WARNING: unless you know what you do, it is better to only make
1151 01781963 bellard
READ-ONLY accesses to the hard disk otherwise you may corrupt your
1152 01781963 bellard
host data (use the @option{-snapshot} command line so that the
1153 01781963 bellard
modifications are written in a temporary file).
1154 01781963 bellard
@end table
1155 01781963 bellard
1156 19cb3738 bellard
1157 19cb3738 bellard
@subsubsection Mac OS X
1158 19cb3738 bellard
1159 19cb3738 bellard
@file{/dev/cdrom} is an alias to the first CDROM. 
1160 19cb3738 bellard
1161 e598752a ths
Currently there is no specific code to handle removable media, so it
1162 19cb3738 bellard
is better to use the @code{change} or @code{eject} monitor commands to
1163 19cb3738 bellard
change or eject media.
1164 19cb3738 bellard
1165 debc7065 bellard
@node disk_images_fat_images
1166 2c6cadd4 bellard
@subsection Virtual FAT disk images
1167 2c6cadd4 bellard
1168 2c6cadd4 bellard
QEMU can automatically create a virtual FAT disk image from a
1169 2c6cadd4 bellard
directory tree. In order to use it, just type:
1170 2c6cadd4 bellard
1171 2c6cadd4 bellard
@example 
1172 2c6cadd4 bellard
qemu linux.img -hdb fat:/my_directory
1173 2c6cadd4 bellard
@end example
1174 2c6cadd4 bellard
1175 2c6cadd4 bellard
Then you access access to all the files in the @file{/my_directory}
1176 2c6cadd4 bellard
directory without having to copy them in a disk image or to export
1177 2c6cadd4 bellard
them via SAMBA or NFS. The default access is @emph{read-only}.
1178 2c6cadd4 bellard
1179 2c6cadd4 bellard
Floppies can be emulated with the @code{:floppy:} option:
1180 2c6cadd4 bellard
1181 2c6cadd4 bellard
@example 
1182 2c6cadd4 bellard
qemu linux.img -fda fat:floppy:/my_directory
1183 2c6cadd4 bellard
@end example
1184 2c6cadd4 bellard
1185 2c6cadd4 bellard
A read/write support is available for testing (beta stage) with the
1186 2c6cadd4 bellard
@code{:rw:} option:
1187 2c6cadd4 bellard
1188 2c6cadd4 bellard
@example 
1189 2c6cadd4 bellard
qemu linux.img -fda fat:floppy:rw:/my_directory
1190 2c6cadd4 bellard
@end example
1191 2c6cadd4 bellard
1192 2c6cadd4 bellard
What you should @emph{never} do:
1193 2c6cadd4 bellard
@itemize
1194 2c6cadd4 bellard
@item use non-ASCII filenames ;
1195 2c6cadd4 bellard
@item use "-snapshot" together with ":rw:" ;
1196 85b2c688 bellard
@item expect it to work when loadvm'ing ;
1197 85b2c688 bellard
@item write to the FAT directory on the host system while accessing it with the guest system.
1198 2c6cadd4 bellard
@end itemize
1199 2c6cadd4 bellard
1200 debc7065 bellard
@node pcsys_network
1201 9d4fb82e bellard
@section Network emulation
1202 9d4fb82e bellard
1203 41d03949 bellard
QEMU can simulate several networks cards (NE2000 boards on the PC
1204 41d03949 bellard
target) and can connect them to an arbitrary number of Virtual Local
1205 41d03949 bellard
Area Networks (VLANs). Host TAP devices can be connected to any QEMU
1206 41d03949 bellard
VLAN. VLAN can be connected between separate instances of QEMU to
1207 41d03949 bellard
simulate large networks. For simpler usage, a non priviledged user mode
1208 41d03949 bellard
network stack can replace the TAP device to have a basic network
1209 41d03949 bellard
connection.
1210 41d03949 bellard
1211 41d03949 bellard
@subsection VLANs
1212 9d4fb82e bellard
1213 41d03949 bellard
QEMU simulates several VLANs. A VLAN can be symbolised as a virtual
1214 41d03949 bellard
connection between several network devices. These devices can be for
1215 41d03949 bellard
example QEMU virtual Ethernet cards or virtual Host ethernet devices
1216 41d03949 bellard
(TAP devices).
1217 9d4fb82e bellard
1218 41d03949 bellard
@subsection Using TAP network interfaces
1219 41d03949 bellard
1220 41d03949 bellard
This is the standard way to connect QEMU to a real network. QEMU adds
1221 41d03949 bellard
a virtual network device on your host (called @code{tapN}), and you
1222 41d03949 bellard
can then configure it as if it was a real ethernet card.
1223 9d4fb82e bellard
1224 8f40c388 bellard
@subsubsection Linux host
1225 8f40c388 bellard
1226 9d4fb82e bellard
As an example, you can download the @file{linux-test-xxx.tar.gz}
1227 9d4fb82e bellard
archive and copy the script @file{qemu-ifup} in @file{/etc} and
1228 9d4fb82e bellard
configure properly @code{sudo} so that the command @code{ifconfig}
1229 9d4fb82e bellard
contained in @file{qemu-ifup} can be executed as root. You must verify
1230 41d03949 bellard
that your host kernel supports the TAP network interfaces: the
1231 9d4fb82e bellard
device @file{/dev/net/tun} must be present.
1232 9d4fb82e bellard
1233 ee0f4751 bellard
See @ref{sec_invocation} to have examples of command lines using the
1234 ee0f4751 bellard
TAP network interfaces.
1235 9d4fb82e bellard
1236 8f40c388 bellard
@subsubsection Windows host
1237 8f40c388 bellard
1238 8f40c388 bellard
There is a virtual ethernet driver for Windows 2000/XP systems, called
1239 8f40c388 bellard
TAP-Win32. But it is not included in standard QEMU for Windows,
1240 8f40c388 bellard
so you will need to get it separately. It is part of OpenVPN package,
1241 8f40c388 bellard
so download OpenVPN from : @url{http://openvpn.net/}.
1242 8f40c388 bellard
1243 9d4fb82e bellard
@subsection Using the user mode network stack
1244 9d4fb82e bellard
1245 41d03949 bellard
By using the option @option{-net user} (default configuration if no
1246 41d03949 bellard
@option{-net} option is specified), QEMU uses a completely user mode
1247 41d03949 bellard
network stack (you don't need root priviledge to use the virtual
1248 41d03949 bellard
network). The virtual network configuration is the following:
1249 9d4fb82e bellard
1250 9d4fb82e bellard
@example
1251 9d4fb82e bellard
1252 41d03949 bellard
         QEMU VLAN      <------>  Firewall/DHCP server <-----> Internet
1253 41d03949 bellard
                           |          (10.0.2.2)
1254 9d4fb82e bellard
                           |
1255 2518bd0d bellard
                           ---->  DNS server (10.0.2.3)
1256 2518bd0d bellard
                           |     
1257 2518bd0d bellard
                           ---->  SMB server (10.0.2.4)
1258 9d4fb82e bellard
@end example
1259 9d4fb82e bellard
1260 9d4fb82e bellard
The QEMU VM behaves as if it was behind a firewall which blocks all
1261 9d4fb82e bellard
incoming connections. You can use a DHCP client to automatically
1262 41d03949 bellard
configure the network in the QEMU VM. The DHCP server assign addresses
1263 41d03949 bellard
to the hosts starting from 10.0.2.15.
1264 9d4fb82e bellard
1265 9d4fb82e bellard
In order to check that the user mode network is working, you can ping
1266 9d4fb82e bellard
the address 10.0.2.2 and verify that you got an address in the range
1267 9d4fb82e bellard
10.0.2.x from the QEMU virtual DHCP server.
1268 9d4fb82e bellard
1269 b415a407 bellard
Note that @code{ping} is not supported reliably to the internet as it
1270 b415a407 bellard
would require root priviledges. It means you can only ping the local
1271 b415a407 bellard
router (10.0.2.2).
1272 b415a407 bellard
1273 9bf05444 bellard
When using the built-in TFTP server, the router is also the TFTP
1274 9bf05444 bellard
server.
1275 9bf05444 bellard
1276 9bf05444 bellard
When using the @option{-redir} option, TCP or UDP connections can be
1277 9bf05444 bellard
redirected from the host to the guest. It allows for example to
1278 9bf05444 bellard
redirect X11, telnet or SSH connections.
1279 443f1376 bellard
1280 41d03949 bellard
@subsection Connecting VLANs between QEMU instances
1281 41d03949 bellard
1282 41d03949 bellard
Using the @option{-net socket} option, it is possible to make VLANs
1283 41d03949 bellard
that span several QEMU instances. See @ref{sec_invocation} to have a
1284 41d03949 bellard
basic example.
1285 41d03949 bellard
1286 9d4fb82e bellard
@node direct_linux_boot
1287 9d4fb82e bellard
@section Direct Linux Boot
1288 1f673135 bellard
1289 1f673135 bellard
This section explains how to launch a Linux kernel inside QEMU without
1290 1f673135 bellard
having to make a full bootable image. It is very useful for fast Linux
1291 ee0f4751 bellard
kernel testing.
1292 1f673135 bellard
1293 ee0f4751 bellard
The syntax is:
1294 1f673135 bellard
@example
1295 ee0f4751 bellard
qemu -kernel arch/i386/boot/bzImage -hda root-2.4.20.img -append "root=/dev/hda"
1296 1f673135 bellard
@end example
1297 1f673135 bellard
1298 ee0f4751 bellard
Use @option{-kernel} to provide the Linux kernel image and
1299 ee0f4751 bellard
@option{-append} to give the kernel command line arguments. The
1300 ee0f4751 bellard
@option{-initrd} option can be used to provide an INITRD image.
1301 1f673135 bellard
1302 ee0f4751 bellard
When using the direct Linux boot, a disk image for the first hard disk
1303 ee0f4751 bellard
@file{hda} is required because its boot sector is used to launch the
1304 ee0f4751 bellard
Linux kernel.
1305 1f673135 bellard
1306 ee0f4751 bellard
If you do not need graphical output, you can disable it and redirect
1307 ee0f4751 bellard
the virtual serial port and the QEMU monitor to the console with the
1308 ee0f4751 bellard
@option{-nographic} option. The typical command line is:
1309 1f673135 bellard
@example
1310 ee0f4751 bellard
qemu -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1311 ee0f4751 bellard
     -append "root=/dev/hda console=ttyS0" -nographic
1312 1f673135 bellard
@end example
1313 1f673135 bellard
1314 ee0f4751 bellard
Use @key{Ctrl-a c} to switch between the serial console and the
1315 ee0f4751 bellard
monitor (@pxref{pcsys_keys}).
1316 1f673135 bellard
1317 debc7065 bellard
@node pcsys_usb
1318 b389dbfb bellard
@section USB emulation
1319 b389dbfb bellard
1320 0aff66b5 pbrook
QEMU emulates a PCI UHCI USB controller. You can virtually plug
1321 0aff66b5 pbrook
virtual USB devices or real host USB devices (experimental, works only
1322 0aff66b5 pbrook
on Linux hosts).  Qemu will automatically create and connect virtual USB hubs
1323 f542086d bellard
as necessary to connect multiple USB devices.
1324 b389dbfb bellard
1325 0aff66b5 pbrook
@menu
1326 0aff66b5 pbrook
* usb_devices::
1327 0aff66b5 pbrook
* host_usb_devices::
1328 0aff66b5 pbrook
@end menu
1329 0aff66b5 pbrook
@node usb_devices
1330 0aff66b5 pbrook
@subsection Connecting USB devices
1331 b389dbfb bellard
1332 0aff66b5 pbrook
USB devices can be connected with the @option{-usbdevice} commandline option
1333 0aff66b5 pbrook
or the @code{usb_add} monitor command.  Available devices are:
1334 b389dbfb bellard
1335 0aff66b5 pbrook
@table @var
1336 0aff66b5 pbrook
@item @code{mouse}
1337 0aff66b5 pbrook
Virtual Mouse.  This will override the PS/2 mouse emulation when activated.
1338 0aff66b5 pbrook
@item @code{tablet}
1339 c6d46c20 bellard
Pointer device that uses absolute coordinates (like a touchscreen).
1340 0aff66b5 pbrook
This means qemu is able to report the mouse position without having
1341 0aff66b5 pbrook
to grab the mouse.  Also overrides the PS/2 mouse emulation when activated.
1342 0aff66b5 pbrook
@item @code{disk:file}
1343 0aff66b5 pbrook
Mass storage device based on @var{file} (@pxref{disk_images})
1344 0aff66b5 pbrook
@item @code{host:bus.addr}
1345 0aff66b5 pbrook
Pass through the host device identified by @var{bus.addr}
1346 0aff66b5 pbrook
(Linux only)
1347 0aff66b5 pbrook
@item @code{host:vendor_id:product_id}
1348 0aff66b5 pbrook
Pass through the host device identified by @var{vendor_id:product_id}
1349 0aff66b5 pbrook
(Linux only)
1350 0aff66b5 pbrook
@end table
1351 b389dbfb bellard
1352 0aff66b5 pbrook
@node host_usb_devices
1353 b389dbfb bellard
@subsection Using host USB devices on a Linux host
1354 b389dbfb bellard
1355 b389dbfb bellard
WARNING: this is an experimental feature. QEMU will slow down when
1356 b389dbfb bellard
using it. USB devices requiring real time streaming (i.e. USB Video
1357 b389dbfb bellard
Cameras) are not supported yet.
1358 b389dbfb bellard
1359 b389dbfb bellard
@enumerate
1360 b389dbfb bellard
@item If you use an early Linux 2.4 kernel, verify that no Linux driver 
1361 b389dbfb bellard
is actually using the USB device. A simple way to do that is simply to
1362 b389dbfb bellard
disable the corresponding kernel module by renaming it from @file{mydriver.o}
1363 b389dbfb bellard
to @file{mydriver.o.disabled}.
1364 b389dbfb bellard
1365 b389dbfb bellard
@item Verify that @file{/proc/bus/usb} is working (most Linux distributions should enable it by default). You should see something like that:
1366 b389dbfb bellard
@example
1367 b389dbfb bellard
ls /proc/bus/usb
1368 b389dbfb bellard
001  devices  drivers
1369 b389dbfb bellard
@end example
1370 b389dbfb bellard
1371 b389dbfb bellard
@item Since only root can access to the USB devices directly, you can either launch QEMU as root or change the permissions of the USB devices you want to use. For testing, the following suffices:
1372 b389dbfb bellard
@example
1373 b389dbfb bellard
chown -R myuid /proc/bus/usb
1374 b389dbfb bellard
@end example
1375 b389dbfb bellard
1376 b389dbfb bellard
@item Launch QEMU and do in the monitor:
1377 b389dbfb bellard
@example 
1378 b389dbfb bellard
info usbhost
1379 b389dbfb bellard
  Device 1.2, speed 480 Mb/s
1380 b389dbfb bellard
    Class 00: USB device 1234:5678, USB DISK
1381 b389dbfb bellard
@end example
1382 b389dbfb bellard
You should see the list of the devices you can use (Never try to use
1383 b389dbfb bellard
hubs, it won't work).
1384 b389dbfb bellard
1385 b389dbfb bellard
@item Add the device in QEMU by using:
1386 b389dbfb bellard
@example 
1387 b389dbfb bellard
usb_add host:1234:5678
1388 b389dbfb bellard
@end example
1389 b389dbfb bellard
1390 b389dbfb bellard
Normally the guest OS should report that a new USB device is
1391 b389dbfb bellard
plugged. You can use the option @option{-usbdevice} to do the same.
1392 b389dbfb bellard
1393 b389dbfb bellard
@item Now you can try to use the host USB device in QEMU.
1394 b389dbfb bellard
1395 b389dbfb bellard
@end enumerate
1396 b389dbfb bellard
1397 b389dbfb bellard
When relaunching QEMU, you may have to unplug and plug again the USB
1398 b389dbfb bellard
device to make it work again (this is a bug).
1399 b389dbfb bellard
1400 0806e3f6 bellard
@node gdb_usage
1401 da415d54 bellard
@section GDB usage
1402 da415d54 bellard
1403 da415d54 bellard
QEMU has a primitive support to work with gdb, so that you can do
1404 0806e3f6 bellard
'Ctrl-C' while the virtual machine is running and inspect its state.
1405 da415d54 bellard
1406 9d4520d0 bellard
In order to use gdb, launch qemu with the '-s' option. It will wait for a
1407 da415d54 bellard
gdb connection:
1408 da415d54 bellard
@example
1409 debc7065 bellard
> qemu -s -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1410 debc7065 bellard
       -append "root=/dev/hda"
1411 da415d54 bellard
Connected to host network interface: tun0
1412 da415d54 bellard
Waiting gdb connection on port 1234
1413 da415d54 bellard
@end example
1414 da415d54 bellard
1415 da415d54 bellard
Then launch gdb on the 'vmlinux' executable:
1416 da415d54 bellard
@example
1417 da415d54 bellard
> gdb vmlinux
1418 da415d54 bellard
@end example
1419 da415d54 bellard
1420 da415d54 bellard
In gdb, connect to QEMU:
1421 da415d54 bellard
@example
1422 6c9bf893 bellard
(gdb) target remote localhost:1234
1423 da415d54 bellard
@end example
1424 da415d54 bellard
1425 da415d54 bellard
Then you can use gdb normally. For example, type 'c' to launch the kernel:
1426 da415d54 bellard
@example
1427 da415d54 bellard
(gdb) c
1428 da415d54 bellard
@end example
1429 da415d54 bellard
1430 0806e3f6 bellard
Here are some useful tips in order to use gdb on system code:
1431 0806e3f6 bellard
1432 0806e3f6 bellard
@enumerate
1433 0806e3f6 bellard
@item
1434 0806e3f6 bellard
Use @code{info reg} to display all the CPU registers.
1435 0806e3f6 bellard
@item
1436 0806e3f6 bellard
Use @code{x/10i $eip} to display the code at the PC position.
1437 0806e3f6 bellard
@item
1438 0806e3f6 bellard
Use @code{set architecture i8086} to dump 16 bit code. Then use
1439 294e8637 bellard
@code{x/10i $cs*16+$eip} to dump the code at the PC position.
1440 0806e3f6 bellard
@end enumerate
1441 0806e3f6 bellard
1442 debc7065 bellard
@node pcsys_os_specific
1443 1a084f3d bellard
@section Target OS specific information
1444 1a084f3d bellard
1445 1a084f3d bellard
@subsection Linux
1446 1a084f3d bellard
1447 15a34c63 bellard
To have access to SVGA graphic modes under X11, use the @code{vesa} or
1448 15a34c63 bellard
the @code{cirrus} X11 driver. For optimal performances, use 16 bit
1449 15a34c63 bellard
color depth in the guest and the host OS.
1450 1a084f3d bellard
1451 e3371e62 bellard
When using a 2.6 guest Linux kernel, you should add the option
1452 e3371e62 bellard
@code{clock=pit} on the kernel command line because the 2.6 Linux
1453 e3371e62 bellard
kernels make very strict real time clock checks by default that QEMU
1454 e3371e62 bellard
cannot simulate exactly.
1455 e3371e62 bellard
1456 7c3fc84d bellard
When using a 2.6 guest Linux kernel, verify that the 4G/4G patch is
1457 7c3fc84d bellard
not activated because QEMU is slower with this patch. The QEMU
1458 7c3fc84d bellard
Accelerator Module is also much slower in this case. Earlier Fedora
1459 7c3fc84d bellard
Core 3 Linux kernel (< 2.6.9-1.724_FC3) were known to incorporte this
1460 7c3fc84d bellard
patch by default. Newer kernels don't have it.
1461 7c3fc84d bellard
1462 1a084f3d bellard
@subsection Windows
1463 1a084f3d bellard
1464 1a084f3d bellard
If you have a slow host, using Windows 95 is better as it gives the
1465 1a084f3d bellard
best speed. Windows 2000 is also a good choice.
1466 1a084f3d bellard
1467 e3371e62 bellard
@subsubsection SVGA graphic modes support
1468 e3371e62 bellard
1469 e3371e62 bellard
QEMU emulates a Cirrus Logic GD5446 Video
1470 15a34c63 bellard
card. All Windows versions starting from Windows 95 should recognize
1471 15a34c63 bellard
and use this graphic card. For optimal performances, use 16 bit color
1472 15a34c63 bellard
depth in the guest and the host OS.
1473 1a084f3d bellard
1474 3cb0853a bellard
If you are using Windows XP as guest OS and if you want to use high
1475 3cb0853a bellard
resolution modes which the Cirrus Logic BIOS does not support (i.e. >=
1476 3cb0853a bellard
1280x1024x16), then you should use the VESA VBE virtual graphic card
1477 3cb0853a bellard
(option @option{-std-vga}).
1478 3cb0853a bellard
1479 e3371e62 bellard
@subsubsection CPU usage reduction
1480 e3371e62 bellard
1481 e3371e62 bellard
Windows 9x does not correctly use the CPU HLT
1482 15a34c63 bellard
instruction. The result is that it takes host CPU cycles even when
1483 15a34c63 bellard
idle. You can install the utility from
1484 15a34c63 bellard
@url{http://www.user.cityline.ru/~maxamn/amnhltm.zip} to solve this
1485 15a34c63 bellard
problem. Note that no such tool is needed for NT, 2000 or XP.
1486 1a084f3d bellard
1487 9d0a8e6f bellard
@subsubsection Windows 2000 disk full problem
1488 e3371e62 bellard
1489 9d0a8e6f bellard
Windows 2000 has a bug which gives a disk full problem during its
1490 9d0a8e6f bellard
installation. When installing it, use the @option{-win2k-hack} QEMU
1491 9d0a8e6f bellard
option to enable a specific workaround. After Windows 2000 is
1492 9d0a8e6f bellard
installed, you no longer need this option (this option slows down the
1493 9d0a8e6f bellard
IDE transfers).
1494 e3371e62 bellard
1495 6cc721cf bellard
@subsubsection Windows 2000 shutdown
1496 6cc721cf bellard
1497 6cc721cf bellard
Windows 2000 cannot automatically shutdown in QEMU although Windows 98
1498 6cc721cf bellard
can. It comes from the fact that Windows 2000 does not automatically
1499 6cc721cf bellard
use the APM driver provided by the BIOS.
1500 6cc721cf bellard
1501 6cc721cf bellard
In order to correct that, do the following (thanks to Struan
1502 6cc721cf bellard
Bartlett): go to the Control Panel => Add/Remove Hardware & Next =>
1503 6cc721cf bellard
Add/Troubleshoot a device => Add a new device & Next => No, select the
1504 6cc721cf bellard
hardware from a list & Next => NT Apm/Legacy Support & Next => Next
1505 6cc721cf bellard
(again) a few times. Now the driver is installed and Windows 2000 now
1506 6cc721cf bellard
correctly instructs QEMU to shutdown at the appropriate moment. 
1507 6cc721cf bellard
1508 6cc721cf bellard
@subsubsection Share a directory between Unix and Windows
1509 6cc721cf bellard
1510 6cc721cf bellard
See @ref{sec_invocation} about the help of the option @option{-smb}.
1511 6cc721cf bellard
1512 2192c332 bellard
@subsubsection Windows XP security problem
1513 e3371e62 bellard
1514 e3371e62 bellard
Some releases of Windows XP install correctly but give a security
1515 e3371e62 bellard
error when booting:
1516 e3371e62 bellard
@example
1517 e3371e62 bellard
A problem is preventing Windows from accurately checking the
1518 e3371e62 bellard
license for this computer. Error code: 0x800703e6.
1519 e3371e62 bellard
@end example
1520 e3371e62 bellard
1521 2192c332 bellard
The workaround is to install a service pack for XP after a boot in safe
1522 2192c332 bellard
mode. Then reboot, and the problem should go away. Since there is no
1523 2192c332 bellard
network while in safe mode, its recommended to download the full
1524 2192c332 bellard
installation of SP1 or SP2 and transfer that via an ISO or using the
1525 2192c332 bellard
vvfat block device ("-hdb fat:directory_which_holds_the_SP").
1526 e3371e62 bellard
1527 a0a821a4 bellard
@subsection MS-DOS and FreeDOS
1528 a0a821a4 bellard
1529 a0a821a4 bellard
@subsubsection CPU usage reduction
1530 a0a821a4 bellard
1531 a0a821a4 bellard
DOS does not correctly use the CPU HLT instruction. The result is that
1532 a0a821a4 bellard
it takes host CPU cycles even when idle. You can install the utility
1533 a0a821a4 bellard
from @url{http://www.vmware.com/software/dosidle210.zip} to solve this
1534 a0a821a4 bellard
problem.
1535 a0a821a4 bellard
1536 debc7065 bellard
@node QEMU System emulator for non PC targets
1537 3f9f3aa1 bellard
@chapter QEMU System emulator for non PC targets
1538 3f9f3aa1 bellard
1539 3f9f3aa1 bellard
QEMU is a generic emulator and it emulates many non PC
1540 3f9f3aa1 bellard
machines. Most of the options are similar to the PC emulator. The
1541 3f9f3aa1 bellard
differences are mentionned in the following sections.
1542 3f9f3aa1 bellard
1543 debc7065 bellard
@menu
1544 debc7065 bellard
* QEMU PowerPC System emulator::
1545 debc7065 bellard
* Sparc32 System emulator invocation::
1546 debc7065 bellard
* Sparc64 System emulator invocation::
1547 debc7065 bellard
* MIPS System emulator invocation::
1548 debc7065 bellard
* ARM System emulator invocation::
1549 debc7065 bellard
@end menu
1550 debc7065 bellard
1551 debc7065 bellard
@node QEMU PowerPC System emulator
1552 3f9f3aa1 bellard
@section QEMU PowerPC System emulator
1553 1a084f3d bellard
1554 15a34c63 bellard
Use the executable @file{qemu-system-ppc} to simulate a complete PREP
1555 15a34c63 bellard
or PowerMac PowerPC system.
1556 1a084f3d bellard
1557 b671f9ed bellard
QEMU emulates the following PowerMac peripherals:
1558 1a084f3d bellard
1559 15a34c63 bellard
@itemize @minus
1560 15a34c63 bellard
@item 
1561 15a34c63 bellard
UniNorth PCI Bridge 
1562 15a34c63 bellard
@item
1563 15a34c63 bellard
PCI VGA compatible card with VESA Bochs Extensions
1564 15a34c63 bellard
@item 
1565 15a34c63 bellard
2 PMAC IDE interfaces with hard disk and CD-ROM support
1566 15a34c63 bellard
@item 
1567 15a34c63 bellard
NE2000 PCI adapters
1568 15a34c63 bellard
@item
1569 15a34c63 bellard
Non Volatile RAM
1570 15a34c63 bellard
@item
1571 15a34c63 bellard
VIA-CUDA with ADB keyboard and mouse.
1572 1a084f3d bellard
@end itemize
1573 1a084f3d bellard
1574 b671f9ed bellard
QEMU emulates the following PREP peripherals:
1575 52c00a5f bellard
1576 52c00a5f bellard
@itemize @minus
1577 52c00a5f bellard
@item 
1578 15a34c63 bellard
PCI Bridge
1579 15a34c63 bellard
@item
1580 15a34c63 bellard
PCI VGA compatible card with VESA Bochs Extensions
1581 15a34c63 bellard
@item 
1582 52c00a5f bellard
2 IDE interfaces with hard disk and CD-ROM support
1583 52c00a5f bellard
@item
1584 52c00a5f bellard
Floppy disk
1585 52c00a5f bellard
@item 
1586 15a34c63 bellard
NE2000 network adapters
1587 52c00a5f bellard
@item
1588 52c00a5f bellard
Serial port
1589 52c00a5f bellard
@item
1590 52c00a5f bellard
PREP Non Volatile RAM
1591 15a34c63 bellard
@item
1592 15a34c63 bellard
PC compatible keyboard and mouse.
1593 52c00a5f bellard
@end itemize
1594 52c00a5f bellard
1595 15a34c63 bellard
QEMU uses the Open Hack'Ware Open Firmware Compatible BIOS available at
1596 3f9f3aa1 bellard
@url{http://perso.magic.fr/l_indien/OpenHackWare/index.htm}.
1597 52c00a5f bellard
1598 15a34c63 bellard
@c man begin OPTIONS
1599 15a34c63 bellard
1600 15a34c63 bellard
The following options are specific to the PowerPC emulation:
1601 15a34c63 bellard
1602 15a34c63 bellard
@table @option
1603 15a34c63 bellard
1604 15a34c63 bellard
@item -g WxH[xDEPTH]  
1605 15a34c63 bellard
1606 15a34c63 bellard
Set the initial VGA graphic mode. The default is 800x600x15.
1607 15a34c63 bellard
1608 15a34c63 bellard
@end table
1609 15a34c63 bellard
1610 15a34c63 bellard
@c man end 
1611 15a34c63 bellard
1612 15a34c63 bellard
1613 52c00a5f bellard
More information is available at
1614 3f9f3aa1 bellard
@url{http://perso.magic.fr/l_indien/qemu-ppc/}.
1615 52c00a5f bellard
1616 debc7065 bellard
@node Sparc32 System emulator invocation
1617 3f9f3aa1 bellard
@section Sparc32 System emulator invocation
1618 e80cfcfc bellard
1619 0986ac3b bellard
Use the executable @file{qemu-system-sparc} to simulate a SparcStation 5
1620 3475187d bellard
(sun4m architecture). The emulation is somewhat complete.
1621 e80cfcfc bellard
1622 b671f9ed bellard
QEMU emulates the following sun4m peripherals:
1623 e80cfcfc bellard
1624 e80cfcfc bellard
@itemize @minus
1625 3475187d bellard
@item
1626 e80cfcfc bellard
IOMMU
1627 e80cfcfc bellard
@item
1628 e80cfcfc bellard
TCX Frame buffer
1629 e80cfcfc bellard
@item 
1630 e80cfcfc bellard
Lance (Am7990) Ethernet
1631 e80cfcfc bellard
@item
1632 e80cfcfc bellard
Non Volatile RAM M48T08
1633 e80cfcfc bellard
@item
1634 3475187d bellard
Slave I/O: timers, interrupt controllers, Zilog serial ports, keyboard
1635 3475187d bellard
and power/reset logic
1636 3475187d bellard
@item
1637 3475187d bellard
ESP SCSI controller with hard disk and CD-ROM support
1638 3475187d bellard
@item
1639 3475187d bellard
Floppy drive
1640 e80cfcfc bellard
@end itemize
1641 e80cfcfc bellard
1642 3475187d bellard
The number of peripherals is fixed in the architecture.
1643 3475187d bellard
1644 30a604f3 bellard
Since version 0.8.2, QEMU uses OpenBIOS
1645 0986ac3b bellard
@url{http://www.openbios.org/}. OpenBIOS is a free (GPL v2) portable
1646 0986ac3b bellard
firmware implementation. The goal is to implement a 100% IEEE
1647 0986ac3b bellard
1275-1994 (referred to as Open Firmware) compliant firmware.
1648 3475187d bellard
1649 3475187d bellard
A sample Linux 2.6 series kernel and ram disk image are available on
1650 0986ac3b bellard
the QEMU web site. Please note that currently NetBSD, OpenBSD or
1651 0986ac3b bellard
Solaris kernels don't work.
1652 3475187d bellard
1653 3475187d bellard
@c man begin OPTIONS
1654 3475187d bellard
1655 3475187d bellard
The following options are specific to the Sparc emulation:
1656 3475187d bellard
1657 3475187d bellard
@table @option
1658 3475187d bellard
1659 3475187d bellard
@item -g WxH
1660 3475187d bellard
1661 3475187d bellard
Set the initial TCX graphic mode. The default is 1024x768.
1662 3475187d bellard
1663 3475187d bellard
@end table
1664 3475187d bellard
1665 3475187d bellard
@c man end 
1666 3475187d bellard
1667 debc7065 bellard
@node Sparc64 System emulator invocation
1668 3f9f3aa1 bellard
@section Sparc64 System emulator invocation
1669 e80cfcfc bellard
1670 3475187d bellard
Use the executable @file{qemu-system-sparc64} to simulate a Sun4u machine.
1671 3475187d bellard
The emulator is not usable for anything yet.
1672 b756921a bellard
1673 83469015 bellard
QEMU emulates the following sun4u peripherals:
1674 83469015 bellard
1675 83469015 bellard
@itemize @minus
1676 83469015 bellard
@item
1677 83469015 bellard
UltraSparc IIi APB PCI Bridge 
1678 83469015 bellard
@item
1679 83469015 bellard
PCI VGA compatible card with VESA Bochs Extensions
1680 83469015 bellard
@item
1681 83469015 bellard
Non Volatile RAM M48T59
1682 83469015 bellard
@item
1683 83469015 bellard
PC-compatible serial ports
1684 83469015 bellard
@end itemize
1685 83469015 bellard
1686 debc7065 bellard
@node MIPS System emulator invocation
1687 3f9f3aa1 bellard
@section MIPS System emulator invocation
1688 9d0a8e6f bellard
1689 9d0a8e6f bellard
Use the executable @file{qemu-system-mips} to simulate a MIPS machine.
1690 3f9f3aa1 bellard
The emulator is able to boot a Linux kernel and to run a Linux Debian
1691 3f9f3aa1 bellard
installation from NFS. The following devices are emulated:
1692 3f9f3aa1 bellard
1693 3f9f3aa1 bellard
@itemize @minus
1694 3f9f3aa1 bellard
@item 
1695 3f9f3aa1 bellard
MIPS R4K CPU
1696 3f9f3aa1 bellard
@item
1697 3f9f3aa1 bellard
PC style serial port
1698 3f9f3aa1 bellard
@item
1699 3f9f3aa1 bellard
NE2000 network card
1700 3f9f3aa1 bellard
@end itemize
1701 3f9f3aa1 bellard
1702 3f9f3aa1 bellard
More information is available in the QEMU mailing-list archive.
1703 3f9f3aa1 bellard
1704 debc7065 bellard
@node ARM System emulator invocation
1705 3f9f3aa1 bellard
@section ARM System emulator invocation
1706 3f9f3aa1 bellard
1707 3f9f3aa1 bellard
Use the executable @file{qemu-system-arm} to simulate a ARM
1708 3f9f3aa1 bellard
machine. The ARM Integrator/CP board is emulated with the following
1709 3f9f3aa1 bellard
devices:
1710 3f9f3aa1 bellard
1711 3f9f3aa1 bellard
@itemize @minus
1712 3f9f3aa1 bellard
@item
1713 ed96ca35 pbrook
ARM926E or ARM1026E CPU
1714 3f9f3aa1 bellard
@item
1715 3f9f3aa1 bellard
Two PL011 UARTs
1716 3f9f3aa1 bellard
@item 
1717 3f9f3aa1 bellard
SMC 91c111 Ethernet adapter
1718 00a9bf19 pbrook
@item
1719 00a9bf19 pbrook
PL110 LCD controller
1720 00a9bf19 pbrook
@item
1721 00a9bf19 pbrook
PL050 KMI with PS/2 keyboard and mouse.
1722 a1bb27b1 pbrook
@item
1723 a1bb27b1 pbrook
PL181 MultiMedia Card Interface with SD card.
1724 00a9bf19 pbrook
@end itemize
1725 00a9bf19 pbrook
1726 00a9bf19 pbrook
The ARM Versatile baseboard is emulated with the following devices:
1727 00a9bf19 pbrook
1728 00a9bf19 pbrook
@itemize @minus
1729 00a9bf19 pbrook
@item
1730 00a9bf19 pbrook
ARM926E CPU
1731 00a9bf19 pbrook
@item
1732 00a9bf19 pbrook
PL190 Vectored Interrupt Controller
1733 00a9bf19 pbrook
@item
1734 00a9bf19 pbrook
Four PL011 UARTs
1735 00a9bf19 pbrook
@item 
1736 00a9bf19 pbrook
SMC 91c111 Ethernet adapter
1737 00a9bf19 pbrook
@item
1738 00a9bf19 pbrook
PL110 LCD controller
1739 00a9bf19 pbrook
@item
1740 00a9bf19 pbrook
PL050 KMI with PS/2 keyboard and mouse.
1741 00a9bf19 pbrook
@item
1742 00a9bf19 pbrook
PCI host bridge.  Note the emulated PCI bridge only provides access to
1743 00a9bf19 pbrook
PCI memory space.  It does not provide access to PCI IO space.
1744 00a9bf19 pbrook
This means some devices (eg. ne2k_pci NIC) are not useable, and others
1745 00a9bf19 pbrook
(eg. rtl8139 NIC) are only useable when the guest drivers use the memory
1746 00a9bf19 pbrook
mapped control registers.
1747 e6de1bad pbrook
@item
1748 e6de1bad pbrook
PCI OHCI USB controller.
1749 e6de1bad pbrook
@item
1750 e6de1bad pbrook
LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices.
1751 a1bb27b1 pbrook
@item
1752 a1bb27b1 pbrook
PL181 MultiMedia Card Interface with SD card.
1753 3f9f3aa1 bellard
@end itemize
1754 3f9f3aa1 bellard
1755 d7739d75 pbrook
The ARM RealView Emulation baseboard is emulated with the following devices:
1756 d7739d75 pbrook
1757 d7739d75 pbrook
@itemize @minus
1758 d7739d75 pbrook
@item
1759 d7739d75 pbrook
ARM926E CPU
1760 d7739d75 pbrook
@item
1761 d7739d75 pbrook
ARM AMBA Generic/Distributed Interrupt Controller
1762 d7739d75 pbrook
@item
1763 d7739d75 pbrook
Four PL011 UARTs
1764 d7739d75 pbrook
@item 
1765 d7739d75 pbrook
SMC 91c111 Ethernet adapter
1766 d7739d75 pbrook
@item
1767 d7739d75 pbrook
PL110 LCD controller
1768 d7739d75 pbrook
@item
1769 d7739d75 pbrook
PL050 KMI with PS/2 keyboard and mouse
1770 d7739d75 pbrook
@item
1771 d7739d75 pbrook
PCI host bridge
1772 d7739d75 pbrook
@item
1773 d7739d75 pbrook
PCI OHCI USB controller
1774 d7739d75 pbrook
@item
1775 d7739d75 pbrook
LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices
1776 a1bb27b1 pbrook
@item
1777 a1bb27b1 pbrook
PL181 MultiMedia Card Interface with SD card.
1778 d7739d75 pbrook
@end itemize
1779 d7739d75 pbrook
1780 3f9f3aa1 bellard
A Linux 2.6 test image is available on the QEMU web site. More
1781 3f9f3aa1 bellard
information is available in the QEMU mailing-list archive.
1782 9d0a8e6f bellard
1783 83195237 bellard
@node QEMU User space emulator 
1784 83195237 bellard
@chapter QEMU User space emulator 
1785 83195237 bellard
1786 83195237 bellard
@menu
1787 83195237 bellard
* Supported Operating Systems ::
1788 83195237 bellard
* Linux User space emulator::
1789 83195237 bellard
* Mac OS X/Darwin User space emulator ::
1790 83195237 bellard
@end menu
1791 83195237 bellard
1792 83195237 bellard
@node Supported Operating Systems
1793 83195237 bellard
@section Supported Operating Systems
1794 83195237 bellard
1795 83195237 bellard
The following OS are supported in user space emulation:
1796 83195237 bellard
1797 83195237 bellard
@itemize @minus
1798 83195237 bellard
@item
1799 83195237 bellard
Linux (refered as qemu-linux-user)
1800 83195237 bellard
@item
1801 83195237 bellard
Mac OS X/Darwin (refered as qemu-darwin-user)
1802 83195237 bellard
@end itemize
1803 83195237 bellard
1804 83195237 bellard
@node Linux User space emulator
1805 83195237 bellard
@section Linux User space emulator
1806 386405f7 bellard
1807 debc7065 bellard
@menu
1808 debc7065 bellard
* Quick Start::
1809 debc7065 bellard
* Wine launch::
1810 debc7065 bellard
* Command line options::
1811 79737e4a pbrook
* Other binaries::
1812 debc7065 bellard
@end menu
1813 debc7065 bellard
1814 debc7065 bellard
@node Quick Start
1815 83195237 bellard
@subsection Quick Start
1816 df0f11a0 bellard
1817 1f673135 bellard
In order to launch a Linux process, QEMU needs the process executable
1818 1f673135 bellard
itself and all the target (x86) dynamic libraries used by it. 
1819 386405f7 bellard
1820 1f673135 bellard
@itemize
1821 386405f7 bellard
1822 1f673135 bellard
@item On x86, you can just try to launch any process by using the native
1823 1f673135 bellard
libraries:
1824 386405f7 bellard
1825 1f673135 bellard
@example 
1826 1f673135 bellard
qemu-i386 -L / /bin/ls
1827 1f673135 bellard
@end example
1828 386405f7 bellard
1829 1f673135 bellard
@code{-L /} tells that the x86 dynamic linker must be searched with a
1830 1f673135 bellard
@file{/} prefix.
1831 386405f7 bellard
1832 dbcf5e82 ths
@item Since QEMU is also a linux process, you can launch qemu with
1833 dbcf5e82 ths
qemu (NOTE: you can only do that if you compiled QEMU from the sources):
1834 386405f7 bellard
1835 1f673135 bellard
@example 
1836 1f673135 bellard
qemu-i386 -L / qemu-i386 -L / /bin/ls
1837 1f673135 bellard
@end example
1838 386405f7 bellard
1839 1f673135 bellard
@item On non x86 CPUs, you need first to download at least an x86 glibc
1840 1f673135 bellard
(@file{qemu-runtime-i386-XXX-.tar.gz} on the QEMU web page). Ensure that
1841 1f673135 bellard
@code{LD_LIBRARY_PATH} is not set:
1842 df0f11a0 bellard
1843 1f673135 bellard
@example
1844 1f673135 bellard
unset LD_LIBRARY_PATH 
1845 1f673135 bellard
@end example
1846 1eb87257 bellard
1847 1f673135 bellard
Then you can launch the precompiled @file{ls} x86 executable:
1848 1eb87257 bellard
1849 1f673135 bellard
@example
1850 1f673135 bellard
qemu-i386 tests/i386/ls
1851 1f673135 bellard
@end example
1852 1f673135 bellard
You can look at @file{qemu-binfmt-conf.sh} so that
1853 1f673135 bellard
QEMU is automatically launched by the Linux kernel when you try to
1854 1f673135 bellard
launch x86 executables. It requires the @code{binfmt_misc} module in the
1855 1f673135 bellard
Linux kernel.
1856 1eb87257 bellard
1857 1f673135 bellard
@item The x86 version of QEMU is also included. You can try weird things such as:
1858 1f673135 bellard
@example
1859 debc7065 bellard
qemu-i386 /usr/local/qemu-i386/bin/qemu-i386 \
1860 debc7065 bellard
          /usr/local/qemu-i386/bin/ls-i386
1861 1f673135 bellard
@end example
1862 1eb20527 bellard
1863 1f673135 bellard
@end itemize
1864 1eb20527 bellard
1865 debc7065 bellard
@node Wine launch
1866 83195237 bellard
@subsection Wine launch
1867 1eb20527 bellard
1868 1f673135 bellard
@itemize
1869 386405f7 bellard
1870 1f673135 bellard
@item Ensure that you have a working QEMU with the x86 glibc
1871 1f673135 bellard
distribution (see previous section). In order to verify it, you must be
1872 1f673135 bellard
able to do:
1873 386405f7 bellard
1874 1f673135 bellard
@example
1875 1f673135 bellard
qemu-i386 /usr/local/qemu-i386/bin/ls-i386
1876 1f673135 bellard
@end example
1877 386405f7 bellard
1878 1f673135 bellard
@item Download the binary x86 Wine install
1879 1f673135 bellard
(@file{qemu-XXX-i386-wine.tar.gz} on the QEMU web page). 
1880 386405f7 bellard
1881 1f673135 bellard
@item Configure Wine on your account. Look at the provided script
1882 debc7065 bellard
@file{/usr/local/qemu-i386/@/bin/wine-conf.sh}. Your previous
1883 1f673135 bellard
@code{$@{HOME@}/.wine} directory is saved to @code{$@{HOME@}/.wine.org}.
1884 386405f7 bellard
1885 1f673135 bellard
@item Then you can try the example @file{putty.exe}:
1886 386405f7 bellard
1887 1f673135 bellard
@example
1888 debc7065 bellard
qemu-i386 /usr/local/qemu-i386/wine/bin/wine \
1889 debc7065 bellard
          /usr/local/qemu-i386/wine/c/Program\ Files/putty.exe
1890 1f673135 bellard
@end example
1891 386405f7 bellard
1892 1f673135 bellard
@end itemize
1893 fd429f2f bellard
1894 debc7065 bellard
@node Command line options
1895 83195237 bellard
@subsection Command line options
1896 1eb20527 bellard
1897 1f673135 bellard
@example
1898 1f673135 bellard
usage: qemu-i386 [-h] [-d] [-L path] [-s size] program [arguments...]
1899 1f673135 bellard
@end example
1900 1eb20527 bellard
1901 1f673135 bellard
@table @option
1902 1f673135 bellard
@item -h
1903 1f673135 bellard
Print the help
1904 1f673135 bellard
@item -L path   
1905 1f673135 bellard
Set the x86 elf interpreter prefix (default=/usr/local/qemu-i386)
1906 1f673135 bellard
@item -s size
1907 1f673135 bellard
Set the x86 stack size in bytes (default=524288)
1908 386405f7 bellard
@end table
1909 386405f7 bellard
1910 1f673135 bellard
Debug options:
1911 386405f7 bellard
1912 1f673135 bellard
@table @option
1913 1f673135 bellard
@item -d
1914 1f673135 bellard
Activate log (logfile=/tmp/qemu.log)
1915 1f673135 bellard
@item -p pagesize
1916 1f673135 bellard
Act as if the host page size was 'pagesize' bytes
1917 1f673135 bellard
@end table
1918 386405f7 bellard
1919 79737e4a pbrook
@node Other binaries
1920 83195237 bellard
@subsection Other binaries
1921 79737e4a pbrook
1922 79737e4a pbrook
@command{qemu-arm} is also capable of running ARM "Angel" semihosted ELF
1923 79737e4a pbrook
binaries (as implemented by the arm-elf and arm-eabi Newlib/GDB
1924 79737e4a pbrook
configurations), and arm-uclinux bFLT format binaries.
1925 79737e4a pbrook
1926 e6e5906b pbrook
@command{qemu-m68k} is capable of running semihosted binaries using the BDM
1927 e6e5906b pbrook
(m5xxx-ram-hosted.ld) or m68k-sim (sim.ld) syscall interfaces, and
1928 e6e5906b pbrook
coldfire uClinux bFLT format binaries.
1929 e6e5906b pbrook
1930 79737e4a pbrook
The binary format is detected automatically.
1931 79737e4a pbrook
1932 83195237 bellard
@node Mac OS X/Darwin User space emulator
1933 83195237 bellard
@section Mac OS X/Darwin User space emulator
1934 83195237 bellard
1935 83195237 bellard
@menu
1936 83195237 bellard
* Mac OS X/Darwin Status::
1937 83195237 bellard
* Mac OS X/Darwin Quick Start::
1938 83195237 bellard
* Mac OS X/Darwin Command line options::
1939 83195237 bellard
@end menu
1940 83195237 bellard
1941 83195237 bellard
@node Mac OS X/Darwin Status
1942 83195237 bellard
@subsection Mac OS X/Darwin Status
1943 83195237 bellard
1944 83195237 bellard
@itemize @minus
1945 83195237 bellard
@item
1946 83195237 bellard
target x86 on x86: Most apps (Cocoa and Carbon too) works. [1]
1947 83195237 bellard
@item
1948 83195237 bellard
target PowerPC on x86: Not working as the ppc commpage can't be mapped (yet!)
1949 83195237 bellard
@item
1950 dbcf5e82 ths
target PowerPC on PowerPC: Most apps (Cocoa and Carbon too) works. [1]
1951 83195237 bellard
@item
1952 83195237 bellard
target x86 on PowerPC: most utilities work. Cocoa and Carbon apps are not yet supported.
1953 83195237 bellard
@end itemize
1954 83195237 bellard
1955 83195237 bellard
[1] If you're host commpage can be executed by qemu.
1956 83195237 bellard
1957 83195237 bellard
@node Mac OS X/Darwin Quick Start
1958 83195237 bellard
@subsection Quick Start
1959 83195237 bellard
1960 83195237 bellard
In order to launch a Mac OS X/Darwin process, QEMU needs the process executable
1961 83195237 bellard
itself and all the target dynamic libraries used by it. If you don't have the FAT
1962 83195237 bellard
libraries (you're running Mac OS X/ppc) you'll need to obtain it from a Mac OS X
1963 83195237 bellard
CD or compile them by hand.
1964 83195237 bellard
1965 83195237 bellard
@itemize
1966 83195237 bellard
1967 83195237 bellard
@item On x86, you can just try to launch any process by using the native
1968 83195237 bellard
libraries:
1969 83195237 bellard
1970 83195237 bellard
@example 
1971 dbcf5e82 ths
qemu-i386 /bin/ls
1972 83195237 bellard
@end example
1973 83195237 bellard
1974 83195237 bellard
or to run the ppc version of the executable:
1975 83195237 bellard
1976 83195237 bellard
@example 
1977 dbcf5e82 ths
qemu-ppc /bin/ls
1978 83195237 bellard
@end example
1979 83195237 bellard
1980 83195237 bellard
@item On ppc, you'll have to tell qemu where your x86 libraries (and dynamic linker)
1981 83195237 bellard
are installed:
1982 83195237 bellard
1983 83195237 bellard
@example 
1984 dbcf5e82 ths
qemu-i386 -L /opt/x86_root/ /bin/ls
1985 83195237 bellard
@end example
1986 83195237 bellard
1987 83195237 bellard
@code{-L /opt/x86_root/} tells that the dynamic linker (dyld) path is in
1988 83195237 bellard
@file{/opt/x86_root/usr/bin/dyld}.
1989 83195237 bellard
1990 83195237 bellard
@end itemize
1991 83195237 bellard
1992 83195237 bellard
@node Mac OS X/Darwin Command line options
1993 83195237 bellard
@subsection Command line options
1994 83195237 bellard
1995 83195237 bellard
@example
1996 dbcf5e82 ths
usage: qemu-i386 [-h] [-d] [-L path] [-s size] program [arguments...]
1997 83195237 bellard
@end example
1998 83195237 bellard
1999 83195237 bellard
@table @option
2000 83195237 bellard
@item -h
2001 83195237 bellard
Print the help
2002 83195237 bellard
@item -L path   
2003 83195237 bellard
Set the library root path (default=/)
2004 83195237 bellard
@item -s size
2005 83195237 bellard
Set the stack size in bytes (default=524288)
2006 83195237 bellard
@end table
2007 83195237 bellard
2008 83195237 bellard
Debug options:
2009 83195237 bellard
2010 83195237 bellard
@table @option
2011 83195237 bellard
@item -d
2012 83195237 bellard
Activate log (logfile=/tmp/qemu.log)
2013 83195237 bellard
@item -p pagesize
2014 83195237 bellard
Act as if the host page size was 'pagesize' bytes
2015 83195237 bellard
@end table
2016 83195237 bellard
2017 15a34c63 bellard
@node compilation
2018 15a34c63 bellard
@chapter Compilation from the sources
2019 15a34c63 bellard
2020 debc7065 bellard
@menu
2021 debc7065 bellard
* Linux/Unix::
2022 debc7065 bellard
* Windows::
2023 debc7065 bellard
* Cross compilation for Windows with Linux::
2024 debc7065 bellard
* Mac OS X::
2025 debc7065 bellard
@end menu
2026 debc7065 bellard
2027 debc7065 bellard
@node Linux/Unix
2028 7c3fc84d bellard
@section Linux/Unix
2029 7c3fc84d bellard
2030 7c3fc84d bellard
@subsection Compilation
2031 7c3fc84d bellard
2032 7c3fc84d bellard
First you must decompress the sources:
2033 7c3fc84d bellard
@example
2034 7c3fc84d bellard
cd /tmp
2035 7c3fc84d bellard
tar zxvf qemu-x.y.z.tar.gz
2036 7c3fc84d bellard
cd qemu-x.y.z
2037 7c3fc84d bellard
@end example
2038 7c3fc84d bellard
2039 7c3fc84d bellard
Then you configure QEMU and build it (usually no options are needed):
2040 7c3fc84d bellard
@example
2041 7c3fc84d bellard
./configure
2042 7c3fc84d bellard
make
2043 7c3fc84d bellard
@end example
2044 7c3fc84d bellard
2045 7c3fc84d bellard
Then type as root user:
2046 7c3fc84d bellard
@example
2047 7c3fc84d bellard
make install
2048 7c3fc84d bellard
@end example
2049 7c3fc84d bellard
to install QEMU in @file{/usr/local}.
2050 7c3fc84d bellard
2051 4fe8b87a bellard
@subsection GCC version
2052 7c3fc84d bellard
2053 366dfc52 ths
In order to compile QEMU successfully, it is very important that you
2054 4fe8b87a bellard
have the right tools. The most important one is gcc. On most hosts and
2055 4fe8b87a bellard
in particular on x86 ones, @emph{gcc 4.x is not supported}. If your
2056 4fe8b87a bellard
Linux distribution includes a gcc 4.x compiler, you can usually
2057 4fe8b87a bellard
install an older version (it is invoked by @code{gcc32} or
2058 4fe8b87a bellard
@code{gcc34}). The QEMU configure script automatically probes for
2059 4fe8b87a bellard
these older versions so that usally you don't have to do anything.
2060 15a34c63 bellard
2061 debc7065 bellard
@node Windows
2062 15a34c63 bellard
@section Windows
2063 15a34c63 bellard
2064 15a34c63 bellard
@itemize
2065 15a34c63 bellard
@item Install the current versions of MSYS and MinGW from
2066 15a34c63 bellard
@url{http://www.mingw.org/}. You can find detailed installation
2067 15a34c63 bellard
instructions in the download section and the FAQ.
2068 15a34c63 bellard
2069 15a34c63 bellard
@item Download 
2070 15a34c63 bellard
the MinGW development library of SDL 1.2.x
2071 debc7065 bellard
(@file{SDL-devel-1.2.x-@/mingw32.tar.gz}) from
2072 15a34c63 bellard
@url{http://www.libsdl.org}. Unpack it in a temporary place, and
2073 15a34c63 bellard
unpack the archive @file{i386-mingw32msvc.tar.gz} in the MinGW tool
2074 15a34c63 bellard
directory. Edit the @file{sdl-config} script so that it gives the
2075 15a34c63 bellard
correct SDL directory when invoked.
2076 15a34c63 bellard
2077 15a34c63 bellard
@item Extract the current version of QEMU.
2078 15a34c63 bellard
 
2079 15a34c63 bellard
@item Start the MSYS shell (file @file{msys.bat}).
2080 15a34c63 bellard
2081 15a34c63 bellard
@item Change to the QEMU directory. Launch @file{./configure} and 
2082 15a34c63 bellard
@file{make}.  If you have problems using SDL, verify that
2083 15a34c63 bellard
@file{sdl-config} can be launched from the MSYS command line.
2084 15a34c63 bellard
2085 15a34c63 bellard
@item You can install QEMU in @file{Program Files/Qemu} by typing 
2086 15a34c63 bellard
@file{make install}. Don't forget to copy @file{SDL.dll} in
2087 15a34c63 bellard
@file{Program Files/Qemu}.
2088 15a34c63 bellard
2089 15a34c63 bellard
@end itemize
2090 15a34c63 bellard
2091 debc7065 bellard
@node Cross compilation for Windows with Linux
2092 15a34c63 bellard
@section Cross compilation for Windows with Linux
2093 15a34c63 bellard
2094 15a34c63 bellard
@itemize
2095 15a34c63 bellard
@item
2096 15a34c63 bellard
Install the MinGW cross compilation tools available at
2097 15a34c63 bellard
@url{http://www.mingw.org/}.
2098 15a34c63 bellard
2099 15a34c63 bellard
@item 
2100 15a34c63 bellard
Install the Win32 version of SDL (@url{http://www.libsdl.org}) by
2101 15a34c63 bellard
unpacking @file{i386-mingw32msvc.tar.gz}. Set up the PATH environment
2102 15a34c63 bellard
variable so that @file{i386-mingw32msvc-sdl-config} can be launched by
2103 15a34c63 bellard
the QEMU configuration script.
2104 15a34c63 bellard
2105 15a34c63 bellard
@item 
2106 15a34c63 bellard
Configure QEMU for Windows cross compilation:
2107 15a34c63 bellard
@example
2108 15a34c63 bellard
./configure --enable-mingw32
2109 15a34c63 bellard
@end example
2110 15a34c63 bellard
If necessary, you can change the cross-prefix according to the prefix
2111 15a34c63 bellard
choosen for the MinGW tools with --cross-prefix. You can also use
2112 15a34c63 bellard
--prefix to set the Win32 install path.
2113 15a34c63 bellard
2114 15a34c63 bellard
@item You can install QEMU in the installation directory by typing 
2115 15a34c63 bellard
@file{make install}. Don't forget to copy @file{SDL.dll} in the
2116 15a34c63 bellard
installation directory. 
2117 15a34c63 bellard
2118 15a34c63 bellard
@end itemize
2119 15a34c63 bellard
2120 15a34c63 bellard
Note: Currently, Wine does not seem able to launch
2121 15a34c63 bellard
QEMU for Win32.
2122 15a34c63 bellard
2123 debc7065 bellard
@node Mac OS X
2124 15a34c63 bellard
@section Mac OS X
2125 15a34c63 bellard
2126 15a34c63 bellard
The Mac OS X patches are not fully merged in QEMU, so you should look
2127 15a34c63 bellard
at the QEMU mailing list archive to have all the necessary
2128 15a34c63 bellard
information.
2129 15a34c63 bellard
2130 debc7065 bellard
@node Index
2131 debc7065 bellard
@chapter Index
2132 debc7065 bellard
@printindex cp
2133 debc7065 bellard
2134 debc7065 bellard
@bye