Statistics
| Branch: | Revision:

root / qemu-doc.texi @ a87295e8

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