1 \input texinfo @c -*- texinfo -*-
3 @setfilename qemu-doc.info
4 @settitle QEMU Emulator User Documentation
12 @center @titlefont{QEMU Emulator}
14 @center @titlefont{User Documentation}
26 * QEMU PC System emulator::
27 * QEMU System emulator for non PC targets::
28 * QEMU Linux User space emulator::
29 * compilation:: Compilation from the sources
40 * intro_features:: Features
46 QEMU is a FAST! processor emulator using dynamic translation to
47 achieve good emulation speed.
49 QEMU has two operating modes:
54 Full system emulation. In this mode, QEMU emulates a full system (for
55 example a PC), including one or several processors and various
56 peripherals. It can be used to launch different Operating Systems
57 without rebooting the PC or to debug system code.
60 User mode emulation (Linux host only). In this mode, QEMU can launch
61 Linux processes compiled for one CPU on another CPU. It can be used to
62 launch the Wine Windows API emulator (@url{http://www.winehq.org}) or
63 to ease cross-compilation and cross-debugging.
67 QEMU can run without an host kernel driver and yet gives acceptable
70 For system emulation, the following hardware targets are supported:
72 @item PC (x86 or x86_64 processor)
73 @item ISA PC (old style PC without PCI bus)
74 @item PREP (PowerPC processor)
75 @item G3 BW PowerMac (PowerPC processor)
76 @item Mac99 PowerMac (PowerPC processor, in progress)
77 @item Sun4m (32-bit Sparc processor)
78 @item Sun4u (64-bit Sparc processor, in progress)
79 @item Malta board (32-bit MIPS processor)
80 @item ARM Integrator/CP (ARM926E or 1026E processor)
81 @item ARM Versatile baseboard (ARM926E)
84 For user emulation, x86, PowerPC, ARM, MIPS, Sparc32/64 and ColdFire(m68k) CPUs are supported.
89 If you want to compile QEMU yourself, see @ref{compilation}.
92 * install_linux:: Linux
93 * install_windows:: Windows
94 * install_mac:: Macintosh
100 If a precompiled package is available for your distribution - you just
101 have to install it. Otherwise, see @ref{compilation}.
103 @node install_windows
106 Download the experimental binary installer at
107 @url{http://www.free.oszoo.org/@/download.html}.
112 Download the experimental binary installer at
113 @url{http://www.free.oszoo.org/@/download.html}.
115 @node QEMU PC System emulator
116 @chapter QEMU PC System emulator
119 * pcsys_introduction:: Introduction
120 * pcsys_quickstart:: Quick Start
121 * sec_invocation:: Invocation
123 * pcsys_monitor:: QEMU Monitor
124 * disk_images:: Disk Images
125 * pcsys_network:: Network emulation
126 * direct_linux_boot:: Direct Linux Boot
127 * pcsys_usb:: USB emulation
128 * gdb_usage:: GDB usage
129 * pcsys_os_specific:: Target OS specific information
132 @node pcsys_introduction
133 @section Introduction
135 @c man begin DESCRIPTION
137 The QEMU PC System emulator simulates the
138 following peripherals:
142 i440FX host PCI bridge and PIIX3 PCI to ISA bridge
144 Cirrus CLGD 5446 PCI VGA card or dummy VGA card with Bochs VESA
145 extensions (hardware level, including all non standard modes).
147 PS/2 mouse and keyboard
149 2 PCI IDE interfaces with hard disk and CD-ROM support
153 NE2000 PCI network adapters
157 Creative SoundBlaster 16 sound card
159 ENSONIQ AudioPCI ES1370 sound card
161 Adlib(OPL2) - Yamaha YM3812 compatible chip
163 PCI UHCI USB controller and a virtual USB hub.
166 SMP is supported with up to 255 CPUs.
168 Note that adlib is only available when QEMU was configured with
171 QEMU uses the PC BIOS from the Bochs project and the Plex86/Bochs LGPL
174 QEMU uses YM3812 emulation by Tatsuyuki Satoh.
178 @node pcsys_quickstart
181 Download and uncompress the linux image (@file{linux.img}) and type:
187 Linux should boot and give you a prompt.
193 @c man begin SYNOPSIS
194 usage: qemu [options] [disk_image]
199 @var{disk_image} is a raw hard disk image for IDE hard disk 0.
204 Select the emulated machine (@code{-M ?} for list)
208 Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can
209 use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}).
215 Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
218 Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and and
219 @option{-cdrom} at the same time). You can use the host CD-ROM by
220 using @file{/dev/cdrom} as filename (@pxref{host_drives}).
222 @item -boot [a|c|d|n]
223 Boot on floppy (a), hard disk (c), CD-ROM (d), or Etherboot (n). Hard disk boot
227 Write to temporary files instead of disk image files. In this case,
228 the raw disk image you use is not written back. You can however force
229 the write back by pressing @key{C-a s} (@pxref{disk_images}).
232 Disable boot signature checking for floppy disks in Bochs BIOS. It may
233 be needed to boot from old floppy disks.
236 Set virtual RAM size to @var{megs} megabytes. Default is 128 MB.
239 Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
244 Normally, QEMU uses SDL to display the VGA output. With this option,
245 you can totally disable graphical output so that QEMU is a simple
246 command line application. The emulated serial port is redirected on
247 the console. Therefore, you can still use QEMU to debug a Linux kernel
248 with a serial console.
252 Normally, QEMU uses SDL to display the VGA output. With this option,
253 you can have QEMU listen on VNC display @var{display} and redirect the VGA
254 display over the VNC session. It is very useful to enable the usb
255 tablet device when using this option (option @option{-usbdevice
256 tablet}). When using the VNC display, you must use the @option{-k}
257 option to set the keyboard layout if you are not using en-us.
259 @var{display} may be in the form @var{interface:d}, in which case connections
260 will only be allowed from @var{interface} on display @var{d}. Optionally,
261 @var{interface} can be omitted. @var{display} can also be in the form
262 @var{unix:path} where @var{path} is the location of a unix socket to listen for
268 Use keyboard layout @var{language} (for example @code{fr} for
269 French). This option is only needed where it is not easy to get raw PC
270 keycodes (e.g. on Macs, with some X11 servers or with a VNC
271 display). You don't normally need to use it on PC/Linux or PC/Windows
274 The available layouts are:
276 ar de-ch es fo fr-ca hu ja mk no pt-br sv
277 da en-gb et fr fr-ch is lt nl pl ru th
278 de en-us fi fr-be hr it lv nl-be pt sl tr
281 The default is @code{en-us}.
285 Will show the audio subsystem help: list of drivers, tunable
288 @item -soundhw card1,card2,... or -soundhw all
290 Enable audio and selected sound hardware. Use ? to print all
291 available sound hardware.
294 qemu -soundhw sb16,adlib hda
295 qemu -soundhw es1370 hda
296 qemu -soundhw all hda
301 Set the real time clock to local time (the default is to UTC
302 time). This option is needed to have correct date in MS-DOS or
306 Start in full screen.
309 Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
313 Daemonize the QEMU process after initialization. QEMU will not detach from
314 standard IO until it is ready to receive connections on any of its devices.
315 This option is a useful way for external programs to launch QEMU without having
316 to cope with initialization race conditions.
319 Use it when installing Windows 2000 to avoid a disk full bug. After
320 Windows 2000 is installed, you no longer need this option (this option
321 slows down the IDE transfers).
323 @item -option-rom file
324 Load the contents of file as an option ROM. This option is useful to load
325 things like EtherBoot.
333 Enable the USB driver (will be the default soon)
335 @item -usbdevice devname
336 Add the USB device @var{devname}. @xref{usb_devices}.
343 @item -net nic[,vlan=n][,macaddr=addr][,model=type]
344 Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
345 = 0 is the default). The NIC is currently an NE2000 on the PC
346 target. Optionally, the MAC address can be changed. If no
347 @option{-net} option is specified, a single NIC is created.
348 Qemu can emulate several different models of network card. Valid values for
349 @var{type} are @code{ne2k_pci}, @code{ne2k_isa}, @code{rtl8139},
350 @code{smc91c111} and @code{lance}. Not all devices are supported on all
353 @item -net user[,vlan=n][,hostname=name]
354 Use the user mode network stack which requires no administrator
355 priviledge to run. @option{hostname=name} can be used to specify the client
356 hostname reported by the builtin DHCP server.
358 @item -net tap[,vlan=n][,fd=h][,ifname=name][,script=file]
359 Connect the host TAP network interface @var{name} to VLAN @var{n} and
360 use the network script @var{file} to configure it. The default
361 network script is @file{/etc/qemu-ifup}. If @var{name} is not
362 provided, the OS automatically provides one. @option{fd=h} can be
363 used to specify the handle of an already opened host TAP interface. Example:
366 qemu linux.img -net nic -net tap
369 More complicated example (two NICs, each one connected to a TAP device)
371 qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
372 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
376 @item -net socket[,vlan=n][,fd=h][,listen=[host]:port][,connect=host:port]
378 Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
379 machine using a TCP socket connection. If @option{listen} is
380 specified, QEMU waits for incoming connections on @var{port}
381 (@var{host} is optional). @option{connect} is used to connect to
382 another QEMU instance using the @option{listen} option. @option{fd=h}
383 specifies an already opened TCP socket.
387 # launch a first QEMU instance
388 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
389 -net socket,listen=:1234
390 # connect the VLAN 0 of this instance to the VLAN 0
391 # of the first instance
392 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
393 -net socket,connect=127.0.0.1:1234
396 @item -net socket[,vlan=n][,fd=h][,mcast=maddr:port]
398 Create a VLAN @var{n} shared with another QEMU virtual
399 machines using a UDP multicast socket, effectively making a bus for
400 every QEMU with same multicast address @var{maddr} and @var{port}.
404 Several QEMU can be running on different hosts and share same bus (assuming
405 correct multicast setup for these hosts).
407 mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
408 @url{http://user-mode-linux.sf.net}.
409 @item Use @option{fd=h} to specify an already opened UDP multicast socket.
414 # launch one QEMU instance
415 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
416 -net socket,mcast=230.0.0.1:1234
417 # launch another QEMU instance on same "bus"
418 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
419 -net socket,mcast=230.0.0.1:1234
420 # launch yet another QEMU instance on same "bus"
421 qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
422 -net socket,mcast=230.0.0.1:1234
425 Example (User Mode Linux compat.):
427 # launch QEMU instance (note mcast address selected
429 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
430 -net socket,mcast=239.192.168.1:1102
432 /path/to/linux ubd0=/path/to/root_fs eth0=mcast
436 Indicate that no network devices should be configured. It is used to
437 override the default configuration (@option{-net nic -net user}) which
438 is activated if no @option{-net} options are provided.
441 When using the user mode network stack, activate a built-in TFTP
442 server. All filenames beginning with @var{prefix} can be downloaded
443 from the host to the guest using a TFTP client. The TFTP client on the
444 guest must be configured in binary mode (use the command @code{bin} of
445 the Unix TFTP client). The host IP address on the guest is as usual
449 When using the user mode network stack, activate a built-in SMB
450 server so that Windows OSes can access to the host files in @file{dir}
453 In the guest Windows OS, the line:
457 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
458 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
460 Then @file{dir} can be accessed in @file{\\smbserver\qemu}.
462 Note that a SAMBA server must be installed on the host OS in
463 @file{/usr/sbin/smbd}. QEMU was tested successfully with smbd version
464 2.2.7a from the Red Hat 9 and version 3.0.10-1.fc3 from Fedora Core 3.
466 @item -redir [tcp|udp]:host-port:[guest-host]:guest-port
468 When using the user mode network stack, redirect incoming TCP or UDP
469 connections to the host port @var{host-port} to the guest
470 @var{guest-host} on guest port @var{guest-port}. If @var{guest-host}
471 is not specified, its value is 10.0.2.15 (default address given by the
472 built-in DHCP server).
474 For example, to redirect host X11 connection from screen 1 to guest
475 screen 0, use the following:
479 qemu -redir tcp:6001::6000 [...]
480 # this host xterm should open in the guest X11 server
484 To redirect telnet connections from host port 5555 to telnet port on
485 the guest, use the following:
489 qemu -redir tcp:5555::23 [...]
490 telnet localhost 5555
493 Then when you use on the host @code{telnet localhost 5555}, you
494 connect to the guest telnet server.
498 Linux boot specific: When using these options, you can use a given
499 Linux kernel without installing it in the disk image. It can be useful
500 for easier testing of various kernels.
504 @item -kernel bzImage
505 Use @var{bzImage} as kernel image.
507 @item -append cmdline
508 Use @var{cmdline} as kernel command line
511 Use @var{file} as initial ram disk.
515 Debug/Expert options:
519 Redirect the virtual serial port to host character device
520 @var{dev}. The default device is @code{vc} in graphical mode and
521 @code{stdio} in non graphical mode.
523 This option can be used several times to simulate up to 4 serials
526 Use @code{-serial none} to disable all serial ports.
528 Available character devices are:
533 [Linux only] Pseudo TTY (a new PTY is automatically allocated)
535 No device is allocated.
539 [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
540 parameters are set according to the emulated ones.
542 [Linux only, parallel port only] Use host parallel port
543 @var{N}. Currently only SPP parallel port features can be used.
545 Write output to filename. No character can be read.
547 [Unix only] standard input/output
549 name pipe @var{filename}
551 [Windows only] Use host serial port @var{n}
552 @item udp:[remote_host]:remote_port[@@[src_ip]:src_port]
553 This implements UDP Net Console. When @var{remote_host} or @var{src_ip} are not specified they default to @code{0.0.0.0}. When not using a specifed @var{src_port} a random port is automatically chosen.
555 If you just want a simple readonly console you can use @code{netcat} or
556 @code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
557 @code{nc -u -l -p 4555}. Any time qemu writes something to that port it
558 will appear in the netconsole session.
560 If you plan to send characters back via netconsole or you want to stop
561 and start qemu a lot of times, you should have qemu use the same
562 source port each time by using something like @code{-serial
563 udp::4555@@:4556} to qemu. Another approach is to use a patched
564 version of netcat which can listen to a TCP port and send and receive
565 characters via udp. If you have a patched version of netcat which
566 activates telnet remote echo and single char transfer, then you can
567 use the following options to step up a netcat redirector to allow
568 telnet on port 5555 to access the qemu port.
571 -serial udp::4555@@:4556
572 @item netcat options:
573 -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
574 @item telnet options:
579 @item tcp:[host]:port[,server][,nowait][,nodelay]
580 The TCP Net Console has two modes of operation. It can send the serial
581 I/O to a location or wait for a connection from a location. By default
582 the TCP Net Console is sent to @var{host} at the @var{port}. If you use
583 the @var{server} option QEMU will wait for a client socket application
584 to connect to the port before continuing, unless the @code{nowait}
585 option was specified. The @code{nodelay} option disables the Nagle buffering
586 algoritm. If @var{host} is omitted, 0.0.0.0 is assumed. Only
587 one TCP connection at a time is accepted. You can use @code{telnet} to
588 connect to the corresponding character device.
590 @item Example to send tcp console to 192.168.0.2 port 4444
591 -serial tcp:192.168.0.2:4444
592 @item Example to listen and wait on port 4444 for connection
593 -serial tcp::4444,server
594 @item Example to not wait and listen on ip 192.168.0.100 port 4444
595 -serial tcp:192.168.0.100:4444,server,nowait
598 @item telnet:host:port[,server][,nowait][,nodelay]
599 The telnet protocol is used instead of raw tcp sockets. The options
600 work the same as if you had specified @code{-serial tcp}. The
601 difference is that the port acts like a telnet server or client using
602 telnet option negotiation. This will also allow you to send the
603 MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
604 sequence. Typically in unix telnet you do it with Control-] and then
605 type "send break" followed by pressing the enter key.
607 @item unix:path[,server][,nowait]
608 A unix domain socket is used instead of a tcp socket. The option works the
609 same as if you had specified @code{-serial tcp} except the unix domain socket
610 @var{path} is used for connections.
615 Redirect the virtual parallel port to host device @var{dev} (same
616 devices as the serial port). On Linux hosts, @file{/dev/parportN} can
617 be used to use hardware devices connected on the corresponding host
620 This option can be used several times to simulate up to 3 parallel
623 Use @code{-parallel none} to disable all parallel ports.
626 Redirect the monitor to host device @var{dev} (same devices as the
628 The default device is @code{vc} in graphical mode and @code{stdio} in
632 Wait gdb connection to port 1234 (@pxref{gdb_usage}).
634 Change gdb connection port.
636 Do not start CPU at startup (you must type 'c' in the monitor).
638 Output log in /tmp/qemu.log
639 @item -hdachs c,h,s,[,t]
640 Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
641 @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
642 translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
643 all thoses parameters. This option is useful for old MS-DOS disk
647 Set the directory for the BIOS, VGA BIOS and keymaps.
650 Simulate a standard VGA card with Bochs VBE extensions (default is
651 Cirrus Logic GD5446 PCI VGA). If your guest OS supports the VESA 2.0
652 VBE extensions (e.g. Windows XP) and if you want to use high
653 resolution modes (>= 1280x1024x16) then you should use this option.
656 Disable ACPI (Advanced Configuration and Power Interface) support. Use
657 it if your guest OS complains about ACPI problems (PC target machine
661 Exit instead of rebooting.
664 Start right away with a saved state (@code{loadvm} in monitor)
667 Enable "Angel" semihosting interface (ARM target machines only).
668 Note that this allows guest direct access to the host filesystem,
669 so should only be used with trusted guest OS.
679 During the graphical emulation, you can use the following keys:
685 Switch to virtual console 'n'. Standard console mappings are:
688 Target system display
696 Toggle mouse and keyboard grab.
699 In the virtual consoles, you can use @key{Ctrl-Up}, @key{Ctrl-Down},
700 @key{Ctrl-PageUp} and @key{Ctrl-PageDown} to move in the back log.
702 During emulation, if you are using the @option{-nographic} option, use
703 @key{Ctrl-a h} to get terminal commands:
711 Save disk data back to file (if -snapshot)
713 Send break (magic sysrq in Linux)
715 Switch between console and monitor
724 The HTML documentation of QEMU for more precise information and Linux
725 user mode emulator invocation.
735 @section QEMU Monitor
737 The QEMU monitor is used to give complex commands to the QEMU
738 emulator. You can use it to:
743 Remove or insert removable medias images
744 (such as CD-ROM or floppies)
747 Freeze/unfreeze the Virtual Machine (VM) and save or restore its state
750 @item Inspect the VM state without an external debugger.
756 The following commands are available:
760 @item help or ? [cmd]
761 Show the help for all commands or just for command @var{cmd}.
764 Commit changes to the disk images (if -snapshot is used)
766 @item info subcommand
767 show various information about the system state
771 show the various VLANs and the associated devices
773 show the block devices
775 show the cpu registers
777 show the command line history
779 show emulated PCI device
781 show USB devices plugged on the virtual USB hub
783 show all USB host devices
785 show information about active capturing
787 show list of VM snapshots
789 show which guest mouse is receiving events
795 @item eject [-f] device
796 Eject a removable media (use -f to force it).
798 @item change device filename
799 Change a removable media.
801 @item screendump filename
802 Save screen into PPM image @var{filename}.
804 @item mouse_move dx dy [dz]
805 Move the active mouse to the specified coordinates @var{dx} @var{dy}
806 with optional scroll axis @var{dz}.
808 @item mouse_button val
809 Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
811 @item mouse_set index
812 Set which mouse device receives events at given @var{index}, index
818 @item wavcapture filename [frequency [bits [channels]]]
819 Capture audio into @var{filename}. Using sample rate @var{frequency}
820 bits per sample @var{bits} and number of channels @var{channels}.
824 @item Sample rate = 44100 Hz - CD quality
826 @item Number of channels = 2 - Stereo
829 @item stopcapture index
830 Stop capture with a given @var{index}, index can be obtained with
835 @item log item1[,...]
836 Activate logging of the specified items to @file{/tmp/qemu.log}.
838 @item savevm [tag|id]
839 Create a snapshot of the whole virtual machine. If @var{tag} is
840 provided, it is used as human readable identifier. If there is already
841 a snapshot with the same tag or ID, it is replaced. More info at
845 Set the whole virtual machine to the snapshot identified by the tag
846 @var{tag} or the unique snapshot ID @var{id}.
849 Delete the snapshot identified by @var{tag} or @var{id}.
857 @item gdbserver [port]
858 Start gdbserver session (default port=1234)
861 Virtual memory dump starting at @var{addr}.
864 Physical memory dump starting at @var{addr}.
866 @var{fmt} is a format which tells the command how to format the
867 data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
871 is the number of items to be dumped.
874 can be x (hexa), d (signed decimal), u (unsigned decimal), o (octal),
875 c (char) or i (asm instruction).
878 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
879 @code{h} or @code{w} can be specified with the @code{i} format to
880 respectively select 16 or 32 bit code instruction size.
887 Dump 10 instructions at the current instruction pointer:
892 0x90107065: lea 0x0(%esi,1),%esi
893 0x90107069: lea 0x0(%edi,1),%edi
895 0x90107071: jmp 0x90107080
903 Dump 80 16 bit values at the start of the video memory.
905 (qemu) xp/80hx 0xb8000
906 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
907 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
908 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
909 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
910 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
911 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
912 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
913 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
914 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
915 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
919 @item p or print/fmt expr
921 Print expression value. Only the @var{format} part of @var{fmt} is
926 Send @var{keys} to the emulator. Use @code{-} to press several keys
927 simultaneously. Example:
932 This command is useful to send keys that your graphical user interface
933 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
939 @item usb_add devname
941 Add the USB device @var{devname}. For details of available devices see
944 @item usb_del devname
946 Remove the USB device @var{devname} from the QEMU virtual USB
947 hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
948 command @code{info usb} to see the devices you can remove.
952 @subsection Integer expressions
954 The monitor understands integers expressions for every integer
955 argument. You can use register names to get the value of specifics
956 CPU registers by prefixing them with @emph{$}.
961 Since version 0.6.1, QEMU supports many disk image formats, including
962 growable disk images (their size increase as non empty sectors are
963 written), compressed and encrypted disk images. Version 0.8.3 added
964 the new qcow2 disk image format which is essential to support VM
968 * disk_images_quickstart:: Quick start for disk image creation
969 * disk_images_snapshot_mode:: Snapshot mode
970 * vm_snapshots:: VM snapshots
971 * qemu_img_invocation:: qemu-img Invocation
972 * host_drives:: Using host drives
973 * disk_images_fat_images:: Virtual FAT disk images
976 @node disk_images_quickstart
977 @subsection Quick start for disk image creation
979 You can create a disk image with the command:
981 qemu-img create myimage.img mysize
983 where @var{myimage.img} is the disk image filename and @var{mysize} is its
984 size in kilobytes. You can add an @code{M} suffix to give the size in
985 megabytes and a @code{G} suffix for gigabytes.
987 See @ref{qemu_img_invocation} for more information.
989 @node disk_images_snapshot_mode
990 @subsection Snapshot mode
992 If you use the option @option{-snapshot}, all disk images are
993 considered as read only. When sectors in written, they are written in
994 a temporary file created in @file{/tmp}. You can however force the
995 write back to the raw disk images by using the @code{commit} monitor
996 command (or @key{C-a s} in the serial console).
999 @subsection VM snapshots
1001 VM snapshots are snapshots of the complete virtual machine including
1002 CPU state, RAM, device state and the content of all the writable
1003 disks. In order to use VM snapshots, you must have at least one non
1004 removable and writable block device using the @code{qcow2} disk image
1005 format. Normally this device is the first virtual hard drive.
1007 Use the monitor command @code{savevm} to create a new VM snapshot or
1008 replace an existing one. A human readable name can be assigned to each
1009 snapshot in addition to its numerical ID.
1011 Use @code{loadvm} to restore a VM snapshot and @code{delvm} to remove
1012 a VM snapshot. @code{info snapshots} lists the available snapshots
1013 with their associated information:
1016 (qemu) info snapshots
1017 Snapshot devices: hda
1018 Snapshot list (from hda):
1019 ID TAG VM SIZE DATE VM CLOCK
1020 1 start 41M 2006-08-06 12:38:02 00:00:14.954
1021 2 40M 2006-08-06 12:43:29 00:00:18.633
1022 3 msys 40M 2006-08-06 12:44:04 00:00:23.514
1025 A VM snapshot is made of a VM state info (its size is shown in
1026 @code{info snapshots}) and a snapshot of every writable disk image.
1027 The VM state info is stored in the first @code{qcow2} non removable
1028 and writable block device. The disk image snapshots are stored in
1029 every disk image. The size of a snapshot in a disk image is difficult
1030 to evaluate and is not shown by @code{info snapshots} because the
1031 associated disk sectors are shared among all the snapshots to save
1032 disk space (otherwise each snapshot would need a full copy of all the
1035 When using the (unrelated) @code{-snapshot} option
1036 (@ref{disk_images_snapshot_mode}), you can always make VM snapshots,
1037 but they are deleted as soon as you exit QEMU.
1039 VM snapshots currently have the following known limitations:
1042 They cannot cope with removable devices if they are removed or
1043 inserted after a snapshot is done.
1045 A few device drivers still have incomplete snapshot support so their
1046 state is not saved or restored properly (in particular USB).
1049 @node qemu_img_invocation
1050 @subsection @code{qemu-img} Invocation
1052 @include qemu-img.texi
1055 @subsection Using host drives
1057 In addition to disk image files, QEMU can directly access host
1058 devices. We describe here the usage for QEMU version >= 0.8.3.
1060 @subsubsection Linux
1062 On Linux, you can directly use the host device filename instead of a
1063 disk image filename provided you have enough proviledge to access
1064 it. For example, use @file{/dev/cdrom} to access to the CDROM or
1065 @file{/dev/fd0} for the floppy.
1069 You can specify a CDROM device even if no CDROM is loaded. QEMU has
1070 specific code to detect CDROM insertion or removal. CDROM ejection by
1071 the guest OS is supported. Currently only data CDs are supported.
1073 You can specify a floppy device even if no floppy is loaded. Floppy
1074 removal is currently not detected accurately (if you change floppy
1075 without doing floppy access while the floppy is not loaded, the guest
1076 OS will think that the same floppy is loaded).
1078 Hard disks can be used. Normally you must specify the whole disk
1079 (@file{/dev/hdb} instead of @file{/dev/hdb1}) so that the guest OS can
1080 see it as a partitioned disk. WARNING: unless you know what you do, it
1081 is better to only make READ-ONLY accesses to the hard disk otherwise
1082 you may corrupt your host data (use the @option{-snapshot} command
1083 line option or modify the device permissions accordingly).
1086 @subsubsection Windows
1090 The prefered syntax is the drive letter (e.g. @file{d:}). The
1091 alternate syntax @file{\\.\d:} is supported. @file{/dev/cdrom} is
1092 supported as an alias to the first CDROM drive.
1094 Currently there is no specific code to handle removable medias, so it
1095 is better to use the @code{change} or @code{eject} monitor commands to
1096 change or eject media.
1098 Hard disks can be used with the syntax: @file{\\.\PhysicalDriveN}
1099 where @var{N} is the drive number (0 is the first hard disk).
1101 WARNING: unless you know what you do, it is better to only make
1102 READ-ONLY accesses to the hard disk otherwise you may corrupt your
1103 host data (use the @option{-snapshot} command line so that the
1104 modifications are written in a temporary file).
1108 @subsubsection Mac OS X
1110 @file{/dev/cdrom} is an alias to the first CDROM.
1112 Currently there is no specific code to handle removable medias, so it
1113 is better to use the @code{change} or @code{eject} monitor commands to
1114 change or eject media.
1116 @node disk_images_fat_images
1117 @subsection Virtual FAT disk images
1119 QEMU can automatically create a virtual FAT disk image from a
1120 directory tree. In order to use it, just type:
1123 qemu linux.img -hdb fat:/my_directory
1126 Then you access access to all the files in the @file{/my_directory}
1127 directory without having to copy them in a disk image or to export
1128 them via SAMBA or NFS. The default access is @emph{read-only}.
1130 Floppies can be emulated with the @code{:floppy:} option:
1133 qemu linux.img -fda fat:floppy:/my_directory
1136 A read/write support is available for testing (beta stage) with the
1140 qemu linux.img -fda fat:floppy:rw:/my_directory
1143 What you should @emph{never} do:
1145 @item use non-ASCII filenames ;
1146 @item use "-snapshot" together with ":rw:" ;
1147 @item expect it to work when loadvm'ing ;
1148 @item write to the FAT directory on the host system while accessing it with the guest system.
1152 @section Network emulation
1154 QEMU can simulate several networks cards (NE2000 boards on the PC
1155 target) and can connect them to an arbitrary number of Virtual Local
1156 Area Networks (VLANs). Host TAP devices can be connected to any QEMU
1157 VLAN. VLAN can be connected between separate instances of QEMU to
1158 simulate large networks. For simpler usage, a non priviledged user mode
1159 network stack can replace the TAP device to have a basic network
1164 QEMU simulates several VLANs. A VLAN can be symbolised as a virtual
1165 connection between several network devices. These devices can be for
1166 example QEMU virtual Ethernet cards or virtual Host ethernet devices
1169 @subsection Using TAP network interfaces
1171 This is the standard way to connect QEMU to a real network. QEMU adds
1172 a virtual network device on your host (called @code{tapN}), and you
1173 can then configure it as if it was a real ethernet card.
1175 @subsubsection Linux host
1177 As an example, you can download the @file{linux-test-xxx.tar.gz}
1178 archive and copy the script @file{qemu-ifup} in @file{/etc} and
1179 configure properly @code{sudo} so that the command @code{ifconfig}
1180 contained in @file{qemu-ifup} can be executed as root. You must verify
1181 that your host kernel supports the TAP network interfaces: the
1182 device @file{/dev/net/tun} must be present.
1184 See @ref{sec_invocation} to have examples of command lines using the
1185 TAP network interfaces.
1187 @subsubsection Windows host
1189 There is a virtual ethernet driver for Windows 2000/XP systems, called
1190 TAP-Win32. But it is not included in standard QEMU for Windows,
1191 so you will need to get it separately. It is part of OpenVPN package,
1192 so download OpenVPN from : @url{http://openvpn.net/}.
1194 @subsection Using the user mode network stack
1196 By using the option @option{-net user} (default configuration if no
1197 @option{-net} option is specified), QEMU uses a completely user mode
1198 network stack (you don't need root priviledge to use the virtual
1199 network). The virtual network configuration is the following:
1203 QEMU VLAN <------> Firewall/DHCP server <-----> Internet
1206 ----> DNS server (10.0.2.3)
1208 ----> SMB server (10.0.2.4)
1211 The QEMU VM behaves as if it was behind a firewall which blocks all
1212 incoming connections. You can use a DHCP client to automatically
1213 configure the network in the QEMU VM. The DHCP server assign addresses
1214 to the hosts starting from 10.0.2.15.
1216 In order to check that the user mode network is working, you can ping
1217 the address 10.0.2.2 and verify that you got an address in the range
1218 10.0.2.x from the QEMU virtual DHCP server.
1220 Note that @code{ping} is not supported reliably to the internet as it
1221 would require root priviledges. It means you can only ping the local
1224 When using the built-in TFTP server, the router is also the TFTP
1227 When using the @option{-redir} option, TCP or UDP connections can be
1228 redirected from the host to the guest. It allows for example to
1229 redirect X11, telnet or SSH connections.
1231 @subsection Connecting VLANs between QEMU instances
1233 Using the @option{-net socket} option, it is possible to make VLANs
1234 that span several QEMU instances. See @ref{sec_invocation} to have a
1237 @node direct_linux_boot
1238 @section Direct Linux Boot
1240 This section explains how to launch a Linux kernel inside QEMU without
1241 having to make a full bootable image. It is very useful for fast Linux
1246 qemu -kernel arch/i386/boot/bzImage -hda root-2.4.20.img -append "root=/dev/hda"
1249 Use @option{-kernel} to provide the Linux kernel image and
1250 @option{-append} to give the kernel command line arguments. The
1251 @option{-initrd} option can be used to provide an INITRD image.
1253 When using the direct Linux boot, a disk image for the first hard disk
1254 @file{hda} is required because its boot sector is used to launch the
1257 If you do not need graphical output, you can disable it and redirect
1258 the virtual serial port and the QEMU monitor to the console with the
1259 @option{-nographic} option. The typical command line is:
1261 qemu -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1262 -append "root=/dev/hda console=ttyS0" -nographic
1265 Use @key{Ctrl-a c} to switch between the serial console and the
1266 monitor (@pxref{pcsys_keys}).
1269 @section USB emulation
1271 QEMU emulates a PCI UHCI USB controller. You can virtually plug
1272 virtual USB devices or real host USB devices (experimental, works only
1273 on Linux hosts). Qemu will automatically create and connect virtual USB hubs
1274 as necessary to connect multiple USB devices.
1278 * host_usb_devices::
1281 @subsection Connecting USB devices
1283 USB devices can be connected with the @option{-usbdevice} commandline option
1284 or the @code{usb_add} monitor command. Available devices are:
1288 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
1290 Pointer device that uses absolute coordinates (like a touchscreen).
1291 This means qemu is able to report the mouse position without having
1292 to grab the mouse. Also overrides the PS/2 mouse emulation when activated.
1293 @item @code{disk:file}
1294 Mass storage device based on @var{file} (@pxref{disk_images})
1295 @item @code{host:bus.addr}
1296 Pass through the host device identified by @var{bus.addr}
1298 @item @code{host:vendor_id:product_id}
1299 Pass through the host device identified by @var{vendor_id:product_id}
1303 @node host_usb_devices
1304 @subsection Using host USB devices on a Linux host
1306 WARNING: this is an experimental feature. QEMU will slow down when
1307 using it. USB devices requiring real time streaming (i.e. USB Video
1308 Cameras) are not supported yet.
1311 @item If you use an early Linux 2.4 kernel, verify that no Linux driver
1312 is actually using the USB device. A simple way to do that is simply to
1313 disable the corresponding kernel module by renaming it from @file{mydriver.o}
1314 to @file{mydriver.o.disabled}.
1316 @item Verify that @file{/proc/bus/usb} is working (most Linux distributions should enable it by default). You should see something like that:
1322 @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:
1324 chown -R myuid /proc/bus/usb
1327 @item Launch QEMU and do in the monitor:
1330 Device 1.2, speed 480 Mb/s
1331 Class 00: USB device 1234:5678, USB DISK
1333 You should see the list of the devices you can use (Never try to use
1334 hubs, it won't work).
1336 @item Add the device in QEMU by using:
1338 usb_add host:1234:5678
1341 Normally the guest OS should report that a new USB device is
1342 plugged. You can use the option @option{-usbdevice} to do the same.
1344 @item Now you can try to use the host USB device in QEMU.
1348 When relaunching QEMU, you may have to unplug and plug again the USB
1349 device to make it work again (this is a bug).
1354 QEMU has a primitive support to work with gdb, so that you can do
1355 'Ctrl-C' while the virtual machine is running and inspect its state.
1357 In order to use gdb, launch qemu with the '-s' option. It will wait for a
1360 > qemu -s -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1361 -append "root=/dev/hda"
1362 Connected to host network interface: tun0
1363 Waiting gdb connection on port 1234
1366 Then launch gdb on the 'vmlinux' executable:
1371 In gdb, connect to QEMU:
1373 (gdb) target remote localhost:1234
1376 Then you can use gdb normally. For example, type 'c' to launch the kernel:
1381 Here are some useful tips in order to use gdb on system code:
1385 Use @code{info reg} to display all the CPU registers.
1387 Use @code{x/10i $eip} to display the code at the PC position.
1389 Use @code{set architecture i8086} to dump 16 bit code. Then use
1390 @code{x/10i $cs*16+$eip} to dump the code at the PC position.
1393 @node pcsys_os_specific
1394 @section Target OS specific information
1398 To have access to SVGA graphic modes under X11, use the @code{vesa} or
1399 the @code{cirrus} X11 driver. For optimal performances, use 16 bit
1400 color depth in the guest and the host OS.
1402 When using a 2.6 guest Linux kernel, you should add the option
1403 @code{clock=pit} on the kernel command line because the 2.6 Linux
1404 kernels make very strict real time clock checks by default that QEMU
1405 cannot simulate exactly.
1407 When using a 2.6 guest Linux kernel, verify that the 4G/4G patch is
1408 not activated because QEMU is slower with this patch. The QEMU
1409 Accelerator Module is also much slower in this case. Earlier Fedora
1410 Core 3 Linux kernel (< 2.6.9-1.724_FC3) were known to incorporte this
1411 patch by default. Newer kernels don't have it.
1415 If you have a slow host, using Windows 95 is better as it gives the
1416 best speed. Windows 2000 is also a good choice.
1418 @subsubsection SVGA graphic modes support
1420 QEMU emulates a Cirrus Logic GD5446 Video
1421 card. All Windows versions starting from Windows 95 should recognize
1422 and use this graphic card. For optimal performances, use 16 bit color
1423 depth in the guest and the host OS.
1425 If you are using Windows XP as guest OS and if you want to use high
1426 resolution modes which the Cirrus Logic BIOS does not support (i.e. >=
1427 1280x1024x16), then you should use the VESA VBE virtual graphic card
1428 (option @option{-std-vga}).
1430 @subsubsection CPU usage reduction
1432 Windows 9x does not correctly use the CPU HLT
1433 instruction. The result is that it takes host CPU cycles even when
1434 idle. You can install the utility from
1435 @url{http://www.user.cityline.ru/~maxamn/amnhltm.zip} to solve this
1436 problem. Note that no such tool is needed for NT, 2000 or XP.
1438 @subsubsection Windows 2000 disk full problem
1440 Windows 2000 has a bug which gives a disk full problem during its
1441 installation. When installing it, use the @option{-win2k-hack} QEMU
1442 option to enable a specific workaround. After Windows 2000 is
1443 installed, you no longer need this option (this option slows down the
1446 @subsubsection Windows 2000 shutdown
1448 Windows 2000 cannot automatically shutdown in QEMU although Windows 98
1449 can. It comes from the fact that Windows 2000 does not automatically
1450 use the APM driver provided by the BIOS.
1452 In order to correct that, do the following (thanks to Struan
1453 Bartlett): go to the Control Panel => Add/Remove Hardware & Next =>
1454 Add/Troubleshoot a device => Add a new device & Next => No, select the
1455 hardware from a list & Next => NT Apm/Legacy Support & Next => Next
1456 (again) a few times. Now the driver is installed and Windows 2000 now
1457 correctly instructs QEMU to shutdown at the appropriate moment.
1459 @subsubsection Share a directory between Unix and Windows
1461 See @ref{sec_invocation} about the help of the option @option{-smb}.
1463 @subsubsection Windows XP security problem
1465 Some releases of Windows XP install correctly but give a security
1468 A problem is preventing Windows from accurately checking the
1469 license for this computer. Error code: 0x800703e6.
1472 The workaround is to install a service pack for XP after a boot in safe
1473 mode. Then reboot, and the problem should go away. Since there is no
1474 network while in safe mode, its recommended to download the full
1475 installation of SP1 or SP2 and transfer that via an ISO or using the
1476 vvfat block device ("-hdb fat:directory_which_holds_the_SP").
1478 @subsection MS-DOS and FreeDOS
1480 @subsubsection CPU usage reduction
1482 DOS does not correctly use the CPU HLT instruction. The result is that
1483 it takes host CPU cycles even when idle. You can install the utility
1484 from @url{http://www.vmware.com/software/dosidle210.zip} to solve this
1487 @node QEMU System emulator for non PC targets
1488 @chapter QEMU System emulator for non PC targets
1490 QEMU is a generic emulator and it emulates many non PC
1491 machines. Most of the options are similar to the PC emulator. The
1492 differences are mentionned in the following sections.
1495 * QEMU PowerPC System emulator::
1496 * Sparc32 System emulator invocation::
1497 * Sparc64 System emulator invocation::
1498 * MIPS System emulator invocation::
1499 * ARM System emulator invocation::
1502 @node QEMU PowerPC System emulator
1503 @section QEMU PowerPC System emulator
1505 Use the executable @file{qemu-system-ppc} to simulate a complete PREP
1506 or PowerMac PowerPC system.
1508 QEMU emulates the following PowerMac peripherals:
1514 PCI VGA compatible card with VESA Bochs Extensions
1516 2 PMAC IDE interfaces with hard disk and CD-ROM support
1522 VIA-CUDA with ADB keyboard and mouse.
1525 QEMU emulates the following PREP peripherals:
1531 PCI VGA compatible card with VESA Bochs Extensions
1533 2 IDE interfaces with hard disk and CD-ROM support
1537 NE2000 network adapters
1541 PREP Non Volatile RAM
1543 PC compatible keyboard and mouse.
1546 QEMU uses the Open Hack'Ware Open Firmware Compatible BIOS available at
1547 @url{http://perso.magic.fr/l_indien/OpenHackWare/index.htm}.
1549 @c man begin OPTIONS
1551 The following options are specific to the PowerPC emulation:
1555 @item -g WxH[xDEPTH]
1557 Set the initial VGA graphic mode. The default is 800x600x15.
1564 More information is available at
1565 @url{http://perso.magic.fr/l_indien/qemu-ppc/}.
1567 @node Sparc32 System emulator invocation
1568 @section Sparc32 System emulator invocation
1570 Use the executable @file{qemu-system-sparc} to simulate a SparcStation 5
1571 (sun4m architecture). The emulation is somewhat complete.
1573 QEMU emulates the following sun4m peripherals:
1581 Lance (Am7990) Ethernet
1583 Non Volatile RAM M48T08
1585 Slave I/O: timers, interrupt controllers, Zilog serial ports, keyboard
1586 and power/reset logic
1588 ESP SCSI controller with hard disk and CD-ROM support
1593 The number of peripherals is fixed in the architecture.
1595 Since version 0.8.2, QEMU uses OpenBIOS
1596 @url{http://www.openbios.org/}. OpenBIOS is a free (GPL v2) portable
1597 firmware implementation. The goal is to implement a 100% IEEE
1598 1275-1994 (referred to as Open Firmware) compliant firmware.
1600 A sample Linux 2.6 series kernel and ram disk image are available on
1601 the QEMU web site. Please note that currently NetBSD, OpenBSD or
1602 Solaris kernels don't work.
1604 @c man begin OPTIONS
1606 The following options are specific to the Sparc emulation:
1612 Set the initial TCX graphic mode. The default is 1024x768.
1618 @node Sparc64 System emulator invocation
1619 @section Sparc64 System emulator invocation
1621 Use the executable @file{qemu-system-sparc64} to simulate a Sun4u machine.
1622 The emulator is not usable for anything yet.
1624 QEMU emulates the following sun4u peripherals:
1628 UltraSparc IIi APB PCI Bridge
1630 PCI VGA compatible card with VESA Bochs Extensions
1632 Non Volatile RAM M48T59
1634 PC-compatible serial ports
1637 @node MIPS System emulator invocation
1638 @section MIPS System emulator invocation
1640 Use the executable @file{qemu-system-mips} to simulate a MIPS machine.
1641 The emulator is able to boot a Linux kernel and to run a Linux Debian
1642 installation from NFS. The following devices are emulated:
1648 PC style serial port
1653 More information is available in the QEMU mailing-list archive.
1655 @node ARM System emulator invocation
1656 @section ARM System emulator invocation
1658 Use the executable @file{qemu-system-arm} to simulate a ARM
1659 machine. The ARM Integrator/CP board is emulated with the following
1664 ARM926E or ARM1026E CPU
1668 SMC 91c111 Ethernet adapter
1670 PL110 LCD controller
1672 PL050 KMI with PS/2 keyboard and mouse.
1675 The ARM Versatile baseboard is emulated with the following devices:
1681 PL190 Vectored Interrupt Controller
1685 SMC 91c111 Ethernet adapter
1687 PL110 LCD controller
1689 PL050 KMI with PS/2 keyboard and mouse.
1691 PCI host bridge. Note the emulated PCI bridge only provides access to
1692 PCI memory space. It does not provide access to PCI IO space.
1693 This means some devices (eg. ne2k_pci NIC) are not useable, and others
1694 (eg. rtl8139 NIC) are only useable when the guest drivers use the memory
1695 mapped control registers.
1697 PCI OHCI USB controller.
1699 LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices.
1702 A Linux 2.6 test image is available on the QEMU web site. More
1703 information is available in the QEMU mailing-list archive.
1705 @node QEMU Linux User space emulator
1706 @chapter QEMU Linux User space emulator
1711 * Command line options::
1716 @section Quick Start
1718 In order to launch a Linux process, QEMU needs the process executable
1719 itself and all the target (x86) dynamic libraries used by it.
1723 @item On x86, you can just try to launch any process by using the native
1727 qemu-i386 -L / /bin/ls
1730 @code{-L /} tells that the x86 dynamic linker must be searched with a
1733 @item Since QEMU is also a linux process, you can launch qemu with qemu (NOTE: you can only do that if you compiled QEMU from the sources):
1736 qemu-i386 -L / qemu-i386 -L / /bin/ls
1739 @item On non x86 CPUs, you need first to download at least an x86 glibc
1740 (@file{qemu-runtime-i386-XXX-.tar.gz} on the QEMU web page). Ensure that
1741 @code{LD_LIBRARY_PATH} is not set:
1744 unset LD_LIBRARY_PATH
1747 Then you can launch the precompiled @file{ls} x86 executable:
1750 qemu-i386 tests/i386/ls
1752 You can look at @file{qemu-binfmt-conf.sh} so that
1753 QEMU is automatically launched by the Linux kernel when you try to
1754 launch x86 executables. It requires the @code{binfmt_misc} module in the
1757 @item The x86 version of QEMU is also included. You can try weird things such as:
1759 qemu-i386 /usr/local/qemu-i386/bin/qemu-i386 \
1760 /usr/local/qemu-i386/bin/ls-i386
1766 @section Wine launch
1770 @item Ensure that you have a working QEMU with the x86 glibc
1771 distribution (see previous section). In order to verify it, you must be
1775 qemu-i386 /usr/local/qemu-i386/bin/ls-i386
1778 @item Download the binary x86 Wine install
1779 (@file{qemu-XXX-i386-wine.tar.gz} on the QEMU web page).
1781 @item Configure Wine on your account. Look at the provided script
1782 @file{/usr/local/qemu-i386/@/bin/wine-conf.sh}. Your previous
1783 @code{$@{HOME@}/.wine} directory is saved to @code{$@{HOME@}/.wine.org}.
1785 @item Then you can try the example @file{putty.exe}:
1788 qemu-i386 /usr/local/qemu-i386/wine/bin/wine \
1789 /usr/local/qemu-i386/wine/c/Program\ Files/putty.exe
1794 @node Command line options
1795 @section Command line options
1798 usage: qemu-i386 [-h] [-d] [-L path] [-s size] program [arguments...]
1805 Set the x86 elf interpreter prefix (default=/usr/local/qemu-i386)
1807 Set the x86 stack size in bytes (default=524288)
1814 Activate log (logfile=/tmp/qemu.log)
1816 Act as if the host page size was 'pagesize' bytes
1819 @node Other binaries
1820 @section Other binaries
1822 @command{qemu-arm} is also capable of running ARM "Angel" semihosted ELF
1823 binaries (as implemented by the arm-elf and arm-eabi Newlib/GDB
1824 configurations), and arm-uclinux bFLT format binaries.
1826 @command{qemu-m68k} is capable of running semihosted binaries using the BDM
1827 (m5xxx-ram-hosted.ld) or m68k-sim (sim.ld) syscall interfaces, and
1828 coldfire uClinux bFLT format binaries.
1830 The binary format is detected automatically.
1833 @chapter Compilation from the sources
1838 * Cross compilation for Windows with Linux::
1845 @subsection Compilation
1847 First you must decompress the sources:
1850 tar zxvf qemu-x.y.z.tar.gz
1854 Then you configure QEMU and build it (usually no options are needed):
1860 Then type as root user:
1864 to install QEMU in @file{/usr/local}.
1866 @subsection Tested tool versions
1868 In order to compile QEMU successfully, it is very important that you
1869 have the right tools. The most important one is gcc. I cannot guaranty
1870 that QEMU works if you do not use a tested gcc version. Look at
1871 'configure' and 'Makefile' if you want to make a different gcc
1875 host gcc binutils glibc linux distribution
1876 ----------------------------------------------------------------------
1877 x86 3.2 2.13.2 2.1.3 2.4.18
1878 2.96 2.11.93.0.2 2.2.5 2.4.18 Red Hat 7.3
1879 3.2.2 2.13.90.0.18 2.3.2 2.4.20 Red Hat 9
1881 PowerPC 3.3 [4] 2.13.90.0.18 2.3.1 2.4.20briq
1884 Alpha 3.3 [1] 2.14.90.0.4 2.2.5 2.2.20 [2] Debian 3.0
1886 Sparc32 2.95.4 2.12.90.0.1 2.2.5 2.4.18 Debian 3.0
1888 ARM 2.95.4 2.12.90.0.1 2.2.5 2.4.9 [3] Debian 3.0
1890 [1] On Alpha, QEMU needs the gcc 'visibility' attribute only available
1891 for gcc version >= 3.3.
1892 [2] Linux >= 2.4.20 is necessary for precise exception support
1894 [3] 2.4.9-ac10-rmk2-np1-cerf2
1896 [4] gcc 2.95.x generates invalid code when using too many register
1897 variables. You must use gcc 3.x on PowerPC.
1904 @item Install the current versions of MSYS and MinGW from
1905 @url{http://www.mingw.org/}. You can find detailed installation
1906 instructions in the download section and the FAQ.
1909 the MinGW development library of SDL 1.2.x
1910 (@file{SDL-devel-1.2.x-@/mingw32.tar.gz}) from
1911 @url{http://www.libsdl.org}. Unpack it in a temporary place, and
1912 unpack the archive @file{i386-mingw32msvc.tar.gz} in the MinGW tool
1913 directory. Edit the @file{sdl-config} script so that it gives the
1914 correct SDL directory when invoked.
1916 @item Extract the current version of QEMU.
1918 @item Start the MSYS shell (file @file{msys.bat}).
1920 @item Change to the QEMU directory. Launch @file{./configure} and
1921 @file{make}. If you have problems using SDL, verify that
1922 @file{sdl-config} can be launched from the MSYS command line.
1924 @item You can install QEMU in @file{Program Files/Qemu} by typing
1925 @file{make install}. Don't forget to copy @file{SDL.dll} in
1926 @file{Program Files/Qemu}.
1930 @node Cross compilation for Windows with Linux
1931 @section Cross compilation for Windows with Linux
1935 Install the MinGW cross compilation tools available at
1936 @url{http://www.mingw.org/}.
1939 Install the Win32 version of SDL (@url{http://www.libsdl.org}) by
1940 unpacking @file{i386-mingw32msvc.tar.gz}. Set up the PATH environment
1941 variable so that @file{i386-mingw32msvc-sdl-config} can be launched by
1942 the QEMU configuration script.
1945 Configure QEMU for Windows cross compilation:
1947 ./configure --enable-mingw32
1949 If necessary, you can change the cross-prefix according to the prefix
1950 choosen for the MinGW tools with --cross-prefix. You can also use
1951 --prefix to set the Win32 install path.
1953 @item You can install QEMU in the installation directory by typing
1954 @file{make install}. Don't forget to copy @file{SDL.dll} in the
1955 installation directory.
1959 Note: Currently, Wine does not seem able to launch
1965 The Mac OS X patches are not fully merged in QEMU, so you should look
1966 at the QEMU mailing list archive to have all the necessary