Archipelago » qemu

    "-h or -help     display this help and exit\n")

STEXI

@item -h

Display help and exit

ETEXI

    "-version        display version information and exit\n")

STEXI

@item -version

Display version information and exit

ETEXI

    "-M machine      select emulated machine (-M ? for list)\n")

STEXI

@item -M @var{machine}

Select the emulated @var{machine} (@code{-M ?} for list)

ETEXI

    "-cpu cpu        select CPU (-cpu ? for list)\n")

STEXI

@item -cpu @var{model}

Select CPU model (-cpu ? for list and additional feature selection)

ETEXI

    "                sockets= number of discrete sockets in the system\n")

STEXI

@item -smp @var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}]

Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255

CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs

to 4.

    "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n")

STEXI

@item -numa @var{opts}

Simulate a multi node NUMA system. If mem and cpus are omitted, resources

are split equally.

ETEXI

STEXI

@item -fda @var{file}

@item -fdb @var{file}

Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can

use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}).

ETEXI

@item -hdb @var{file}

@item -hdc @var{file}

@item -hdd @var{file}

Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).

ETEXI

    "-cdrom file     use 'file' as IDE cdrom image (cdrom is ide1 master)\n")

STEXI

@item -cdrom @var{file}

Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and

@option{-cdrom} at the same time). You can use the host CD-ROM by

using @file{/dev/cdrom} as filename (@pxref{host_drives}).

    "       [,cache=writethrough|writeback|none][,format=f][,serial=s]\n"

    "       [,addr=A][,id=name][,aio=threads|native][,readonly=on|off]\n"

    "                use 'file' as a drive image\n")

STEXI

@item -drive @var{option}[,@var{option}[,@var{option}[,...]]]

Define a new drive. Valid options are:

@end example

ETEXI

DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock,

    "-mtdblock file  use 'file' as on-board Flash memory image\n")

STEXI

@item -mtdblock @var{file}

Use @var{file} as on-board Flash memory image.

ETEXI

    "-sd file        use 'file' as SecureDigital card image\n")

STEXI

@item -sd @var{file}

Use @var{file} as SecureDigital card image.

ETEXI

    "-pflash file    use 'file' as a parallel flash image\n")

STEXI

@item -pflash @var{file}

Use @var{file} as a parallel flash image.

ETEXI

    "                'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n")

STEXI

@item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off]

Specify boot order @var{drives} as a string of drive letters. Valid

drive letters depend on the target achitecture. The x86 PC uses: a, b

(floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot

    "-snapshot       write to temporary files instead of disk image files\n")

STEXI

@item -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 @key{C-a s} (@pxref{disk_images}).

    stringify(DEFAULT_RAM_SIZE) "]\n")

STEXI

@item -m @var{megs}

Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB.  Optionally,

a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or

gigabytes respectively.

    "-k language     use keyboard layout (for example 'fr' for French)\n")

STEXI

@item -k @var{language}

Use keyboard layout @var{language} (for example @code{fr} for

French). This option is only needed where it is not easy to get raw PC

keycodes (e.g. on Macs, with some X11 servers or with a VNC

#endif

STEXI

@item -audio-help

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

parameters.

ETEXI

#endif

STEXI

@item -soundhw @var{card1}[,@var{card2},...] or -soundhw all

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

available sound hardware.

@table @option

@item -usb

Enable the USB driver (will be the default soon)

ETEXI

STEXI

@item -usbdevice @var{devname}

Add the USB device @var{devname}. @xref{usb_devices}.

@table @option

    "                add device (based on driver)\n"

    "                prop=value,... sets driver properties\n"

    "                use -device ? to print all possible drivers\n"

STEXI

ETEXI

DEF("name", HAS_ARG, QEMU_OPTION_name,

    "                string1 sets the window title and string2 the process name (on Linux)\n")

STEXI

@item -name @var{name}

Sets the @var{name} of the guest.

This name will be displayed in the SDL window caption.

The @var{name} will also be used for the VNC server.

    "                specify machine UUID\n")

STEXI

@item -uuid @var{uuid}

Set system UUID.

ETEXI

    "-nographic      disable graphical output and redirect serial I/Os to console\n")

STEXI

@item -nographic

Normally, QEMU uses SDL to display the VGA output. With this option,

you can totally disable graphical output so that QEMU is a simple

command line application. The emulated serial port is redirected on

#endif

STEXI

@item -curses

Normally, QEMU uses SDL to display the VGA output.  With this option,

QEMU can display the VGA output when in text mode using a

curses/ncurses interface.  Nothing is displayed in graphical mode.

#endif

STEXI

@item -no-frame

Do not use decorations for SDL windows and start them using the whole

available screen space. This makes the using QEMU in a dedicated desktop

workspace more convenient.

#endif

STEXI

@item -alt-grab

Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt).

ETEXI

#endif

STEXI

@item -ctrl-grab

Use Right-Ctrl to grab mouse (instead of Ctrl-Alt).

ETEXI

#endif

STEXI

@item -no-quit

Disable SDL window close capability.

ETEXI

#endif

STEXI

@item -sdl

Enable SDL.

ETEXI

    "-portrait       rotate graphical output 90 deg left (only PXA LCD)\n")

STEXI

@item -portrait

Rotate graphical output 90 deg left (only PXA LCD).

ETEXI

    "                select video card type\n")

STEXI

@item -vga @var{type}

Select type of VGA card to emulate. Valid values for @var{type} are

@table @option

@item cirrus

    "-full-screen    start in full screen\n")

STEXI

@item -full-screen

Start in full screen.

ETEXI

#endif

STEXI

@item -g @var{width}x@var{height}[x@var{depth}]

Set the initial graphical resolution and depth (PPC, SPARC only).

ETEXI

    "-vnc display    start a VNC server on display\n")

STEXI

@item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]

Normally, QEMU uses SDL to display the VGA output.  With this option,

you can have QEMU listen on VNC display @var{display} and redirect the VGA

display over the VNC session.  It is very useful to enable the usb

#endif

STEXI

@item -win2k-hack

Use it when installing Windows 2000 to avoid a disk full bug. After

Windows 2000 is installed, you no longer need this option (this option

slows down the IDE transfers).

#endif

STEXI

@item -no-fd-bootchk

Disable boot signature checking for floppy disks in Bochs BIOS. It may

be needed to boot from old floppy disks.

ETEXI

#ifdef TARGET_I386

#endif

STEXI

@item -no-acpi

Disable ACPI (Advanced Configuration and Power Interface) support. Use

it if your guest OS complains about ACPI problems (PC target machine

only).

#endif

STEXI

@item -no-hpet

Disable HPET support.

ETEXI

#endif

STEXI

@item -balloon none

Disable balloon device.

@item -balloon virtio[,addr=@var{addr}]

Enable virtio balloon device (default), optionally with PCI address

#endif

STEXI

@item -acpitable [sig=@var{str}][,rev=@var{n}][,oem_id=@var{str}][,oem_table_id=@var{str}][,oem_rev=@var{n}] [,asl_compiler_id=@var{str}][,asl_compiler_rev=@var{n}][,data=@var{file1}[:@var{file2}]...]

Add ACPI table with specified header fields and context from specified files.

ETEXI

#endif

STEXI

@item -smbios file=@var{binary}

Load SMBIOS entry from binary file.

@item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}]

Specify SMBIOS type 0 fields

@item -smbios type=1[,manufacturer=@var{str}][,product=@var{str}][,version=@var{str}][,serial=@var{str}][,uuid=@var{uuid}][,sku=@var{str}][,family=@var{str}]

    "socket],id=str[,option][,option][,...]\n")

STEXI

@item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}][,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}]

Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}

= 0 is the default). The NIC is an e1000 by default on the PC

target. Optionally, the MAC address can be changed to @var{mac}, the

@table @option

@item -chardev @var{backend} ,id=@var{id} [,@var{options}]

Backend is one of:

@option{null},

@option{socket},

@table @option

@item -bt hci[...]

Defines the function of the corresponding Bluetooth HCI.  -bt options

are matched with the HCIs present in the chosen machine type.  For

example when emulating a machine with only one HCI built into it, only

    "-kernel bzImage use 'bzImage' as kernel image\n")

STEXI

@item -kernel @var{bzImage}

Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel

or in multiboot format.

ETEXI

    "-append cmdline use 'cmdline' as kernel command line\n")

STEXI

@item -append @var{cmdline}

Use @var{cmdline} as kernel command line

ETEXI

           "-initrd file    use 'file' as initial ram disk\n")

STEXI

@item -initrd @var{file}

Use @var{file} as initial ram disk.

@item -initrd "@var{file1} arg=foo,@var{file2}"

    "-serial dev     redirect the serial port to char device 'dev'\n")

STEXI

@item -serial @var{dev}

Redirect the virtual serial port to host character device

@var{dev}. The default device is @code{vc} in graphical mode and

@code{stdio} in non graphical mode.

    "-parallel dev   redirect the parallel port to char device 'dev'\n")

STEXI

@item -parallel @var{dev}

Redirect the virtual parallel port to host device @var{dev} (same

devices as the serial port). On Linux hosts, @file{/dev/parportN} can

be used to use hardware devices connected on the corresponding host

    "-monitor dev    redirect the monitor to char device 'dev'\n")

STEXI

@item -monitor @var{dev}

Redirect the monitor to host device @var{dev} (same devices as the

serial port).

The default device is @code{vc} in graphical mode and @code{stdio} in

    "-qmp dev        like -monitor but opens in 'control' mode\n")

STEXI

@item -qmp @var{dev}

Like -monitor but opens in 'control' mode.

ETEXI

    "-mon chardev=[name][,mode=readline|control][,default]\n")

STEXI

@item -mon chardev=[name][,mode=readline|control][,default]

Setup monitor on chardev @var{name}.

ETEXI

    "-debugcon dev   redirect the debug console to char device 'dev'\n")

STEXI

@item -debugcon @var{dev}

Redirect the debug console to host device @var{dev} (same devices as the

serial port).  The debug console is an I/O port which is typically port

0xe9; writing to that I/O port sends output to this device.

    "-pidfile file   write PID to 'file'\n")

STEXI

@item -pidfile @var{file}

Store the QEMU process PID in @var{file}. It is useful if you launch QEMU

from a script.

ETEXI

    "-singlestep     always run in singlestep mode\n")

STEXI

@item -singlestep

Run the emulation in single step mode.

ETEXI

    "-S              freeze CPU at startup (use 'c' to start execution)\n")

STEXI

@item -S

Do not start CPU at startup (you must type 'c' in the monitor).

ETEXI

    "-gdb dev        wait for gdb connection on 'dev'\n")

STEXI

@item -gdb @var{dev}

Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical

connections will likely be TCP-based, but also UDP, pseudo TTY, or even

stdio are reasonable use case. The latter is allowing to start qemu from

    "-s              shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n")

STEXI

@item -s

Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234

(@pxref{gdb_usage}).

ETEXI

    "-d item1,...    output log to /tmp/qemu.log (use -d ? for a list of log items)\n")

STEXI

@item -d

Output log in /tmp/qemu.log

ETEXI

    "                translation (t=none or lba) (usually qemu can guess them)\n")

STEXI

@item -hdachs @var{c},@var{h},@var{s},[,@var{t}]

Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=

@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS

translation mode (@var{t}=none, lba or auto). Usually QEMU can guess

    "-L path         set the directory for the BIOS, VGA BIOS and keymaps\n")

STEXI

@item -L  @var{path}

Set the directory for the BIOS, VGA BIOS and keymaps.

ETEXI

    "-bios file      set the filename for the BIOS\n")

STEXI

@item -bios @var{file}

Set the filename for the BIOS.

ETEXI

#endif

STEXI

@item -enable-kvm

Enable KVM full virtualization support. This option is only available

if KVM support is enabled when compiling.

ETEXI

#endif

STEXI

@item -xen-domid @var{id}

Specify xen guest domain @var{id} (XEN only).

@item -xen-create

Create domain using xen hypercalls, bypassing xend.

Warning: should not be used when xend is in use (XEN only).

@item -xen-attach

Attach to existing xen domain.

xend will use this when starting qemu (XEN only).

ETEXI

    "-no-reboot      exit instead of rebooting\n")

STEXI

@item -no-reboot

Exit instead of rebooting.

ETEXI

    "-no-shutdown    stop before shutdown\n")

STEXI

@item -no-shutdown

Don't exit QEMU on guest shutdown, but instead only stop the emulation.

This allows for instance switching to monitor to commit changes to the

disk image.

    "                start right away with a saved state (loadvm in monitor)\n")

STEXI

@item -loadvm @var{file}

Start right away with a saved state (@code{loadvm} in monitor)

ETEXI

#endif

STEXI

@item -daemonize

Daemonize the QEMU process after initialization.  QEMU will not detach from

standard IO until it is ready to receive connections on any of its devices.

This option is a useful way for external programs to launch QEMU without having

    "-option-rom rom load a file, rom, into the option ROM space\n")

STEXI

@item -option-rom @var{file}

Load the contents of @var{file} as an option ROM.

This option is useful to load things like EtherBoot.

ETEXI

    "                To see what timers are available use -clock ?\n")

STEXI

@item -clock @var{method}

Force the use of the given methods for timer alarm. To see what timers

are available use -clock ?.

ETEXI

STEXI

@item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew]

Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current

UTC or local time, respectively. @code{localtime} is required for correct date in

MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the

    "                instruction\n")

STEXI

@item -icount [@var{N}|auto]

Enable virtual instruction counter.  The virtual cpu will execute one

instruction every 2^@var{N} ns of virtual time.  If @code{auto} is specified

then the virtual cpu speed will be automatically adjusted to keep virtual

    "                enable virtual hardware watchdog [default=none]\n")

STEXI

@item -watchdog @var{model}

Create a virtual hardware watchdog device.  Once enabled (by a guest

action), the watchdog must be periodically polled by an agent inside

the guest or else the guest will be restarted.

STEXI

@item -echr @var{numeric_ascii_value}

Change the escape character used for switching to the monitor when using

monitor and serial sharing.  The default is @code{0x01} when using the

@code{-nographic} option.  @code{0x01} is equal to pressing

    "                set virtio console\n")

STEXI

@item -virtioconsole @var{c}

Set virtio console.

This option is maintained for backward compatibility.

    "-show-cursor    show cursor\n")

STEXI

@item -show-cursor

Show cursor.

ETEXI

    "-tb-size n      set TB size\n")

STEXI

@item -tb-size @var{n}

Set TB size.

ETEXI

    "-incoming p     prepare for incoming migration, listen on port p\n")

STEXI

@item -incoming @var{port}

Prepare for incoming migration, listen on @var{port}.

ETEXI

    "-nodefaults     don't create default devices\n")

STEXI

@item -nodefaults

Don't create default devices.

ETEXI

#endif

STEXI

@item -chroot @var{dir}

Immediately before starting guest execution, chroot to the specified

directory.  Especially useful in combination with -runas.

ETEXI

#endif

STEXI

@item -runas @var{user}

Immediately before starting guest execution, drop root privileges, switching

to the specified user.

ETEXI

#endif

STEXI

@item -prom-env @var{variable}=@var{value}

Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only).

ETEXI

#if defined(TARGET_ARM) || defined(TARGET_M68K)

#endif

STEXI

@item -semihosting

Semihosting mode (ARM, M68K only).

ETEXI

#if defined(TARGET_ARM)

#endif

STEXI

@item -old-param

Old param mode (ARM only).

ETEXI

    "-readconfig <file>\n")

STEXI

@item -readconfig @var{file}

Read device configuration from @var{file}.

ETEXI

DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig,

    "                read/write config file\n")

STEXI

@item -writeconfig @var{file}

Write device configuration to @var{file}.

ETEXI

DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig,

    "                do not load default config files at startup\n")

STEXI

@item -nodefconfig

Normally QEMU loads a configuration file from @var{sysconfdir}/qemu.conf and

@var{sysconfdir}/target-@var{ARCH}.conf on startup.  The @code{-nodefconfig}

option will prevent QEMU from loading these configuration files at startup.