blob: 5b534cc9b427a9f663a5442c961b46294e9f0864 [file] [log] [blame]
bellard386405f2003-03-23 21:28:45 +00001\input texinfo @c -*- texinfo -*-
bellarddebc7062006-04-30 21:58:41 +00002@c %**start of header
3@setfilename qemu-doc.info
bellard8f40c382006-09-20 20:28:05 +00004@settitle QEMU Emulator User Documentation
bellarddebc7062006-04-30 21:58:41 +00005@exampleindent 0
6@paragraphindent 0
7@c %**end of header
bellard386405f2003-03-23 21:28:45 +00008
bellard0806e3f2003-10-01 00:15:32 +00009@iftex
bellard386405f2003-03-23 21:28:45 +000010@titlepage
11@sp 7
bellard8f40c382006-09-20 20:28:05 +000012@center @titlefont{QEMU Emulator}
bellarddebc7062006-04-30 21:58:41 +000013@sp 1
14@center @titlefont{User Documentation}
bellard386405f2003-03-23 21:28:45 +000015@sp 3
16@end titlepage
bellard0806e3f2003-10-01 00:15:32 +000017@end iftex
bellard386405f2003-03-23 21:28:45 +000018
bellarddebc7062006-04-30 21:58:41 +000019@ifnottex
20@node Top
21@top
22
23@menu
24* Introduction::
25* Installation::
26* QEMU PC System emulator::
27* QEMU System emulator for non PC targets::
bellard83195232007-02-05 19:42:07 +000028* QEMU User space emulator::
bellarddebc7062006-04-30 21:58:41 +000029* compilation:: Compilation from the sources
30* Index::
31@end menu
32@end ifnottex
33
34@contents
35
36@node Introduction
bellard386405f2003-03-23 21:28:45 +000037@chapter Introduction
38
bellarddebc7062006-04-30 21:58:41 +000039@menu
40* intro_features:: Features
41@end menu
42
43@node intro_features
bellard322d0c62003-06-15 23:29:28 +000044@section Features
bellard386405f2003-03-23 21:28:45 +000045
bellard1f673132004-04-04 15:21:17 +000046QEMU is a FAST! processor emulator using dynamic translation to
47achieve good emulation speed.
bellard1eb20522003-06-25 16:21:49 +000048
49QEMU has two operating modes:
bellard0806e3f2003-10-01 00:15:32 +000050
51@itemize @minus
52
ths5fafdf22007-09-16 21:08:06 +000053@item
bellard1f673132004-04-04 15:21:17 +000054Full system emulation. In this mode, QEMU emulates a full system (for
bellard3f9f3aa2005-12-18 20:11:37 +000055example a PC), including one or several processors and various
56peripherals. It can be used to launch different Operating Systems
57without rebooting the PC or to debug system code.
bellard1eb20522003-06-25 16:21:49 +000058
ths5fafdf22007-09-16 21:08:06 +000059@item
bellard83195232007-02-05 19:42:07 +000060User mode emulation. In this mode, QEMU can launch
61processes compiled for one CPU on another CPU. It can be used to
bellard1f673132004-04-04 15:21:17 +000062launch the Wine Windows API emulator (@url{http://www.winehq.org}) or
63to ease cross-compilation and cross-debugging.
bellard1eb20522003-06-25 16:21:49 +000064
65@end itemize
66
bellard7c3fc842005-02-10 21:46:47 +000067QEMU can run without an host kernel driver and yet gives acceptable
ths5fafdf22007-09-16 21:08:06 +000068performance.
bellard322d0c62003-06-15 23:29:28 +000069
bellard52c00a52004-04-25 21:27:03 +000070For system emulation, the following hardware targets are supported:
71@itemize
bellard9d0a8e62005-07-03 17:34:05 +000072@item PC (x86 or x86_64 processor)
bellard3f9f3aa2005-12-18 20:11:37 +000073@item ISA PC (old style PC without PCI bus)
bellard52c00a52004-04-25 21:27:03 +000074@item PREP (PowerPC processor)
bellard9d0a8e62005-07-03 17:34:05 +000075@item G3 BW PowerMac (PowerPC processor)
76@item Mac99 PowerMac (PowerPC processor, in progress)
bellard34751872005-07-02 14:31:34 +000077@item Sun4m (32-bit Sparc processor)
78@item Sun4u (64-bit Sparc processor, in progress)
bellard3f9f3aa2005-12-18 20:11:37 +000079@item Malta board (32-bit MIPS processor)
pbrookce819862007-05-08 02:30:40 +000080@item ARM Integrator/CP (ARM926E, 1026E or 946E processor)
pbrook00a9bf12006-05-13 16:55:46 +000081@item ARM Versatile baseboard (ARM926E)
pbrookd7739d72007-02-28 16:25:17 +000082@item ARM RealView Emulation baseboard (ARM926EJ-S)
balrogb00052e2007-04-30 02:22:06 +000083@item Spitz, Akita, Borzoi and Terrier PDAs (PXA270 processor)
pbrook707e0112007-06-04 00:50:06 +000084@item Freescale MCF5208EVB (ColdFire V2).
pbrook209a4e62007-05-23 20:16:15 +000085@item Arnewsh MCF5206 evaluation board (ColdFire V2).
bellard52c00a52004-04-25 21:27:03 +000086@end itemize
bellard386405f2003-03-23 21:28:45 +000087
pbrooke6e59062006-10-22 00:18:54 +000088For user emulation, x86, PowerPC, ARM, MIPS, Sparc32/64 and ColdFire(m68k) CPUs are supported.
bellard0806e3f2003-10-01 00:15:32 +000089
bellarddebc7062006-04-30 21:58:41 +000090@node Installation
bellard5b9f4572003-10-28 00:49:54 +000091@chapter Installation
92
bellard15a34c62004-07-08 21:26:26 +000093If you want to compile QEMU yourself, see @ref{compilation}.
94
bellarddebc7062006-04-30 21:58:41 +000095@menu
96* install_linux:: Linux
97* install_windows:: Windows
98* install_mac:: Macintosh
99@end menu
100
101@node install_linux
bellard1f673132004-04-04 15:21:17 +0000102@section Linux
103
bellard7c3fc842005-02-10 21:46:47 +0000104If a precompiled package is available for your distribution - you just
105have to install it. Otherwise, see @ref{compilation}.
bellard5b9f4572003-10-28 00:49:54 +0000106
bellarddebc7062006-04-30 21:58:41 +0000107@node install_windows
bellard1f673132004-04-04 15:21:17 +0000108@section Windows
bellard8cd0ac22004-05-12 19:09:16 +0000109
bellard15a34c62004-07-08 21:26:26 +0000110Download the experimental binary installer at
bellarddebc7062006-04-30 21:58:41 +0000111@url{http://www.free.oszoo.org/@/download.html}.
bellardd691f662003-03-24 21:58:34 +0000112
bellarddebc7062006-04-30 21:58:41 +0000113@node install_mac
bellard1f673132004-04-04 15:21:17 +0000114@section Mac OS X
bellardd691f662003-03-24 21:58:34 +0000115
bellard15a34c62004-07-08 21:26:26 +0000116Download the experimental binary installer at
bellarddebc7062006-04-30 21:58:41 +0000117@url{http://www.free.oszoo.org/@/download.html}.
bellarddf0f11a2003-05-28 00:27:57 +0000118
bellarddebc7062006-04-30 21:58:41 +0000119@node QEMU PC System emulator
bellard3f9f3aa2005-12-18 20:11:37 +0000120@chapter QEMU PC System emulator
bellard1eb20522003-06-25 16:21:49 +0000121
bellarddebc7062006-04-30 21:58:41 +0000122@menu
123* pcsys_introduction:: Introduction
124* pcsys_quickstart:: Quick Start
125* sec_invocation:: Invocation
126* pcsys_keys:: Keys
127* pcsys_monitor:: QEMU Monitor
128* disk_images:: Disk Images
129* pcsys_network:: Network emulation
130* direct_linux_boot:: Direct Linux Boot
131* pcsys_usb:: USB emulation
thsf858dca2007-08-25 01:40:37 +0000132* vnc_security:: VNC security
bellarddebc7062006-04-30 21:58:41 +0000133* gdb_usage:: GDB usage
134* pcsys_os_specific:: Target OS specific information
135@end menu
136
137@node pcsys_introduction
bellard0806e3f2003-10-01 00:15:32 +0000138@section Introduction
139
140@c man begin DESCRIPTION
141
bellard3f9f3aa2005-12-18 20:11:37 +0000142The QEMU PC System emulator simulates the
143following peripherals:
bellard0806e3f2003-10-01 00:15:32 +0000144
145@itemize @minus
ths5fafdf22007-09-16 21:08:06 +0000146@item
bellard15a34c62004-07-08 21:26:26 +0000147i440FX host PCI bridge and PIIX3 PCI to ISA bridge
bellard0806e3f2003-10-01 00:15:32 +0000148@item
bellard15a34c62004-07-08 21:26:26 +0000149Cirrus CLGD 5446 PCI VGA card or dummy VGA card with Bochs VESA
150extensions (hardware level, including all non standard modes).
bellard0806e3f2003-10-01 00:15:32 +0000151@item
152PS/2 mouse and keyboard
ths5fafdf22007-09-16 21:08:06 +0000153@item
bellard15a34c62004-07-08 21:26:26 +00001542 PCI IDE interfaces with hard disk and CD-ROM support
bellard1f673132004-04-04 15:21:17 +0000155@item
156Floppy disk
ths5fafdf22007-09-16 21:08:06 +0000157@item
blueswir1c4a70602007-05-27 19:41:17 +0000158PCI/ISA PCI network adapters
bellard0806e3f2003-10-01 00:15:32 +0000159@item
bellard05d58182004-08-24 21:12:04 +0000160Serial ports
161@item
bellardc0fe3822005-11-05 18:55:28 +0000162Creative SoundBlaster 16 sound card
163@item
164ENSONIQ AudioPCI ES1370 sound card
165@item
166Adlib(OPL2) - Yamaha YM3812 compatible chip
bellardb389dbf2005-11-06 16:49:55 +0000167@item
168PCI UHCI USB controller and a virtual USB hub.
bellard0806e3f2003-10-01 00:15:32 +0000169@end itemize
170
bellard3f9f3aa2005-12-18 20:11:37 +0000171SMP is supported with up to 255 CPUs.
172
bellardc0fe3822005-11-05 18:55:28 +0000173Note that adlib is only available when QEMU was configured with
174-enable-adlib
175
bellard15a34c62004-07-08 21:26:26 +0000176QEMU uses the PC BIOS from the Bochs project and the Plex86/Bochs LGPL
177VGA BIOS.
178
bellardc0fe3822005-11-05 18:55:28 +0000179QEMU uses YM3812 emulation by Tatsuyuki Satoh.
180
bellard0806e3f2003-10-01 00:15:32 +0000181@c man end
182
bellarddebc7062006-04-30 21:58:41 +0000183@node pcsys_quickstart
bellard1eb20522003-06-25 16:21:49 +0000184@section Quick Start
185
bellard285dc332003-10-27 23:58:04 +0000186Download and uncompress the linux image (@file{linux.img}) and type:
bellard0806e3f2003-10-01 00:15:32 +0000187
188@example
bellard285dc332003-10-27 23:58:04 +0000189qemu linux.img
bellard0806e3f2003-10-01 00:15:32 +0000190@end example
191
192Linux should boot and give you a prompt.
193
bellard6cc721c2005-07-28 22:27:28 +0000194@node sec_invocation
bellard1f673132004-04-04 15:21:17 +0000195@section Invocation
196
197@example
198@c man begin SYNOPSIS
199usage: qemu [options] [disk_image]
200@c man end
201@end example
202
203@c man begin OPTIONS
204@var{disk_image} is a raw hard disk image for IDE hard disk 0.
205
206General options:
207@table @option
bellard3dbbdc22005-11-06 18:20:37 +0000208@item -M machine
209Select the emulated machine (@code{-M ?} for list)
210
bellard1f673132004-04-04 15:21:17 +0000211@item -fda file
212@item -fdb file
bellarddebc7062006-04-30 21:58:41 +0000213Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can
bellard19cb3732006-08-19 11:45:59 +0000214use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}).
bellard1f673132004-04-04 15:21:17 +0000215
216@item -hda file
217@item -hdb file
218@item -hdc file
219@item -hdd file
bellarddebc7062006-04-30 21:58:41 +0000220Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
bellard1f673132004-04-04 15:21:17 +0000221
222@item -cdrom file
223Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and and
bellardbe3edd92004-06-03 12:48:45 +0000224@option{-cdrom} at the same time). You can use the host CD-ROM by
bellard19cb3732006-08-19 11:45:59 +0000225using @file{/dev/cdrom} as filename (@pxref{host_drives}).
bellard1f673132004-04-04 15:21:17 +0000226
thseec85c22007-01-05 17:41:07 +0000227@item -boot [a|c|d|n]
228Boot on floppy (a), hard disk (c), CD-ROM (d), or Etherboot (n). Hard disk boot
229is the default.
bellard1f673132004-04-04 15:21:17 +0000230
231@item -snapshot
232Write to temporary files instead of disk image files. In this case,
233the raw disk image you use is not written back. You can however force
ths42550fd2006-12-22 16:34:12 +0000234the write back by pressing @key{C-a s} (@pxref{disk_images}).
bellard1f673132004-04-04 15:21:17 +0000235
bellard52ca8d62006-06-14 16:03:05 +0000236@item -no-fd-bootchk
237Disable boot signature checking for floppy disks in Bochs BIOS. It may
238be needed to boot from old floppy disks.
239
bellard1f673132004-04-04 15:21:17 +0000240@item -m megs
bellard15a34c62004-07-08 21:26:26 +0000241Set virtual RAM size to @var{megs} megabytes. Default is 128 MB.
bellard1f673132004-04-04 15:21:17 +0000242
bellard3f9f3aa2005-12-18 20:11:37 +0000243@item -smp n
244Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
245CPUs are supported.
246
bellard1d14ffa2005-10-30 18:58:22 +0000247@item -audio-help
248
249Will show the audio subsystem help: list of drivers, tunable
250parameters.
251
bellard6a36d842005-12-18 20:34:32 +0000252@item -soundhw card1,card2,... or -soundhw all
bellard1d14ffa2005-10-30 18:58:22 +0000253
254Enable audio and selected sound hardware. Use ? to print all
255available sound hardware.
256
257@example
258qemu -soundhw sb16,adlib hda
259qemu -soundhw es1370 hda
bellard6a36d842005-12-18 20:34:32 +0000260qemu -soundhw all hda
bellard1d14ffa2005-10-30 18:58:22 +0000261qemu -soundhw ?
262@end example
bellarda8c490c2004-04-26 20:59:17 +0000263
bellard15a34c62004-07-08 21:26:26 +0000264@item -localtime
265Set the real time clock to local time (the default is to UTC
266time). This option is needed to have correct date in MS-DOS or
267Windows.
268
bellardf7cce892004-12-08 22:21:25 +0000269@item -pidfile file
270Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
271from a script.
272
ths71e3ceb2006-12-22 02:11:31 +0000273@item -daemonize
274Daemonize the QEMU process after initialization. QEMU will not detach from
275standard IO until it is ready to receive connections on any of its devices.
276This option is a useful way for external programs to launch QEMU without having
277to cope with initialization race conditions.
278
bellard9d0a8e62005-07-03 17:34:05 +0000279@item -win2k-hack
280Use it when installing Windows 2000 to avoid a disk full bug. After
281Windows 2000 is installed, you no longer need this option (this option
282slows down the IDE transfers).
283
ths9ae02552007-01-05 17:39:04 +0000284@item -option-rom file
285Load the contents of file as an option ROM. This option is useful to load
286things like EtherBoot.
287
thsc35734b2007-03-19 15:17:08 +0000288@item -name string
289Sets the name of the guest. This name will be display in the SDL window
290caption. The name will also be used for the VNC server.
291
bellard1f673132004-04-04 15:21:17 +0000292@end table
293
thsf858dca2007-08-25 01:40:37 +0000294Display options:
295@table @option
296
297@item -nographic
298
299Normally, QEMU uses SDL to display the VGA output. With this option,
300you can totally disable graphical output so that QEMU is a simple
301command line application. The emulated serial port is redirected on
302the console. Therefore, you can still use QEMU to debug a Linux kernel
303with a serial console.
304
305@item -no-frame
306
307Do not use decorations for SDL windows and start them using the whole
308available screen space. This makes the using QEMU in a dedicated desktop
309workspace more convenient.
310
311@item -full-screen
312Start in full screen.
313
314@item -vnc display[,option[,option[,...]]]
315
316Normally, QEMU uses SDL to display the VGA output. With this option,
317you can have QEMU listen on VNC display @var{display} and redirect the VGA
318display over the VNC session. It is very useful to enable the usb
319tablet device when using this option (option @option{-usbdevice
320tablet}). When using the VNC display, you must use the @option{-k}
321parameter to set the keyboard layout if you are not using en-us. Valid
322syntax for the @var{display} is
323
324@table @code
325
326@item @var{interface:d}
327
328TCP connections will only be allowed from @var{interface} on display @var{d}.
329By convention the TCP port is 5900+@var{d}. Optionally, @var{interface} can
330be omitted in which case the server will bind to all interfaces.
331
332@item @var{unix:path}
333
334Connections will be allowed over UNIX domain sockets where @var{path} is the
335location of a unix socket to listen for connections on.
336
337@item @var{none}
338
339VNC is initialized by not started. The monitor @code{change} command can be used
340to later start the VNC server.
341
342@end table
343
344Following the @var{display} value there may be one or more @var{option} flags
345separated by commas. Valid options are
346
347@table @code
348
349@item @var{password}
350
351Require that password based authentication is used for client connections.
352The password must be set separately using the @code{change} command in the
353@ref{pcsys_monitor}
354
355@item @var{tls}
356
357Require that client use TLS when communicating with the VNC server. This
358uses anonymous TLS credentials so is susceptible to a man-in-the-middle
359attack. It is recommended that this option be combined with either the
360@var{x509} or @var{x509verify} options.
361
362@item @var{x509=/path/to/certificate/dir}
363
364Valid if @var{tls} is specified. Require that x509 credentials are used
365for negotiating the TLS session. The server will send its x509 certificate
366to the client. It is recommended that a password be set on the VNC server
367to provide authentication of the client when this is used. The path following
368this option specifies where the x509 certificates are to be loaded from.
369See the @ref{vnc_security} section for details on generating certificates.
370
371@item @var{x509verify=/path/to/certificate/dir}
372
373Valid if @var{tls} is specified. Require that x509 credentials are used
374for negotiating the TLS session. The server will send its x509 certificate
375to the client, and request that the client send its own x509 certificate.
376The server will validate the client's certificate against the CA certificate,
377and reject clients when validation fails. If the certificate authority is
378trusted, this is a sufficient authentication mechanism. You may still wish
379to set a password on the VNC server as a second authentication layer. The
380path following this option specifies where the x509 certificates are to
381be loaded from. See the @ref{vnc_security} section for details on generating
382certificates.
383
384@end table
385
386@item -k language
387
388Use keyboard layout @var{language} (for example @code{fr} for
389French). This option is only needed where it is not easy to get raw PC
390keycodes (e.g. on Macs, with some X11 servers or with a VNC
391display). You don't normally need to use it on PC/Linux or PC/Windows
392hosts.
393
394The available layouts are:
395@example
396ar de-ch es fo fr-ca hu ja mk no pt-br sv
397da en-gb et fr fr-ch is lt nl pl ru th
398de en-us fi fr-be hr it lv nl-be pt sl tr
399@end example
400
401The default is @code{en-us}.
402
403@end table
404
bellardb389dbf2005-11-06 16:49:55 +0000405USB options:
406@table @option
407
408@item -usb
409Enable the USB driver (will be the default soon)
410
411@item -usbdevice devname
pbrook0aff66b2006-05-26 00:49:52 +0000412Add the USB device @var{devname}. @xref{usb_devices}.
bellardb389dbf2005-11-06 16:49:55 +0000413@end table
414
bellard1f673132004-04-04 15:21:17 +0000415Network options:
416
417@table @option
418
pbrooka41b2ff2006-02-05 04:14:41 +0000419@item -net nic[,vlan=n][,macaddr=addr][,model=type]
bellard41d03942005-11-15 23:02:53 +0000420Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
blueswir1c4a70602007-05-27 19:41:17 +0000421= 0 is the default). The NIC is an ne2k_pci by default on the PC
bellard41d03942005-11-15 23:02:53 +0000422target. Optionally, the MAC address can be changed. If no
423@option{-net} option is specified, a single NIC is created.
balrog549444e2007-05-01 17:53:37 +0000424Qemu can emulate several different models of network card.
425Valid values for @var{type} are
426@code{i82551}, @code{i82557b}, @code{i82559er},
427@code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
pbrook7e049b82007-06-04 00:31:01 +0000428@code{smc91c111}, @code{lance} and @code{mcf_fec}.
blueswir1c4a70602007-05-27 19:41:17 +0000429Not all devices are supported on all targets. Use -net nic,model=?
430for a list of available devices for your target.
bellard1f673132004-04-04 15:21:17 +0000431
pbrook115defd2006-04-16 11:06:58 +0000432@item -net user[,vlan=n][,hostname=name]
bellard7e894632005-11-19 17:42:52 +0000433Use the user mode network stack which requires no administrator
ths4be456f2007-06-03 13:41:28 +0000434privilege to run. @option{hostname=name} can be used to specify the client
pbrook115defd2006-04-16 11:06:58 +0000435hostname reported by the builtin DHCP server.
bellard3f1a88f2005-06-05 16:48:41 +0000436
bellard41d03942005-11-15 23:02:53 +0000437@item -net tap[,vlan=n][,fd=h][,ifname=name][,script=file]
438Connect the host TAP network interface @var{name} to VLAN @var{n} and
439use the network script @var{file} to configure it. The default
ths6a1cbf62007-02-02 00:37:56 +0000440network script is @file{/etc/qemu-ifup}. Use @option{script=no} to
441disable script execution. If @var{name} is not
bellard41d03942005-11-15 23:02:53 +0000442provided, the OS automatically provides one. @option{fd=h} can be
443used to specify the handle of an already opened host TAP interface. Example:
bellard3f1a88f2005-06-05 16:48:41 +0000444
bellard41d03942005-11-15 23:02:53 +0000445@example
446qemu linux.img -net nic -net tap
447@end example
bellard1f673132004-04-04 15:21:17 +0000448
bellard41d03942005-11-15 23:02:53 +0000449More complicated example (two NICs, each one connected to a TAP device)
450@example
451qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
452 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
453@end example
bellard1f673132004-04-04 15:21:17 +0000454
bellard52c00a52004-04-25 21:27:03 +0000455
bellard41d03942005-11-15 23:02:53 +0000456@item -net socket[,vlan=n][,fd=h][,listen=[host]:port][,connect=host:port]
457
458Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
459machine using a TCP socket connection. If @option{listen} is
460specified, QEMU waits for incoming connections on @var{port}
461(@var{host} is optional). @option{connect} is used to connect to
bellard3d830452005-12-18 16:36:49 +0000462another QEMU instance using the @option{listen} option. @option{fd=h}
463specifies an already opened TCP socket.
bellard41d03942005-11-15 23:02:53 +0000464
465Example:
466@example
467# launch a first QEMU instance
bellarddebc7062006-04-30 21:58:41 +0000468qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
469 -net socket,listen=:1234
470# connect the VLAN 0 of this instance to the VLAN 0
471# of the first instance
472qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
473 -net socket,connect=127.0.0.1:1234
bellard41d03942005-11-15 23:02:53 +0000474@end example
475
bellard3d830452005-12-18 16:36:49 +0000476@item -net socket[,vlan=n][,fd=h][,mcast=maddr:port]
477
478Create a VLAN @var{n} shared with another QEMU virtual
ths5fafdf22007-09-16 21:08:06 +0000479machines using a UDP multicast socket, effectively making a bus for
bellard3d830452005-12-18 16:36:49 +0000480every QEMU with same multicast address @var{maddr} and @var{port}.
481NOTES:
482@enumerate
ths5fafdf22007-09-16 21:08:06 +0000483@item
484Several QEMU can be running on different hosts and share same bus (assuming
bellard3d830452005-12-18 16:36:49 +0000485correct multicast setup for these hosts).
486@item
487mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
488@url{http://user-mode-linux.sf.net}.
ths4be456f2007-06-03 13:41:28 +0000489@item
490Use @option{fd=h} to specify an already opened UDP multicast socket.
bellard3d830452005-12-18 16:36:49 +0000491@end enumerate
492
493Example:
494@example
495# launch one QEMU instance
bellarddebc7062006-04-30 21:58:41 +0000496qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
497 -net socket,mcast=230.0.0.1:1234
bellard3d830452005-12-18 16:36:49 +0000498# launch another QEMU instance on same "bus"
bellarddebc7062006-04-30 21:58:41 +0000499qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
500 -net socket,mcast=230.0.0.1:1234
bellard3d830452005-12-18 16:36:49 +0000501# launch yet another QEMU instance on same "bus"
bellarddebc7062006-04-30 21:58:41 +0000502qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
503 -net socket,mcast=230.0.0.1:1234
bellard3d830452005-12-18 16:36:49 +0000504@end example
505
506Example (User Mode Linux compat.):
507@example
bellarddebc7062006-04-30 21:58:41 +0000508# launch QEMU instance (note mcast address selected
509# is UML's default)
510qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
511 -net socket,mcast=239.192.168.1:1102
bellard3d830452005-12-18 16:36:49 +0000512# launch UML
513/path/to/linux ubd0=/path/to/root_fs eth0=mcast
514@end example
515
bellard41d03942005-11-15 23:02:53 +0000516@item -net none
517Indicate that no network devices should be configured. It is used to
bellard039af322006-02-01 21:30:55 +0000518override the default configuration (@option{-net nic -net user}) which
519is activated if no @option{-net} options are provided.
bellard52c00a52004-04-25 21:27:03 +0000520
ths0db11372007-02-20 00:12:07 +0000521@item -tftp dir
bellard9bf05442004-08-25 22:12:49 +0000522When using the user mode network stack, activate a built-in TFTP
ths0db11372007-02-20 00:12:07 +0000523server. The files in @var{dir} will be exposed as the root of a TFTP server.
524The TFTP client on the guest must be configured in binary mode (use the command
525@code{bin} of the Unix TFTP client). The host IP address on the guest is as
526usual 10.0.2.2.
bellard9bf05442004-08-25 22:12:49 +0000527
ths47d5d012007-02-20 00:05:08 +0000528@item -bootp file
529When using the user mode network stack, broadcast @var{file} as the BOOTP
530filename. In conjunction with @option{-tftp}, this can be used to network boot
531a guest from a local directory.
532
533Example (using pxelinux):
534@example
535qemu -hda linux.img -boot n -tftp /path/to/tftp/files -bootp /pxelinux.0
536@end example
537
bellard2518bd02004-09-30 22:35:13 +0000538@item -smb dir
539When using the user mode network stack, activate a built-in SMB
540server so that Windows OSes can access to the host files in @file{dir}
541transparently.
542
543In the guest Windows OS, the line:
544@example
54510.0.2.4 smbserver
546@end example
547must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
548or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
549
550Then @file{dir} can be accessed in @file{\\smbserver\qemu}.
551
552Note that a SAMBA server must be installed on the host OS in
ths366dfc52006-12-11 18:35:08 +0000553@file{/usr/sbin/smbd}. QEMU was tested successfully with smbd version
bellard6cc721c2005-07-28 22:27:28 +00005542.2.7a from the Red Hat 9 and version 3.0.10-1.fc3 from Fedora Core 3.
bellard2518bd02004-09-30 22:35:13 +0000555
bellard9bf05442004-08-25 22:12:49 +0000556@item -redir [tcp|udp]:host-port:[guest-host]:guest-port
557
558When using the user mode network stack, redirect incoming TCP or UDP
559connections to the host port @var{host-port} to the guest
560@var{guest-host} on guest port @var{guest-port}. If @var{guest-host}
561is not specified, its value is 10.0.2.15 (default address given by the
562built-in DHCP server).
563
564For example, to redirect host X11 connection from screen 1 to guest
565screen 0, use the following:
566
567@example
568# on the host
569qemu -redir tcp:6001::6000 [...]
570# this host xterm should open in the guest X11 server
571xterm -display :1
572@end example
573
574To redirect telnet connections from host port 5555 to telnet port on
575the guest, use the following:
576
577@example
578# on the host
579qemu -redir tcp:5555::23 [...]
580telnet localhost 5555
581@end example
582
583Then when you use on the host @code{telnet localhost 5555}, you
584connect to the guest telnet server.
585
bellard1f673132004-04-04 15:21:17 +0000586@end table
587
bellard41d03942005-11-15 23:02:53 +0000588Linux boot specific: When using these options, you can use a given
bellard1f673132004-04-04 15:21:17 +0000589Linux kernel without installing it in the disk image. It can be useful
590for easier testing of various kernels.
591
592@table @option
593
ths5fafdf22007-09-16 21:08:06 +0000594@item -kernel bzImage
bellard1f673132004-04-04 15:21:17 +0000595Use @var{bzImage} as kernel image.
596
ths5fafdf22007-09-16 21:08:06 +0000597@item -append cmdline
bellard1f673132004-04-04 15:21:17 +0000598Use @var{cmdline} as kernel command line
599
600@item -initrd file
601Use @var{file} as initial ram disk.
602
603@end table
604
bellard15a34c62004-07-08 21:26:26 +0000605Debug/Expert options:
bellard1f673132004-04-04 15:21:17 +0000606@table @option
bellarda0a821a2004-07-14 17:38:57 +0000607
608@item -serial dev
bellard0bab00f2006-06-25 14:49:44 +0000609Redirect the virtual serial port to host character device
610@var{dev}. The default device is @code{vc} in graphical mode and
611@code{stdio} in non graphical mode.
612
613This option can be used several times to simulate up to 4 serials
614ports.
615
bellardc03b0f02006-09-03 14:10:53 +0000616Use @code{-serial none} to disable all serial ports.
617
bellard0bab00f2006-06-25 14:49:44 +0000618Available character devices are:
bellarda0a821a2004-07-14 17:38:57 +0000619@table @code
thsaf3a9032007-07-11 23:14:59 +0000620@item vc[:WxH]
621Virtual console. Optionally, a width and height can be given in pixel with
622@example
623vc:800x600
624@end example
625It is also possible to specify width or height in characters:
626@example
627vc:80Cx24C
628@end example
bellarda0a821a2004-07-14 17:38:57 +0000629@item pty
630[Linux only] Pseudo TTY (a new PTY is automatically allocated)
bellardc03b0f02006-09-03 14:10:53 +0000631@item none
632No device is allocated.
bellarda0a821a2004-07-14 17:38:57 +0000633@item null
634void device
bellardf8d179e2005-11-08 22:30:36 +0000635@item /dev/XXX
bellarde57a8c02005-11-10 23:58:52 +0000636[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
bellardf8d179e2005-11-08 22:30:36 +0000637parameters are set according to the emulated ones.
bellarde57a8c02005-11-10 23:58:52 +0000638@item /dev/parportN
639[Linux only, parallel port only] Use host parallel port
ths5867c882007-02-17 23:44:43 +0000640@var{N}. Currently SPP and EPP parallel port features can be used.
bellardf8d179e2005-11-08 22:30:36 +0000641@item file:filename
642Write output to filename. No character can be read.
bellarda0a821a2004-07-14 17:38:57 +0000643@item stdio
644[Unix only] standard input/output
bellardf8d179e2005-11-08 22:30:36 +0000645@item pipe:filename
bellard0bab00f2006-06-25 14:49:44 +0000646name pipe @var{filename}
647@item COMn
648[Windows only] Use host serial port @var{n}
bellard951f1352006-06-27 21:02:43 +0000649@item udp:[remote_host]:remote_port[@@[src_ip]:src_port]
ths4be456f2007-06-03 13:41:28 +0000650This 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.
bellarda0a821a2004-07-14 17:38:57 +0000651
bellard951f1352006-06-27 21:02:43 +0000652If you just want a simple readonly console you can use @code{netcat} or
653@code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
654@code{nc -u -l -p 4555}. Any time qemu writes something to that port it
655will appear in the netconsole session.
bellard0bab00f2006-06-25 14:49:44 +0000656
657If you plan to send characters back via netconsole or you want to stop
658and start qemu a lot of times, you should have qemu use the same
659source port each time by using something like @code{-serial
bellard951f1352006-06-27 21:02:43 +0000660udp::4555@@:4556} to qemu. Another approach is to use a patched
bellard0bab00f2006-06-25 14:49:44 +0000661version of netcat which can listen to a TCP port and send and receive
662characters via udp. If you have a patched version of netcat which
663activates telnet remote echo and single char transfer, then you can
664use the following options to step up a netcat redirector to allow
665telnet on port 5555 to access the qemu port.
666@table @code
bellard951f1352006-06-27 21:02:43 +0000667@item Qemu Options:
668-serial udp::4555@@:4556
669@item netcat options:
670-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
671@item telnet options:
672localhost 5555
bellard0bab00f2006-06-25 14:49:44 +0000673@end table
674
675
pbrookf7499982007-01-28 00:10:01 +0000676@item tcp:[host]:port[,server][,nowait][,nodelay]
bellard951f1352006-06-27 21:02:43 +0000677The TCP Net Console has two modes of operation. It can send the serial
678I/O to a location or wait for a connection from a location. By default
679the TCP Net Console is sent to @var{host} at the @var{port}. If you use
bellardf5420862006-08-21 20:26:44 +0000680the @var{server} option QEMU will wait for a client socket application
681to connect to the port before continuing, unless the @code{nowait}
pbrookf7499982007-01-28 00:10:01 +0000682option was specified. The @code{nodelay} option disables the Nagle buffering
ths4be456f2007-06-03 13:41:28 +0000683algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only
bellard951f1352006-06-27 21:02:43 +0000684one TCP connection at a time is accepted. You can use @code{telnet} to
685connect to the corresponding character device.
686@table @code
687@item Example to send tcp console to 192.168.0.2 port 4444
688-serial tcp:192.168.0.2:4444
689@item Example to listen and wait on port 4444 for connection
690-serial tcp::4444,server
691@item Example to not wait and listen on ip 192.168.0.100 port 4444
692-serial tcp:192.168.0.100:4444,server,nowait
693@end table
694
pbrookf7499982007-01-28 00:10:01 +0000695@item telnet:host:port[,server][,nowait][,nodelay]
bellard951f1352006-06-27 21:02:43 +0000696The telnet protocol is used instead of raw tcp sockets. The options
697work the same as if you had specified @code{-serial tcp}. The
698difference is that the port acts like a telnet server or client using
699telnet option negotiation. This will also allow you to send the
700MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
701sequence. Typically in unix telnet you do it with Control-] and then
702type "send break" followed by pressing the enter key.
703
thsffd843b2006-12-21 19:46:43 +0000704@item unix:path[,server][,nowait]
705A unix domain socket is used instead of a tcp socket. The option works the
706same as if you had specified @code{-serial tcp} except the unix domain socket
707@var{path} is used for connections.
708
ths20d8a3e2007-02-18 17:04:49 +0000709@item mon:dev_string
710This is a special option to allow the monitor to be multiplexed onto
711another serial port. The monitor is accessed with key sequence of
712@key{Control-a} and then pressing @key{c}. See monitor access
713@ref{pcsys_keys} in the -nographic section for more keys.
714@var{dev_string} should be any one of the serial devices specified
715above. An example to multiplex the monitor onto a telnet server
716listening on port 4444 would be:
717@table @code
718@item -serial mon:telnet::4444,server,nowait
719@end table
720
bellard0bab00f2006-06-25 14:49:44 +0000721@end table
bellard05d58182004-08-24 21:12:04 +0000722
bellarde57a8c02005-11-10 23:58:52 +0000723@item -parallel dev
724Redirect the virtual parallel port to host device @var{dev} (same
725devices as the serial port). On Linux hosts, @file{/dev/parportN} can
726be used to use hardware devices connected on the corresponding host
727parallel port.
728
729This option can be used several times to simulate up to 3 parallel
730ports.
731
bellardc03b0f02006-09-03 14:10:53 +0000732Use @code{-parallel none} to disable all parallel ports.
733
bellarda0a821a2004-07-14 17:38:57 +0000734@item -monitor dev
735Redirect the monitor to host device @var{dev} (same devices as the
736serial port).
737The default device is @code{vc} in graphical mode and @code{stdio} in
738non graphical mode.
739
ths20d8a3e2007-02-18 17:04:49 +0000740@item -echr numeric_ascii_value
741Change the escape character used for switching to the monitor when using
742monitor and serial sharing. The default is @code{0x01} when using the
743@code{-nographic} option. @code{0x01} is equal to pressing
744@code{Control-a}. You can select a different character from the ascii
745control keys where 1 through 26 map to Control-a through Control-z. For
746instance you could use the either of the following to change the escape
747character to Control-t.
748@table @code
749@item -echr 0x14
750@item -echr 20
751@end table
752
bellard1f673132004-04-04 15:21:17 +0000753@item -s
ths5fafdf22007-09-16 21:08:06 +0000754Wait gdb connection to port 1234 (@pxref{gdb_usage}).
bellard1f673132004-04-04 15:21:17 +0000755@item -p port
pbrook4046d912007-01-28 01:53:16 +0000756Change gdb connection port. @var{port} can be either a decimal number
757to specify a TCP port, or a host device (same devices as the serial port).
bellard52c00a52004-04-25 21:27:03 +0000758@item -S
759Do not start CPU at startup (you must type 'c' in the monitor).
ths3b46e622007-09-17 08:09:54 +0000760@item -d
bellard1f673132004-04-04 15:21:17 +0000761Output log in /tmp/qemu.log
bellard46d47672004-11-16 01:45:27 +0000762@item -hdachs c,h,s,[,t]
763Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
764@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
765translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
ths4be456f2007-06-03 13:41:28 +0000766all those parameters. This option is useful for old MS-DOS disk
bellard46d47672004-11-16 01:45:27 +0000767images.
bellard7c3fc842005-02-10 21:46:47 +0000768
bellard87b47352006-08-17 17:22:54 +0000769@item -L path
770Set the directory for the BIOS, VGA BIOS and keymaps.
771
bellard15a34c62004-07-08 21:26:26 +0000772@item -std-vga
773Simulate a standard VGA card with Bochs VBE extensions (default is
bellard3cb08532006-06-21 21:19:50 +0000774Cirrus Logic GD5446 PCI VGA). If your guest OS supports the VESA 2.0
775VBE extensions (e.g. Windows XP) and if you want to use high
776resolution modes (>= 1280x1024x16) then you should use this option.
777
bellard3c656342006-07-14 13:13:51 +0000778@item -no-acpi
779Disable ACPI (Advanced Configuration and Power Interface) support. Use
780it if your guest OS complains about ACPI problems (PC target machine
781only).
782
bellardd1beab82006-10-02 19:44:22 +0000783@item -no-reboot
784Exit instead of rebooting.
785
bellardd63d3072004-10-03 13:29:03 +0000786@item -loadvm file
787Start right away with a saved state (@code{loadvm} in monitor)
pbrook8e716212007-01-20 17:12:09 +0000788
789@item -semihosting
pbrooka87295e2007-05-26 15:09:38 +0000790Enable semihosting syscall emulation (ARM and M68K target machines only).
791
792On ARM this implements the "Angel" interface.
793On M68K this implements the "ColdFire GDB" interface used by libgloss.
794
pbrook8e716212007-01-20 17:12:09 +0000795Note that this allows guest direct access to the host filesystem,
796so should only be used with trusted guest OS.
bellard1f673132004-04-04 15:21:17 +0000797@end table
798
bellard3e11db92004-07-14 17:47:14 +0000799@c man end
800
bellarddebc7062006-04-30 21:58:41 +0000801@node pcsys_keys
bellard3e11db92004-07-14 17:47:14 +0000802@section Keys
803
804@c man begin OPTIONS
805
bellarda1b74fe2004-05-08 13:26:35 +0000806During the graphical emulation, you can use the following keys:
807@table @key
bellardf9859312004-10-03 14:33:10 +0000808@item Ctrl-Alt-f
bellarda1b74fe2004-05-08 13:26:35 +0000809Toggle full screen
bellarda0a821a2004-07-14 17:38:57 +0000810
bellardf9859312004-10-03 14:33:10 +0000811@item Ctrl-Alt-n
bellarda0a821a2004-07-14 17:38:57 +0000812Switch to virtual console 'n'. Standard console mappings are:
813@table @emph
814@item 1
815Target system display
816@item 2
817Monitor
818@item 3
819Serial port
bellarda1b74fe2004-05-08 13:26:35 +0000820@end table
821
bellardf9859312004-10-03 14:33:10 +0000822@item Ctrl-Alt
bellarda0a821a2004-07-14 17:38:57 +0000823Toggle mouse and keyboard grab.
824@end table
825
bellard3e11db92004-07-14 17:47:14 +0000826In the virtual consoles, you can use @key{Ctrl-Up}, @key{Ctrl-Down},
827@key{Ctrl-PageUp} and @key{Ctrl-PageDown} to move in the back log.
828
bellarda0a821a2004-07-14 17:38:57 +0000829During emulation, if you are using the @option{-nographic} option, use
830@key{Ctrl-a h} to get terminal commands:
bellard1f673132004-04-04 15:21:17 +0000831
832@table @key
bellarda1b74fe2004-05-08 13:26:35 +0000833@item Ctrl-a h
bellard1f673132004-04-04 15:21:17 +0000834Print this help
ths3b46e622007-09-17 08:09:54 +0000835@item Ctrl-a x
ths366dfc52006-12-11 18:35:08 +0000836Exit emulator
ths3b46e622007-09-17 08:09:54 +0000837@item Ctrl-a s
bellard1f673132004-04-04 15:21:17 +0000838Save disk data back to file (if -snapshot)
ths20d8a3e2007-02-18 17:04:49 +0000839@item Ctrl-a t
840toggle console timestamps
bellarda1b74fe2004-05-08 13:26:35 +0000841@item Ctrl-a b
bellard1f673132004-04-04 15:21:17 +0000842Send break (magic sysrq in Linux)
bellarda1b74fe2004-05-08 13:26:35 +0000843@item Ctrl-a c
bellard1f673132004-04-04 15:21:17 +0000844Switch between console and monitor
bellarda1b74fe2004-05-08 13:26:35 +0000845@item Ctrl-a Ctrl-a
846Send Ctrl-a
bellard1f673132004-04-04 15:21:17 +0000847@end table
848@c man end
849
850@ignore
851
bellard1f673132004-04-04 15:21:17 +0000852@c man begin SEEALSO
853The HTML documentation of QEMU for more precise information and Linux
854user mode emulator invocation.
855@c man end
856
857@c man begin AUTHOR
858Fabrice Bellard
859@c man end
860
861@end ignore
862
bellarddebc7062006-04-30 21:58:41 +0000863@node pcsys_monitor
bellard1f673132004-04-04 15:21:17 +0000864@section QEMU Monitor
865
866The QEMU monitor is used to give complex commands to the QEMU
867emulator. You can use it to:
868
869@itemize @minus
870
871@item
thse5987522007-03-30 18:58:01 +0000872Remove or insert removable media images
bellard1f673132004-04-04 15:21:17 +0000873(such as CD-ROM or floppies)
874
ths5fafdf22007-09-16 21:08:06 +0000875@item
bellard1f673132004-04-04 15:21:17 +0000876Freeze/unfreeze the Virtual Machine (VM) and save or restore its state
877from a disk file.
878
879@item Inspect the VM state without an external debugger.
880
881@end itemize
882
883@subsection Commands
884
885The following commands are available:
886
887@table @option
888
889@item help or ? [cmd]
890Show the help for all commands or just for command @var{cmd}.
891
ths3b46e622007-09-17 08:09:54 +0000892@item commit
bellard1f673132004-04-04 15:21:17 +0000893Commit changes to the disk images (if -snapshot is used)
894
ths5fafdf22007-09-16 21:08:06 +0000895@item info subcommand
bellard1f673132004-04-04 15:21:17 +0000896show various information about the system state
897
898@table @option
899@item info network
bellard41d03942005-11-15 23:02:53 +0000900show the various VLANs and the associated devices
bellard1f673132004-04-04 15:21:17 +0000901@item info block
902show the block devices
903@item info registers
904show the cpu registers
905@item info history
906show the command line history
bellardb389dbf2005-11-06 16:49:55 +0000907@item info pci
908show emulated PCI device
909@item info usb
910show USB devices plugged on the virtual USB hub
911@item info usbhost
912show all USB host devices
bellarda3c25992006-07-18 21:09:59 +0000913@item info capture
914show information about active capturing
bellard13a2e802006-08-06 14:50:31 +0000915@item info snapshots
916show list of VM snapshots
ths455204e2007-01-05 16:42:13 +0000917@item info mice
918show which guest mouse is receiving events
bellard1f673132004-04-04 15:21:17 +0000919@end table
920
921@item q or quit
922Quit the emulator.
923
924@item eject [-f] device
thse5987522007-03-30 18:58:01 +0000925Eject a removable medium (use -f to force it).
bellard1f673132004-04-04 15:21:17 +0000926
thsf858dca2007-08-25 01:40:37 +0000927@item change device setting
928
929Change the configuration of a device
930
931@table @option
932@item change @var{diskdevice} @var{filename}
933Change the medium for a removable disk device to point to @var{filename}. eg
934
935@example
936(qemu) change cdrom /path/to/some.iso
937@end example
938
939@item change vnc @var{display,options}
940Change the configuration of the VNC server. The valid syntax for @var{display}
941and @var{options} are described at @ref{sec_invocation}. eg
942
943@example
944(qemu) change vnc localhost:1
945@end example
946
947@item change vnc password
948
949Change the password associated with the VNC server. The monitor will prompt for
950the new password to be entered. VNC passwords are only significant upto 8 letters.
951eg.
952
953@example
954(qemu) change vnc password
955Password: ********
956@end example
957
958@end table
bellard1f673132004-04-04 15:21:17 +0000959
960@item screendump filename
961Save screen into PPM image @var{filename}.
962
ths455204e2007-01-05 16:42:13 +0000963@item mouse_move dx dy [dz]
964Move the active mouse to the specified coordinates @var{dx} @var{dy}
965with optional scroll axis @var{dz}.
966
967@item mouse_button val
968Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
969
970@item mouse_set index
971Set which mouse device receives events at given @var{index}, index
972can be obtained with
973@example
974info mice
975@end example
976
bellarda3c25992006-07-18 21:09:59 +0000977@item wavcapture filename [frequency [bits [channels]]]
978Capture audio into @var{filename}. Using sample rate @var{frequency}
979bits per sample @var{bits} and number of channels @var{channels}.
980
981Defaults:
982@itemize @minus
983@item Sample rate = 44100 Hz - CD quality
984@item Bits = 16
985@item Number of channels = 2 - Stereo
986@end itemize
987
988@item stopcapture index
989Stop capture with a given @var{index}, index can be obtained with
990@example
991info capture
992@end example
993
bellard1f673132004-04-04 15:21:17 +0000994@item log item1[,...]
995Activate logging of the specified items to @file{/tmp/qemu.log}.
996
bellard13a2e802006-08-06 14:50:31 +0000997@item savevm [tag|id]
998Create a snapshot of the whole virtual machine. If @var{tag} is
999provided, it is used as human readable identifier. If there is already
1000a snapshot with the same tag or ID, it is replaced. More info at
1001@ref{vm_snapshots}.
bellard1f673132004-04-04 15:21:17 +00001002
bellard13a2e802006-08-06 14:50:31 +00001003@item loadvm tag|id
1004Set the whole virtual machine to the snapshot identified by the tag
1005@var{tag} or the unique snapshot ID @var{id}.
1006
1007@item delvm tag|id
1008Delete the snapshot identified by @var{tag} or @var{id}.
bellard1f673132004-04-04 15:21:17 +00001009
1010@item stop
1011Stop emulation.
1012
1013@item c or cont
1014Resume emulation.
1015
1016@item gdbserver [port]
1017Start gdbserver session (default port=1234)
1018
1019@item x/fmt addr
1020Virtual memory dump starting at @var{addr}.
1021
1022@item xp /fmt addr
1023Physical memory dump starting at @var{addr}.
1024
1025@var{fmt} is a format which tells the command how to format the
1026data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
1027
1028@table @var
ths5fafdf22007-09-16 21:08:06 +00001029@item count
bellard1f673132004-04-04 15:21:17 +00001030is the number of items to be dumped.
1031
1032@item format
ths4be456f2007-06-03 13:41:28 +00001033can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
bellard1f673132004-04-04 15:21:17 +00001034c (char) or i (asm instruction).
1035
1036@item size
bellard52c00a52004-04-25 21:27:03 +00001037can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
1038@code{h} or @code{w} can be specified with the @code{i} format to
1039respectively select 16 or 32 bit code instruction size.
bellard1f673132004-04-04 15:21:17 +00001040
1041@end table
1042
ths5fafdf22007-09-16 21:08:06 +00001043Examples:
bellard1f673132004-04-04 15:21:17 +00001044@itemize
1045@item
1046Dump 10 instructions at the current instruction pointer:
ths5fafdf22007-09-16 21:08:06 +00001047@example
bellard1f673132004-04-04 15:21:17 +00001048(qemu) x/10i $eip
10490x90107063: ret
10500x90107064: sti
10510x90107065: lea 0x0(%esi,1),%esi
10520x90107069: lea 0x0(%edi,1),%edi
10530x90107070: ret
10540x90107071: jmp 0x90107080
10550x90107073: nop
10560x90107074: nop
10570x90107075: nop
10580x90107076: nop
1059@end example
1060
1061@item
1062Dump 80 16 bit values at the start of the video memory.
ths5fafdf22007-09-16 21:08:06 +00001063@smallexample
bellard1f673132004-04-04 15:21:17 +00001064(qemu) xp/80hx 0xb8000
10650x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
10660x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
10670x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
10680x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
10690x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
10700x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
10710x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
10720x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
10730x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
10740x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
bellarddebc7062006-04-30 21:58:41 +00001075@end smallexample
bellard1f673132004-04-04 15:21:17 +00001076@end itemize
1077
1078@item p or print/fmt expr
1079
1080Print expression value. Only the @var{format} part of @var{fmt} is
1081used.
1082
bellarda3a91a32004-06-04 11:06:21 +00001083@item sendkey keys
1084
1085Send @var{keys} to the emulator. Use @code{-} to press several keys
1086simultaneously. Example:
1087@example
1088sendkey ctrl-alt-f1
1089@end example
1090
1091This command is useful to send keys that your graphical user interface
1092intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
1093
bellard15a34c62004-07-08 21:26:26 +00001094@item system_reset
1095
1096Reset the system.
1097
bellardb389dbf2005-11-06 16:49:55 +00001098@item usb_add devname
1099
pbrook0aff66b2006-05-26 00:49:52 +00001100Add the USB device @var{devname}. For details of available devices see
1101@ref{usb_devices}
bellardb389dbf2005-11-06 16:49:55 +00001102
1103@item usb_del devname
1104
1105Remove the USB device @var{devname} from the QEMU virtual USB
1106hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
1107command @code{info usb} to see the devices you can remove.
1108
bellard1f673132004-04-04 15:21:17 +00001109@end table
1110
1111@subsection Integer expressions
1112
1113The monitor understands integers expressions for every integer
1114argument. You can use register names to get the value of specifics
1115CPU registers by prefixing them with @emph{$}.
1116
1117@node disk_images
1118@section Disk Images
1119
bellardacd935e2004-11-15 22:57:26 +00001120Since version 0.6.1, QEMU supports many disk image formats, including
1121growable disk images (their size increase as non empty sectors are
bellard13a2e802006-08-06 14:50:31 +00001122written), compressed and encrypted disk images. Version 0.8.3 added
1123the new qcow2 disk image format which is essential to support VM
1124snapshots.
bellard1f673132004-04-04 15:21:17 +00001125
bellarddebc7062006-04-30 21:58:41 +00001126@menu
1127* disk_images_quickstart:: Quick start for disk image creation
1128* disk_images_snapshot_mode:: Snapshot mode
bellard13a2e802006-08-06 14:50:31 +00001129* vm_snapshots:: VM snapshots
bellarddebc7062006-04-30 21:58:41 +00001130* qemu_img_invocation:: qemu-img Invocation
bellard19cb3732006-08-19 11:45:59 +00001131* host_drives:: Using host drives
bellarddebc7062006-04-30 21:58:41 +00001132* disk_images_fat_images:: Virtual FAT disk images
1133@end menu
1134
1135@node disk_images_quickstart
bellardacd935e2004-11-15 22:57:26 +00001136@subsection Quick start for disk image creation
1137
1138You can create a disk image with the command:
bellard1f673132004-04-04 15:21:17 +00001139@example
bellardacd935e2004-11-15 22:57:26 +00001140qemu-img create myimage.img mysize
bellard1f673132004-04-04 15:21:17 +00001141@end example
bellardacd935e2004-11-15 22:57:26 +00001142where @var{myimage.img} is the disk image filename and @var{mysize} is its
1143size in kilobytes. You can add an @code{M} suffix to give the size in
1144megabytes and a @code{G} suffix for gigabytes.
1145
bellarddebc7062006-04-30 21:58:41 +00001146See @ref{qemu_img_invocation} for more information.
bellard1f673132004-04-04 15:21:17 +00001147
bellarddebc7062006-04-30 21:58:41 +00001148@node disk_images_snapshot_mode
bellard1f673132004-04-04 15:21:17 +00001149@subsection Snapshot mode
1150
1151If you use the option @option{-snapshot}, all disk images are
1152considered as read only. When sectors in written, they are written in
1153a temporary file created in @file{/tmp}. You can however force the
bellardacd935e2004-11-15 22:57:26 +00001154write back to the raw disk images by using the @code{commit} monitor
1155command (or @key{C-a s} in the serial console).
bellard1f673132004-04-04 15:21:17 +00001156
bellard13a2e802006-08-06 14:50:31 +00001157@node vm_snapshots
1158@subsection VM snapshots
1159
1160VM snapshots are snapshots of the complete virtual machine including
1161CPU state, RAM, device state and the content of all the writable
1162disks. In order to use VM snapshots, you must have at least one non
1163removable and writable block device using the @code{qcow2} disk image
1164format. Normally this device is the first virtual hard drive.
1165
1166Use the monitor command @code{savevm} to create a new VM snapshot or
1167replace an existing one. A human readable name can be assigned to each
bellard19d36792006-08-07 21:34:34 +00001168snapshot in addition to its numerical ID.
bellard13a2e802006-08-06 14:50:31 +00001169
1170Use @code{loadvm} to restore a VM snapshot and @code{delvm} to remove
1171a VM snapshot. @code{info snapshots} lists the available snapshots
1172with their associated information:
1173
1174@example
1175(qemu) info snapshots
1176Snapshot devices: hda
1177Snapshot list (from hda):
1178ID TAG VM SIZE DATE VM CLOCK
11791 start 41M 2006-08-06 12:38:02 00:00:14.954
11802 40M 2006-08-06 12:43:29 00:00:18.633
11813 msys 40M 2006-08-06 12:44:04 00:00:23.514
1182@end example
1183
1184A VM snapshot is made of a VM state info (its size is shown in
1185@code{info snapshots}) and a snapshot of every writable disk image.
1186The VM state info is stored in the first @code{qcow2} non removable
1187and writable block device. The disk image snapshots are stored in
1188every disk image. The size of a snapshot in a disk image is difficult
1189to evaluate and is not shown by @code{info snapshots} because the
1190associated disk sectors are shared among all the snapshots to save
bellard19d36792006-08-07 21:34:34 +00001191disk space (otherwise each snapshot would need a full copy of all the
1192disk images).
bellard13a2e802006-08-06 14:50:31 +00001193
1194When using the (unrelated) @code{-snapshot} option
1195(@ref{disk_images_snapshot_mode}), you can always make VM snapshots,
1196but they are deleted as soon as you exit QEMU.
1197
1198VM snapshots currently have the following known limitations:
1199@itemize
ths5fafdf22007-09-16 21:08:06 +00001200@item
bellard13a2e802006-08-06 14:50:31 +00001201They cannot cope with removable devices if they are removed or
1202inserted after a snapshot is done.
ths5fafdf22007-09-16 21:08:06 +00001203@item
bellard13a2e802006-08-06 14:50:31 +00001204A few device drivers still have incomplete snapshot support so their
1205state is not saved or restored properly (in particular USB).
1206@end itemize
1207
bellardacd935e2004-11-15 22:57:26 +00001208@node qemu_img_invocation
1209@subsection @code{qemu-img} Invocation
bellard1f673132004-04-04 15:21:17 +00001210
bellardacd935e2004-11-15 22:57:26 +00001211@include qemu-img.texi
bellard05efe462004-06-16 20:34:33 +00001212
bellard19cb3732006-08-19 11:45:59 +00001213@node host_drives
1214@subsection Using host drives
1215
1216In addition to disk image files, QEMU can directly access host
1217devices. We describe here the usage for QEMU version >= 0.8.3.
1218
1219@subsubsection Linux
1220
1221On Linux, you can directly use the host device filename instead of a
ths4be456f2007-06-03 13:41:28 +00001222disk image filename provided you have enough privileges to access
bellard19cb3732006-08-19 11:45:59 +00001223it. For example, use @file{/dev/cdrom} to access to the CDROM or
1224@file{/dev/fd0} for the floppy.
1225
bellardf5420862006-08-21 20:26:44 +00001226@table @code
bellard19cb3732006-08-19 11:45:59 +00001227@item CD
1228You can specify a CDROM device even if no CDROM is loaded. QEMU has
1229specific code to detect CDROM insertion or removal. CDROM ejection by
1230the guest OS is supported. Currently only data CDs are supported.
1231@item Floppy
1232You can specify a floppy device even if no floppy is loaded. Floppy
1233removal is currently not detected accurately (if you change floppy
1234without doing floppy access while the floppy is not loaded, the guest
1235OS will think that the same floppy is loaded).
1236@item Hard disks
1237Hard disks can be used. Normally you must specify the whole disk
1238(@file{/dev/hdb} instead of @file{/dev/hdb1}) so that the guest OS can
1239see it as a partitioned disk. WARNING: unless you know what you do, it
1240is better to only make READ-ONLY accesses to the hard disk otherwise
1241you may corrupt your host data (use the @option{-snapshot} command
1242line option or modify the device permissions accordingly).
1243@end table
1244
1245@subsubsection Windows
1246
bellard01781962007-01-07 22:43:30 +00001247@table @code
1248@item CD
ths4be456f2007-06-03 13:41:28 +00001249The preferred syntax is the drive letter (e.g. @file{d:}). The
bellard01781962007-01-07 22:43:30 +00001250alternate syntax @file{\\.\d:} is supported. @file{/dev/cdrom} is
1251supported as an alias to the first CDROM drive.
bellard19cb3732006-08-19 11:45:59 +00001252
thse5987522007-03-30 18:58:01 +00001253Currently there is no specific code to handle removable media, so it
bellard19cb3732006-08-19 11:45:59 +00001254is better to use the @code{change} or @code{eject} monitor commands to
1255change or eject media.
bellard01781962007-01-07 22:43:30 +00001256@item Hard disks
1257Hard disks can be used with the syntax: @file{\\.\PhysicalDriveN}
1258where @var{N} is the drive number (0 is the first hard disk).
1259
1260WARNING: unless you know what you do, it is better to only make
1261READ-ONLY accesses to the hard disk otherwise you may corrupt your
1262host data (use the @option{-snapshot} command line so that the
1263modifications are written in a temporary file).
1264@end table
1265
bellard19cb3732006-08-19 11:45:59 +00001266
1267@subsubsection Mac OS X
1268
ths5fafdf22007-09-16 21:08:06 +00001269@file{/dev/cdrom} is an alias to the first CDROM.
bellard19cb3732006-08-19 11:45:59 +00001270
thse5987522007-03-30 18:58:01 +00001271Currently there is no specific code to handle removable media, so it
bellard19cb3732006-08-19 11:45:59 +00001272is better to use the @code{change} or @code{eject} monitor commands to
1273change or eject media.
1274
bellarddebc7062006-04-30 21:58:41 +00001275@node disk_images_fat_images
bellard2c6cadd2005-12-18 18:31:45 +00001276@subsection Virtual FAT disk images
1277
1278QEMU can automatically create a virtual FAT disk image from a
1279directory tree. In order to use it, just type:
1280
ths5fafdf22007-09-16 21:08:06 +00001281@example
bellard2c6cadd2005-12-18 18:31:45 +00001282qemu linux.img -hdb fat:/my_directory
1283@end example
1284
1285Then you access access to all the files in the @file{/my_directory}
1286directory without having to copy them in a disk image or to export
1287them via SAMBA or NFS. The default access is @emph{read-only}.
1288
1289Floppies can be emulated with the @code{:floppy:} option:
1290
ths5fafdf22007-09-16 21:08:06 +00001291@example
bellard2c6cadd2005-12-18 18:31:45 +00001292qemu linux.img -fda fat:floppy:/my_directory
1293@end example
1294
1295A read/write support is available for testing (beta stage) with the
1296@code{:rw:} option:
1297
ths5fafdf22007-09-16 21:08:06 +00001298@example
bellard2c6cadd2005-12-18 18:31:45 +00001299qemu linux.img -fda fat:floppy:rw:/my_directory
1300@end example
1301
1302What you should @emph{never} do:
1303@itemize
1304@item use non-ASCII filenames ;
1305@item use "-snapshot" together with ":rw:" ;
bellard85b2c682005-12-19 22:12:34 +00001306@item expect it to work when loadvm'ing ;
1307@item write to the FAT directory on the host system while accessing it with the guest system.
bellard2c6cadd2005-12-18 18:31:45 +00001308@end itemize
1309
bellarddebc7062006-04-30 21:58:41 +00001310@node pcsys_network
bellard9d4fb822004-04-26 20:55:38 +00001311@section Network emulation
1312
ths4be456f2007-06-03 13:41:28 +00001313QEMU can simulate several network cards (PCI or ISA cards on the PC
bellard41d03942005-11-15 23:02:53 +00001314target) and can connect them to an arbitrary number of Virtual Local
1315Area Networks (VLANs). Host TAP devices can be connected to any QEMU
1316VLAN. VLAN can be connected between separate instances of QEMU to
ths4be456f2007-06-03 13:41:28 +00001317simulate large networks. For simpler usage, a non privileged user mode
bellard41d03942005-11-15 23:02:53 +00001318network stack can replace the TAP device to have a basic network
1319connection.
bellard9d4fb822004-04-26 20:55:38 +00001320
bellard41d03942005-11-15 23:02:53 +00001321@subsection VLANs
bellard9d4fb822004-04-26 20:55:38 +00001322
bellard41d03942005-11-15 23:02:53 +00001323QEMU simulates several VLANs. A VLAN can be symbolised as a virtual
1324connection between several network devices. These devices can be for
1325example QEMU virtual Ethernet cards or virtual Host ethernet devices
1326(TAP devices).
1327
1328@subsection Using TAP network interfaces
1329
1330This is the standard way to connect QEMU to a real network. QEMU adds
1331a virtual network device on your host (called @code{tapN}), and you
1332can then configure it as if it was a real ethernet card.
bellard9d4fb822004-04-26 20:55:38 +00001333
bellard8f40c382006-09-20 20:28:05 +00001334@subsubsection Linux host
1335
bellard9d4fb822004-04-26 20:55:38 +00001336As an example, you can download the @file{linux-test-xxx.tar.gz}
1337archive and copy the script @file{qemu-ifup} in @file{/etc} and
1338configure properly @code{sudo} so that the command @code{ifconfig}
1339contained in @file{qemu-ifup} can be executed as root. You must verify
bellard41d03942005-11-15 23:02:53 +00001340that your host kernel supports the TAP network interfaces: the
bellard9d4fb822004-04-26 20:55:38 +00001341device @file{/dev/net/tun} must be present.
1342
bellardee0f4752006-08-19 16:56:18 +00001343See @ref{sec_invocation} to have examples of command lines using the
1344TAP network interfaces.
bellard9d4fb822004-04-26 20:55:38 +00001345
bellard8f40c382006-09-20 20:28:05 +00001346@subsubsection Windows host
1347
1348There is a virtual ethernet driver for Windows 2000/XP systems, called
1349TAP-Win32. But it is not included in standard QEMU for Windows,
1350so you will need to get it separately. It is part of OpenVPN package,
1351so download OpenVPN from : @url{http://openvpn.net/}.
1352
bellard9d4fb822004-04-26 20:55:38 +00001353@subsection Using the user mode network stack
1354
bellard41d03942005-11-15 23:02:53 +00001355By using the option @option{-net user} (default configuration if no
1356@option{-net} option is specified), QEMU uses a completely user mode
ths4be456f2007-06-03 13:41:28 +00001357network stack (you don't need root privilege to use the virtual
bellard41d03942005-11-15 23:02:53 +00001358network). The virtual network configuration is the following:
bellard9d4fb822004-04-26 20:55:38 +00001359
1360@example
1361
bellard41d03942005-11-15 23:02:53 +00001362 QEMU VLAN <------> Firewall/DHCP server <-----> Internet
1363 | (10.0.2.2)
bellard9d4fb822004-04-26 20:55:38 +00001364 |
bellard2518bd02004-09-30 22:35:13 +00001365 ----> DNS server (10.0.2.3)
ths3b46e622007-09-17 08:09:54 +00001366 |
bellard2518bd02004-09-30 22:35:13 +00001367 ----> SMB server (10.0.2.4)
bellard9d4fb822004-04-26 20:55:38 +00001368@end example
1369
1370The QEMU VM behaves as if it was behind a firewall which blocks all
1371incoming connections. You can use a DHCP client to automatically
bellard41d03942005-11-15 23:02:53 +00001372configure the network in the QEMU VM. The DHCP server assign addresses
1373to the hosts starting from 10.0.2.15.
bellard9d4fb822004-04-26 20:55:38 +00001374
1375In order to check that the user mode network is working, you can ping
1376the address 10.0.2.2 and verify that you got an address in the range
137710.0.2.x from the QEMU virtual DHCP server.
1378
bellardb415a402004-05-23 21:04:06 +00001379Note that @code{ping} is not supported reliably to the internet as it
ths4be456f2007-06-03 13:41:28 +00001380would require root privileges. It means you can only ping the local
bellardb415a402004-05-23 21:04:06 +00001381router (10.0.2.2).
1382
bellard9bf05442004-08-25 22:12:49 +00001383When using the built-in TFTP server, the router is also the TFTP
1384server.
1385
1386When using the @option{-redir} option, TCP or UDP connections can be
1387redirected from the host to the guest. It allows for example to
1388redirect X11, telnet or SSH connections.
bellard443f1372004-06-04 11:13:20 +00001389
bellard41d03942005-11-15 23:02:53 +00001390@subsection Connecting VLANs between QEMU instances
1391
1392Using the @option{-net socket} option, it is possible to make VLANs
1393that span several QEMU instances. See @ref{sec_invocation} to have a
1394basic example.
1395
bellard9d4fb822004-04-26 20:55:38 +00001396@node direct_linux_boot
1397@section Direct Linux Boot
bellard0806e3f2003-10-01 00:15:32 +00001398
1399This section explains how to launch a Linux kernel inside QEMU without
1400having to make a full bootable image. It is very useful for fast Linux
bellardee0f4752006-08-19 16:56:18 +00001401kernel testing.
bellard1eb20522003-06-25 16:21:49 +00001402
bellardee0f4752006-08-19 16:56:18 +00001403The syntax is:
bellard1eb20522003-06-25 16:21:49 +00001404@example
bellardee0f4752006-08-19 16:56:18 +00001405qemu -kernel arch/i386/boot/bzImage -hda root-2.4.20.img -append "root=/dev/hda"
bellard1eb20522003-06-25 16:21:49 +00001406@end example
1407
bellardee0f4752006-08-19 16:56:18 +00001408Use @option{-kernel} to provide the Linux kernel image and
1409@option{-append} to give the kernel command line arguments. The
1410@option{-initrd} option can be used to provide an INITRD image.
1411
1412When using the direct Linux boot, a disk image for the first hard disk
1413@file{hda} is required because its boot sector is used to launch the
1414Linux kernel.
1415
1416If you do not need graphical output, you can disable it and redirect
1417the virtual serial port and the QEMU monitor to the console with the
1418@option{-nographic} option. The typical command line is:
bellard1eb20522003-06-25 16:21:49 +00001419@example
bellardee0f4752006-08-19 16:56:18 +00001420qemu -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1421 -append "root=/dev/hda console=ttyS0" -nographic
bellard1eb20522003-06-25 16:21:49 +00001422@end example
1423
bellardee0f4752006-08-19 16:56:18 +00001424Use @key{Ctrl-a c} to switch between the serial console and the
1425monitor (@pxref{pcsys_keys}).
bellardd5a0b502003-06-27 12:02:03 +00001426
bellarddebc7062006-04-30 21:58:41 +00001427@node pcsys_usb
bellardb389dbf2005-11-06 16:49:55 +00001428@section USB emulation
1429
pbrook0aff66b2006-05-26 00:49:52 +00001430QEMU emulates a PCI UHCI USB controller. You can virtually plug
1431virtual USB devices or real host USB devices (experimental, works only
1432on Linux hosts). Qemu will automatically create and connect virtual USB hubs
bellardf5420862006-08-21 20:26:44 +00001433as necessary to connect multiple USB devices.
bellardb389dbf2005-11-06 16:49:55 +00001434
pbrook0aff66b2006-05-26 00:49:52 +00001435@menu
1436* usb_devices::
1437* host_usb_devices::
1438@end menu
1439@node usb_devices
1440@subsection Connecting USB devices
bellardb389dbf2005-11-06 16:49:55 +00001441
pbrook0aff66b2006-05-26 00:49:52 +00001442USB devices can be connected with the @option{-usbdevice} commandline option
1443or the @code{usb_add} monitor command. Available devices are:
bellardb389dbf2005-11-06 16:49:55 +00001444
pbrook0aff66b2006-05-26 00:49:52 +00001445@table @var
1446@item @code{mouse}
1447Virtual Mouse. This will override the PS/2 mouse emulation when activated.
1448@item @code{tablet}
bellardc6d46c22006-09-03 17:10:41 +00001449Pointer device that uses absolute coordinates (like a touchscreen).
pbrook0aff66b2006-05-26 00:49:52 +00001450This means qemu is able to report the mouse position without having
1451to grab the mouse. Also overrides the PS/2 mouse emulation when activated.
1452@item @code{disk:file}
1453Mass storage device based on @var{file} (@pxref{disk_images})
1454@item @code{host:bus.addr}
1455Pass through the host device identified by @var{bus.addr}
1456(Linux only)
1457@item @code{host:vendor_id:product_id}
1458Pass through the host device identified by @var{vendor_id:product_id}
1459(Linux only)
balrogf6d2a312007-06-10 19:21:04 +00001460@item @code{wacom-tablet}
1461Virtual Wacom PenPartner tablet. This device is similar to the @code{tablet}
1462above but it can be used with the tslib library because in addition to touch
1463coordinates it reports touch pressure.
balrog47b2d332007-06-22 08:16:00 +00001464@item @code{keyboard}
1465Standard USB keyboard. Will override the PS/2 keyboard (if present).
pbrook0aff66b2006-05-26 00:49:52 +00001466@end table
bellardb389dbf2005-11-06 16:49:55 +00001467
pbrook0aff66b2006-05-26 00:49:52 +00001468@node host_usb_devices
bellardb389dbf2005-11-06 16:49:55 +00001469@subsection Using host USB devices on a Linux host
1470
1471WARNING: this is an experimental feature. QEMU will slow down when
1472using it. USB devices requiring real time streaming (i.e. USB Video
1473Cameras) are not supported yet.
1474
1475@enumerate
ths5fafdf22007-09-16 21:08:06 +00001476@item If you use an early Linux 2.4 kernel, verify that no Linux driver
bellardb389dbf2005-11-06 16:49:55 +00001477is actually using the USB device. A simple way to do that is simply to
1478disable the corresponding kernel module by renaming it from @file{mydriver.o}
1479to @file{mydriver.o.disabled}.
1480
1481@item Verify that @file{/proc/bus/usb} is working (most Linux distributions should enable it by default). You should see something like that:
1482@example
1483ls /proc/bus/usb
1484001 devices drivers
1485@end example
1486
1487@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:
1488@example
1489chown -R myuid /proc/bus/usb
1490@end example
1491
1492@item Launch QEMU and do in the monitor:
ths5fafdf22007-09-16 21:08:06 +00001493@example
bellardb389dbf2005-11-06 16:49:55 +00001494info usbhost
1495 Device 1.2, speed 480 Mb/s
1496 Class 00: USB device 1234:5678, USB DISK
1497@end example
1498You should see the list of the devices you can use (Never try to use
1499hubs, it won't work).
1500
1501@item Add the device in QEMU by using:
ths5fafdf22007-09-16 21:08:06 +00001502@example
bellardb389dbf2005-11-06 16:49:55 +00001503usb_add host:1234:5678
1504@end example
1505
1506Normally the guest OS should report that a new USB device is
1507plugged. You can use the option @option{-usbdevice} to do the same.
1508
1509@item Now you can try to use the host USB device in QEMU.
1510
1511@end enumerate
1512
1513When relaunching QEMU, you may have to unplug and plug again the USB
1514device to make it work again (this is a bug).
1515
thsf858dca2007-08-25 01:40:37 +00001516@node vnc_security
1517@section VNC security
1518
1519The VNC server capability provides access to the graphical console
1520of the guest VM across the network. This has a number of security
1521considerations depending on the deployment scenarios.
1522
1523@menu
1524* vnc_sec_none::
1525* vnc_sec_password::
1526* vnc_sec_certificate::
1527* vnc_sec_certificate_verify::
1528* vnc_sec_certificate_pw::
1529* vnc_generate_cert::
1530@end menu
1531@node vnc_sec_none
1532@subsection Without passwords
1533
1534The simplest VNC server setup does not include any form of authentication.
1535For this setup it is recommended to restrict it to listen on a UNIX domain
1536socket only. For example
1537
1538@example
1539qemu [...OPTIONS...] -vnc unix:/home/joebloggs/.qemu-myvm-vnc
1540@end example
1541
1542This ensures that only users on local box with read/write access to that
1543path can access the VNC server. To securely access the VNC server from a
1544remote machine, a combination of netcat+ssh can be used to provide a secure
1545tunnel.
1546
1547@node vnc_sec_password
1548@subsection With passwords
1549
1550The VNC protocol has limited support for password based authentication. Since
1551the protocol limits passwords to 8 characters it should not be considered
1552to provide high security. The password can be fairly easily brute-forced by
1553a client making repeat connections. For this reason, a VNC server using password
1554authentication should be restricted to only listen on the loopback interface
1555or UNIX domain sockets. Password ayuthentication is requested with the @code{password}
1556option, and then once QEMU is running the password is set with the monitor. Until
1557the monitor is used to set the password all clients will be rejected.
1558
1559@example
1560qemu [...OPTIONS...] -vnc :1,password -monitor stdio
1561(qemu) change vnc password
1562Password: ********
1563(qemu)
1564@end example
1565
1566@node vnc_sec_certificate
1567@subsection With x509 certificates
1568
1569The QEMU VNC server also implements the VeNCrypt extension allowing use of
1570TLS for encryption of the session, and x509 certificates for authentication.
1571The use of x509 certificates is strongly recommended, because TLS on its
1572own is susceptible to man-in-the-middle attacks. Basic x509 certificate
1573support provides a secure session, but no authentication. This allows any
1574client to connect, and provides an encrypted session.
1575
1576@example
1577qemu [...OPTIONS...] -vnc :1,tls,x509=/etc/pki/qemu -monitor stdio
1578@end example
1579
1580In the above example @code{/etc/pki/qemu} should contain at least three files,
1581@code{ca-cert.pem}, @code{server-cert.pem} and @code{server-key.pem}. Unprivileged
1582users will want to use a private directory, for example @code{$HOME/.pki/qemu}.
1583NB the @code{server-key.pem} file should be protected with file mode 0600 to
1584only be readable by the user owning it.
1585
1586@node vnc_sec_certificate_verify
1587@subsection With x509 certificates and client verification
1588
1589Certificates can also provide a means to authenticate the client connecting.
1590The server will request that the client provide a certificate, which it will
1591then validate against the CA certificate. This is a good choice if deploying
1592in an environment with a private internal certificate authority.
1593
1594@example
1595qemu [...OPTIONS...] -vnc :1,tls,x509verify=/etc/pki/qemu -monitor stdio
1596@end example
1597
1598
1599@node vnc_sec_certificate_pw
1600@subsection With x509 certificates, client verification and passwords
1601
1602Finally, the previous method can be combined with VNC password authentication
1603to provide two layers of authentication for clients.
1604
1605@example
1606qemu [...OPTIONS...] -vnc :1,password,tls,x509verify=/etc/pki/qemu -monitor stdio
1607(qemu) change vnc password
1608Password: ********
1609(qemu)
1610@end example
1611
1612@node vnc_generate_cert
1613@subsection Generating certificates for VNC
1614
1615The GNU TLS packages provides a command called @code{certtool} which can
1616be used to generate certificates and keys in PEM format. At a minimum it
1617is neccessary to setup a certificate authority, and issue certificates to
1618each server. If using certificates for authentication, then each client
1619will also need to be issued a certificate. The recommendation is for the
1620server to keep its certificates in either @code{/etc/pki/qemu} or for
1621unprivileged users in @code{$HOME/.pki/qemu}.
1622
1623@menu
1624* vnc_generate_ca::
1625* vnc_generate_server::
1626* vnc_generate_client::
1627@end menu
1628@node vnc_generate_ca
1629@subsubsection Setup the Certificate Authority
1630
1631This step only needs to be performed once per organization / organizational
1632unit. First the CA needs a private key. This key must be kept VERY secret
1633and secure. If this key is compromised the entire trust chain of the certificates
1634issued with it is lost.
1635
1636@example
1637# certtool --generate-privkey > ca-key.pem
1638@end example
1639
1640A CA needs to have a public certificate. For simplicity it can be a self-signed
1641certificate, or one issue by a commercial certificate issuing authority. To
1642generate a self-signed certificate requires one core piece of information, the
1643name of the organization.
1644
1645@example
1646# cat > ca.info <<EOF
1647cn = Name of your organization
1648ca
1649cert_signing_key
1650EOF
1651# certtool --generate-self-signed \
1652 --load-privkey ca-key.pem
1653 --template ca.info \
1654 --outfile ca-cert.pem
1655@end example
1656
1657The @code{ca-cert.pem} file should be copied to all servers and clients wishing to utilize
1658TLS support in the VNC server. The @code{ca-key.pem} must not be disclosed/copied at all.
1659
1660@node vnc_generate_server
1661@subsubsection Issuing server certificates
1662
1663Each server (or host) needs to be issued with a key and certificate. When connecting
1664the certificate is sent to the client which validates it against the CA certificate.
1665The core piece of information for a server certificate is the hostname. This should
1666be the fully qualified hostname that the client will connect with, since the client
1667will typically also verify the hostname in the certificate. On the host holding the
1668secure CA private key:
1669
1670@example
1671# cat > server.info <<EOF
1672organization = Name of your organization
1673cn = server.foo.example.com
1674tls_www_server
1675encryption_key
1676signing_key
1677EOF
1678# certtool --generate-privkey > server-key.pem
1679# certtool --generate-certificate \
1680 --load-ca-certificate ca-cert.pem \
1681 --load-ca-privkey ca-key.pem \
1682 --load-privkey server server-key.pem \
1683 --template server.info \
1684 --outfile server-cert.pem
1685@end example
1686
1687The @code{server-key.pem} and @code{server-cert.pem} files should now be securely copied
1688to the server for which they were generated. The @code{server-key.pem} is security
1689sensitive and should be kept protected with file mode 0600 to prevent disclosure.
1690
1691@node vnc_generate_client
1692@subsubsection Issuing client certificates
1693
1694If the QEMU VNC server is to use the @code{x509verify} option to validate client
1695certificates as its authentication mechanism, each client also needs to be issued
1696a certificate. The client certificate contains enough metadata to uniquely identify
1697the client, typically organization, state, city, building, etc. On the host holding
1698the secure CA private key:
1699
1700@example
1701# cat > client.info <<EOF
1702country = GB
1703state = London
1704locality = London
1705organiazation = Name of your organization
1706cn = client.foo.example.com
1707tls_www_client
1708encryption_key
1709signing_key
1710EOF
1711# certtool --generate-privkey > client-key.pem
1712# certtool --generate-certificate \
1713 --load-ca-certificate ca-cert.pem \
1714 --load-ca-privkey ca-key.pem \
1715 --load-privkey client-key.pem \
1716 --template client.info \
1717 --outfile client-cert.pem
1718@end example
1719
1720The @code{client-key.pem} and @code{client-cert.pem} files should now be securely
1721copied to the client for which they were generated.
1722
bellard0806e3f2003-10-01 00:15:32 +00001723@node gdb_usage
bellardda415d52003-06-27 18:50:50 +00001724@section GDB usage
1725
1726QEMU has a primitive support to work with gdb, so that you can do
bellard0806e3f2003-10-01 00:15:32 +00001727'Ctrl-C' while the virtual machine is running and inspect its state.
bellardda415d52003-06-27 18:50:50 +00001728
bellard9d4520d2003-10-28 01:38:57 +00001729In order to use gdb, launch qemu with the '-s' option. It will wait for a
bellardda415d52003-06-27 18:50:50 +00001730gdb connection:
1731@example
bellarddebc7062006-04-30 21:58:41 +00001732> qemu -s -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1733 -append "root=/dev/hda"
bellardda415d52003-06-27 18:50:50 +00001734Connected to host network interface: tun0
1735Waiting gdb connection on port 1234
1736@end example
1737
1738Then launch gdb on the 'vmlinux' executable:
1739@example
1740> gdb vmlinux
1741@end example
1742
1743In gdb, connect to QEMU:
1744@example
bellard6c9bf892004-01-24 13:46:56 +00001745(gdb) target remote localhost:1234
bellardda415d52003-06-27 18:50:50 +00001746@end example
1747
1748Then you can use gdb normally. For example, type 'c' to launch the kernel:
1749@example
1750(gdb) c
1751@end example
1752
bellard0806e3f2003-10-01 00:15:32 +00001753Here are some useful tips in order to use gdb on system code:
1754
1755@enumerate
1756@item
1757Use @code{info reg} to display all the CPU registers.
1758@item
1759Use @code{x/10i $eip} to display the code at the PC position.
1760@item
1761Use @code{set architecture i8086} to dump 16 bit code. Then use
bellard294e8632006-05-06 14:23:06 +00001762@code{x/10i $cs*16+$eip} to dump the code at the PC position.
bellard0806e3f2003-10-01 00:15:32 +00001763@end enumerate
1764
bellarddebc7062006-04-30 21:58:41 +00001765@node pcsys_os_specific
bellard1a084f32004-05-13 22:34:49 +00001766@section Target OS specific information
1767
1768@subsection Linux
1769
bellard15a34c62004-07-08 21:26:26 +00001770To have access to SVGA graphic modes under X11, use the @code{vesa} or
1771the @code{cirrus} X11 driver. For optimal performances, use 16 bit
1772color depth in the guest and the host OS.
bellard1a084f32004-05-13 22:34:49 +00001773
bellarde3371e62004-07-10 16:26:02 +00001774When using a 2.6 guest Linux kernel, you should add the option
1775@code{clock=pit} on the kernel command line because the 2.6 Linux
1776kernels make very strict real time clock checks by default that QEMU
1777cannot simulate exactly.
1778
bellard7c3fc842005-02-10 21:46:47 +00001779When using a 2.6 guest Linux kernel, verify that the 4G/4G patch is
1780not activated because QEMU is slower with this patch. The QEMU
1781Accelerator Module is also much slower in this case. Earlier Fedora
ths4be456f2007-06-03 13:41:28 +00001782Core 3 Linux kernel (< 2.6.9-1.724_FC3) were known to incorporate this
bellard7c3fc842005-02-10 21:46:47 +00001783patch by default. Newer kernels don't have it.
1784
bellard1a084f32004-05-13 22:34:49 +00001785@subsection Windows
1786
1787If you have a slow host, using Windows 95 is better as it gives the
1788best speed. Windows 2000 is also a good choice.
1789
bellarde3371e62004-07-10 16:26:02 +00001790@subsubsection SVGA graphic modes support
1791
1792QEMU emulates a Cirrus Logic GD5446 Video
bellard15a34c62004-07-08 21:26:26 +00001793card. All Windows versions starting from Windows 95 should recognize
1794and use this graphic card. For optimal performances, use 16 bit color
1795depth in the guest and the host OS.
bellard1a084f32004-05-13 22:34:49 +00001796
bellard3cb08532006-06-21 21:19:50 +00001797If you are using Windows XP as guest OS and if you want to use high
1798resolution modes which the Cirrus Logic BIOS does not support (i.e. >=
17991280x1024x16), then you should use the VESA VBE virtual graphic card
1800(option @option{-std-vga}).
1801
bellarde3371e62004-07-10 16:26:02 +00001802@subsubsection CPU usage reduction
1803
1804Windows 9x does not correctly use the CPU HLT
bellard15a34c62004-07-08 21:26:26 +00001805instruction. The result is that it takes host CPU cycles even when
1806idle. You can install the utility from
1807@url{http://www.user.cityline.ru/~maxamn/amnhltm.zip} to solve this
1808problem. Note that no such tool is needed for NT, 2000 or XP.
bellard1a084f32004-05-13 22:34:49 +00001809
bellard9d0a8e62005-07-03 17:34:05 +00001810@subsubsection Windows 2000 disk full problem
bellarde3371e62004-07-10 16:26:02 +00001811
bellard9d0a8e62005-07-03 17:34:05 +00001812Windows 2000 has a bug which gives a disk full problem during its
1813installation. When installing it, use the @option{-win2k-hack} QEMU
1814option to enable a specific workaround. After Windows 2000 is
1815installed, you no longer need this option (this option slows down the
1816IDE transfers).
bellarde3371e62004-07-10 16:26:02 +00001817
bellard6cc721c2005-07-28 22:27:28 +00001818@subsubsection Windows 2000 shutdown
1819
1820Windows 2000 cannot automatically shutdown in QEMU although Windows 98
1821can. It comes from the fact that Windows 2000 does not automatically
1822use the APM driver provided by the BIOS.
1823
1824In order to correct that, do the following (thanks to Struan
1825Bartlett): go to the Control Panel => Add/Remove Hardware & Next =>
1826Add/Troubleshoot a device => Add a new device & Next => No, select the
1827hardware from a list & Next => NT Apm/Legacy Support & Next => Next
1828(again) a few times. Now the driver is installed and Windows 2000 now
ths5fafdf22007-09-16 21:08:06 +00001829correctly instructs QEMU to shutdown at the appropriate moment.
bellard6cc721c2005-07-28 22:27:28 +00001830
1831@subsubsection Share a directory between Unix and Windows
1832
1833See @ref{sec_invocation} about the help of the option @option{-smb}.
1834
bellard2192c332006-08-21 20:28:18 +00001835@subsubsection Windows XP security problem
bellarde3371e62004-07-10 16:26:02 +00001836
1837Some releases of Windows XP install correctly but give a security
1838error when booting:
1839@example
1840A problem is preventing Windows from accurately checking the
1841license for this computer. Error code: 0x800703e6.
1842@end example
bellarde3371e62004-07-10 16:26:02 +00001843
bellard2192c332006-08-21 20:28:18 +00001844The workaround is to install a service pack for XP after a boot in safe
1845mode. Then reboot, and the problem should go away. Since there is no
1846network while in safe mode, its recommended to download the full
1847installation of SP1 or SP2 and transfer that via an ISO or using the
1848vvfat block device ("-hdb fat:directory_which_holds_the_SP").
bellarde3371e62004-07-10 16:26:02 +00001849
bellarda0a821a2004-07-14 17:38:57 +00001850@subsection MS-DOS and FreeDOS
1851
1852@subsubsection CPU usage reduction
1853
1854DOS does not correctly use the CPU HLT instruction. The result is that
1855it takes host CPU cycles even when idle. You can install the utility
1856from @url{http://www.vmware.com/software/dosidle210.zip} to solve this
1857problem.
1858
bellarddebc7062006-04-30 21:58:41 +00001859@node QEMU System emulator for non PC targets
bellard3f9f3aa2005-12-18 20:11:37 +00001860@chapter QEMU System emulator for non PC targets
1861
1862QEMU is a generic emulator and it emulates many non PC
1863machines. Most of the options are similar to the PC emulator. The
ths4be456f2007-06-03 13:41:28 +00001864differences are mentioned in the following sections.
bellard3f9f3aa2005-12-18 20:11:37 +00001865
bellarddebc7062006-04-30 21:58:41 +00001866@menu
1867* QEMU PowerPC System emulator::
ths24d4de42007-07-11 10:24:28 +00001868* Sparc32 System emulator::
1869* Sparc64 System emulator::
1870* MIPS System emulator::
1871* ARM System emulator::
1872* ColdFire System emulator::
bellarddebc7062006-04-30 21:58:41 +00001873@end menu
1874
1875@node QEMU PowerPC System emulator
bellard3f9f3aa2005-12-18 20:11:37 +00001876@section QEMU PowerPC System emulator
bellard52c00a52004-04-25 21:27:03 +00001877
1878Use the executable @file{qemu-system-ppc} to simulate a complete PREP
bellard15a34c62004-07-08 21:26:26 +00001879or PowerMac PowerPC system.
1880
bellardb671f9e2005-04-30 15:08:33 +00001881QEMU emulates the following PowerMac peripherals:
bellard15a34c62004-07-08 21:26:26 +00001882
1883@itemize @minus
ths5fafdf22007-09-16 21:08:06 +00001884@item
1885UniNorth PCI Bridge
bellard15a34c62004-07-08 21:26:26 +00001886@item
1887PCI VGA compatible card with VESA Bochs Extensions
ths5fafdf22007-09-16 21:08:06 +00001888@item
bellard15a34c62004-07-08 21:26:26 +000018892 PMAC IDE interfaces with hard disk and CD-ROM support
ths5fafdf22007-09-16 21:08:06 +00001890@item
bellard15a34c62004-07-08 21:26:26 +00001891NE2000 PCI adapters
1892@item
1893Non Volatile RAM
1894@item
1895VIA-CUDA with ADB keyboard and mouse.
1896@end itemize
bellard52c00a52004-04-25 21:27:03 +00001897
bellardb671f9e2005-04-30 15:08:33 +00001898QEMU emulates the following PREP peripherals:
bellard52c00a52004-04-25 21:27:03 +00001899
1900@itemize @minus
ths5fafdf22007-09-16 21:08:06 +00001901@item
bellard15a34c62004-07-08 21:26:26 +00001902PCI Bridge
1903@item
1904PCI VGA compatible card with VESA Bochs Extensions
ths5fafdf22007-09-16 21:08:06 +00001905@item
bellard52c00a52004-04-25 21:27:03 +000019062 IDE interfaces with hard disk and CD-ROM support
1907@item
1908Floppy disk
ths5fafdf22007-09-16 21:08:06 +00001909@item
bellard15a34c62004-07-08 21:26:26 +00001910NE2000 network adapters
bellard52c00a52004-04-25 21:27:03 +00001911@item
1912Serial port
1913@item
1914PREP Non Volatile RAM
bellard15a34c62004-07-08 21:26:26 +00001915@item
1916PC compatible keyboard and mouse.
bellard52c00a52004-04-25 21:27:03 +00001917@end itemize
1918
bellard15a34c62004-07-08 21:26:26 +00001919QEMU uses the Open Hack'Ware Open Firmware Compatible BIOS available at
bellard3f9f3aa2005-12-18 20:11:37 +00001920@url{http://perso.magic.fr/l_indien/OpenHackWare/index.htm}.
bellard52c00a52004-04-25 21:27:03 +00001921
bellard15a34c62004-07-08 21:26:26 +00001922@c man begin OPTIONS
1923
1924The following options are specific to the PowerPC emulation:
1925
1926@table @option
1927
ths3b46e622007-09-17 08:09:54 +00001928@item -g WxH[xDEPTH]
bellard15a34c62004-07-08 21:26:26 +00001929
1930Set the initial VGA graphic mode. The default is 800x600x15.
1931
1932@end table
1933
ths5fafdf22007-09-16 21:08:06 +00001934@c man end
bellard15a34c62004-07-08 21:26:26 +00001935
1936
bellard52c00a52004-04-25 21:27:03 +00001937More information is available at
bellard3f9f3aa2005-12-18 20:11:37 +00001938@url{http://perso.magic.fr/l_indien/qemu-ppc/}.
bellard52c00a52004-04-25 21:27:03 +00001939
ths24d4de42007-07-11 10:24:28 +00001940@node Sparc32 System emulator
1941@section Sparc32 System emulator
bellarde80cfcf2004-12-19 23:18:01 +00001942
bellard0986ac32006-06-14 12:36:32 +00001943Use the executable @file{qemu-system-sparc} to simulate a SparcStation 5
blueswir1a2502b52007-06-10 17:01:00 +00001944or SparcStation 10 (sun4m architecture). The emulation is somewhat complete.
bellarde80cfcf2004-12-19 23:18:01 +00001945
bellardb671f9e2005-04-30 15:08:33 +00001946QEMU emulates the following sun4m peripherals:
bellarde80cfcf2004-12-19 23:18:01 +00001947
1948@itemize @minus
bellard34751872005-07-02 14:31:34 +00001949@item
bellarde80cfcf2004-12-19 23:18:01 +00001950IOMMU
1951@item
1952TCX Frame buffer
ths5fafdf22007-09-16 21:08:06 +00001953@item
bellarde80cfcf2004-12-19 23:18:01 +00001954Lance (Am7990) Ethernet
1955@item
1956Non Volatile RAM M48T08
1957@item
bellard34751872005-07-02 14:31:34 +00001958Slave I/O: timers, interrupt controllers, Zilog serial ports, keyboard
1959and power/reset logic
1960@item
1961ESP SCSI controller with hard disk and CD-ROM support
1962@item
1963Floppy drive
blueswir1a2502b52007-06-10 17:01:00 +00001964@item
1965CS4231 sound device (only on SS-5, not working yet)
bellarde80cfcf2004-12-19 23:18:01 +00001966@end itemize
1967
bellard34751872005-07-02 14:31:34 +00001968The number of peripherals is fixed in the architecture.
bellarde80cfcf2004-12-19 23:18:01 +00001969
bellard30a604f2006-06-14 18:35:18 +00001970Since version 0.8.2, QEMU uses OpenBIOS
bellard0986ac32006-06-14 12:36:32 +00001971@url{http://www.openbios.org/}. OpenBIOS is a free (GPL v2) portable
1972firmware implementation. The goal is to implement a 100% IEEE
19731275-1994 (referred to as Open Firmware) compliant firmware.
bellard34751872005-07-02 14:31:34 +00001974
1975A sample Linux 2.6 series kernel and ram disk image are available on
bellard0986ac32006-06-14 12:36:32 +00001976the QEMU web site. Please note that currently NetBSD, OpenBSD or
1977Solaris kernels don't work.
bellard34751872005-07-02 14:31:34 +00001978
1979@c man begin OPTIONS
1980
blueswir1a2502b52007-06-10 17:01:00 +00001981The following options are specific to the Sparc32 emulation:
bellard34751872005-07-02 14:31:34 +00001982
1983@table @option
1984
blueswir1a2502b52007-06-10 17:01:00 +00001985@item -g WxHx[xDEPTH]
bellard34751872005-07-02 14:31:34 +00001986
blueswir1a2502b52007-06-10 17:01:00 +00001987Set the initial TCX graphic mode. The default is 1024x768x8, currently
1988the only other possible mode is 1024x768x24.
bellard34751872005-07-02 14:31:34 +00001989
blueswir166508602007-05-01 14:16:52 +00001990@item -prom-env string
1991
1992Set OpenBIOS variables in NVRAM, for example:
1993
1994@example
1995qemu-system-sparc -prom-env 'auto-boot?=false' \
1996 -prom-env 'boot-device=sd(0,2,0):d' -prom-env 'boot-args=linux single'
1997@end example
1998
blueswir1a2502b52007-06-10 17:01:00 +00001999@item -M [SS-5|SS-10]
2000
2001Set the emulated machine type. Default is SS-5.
2002
bellard34751872005-07-02 14:31:34 +00002003@end table
2004
ths5fafdf22007-09-16 21:08:06 +00002005@c man end
bellard34751872005-07-02 14:31:34 +00002006
ths24d4de42007-07-11 10:24:28 +00002007@node Sparc64 System emulator
2008@section Sparc64 System emulator
bellard34751872005-07-02 14:31:34 +00002009
2010Use the executable @file{qemu-system-sparc64} to simulate a Sun4u machine.
2011The emulator is not usable for anything yet.
bellardb7569212005-03-13 09:43:05 +00002012
bellard83469012005-07-23 14:27:54 +00002013QEMU emulates the following sun4u peripherals:
2014
2015@itemize @minus
2016@item
ths5fafdf22007-09-16 21:08:06 +00002017UltraSparc IIi APB PCI Bridge
bellard83469012005-07-23 14:27:54 +00002018@item
2019PCI VGA compatible card with VESA Bochs Extensions
2020@item
2021Non Volatile RAM M48T59
2022@item
2023PC-compatible serial ports
2024@end itemize
2025
ths24d4de42007-07-11 10:24:28 +00002026@node MIPS System emulator
2027@section MIPS System emulator
bellard9d0a8e62005-07-03 17:34:05 +00002028
2029Use the executable @file{qemu-system-mips} to simulate a MIPS machine.
ths24d4de42007-07-11 10:24:28 +00002030Three different machine types are emulated:
2031
2032@itemize @minus
2033@item
2034A generic ISA PC-like machine "mips"
2035@item
2036The MIPS Malta prototype board "malta"
2037@item
2038An ACER Pica "pica61"
ths6bf5b4e2007-10-17 13:08:32 +00002039@item
2040MIPS MIPSsim emulator pseudo board "mipssim"
ths24d4de42007-07-11 10:24:28 +00002041@end itemize
2042
2043The generic emulation is supported by Debian 'Etch' and is able to
2044install Debian into a virtual disk image. The following devices are
2045emulated:
bellard9d0a8e62005-07-03 17:34:05 +00002046
bellard3f9f3aa2005-12-18 20:11:37 +00002047@itemize @minus
ths5fafdf22007-09-16 21:08:06 +00002048@item
ths6bf5b4e2007-10-17 13:08:32 +00002049A range of MIPS CPUs, default is the 24Kf
bellard3f9f3aa2005-12-18 20:11:37 +00002050@item
2051PC style serial port
2052@item
ths24d4de42007-07-11 10:24:28 +00002053PC style IDE disk
2054@item
bellard3f9f3aa2005-12-18 20:11:37 +00002055NE2000 network card
2056@end itemize
2057
ths24d4de42007-07-11 10:24:28 +00002058The Malta emulation supports the following devices:
bellard3f9f3aa2005-12-18 20:11:37 +00002059
ths24d4de42007-07-11 10:24:28 +00002060@itemize @minus
2061@item
ths0b64d002007-07-11 21:43:14 +00002062Core board with MIPS 24Kf CPU and Galileo system controller
ths24d4de42007-07-11 10:24:28 +00002063@item
2064PIIX4 PCI/USB/SMbus controller
2065@item
2066The Multi-I/O chip's serial device
2067@item
2068PCnet32 PCI network card
2069@item
2070Malta FPGA serial device
2071@item
2072Cirrus VGA graphics card
2073@end itemize
2074
2075The ACER Pica emulation supports:
2076
2077@itemize @minus
2078@item
2079MIPS R4000 CPU
2080@item
2081PC-style IRQ and DMA controllers
2082@item
2083PC Keyboard
2084@item
2085IDE controller
2086@end itemize
2087
ths6bf5b4e2007-10-17 13:08:32 +00002088The MIPSsim emulation supports:
2089
2090@itemize @minus
2091@item
2092A range of MIPS CPUs, default is the 24Kf
2093@item
2094PC style serial port
2095@item
2096MIPSnet network emulation
2097@end itemize
2098
ths24d4de42007-07-11 10:24:28 +00002099@node ARM System emulator
2100@section ARM System emulator
bellard3f9f3aa2005-12-18 20:11:37 +00002101
2102Use the executable @file{qemu-system-arm} to simulate a ARM
2103machine. The ARM Integrator/CP board is emulated with the following
2104devices:
2105
2106@itemize @minus
2107@item
pbrookce819862007-05-08 02:30:40 +00002108ARM926E, ARM1026E or ARM946E CPU
bellard3f9f3aa2005-12-18 20:11:37 +00002109@item
2110Two PL011 UARTs
ths5fafdf22007-09-16 21:08:06 +00002111@item
bellard3f9f3aa2005-12-18 20:11:37 +00002112SMC 91c111 Ethernet adapter
pbrook00a9bf12006-05-13 16:55:46 +00002113@item
2114PL110 LCD controller
2115@item
2116PL050 KMI with PS/2 keyboard and mouse.
pbrooka1bb27b2007-04-06 16:49:48 +00002117@item
2118PL181 MultiMedia Card Interface with SD card.
pbrook00a9bf12006-05-13 16:55:46 +00002119@end itemize
2120
2121The ARM Versatile baseboard is emulated with the following devices:
2122
2123@itemize @minus
2124@item
2125ARM926E CPU
2126@item
2127PL190 Vectored Interrupt Controller
2128@item
2129Four PL011 UARTs
ths5fafdf22007-09-16 21:08:06 +00002130@item
pbrook00a9bf12006-05-13 16:55:46 +00002131SMC 91c111 Ethernet adapter
2132@item
2133PL110 LCD controller
2134@item
2135PL050 KMI with PS/2 keyboard and mouse.
2136@item
2137PCI host bridge. Note the emulated PCI bridge only provides access to
2138PCI memory space. It does not provide access to PCI IO space.
ths4be456f2007-06-03 13:41:28 +00002139This means some devices (eg. ne2k_pci NIC) are not usable, and others
2140(eg. rtl8139 NIC) are only usable when the guest drivers use the memory
pbrook00a9bf12006-05-13 16:55:46 +00002141mapped control registers.
pbrooke6de1ba2006-06-16 21:48:48 +00002142@item
2143PCI OHCI USB controller.
2144@item
2145LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices.
pbrooka1bb27b2007-04-06 16:49:48 +00002146@item
2147PL181 MultiMedia Card Interface with SD card.
bellard3f9f3aa2005-12-18 20:11:37 +00002148@end itemize
2149
pbrookd7739d72007-02-28 16:25:17 +00002150The ARM RealView Emulation baseboard is emulated with the following devices:
2151
2152@itemize @minus
2153@item
2154ARM926E CPU
2155@item
2156ARM AMBA Generic/Distributed Interrupt Controller
2157@item
2158Four PL011 UARTs
ths5fafdf22007-09-16 21:08:06 +00002159@item
pbrookd7739d72007-02-28 16:25:17 +00002160SMC 91c111 Ethernet adapter
2161@item
2162PL110 LCD controller
2163@item
2164PL050 KMI with PS/2 keyboard and mouse
2165@item
2166PCI host bridge
2167@item
2168PCI OHCI USB controller
2169@item
2170LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices
pbrooka1bb27b2007-04-06 16:49:48 +00002171@item
2172PL181 MultiMedia Card Interface with SD card.
pbrookd7739d72007-02-28 16:25:17 +00002173@end itemize
2174
balrogb00052e2007-04-30 02:22:06 +00002175The XScale-based clamshell PDA models ("Spitz", "Akita", "Borzoi"
2176and "Terrier") emulation includes the following peripherals:
2177
2178@itemize @minus
2179@item
2180Intel PXA270 System-on-chip (ARM V5TE core)
2181@item
2182NAND Flash memory
2183@item
2184IBM/Hitachi DSCM microdrive in a PXA PCMCIA slot - not in "Akita"
2185@item
2186On-chip OHCI USB controller
2187@item
2188On-chip LCD controller
2189@item
2190On-chip Real Time Clock
2191@item
2192TI ADS7846 touchscreen controller on SSP bus
2193@item
2194Maxim MAX1111 analog-digital converter on I@math{^2}C bus
2195@item
2196GPIO-connected keyboard controller and LEDs
2197@item
balrog549444e2007-05-01 17:53:37 +00002198Secure Digital card connected to PXA MMC/SD host
balrogb00052e2007-04-30 02:22:06 +00002199@item
2200Three on-chip UARTs
2201@item
2202WM8750 audio CODEC on I@math{^2}C and I@math{^2}S busses
2203@end itemize
2204
bellard3f9f3aa2005-12-18 20:11:37 +00002205A Linux 2.6 test image is available on the QEMU web site. More
2206information is available in the QEMU mailing-list archive.
2207
ths24d4de42007-07-11 10:24:28 +00002208@node ColdFire System emulator
2209@section ColdFire System emulator
pbrook209a4e62007-05-23 20:16:15 +00002210
2211Use the executable @file{qemu-system-m68k} to simulate a ColdFire machine.
2212The emulator is able to boot a uClinux kernel.
pbrook707e0112007-06-04 00:50:06 +00002213
2214The M5208EVB emulation includes the following devices:
2215
2216@itemize @minus
ths5fafdf22007-09-16 21:08:06 +00002217@item
pbrook707e0112007-06-04 00:50:06 +00002218MCF5208 ColdFire V2 Microprocessor (ISA A+ with EMAC).
2219@item
2220Three Two on-chip UARTs.
2221@item
2222Fast Ethernet Controller (FEC)
2223@end itemize
2224
2225The AN5206 emulation includes the following devices:
pbrook209a4e62007-05-23 20:16:15 +00002226
2227@itemize @minus
ths5fafdf22007-09-16 21:08:06 +00002228@item
pbrook209a4e62007-05-23 20:16:15 +00002229MCF5206 ColdFire V2 Microprocessor.
2230@item
2231Two on-chip UARTs.
2232@end itemize
2233
ths5fafdf22007-09-16 21:08:06 +00002234@node QEMU User space emulator
2235@chapter QEMU User space emulator
bellard83195232007-02-05 19:42:07 +00002236
2237@menu
2238* Supported Operating Systems ::
2239* Linux User space emulator::
2240* Mac OS X/Darwin User space emulator ::
2241@end menu
2242
2243@node Supported Operating Systems
2244@section Supported Operating Systems
2245
2246The following OS are supported in user space emulation:
2247
2248@itemize @minus
2249@item
ths4be456f2007-06-03 13:41:28 +00002250Linux (referred as qemu-linux-user)
bellard83195232007-02-05 19:42:07 +00002251@item
ths4be456f2007-06-03 13:41:28 +00002252Mac OS X/Darwin (referred as qemu-darwin-user)
bellard83195232007-02-05 19:42:07 +00002253@end itemize
2254
2255@node Linux User space emulator
2256@section Linux User space emulator
bellard386405f2003-03-23 21:28:45 +00002257
bellarddebc7062006-04-30 21:58:41 +00002258@menu
2259* Quick Start::
2260* Wine launch::
2261* Command line options::
pbrook79737e42006-06-11 16:28:41 +00002262* Other binaries::
bellarddebc7062006-04-30 21:58:41 +00002263@end menu
2264
2265@node Quick Start
bellard83195232007-02-05 19:42:07 +00002266@subsection Quick Start
bellard386405f2003-03-23 21:28:45 +00002267
bellard1f673132004-04-04 15:21:17 +00002268In order to launch a Linux process, QEMU needs the process executable
ths5fafdf22007-09-16 21:08:06 +00002269itself and all the target (x86) dynamic libraries used by it.
bellard386405f2003-03-23 21:28:45 +00002270
bellard1f673132004-04-04 15:21:17 +00002271@itemize
bellard386405f2003-03-23 21:28:45 +00002272
bellard1f673132004-04-04 15:21:17 +00002273@item On x86, you can just try to launch any process by using the native
2274libraries:
bellard386405f2003-03-23 21:28:45 +00002275
ths5fafdf22007-09-16 21:08:06 +00002276@example
bellard1f673132004-04-04 15:21:17 +00002277qemu-i386 -L / /bin/ls
2278@end example
bellardfd429f22003-03-30 20:59:46 +00002279
bellard1f673132004-04-04 15:21:17 +00002280@code{-L /} tells that the x86 dynamic linker must be searched with a
2281@file{/} prefix.
bellard1eb20522003-06-25 16:21:49 +00002282
thsdbcf5e82007-02-10 22:14:55 +00002283@item Since QEMU is also a linux process, you can launch qemu with
2284qemu (NOTE: you can only do that if you compiled QEMU from the sources):
bellard1eb20522003-06-25 16:21:49 +00002285
ths5fafdf22007-09-16 21:08:06 +00002286@example
bellard1f673132004-04-04 15:21:17 +00002287qemu-i386 -L / qemu-i386 -L / /bin/ls
2288@end example
bellard386405f2003-03-23 21:28:45 +00002289
bellard1f673132004-04-04 15:21:17 +00002290@item On non x86 CPUs, you need first to download at least an x86 glibc
2291(@file{qemu-runtime-i386-XXX-.tar.gz} on the QEMU web page). Ensure that
2292@code{LD_LIBRARY_PATH} is not set:
bellard386405f2003-03-23 21:28:45 +00002293
bellard1f673132004-04-04 15:21:17 +00002294@example
ths5fafdf22007-09-16 21:08:06 +00002295unset LD_LIBRARY_PATH
bellard1f673132004-04-04 15:21:17 +00002296@end example
bellard386405f2003-03-23 21:28:45 +00002297
bellard1f673132004-04-04 15:21:17 +00002298Then you can launch the precompiled @file{ls} x86 executable:
bellard386405f2003-03-23 21:28:45 +00002299
bellard1f673132004-04-04 15:21:17 +00002300@example
2301qemu-i386 tests/i386/ls
2302@end example
2303You can look at @file{qemu-binfmt-conf.sh} so that
2304QEMU is automatically launched by the Linux kernel when you try to
2305launch x86 executables. It requires the @code{binfmt_misc} module in the
2306Linux kernel.
bellard386405f2003-03-23 21:28:45 +00002307
bellard1f673132004-04-04 15:21:17 +00002308@item The x86 version of QEMU is also included. You can try weird things such as:
2309@example
bellarddebc7062006-04-30 21:58:41 +00002310qemu-i386 /usr/local/qemu-i386/bin/qemu-i386 \
2311 /usr/local/qemu-i386/bin/ls-i386
bellard1f673132004-04-04 15:21:17 +00002312@end example
bellard386405f2003-03-23 21:28:45 +00002313
bellard1f673132004-04-04 15:21:17 +00002314@end itemize
bellard386405f2003-03-23 21:28:45 +00002315
bellarddebc7062006-04-30 21:58:41 +00002316@node Wine launch
bellard83195232007-02-05 19:42:07 +00002317@subsection Wine launch
bellard386405f2003-03-23 21:28:45 +00002318
bellard1f673132004-04-04 15:21:17 +00002319@itemize
bellard386405f2003-03-23 21:28:45 +00002320
bellard1f673132004-04-04 15:21:17 +00002321@item Ensure that you have a working QEMU with the x86 glibc
2322distribution (see previous section). In order to verify it, you must be
2323able to do:
bellard386405f2003-03-23 21:28:45 +00002324
bellard1f673132004-04-04 15:21:17 +00002325@example
2326qemu-i386 /usr/local/qemu-i386/bin/ls-i386
2327@end example
bellard386405f2003-03-23 21:28:45 +00002328
bellard1f673132004-04-04 15:21:17 +00002329@item Download the binary x86 Wine install
ths5fafdf22007-09-16 21:08:06 +00002330(@file{qemu-XXX-i386-wine.tar.gz} on the QEMU web page).
bellard386405f2003-03-23 21:28:45 +00002331
bellard1f673132004-04-04 15:21:17 +00002332@item Configure Wine on your account. Look at the provided script
bellarddebc7062006-04-30 21:58:41 +00002333@file{/usr/local/qemu-i386/@/bin/wine-conf.sh}. Your previous
bellard1f673132004-04-04 15:21:17 +00002334@code{$@{HOME@}/.wine} directory is saved to @code{$@{HOME@}/.wine.org}.
bellard386405f2003-03-23 21:28:45 +00002335
bellard1f673132004-04-04 15:21:17 +00002336@item Then you can try the example @file{putty.exe}:
bellard386405f2003-03-23 21:28:45 +00002337
bellard1f673132004-04-04 15:21:17 +00002338@example
bellarddebc7062006-04-30 21:58:41 +00002339qemu-i386 /usr/local/qemu-i386/wine/bin/wine \
2340 /usr/local/qemu-i386/wine/c/Program\ Files/putty.exe
bellard1f673132004-04-04 15:21:17 +00002341@end example
bellard386405f2003-03-23 21:28:45 +00002342
bellard1f673132004-04-04 15:21:17 +00002343@end itemize
bellard386405f2003-03-23 21:28:45 +00002344
bellarddebc7062006-04-30 21:58:41 +00002345@node Command line options
bellard83195232007-02-05 19:42:07 +00002346@subsection Command line options
bellard386405f2003-03-23 21:28:45 +00002347
bellard1f673132004-04-04 15:21:17 +00002348@example
2349usage: qemu-i386 [-h] [-d] [-L path] [-s size] program [arguments...]
2350@end example
bellard386405f2003-03-23 21:28:45 +00002351
bellard1f673132004-04-04 15:21:17 +00002352@table @option
2353@item -h
2354Print the help
ths3b46e622007-09-17 08:09:54 +00002355@item -L path
bellard1f673132004-04-04 15:21:17 +00002356Set the x86 elf interpreter prefix (default=/usr/local/qemu-i386)
2357@item -s size
2358Set the x86 stack size in bytes (default=524288)
bellard386405f2003-03-23 21:28:45 +00002359@end table
2360
bellard1f673132004-04-04 15:21:17 +00002361Debug options:
bellard386405f2003-03-23 21:28:45 +00002362
bellard1f673132004-04-04 15:21:17 +00002363@table @option
2364@item -d
2365Activate log (logfile=/tmp/qemu.log)
2366@item -p pagesize
2367Act as if the host page size was 'pagesize' bytes
2368@end table
bellard386405f2003-03-23 21:28:45 +00002369
pbrook79737e42006-06-11 16:28:41 +00002370@node Other binaries
bellard83195232007-02-05 19:42:07 +00002371@subsection Other binaries
pbrook79737e42006-06-11 16:28:41 +00002372
2373@command{qemu-arm} is also capable of running ARM "Angel" semihosted ELF
2374binaries (as implemented by the arm-elf and arm-eabi Newlib/GDB
2375configurations), and arm-uclinux bFLT format binaries.
2376
pbrooke6e59062006-10-22 00:18:54 +00002377@command{qemu-m68k} is capable of running semihosted binaries using the BDM
2378(m5xxx-ram-hosted.ld) or m68k-sim (sim.ld) syscall interfaces, and
2379coldfire uClinux bFLT format binaries.
2380
pbrook79737e42006-06-11 16:28:41 +00002381The binary format is detected automatically.
2382
bellard83195232007-02-05 19:42:07 +00002383@node Mac OS X/Darwin User space emulator
2384@section Mac OS X/Darwin User space emulator
2385
2386@menu
2387* Mac OS X/Darwin Status::
2388* Mac OS X/Darwin Quick Start::
2389* Mac OS X/Darwin Command line options::
2390@end menu
2391
2392@node Mac OS X/Darwin Status
2393@subsection Mac OS X/Darwin Status
2394
2395@itemize @minus
2396@item
2397target x86 on x86: Most apps (Cocoa and Carbon too) works. [1]
2398@item
2399target PowerPC on x86: Not working as the ppc commpage can't be mapped (yet!)
2400@item
thsdbcf5e82007-02-10 22:14:55 +00002401target PowerPC on PowerPC: Most apps (Cocoa and Carbon too) works. [1]
bellard83195232007-02-05 19:42:07 +00002402@item
2403target x86 on PowerPC: most utilities work. Cocoa and Carbon apps are not yet supported.
2404@end itemize
2405
2406[1] If you're host commpage can be executed by qemu.
2407
2408@node Mac OS X/Darwin Quick Start
2409@subsection Quick Start
2410
2411In order to launch a Mac OS X/Darwin process, QEMU needs the process executable
2412itself and all the target dynamic libraries used by it. If you don't have the FAT
2413libraries (you're running Mac OS X/ppc) you'll need to obtain it from a Mac OS X
2414CD or compile them by hand.
2415
2416@itemize
2417
2418@item On x86, you can just try to launch any process by using the native
2419libraries:
2420
ths5fafdf22007-09-16 21:08:06 +00002421@example
thsdbcf5e82007-02-10 22:14:55 +00002422qemu-i386 /bin/ls
bellard83195232007-02-05 19:42:07 +00002423@end example
2424
2425or to run the ppc version of the executable:
2426
ths5fafdf22007-09-16 21:08:06 +00002427@example
thsdbcf5e82007-02-10 22:14:55 +00002428qemu-ppc /bin/ls
bellard83195232007-02-05 19:42:07 +00002429@end example
2430
2431@item On ppc, you'll have to tell qemu where your x86 libraries (and dynamic linker)
2432are installed:
2433
ths5fafdf22007-09-16 21:08:06 +00002434@example
thsdbcf5e82007-02-10 22:14:55 +00002435qemu-i386 -L /opt/x86_root/ /bin/ls
bellard83195232007-02-05 19:42:07 +00002436@end example
2437
2438@code{-L /opt/x86_root/} tells that the dynamic linker (dyld) path is in
2439@file{/opt/x86_root/usr/bin/dyld}.
2440
2441@end itemize
2442
2443@node Mac OS X/Darwin Command line options
2444@subsection Command line options
2445
2446@example
thsdbcf5e82007-02-10 22:14:55 +00002447usage: qemu-i386 [-h] [-d] [-L path] [-s size] program [arguments...]
bellard83195232007-02-05 19:42:07 +00002448@end example
2449
2450@table @option
2451@item -h
2452Print the help
ths3b46e622007-09-17 08:09:54 +00002453@item -L path
bellard83195232007-02-05 19:42:07 +00002454Set the library root path (default=/)
2455@item -s size
2456Set the stack size in bytes (default=524288)
2457@end table
2458
2459Debug options:
2460
2461@table @option
2462@item -d
2463Activate log (logfile=/tmp/qemu.log)
2464@item -p pagesize
2465Act as if the host page size was 'pagesize' bytes
2466@end table
2467
bellard15a34c62004-07-08 21:26:26 +00002468@node compilation
2469@chapter Compilation from the sources
2470
bellarddebc7062006-04-30 21:58:41 +00002471@menu
2472* Linux/Unix::
2473* Windows::
2474* Cross compilation for Windows with Linux::
2475* Mac OS X::
2476@end menu
2477
2478@node Linux/Unix
bellard7c3fc842005-02-10 21:46:47 +00002479@section Linux/Unix
bellard15a34c62004-07-08 21:26:26 +00002480
bellard7c3fc842005-02-10 21:46:47 +00002481@subsection Compilation
2482
2483First you must decompress the sources:
2484@example
2485cd /tmp
2486tar zxvf qemu-x.y.z.tar.gz
2487cd qemu-x.y.z
2488@end example
2489
2490Then you configure QEMU and build it (usually no options are needed):
2491@example
2492./configure
2493make
2494@end example
2495
2496Then type as root user:
2497@example
2498make install
2499@end example
2500to install QEMU in @file{/usr/local}.
2501
bellard4fe8b872007-02-05 19:38:35 +00002502@subsection GCC version
bellard7c3fc842005-02-10 21:46:47 +00002503
ths366dfc52006-12-11 18:35:08 +00002504In order to compile QEMU successfully, it is very important that you
bellard4fe8b872007-02-05 19:38:35 +00002505have the right tools. The most important one is gcc. On most hosts and
2506in particular on x86 ones, @emph{gcc 4.x is not supported}. If your
2507Linux distribution includes a gcc 4.x compiler, you can usually
2508install an older version (it is invoked by @code{gcc32} or
2509@code{gcc34}). The QEMU configure script automatically probes for
ths4be456f2007-06-03 13:41:28 +00002510these older versions so that usually you don't have to do anything.
bellard15a34c62004-07-08 21:26:26 +00002511
bellarddebc7062006-04-30 21:58:41 +00002512@node Windows
bellard15a34c62004-07-08 21:26:26 +00002513@section Windows
2514
2515@itemize
2516@item Install the current versions of MSYS and MinGW from
2517@url{http://www.mingw.org/}. You can find detailed installation
2518instructions in the download section and the FAQ.
2519
ths5fafdf22007-09-16 21:08:06 +00002520@item Download
bellard15a34c62004-07-08 21:26:26 +00002521the MinGW development library of SDL 1.2.x
bellarddebc7062006-04-30 21:58:41 +00002522(@file{SDL-devel-1.2.x-@/mingw32.tar.gz}) from
bellard15a34c62004-07-08 21:26:26 +00002523@url{http://www.libsdl.org}. Unpack it in a temporary place, and
2524unpack the archive @file{i386-mingw32msvc.tar.gz} in the MinGW tool
2525directory. Edit the @file{sdl-config} script so that it gives the
2526correct SDL directory when invoked.
2527
2528@item Extract the current version of QEMU.
ths5fafdf22007-09-16 21:08:06 +00002529
bellard15a34c62004-07-08 21:26:26 +00002530@item Start the MSYS shell (file @file{msys.bat}).
2531
ths5fafdf22007-09-16 21:08:06 +00002532@item Change to the QEMU directory. Launch @file{./configure} and
bellard15a34c62004-07-08 21:26:26 +00002533@file{make}. If you have problems using SDL, verify that
2534@file{sdl-config} can be launched from the MSYS command line.
2535
ths5fafdf22007-09-16 21:08:06 +00002536@item You can install QEMU in @file{Program Files/Qemu} by typing
bellard15a34c62004-07-08 21:26:26 +00002537@file{make install}. Don't forget to copy @file{SDL.dll} in
2538@file{Program Files/Qemu}.
2539
2540@end itemize
2541
bellarddebc7062006-04-30 21:58:41 +00002542@node Cross compilation for Windows with Linux
bellard15a34c62004-07-08 21:26:26 +00002543@section Cross compilation for Windows with Linux
2544
2545@itemize
2546@item
2547Install the MinGW cross compilation tools available at
2548@url{http://www.mingw.org/}.
2549
ths5fafdf22007-09-16 21:08:06 +00002550@item
bellard15a34c62004-07-08 21:26:26 +00002551Install the Win32 version of SDL (@url{http://www.libsdl.org}) by
2552unpacking @file{i386-mingw32msvc.tar.gz}. Set up the PATH environment
2553variable so that @file{i386-mingw32msvc-sdl-config} can be launched by
2554the QEMU configuration script.
2555
ths5fafdf22007-09-16 21:08:06 +00002556@item
bellard15a34c62004-07-08 21:26:26 +00002557Configure QEMU for Windows cross compilation:
2558@example
2559./configure --enable-mingw32
2560@end example
2561If necessary, you can change the cross-prefix according to the prefix
ths4be456f2007-06-03 13:41:28 +00002562chosen for the MinGW tools with --cross-prefix. You can also use
bellard15a34c62004-07-08 21:26:26 +00002563--prefix to set the Win32 install path.
2564
ths5fafdf22007-09-16 21:08:06 +00002565@item You can install QEMU in the installation directory by typing
bellard15a34c62004-07-08 21:26:26 +00002566@file{make install}. Don't forget to copy @file{SDL.dll} in the
ths5fafdf22007-09-16 21:08:06 +00002567installation directory.
bellard15a34c62004-07-08 21:26:26 +00002568
2569@end itemize
2570
2571Note: Currently, Wine does not seem able to launch
2572QEMU for Win32.
2573
bellarddebc7062006-04-30 21:58:41 +00002574@node Mac OS X
bellard15a34c62004-07-08 21:26:26 +00002575@section Mac OS X
2576
2577The Mac OS X patches are not fully merged in QEMU, so you should look
2578at the QEMU mailing list archive to have all the necessary
2579information.
2580
bellarddebc7062006-04-30 21:58:41 +00002581@node Index
2582@chapter Index
2583@printindex cp
2584
2585@bye