qemu-doc.texi 88.4 KB
Newer Older
B
bellard 已提交
1
\input texinfo @c -*- texinfo -*-
B
bellard 已提交
2 3
@c %**start of header
@setfilename qemu-doc.info
B
update  
bellard 已提交
4
@settitle QEMU Emulator User Documentation
B
bellard 已提交
5 6 7
@exampleindent 0
@paragraphindent 0
@c %**end of header
B
bellard 已提交
8

B
updated  
bellard 已提交
9
@iftex
B
bellard 已提交
10 11
@titlepage
@sp 7
B
update  
bellard 已提交
12
@center @titlefont{QEMU Emulator}
B
bellard 已提交
13 14
@sp 1
@center @titlefont{User Documentation}
B
bellard 已提交
15 16
@sp 3
@end titlepage
B
updated  
bellard 已提交
17
@end iftex
B
bellard 已提交
18

B
bellard 已提交
19 20 21 22 23 24 25 26 27
@ifnottex
@node Top
@top

@menu
* Introduction::
* Installation::
* QEMU PC System emulator::
* QEMU System emulator for non PC targets::
B
bellard 已提交
28
* QEMU User space emulator::
B
bellard 已提交
29 30 31 32 33 34 35 36
* compilation:: Compilation from the sources
* Index::
@end menu
@end ifnottex

@contents

@node Introduction
B
bellard 已提交
37 38
@chapter Introduction

B
bellard 已提交
39 40 41 42 43
@menu
* intro_features:: Features
@end menu

@node intro_features
B
update  
bellard 已提交
44
@section Features
B
bellard 已提交
45

B
bellard 已提交
46 47
QEMU is a FAST! processor emulator using dynamic translation to
achieve good emulation speed.
B
update  
bellard 已提交
48 49

QEMU has two operating modes:
B
updated  
bellard 已提交
50 51 52

@itemize @minus

53
@item
B
bellard 已提交
54
Full system emulation. In this mode, QEMU emulates a full system (for
B
bellard 已提交
55 56 57
example a PC), including one or several processors and various
peripherals. It can be used to launch different Operating Systems
without rebooting the PC or to debug system code.
B
update  
bellard 已提交
58

59
@item
B
bellard 已提交
60 61
User mode emulation. In this mode, QEMU can launch
processes compiled for one CPU on another CPU. It can be used to
B
bellard 已提交
62 63
launch the Wine Windows API emulator (@url{http://www.winehq.org}) or
to ease cross-compilation and cross-debugging.
B
update  
bellard 已提交
64 65 66

@end itemize

B
update  
bellard 已提交
67
QEMU can run without an host kernel driver and yet gives acceptable
68
performance.
B
update  
bellard 已提交
69

B
update  
bellard 已提交
70 71
For system emulation, the following hardware targets are supported:
@itemize
B
update  
bellard 已提交
72
@item PC (x86 or x86_64 processor)
B
bellard 已提交
73
@item ISA PC (old style PC without PCI bus)
B
update  
bellard 已提交
74
@item PREP (PowerPC processor)
B
update  
bellard 已提交
75 76
@item G3 BW PowerMac (PowerPC processor)
@item Mac99 PowerMac (PowerPC processor, in progress)
B
blueswir1 已提交
77
@item Sun4m/Sun4c/Sun4d (32-bit Sparc processor)
B
bellard 已提交
78
@item Sun4u (64-bit Sparc processor, in progress)
T
ths 已提交
79
@item Malta board (32-bit and 64-bit MIPS processors)
80
@item MIPS Magnum (64-bit MIPS processor)
P
pbrook 已提交
81 82 83
@item ARM Integrator/CP (ARM)
@item ARM Versatile baseboard (ARM)
@item ARM RealView Emulation baseboard (ARM)
84
@item Spitz, Akita, Borzoi and Terrier PDAs (PXA270 processor)
P
pbrook 已提交
85 86
@item Luminary Micro LM3S811EVB (ARM Cortex-M3)
@item Luminary Micro LM3S6965EVB (ARM Cortex-M3)
87
@item Freescale MCF5208EVB (ColdFire V2).
P
pbrook 已提交
88
@item Arnewsh MCF5206 evaluation board (ColdFire V2).
B
balrog 已提交
89
@item Palm Tungsten|E PDA (OMAP310 processor)
90
@item N800 and N810 tablets (OMAP2420 processor)
91
@item MusicPal (MV88W8618 ARM processor)
B
update  
bellard 已提交
92
@end itemize
B
bellard 已提交
93

T
ths 已提交
94
For user emulation, x86, PowerPC, ARM, 32-bit MIPS, Sparc32/64 and ColdFire(m68k) CPUs are supported.
B
updated  
bellard 已提交
95

B
bellard 已提交
96
@node Installation
B
update  
bellard 已提交
97 98
@chapter Installation

B
bellard 已提交
99 100
If you want to compile QEMU yourself, see @ref{compilation}.

B
bellard 已提交
101 102 103 104 105 106 107
@menu
* install_linux::   Linux
* install_windows:: Windows
* install_mac::     Macintosh
@end menu

@node install_linux
B
bellard 已提交
108 109
@section Linux

B
update  
bellard 已提交
110 111
If a precompiled package is available for your distribution - you just
have to install it. Otherwise, see @ref{compilation}.
B
update  
bellard 已提交
112

B
bellard 已提交
113
@node install_windows
B
bellard 已提交
114
@section Windows
B
update  
bellard 已提交
115

B
bellard 已提交
116
Download the experimental binary installer at
B
bellard 已提交
117
@url{http://www.free.oszoo.org/@/download.html}.
118

B
bellard 已提交
119
@node install_mac
B
bellard 已提交
120
@section Mac OS X
121

B
bellard 已提交
122
Download the experimental binary installer at
B
bellard 已提交
123
@url{http://www.free.oszoo.org/@/download.html}.
B
update  
bellard 已提交
124

B
bellard 已提交
125
@node QEMU PC System emulator
B
bellard 已提交
126
@chapter QEMU PC System emulator
B
update  
bellard 已提交
127

B
bellard 已提交
128 129 130 131 132 133 134 135 136 137
@menu
* pcsys_introduction:: Introduction
* pcsys_quickstart::   Quick Start
* sec_invocation::     Invocation
* pcsys_keys::         Keys
* pcsys_monitor::      QEMU Monitor
* disk_images::        Disk Images
* pcsys_network::      Network emulation
* direct_linux_boot::  Direct Linux Boot
* pcsys_usb::          USB emulation
138
* vnc_security::       VNC security
B
bellard 已提交
139 140 141 142 143
* gdb_usage::          GDB usage
* pcsys_os_specific::  Target OS specific information
@end menu

@node pcsys_introduction
B
updated  
bellard 已提交
144 145 146 147
@section Introduction

@c man begin DESCRIPTION

B
bellard 已提交
148 149
The QEMU PC System emulator simulates the
following peripherals:
B
updated  
bellard 已提交
150 151

@itemize @minus
152
@item
B
bellard 已提交
153
i440FX host PCI bridge and PIIX3 PCI to ISA bridge
B
updated  
bellard 已提交
154
@item
B
bellard 已提交
155 156
Cirrus CLGD 5446 PCI VGA card or dummy VGA card with Bochs VESA
extensions (hardware level, including all non standard modes).
B
updated  
bellard 已提交
157 158
@item
PS/2 mouse and keyboard
159
@item
B
bellard 已提交
160
2 PCI IDE interfaces with hard disk and CD-ROM support
B
bellard 已提交
161 162
@item
Floppy disk
163
@item
164
PCI/ISA PCI network adapters
B
updated  
bellard 已提交
165
@item
B
update  
bellard 已提交
166 167
Serial ports
@item
B
bellard 已提交
168 169 170 171
Creative SoundBlaster 16 sound card
@item
ENSONIQ AudioPCI ES1370 sound card
@item
B
balrog 已提交
172 173
Intel 82801AA AC97 Audio compatible sound card
@item
B
bellard 已提交
174
Adlib(OPL2) - Yamaha YM3812 compatible chip
B
bellard 已提交
175
@item
176 177
Gravis Ultrasound GF1 sound card
@item
M
malc 已提交
178 179
CS4231A compatible sound card
@item
B
bellard 已提交
180
PCI UHCI USB controller and a virtual USB hub.
B
updated  
bellard 已提交
181 182
@end itemize

B
bellard 已提交
183 184
SMP is supported with up to 255 CPUs.

M
malc 已提交
185
Note that adlib, ac97, gus and cs4231a are only available when QEMU
M
malc 已提交
186 187
was configured with --audio-card-list option containing the name(s) of
required cards.
B
bellard 已提交
188

B
bellard 已提交
189 190 191
QEMU uses the PC BIOS from the Bochs project and the Plex86/Bochs LGPL
VGA BIOS.

B
bellard 已提交
192 193
QEMU uses YM3812 emulation by Tatsuyuki Satoh.

194 195
QEMU uses GUS emulation(GUSEMU32 @url{http://www.deinmeister.de/gusemu/})
by Tibor "TS" Schütz.
196

M
malc 已提交
197 198
CS4231A is the chip used in Windows Sound System and GUSMAX products

B
updated  
bellard 已提交
199 200
@c man end

B
bellard 已提交
201
@node pcsys_quickstart
B
update  
bellard 已提交
202 203
@section Quick Start

B
update  
bellard 已提交
204
Download and uncompress the linux image (@file{linux.img}) and type:
B
updated  
bellard 已提交
205 206

@example
B
update  
bellard 已提交
207
qemu linux.img
B
updated  
bellard 已提交
208 209 210 211
@end example

Linux should boot and give you a prompt.

B
update  
bellard 已提交
212
@node sec_invocation
B
update  
bellard 已提交
213 214 215
@section Invocation

@example
B
updated  
bellard 已提交
216
@c man begin SYNOPSIS
217
usage: qemu [options] [@var{disk_image}]
B
updated  
bellard 已提交
218
@c man end
B
update  
bellard 已提交
219 220
@end example

B
updated  
bellard 已提交
221
@c man begin OPTIONS
B
update  
bellard 已提交
222
@var{disk_image} is a raw hard disk image for IDE hard disk 0.
B
update  
bellard 已提交
223 224 225

General options:
@table @option
226 227
@item -M @var{machine}
Select the emulated @var{machine} (@code{-M ?} for list)
228

229 230
@item -fda @var{file}
@item -fdb @var{file}
B
bellard 已提交
231
Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can
B
bellard 已提交
232
use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}).
B
update  
bellard 已提交
233

234 235 236 237
@item -hda @var{file}
@item -hdb @var{file}
@item -hdc @var{file}
@item -hdd @var{file}
B
bellard 已提交
238
Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
B
bellard 已提交
239

240 241
@item -cdrom @var{file}
Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and
B
update  
bellard 已提交
242
@option{-cdrom} at the same time). You can use the host CD-ROM by
B
bellard 已提交
243
using @file{/dev/cdrom} as filename (@pxref{host_drives}).
B
update  
bellard 已提交
244

245 246 247 248 249 250 251
@item -drive @var{option}[,@var{option}[,@var{option}[,...]]]

Define a new drive. Valid options are:

@table @code
@item file=@var{file}
This option defines which disk image (@pxref{disk_images}) to use with
252 253
this drive. If the filename contains comma, you must double it
(for instance, "file=my,,file" to use file "my,file").
254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
@item if=@var{interface}
This option defines on which type on interface the drive is connected.
Available types are: ide, scsi, sd, mtd, floppy, pflash.
@item bus=@var{bus},unit=@var{unit}
These options define where is connected the drive by defining the bus number and
the unit id.
@item index=@var{index}
This option defines where is connected the drive by using an index in the list
of available connectors of a given interface type.
@item media=@var{media}
This option defines the type of the media: disk or cdrom.
@item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}]
These options have the same definition as they have in @option{-hdachs}.
@item snapshot=@var{snapshot}
@var{snapshot} is "on" or "off" and allows to enable snapshot for given drive (see @option{-snapshot}).
269 270
@item cache=@var{cache}
@var{cache} is "on" or "off" and allows to disable host cache to access data.
271 272 273 274
@item format=@var{format}
Specify which disk @var{format} will be used rather than detecting
the format.  Can be used to specifiy format=raw to avoid interpreting
an untrusted format header.
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
@end table

Instead of @option{-cdrom} you can use:
@example
qemu -drive file=file,index=2,media=cdrom
@end example

Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
use:
@example
qemu -drive file=file,index=0,media=disk
qemu -drive file=file,index=1,media=disk
qemu -drive file=file,index=2,media=disk
qemu -drive file=file,index=3,media=disk
@end example

You can connect a CDROM to the slave of ide0:
@example
qemu -drive file=file,if=ide,index=1,media=cdrom
@end example

If you don't specify the "file=" argument, you define an empty drive:
@example
qemu -drive if=ide,index=1,media=cdrom
@end example

You can connect a SCSI disk with unit ID 6 on the bus #0:
@example
qemu -drive file=file,if=scsi,bus=0,unit=6
@end example

Instead of @option{-fda}, @option{-fdb}, you can use:
@example
qemu -drive file=file,index=0,if=floppy
qemu -drive file=file,index=1,if=floppy
@end example

By default, @var{interface} is "ide" and @var{index} is automatically
incremented:
@example
qemu -drive file=a -drive file=b"
@end example
is interpreted like:
@example
qemu -hda a -hdb b
@end example

322 323 324
@item -boot [a|c|d|n]
Boot on floppy (a), hard disk (c), CD-ROM (d), or Etherboot (n). Hard disk boot
is the default.
B
bellard 已提交
325

B
update  
bellard 已提交
326
@item -snapshot
B
bellard 已提交
327 328
Write to temporary files instead of disk image files. In this case,
the raw disk image you use is not written back. You can however force
329
the write back by pressing @key{C-a s} (@pxref{disk_images}).
B
update  
bellard 已提交
330

B
bellard 已提交
331 332 333 334
@item -no-fd-bootchk
Disable boot signature checking for floppy disks in Bochs BIOS. It may
be needed to boot from old floppy disks.

335
@item -m @var{megs}
336 337 338
Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB.  Optionally,
a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
gigabytes respectively.
B
update  
bellard 已提交
339

340
@item -smp @var{n}
B
bellard 已提交
341
Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
B
blueswir1 已提交
342 343
CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs
to 4.
B
bellard 已提交
344

345 346 347 348 349
@item -audio-help

Will show the audio subsystem help: list of drivers, tunable
parameters.

350
@item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
351 352 353 354 355 356 357

Enable audio and selected sound hardware. Use ? to print all
available sound hardware.

@example
qemu -soundhw sb16,adlib hda
qemu -soundhw es1370 hda
B
balrog 已提交
358
qemu -soundhw ac97 hda
359
qemu -soundhw all hda
360 361
qemu -soundhw ?
@end example
B
update  
bellard 已提交
362

B
balrog 已提交
363 364 365 366 367 368 369
Note that Linux's i810_audio OSS kernel (for AC97) module might
require manually specifying clocking.

@example
modprobe i810_audio clocking=48000
@end example

B
bellard 已提交
370 371 372 373 374
@item -localtime
Set the real time clock to local time (the default is to UTC
time). This option is needed to have correct date in MS-DOS or
Windows.

375
@item -startdate @var{date}
B
bellard 已提交
376 377 378 379
Set the initial date of the real time clock. Valid format for
@var{date} are: @code{now} or @code{2006-06-17T16:01:21} or
@code{2006-06-17}. The default value is @code{now}.

380
@item -pidfile @var{file}
B
bellard 已提交
381 382 383
Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
from a script.

T
ths 已提交
384 385 386 387 388 389
@item -daemonize
Daemonize the QEMU process after initialization.  QEMU will not detach from
standard IO until it is ready to receive connections on any of its devices.
This option is a useful way for external programs to launch QEMU without having
to cope with initialization race conditions.

B
update  
bellard 已提交
390 391 392 393 394
@item -win2k-hack
Use it when installing Windows 2000 to avoid a disk full bug. After
Windows 2000 is installed, you no longer need this option (this option
slows down the IDE transfers).

395 396 397
@item -option-rom @var{file}
Load the contents of @var{file} as an option ROM.
This option is useful to load things like EtherBoot.
398

399 400 401 402
@item -name @var{name}
Sets the @var{name} of the guest.
This name will be display in the SDL window caption.
The @var{name} will also be used for the VNC server.
T
ths 已提交
403

B
updated  
bellard 已提交
404 405
@end table

406 407 408 409 410 411 412 413 414 415 416
Display options:
@table @option

@item -nographic

Normally, QEMU uses SDL to display the VGA output. With this option,
you can totally disable graphical output so that QEMU is a simple
command line application. The emulated serial port is redirected on
the console. Therefore, you can still use QEMU to debug a Linux kernel
with a serial console.

A
aurel32 已提交
417 418 419 420 421 422
@item -curses

Normally, QEMU uses SDL to display the VGA output.  With this option,
QEMU can display the VGA output when in text mode using a 
curses/ncurses interface.  Nothing is displayed in graphical mode.

423 424 425 426 427 428
@item -no-frame

Do not use decorations for SDL windows and start them using the whole
available screen space. This makes the using QEMU in a dedicated desktop
workspace more convenient.

429 430 431 432
@item -no-quit

Disable SDL window close capability.

433 434 435
@item -full-screen
Start in full screen.

436
@item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
437 438 439 440 441 442 443 444 445 446 447

Normally, QEMU uses SDL to display the VGA output.  With this option,
you can have QEMU listen on VNC display @var{display} and redirect the VGA
display over the VNC session.  It is very useful to enable the usb
tablet device when using this option (option @option{-usbdevice
tablet}). When using the VNC display, you must use the @option{-k}
parameter to set the keyboard layout if you are not using en-us. Valid
syntax for the @var{display} is

@table @code

448
@item @var{host}:@var{d}
449

450 451 452
TCP connections will only be allowed from @var{host} on display @var{d}.
By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
be omitted in which case the server will accept connections from any host.
453

454
@item @code{unix}:@var{path}
455 456 457 458

Connections will be allowed over UNIX domain sockets where @var{path} is the
location of a unix socket to listen for connections on.

459
@item none
460

461 462
VNC is initialized but not started. The monitor @code{change} command
can be used to later start the VNC server.
463 464 465 466 467 468 469 470

@end table

Following the @var{display} value there may be one or more @var{option} flags
separated by commas. Valid options are

@table @code

471 472 473 474 475 476 477
@item reverse

Connect to a listening VNC client via a ``reverse'' connection. The
client is specified by the @var{display}. For reverse network
connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
is a TCP port number, not a display number.

478
@item password
479 480 481 482 483

Require that password based authentication is used for client connections.
The password must be set separately using the @code{change} command in the
@ref{pcsys_monitor}

484
@item tls
485 486 487 488 489 490

Require that client use TLS when communicating with the VNC server. This
uses anonymous TLS credentials so is susceptible to a man-in-the-middle
attack. It is recommended that this option be combined with either the
@var{x509} or @var{x509verify} options.

491
@item x509=@var{/path/to/certificate/dir}
492

493
Valid if @option{tls} is specified. Require that x509 credentials are used
494 495 496 497 498 499
for negotiating the TLS session. The server will send its x509 certificate
to the client. It is recommended that a password be set on the VNC server
to provide authentication of the client when this is used. The path following
this option specifies where the x509 certificates are to be loaded from.
See the @ref{vnc_security} section for details on generating certificates.

500
@item x509verify=@var{/path/to/certificate/dir}
501

502
Valid if @option{tls} is specified. Require that x509 credentials are used
503 504 505 506 507 508 509 510 511 512 513 514
for negotiating the TLS session. The server will send its x509 certificate
to the client, and request that the client send its own x509 certificate.
The server will validate the client's certificate against the CA certificate,
and reject clients when validation fails. If the certificate authority is
trusted, this is a sufficient authentication mechanism. You may still wish
to set a password on the VNC server as a second authentication layer. The
path following this option specifies where the x509 certificates are to
be loaded from. See the @ref{vnc_security} section for details on generating
certificates.

@end table

515
@item -k @var{language}
516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533

Use keyboard layout @var{language} (for example @code{fr} for
French). This option is only needed where it is not easy to get raw PC
keycodes (e.g. on Macs, with some X11 servers or with a VNC
display). You don't normally need to use it on PC/Linux or PC/Windows
hosts.

The available layouts are:
@example
ar  de-ch  es  fo     fr-ca  hu  ja  mk     no  pt-br  sv
da  en-gb  et  fr     fr-ch  is  lt  nl     pl  ru     th
de  en-us  fi  fr-be  hr     it  lv  nl-be  pt  sl     tr
@end example

The default is @code{en-us}.

@end table

B
bellard 已提交
534 535 536 537 538 539
USB options:
@table @option

@item -usb
Enable the USB driver (will be the default soon)

540
@item -usbdevice @var{devname}
P
pbrook 已提交
541
Add the USB device @var{devname}. @xref{usb_devices}.
542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561

@table @code

@item mouse
Virtual Mouse. This will override the PS/2 mouse emulation when activated.

@item tablet
Pointer device that uses absolute coordinates (like a touchscreen). This
means qemu is able to report the mouse position without having to grab the
mouse. Also overrides the PS/2 mouse emulation when activated.

@item disk:file
Mass storage device based on file

@item host:bus.addr
Pass through the host device identified by bus.addr (Linux only).

@item host:vendor_id:product_id
Pass through the host device identified by vendor_id:product_id (Linux only).

562 563 564 565
@item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
Serial converter to host character device @var{dev}, see @code{-serial} for the
available devices.

A
aurel32 已提交
566 567 568 569
@item braille
Braille device.  This will use BrlAPI to display the braille output on a real
or fake device.

570 571
@end table

B
bellard 已提交
572 573
@end table

B
bellard 已提交
574 575 576 577
Network options:

@table @option

578
@item -net nic[,vlan=@var{n}][,macaddr=@var{addr}][,model=@var{type}]
B
update  
bellard 已提交
579
Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
580
= 0 is the default). The NIC is an ne2k_pci by default on the PC
B
update  
bellard 已提交
581 582
target. Optionally, the MAC address can be changed. If no
@option{-net} option is specified, a single NIC is created.
583 584 585 586
Qemu can emulate several different models of network card.
Valid values for @var{type} are
@code{i82551}, @code{i82557b}, @code{i82559er},
@code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
587
@code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
588 589
Not all devices are supported on all targets.  Use -net nic,model=?
for a list of available devices for your target.
B
update  
bellard 已提交
590

591
@item -net user[,vlan=@var{n}][,hostname=@var{name}]
B
update  
bellard 已提交
592
Use the user mode network stack which requires no administrator
593
privilege to run.  @option{hostname=name} can be used to specify the client
P
pbrook 已提交
594
hostname reported by the builtin DHCP server.
B
update  
bellard 已提交
595

596
@item -net tap[,vlan=@var{n}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}]
B
update  
bellard 已提交
597 598
Connect the host TAP network interface @var{name} to VLAN @var{n} and
use the network script @var{file} to configure it. The default
599 600
network script is @file{/etc/qemu-ifup}. Use @option{script=no} to
disable script execution. If @var{name} is not
601
provided, the OS automatically provides one. @option{fd}=@var{h} can be
B
update  
bellard 已提交
602
used to specify the handle of an already opened host TAP interface. Example:
B
bellard 已提交
603

B
update  
bellard 已提交
604 605 606 607 608 609 610 611 612
@example
qemu linux.img -net nic -net tap
@end example

More complicated example (two NICs, each one connected to a TAP device)
@example
qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
               -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
@end example
B
bellard 已提交
613 614


615
@item -net socket[,vlan=@var{n}][,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
B
bellard 已提交
616

B
update  
bellard 已提交
617 618 619 620
Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
machine using a TCP socket connection. If @option{listen} is
specified, QEMU waits for incoming connections on @var{port}
(@var{host} is optional). @option{connect} is used to connect to
621
another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
622
specifies an already opened TCP socket.
B
bellard 已提交
623

B
update  
bellard 已提交
624 625 626
Example:
@example
# launch a first QEMU instance
B
bellard 已提交
627 628 629 630 631 632
qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
               -net socket,listen=:1234
# connect the VLAN 0 of this instance to the VLAN 0
# of the first instance
qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
               -net socket,connect=127.0.0.1:1234
B
update  
bellard 已提交
633
@end example
B
update  
bellard 已提交
634

635
@item -net socket[,vlan=@var{n}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}]
636 637

Create a VLAN @var{n} shared with another QEMU virtual
638
machines using a UDP multicast socket, effectively making a bus for
639 640 641
every QEMU with same multicast address @var{maddr} and @var{port}.
NOTES:
@enumerate
642 643
@item
Several QEMU can be running on different hosts and share same bus (assuming
644 645 646 647
correct multicast setup for these hosts).
@item
mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
@url{http://user-mode-linux.sf.net}.
648 649
@item
Use @option{fd=h} to specify an already opened UDP multicast socket.
650 651 652 653 654
@end enumerate

Example:
@example
# launch one QEMU instance
B
bellard 已提交
655 656
qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
               -net socket,mcast=230.0.0.1:1234
657
# launch another QEMU instance on same "bus"
B
bellard 已提交
658 659
qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
               -net socket,mcast=230.0.0.1:1234
660
# launch yet another QEMU instance on same "bus"
B
bellard 已提交
661 662
qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
               -net socket,mcast=230.0.0.1:1234
663 664 665 666
@end example

Example (User Mode Linux compat.):
@example
B
bellard 已提交
667 668 669 670
# launch QEMU instance (note mcast address selected
# is UML's default)
qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
               -net socket,mcast=239.192.168.1:1102
671 672 673 674
# launch UML
/path/to/linux ubd0=/path/to/root_fs eth0=mcast
@end example

B
update  
bellard 已提交
675 676
@item -net none
Indicate that no network devices should be configured. It is used to
B
bellard 已提交
677 678
override the default configuration (@option{-net nic -net user}) which
is activated if no @option{-net} options are provided.
B
update  
bellard 已提交
679

680
@item -tftp @var{dir}
B
bellard 已提交
681
When using the user mode network stack, activate a built-in TFTP
682 683 684 685
server. The files in @var{dir} will be exposed as the root of a TFTP server.
The TFTP client on the guest must be configured in binary mode (use the command
@code{bin} of the Unix TFTP client). The host IP address on the guest is as
usual 10.0.2.2.
B
bellard 已提交
686

687
@item -bootp @var{file}
688 689 690 691 692 693 694 695 696
When using the user mode network stack, broadcast @var{file} as the BOOTP
filename.  In conjunction with @option{-tftp}, this can be used to network boot
a guest from a local directory.

Example (using pxelinux):
@example
qemu -hda linux.img -boot n -tftp /path/to/tftp/files -bootp /pxelinux.0
@end example

697
@item -smb @var{dir}
B
update  
bellard 已提交
698
When using the user mode network stack, activate a built-in SMB
699
server so that Windows OSes can access to the host files in @file{@var{dir}}
B
update  
bellard 已提交
700 701 702 703 704 705 706 707 708
transparently.

In the guest Windows OS, the line:
@example
10.0.2.4 smbserver
@end example
must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).

709
Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
B
update  
bellard 已提交
710 711

Note that a SAMBA server must be installed on the host OS in
T
ths 已提交
712
@file{/usr/sbin/smbd}. QEMU was tested successfully with smbd version
B
update  
bellard 已提交
713
2.2.7a from the Red Hat 9 and version 3.0.10-1.fc3 from Fedora Core 3.
B
update  
bellard 已提交
714

715
@item -redir [tcp|udp]:@var{host-port}:[@var{guest-host}]:@var{guest-port}
B
bellard 已提交
716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744

When using the user mode network stack, redirect incoming TCP or UDP
connections to the host port @var{host-port} to the guest
@var{guest-host} on guest port @var{guest-port}. If @var{guest-host}
is not specified, its value is 10.0.2.15 (default address given by the
built-in DHCP server).

For example, to redirect host X11 connection from screen 1 to guest
screen 0, use the following:

@example
# on the host
qemu -redir tcp:6001::6000 [...]
# this host xterm should open in the guest X11 server
xterm -display :1
@end example

To redirect telnet connections from host port 5555 to telnet port on
the guest, use the following:

@example
# on the host
qemu -redir tcp:5555::23 [...]
telnet localhost 5555
@end example

Then when you use on the host @code{telnet localhost 5555}, you
connect to the guest telnet server.

B
bellard 已提交
745 746
@end table

B
update  
bellard 已提交
747
Linux boot specific: When using these options, you can use a given
B
bellard 已提交
748 749 750
Linux kernel without installing it in the disk image. It can be useful
for easier testing of various kernels.

B
updated  
bellard 已提交
751 752
@table @option

753
@item -kernel @var{bzImage}
B
updated  
bellard 已提交
754 755
Use @var{bzImage} as kernel image.

756
@item -append @var{cmdline}
B
updated  
bellard 已提交
757 758
Use @var{cmdline} as kernel command line

759
@item -initrd @var{file}
B
updated  
bellard 已提交
760 761
Use @var{file} as initial ram disk.

B
update  
bellard 已提交
762 763
@end table

B
bellard 已提交
764
Debug/Expert options:
B
update  
bellard 已提交
765
@table @option
B
update  
bellard 已提交
766

767
@item -serial @var{dev}
768 769 770 771 772 773 774
Redirect the virtual serial port to host character device
@var{dev}. The default device is @code{vc} in graphical mode and
@code{stdio} in non graphical mode.

This option can be used several times to simulate up to 4 serials
ports.

775 776
Use @code{-serial none} to disable all serial ports.

777
Available character devices are:
B
update  
bellard 已提交
778
@table @code
779 780 781 782 783 784 785 786 787
@item vc[:WxH]
Virtual console. Optionally, a width and height can be given in pixel with
@example
vc:800x600
@end example
It is also possible to specify width or height in characters:
@example
vc:80Cx24C
@end example
B
update  
bellard 已提交
788 789
@item pty
[Linux only] Pseudo TTY (a new PTY is automatically allocated)
790 791
@item none
No device is allocated.
B
update  
bellard 已提交
792 793
@item null
void device
B
bellard 已提交
794
@item /dev/XXX
B
bellard 已提交
795
[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
B
bellard 已提交
796
parameters are set according to the emulated ones.
797
@item /dev/parport@var{N}
B
bellard 已提交
798
[Linux only, parallel port only] Use host parallel port
799
@var{N}. Currently SPP and EPP parallel port features can be used.
800 801
@item file:@var{filename}
Write output to @var{filename}. No character can be read.
B
update  
bellard 已提交
802 803
@item stdio
[Unix only] standard input/output
804
@item pipe:@var{filename}
805
name pipe @var{filename}
806
@item COM@var{n}
807
[Windows only] Use host serial port @var{n}
808 809 810 811 812
@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
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 specified @var{src_port} a random port is automatically chosen.
813 814 815 816 817

If you just want a simple readonly console you can use @code{netcat} or
@code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
@code{nc -u -l -p 4555}. Any time qemu writes something to that port it
will appear in the netconsole session.
818 819 820 821

If you plan to send characters back via netconsole or you want to stop
and start qemu a lot of times, you should have qemu use the same
source port each time by using something like @code{-serial
822
udp::4555@@:4556} to qemu. Another approach is to use a patched
823 824 825 826 827 828
version of netcat which can listen to a TCP port and send and receive
characters via udp.  If you have a patched version of netcat which
activates telnet remote echo and single char transfer, then you can
use the following options to step up a netcat redirector to allow
telnet on port 5555 to access the qemu port.
@table @code
829 830 831 832 833 834 835 836 837
@item Qemu Options:
-serial udp::4555@@:4556
@item netcat options:
-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
@item telnet options:
localhost 5555
@end table


838
@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay]
839 840 841
The TCP Net Console has two modes of operation.  It can send the serial
I/O to a location or wait for a connection from a location.  By default
the TCP Net Console is sent to @var{host} at the @var{port}.  If you use
B
bellard 已提交
842 843
the @var{server} option QEMU will wait for a client socket application
to connect to the port before continuing, unless the @code{nowait}
844
option was specified.  The @code{nodelay} option disables the Nagle buffering
845
algorithm.  If @var{host} is omitted, 0.0.0.0 is assumed. Only
846 847 848 849 850 851 852 853 854
one TCP connection at a time is accepted. You can use @code{telnet} to
connect to the corresponding character device.
@table @code
@item Example to send tcp console to 192.168.0.2 port 4444
-serial tcp:192.168.0.2:4444
@item Example to listen and wait on port 4444 for connection
-serial tcp::4444,server
@item Example to not wait and listen on ip 192.168.0.100 port 4444
-serial tcp:192.168.0.100:4444,server,nowait
B
update  
bellard 已提交
855 856
@end table

857
@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
858 859 860 861 862 863 864
The telnet protocol is used instead of raw tcp sockets.  The options
work the same as if you had specified @code{-serial tcp}.  The
difference is that the port acts like a telnet server or client using
telnet option negotiation.  This will also allow you to send the
MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
sequence.  Typically in unix telnet you do it with Control-] and then
type "send break" followed by pressing the enter key.
865

866
@item unix:@var{path}[,server][,nowait]
867 868 869 870
A unix domain socket is used instead of a tcp socket.  The option works the
same as if you had specified @code{-serial tcp} except the unix domain socket
@var{path} is used for connections.

871
@item mon:@var{dev_string}
T
ths 已提交
872 873 874 875 876 877 878 879 880 881 882
This is a special option to allow the monitor to be multiplexed onto
another serial port.  The monitor is accessed with key sequence of
@key{Control-a} and then pressing @key{c}. See monitor access
@ref{pcsys_keys} in the -nographic section for more keys.
@var{dev_string} should be any one of the serial devices specified
above.  An example to multiplex the monitor onto a telnet server
listening on port 4444 would be:
@table @code
@item -serial mon:telnet::4444,server,nowait
@end table

A
aurel32 已提交
883 884 885 886
@item braille
Braille device.  This will use BrlAPI to display the braille output on a real
or fake device.

887
@end table
B
update  
bellard 已提交
888

889
@item -parallel @var{dev}
B
bellard 已提交
890 891 892 893 894 895 896 897
Redirect the virtual parallel port to host device @var{dev} (same
devices as the serial port). On Linux hosts, @file{/dev/parportN} can
be used to use hardware devices connected on the corresponding host
parallel port.

This option can be used several times to simulate up to 3 parallel
ports.

898 899
Use @code{-parallel none} to disable all parallel ports.

900
@item -monitor @var{dev}
B
update  
bellard 已提交
901 902 903 904 905
Redirect the monitor to host device @var{dev} (same devices as the
serial port).
The default device is @code{vc} in graphical mode and @code{stdio} in
non graphical mode.

T
ths 已提交
906 907 908 909 910 911 912 913 914 915 916 917 918
@item -echr numeric_ascii_value
Change the escape character used for switching to the monitor when using
monitor and serial sharing.  The default is @code{0x01} when using the
@code{-nographic} option.  @code{0x01} is equal to pressing
@code{Control-a}.  You can select a different character from the ascii
control keys where 1 through 26 map to Control-a through Control-z.  For
instance you could use the either of the following to change the escape
character to Control-t.
@table @code
@item -echr 0x14
@item -echr 20
@end table

B
update  
bellard 已提交
919
@item -s
920
Wait gdb connection to port 1234 (@pxref{gdb_usage}).
921
@item -p @var{port}
922 923
Change gdb connection port.  @var{port} can be either a decimal number
to specify a TCP port, or a host device (same devices as the serial port).
B
update  
bellard 已提交
924 925
@item -S
Do not start CPU at startup (you must type 'c' in the monitor).
926
@item -d
B
update  
bellard 已提交
927
Output log in /tmp/qemu.log
928
@item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
B
bellard 已提交
929 930 931
Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
932
all those parameters. This option is useful for old MS-DOS disk
B
bellard 已提交
933
images.
B
update  
bellard 已提交
934

B
-L help  
bellard 已提交
935 936 937
@item -L path
Set the directory for the BIOS, VGA BIOS and keymaps.

B
bellard 已提交
938 939
@item -std-vga
Simulate a standard VGA card with Bochs VBE extensions (default is
B
bellard 已提交
940 941 942 943
Cirrus Logic GD5446 PCI VGA). If your guest OS supports the VESA 2.0
VBE extensions (e.g. Windows XP) and if you want to use high
resolution modes (>= 1280x1024x16) then you should use this option.

B
update  
bellard 已提交
944 945 946 947 948
@item -no-acpi
Disable ACPI (Advanced Configuration and Power Interface) support. Use
it if your guest OS complains about ACPI problems (PC target machine
only).

B
bellard 已提交
949 950 951
@item -no-reboot
Exit instead of rebooting.

952 953 954 955 956
@item -no-shutdown
Don't exit QEMU on guest shutdown, but instead only stop the emulation.
This allows for instance switching to monitor to commit changes to the
disk image.

B
bellard 已提交
957 958
@item -loadvm file
Start right away with a saved state (@code{loadvm} in monitor)
959 960

@item -semihosting
P
pbrook 已提交
961 962 963 964 965
Enable semihosting syscall emulation (ARM and M68K target machines only).

On ARM this implements the "Angel" interface.
On M68K this implements the "ColdFire GDB" interface used by libgloss.

966 967
Note that this allows guest direct access to the host filesystem,
so should only be used with trusted guest OS.
B
update  
bellard 已提交
968 969
@end table

B
update  
bellard 已提交
970 971
@c man end

B
bellard 已提交
972
@node pcsys_keys
B
update  
bellard 已提交
973 974 975 976
@section Keys

@c man begin OPTIONS

B
update  
bellard 已提交
977 978
During the graphical emulation, you can use the following keys:
@table @key
B
update  
bellard 已提交
979
@item Ctrl-Alt-f
B
update  
bellard 已提交
980
Toggle full screen
B
update  
bellard 已提交
981

B
update  
bellard 已提交
982
@item Ctrl-Alt-n
B
update  
bellard 已提交
983 984 985 986 987 988 989 990
Switch to virtual console 'n'. Standard console mappings are:
@table @emph
@item 1
Target system display
@item 2
Monitor
@item 3
Serial port
B
update  
bellard 已提交
991 992
@end table

B
update  
bellard 已提交
993
@item Ctrl-Alt
B
update  
bellard 已提交
994 995 996
Toggle mouse and keyboard grab.
@end table

B
update  
bellard 已提交
997 998 999
In the virtual consoles, you can use @key{Ctrl-Up}, @key{Ctrl-Down},
@key{Ctrl-PageUp} and @key{Ctrl-PageDown} to move in the back log.

B
update  
bellard 已提交
1000 1001
During emulation, if you are using the @option{-nographic} option, use
@key{Ctrl-a h} to get terminal commands:
B
update  
bellard 已提交
1002 1003

@table @key
B
update  
bellard 已提交
1004
@item Ctrl-a h
B
update  
bellard 已提交
1005
Print this help
1006
@item Ctrl-a x
T
ths 已提交
1007
Exit emulator
1008
@item Ctrl-a s
B
bellard 已提交
1009
Save disk data back to file (if -snapshot)
T
ths 已提交
1010 1011
@item Ctrl-a t
toggle console timestamps
B
update  
bellard 已提交
1012
@item Ctrl-a b
B
bellard 已提交
1013
Send break (magic sysrq in Linux)
B
update  
bellard 已提交
1014
@item Ctrl-a c
B
bellard 已提交
1015
Switch between console and monitor
B
update  
bellard 已提交
1016 1017
@item Ctrl-a Ctrl-a
Send Ctrl-a
B
update  
bellard 已提交
1018
@end table
B
updated  
bellard 已提交
1019 1020 1021 1022
@c man end

@ignore

B
bellard 已提交
1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
@c man begin SEEALSO
The HTML documentation of QEMU for more precise information and Linux
user mode emulator invocation.
@c man end

@c man begin AUTHOR
Fabrice Bellard
@c man end

@end ignore

B
bellard 已提交
1034
@node pcsys_monitor
B
bellard 已提交
1035 1036 1037 1038 1039 1040 1041 1042
@section QEMU Monitor

The QEMU monitor is used to give complex commands to the QEMU
emulator. You can use it to:

@itemize @minus

@item
T
ths 已提交
1043
Remove or insert removable media images
1044
(such as CD-ROM or floppies).
B
bellard 已提交
1045

1046
@item
B
bellard 已提交
1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059
Freeze/unfreeze the Virtual Machine (VM) and save or restore its state
from a disk file.

@item Inspect the VM state without an external debugger.

@end itemize

@subsection Commands

The following commands are available:

@table @option

1060
@item help or ? [@var{cmd}]
B
bellard 已提交
1061 1062
Show the help for all commands or just for command @var{cmd}.

1063
@item commit
1064
Commit changes to the disk images (if -snapshot is used).
B
bellard 已提交
1065

1066 1067
@item info @var{subcommand}
Show various information about the system state.
B
bellard 已提交
1068 1069 1070

@table @option
@item info network
B
update  
bellard 已提交
1071
show the various VLANs and the associated devices
B
bellard 已提交
1072 1073 1074 1075 1076 1077
@item info block
show the block devices
@item info registers
show the cpu registers
@item info history
show the command line history
B
bellard 已提交
1078 1079 1080 1081 1082 1083
@item info pci
show emulated PCI device
@item info usb
show USB devices plugged on the virtual USB hub
@item info usbhost
show all USB host devices
B
bellard 已提交
1084 1085
@item info capture
show information about active capturing
B
bellard 已提交
1086 1087
@item info snapshots
show list of VM snapshots
1088 1089
@item info mice
show which guest mouse is receiving events
B
bellard 已提交
1090 1091 1092 1093 1094
@end table

@item q or quit
Quit the emulator.

1095
@item eject [-f] @var{device}
T
ths 已提交
1096
Eject a removable medium (use -f to force it).
B
bellard 已提交
1097

1098
@item change @var{device} @var{setting}
1099

1100
Change the configuration of a device.
1101 1102 1103 1104 1105 1106

@table @option
@item change @var{diskdevice} @var{filename}
Change the medium for a removable disk device to point to @var{filename}. eg

@example
1107
(qemu) change ide1-cd0 /path/to/some.iso
1108 1109
@end example

1110
@item change vnc @var{display},@var{options}
1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129
Change the configuration of the VNC server. The valid syntax for @var{display}
and @var{options} are described at @ref{sec_invocation}. eg

@example
(qemu) change vnc localhost:1
@end example

@item change vnc password

Change the password associated with the VNC server. The monitor will prompt for
the new password to be entered. VNC passwords are only significant upto 8 letters.
eg.

@example
(qemu) change vnc password
Password: ********
@end example

@end table
B
bellard 已提交
1130

1131
@item screendump @var{filename}
B
bellard 已提交
1132 1133
Save screen into PPM image @var{filename}.

1134
@item mouse_move @var{dx} @var{dy} [@var{dz}]
1135 1136 1137
Move the active mouse to the specified coordinates @var{dx} @var{dy}
with optional scroll axis @var{dz}.

1138
@item mouse_button @var{val}
1139 1140
Change the active mouse button state @var{val} (1=L, 2=M, 4=R).

1141
@item mouse_set @var{index}
1142 1143 1144 1145 1146 1147
Set which mouse device receives events at given @var{index}, index
can be obtained with
@example
info mice
@end example

1148
@item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
B
bellard 已提交
1149 1150 1151 1152 1153 1154 1155 1156 1157 1158
Capture audio into @var{filename}. Using sample rate @var{frequency}
bits per sample @var{bits} and number of channels @var{channels}.

Defaults:
@itemize @minus
@item Sample rate = 44100 Hz - CD quality
@item Bits = 16
@item Number of channels = 2 - Stereo
@end itemize

1159
@item stopcapture @var{index}
B
bellard 已提交
1160 1161 1162 1163 1164
Stop capture with a given @var{index}, index can be obtained with
@example
info capture
@end example

1165
@item log @var{item1}[,...]
B
bellard 已提交
1166 1167
Activate logging of the specified items to @file{/tmp/qemu.log}.

1168
@item savevm [@var{tag}|@var{id}]
B
bellard 已提交
1169 1170 1171 1172
Create a snapshot of the whole virtual machine. If @var{tag} is
provided, it is used as human readable identifier. If there is already
a snapshot with the same tag or ID, it is replaced. More info at
@ref{vm_snapshots}.
B
bellard 已提交
1173

1174
@item loadvm @var{tag}|@var{id}
B
bellard 已提交
1175 1176 1177
Set the whole virtual machine to the snapshot identified by the tag
@var{tag} or the unique snapshot ID @var{id}.

1178
@item delvm @var{tag}|@var{id}
B
bellard 已提交
1179
Delete the snapshot identified by @var{tag} or @var{id}.
B
bellard 已提交
1180 1181 1182 1183 1184 1185 1186

@item stop
Stop emulation.

@item c or cont
Resume emulation.

1187 1188
@item gdbserver [@var{port}]
Start gdbserver session (default @var{port}=1234)
B
bellard 已提交
1189

1190
@item x/fmt @var{addr}
B
bellard 已提交
1191 1192
Virtual memory dump starting at @var{addr}.

1193
@item xp /@var{fmt} @var{addr}
B
bellard 已提交
1194 1195 1196 1197 1198 1199
Physical memory dump starting at @var{addr}.

@var{fmt} is a format which tells the command how to format the
data. Its syntax is: @option{/@{count@}@{format@}@{size@}}

@table @var
1200
@item count
B
bellard 已提交
1201 1202 1203
is the number of items to be dumped.

@item format
1204
can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
B
bellard 已提交
1205 1206 1207
c (char) or i (asm instruction).

@item size
B
update  
bellard 已提交
1208 1209 1210
can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
@code{h} or @code{w} can be specified with the @code{i} format to
respectively select 16 or 32 bit code instruction size.
B
bellard 已提交
1211 1212 1213

@end table

1214
Examples:
B
bellard 已提交
1215 1216 1217
@itemize
@item
Dump 10 instructions at the current instruction pointer:
1218
@example
B
bellard 已提交
1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233
(qemu) x/10i $eip
0x90107063:  ret
0x90107064:  sti
0x90107065:  lea    0x0(%esi,1),%esi
0x90107069:  lea    0x0(%edi,1),%edi
0x90107070:  ret
0x90107071:  jmp    0x90107080
0x90107073:  nop
0x90107074:  nop
0x90107075:  nop
0x90107076:  nop
@end example

@item
Dump 80 16 bit values at the start of the video memory.
1234
@smallexample
B
bellard 已提交
1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245
(qemu) xp/80hx 0xb8000
0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
B
bellard 已提交
1246
@end smallexample
B
bellard 已提交
1247 1248
@end itemize

1249
@item p or print/@var{fmt} @var{expr}
B
bellard 已提交
1250 1251 1252

Print expression value. Only the @var{format} part of @var{fmt} is
used.
B
updated  
bellard 已提交
1253

1254
@item sendkey @var{keys}
B
bellard 已提交
1255 1256 1257 1258 1259 1260 1261 1262 1263 1264

Send @var{keys} to the emulator. Use @code{-} to press several keys
simultaneously. Example:
@example
sendkey ctrl-alt-f1
@end example

This command is useful to send keys that your graphical user interface
intercepts at low level, such as @code{ctrl-alt-f1} in X Window.

B
bellard 已提交
1265 1266 1267 1268
@item system_reset

Reset the system.

1269 1270 1271 1272 1273 1274 1275 1276
@item boot_set @var{bootdevicelist}

Define new values for the boot device list. Those values will override
the values specified on the command line through the @code{-boot} option.

The values that can be specified here depend on the machine type, but are
the same that can be specified in the @code{-boot} command line option.

1277
@item usb_add @var{devname}
B
bellard 已提交
1278

P
pbrook 已提交
1279 1280
Add the USB device @var{devname}.  For details of available devices see
@ref{usb_devices}
B
bellard 已提交
1281

1282
@item usb_del @var{devname}
B
bellard 已提交
1283 1284 1285 1286 1287

Remove the USB device @var{devname} from the QEMU virtual USB
hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
command @code{info usb} to see the devices you can remove.

B
bellard 已提交
1288
@end table
B
updated  
bellard 已提交
1289

B
bellard 已提交
1290 1291 1292 1293 1294
@subsection Integer expressions

The monitor understands integers expressions for every integer
argument. You can use register names to get the value of specifics
CPU registers by prefixing them with @emph{$}.
B
update  
bellard 已提交
1295

B
bellard 已提交
1296 1297 1298
@node disk_images
@section Disk Images

B
bellard 已提交
1299 1300
Since version 0.6.1, QEMU supports many disk image formats, including
growable disk images (their size increase as non empty sectors are
B
bellard 已提交
1301 1302 1303
written), compressed and encrypted disk images. Version 0.8.3 added
the new qcow2 disk image format which is essential to support VM
snapshots.
B
bellard 已提交
1304

B
bellard 已提交
1305 1306 1307
@menu
* disk_images_quickstart::    Quick start for disk image creation
* disk_images_snapshot_mode:: Snapshot mode
B
bellard 已提交
1308
* vm_snapshots::              VM snapshots
B
bellard 已提交
1309
* qemu_img_invocation::       qemu-img Invocation
B
bellard 已提交
1310
* host_drives::               Using host drives
B
bellard 已提交
1311 1312 1313 1314
* disk_images_fat_images::    Virtual FAT disk images
@end menu

@node disk_images_quickstart
B
bellard 已提交
1315 1316 1317
@subsection Quick start for disk image creation

You can create a disk image with the command:
B
bellard 已提交
1318
@example
B
bellard 已提交
1319
qemu-img create myimage.img mysize
B
bellard 已提交
1320
@end example
B
bellard 已提交
1321 1322 1323 1324
where @var{myimage.img} is the disk image filename and @var{mysize} is its
size in kilobytes. You can add an @code{M} suffix to give the size in
megabytes and a @code{G} suffix for gigabytes.

B
bellard 已提交
1325
See @ref{qemu_img_invocation} for more information.
B
bellard 已提交
1326

B
bellard 已提交
1327
@node disk_images_snapshot_mode
B
bellard 已提交
1328 1329 1330 1331 1332
@subsection Snapshot mode

If you use the option @option{-snapshot}, all disk images are
considered as read only. When sectors in written, they are written in
a temporary file created in @file{/tmp}. You can however force the
B
bellard 已提交
1333 1334
write back to the raw disk images by using the @code{commit} monitor
command (or @key{C-a s} in the serial console).
B
bellard 已提交
1335

B
bellard 已提交
1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346
@node vm_snapshots
@subsection VM snapshots

VM snapshots are snapshots of the complete virtual machine including
CPU state, RAM, device state and the content of all the writable
disks. In order to use VM snapshots, you must have at least one non
removable and writable block device using the @code{qcow2} disk image
format. Normally this device is the first virtual hard drive.

Use the monitor command @code{savevm} to create a new VM snapshot or
replace an existing one. A human readable name can be assigned to each
B
update  
bellard 已提交
1347
snapshot in addition to its numerical ID.
B
bellard 已提交
1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369

Use @code{loadvm} to restore a VM snapshot and @code{delvm} to remove
a VM snapshot. @code{info snapshots} lists the available snapshots
with their associated information:

@example
(qemu) info snapshots
Snapshot devices: hda
Snapshot list (from hda):
ID        TAG                 VM SIZE                DATE       VM CLOCK
1         start                   41M 2006-08-06 12:38:02   00:00:14.954
2                                 40M 2006-08-06 12:43:29   00:00:18.633
3         msys                    40M 2006-08-06 12:44:04   00:00:23.514
@end example

A VM snapshot is made of a VM state info (its size is shown in
@code{info snapshots}) and a snapshot of every writable disk image.
The VM state info is stored in the first @code{qcow2} non removable
and writable block device. The disk image snapshots are stored in
every disk image. The size of a snapshot in a disk image is difficult
to evaluate and is not shown by @code{info snapshots} because the
associated disk sectors are shared among all the snapshots to save
B
update  
bellard 已提交
1370 1371
disk space (otherwise each snapshot would need a full copy of all the
disk images).
B
bellard 已提交
1372 1373 1374 1375 1376 1377 1378

When using the (unrelated) @code{-snapshot} option
(@ref{disk_images_snapshot_mode}), you can always make VM snapshots,
but they are deleted as soon as you exit QEMU.

VM snapshots currently have the following known limitations:
@itemize
1379
@item
B
bellard 已提交
1380 1381
They cannot cope with removable devices if they are removed or
inserted after a snapshot is done.
1382
@item
B
bellard 已提交
1383 1384 1385 1386
A few device drivers still have incomplete snapshot support so their
state is not saved or restored properly (in particular USB).
@end itemize

B
bellard 已提交
1387 1388
@node qemu_img_invocation
@subsection @code{qemu-img} Invocation
B
bellard 已提交
1389

B
bellard 已提交
1390
@include qemu-img.texi
B
bellard 已提交
1391

B
bellard 已提交
1392 1393 1394 1395 1396 1397 1398 1399 1400
@node host_drives
@subsection Using host drives

In addition to disk image files, QEMU can directly access host
devices. We describe here the usage for QEMU version >= 0.8.3.

@subsubsection Linux

On Linux, you can directly use the host device filename instead of a
1401
disk image filename provided you have enough privileges to access
B
bellard 已提交
1402 1403 1404
it. For example, use @file{/dev/cdrom} to access to the CDROM or
@file{/dev/fd0} for the floppy.

B
bellard 已提交
1405
@table @code
B
bellard 已提交
1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425
@item CD
You can specify a CDROM device even if no CDROM is loaded. QEMU has
specific code to detect CDROM insertion or removal. CDROM ejection by
the guest OS is supported. Currently only data CDs are supported.
@item Floppy
You can specify a floppy device even if no floppy is loaded. Floppy
removal is currently not detected accurately (if you change floppy
without doing floppy access while the floppy is not loaded, the guest
OS will think that the same floppy is loaded).
@item Hard disks
Hard disks can be used. Normally you must specify the whole disk
(@file{/dev/hdb} instead of @file{/dev/hdb1}) so that the guest OS can
see it as a partitioned disk. WARNING: unless you know what you do, it
is better to only make READ-ONLY accesses to the hard disk otherwise
you may corrupt your host data (use the @option{-snapshot} command
line option or modify the device permissions accordingly).
@end table

@subsubsection Windows

1426 1427
@table @code
@item CD
1428
The preferred syntax is the drive letter (e.g. @file{d:}). The
1429 1430
alternate syntax @file{\\.\d:} is supported. @file{/dev/cdrom} is
supported as an alias to the first CDROM drive.
B
bellard 已提交
1431

T
ths 已提交
1432
Currently there is no specific code to handle removable media, so it
B
bellard 已提交
1433 1434
is better to use the @code{change} or @code{eject} monitor commands to
change or eject media.
1435
@item Hard disks
1436
Hard disks can be used with the syntax: @file{\\.\PhysicalDrive@var{N}}
1437 1438 1439 1440 1441 1442 1443 1444
where @var{N} is the drive number (0 is the first hard disk).

WARNING: unless you know what you do, it is better to only make
READ-ONLY accesses to the hard disk otherwise you may corrupt your
host data (use the @option{-snapshot} command line so that the
modifications are written in a temporary file).
@end table

B
bellard 已提交
1445 1446 1447

@subsubsection Mac OS X

1448
@file{/dev/cdrom} is an alias to the first CDROM.
B
bellard 已提交
1449

T
ths 已提交
1450
Currently there is no specific code to handle removable media, so it
B
bellard 已提交
1451 1452 1453
is better to use the @code{change} or @code{eject} monitor commands to
change or eject media.

B
bellard 已提交
1454
@node disk_images_fat_images
B
update  
bellard 已提交
1455 1456 1457 1458 1459
@subsection Virtual FAT disk images

QEMU can automatically create a virtual FAT disk image from a
directory tree. In order to use it, just type:

1460
@example
B
update  
bellard 已提交
1461 1462 1463 1464 1465 1466 1467 1468 1469
qemu linux.img -hdb fat:/my_directory
@end example

Then you access access to all the files in the @file{/my_directory}
directory without having to copy them in a disk image or to export
them via SAMBA or NFS. The default access is @emph{read-only}.

Floppies can be emulated with the @code{:floppy:} option:

1470
@example
B
update  
bellard 已提交
1471 1472 1473 1474 1475 1476
qemu linux.img -fda fat:floppy:/my_directory
@end example

A read/write support is available for testing (beta stage) with the
@code{:rw:} option:

1477
@example
B
update  
bellard 已提交
1478 1479 1480 1481 1482 1483 1484
qemu linux.img -fda fat:floppy:rw:/my_directory
@end example

What you should @emph{never} do:
@itemize
@item use non-ASCII filenames ;
@item use "-snapshot" together with ":rw:" ;
B
bellard 已提交
1485 1486
@item expect it to work when loadvm'ing ;
@item write to the FAT directory on the host system while accessing it with the guest system.
B
update  
bellard 已提交
1487 1488
@end itemize

B
bellard 已提交
1489
@node pcsys_network
B
update  
bellard 已提交
1490 1491
@section Network emulation

1492
QEMU can simulate several network cards (PCI or ISA cards on the PC
B
update  
bellard 已提交
1493 1494 1495
target) and can connect them to an arbitrary number of Virtual Local
Area Networks (VLANs). Host TAP devices can be connected to any QEMU
VLAN. VLAN can be connected between separate instances of QEMU to
1496
simulate large networks. For simpler usage, a non privileged user mode
B
update  
bellard 已提交
1497 1498 1499 1500
network stack can replace the TAP device to have a basic network
connection.

@subsection VLANs
B
update  
bellard 已提交
1501

B
update  
bellard 已提交
1502 1503 1504 1505
QEMU simulates several VLANs. A VLAN can be symbolised as a virtual
connection between several network devices. These devices can be for
example QEMU virtual Ethernet cards or virtual Host ethernet devices
(TAP devices).
B
update  
bellard 已提交
1506

B
update  
bellard 已提交
1507 1508 1509 1510 1511
@subsection Using TAP network interfaces

This is the standard way to connect QEMU to a real network. QEMU adds
a virtual network device on your host (called @code{tapN}), and you
can then configure it as if it was a real ethernet card.
B
update  
bellard 已提交
1512

B
update  
bellard 已提交
1513 1514
@subsubsection Linux host

B
update  
bellard 已提交
1515 1516 1517 1518
As an example, you can download the @file{linux-test-xxx.tar.gz}
archive and copy the script @file{qemu-ifup} in @file{/etc} and
configure properly @code{sudo} so that the command @code{ifconfig}
contained in @file{qemu-ifup} can be executed as root. You must verify
B
update  
bellard 已提交
1519
that your host kernel supports the TAP network interfaces: the
B
update  
bellard 已提交
1520 1521
device @file{/dev/net/tun} must be present.

B
bellard 已提交
1522 1523
See @ref{sec_invocation} to have examples of command lines using the
TAP network interfaces.
B
update  
bellard 已提交
1524

B
update  
bellard 已提交
1525 1526 1527 1528 1529 1530 1531
@subsubsection Windows host

There is a virtual ethernet driver for Windows 2000/XP systems, called
TAP-Win32. But it is not included in standard QEMU for Windows,
so you will need to get it separately. It is part of OpenVPN package,
so download OpenVPN from : @url{http://openvpn.net/}.

B
update  
bellard 已提交
1532 1533
@subsection Using the user mode network stack

B
update  
bellard 已提交
1534 1535
By using the option @option{-net user} (default configuration if no
@option{-net} option is specified), QEMU uses a completely user mode
1536
network stack (you don't need root privilege to use the virtual
B
update  
bellard 已提交
1537
network). The virtual network configuration is the following:
B
update  
bellard 已提交
1538 1539 1540

@example

B
update  
bellard 已提交
1541 1542
         QEMU VLAN      <------>  Firewall/DHCP server <-----> Internet
                           |          (10.0.2.2)
B
update  
bellard 已提交
1543
                           |
B
update  
bellard 已提交
1544
                           ---->  DNS server (10.0.2.3)
1545
                           |
B
update  
bellard 已提交
1546
                           ---->  SMB server (10.0.2.4)
B
update  
bellard 已提交
1547 1548 1549 1550
@end example

The QEMU VM behaves as if it was behind a firewall which blocks all
incoming connections. You can use a DHCP client to automatically
B
update  
bellard 已提交
1551 1552
configure the network in the QEMU VM. The DHCP server assign addresses
to the hosts starting from 10.0.2.15.
B
update  
bellard 已提交
1553 1554 1555 1556 1557

In order to check that the user mode network is working, you can ping
the address 10.0.2.2 and verify that you got an address in the range
10.0.2.x from the QEMU virtual DHCP server.

B
update  
bellard 已提交
1558
Note that @code{ping} is not supported reliably to the internet as it
1559
would require root privileges. It means you can only ping the local
B
update  
bellard 已提交
1560 1561
router (10.0.2.2).

B
bellard 已提交
1562 1563 1564 1565 1566 1567
When using the built-in TFTP server, the router is also the TFTP
server.

When using the @option{-redir} option, TCP or UDP connections can be
redirected from the host to the guest. It allows for example to
redirect X11, telnet or SSH connections.
B
bellard 已提交
1568

B
update  
bellard 已提交
1569 1570 1571 1572 1573 1574
@subsection Connecting VLANs between QEMU instances

Using the @option{-net socket} option, it is possible to make VLANs
that span several QEMU instances. See @ref{sec_invocation} to have a
basic example.

B
update  
bellard 已提交
1575 1576
@node direct_linux_boot
@section Direct Linux Boot
B
bellard 已提交
1577 1578 1579

This section explains how to launch a Linux kernel inside QEMU without
having to make a full bootable image. It is very useful for fast Linux
B
bellard 已提交
1580
kernel testing.
B
bellard 已提交
1581

B
bellard 已提交
1582
The syntax is:
B
bellard 已提交
1583
@example
B
bellard 已提交
1584
qemu -kernel arch/i386/boot/bzImage -hda root-2.4.20.img -append "root=/dev/hda"
B
bellard 已提交
1585 1586
@end example

B
bellard 已提交
1587 1588 1589
Use @option{-kernel} to provide the Linux kernel image and
@option{-append} to give the kernel command line arguments. The
@option{-initrd} option can be used to provide an INITRD image.
B
bellard 已提交
1590

B
bellard 已提交
1591 1592 1593
When using the direct Linux boot, a disk image for the first hard disk
@file{hda} is required because its boot sector is used to launch the
Linux kernel.
B
bellard 已提交
1594

B
bellard 已提交
1595 1596 1597
If you do not need graphical output, you can disable it and redirect
the virtual serial port and the QEMU monitor to the console with the
@option{-nographic} option. The typical command line is:
B
bellard 已提交
1598
@example
B
bellard 已提交
1599 1600
qemu -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
     -append "root=/dev/hda console=ttyS0" -nographic
B
bellard 已提交
1601 1602
@end example

B
bellard 已提交
1603 1604
Use @key{Ctrl-a c} to switch between the serial console and the
monitor (@pxref{pcsys_keys}).
B
bellard 已提交
1605

B
bellard 已提交
1606
@node pcsys_usb
B
bellard 已提交
1607 1608
@section USB emulation

P
pbrook 已提交
1609 1610 1611
QEMU emulates a PCI UHCI USB controller. You can virtually plug
virtual USB devices or real host USB devices (experimental, works only
on Linux hosts).  Qemu will automatically create and connect virtual USB hubs
B
bellard 已提交
1612
as necessary to connect multiple USB devices.
B
bellard 已提交
1613

P
pbrook 已提交
1614 1615 1616 1617 1618 1619
@menu
* usb_devices::
* host_usb_devices::
@end menu
@node usb_devices
@subsection Connecting USB devices
B
bellard 已提交
1620

P
pbrook 已提交
1621 1622
USB devices can be connected with the @option{-usbdevice} commandline option
or the @code{usb_add} monitor command.  Available devices are:
B
bellard 已提交
1623

1624 1625
@table @code
@item mouse
P
pbrook 已提交
1626
Virtual Mouse.  This will override the PS/2 mouse emulation when activated.
1627
@item tablet
B
typo  
bellard 已提交
1628
Pointer device that uses absolute coordinates (like a touchscreen).
P
pbrook 已提交
1629 1630
This means qemu is able to report the mouse position without having
to grab the mouse.  Also overrides the PS/2 mouse emulation when activated.
1631
@item disk:@var{file}
P
pbrook 已提交
1632
Mass storage device based on @var{file} (@pxref{disk_images})
1633
@item host:@var{bus.addr}
P
pbrook 已提交
1634 1635
Pass through the host device identified by @var{bus.addr}
(Linux only)
1636
@item host:@var{vendor_id:product_id}
P
pbrook 已提交
1637 1638
Pass through the host device identified by @var{vendor_id:product_id}
(Linux only)
1639
@item wacom-tablet
1640 1641 1642
Virtual Wacom PenPartner tablet.  This device is similar to the @code{tablet}
above but it can be used with the tslib library because in addition to touch
coordinates it reports touch pressure.
1643
@item keyboard
B
balrog 已提交
1644
Standard USB keyboard.  Will override the PS/2 keyboard (if present).
1645 1646 1647 1648
@item serial:[vendorid=@var{vendor_id}][,product_id=@var{product_id}]:@var{dev}
Serial converter. This emulates an FTDI FT232BM chip connected to host character
device @var{dev}. The available character devices are the same as for the
@code{-serial} option. The @code{vendorid} and @code{productid} options can be
1649
used to override the default 0403:6001. For instance, 
1650 1651 1652 1653 1654
@example
usb_add serial:productid=FA00:tcp:192.168.0.2:4444
@end example
will connect to tcp port 4444 of ip 192.168.0.2, and plug that to the virtual
serial converter, faking a Matrix Orbital LCD Display (USB ID 0403:FA00).
A
aurel32 已提交
1655 1656 1657
@item braille
Braille device.  This will use BrlAPI to display the braille output on a real
or fake device.
P
pbrook 已提交
1658
@end table
B
bellard 已提交
1659

P
pbrook 已提交
1660
@node host_usb_devices
B
bellard 已提交
1661 1662 1663 1664 1665 1666 1667
@subsection Using host USB devices on a Linux host

WARNING: this is an experimental feature. QEMU will slow down when
using it. USB devices requiring real time streaming (i.e. USB Video
Cameras) are not supported yet.

@enumerate
1668
@item If you use an early Linux 2.4 kernel, verify that no Linux driver
B
bellard 已提交
1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684
is actually using the USB device. A simple way to do that is simply to
disable the corresponding kernel module by renaming it from @file{mydriver.o}
to @file{mydriver.o.disabled}.

@item Verify that @file{/proc/bus/usb} is working (most Linux distributions should enable it by default). You should see something like that:
@example
ls /proc/bus/usb
001  devices  drivers
@end example

@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:
@example
chown -R myuid /proc/bus/usb
@end example

@item Launch QEMU and do in the monitor:
1685
@example
B
bellard 已提交
1686 1687 1688 1689 1690 1691 1692 1693
info usbhost
  Device 1.2, speed 480 Mb/s
    Class 00: USB device 1234:5678, USB DISK
@end example
You should see the list of the devices you can use (Never try to use
hubs, it won't work).

@item Add the device in QEMU by using:
1694
@example
B
bellard 已提交
1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707
usb_add host:1234:5678
@end example

Normally the guest OS should report that a new USB device is
plugged. You can use the option @option{-usbdevice} to do the same.

@item Now you can try to use the host USB device in QEMU.

@end enumerate

When relaunching QEMU, you may have to unplug and plug again the USB
device to make it work again (this is a bug).

1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914
@node vnc_security
@section VNC security

The VNC server capability provides access to the graphical console
of the guest VM across the network. This has a number of security
considerations depending on the deployment scenarios.

@menu
* vnc_sec_none::
* vnc_sec_password::
* vnc_sec_certificate::
* vnc_sec_certificate_verify::
* vnc_sec_certificate_pw::
* vnc_generate_cert::
@end menu
@node vnc_sec_none
@subsection Without passwords

The simplest VNC server setup does not include any form of authentication.
For this setup it is recommended to restrict it to listen on a UNIX domain
socket only. For example

@example
qemu [...OPTIONS...] -vnc unix:/home/joebloggs/.qemu-myvm-vnc
@end example

This ensures that only users on local box with read/write access to that
path can access the VNC server. To securely access the VNC server from a
remote machine, a combination of netcat+ssh can be used to provide a secure
tunnel.

@node vnc_sec_password
@subsection With passwords

The VNC protocol has limited support for password based authentication. Since
the protocol limits passwords to 8 characters it should not be considered
to provide high security. The password can be fairly easily brute-forced by
a client making repeat connections. For this reason, a VNC server using password
authentication should be restricted to only listen on the loopback interface
or UNIX domain sockets. Password ayuthentication is requested with the @code{password}
option, and then once QEMU is running the password is set with the monitor. Until
the monitor is used to set the password all clients will be rejected.

@example
qemu [...OPTIONS...] -vnc :1,password -monitor stdio
(qemu) change vnc password
Password: ********
(qemu)
@end example

@node vnc_sec_certificate
@subsection With x509 certificates

The QEMU VNC server also implements the VeNCrypt extension allowing use of
TLS for encryption of the session, and x509 certificates for authentication.
The use of x509 certificates is strongly recommended, because TLS on its
own is susceptible to man-in-the-middle attacks. Basic x509 certificate
support provides a secure session, but no authentication. This allows any
client to connect, and provides an encrypted session.

@example
qemu [...OPTIONS...] -vnc :1,tls,x509=/etc/pki/qemu -monitor stdio
@end example

In the above example @code{/etc/pki/qemu} should contain at least three files,
@code{ca-cert.pem}, @code{server-cert.pem} and @code{server-key.pem}. Unprivileged
users will want to use a private directory, for example @code{$HOME/.pki/qemu}.
NB the @code{server-key.pem} file should be protected with file mode 0600 to
only be readable by the user owning it.

@node vnc_sec_certificate_verify
@subsection With x509 certificates and client verification

Certificates can also provide a means to authenticate the client connecting.
The server will request that the client provide a certificate, which it will
then validate against the CA certificate. This is a good choice if deploying
in an environment with a private internal certificate authority.

@example
qemu [...OPTIONS...] -vnc :1,tls,x509verify=/etc/pki/qemu -monitor stdio
@end example


@node vnc_sec_certificate_pw
@subsection With x509 certificates, client verification and passwords

Finally, the previous method can be combined with VNC password authentication
to provide two layers of authentication for clients.

@example
qemu [...OPTIONS...] -vnc :1,password,tls,x509verify=/etc/pki/qemu -monitor stdio
(qemu) change vnc password
Password: ********
(qemu)
@end example

@node vnc_generate_cert
@subsection Generating certificates for VNC

The GNU TLS packages provides a command called @code{certtool} which can
be used to generate certificates and keys in PEM format. At a minimum it
is neccessary to setup a certificate authority, and issue certificates to
each server. If using certificates for authentication, then each client
will also need to be issued a certificate. The recommendation is for the
server to keep its certificates in either @code{/etc/pki/qemu} or for
unprivileged users in @code{$HOME/.pki/qemu}.

@menu
* vnc_generate_ca::
* vnc_generate_server::
* vnc_generate_client::
@end menu
@node vnc_generate_ca
@subsubsection Setup the Certificate Authority

This step only needs to be performed once per organization / organizational
unit. First the CA needs a private key. This key must be kept VERY secret
and secure. If this key is compromised the entire trust chain of the certificates
issued with it is lost.

@example
# certtool --generate-privkey > ca-key.pem
@end example

A CA needs to have a public certificate. For simplicity it can be a self-signed
certificate, or one issue by a commercial certificate issuing authority. To
generate a self-signed certificate requires one core piece of information, the
name of the organization.

@example
# cat > ca.info <<EOF
cn = Name of your organization
ca
cert_signing_key
EOF
# certtool --generate-self-signed \
           --load-privkey ca-key.pem
           --template ca.info \
           --outfile ca-cert.pem
@end example

The @code{ca-cert.pem} file should be copied to all servers and clients wishing to utilize
TLS support in the VNC server. The @code{ca-key.pem} must not be disclosed/copied at all.

@node vnc_generate_server
@subsubsection Issuing server certificates

Each server (or host) needs to be issued with a key and certificate. When connecting
the certificate is sent to the client which validates it against the CA certificate.
The core piece of information for a server certificate is the hostname. This should
be the fully qualified hostname that the client will connect with, since the client
will typically also verify the hostname in the certificate. On the host holding the
secure CA private key:

@example
# cat > server.info <<EOF
organization = Name  of your organization
cn = server.foo.example.com
tls_www_server
encryption_key
signing_key
EOF
# certtool --generate-privkey > server-key.pem
# certtool --generate-certificate \
           --load-ca-certificate ca-cert.pem \
           --load-ca-privkey ca-key.pem \
           --load-privkey server server-key.pem \
           --template server.info \
           --outfile server-cert.pem
@end example

The @code{server-key.pem} and @code{server-cert.pem} files should now be securely copied
to the server for which they were generated. The @code{server-key.pem} is security
sensitive and should be kept protected with file mode 0600 to prevent disclosure.

@node vnc_generate_client
@subsubsection Issuing client certificates

If the QEMU VNC server is to use the @code{x509verify} option to validate client
certificates as its authentication mechanism, each client also needs to be issued
a certificate. The client certificate contains enough metadata to uniquely identify
the client, typically organization, state, city, building, etc. On the host holding
the secure CA private key:

@example
# cat > client.info <<EOF
country = GB
state = London
locality = London
organiazation = Name of your organization
cn = client.foo.example.com
tls_www_client
encryption_key
signing_key
EOF
# certtool --generate-privkey > client-key.pem
# certtool --generate-certificate \
           --load-ca-certificate ca-cert.pem \
           --load-ca-privkey ca-key.pem \
           --load-privkey client-key.pem \
           --template client.info \
           --outfile client-cert.pem
@end example

The @code{client-key.pem} and @code{client-cert.pem} files should now be securely
copied to the client for which they were generated.

B
updated  
bellard 已提交
1915
@node gdb_usage
B
bellard 已提交
1916 1917 1918
@section GDB usage

QEMU has a primitive support to work with gdb, so that you can do
B
updated  
bellard 已提交
1919
'Ctrl-C' while the virtual machine is running and inspect its state.
B
bellard 已提交
1920

B
update  
bellard 已提交
1921
In order to use gdb, launch qemu with the '-s' option. It will wait for a
B
bellard 已提交
1922 1923
gdb connection:
@example
B
bellard 已提交
1924 1925
> qemu -s -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
       -append "root=/dev/hda"
B
bellard 已提交
1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936
Connected to host network interface: tun0
Waiting gdb connection on port 1234
@end example

Then launch gdb on the 'vmlinux' executable:
@example
> gdb vmlinux
@end example

In gdb, connect to QEMU:
@example
B
update  
bellard 已提交
1937
(gdb) target remote localhost:1234
B
bellard 已提交
1938 1939 1940 1941 1942 1943 1944
@end example

Then you can use gdb normally. For example, type 'c' to launch the kernel:
@example
(gdb) c
@end example

B
updated  
bellard 已提交
1945 1946 1947 1948 1949 1950 1951 1952 1953
Here are some useful tips in order to use gdb on system code:

@enumerate
@item
Use @code{info reg} to display all the CPU registers.
@item
Use @code{x/10i $eip} to display the code at the PC position.
@item
Use @code{set architecture i8086} to dump 16 bit code. Then use
B
update  
bellard 已提交
1954
@code{x/10i $cs*16+$eip} to dump the code at the PC position.
B
updated  
bellard 已提交
1955 1956
@end enumerate

1957 1958 1959
Advanced debugging options:

The default single stepping behavior is step with the IRQs and timer service routines off.  It is set this way because when gdb executes a single step it expects to advance beyond the current instruction.  With the IRQs and and timer service routines on, a single step might jump into the one of the interrupt or exception vectors instead of executing the current instruction. This means you may hit the same breakpoint a number of times before executing the instruction gdb wants to have executed.  Because there are rare circumstances where you want to single step into an interrupt vector the behavior can be controlled from GDB.  There are three commands you can query and set the single step behavior:
1960
@table @code
1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984
@item maintenance packet qqemu.sstepbits

This will display the MASK bits used to control the single stepping IE:
@example
(gdb) maintenance packet qqemu.sstepbits
sending: "qqemu.sstepbits"
received: "ENABLE=1,NOIRQ=2,NOTIMER=4"
@end example
@item maintenance packet qqemu.sstep

This will display the current value of the mask used when single stepping IE:
@example
(gdb) maintenance packet qqemu.sstep
sending: "qqemu.sstep"
received: "0x7"
@end example
@item maintenance packet Qqemu.sstep=HEX_VALUE

This will change the single step mask, so if wanted to enable IRQs on the single step, but not timers, you would use:
@example
(gdb) maintenance packet Qqemu.sstep=0x5
sending: "qemu.sstep=0x5"
received: "OK"
@end example
1985
@end table
1986

B
bellard 已提交
1987
@node pcsys_os_specific
B
update  
bellard 已提交
1988 1989 1990 1991
@section Target OS specific information

@subsection Linux

B
bellard 已提交
1992 1993 1994
To have access to SVGA graphic modes under X11, use the @code{vesa} or
the @code{cirrus} X11 driver. For optimal performances, use 16 bit
color depth in the guest and the host OS.
B
update  
bellard 已提交
1995

B
update  
bellard 已提交
1996 1997 1998 1999 2000
When using a 2.6 guest Linux kernel, you should add the option
@code{clock=pit} on the kernel command line because the 2.6 Linux
kernels make very strict real time clock checks by default that QEMU
cannot simulate exactly.

B
update  
bellard 已提交
2001 2002 2003
When using a 2.6 guest Linux kernel, verify that the 4G/4G patch is
not activated because QEMU is slower with this patch. The QEMU
Accelerator Module is also much slower in this case. Earlier Fedora
2004
Core 3 Linux kernel (< 2.6.9-1.724_FC3) were known to incorporate this
B
update  
bellard 已提交
2005 2006
patch by default. Newer kernels don't have it.

B
update  
bellard 已提交
2007 2008 2009 2010 2011
@subsection Windows

If you have a slow host, using Windows 95 is better as it gives the
best speed. Windows 2000 is also a good choice.

B
update  
bellard 已提交
2012 2013 2014
@subsubsection SVGA graphic modes support

QEMU emulates a Cirrus Logic GD5446 Video
B
bellard 已提交
2015 2016 2017
card. All Windows versions starting from Windows 95 should recognize
and use this graphic card. For optimal performances, use 16 bit color
depth in the guest and the host OS.
B
update  
bellard 已提交
2018

B
bellard 已提交
2019 2020 2021 2022 2023
If you are using Windows XP as guest OS and if you want to use high
resolution modes which the Cirrus Logic BIOS does not support (i.e. >=
1280x1024x16), then you should use the VESA VBE virtual graphic card
(option @option{-std-vga}).

B
update  
bellard 已提交
2024 2025 2026
@subsubsection CPU usage reduction

Windows 9x does not correctly use the CPU HLT
B
bellard 已提交
2027 2028 2029 2030
instruction. The result is that it takes host CPU cycles even when
idle. You can install the utility from
@url{http://www.user.cityline.ru/~maxamn/amnhltm.zip} to solve this
problem. Note that no such tool is needed for NT, 2000 or XP.
B
update  
bellard 已提交
2031

B
update  
bellard 已提交
2032
@subsubsection Windows 2000 disk full problem
B
update  
bellard 已提交
2033

B
update  
bellard 已提交
2034 2035 2036 2037 2038
Windows 2000 has a bug which gives a disk full problem during its
installation. When installing it, use the @option{-win2k-hack} QEMU
option to enable a specific workaround. After Windows 2000 is
installed, you no longer need this option (this option slows down the
IDE transfers).
B
update  
bellard 已提交
2039

B
update  
bellard 已提交
2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050
@subsubsection Windows 2000 shutdown

Windows 2000 cannot automatically shutdown in QEMU although Windows 98
can. It comes from the fact that Windows 2000 does not automatically
use the APM driver provided by the BIOS.

In order to correct that, do the following (thanks to Struan
Bartlett): go to the Control Panel => Add/Remove Hardware & Next =>
Add/Troubleshoot a device => Add a new device & Next => No, select the
hardware from a list & Next => NT Apm/Legacy Support & Next => Next
(again) a few times. Now the driver is installed and Windows 2000 now
2051
correctly instructs QEMU to shutdown at the appropriate moment.
B
update  
bellard 已提交
2052 2053 2054 2055 2056

@subsubsection Share a directory between Unix and Windows

See @ref{sec_invocation} about the help of the option @option{-smb}.

B
update  
bellard 已提交
2057
@subsubsection Windows XP security problem
B
update  
bellard 已提交
2058 2059 2060 2061 2062 2063 2064 2065

Some releases of Windows XP install correctly but give a security
error when booting:
@example
A problem is preventing Windows from accurately checking the
license for this computer. Error code: 0x800703e6.
@end example

B
update  
bellard 已提交
2066 2067 2068 2069 2070
The workaround is to install a service pack for XP after a boot in safe
mode. Then reboot, and the problem should go away. Since there is no
network while in safe mode, its recommended to download the full
installation of SP1 or SP2 and transfer that via an ISO or using the
vvfat block device ("-hdb fat:directory_which_holds_the_SP").
B
update  
bellard 已提交
2071

B
update  
bellard 已提交
2072 2073 2074 2075 2076 2077 2078 2079 2080
@subsection MS-DOS and FreeDOS

@subsubsection CPU usage reduction

DOS does not correctly use the CPU HLT instruction. The result is that
it takes host CPU cycles even when idle. You can install the utility
from @url{http://www.vmware.com/software/dosidle210.zip} to solve this
problem.

B
bellard 已提交
2081
@node QEMU System emulator for non PC targets
B
bellard 已提交
2082 2083 2084 2085
@chapter QEMU System emulator for non PC targets

QEMU is a generic emulator and it emulates many non PC
machines. Most of the options are similar to the PC emulator. The
2086
differences are mentioned in the following sections.
B
bellard 已提交
2087

B
bellard 已提交
2088 2089
@menu
* QEMU PowerPC System emulator::
T
ths 已提交
2090 2091 2092 2093 2094
* Sparc32 System emulator::
* Sparc64 System emulator::
* MIPS System emulator::
* ARM System emulator::
* ColdFire System emulator::
B
bellard 已提交
2095 2096 2097
@end menu

@node QEMU PowerPC System emulator
B
bellard 已提交
2098
@section QEMU PowerPC System emulator
B
update  
bellard 已提交
2099

B
bellard 已提交
2100 2101
Use the executable @file{qemu-system-ppc} to simulate a complete PREP
or PowerMac PowerPC system.
B
update  
bellard 已提交
2102

B
typos  
bellard 已提交
2103
QEMU emulates the following PowerMac peripherals:
B
update  
bellard 已提交
2104

B
bellard 已提交
2105
@itemize @minus
2106 2107
@item
UniNorth PCI Bridge
B
bellard 已提交
2108 2109
@item
PCI VGA compatible card with VESA Bochs Extensions
2110
@item
B
bellard 已提交
2111
2 PMAC IDE interfaces with hard disk and CD-ROM support
2112
@item
B
bellard 已提交
2113 2114 2115 2116 2117
NE2000 PCI adapters
@item
Non Volatile RAM
@item
VIA-CUDA with ADB keyboard and mouse.
B
update  
bellard 已提交
2118 2119
@end itemize

B
typos  
bellard 已提交
2120
QEMU emulates the following PREP peripherals:
B
update  
bellard 已提交
2121 2122

@itemize @minus
2123
@item
B
bellard 已提交
2124 2125 2126
PCI Bridge
@item
PCI VGA compatible card with VESA Bochs Extensions
2127
@item
B
update  
bellard 已提交
2128 2129 2130
2 IDE interfaces with hard disk and CD-ROM support
@item
Floppy disk
2131
@item
B
bellard 已提交
2132
NE2000 network adapters
B
update  
bellard 已提交
2133 2134 2135 2136
@item
Serial port
@item
PREP Non Volatile RAM
B
bellard 已提交
2137 2138
@item
PC compatible keyboard and mouse.
B
update  
bellard 已提交
2139 2140
@end itemize

B
bellard 已提交
2141
QEMU uses the Open Hack'Ware Open Firmware Compatible BIOS available at
B
bellard 已提交
2142
@url{http://perso.magic.fr/l_indien/OpenHackWare/index.htm}.
B
update  
bellard 已提交
2143

B
bellard 已提交
2144 2145 2146 2147 2148 2149
@c man begin OPTIONS

The following options are specific to the PowerPC emulation:

@table @option

2150
@item -g WxH[xDEPTH]
B
bellard 已提交
2151 2152 2153 2154 2155

Set the initial VGA graphic mode. The default is 800x600x15.

@end table

2156
@c man end
B
bellard 已提交
2157 2158


B
update  
bellard 已提交
2159
More information is available at
B
bellard 已提交
2160
@url{http://perso.magic.fr/l_indien/qemu-ppc/}.
B
update  
bellard 已提交
2161

T
ths 已提交
2162 2163
@node Sparc32 System emulator
@section Sparc32 System emulator
B
bellard 已提交
2164

2165
Use the executable @file{qemu-system-sparc} to simulate a SPARCstation
B
blueswir1 已提交
2166 2167 2168 2169 2170
5, SPARCstation 10, SPARCstation 20, SPARCserver 600MP (sun4m
architecture), SPARCstation 2 (sun4c architecture), SPARCserver 1000,
or SPARCcenter 2000 (sun4d architecture). The emulation is somewhat
complete.  SMP up to 16 CPUs is supported, but Linux limits the number
of usable CPUs to 4.
B
bellard 已提交
2171

2172
QEMU emulates the following sun4m/sun4d peripherals:
B
bellard 已提交
2173 2174

@itemize @minus
B
bellard 已提交
2175
@item
2176
IOMMU or IO-UNITs
B
bellard 已提交
2177 2178
@item
TCX Frame buffer
2179
@item
B
bellard 已提交
2180 2181 2182 2183
Lance (Am7990) Ethernet
@item
Non Volatile RAM M48T08
@item
B
bellard 已提交
2184 2185 2186 2187 2188
Slave I/O: timers, interrupt controllers, Zilog serial ports, keyboard
and power/reset logic
@item
ESP SCSI controller with hard disk and CD-ROM support
@item
2189
Floppy drive (not on SS-600MP)
2190 2191
@item
CS4231 sound device (only on SS-5, not working yet)
B
bellard 已提交
2192 2193
@end itemize

2194 2195
The number of peripherals is fixed in the architecture.  Maximum
memory size depends on the machine type, for SS-5 it is 256MB and for
2196
others 2047MB.
B
bellard 已提交
2197

B
update  
bellard 已提交
2198
Since version 0.8.2, QEMU uses OpenBIOS
2199 2200 2201
@url{http://www.openbios.org/}. OpenBIOS is a free (GPL v2) portable
firmware implementation. The goal is to implement a 100% IEEE
1275-1994 (referred to as Open Firmware) compliant firmware.
B
bellard 已提交
2202 2203

A sample Linux 2.6 series kernel and ram disk image are available on
2204 2205
the QEMU web site. Please note that currently NetBSD, OpenBSD or
Solaris kernels don't work.
B
bellard 已提交
2206 2207 2208

@c man begin OPTIONS

2209
The following options are specific to the Sparc32 emulation:
B
bellard 已提交
2210 2211 2212

@table @option

2213
@item -g WxHx[xDEPTH]
B
bellard 已提交
2214

2215 2216
Set the initial TCX graphic mode. The default is 1024x768x8, currently
the only other possible mode is 1024x768x24.
B
bellard 已提交
2217

B
blueswir1 已提交
2218 2219 2220 2221 2222 2223 2224 2225 2226
@item -prom-env string

Set OpenBIOS variables in NVRAM, for example:

@example
qemu-system-sparc -prom-env 'auto-boot?=false' \
 -prom-env 'boot-device=sd(0,2,0):d' -prom-env 'boot-args=linux single'
@end example

B
blueswir1 已提交
2227
@item -M [SS-5|SS-10|SS-20|SS-600MP|SS-2|SS-1000|SS-2000]
2228 2229 2230

Set the emulated machine type. Default is SS-5.

B
bellard 已提交
2231 2232
@end table

2233
@c man end
B
bellard 已提交
2234

T
ths 已提交
2235 2236
@node Sparc64 System emulator
@section Sparc64 System emulator
B
bellard 已提交
2237

B
bellard 已提交
2238 2239
Use the executable @file{qemu-system-sparc64} to simulate a Sun4u machine.
The emulator is not usable for anything yet.
B
bellard 已提交
2240

B
bellard 已提交
2241 2242 2243 2244
QEMU emulates the following sun4u peripherals:

@itemize @minus
@item
2245
UltraSparc IIi APB PCI Bridge
B
bellard 已提交
2246 2247 2248 2249 2250 2251 2252 2253
@item
PCI VGA compatible card with VESA Bochs Extensions
@item
Non Volatile RAM M48T59
@item
PC-compatible serial ports
@end itemize

T
ths 已提交
2254 2255
@node MIPS System emulator
@section MIPS System emulator
B
update  
bellard 已提交
2256

T
ths 已提交
2257 2258 2259
Four executables cover simulation of 32 and 64-bit MIPS systems in
both endian options, @file{qemu-system-mips}, @file{qemu-system-mipsel}
@file{qemu-system-mips64} and @file{qemu-system-mips64el}.
2260
Five different machine types are emulated:
T
ths 已提交
2261 2262 2263 2264 2265 2266 2267

@itemize @minus
@item
A generic ISA PC-like machine "mips"
@item
The MIPS Malta prototype board "malta"
@item
T
ths 已提交
2268
An ACER Pica "pica61". This machine needs the 64-bit emulator.
T
ths 已提交
2269
@item
2270
MIPS emulator pseudo board "mipssim"
2271 2272
@item
A MIPS Magnum R4000 machine "magnum". This machine needs the 64-bit emulator.
T
ths 已提交
2273 2274 2275 2276 2277
@end itemize

The generic emulation is supported by Debian 'Etch' and is able to
install Debian into a virtual disk image. The following devices are
emulated:
B
bellard 已提交
2278 2279

@itemize @minus
2280
@item
T
ths 已提交
2281
A range of MIPS CPUs, default is the 24Kf
B
bellard 已提交
2282 2283 2284
@item
PC style serial port
@item
T
ths 已提交
2285 2286
PC style IDE disk
@item
B
bellard 已提交
2287 2288 2289
NE2000 network card
@end itemize

T
ths 已提交
2290 2291 2292 2293
The Malta emulation supports the following devices:

@itemize @minus
@item
T
ths 已提交
2294
Core board with MIPS 24Kf CPU and Galileo system controller
T
ths 已提交
2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318
@item
PIIX4 PCI/USB/SMbus controller
@item
The Multi-I/O chip's serial device
@item
PCnet32 PCI network card
@item
Malta FPGA serial device
@item
Cirrus VGA graphics card
@end itemize

The ACER Pica emulation supports:

@itemize @minus
@item
MIPS R4000 CPU
@item
PC-style IRQ and DMA controllers
@item
PC Keyboard
@item
IDE controller
@end itemize
B
bellard 已提交
2319

2320 2321 2322
The mipssim pseudo board emulation provides an environment similiar
to what the proprietary MIPS emulator uses for running Linux.
It supports:
T
ths 已提交
2323 2324 2325 2326 2327 2328 2329 2330 2331 2332

@itemize @minus
@item
A range of MIPS CPUs, default is the 24Kf
@item
PC style serial port
@item
MIPSnet network emulation
@end itemize

2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348
The MIPS Magnum R4000 emulation supports:

@itemize @minus
@item
MIPS R4000 CPU
@item
PC-style IRQ controller
@item
PC Keyboard
@item
SCSI controller
@item
G364 framebuffer
@end itemize


T
ths 已提交
2349 2350
@node ARM System emulator
@section ARM System emulator
B
bellard 已提交
2351 2352 2353 2354 2355 2356 2357

Use the executable @file{qemu-system-arm} to simulate a ARM
machine. The ARM Integrator/CP board is emulated with the following
devices:

@itemize @minus
@item
P
pbrook 已提交
2358
ARM926E, ARM1026E, ARM946E, ARM1136 or Cortex-A8 CPU
B
bellard 已提交
2359 2360
@item
Two PL011 UARTs
2361
@item
B
bellard 已提交
2362
SMC 91c111 Ethernet adapter
P
pbrook 已提交
2363 2364 2365 2366
@item
PL110 LCD controller
@item
PL050 KMI with PS/2 keyboard and mouse.
2367 2368
@item
PL181 MultiMedia Card Interface with SD card.
P
pbrook 已提交
2369 2370 2371 2372 2373 2374
@end itemize

The ARM Versatile baseboard is emulated with the following devices:

@itemize @minus
@item
P
pbrook 已提交
2375
ARM926E, ARM1136 or Cortex-A8 CPU
P
pbrook 已提交
2376 2377 2378 2379
@item
PL190 Vectored Interrupt Controller
@item
Four PL011 UARTs
2380
@item
P
pbrook 已提交
2381 2382 2383 2384 2385 2386 2387 2388
SMC 91c111 Ethernet adapter
@item
PL110 LCD controller
@item
PL050 KMI with PS/2 keyboard and mouse.
@item
PCI host bridge.  Note the emulated PCI bridge only provides access to
PCI memory space.  It does not provide access to PCI IO space.
2389 2390
This means some devices (eg. ne2k_pci NIC) are not usable, and others
(eg. rtl8139 NIC) are only usable when the guest drivers use the memory
P
pbrook 已提交
2391
mapped control registers.
P
pbrook 已提交
2392 2393 2394 2395
@item
PCI OHCI USB controller.
@item
LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices.
2396 2397
@item
PL181 MultiMedia Card Interface with SD card.
B
bellard 已提交
2398 2399
@end itemize

2400 2401 2402 2403
The ARM RealView Emulation baseboard is emulated with the following devices:

@itemize @minus
@item
P
pbrook 已提交
2404
ARM926E, ARM1136, ARM11MPCORE(x4) or Cortex-A8 CPU
2405 2406 2407 2408
@item
ARM AMBA Generic/Distributed Interrupt Controller
@item
Four PL011 UARTs
2409
@item
2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420
SMC 91c111 Ethernet adapter
@item
PL110 LCD controller
@item
PL050 KMI with PS/2 keyboard and mouse
@item
PCI host bridge
@item
PCI OHCI USB controller
@item
LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices
2421 2422
@item
PL181 MultiMedia Card Interface with SD card.
2423 2424
@end itemize

2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447
The XScale-based clamshell PDA models ("Spitz", "Akita", "Borzoi"
and "Terrier") emulation includes the following peripherals:

@itemize @minus
@item
Intel PXA270 System-on-chip (ARM V5TE core)
@item
NAND Flash memory
@item
IBM/Hitachi DSCM microdrive in a PXA PCMCIA slot - not in "Akita"
@item
On-chip OHCI USB controller
@item
On-chip LCD controller
@item
On-chip Real Time Clock
@item
TI ADS7846 touchscreen controller on SSP bus
@item
Maxim MAX1111 analog-digital converter on I@math{^2}C bus
@item
GPIO-connected keyboard controller and LEDs
@item
2448
Secure Digital card connected to PXA MMC/SD host
2449 2450 2451 2452 2453 2454
@item
Three on-chip UARTs
@item
WM8750 audio CODEC on I@math{^2}C and I@math{^2}S busses
@end itemize

B
balrog 已提交
2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477
The Palm Tungsten|E PDA (codename "Cheetah") emulation includes the
following elements:

@itemize @minus
@item
Texas Instruments OMAP310 System-on-chip (ARM 925T core)
@item
ROM and RAM memories (ROM firmware image can be loaded with -option-rom)
@item
On-chip LCD controller
@item
On-chip Real Time Clock
@item
TI TSC2102i touchscreen controller / analog-digital converter / Audio
CODEC, connected through MicroWire and I@math{^2}S busses
@item
GPIO-connected matrix keypad
@item
Secure Digital card connected to OMAP MMC/SD host
@item
Three on-chip UARTs
@end itemize

2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510
Nokia N800 and N810 internet tablets (known also as RX-34 and RX-44 / 48)
emulation supports the following elements:

@itemize @minus
@item
Texas Instruments OMAP2420 System-on-chip (ARM 1136 core)
@item
RAM and non-volatile OneNAND Flash memories
@item
Display connected to EPSON remote framebuffer chip and OMAP on-chip
display controller and a LS041y3 MIPI DBI-C controller
@item
TI TSC2301 (in N800) and TI TSC2005 (in N810) touchscreen controllers
driven through SPI bus
@item
National Semiconductor LM8323-controlled qwerty keyboard driven
through I@math{^2}C bus
@item
Secure Digital card connected to OMAP MMC/SD host
@item
Three OMAP on-chip UARTs and on-chip STI debugging console
@item
Mentor Graphics "Inventra" dual-role USB controller embedded in a TI
TUSB6010 chip - only USB host mode is supported
@item
TI TMP105 temperature sensor driven through I@math{^2}C bus
@item
TI TWL92230C power management companion with an RTC on I@math{^2}C bus
@item
Nokia RETU and TAHVO multi-purpose chips with an RTC, connected
through CBUS
@end itemize

P
pbrook 已提交
2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538
The Luminary Micro Stellaris LM3S811EVB emulation includes the following
devices:

@itemize @minus
@item
Cortex-M3 CPU core.
@item
64k Flash and 8k SRAM.
@item
Timers, UARTs, ADC and I@math{^2}C interface.
@item
OSRAM Pictiva 96x16 OLED with SSD0303 controller on I@math{^2}C bus.
@end itemize

The Luminary Micro Stellaris LM3S6965EVB emulation includes the following
devices:

@itemize @minus
@item
Cortex-M3 CPU core.
@item
256k Flash and 64k SRAM.
@item
Timers, UARTs, ADC, I@math{^2}C and SSI interfaces.
@item
OSRAM Pictiva 128x64 OLED with SSD0323 controller connected via SSI.
@end itemize

2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558
The Freecom MusicPal internet radio emulation includes the following
elements:

@itemize @minus
@item
Marvell MV88W8618 ARM core.
@item
32 MB RAM, 256 KB SRAM, 8 MB flash.
@item
Up to 2 16550 UARTs
@item
MV88W8xx8 Ethernet controller
@item
MV88W8618 audio controller, WM8750 CODEC and mixer
@item
12864 display with brightness control
@item
2 buttons, 2 navigation wheels with button function
@end itemize

B
bellard 已提交
2559 2560
A Linux 2.6 test image is available on the QEMU web site. More
information is available in the QEMU mailing-list archive.
B
update  
bellard 已提交
2561

T
ths 已提交
2562 2563
@node ColdFire System emulator
@section ColdFire System emulator
P
pbrook 已提交
2564 2565 2566

Use the executable @file{qemu-system-m68k} to simulate a ColdFire machine.
The emulator is able to boot a uClinux kernel.
2567 2568 2569 2570

The M5208EVB emulation includes the following devices:

@itemize @minus
2571
@item
2572 2573 2574 2575 2576 2577 2578 2579
MCF5208 ColdFire V2 Microprocessor (ISA A+ with EMAC).
@item
Three Two on-chip UARTs.
@item
Fast Ethernet Controller (FEC)
@end itemize

The AN5206 emulation includes the following devices:
P
pbrook 已提交
2580 2581

@itemize @minus
2582
@item
P
pbrook 已提交
2583 2584 2585 2586 2587
MCF5206 ColdFire V2 Microprocessor.
@item
Two on-chip UARTs.
@end itemize

2588 2589
@node QEMU User space emulator
@chapter QEMU User space emulator
B
bellard 已提交
2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603

@menu
* Supported Operating Systems ::
* Linux User space emulator::
* Mac OS X/Darwin User space emulator ::
@end menu

@node Supported Operating Systems
@section Supported Operating Systems

The following OS are supported in user space emulation:

@itemize @minus
@item
2604
Linux (referred as qemu-linux-user)
B
bellard 已提交
2605
@item
2606
Mac OS X/Darwin (referred as qemu-darwin-user)
B
bellard 已提交
2607 2608 2609 2610
@end itemize

@node Linux User space emulator
@section Linux User space emulator
B
bellard 已提交
2611

B
bellard 已提交
2612 2613 2614 2615
@menu
* Quick Start::
* Wine launch::
* Command line options::
P
pbrook 已提交
2616
* Other binaries::
B
bellard 已提交
2617 2618 2619
@end menu

@node Quick Start
B
bellard 已提交
2620
@subsection Quick Start
B
update  
bellard 已提交
2621

B
bellard 已提交
2622
In order to launch a Linux process, QEMU needs the process executable
2623
itself and all the target (x86) dynamic libraries used by it.
B
bellard 已提交
2624

B
bellard 已提交
2625
@itemize
B
bellard 已提交
2626

B
bellard 已提交
2627 2628
@item On x86, you can just try to launch any process by using the native
libraries:
B
bellard 已提交
2629

2630
@example
B
bellard 已提交
2631 2632
qemu-i386 -L / /bin/ls
@end example
B
bellard 已提交
2633

B
bellard 已提交
2634 2635
@code{-L /} tells that the x86 dynamic linker must be searched with a
@file{/} prefix.
B
bellard 已提交
2636

2637 2638
@item Since QEMU is also a linux process, you can launch qemu with
qemu (NOTE: you can only do that if you compiled QEMU from the sources):
B
bellard 已提交
2639

2640
@example
B
bellard 已提交
2641 2642
qemu-i386 -L / qemu-i386 -L / /bin/ls
@end example
B
bellard 已提交
2643

B
bellard 已提交
2644 2645 2646
@item On non x86 CPUs, you need first to download at least an x86 glibc
(@file{qemu-runtime-i386-XXX-.tar.gz} on the QEMU web page). Ensure that
@code{LD_LIBRARY_PATH} is not set:
B
update  
bellard 已提交
2647

B
bellard 已提交
2648
@example
2649
unset LD_LIBRARY_PATH
B
bellard 已提交
2650
@end example
B
update  
bellard 已提交
2651

B
bellard 已提交
2652
Then you can launch the precompiled @file{ls} x86 executable:
B
update  
bellard 已提交
2653

B
bellard 已提交
2654 2655 2656 2657 2658 2659 2660
@example
qemu-i386 tests/i386/ls
@end example
You can look at @file{qemu-binfmt-conf.sh} so that
QEMU is automatically launched by the Linux kernel when you try to
launch x86 executables. It requires the @code{binfmt_misc} module in the
Linux kernel.
B
update  
bellard 已提交
2661

B
bellard 已提交
2662 2663
@item The x86 version of QEMU is also included. You can try weird things such as:
@example
B
bellard 已提交
2664 2665
qemu-i386 /usr/local/qemu-i386/bin/qemu-i386 \
          /usr/local/qemu-i386/bin/ls-i386
B
bellard 已提交
2666
@end example
B
update  
bellard 已提交
2667

B
bellard 已提交
2668
@end itemize
B
update  
bellard 已提交
2669

B
bellard 已提交
2670
@node Wine launch
B
bellard 已提交
2671
@subsection Wine launch
B
update  
bellard 已提交
2672

B
bellard 已提交
2673
@itemize
B
bellard 已提交
2674

B
bellard 已提交
2675 2676 2677
@item Ensure that you have a working QEMU with the x86 glibc
distribution (see previous section). In order to verify it, you must be
able to do:
B
bellard 已提交
2678

B
bellard 已提交
2679 2680 2681
@example
qemu-i386 /usr/local/qemu-i386/bin/ls-i386
@end example
B
bellard 已提交
2682

B
bellard 已提交
2683
@item Download the binary x86 Wine install
2684
(@file{qemu-XXX-i386-wine.tar.gz} on the QEMU web page).
B
bellard 已提交
2685

B
bellard 已提交
2686
@item Configure Wine on your account. Look at the provided script
B
bellard 已提交
2687
@file{/usr/local/qemu-i386/@/bin/wine-conf.sh}. Your previous
B
bellard 已提交
2688
@code{$@{HOME@}/.wine} directory is saved to @code{$@{HOME@}/.wine.org}.
B
bellard 已提交
2689

B
bellard 已提交
2690
@item Then you can try the example @file{putty.exe}:
B
bellard 已提交
2691

B
bellard 已提交
2692
@example
B
bellard 已提交
2693 2694
qemu-i386 /usr/local/qemu-i386/wine/bin/wine \
          /usr/local/qemu-i386/wine/c/Program\ Files/putty.exe
B
bellard 已提交
2695
@end example
B
bellard 已提交
2696

B
bellard 已提交
2697
@end itemize
B
update  
bellard 已提交
2698

B
bellard 已提交
2699
@node Command line options
B
bellard 已提交
2700
@subsection Command line options
B
update  
bellard 已提交
2701

B
bellard 已提交
2702 2703 2704
@example
usage: qemu-i386 [-h] [-d] [-L path] [-s size] program [arguments...]
@end example
B
update  
bellard 已提交
2705

B
bellard 已提交
2706 2707 2708
@table @option
@item -h
Print the help
2709
@item -L path
B
bellard 已提交
2710 2711 2712
Set the x86 elf interpreter prefix (default=/usr/local/qemu-i386)
@item -s size
Set the x86 stack size in bytes (default=524288)
B
bellard 已提交
2713 2714
@end table

B
bellard 已提交
2715
Debug options:
B
bellard 已提交
2716

B
bellard 已提交
2717 2718 2719 2720 2721 2722
@table @option
@item -d
Activate log (logfile=/tmp/qemu.log)
@item -p pagesize
Act as if the host page size was 'pagesize' bytes
@end table
B
bellard 已提交
2723

2724 2725 2726 2727 2728 2729 2730 2731 2732 2733
Environment variables:

@table @env
@item QEMU_STRACE
Print system calls and arguments similar to the 'strace' program
(NOTE: the actual 'strace' program will not work because the user
space emulator hasn't implemented ptrace).  At the moment this is
incomplete.  All system calls that don't have a specific argument
format are printed with information for six arguments.  Many
flag-style arguments don't have decoders and will show up as numbers.
T
ths 已提交
2734
@end table
2735

P
pbrook 已提交
2736
@node Other binaries
B
bellard 已提交
2737
@subsection Other binaries
P
pbrook 已提交
2738 2739 2740 2741 2742

@command{qemu-arm} is also capable of running ARM "Angel" semihosted ELF
binaries (as implemented by the arm-elf and arm-eabi Newlib/GDB
configurations), and arm-uclinux bFLT format binaries.

P
pbrook 已提交
2743 2744 2745 2746
@command{qemu-m68k} is capable of running semihosted binaries using the BDM
(m5xxx-ram-hosted.ld) or m68k-sim (sim.ld) syscall interfaces, and
coldfire uClinux bFLT format binaries.

P
pbrook 已提交
2747 2748
The binary format is detected automatically.

B
blueswir1 已提交
2749 2750 2751 2752 2753 2754
@command{qemu-sparc32plus} can execute Sparc32 and SPARC32PLUS binaries
(Sparc64 CPU, 32 bit ABI).

@command{qemu-sparc64} can execute some Sparc64 (Sparc64 CPU, 64 bit ABI) and
SPARC32PLUS binaries (Sparc64 CPU, 32 bit ABI).

B
bellard 已提交
2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772
@node Mac OS X/Darwin User space emulator
@section Mac OS X/Darwin User space emulator

@menu
* Mac OS X/Darwin Status::
* Mac OS X/Darwin Quick Start::
* Mac OS X/Darwin Command line options::
@end menu

@node Mac OS X/Darwin Status
@subsection Mac OS X/Darwin Status

@itemize @minus
@item
target x86 on x86: Most apps (Cocoa and Carbon too) works. [1]
@item
target PowerPC on x86: Not working as the ppc commpage can't be mapped (yet!)
@item
2773
target PowerPC on PowerPC: Most apps (Cocoa and Carbon too) works. [1]
B
bellard 已提交
2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792
@item
target x86 on PowerPC: most utilities work. Cocoa and Carbon apps are not yet supported.
@end itemize

[1] If you're host commpage can be executed by qemu.

@node Mac OS X/Darwin Quick Start
@subsection Quick Start

In order to launch a Mac OS X/Darwin process, QEMU needs the process executable
itself and all the target dynamic libraries used by it. If you don't have the FAT
libraries (you're running Mac OS X/ppc) you'll need to obtain it from a Mac OS X
CD or compile them by hand.

@itemize

@item On x86, you can just try to launch any process by using the native
libraries:

2793
@example
2794
qemu-i386 /bin/ls
B
bellard 已提交
2795 2796 2797 2798
@end example

or to run the ppc version of the executable:

2799
@example
2800
qemu-ppc /bin/ls
B
bellard 已提交
2801 2802 2803 2804 2805
@end example

@item On ppc, you'll have to tell qemu where your x86 libraries (and dynamic linker)
are installed:

2806
@example
2807
qemu-i386 -L /opt/x86_root/ /bin/ls
B
bellard 已提交
2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818
@end example

@code{-L /opt/x86_root/} tells that the dynamic linker (dyld) path is in
@file{/opt/x86_root/usr/bin/dyld}.

@end itemize

@node Mac OS X/Darwin Command line options
@subsection Command line options

@example
2819
usage: qemu-i386 [-h] [-d] [-L path] [-s size] program [arguments...]
B
bellard 已提交
2820 2821 2822 2823 2824
@end example

@table @option
@item -h
Print the help
2825
@item -L path
B
bellard 已提交
2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839
Set the library root path (default=/)
@item -s size
Set the stack size in bytes (default=524288)
@end table

Debug options:

@table @option
@item -d
Activate log (logfile=/tmp/qemu.log)
@item -p pagesize
Act as if the host page size was 'pagesize' bytes
@end table

B
bellard 已提交
2840 2841 2842
@node compilation
@chapter Compilation from the sources

B
bellard 已提交
2843 2844 2845 2846 2847 2848 2849 2850
@menu
* Linux/Unix::
* Windows::
* Cross compilation for Windows with Linux::
* Mac OS X::
@end menu

@node Linux/Unix
B
update  
bellard 已提交
2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873
@section Linux/Unix

@subsection Compilation

First you must decompress the sources:
@example
cd /tmp
tar zxvf qemu-x.y.z.tar.gz
cd qemu-x.y.z
@end example

Then you configure QEMU and build it (usually no options are needed):
@example
./configure
make
@end example

Then type as root user:
@example
make install
@end example
to install QEMU in @file{/usr/local}.

B
bellard 已提交
2874
@subsection GCC version
B
update  
bellard 已提交
2875

T
ths 已提交
2876
In order to compile QEMU successfully, it is very important that you
B
bellard 已提交
2877 2878 2879 2880 2881
have the right tools. The most important one is gcc. On most hosts and
in particular on x86 ones, @emph{gcc 4.x is not supported}. If your
Linux distribution includes a gcc 4.x compiler, you can usually
install an older version (it is invoked by @code{gcc32} or
@code{gcc34}). The QEMU configure script automatically probes for
2882
these older versions so that usually you don't have to do anything.
B
bellard 已提交
2883

B
bellard 已提交
2884
@node Windows
B
bellard 已提交
2885 2886 2887 2888 2889 2890 2891
@section Windows

@itemize
@item Install the current versions of MSYS and MinGW from
@url{http://www.mingw.org/}. You can find detailed installation
instructions in the download section and the FAQ.

2892
@item Download
B
bellard 已提交
2893
the MinGW development library of SDL 1.2.x
B
bellard 已提交
2894
(@file{SDL-devel-1.2.x-@/mingw32.tar.gz}) from
B
bellard 已提交
2895 2896 2897 2898 2899 2900
@url{http://www.libsdl.org}. Unpack it in a temporary place, and
unpack the archive @file{i386-mingw32msvc.tar.gz} in the MinGW tool
directory. Edit the @file{sdl-config} script so that it gives the
correct SDL directory when invoked.

@item Extract the current version of QEMU.
2901

B
bellard 已提交
2902 2903
@item Start the MSYS shell (file @file{msys.bat}).

2904
@item Change to the QEMU directory. Launch @file{./configure} and
B
bellard 已提交
2905 2906 2907
@file{make}.  If you have problems using SDL, verify that
@file{sdl-config} can be launched from the MSYS command line.

2908
@item You can install QEMU in @file{Program Files/Qemu} by typing
B
bellard 已提交
2909 2910 2911 2912 2913
@file{make install}. Don't forget to copy @file{SDL.dll} in
@file{Program Files/Qemu}.

@end itemize

B
bellard 已提交
2914
@node Cross compilation for Windows with Linux
B
bellard 已提交
2915 2916 2917 2918 2919 2920 2921
@section Cross compilation for Windows with Linux

@itemize
@item
Install the MinGW cross compilation tools available at
@url{http://www.mingw.org/}.

2922
@item
B
bellard 已提交
2923 2924 2925 2926 2927
Install the Win32 version of SDL (@url{http://www.libsdl.org}) by
unpacking @file{i386-mingw32msvc.tar.gz}. Set up the PATH environment
variable so that @file{i386-mingw32msvc-sdl-config} can be launched by
the QEMU configuration script.

2928
@item
B
bellard 已提交
2929 2930 2931 2932 2933
Configure QEMU for Windows cross compilation:
@example
./configure --enable-mingw32
@end example
If necessary, you can change the cross-prefix according to the prefix
2934
chosen for the MinGW tools with --cross-prefix. You can also use
B
bellard 已提交
2935 2936
--prefix to set the Win32 install path.

2937
@item You can install QEMU in the installation directory by typing
B
bellard 已提交
2938
@file{make install}. Don't forget to copy @file{SDL.dll} in the
2939
installation directory.
B
bellard 已提交
2940 2941 2942 2943 2944 2945

@end itemize

Note: Currently, Wine does not seem able to launch
QEMU for Win32.

B
bellard 已提交
2946
@node Mac OS X
B
bellard 已提交
2947 2948 2949 2950 2951 2952
@section Mac OS X

The Mac OS X patches are not fully merged in QEMU, so you should look
at the QEMU mailing list archive to have all the necessary
information.

B
bellard 已提交
2953 2954 2955 2956 2957
@node Index
@chapter Index
@printindex cp

@bye