Difference between revisions of "qemu (manpage)"

from HTYP, the free directory anyone can edit if they can prove to me that they're not a spambot
Jump to navigation Jump to search
m (category: manpages)
m (→‎Network options: hilited note about samba server)
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[Category:Manpages]]
+
{{manpagehdr|qemu}}
 
==Related Articles==
 
==Related Articles==
 
* [[Qemu]]
 
* [[Qemu]]
* [[Linux]]
+
* [[Qemu on Linux]]
 +
 
 
==Manpage Documentation==
 
==Manpage Documentation==
 
===NAME===
 
===NAME===
[[qemu]] - QEMU System Emulator
+
{{Linuxcmd|qemu}} - QEMU System Emulator
 +
 
 
===SYNOPSIS===
 
===SYNOPSIS===
 
usage: [[qemu]] [options] [disk_image]
 
usage: [[qemu]] [options] [disk_image]
Line 30: Line 32:
 
*'''-fda''' ''file''
 
*'''-fda''' ''file''
 
*'''-fdb''' ''file''
 
*'''-fdb''' ''file''
:Use file as floppy disk 0/1 image You can use the host floppy by using /dev/fd0 as filename. *'''-hda''' ''file''
+
:Use file as floppy disk 0/1 image You can use the host floppy by using /dev/fd0 as filename.
 +
*'''-hda''' ''file''
 
*'''-hdb''' ''file''
 
*'''-hdb''' ''file''
 
*'''-hdc''' ''file''
 
*'''-hdc''' ''file''
 
*'''-hdd''' ''file''
 
*'''-hdd''' ''file''
:Use file as hard disk 0, 1, 2 or 3 image *'''-cdrom''' ''file''
+
:Use file as hard disk 0, 1, 2 or 3 image
 +
*'''-cdrom''' ''file''
 
:Use file as CD-ROM image (you cannot use -hdc and and -cdrom at the same time). You can use the host CD-ROM by using /dev/cdrom as filename.
 
:Use file as CD-ROM image (you cannot use -hdc and and -cdrom at the same time). You can use the host CD-ROM by using /dev/cdrom as filename.
 
*'''-boot''' ['''a'''|'''c'''|'''d''']
 
*'''-boot''' ['''a'''|'''c'''|'''d''']
Line 44: Line 48:
 
*'''-nographic'''
 
*'''-nographic'''
 
:Normally, QEMU uses SDL to display the VGA output. With this option, you can totally disable graphical output so that QEMU is a simple command line application. The emulated serial port is redirected on the console. Therefore, you can still use QEMU to debug a Linux kernel with a serial console.
 
:Normally, QEMU uses SDL to display the VGA output. With this option, you can totally disable graphical output so that QEMU is a simple command line application. The emulated serial port is redirected on the console. Therefore, you can still use QEMU to debug a Linux kernel with a serial console.
*'''-enable-audio'''
+
* {{faint|'''-enable-audio'''}} (superceded by '''-soundhw''' in v0.80)
:The SB16 emulation is disabled by default as it may give problems with Windows. You can enable it manually with this option.
+
:{{faint|The SB16 emulation is disabled by default as it may give problems with Windows. You can enable it manually with this option.}}
 +
*'''-k''' <u>language</u>
 +
:Use keyboard layout language (for example "fr" for French). This option is only needed where it is not easy to get raw PC keycodes (e.g. on Macs or with some X11 servers). You don’t need to use it on PC/Linux or PC/Windows hosts.
 +
:The available layouts are:
 +
                  ar  de-ch  es  fo    fr-ca  hu  ja  mk    no  pt-br  sv
 +
                  da  en-gb  et  fr    fr-ch  is  lt  nl    pl  ru    th
 +
                  de  en-us  fi  fr-be  hr    it  lv  nl-be  pt  sl    tr
 +
:The default is "en-us".
 +
*'''-audio-help'''
 +
:Will show the audio subsystem help: list of drivers, tunable parameters.
 +
*'''-soundhw''' <u>card1</u>,<u>card2</u>,... or '''-soundhw all'''
 +
:Enable audio and selected sound hardware. Use ? to print all available sound hardware.
 +
                  qemu -soundhw sb16,adlib hda
 +
                  qemu -soundhw es1370 hda
 +
                  qemu -soundhw all hda
 +
                  qemu -soundhw ?
 
*'''-localtime'''
 
*'''-localtime'''
 
:Set the real time clock to local time (the default is to UTC time). This option is needed to have correct date in MS-DOS or Windows.
 
:Set the real time clock to local time (the default is to UTC time). This option is needed to have correct date in MS-DOS or Windows.
 
*'''-full-screen'''
 
*'''-full-screen'''
 
:Start in full screen.
 
:Start in full screen.
 +
 
====Network options====
 
====Network options====
 
*'''-n''' ''script''
 
*'''-n''' ''script''
Line 65: Line 85:
 
  10.0.2.4 smbserver
 
  10.0.2.4 smbserver
 
:must be added in the file C:\WINDOWS\LMHOSTS (for windows 9x/Me) or C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS (Windows NT/2000). Then dir can be accessed in \\smbserver\qemu.
 
:must be added in the file C:\WINDOWS\LMHOSTS (for windows 9x/Me) or C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS (Windows NT/2000). Then dir can be accessed in \\smbserver\qemu.
:Note that a SAMBA server must be installed on the host OS in /usr/sbin/smbd. QEMU was tested succesfully with smbd version 2.2.7a from the Red Hat 9.
+
:Note that {{hilite|a SAMBA server must be installed on the host}} OS in /usr/sbin/smbd. QEMU was tested succesfully with smbd version 2.2.7a from the Red Hat 9.
 
*'''-redir''' ['''tcp'''|'''udp''']''':'''''host-port''''':'''[''guest-host'']''':'''''guest-port''
 
*'''-redir''' ['''tcp'''|'''udp''']''':'''''host-port''''':'''[''guest-host'']''':'''''guest-port''
 
:When using the user mode network stack, redirect incoming TCP or UDP connections to the host port host-port to the guest guest-host on guest port guest-port. If guest-host is not specified, its value is 10.0.2.15 (default address given by the built-in DHCP server).
 
:When using the user mode network stack, redirect incoming TCP or UDP connections to the host port host-port to the guest guest-host on guest port guest-port. If guest-host is not specified, its value is 10.0.2.15 (default address given by the built-in DHCP server).
Line 81: Line 101:
 
*'''-dummy-net'''
 
*'''-dummy-net'''
 
:Use the dummy network stack: no packet will be received by the network cards.
 
:Use the dummy network stack: no packet will be received by the network cards.
 +
 
====Linux boot specific====
 
====Linux boot specific====
 
When using these options, you can use a given Linux kernel without installing it in the disk image. It can be useful for easier testing of various kernels.
 
When using these options, you can use a given Linux kernel without installing it in the disk image. It can be useful for easier testing of various kernels.
Line 152: Line 173:
 
Fabrice Bellard
 
Fabrice Bellard
 
==Edit Log==
 
==Edit Log==
 +
* '''2006-07-15''': some new options: soundhw, language
 
* '''2005-10-14''': Cleaned up after import from hypertwiki to htyp
 
* '''2005-10-14''': Cleaned up after import from hypertwiki to htyp
 
* '''2005-06-25''': Added contents of manpage
 
* '''2005-06-25''': Added contents of manpage

Latest revision as of 01:30, 16 July 2006

computing: software: documentation: manpages: qemum

Related Articles

Manpage Documentation

NAME

qemu - QEMU System Emulator

SYNOPSIS

usage: qemu [options] [disk_image]

DESCRIPTION

The QEMU System emulator simulates a complete PC. In order to meet specific user needs, two versions of QEMU are available:

  1. "qemu-fast" uses the host Memory Management Unit (MMU) to simulate the x86 MMU. It is fast but has limitations because the whole 4 GB address space cannot be used and some memory mapped peripherials cannot be emulated accurately yet. Therefore, a specific guest Linux kernel can be used.
    • Moreover there is no separation between the host and target address spaces, so it offers no security (the target OS can modify the "qemu-fast" code by writing at the right addresses).
  2. "qemu" uses a software MMU. It is about two times slower but gives a more accurate emulation and a complete separation between the host and target address spaces.

QEMU emulates the following PC peripherials:

  • i440FX host PCI bridge and PIIX3 PCI to ISA bridge
  • Cirrus CLGD 5446 PCI VGA card or dummy VGA card with Bochs VESA extensions (hardware level, including all non-standard modes).
  • PS/2 mouse and keyboard
  • 2 PCI IDE interfaces with hard disk and CD-ROM support
  • Floppy disk
  • NE2000 PCI network adapters
  • Serial ports
  • Soundblaster 16 card

QEMU uses the PC BIOS from the Bochs project and the Plex86/Bochs LGPL VGA BIOS.

OPTIONS

  • disk_image is a raw hard disk image for IDE hard disk 0.

General options

  • -fda file
  • -fdb file
Use file as floppy disk 0/1 image You can use the host floppy by using /dev/fd0 as filename.
  • -hda file
  • -hdb file
  • -hdc file
  • -hdd file
Use file as hard disk 0, 1, 2 or 3 image
  • -cdrom file
Use file as CD-ROM image (you cannot use -hdc and and -cdrom at the same time). You can use the host CD-ROM by using /dev/cdrom as filename.
  • -boot [a|c|d]
Boot on floppy (a), hard disk (c) or CD-ROM (d). Hard disk boot is the default.
  • -snapshot
Write to temporary files instead of disk image files. In this case, the raw disk image you use is not written back. You can however force the write back by pressing C-a s
  • -m megs
Set virtual RAM size to megs megabytes. Default is 128 MB.
  • -nographic
Normally, QEMU uses SDL to display the VGA output. With this option, you can totally disable graphical output so that QEMU is a simple command line application. The emulated serial port is redirected on the console. Therefore, you can still use QEMU to debug a Linux kernel with a serial console.
  • -enable-audio (superceded by -soundhw in v0.80)
The SB16 emulation is disabled by default as it may give problems with Windows. You can enable it manually with this option.
  • -k language
Use keyboard layout language (for example "fr" for French). This option is only needed where it is not easy to get raw PC keycodes (e.g. on Macs or with some X11 servers). You don’t need to use it on PC/Linux or PC/Windows hosts.
The available layouts are:
                  ar  de-ch  es  fo     fr-ca  hu  ja  mk     no  pt-br  sv
                  da  en-gb  et  fr     fr-ch  is  lt  nl     pl  ru     th
                  de  en-us  fi  fr-be  hr     it  lv  nl-be  pt  sl     tr
The default is "en-us".
  • -audio-help
Will show the audio subsystem help: list of drivers, tunable parameters.
  • -soundhw card1,card2,... or -soundhw all
Enable audio and selected sound hardware. Use ? to print all available sound hardware.
                  qemu -soundhw sb16,adlib hda
                  qemu -soundhw es1370 hda
                  qemu -soundhw all hda
                  qemu -soundhw ?
  • -localtime
Set the real time clock to local time (the default is to UTC time). This option is needed to have correct date in MS-DOS or Windows.
  • -full-screen
Start in full screen.

Network options

  • -n script
Set TUN/TAP network init script [default=/etc/qemu-ifup]. This script is launched to configure the host network interface (usually tun0) corresponding to the virtual NE2000 card.
  • -macaddr addr
Set the mac address of the first interface (the format is aa:bb:cc:dd:ee:ff in hexa). The mac address is incremented for each new network interface. *-tun-fd fd
Assumes fd talks to a tap/tun host network interface and use it. Read http://bellard.org/qemu/tetrinet.html to have an example of its use.
  • -user-net
Use the user mode network stack. This is the default if no tun/tap network init script is found.
  • -tftp prefix
When using the user mode network stack, activate a built-in TFTP server. All filenames beginning with prefix can be downloaded from the host to the guest using a TFTP client. The TFTP client on the guest must be configured in binary mode (use the command "bin" of the Unix TFTP client). The host IP address on the guest is as usual 10.0.2.2.
  • -smb dir
When using the user mode network stack, activate a built-in SMB server so that Windows OSes can access to the host files in dir transparently.
In the guest Windows OS, the line:
10.0.2.4 smbserver
must be added in the file C:\WINDOWS\LMHOSTS (for windows 9x/Me) or C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS (Windows NT/2000). Then dir can be accessed in \\smbserver\qemu.
Note that a SAMBA server must be installed on the host OS in /usr/sbin/smbd. QEMU was tested succesfully with smbd version 2.2.7a from the Red Hat 9.
  • -redir [tcp|udp]:host-port:[guest-host]:guest-port
When using the user mode network stack, redirect incoming TCP or UDP connections to the host port host-port to the guest guest-host on guest port guest-port. If guest-host is not specified, its value is 10.0.2.15 (default address given by the built-in DHCP server).
For example, to redirect host X11 connection from screen 1 to guest screen 0, use the following:
# on the host
qemu -redir tcp:6001::6000 [...]
# this host xterm should open in the guest X11 server
xterm -display :1
To redirect telnet connections from host port 5555 to telnet port on the guest, use the following:
# on the host
qemu -redir
tcp:5555::23 [...]
telnet localhost 5555
Then when you use on the host "telnet localhost 5555", you connect to the guest telnet server.
  • -dummy-net
Use the dummy network stack: no packet will be received by the network cards.

Linux boot specific

When using these options, you can use a given Linux kernel without installing it in the disk image. It can be useful for easier testing of various kernels.

  • -kernel bzImage
Use bzImage as kernel image.
  • -append cmdline
Use cmdline as kernel command line
  • -initrd file
Use file as initial ram disk.

Debug/Expert options

  • -serial dev
Redirect the virtual serial port to host device dev. Available devices are:
    • "vc"
      Virtual console
    • "pty"
      [Linux only] Pseudo TTY (a new PTY is automatically allocated)
    • "null"
      void device
    • "stdio"
      [Unix only] standard input/output :The default device is "vc" in graphical mode and "stdio" in non graphical mode. :This option can be used several times to simulate up to 4 serials ports.
  • -monitor dev
Redirect the monitor to host device dev (same devices as the serial port). The default device is "vc" in graphical mode and "stdio" in non graphical mode.
  • -s
Wait gdb connection to port 1234
  • -p port
Change gdb connection port.
  • -S
Do not start CPU at startup (you must type 'c' in the monitor).
  • -d
Output log in /tmp/qemu.log
  • -isa
Simulate an ISA-only system (default is PCI system).
  • -std-vga
Simulate a standard VGA card with Bochs VBE extensions (default is Cirrus Logic GD5446 PCI VGA)
  • -loadvm file
Start right away with a saved state ("loadvm" in monitor)

PowerPC Options

The following options are specific to the PowerPC emulation:

  • -prep
Simulate a PREP system (default is PowerMAC)
  • -g WxH[xDEPTH]
Set the initial VGA graphic mode. The default is 800x600x15.

Keys

During the graphical emulation, you can use the following keys:

  • Ctrl-Alt-f
    Toggle full screen
  • Ctrl-Alt-n
    Switch to virtual console 'n'. Standard console mappings are:
    • 1 : Target system display
    • 2 : Monitor
    • 3 :Serial port
  • Ctrl-Alt
    Toggle mouse and keyboard grab.
  • In the virtual consoles, you can use Ctrl-Up, Ctrl-Down, Ctrl-PageUp and Ctrl-PageDown to move in the back log.
  • During emulation, if you are using the -nographic option, use Ctrl-a h to get terminal commands:
    • Ctrl-a h
      Print this help
    • Ctrl-a x
      Exit emulatior
    • Ctrl-a s
      Save disk data back to file (if -snapshot)
    • Ctrl-a b
      Send break (magic sysrq in Linux)
    • Ctrl-a c
      Switch between console and monitor
    • Ctrl-a Ctrl-a
      Send Ctrl-a

SEE ALSO

The HTML documentation of QEMU for more precise information and Linux user mode emulator invocation.

AUTHOR

Fabrice Bellard

Edit Log

  • 2006-07-15: some new options: soundhw, language
  • 2005-10-14: Cleaned up after import from hypertwiki to htyp
  • 2005-06-25: Added contents of manpage