qemu/qemu-options.hx
<<
>>
Prefs
   1HXCOMM Use DEFHEADING() to define headings in both help text and texi
   2HXCOMM Text between STEXI and ETEXI are copied to texi version and
   3HXCOMM discarded from C version
   4HXCOMM DEF(option, HAS_ARG/0, opt_enum, opt_help) is used to construct
   5HXCOMM option structures, enums and help message.
   6HXCOMM HXCOMM can be used for comments, discarded from both texi and C
   7
   8DEFHEADING(Standard options:)
   9STEXI
  10@table @option
  11ETEXI
  12
  13DEF("help", 0, QEMU_OPTION_h,
  14    "-h or -help     display this help and exit\n")
  15STEXI
  16@item -h
  17Display help and exit
  18ETEXI
  19
  20DEF("version", 0, QEMU_OPTION_version,
  21    "-version        display version information and exit\n")
  22STEXI
  23@item -version
  24Display version information and exit
  25ETEXI
  26
  27DEF("M", HAS_ARG, QEMU_OPTION_M,
  28    "-M machine      select emulated machine (-M ? for list)\n")
  29STEXI
  30@item -M @var{machine}
  31Select the emulated @var{machine} (@code{-M ?} for list)
  32ETEXI
  33
  34DEF("cpu", HAS_ARG, QEMU_OPTION_cpu,
  35    "-cpu cpu        select CPU (-cpu ? for list)\n")
  36STEXI
  37@item -cpu @var{model}
  38Select CPU model (-cpu ? for list and additional feature selection)
  39ETEXI
  40
  41DEF("smp", HAS_ARG, QEMU_OPTION_smp,
  42    "-smp n          set the number of CPUs to 'n' [default=1]\n")
  43STEXI
  44@item -smp @var{n}
  45Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
  46CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs
  47to 4.
  48ETEXI
  49
  50DEF("numa", HAS_ARG, QEMU_OPTION_numa,
  51    "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n")
  52STEXI
  53@item -numa @var{opts}
  54Simulate a multi node NUMA system. If mem and cpus are omitted, resources
  55are split equally.
  56ETEXI
  57
  58DEF("fda", HAS_ARG, QEMU_OPTION_fda,
  59    "-fda/-fdb file  use 'file' as floppy disk 0/1 image\n")
  60DEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "")
  61STEXI
  62@item -fda @var{file}
  63@item -fdb @var{file}
  64Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can
  65use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}).
  66ETEXI
  67
  68DEF("hda", HAS_ARG, QEMU_OPTION_hda,
  69    "-hda/-hdb file  use 'file' as IDE hard disk 0/1 image\n")
  70DEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "")
  71DEF("hdc", HAS_ARG, QEMU_OPTION_hdc,
  72    "-hdc/-hdd file  use 'file' as IDE hard disk 2/3 image\n")
  73DEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "")
  74STEXI
  75@item -hda @var{file}
  76@item -hdb @var{file}
  77@item -hdc @var{file}
  78@item -hdd @var{file}
  79Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
  80ETEXI
  81
  82DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom,
  83    "-cdrom file     use 'file' as IDE cdrom image (cdrom is ide1 master)\n")
  84STEXI
  85@item -cdrom @var{file}
  86Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and
  87@option{-cdrom} at the same time). You can use the host CD-ROM by
  88using @file{/dev/cdrom} as filename (@pxref{host_drives}).
  89ETEXI
  90
  91DEF("drive", HAS_ARG, QEMU_OPTION_drive,
  92    "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n"
  93    "       [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n"
  94    "       [,cache=writethrough|writeback|none][,format=f][,serial=s]\n"
  95    "       [,addr=A]\n"
  96    "                use 'file' as a drive image\n")
  97STEXI
  98@item -drive @var{option}[,@var{option}[,@var{option}[,...]]]
  99
 100Define a new drive. Valid options are:
 101
 102@table @code
 103@item file=@var{file}
 104This option defines which disk image (@pxref{disk_images}) to use with
 105this drive. If the filename contains comma, you must double it
 106(for instance, "file=my,,file" to use file "my,file").
 107@item if=@var{interface}
 108This option defines on which type on interface the drive is connected.
 109Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio.
 110@item bus=@var{bus},unit=@var{unit}
 111These options define where is connected the drive by defining the bus number and
 112the unit id.
 113@item index=@var{index}
 114This option defines where is connected the drive by using an index in the list
 115of available connectors of a given interface type.
 116@item media=@var{media}
 117This option defines the type of the media: disk or cdrom.
 118@item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}]
 119These options have the same definition as they have in @option{-hdachs}.
 120@item snapshot=@var{snapshot}
 121@var{snapshot} is "on" or "off" and allows to enable snapshot for given drive (see @option{-snapshot}).
 122@item cache=@var{cache}
 123@var{cache} is "none", "writeback", or "writethrough" and controls how the host cache is used to access block data.
 124@item format=@var{format}
 125Specify which disk @var{format} will be used rather than detecting
 126the format.  Can be used to specifiy format=raw to avoid interpreting
 127an untrusted format header.
 128@item serial=@var{serial}
 129This option specifies the serial number to assign to the device.
 130@item addr=@var{addr}
 131Specify the controller's PCI address (if=virtio only).
 132@end table
 133
 134By default, writethrough caching is used for all block device.  This means that
 135the host page cache will be used to read and write data but write notification
 136will be sent to the guest only when the data has been reported as written by
 137the storage subsystem.
 138
 139Writeback caching will report data writes as completed as soon as the data is
 140present in the host page cache.  This is safe as long as you trust your host.
 141If your host crashes or loses power, then the guest may experience data
 142corruption.  When using the @option{-snapshot} option, writeback caching is
 143used by default.
 144
 145The host page cache can be avoided entirely with @option{cache=none}.  This will
 146attempt to do disk IO directly to the guests memory.  QEMU may still perform
 147an internal copy of the data.
 148
 149Some block drivers perform badly with @option{cache=writethrough}, most notably,
 150qcow2.  If performance is more important than correctness,
 151@option{cache=writeback} should be used with qcow2.
 152
 153Instead of @option{-cdrom} you can use:
 154@example
 155qemu -drive file=file,index=2,media=cdrom
 156@end example
 157
 158Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
 159use:
 160@example
 161qemu -drive file=file,index=0,media=disk
 162qemu -drive file=file,index=1,media=disk
 163qemu -drive file=file,index=2,media=disk
 164qemu -drive file=file,index=3,media=disk
 165@end example
 166
 167You can connect a CDROM to the slave of ide0:
 168@example
 169qemu -drive file=file,if=ide,index=1,media=cdrom
 170@end example
 171
 172If you don't specify the "file=" argument, you define an empty drive:
 173@example
 174qemu -drive if=ide,index=1,media=cdrom
 175@end example
 176
 177You can connect a SCSI disk with unit ID 6 on the bus #0:
 178@example
 179qemu -drive file=file,if=scsi,bus=0,unit=6
 180@end example
 181
 182Instead of @option{-fda}, @option{-fdb}, you can use:
 183@example
 184qemu -drive file=file,index=0,if=floppy
 185qemu -drive file=file,index=1,if=floppy
 186@end example
 187
 188By default, @var{interface} is "ide" and @var{index} is automatically
 189incremented:
 190@example
 191qemu -drive file=a -drive file=b"
 192@end example
 193is interpreted like:
 194@example
 195qemu -hda a -hdb b
 196@end example
 197ETEXI
 198
 199DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock,
 200    "-mtdblock file  use 'file' as on-board Flash memory image\n")
 201STEXI
 202
 203@item -mtdblock file
 204Use 'file' as on-board Flash memory image.
 205ETEXI
 206
 207DEF("sd", HAS_ARG, QEMU_OPTION_sd,
 208    "-sd file        use 'file' as SecureDigital card image\n")
 209STEXI
 210@item -sd file
 211Use 'file' as SecureDigital card image.
 212ETEXI
 213
 214DEF("pflash", HAS_ARG, QEMU_OPTION_pflash,
 215    "-pflash file    use 'file' as a parallel flash image\n")
 216STEXI
 217@item -pflash file
 218Use 'file' as a parallel flash image.
 219ETEXI
 220
 221DEF("boot", HAS_ARG, QEMU_OPTION_boot,
 222    "-boot [order=drives][,once=drives][,menu=on|off]\n"
 223    "                'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n")
 224STEXI
 225@item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off]
 226
 227Specify boot order @var{drives} as a string of drive letters. Valid
 228drive letters depend on the target achitecture. The x86 PC uses: a, b
 229(floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot
 230from network adapter 1-4), hard disk boot is the default. To apply a
 231particular boot order only on the first startup, specify it via
 232@option{once}.
 233
 234Interactive boot menus/prompts can be enabled via @option{menu=on} as far
 235as firmware/BIOS supports them. The default is non-interactive boot.
 236
 237@example
 238# try to boot from network first, then from hard disk
 239qemu -boot order=nc
 240# boot from CD-ROM first, switch back to default order after reboot
 241qemu -boot once=d
 242@end example
 243
 244Note: The legacy format '-boot @var{drives}' is still supported but its
 245use is discouraged as it may be removed from future versions.
 246ETEXI
 247
 248DEF("snapshot", 0, QEMU_OPTION_snapshot,
 249    "-snapshot       write to temporary files instead of disk image files\n")
 250STEXI
 251@item -snapshot
 252Write to temporary files instead of disk image files. In this case,
 253the raw disk image you use is not written back. You can however force
 254the write back by pressing @key{C-a s} (@pxref{disk_images}).
 255ETEXI
 256
 257DEF("m", HAS_ARG, QEMU_OPTION_m,
 258    "-m megs         set virtual RAM size to megs MB [default=%d]\n")
 259STEXI
 260@item -m @var{megs}
 261Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB.  Optionally,
 262a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
 263gigabytes respectively.
 264ETEXI
 265
 266DEF("k", HAS_ARG, QEMU_OPTION_k,
 267    "-k language     use keyboard layout (for example 'fr' for French)\n")
 268STEXI
 269@item -k @var{language}
 270
 271Use keyboard layout @var{language} (for example @code{fr} for
 272French). This option is only needed where it is not easy to get raw PC
 273keycodes (e.g. on Macs, with some X11 servers or with a VNC
 274display). You don't normally need to use it on PC/Linux or PC/Windows
 275hosts.
 276
 277The available layouts are:
 278@example
 279ar  de-ch  es  fo     fr-ca  hu  ja  mk     no  pt-br  sv
 280da  en-gb  et  fr     fr-ch  is  lt  nl     pl  ru     th
 281de  en-us  fi  fr-be  hr     it  lv  nl-be  pt  sl     tr
 282@end example
 283
 284The default is @code{en-us}.
 285ETEXI
 286
 287
 288#ifdef HAS_AUDIO
 289DEF("audio-help", 0, QEMU_OPTION_audio_help,
 290    "-audio-help     print list of audio drivers and their options\n")
 291#endif
 292STEXI
 293@item -audio-help
 294
 295Will show the audio subsystem help: list of drivers, tunable
 296parameters.
 297ETEXI
 298
 299#ifdef HAS_AUDIO
 300DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw,
 301    "-soundhw c1,... enable audio support\n"
 302    "                and only specified sound cards (comma separated list)\n"
 303    "                use -soundhw ? to get the list of supported cards\n"
 304    "                use -soundhw all to enable all of them\n")
 305#endif
 306STEXI
 307@item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
 308
 309Enable audio and selected sound hardware. Use ? to print all
 310available sound hardware.
 311
 312@example
 313qemu -soundhw sb16,adlib disk.img
 314qemu -soundhw es1370 disk.img
 315qemu -soundhw ac97 disk.img
 316qemu -soundhw all disk.img
 317qemu -soundhw ?
 318@end example
 319
 320Note that Linux's i810_audio OSS kernel (for AC97) module might
 321require manually specifying clocking.
 322
 323@example
 324modprobe i810_audio clocking=48000
 325@end example
 326ETEXI
 327
 328STEXI
 329@end table
 330ETEXI
 331
 332DEF("usb", 0, QEMU_OPTION_usb,
 333    "-usb            enable the USB driver (will be the default soon)\n")
 334STEXI
 335USB options:
 336@table @option
 337
 338@item -usb
 339Enable the USB driver (will be the default soon)
 340ETEXI
 341
 342DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice,
 343    "-usbdevice name add the host or guest USB device 'name'\n")
 344STEXI
 345
 346@item -usbdevice @var{devname}
 347Add the USB device @var{devname}. @xref{usb_devices}.
 348
 349@table @code
 350
 351@item mouse
 352Virtual Mouse. This will override the PS/2 mouse emulation when activated.
 353
 354@item tablet
 355Pointer device that uses absolute coordinates (like a touchscreen). This
 356means qemu is able to report the mouse position without having to grab the
 357mouse. Also overrides the PS/2 mouse emulation when activated.
 358
 359@item disk:[format=@var{format}]:file
 360Mass storage device based on file. The optional @var{format} argument
 361will be used rather than detecting the format. Can be used to specifiy
 362format=raw to avoid interpreting an untrusted format header.
 363
 364@item host:bus.addr
 365Pass through the host device identified by bus.addr (Linux only).
 366
 367@item host:vendor_id:product_id
 368Pass through the host device identified by vendor_id:product_id (Linux only).
 369
 370@item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
 371Serial converter to host character device @var{dev}, see @code{-serial} for the
 372available devices.
 373
 374@item braille
 375Braille device.  This will use BrlAPI to display the braille output on a real
 376or fake device.
 377
 378@item net:options
 379Network adapter that supports CDC ethernet and RNDIS protocols.
 380
 381@end table
 382ETEXI
 383
 384DEF("name", HAS_ARG, QEMU_OPTION_name,
 385    "-name string1[,process=string2]    set the name of the guest\n"
 386    "            string1 sets the window title and string2 the process name (on Linux)\n")
 387STEXI
 388@item -name @var{name}
 389Sets the @var{name} of the guest.
 390This name will be displayed in the SDL window caption.
 391The @var{name} will also be used for the VNC server.
 392Also optionally set the top visible process name in Linux.
 393ETEXI
 394
 395DEF("uuid", HAS_ARG, QEMU_OPTION_uuid,
 396    "-uuid %%08x-%%04x-%%04x-%%04x-%%012x\n"
 397    "                specify machine UUID\n")
 398STEXI
 399@item -uuid @var{uuid}
 400Set system UUID.
 401ETEXI
 402
 403STEXI
 404@end table
 405ETEXI
 406
 407DEFHEADING()
 408
 409DEFHEADING(Display options:)
 410
 411STEXI
 412@table @option
 413ETEXI
 414
 415DEF("nographic", 0, QEMU_OPTION_nographic,
 416    "-nographic      disable graphical output and redirect serial I/Os to console\n")
 417STEXI
 418@item -nographic
 419
 420Normally, QEMU uses SDL to display the VGA output. With this option,
 421you can totally disable graphical output so that QEMU is a simple
 422command line application. The emulated serial port is redirected on
 423the console. Therefore, you can still use QEMU to debug a Linux kernel
 424with a serial console.
 425ETEXI
 426
 427#ifdef CONFIG_CURSES
 428DEF("curses", 0, QEMU_OPTION_curses,
 429    "-curses         use a curses/ncurses interface instead of SDL\n")
 430#endif
 431STEXI
 432@item -curses
 433
 434Normally, QEMU uses SDL to display the VGA output.  With this option,
 435QEMU can display the VGA output when in text mode using a
 436curses/ncurses interface.  Nothing is displayed in graphical mode.
 437ETEXI
 438
 439#ifdef CONFIG_SDL
 440DEF("no-frame", 0, QEMU_OPTION_no_frame,
 441    "-no-frame       open SDL window without a frame and window decorations\n")
 442#endif
 443STEXI
 444@item -no-frame
 445
 446Do not use decorations for SDL windows and start them using the whole
 447available screen space. This makes the using QEMU in a dedicated desktop
 448workspace more convenient.
 449ETEXI
 450
 451#ifdef CONFIG_SDL
 452DEF("alt-grab", 0, QEMU_OPTION_alt_grab,
 453    "-alt-grab       use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n")
 454#endif
 455STEXI
 456@item -alt-grab
 457
 458Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt).
 459ETEXI
 460
 461#ifdef CONFIG_SDL
 462DEF("no-quit", 0, QEMU_OPTION_no_quit,
 463    "-no-quit        disable SDL window close capability\n")
 464#endif
 465STEXI
 466@item -no-quit
 467
 468Disable SDL window close capability.
 469ETEXI
 470
 471#ifdef CONFIG_SDL
 472DEF("sdl", 0, QEMU_OPTION_sdl,
 473    "-sdl            enable SDL\n")
 474#endif
 475STEXI
 476@item -sdl
 477
 478Enable SDL.
 479ETEXI
 480
 481DEF("portrait", 0, QEMU_OPTION_portrait,
 482    "-portrait       rotate graphical output 90 deg left (only PXA LCD)\n")
 483STEXI
 484@item -portrait
 485
 486Rotate graphical output 90 deg left (only PXA LCD).
 487ETEXI
 488
 489DEF("vga", HAS_ARG, QEMU_OPTION_vga,
 490    "-vga [std|cirrus|vmware|xenfb|none]\n"
 491    "                select video card type\n")
 492STEXI
 493@item -vga @var{type}
 494Select type of VGA card to emulate. Valid values for @var{type} are
 495@table @code
 496@item cirrus
 497Cirrus Logic GD5446 Video card. All Windows versions starting from
 498Windows 95 should recognize and use this graphic card. For optimal
 499performances, use 16 bit color depth in the guest and the host OS.
 500(This one is the default)
 501@item std
 502Standard VGA card with Bochs VBE extensions.  If your guest OS
 503supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
 504to use high resolution modes (>= 1280x1024x16) then you should use
 505this option.
 506@item vmware
 507VMWare SVGA-II compatible adapter. Use it if you have sufficiently
 508recent XFree86/XOrg server or Windows guest with a driver for this
 509card.
 510@item none
 511Disable VGA card.
 512@end table
 513ETEXI
 514
 515DEF("full-screen", 0, QEMU_OPTION_full_screen,
 516    "-full-screen    start in full screen\n")
 517STEXI
 518@item -full-screen
 519Start in full screen.
 520ETEXI
 521
 522#if defined(TARGET_PPC) || defined(TARGET_SPARC)
 523DEF("g", 1, QEMU_OPTION_g ,
 524    "-g WxH[xDEPTH]  Set the initial graphical resolution and depth\n")
 525#endif
 526STEXI
 527ETEXI
 528
 529DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
 530    "-vnc display    start a VNC server on display\n")
 531STEXI
 532@item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
 533
 534Normally, QEMU uses SDL to display the VGA output.  With this option,
 535you can have QEMU listen on VNC display @var{display} and redirect the VGA
 536display over the VNC session.  It is very useful to enable the usb
 537tablet device when using this option (option @option{-usbdevice
 538tablet}). When using the VNC display, you must use the @option{-k}
 539parameter to set the keyboard layout if you are not using en-us. Valid
 540syntax for the @var{display} is
 541
 542@table @code
 543
 544@item @var{host}:@var{d}
 545
 546TCP connections will only be allowed from @var{host} on display @var{d}.
 547By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
 548be omitted in which case the server will accept connections from any host.
 549
 550@item @code{unix}:@var{path}
 551
 552Connections will be allowed over UNIX domain sockets where @var{path} is the
 553location of a unix socket to listen for connections on.
 554
 555@item none
 556
 557VNC is initialized but not started. The monitor @code{change} command
 558can be used to later start the VNC server.
 559
 560@end table
 561
 562Following the @var{display} value there may be one or more @var{option} flags
 563separated by commas. Valid options are
 564
 565@table @code
 566
 567@item reverse
 568
 569Connect to a listening VNC client via a ``reverse'' connection. The
 570client is specified by the @var{display}. For reverse network
 571connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
 572is a TCP port number, not a display number.
 573
 574@item password
 575
 576Require that password based authentication is used for client connections.
 577The password must be set separately using the @code{change} command in the
 578@ref{pcsys_monitor}
 579
 580@item tls
 581
 582Require that client use TLS when communicating with the VNC server. This
 583uses anonymous TLS credentials so is susceptible to a man-in-the-middle
 584attack. It is recommended that this option be combined with either the
 585@var{x509} or @var{x509verify} options.
 586
 587@item x509=@var{/path/to/certificate/dir}
 588
 589Valid if @option{tls} is specified. Require that x509 credentials are used
 590for negotiating the TLS session. The server will send its x509 certificate
 591to the client. It is recommended that a password be set on the VNC server
 592to provide authentication of the client when this is used. The path following
 593this option specifies where the x509 certificates are to be loaded from.
 594See the @ref{vnc_security} section for details on generating certificates.
 595
 596@item x509verify=@var{/path/to/certificate/dir}
 597
 598Valid if @option{tls} is specified. Require that x509 credentials are used
 599for negotiating the TLS session. The server will send its x509 certificate
 600to the client, and request that the client send its own x509 certificate.
 601The server will validate the client's certificate against the CA certificate,
 602and reject clients when validation fails. If the certificate authority is
 603trusted, this is a sufficient authentication mechanism. You may still wish
 604to set a password on the VNC server as a second authentication layer. The
 605path following this option specifies where the x509 certificates are to
 606be loaded from. See the @ref{vnc_security} section for details on generating
 607certificates.
 608
 609@item sasl
 610
 611Require that the client use SASL to authenticate with the VNC server.
 612The exact choice of authentication method used is controlled from the
 613system / user's SASL configuration file for the 'qemu' service. This
 614is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
 615unprivileged user, an environment variable SASL_CONF_PATH can be used
 616to make it search alternate locations for the service config.
 617While some SASL auth methods can also provide data encryption (eg GSSAPI),
 618it is recommended that SASL always be combined with the 'tls' and
 619'x509' settings to enable use of SSL and server certificates. This
 620ensures a data encryption preventing compromise of authentication
 621credentials. See the @ref{vnc_security} section for details on using
 622SASL authentication.
 623
 624@item acl
 625
 626Turn on access control lists for checking of the x509 client certificate
 627and SASL party. For x509 certs, the ACL check is made against the
 628certificate's distinguished name. This is something that looks like
 629@code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
 630made against the username, which depending on the SASL plugin, may
 631include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
 632When the @option{acl} flag is set, the initial access list will be
 633empty, with a @code{deny} policy. Thus no one will be allowed to
 634use the VNC server until the ACLs have been loaded. This can be
 635achieved using the @code{acl} monitor command.
 636
 637@end table
 638ETEXI
 639
 640STEXI
 641@end table
 642ETEXI
 643
 644DEFHEADING()
 645
 646#ifdef TARGET_I386
 647DEFHEADING(i386 target only:)
 648#endif
 649STEXI
 650@table @option
 651ETEXI
 652
 653#ifdef TARGET_I386
 654DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack,
 655    "-win2k-hack     use it when installing Windows 2000 to avoid a disk full bug\n")
 656#endif
 657STEXI
 658@item -win2k-hack
 659Use it when installing Windows 2000 to avoid a disk full bug. After
 660Windows 2000 is installed, you no longer need this option (this option
 661slows down the IDE transfers).
 662ETEXI
 663
 664#ifdef TARGET_I386
 665DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack,
 666    "-rtc-td-hack    use it to fix time drift in Windows ACPI HAL\n")
 667#endif
 668STEXI
 669@item -rtc-td-hack
 670Use it if you experience time drift problem in Windows with ACPI HAL.
 671This option will try to figure out how many timer interrupts were not
 672processed by the Windows guest and will re-inject them.
 673ETEXI
 674
 675#ifdef TARGET_I386
 676DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk,
 677    "-no-fd-bootchk  disable boot signature checking for floppy disks\n")
 678#endif
 679STEXI
 680@item -no-fd-bootchk
 681Disable boot signature checking for floppy disks in Bochs BIOS. It may
 682be needed to boot from old floppy disks.
 683ETEXI
 684
 685#ifdef TARGET_I386
 686DEF("no-acpi", 0, QEMU_OPTION_no_acpi,
 687           "-no-acpi        disable ACPI\n")
 688#endif
 689STEXI
 690@item -no-acpi
 691Disable ACPI (Advanced Configuration and Power Interface) support. Use
 692it if your guest OS complains about ACPI problems (PC target machine
 693only).
 694ETEXI
 695
 696#ifdef TARGET_I386
 697DEF("no-hpet", 0, QEMU_OPTION_no_hpet,
 698    "-no-hpet        disable HPET\n")
 699#endif
 700STEXI
 701@item -no-hpet
 702Disable HPET support.
 703ETEXI
 704
 705#ifdef TARGET_I386
 706DEF("balloon", HAS_ARG, QEMU_OPTION_balloon,
 707    "-balloon none   disable balloon device\n"
 708    "-balloon virtio[,addr=str]\n"
 709    "                enable virtio balloon device (default)\n")
 710#endif
 711STEXI
 712@item -balloon none
 713Disable balloon device.
 714@item -balloon virtio[,addr=@var{addr}]
 715Enable virtio balloon device (default), optionally with PCI address
 716@var{addr}.
 717ETEXI
 718
 719#ifdef TARGET_I386
 720DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable,
 721    "-acpitable [sig=str][,rev=n][,oem_id=str][,oem_table_id=str][,oem_rev=n][,asl_compiler_id=str][,asl_compiler_rev=n][,data=file1[:file2]...]\n"
 722    "                ACPI table description\n")
 723#endif
 724STEXI
 725@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}]...]
 726Add ACPI table with specified header fields and context from specified files.
 727ETEXI
 728
 729#ifdef TARGET_I386
 730DEF("smbios", HAS_ARG, QEMU_OPTION_smbios,
 731    "-smbios file=binary\n"
 732    "                Load SMBIOS entry from binary file\n"
 733    "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%%d.%%d]\n"
 734    "                Specify SMBIOS type 0 fields\n"
 735    "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n"
 736    "              [,uuid=uuid][,sku=str][,family=str]\n"
 737    "                Specify SMBIOS type 1 fields\n")
 738#endif
 739STEXI
 740@item -smbios file=@var{binary}
 741Load SMBIOS entry from binary file.
 742
 743@item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}]
 744Specify SMBIOS type 0 fields
 745
 746@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}]
 747Specify SMBIOS type 1 fields
 748ETEXI
 749
 750#ifdef TARGET_I386
 751DEFHEADING()
 752#endif
 753STEXI
 754@end table
 755ETEXI
 756
 757DEFHEADING(Network options:)
 758STEXI
 759@table @option
 760ETEXI
 761
 762HXCOMM Legacy slirp options (now moved to -net user):
 763#ifdef CONFIG_SLIRP
 764DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "")
 765DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "")
 766DEF("redir", HAS_ARG, QEMU_OPTION_redir, "")
 767#ifndef _WIN32
 768DEF("smb", HAS_ARG, QEMU_OPTION_smb, "")
 769#endif
 770#endif
 771
 772DEF("net", HAS_ARG, QEMU_OPTION_net,
 773    "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n"
 774    "                create a new Network Interface Card and connect it to VLAN 'n'\n"
 775#ifdef CONFIG_SLIRP
 776    "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=y|n]\n"
 777    "         [,hostname=host][,dhcpstart=addr][,dns=addr][,tftp=dir][,bootfile=f]\n"
 778    "         [,hostfwd=rule][,guestfwd=rule]"
 779#ifndef _WIN32
 780                                             "[,smb=dir[,smbserver=addr]]\n"
 781#endif
 782    "                connect the user mode network stack to VLAN 'n', configure its\n"
 783    "                DHCP server and enabled optional services\n"
 784#endif
 785#ifdef _WIN32
 786    "-net tap[,vlan=n][,name=str],ifname=name\n"
 787    "                connect the host TAP network interface to VLAN 'n'\n"
 788#else
 789    "-net tap[,vlan=n][,name=str][,fd=h][,ifname=name][,script=file][,downscript=dfile]"
 790#ifdef TUNSETSNDBUF
 791    "[,sndbuf=nbytes]"
 792#endif
 793    "\n"
 794    "                connect the host TAP network interface to VLAN 'n' and use the\n"
 795    "                network scripts 'file' (default=%s)\n"
 796    "                and 'dfile' (default=%s);\n"
 797    "                use '[down]script=no' to disable script execution;\n"
 798    "                use 'fd=h' to connect to an already opened TAP interface\n"
 799#ifdef TUNSETSNDBUF
 800    "                use 'sndbuf=nbytes' to limit the size of the send buffer; the\n"
 801    "                default of 'sndbuf=1048576' can be disabled using 'sndbuf=0'\n"
 802#endif
 803#endif
 804    "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n"
 805    "                connect the vlan 'n' to another VLAN using a socket connection\n"
 806    "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port]\n"
 807    "                connect the vlan 'n' to multicast maddr and port\n"
 808#ifdef CONFIG_VDE
 809    "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n"
 810    "                connect the vlan 'n' to port 'n' of a vde switch running\n"
 811    "                on host and listening for incoming connections on 'socketpath'.\n"
 812    "                Use group 'groupname' and mode 'octalmode' to change default\n"
 813    "                ownership and permissions for communication port.\n"
 814#endif
 815    "-net dump[,vlan=n][,file=f][,len=n]\n"
 816    "                dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n"
 817    "-net none       use it alone to have zero network devices; if no -net option\n"
 818    "                is provided, the default is '-net nic -net user'\n")
 819STEXI
 820@item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}][,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}]
 821Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
 822= 0 is the default). The NIC is an ne2k_pci by default on the PC
 823target. Optionally, the MAC address can be changed to @var{mac}, the
 824device address set to @var{addr} (PCI cards only),
 825and a @var{name} can be assigned for use in monitor commands.
 826Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
 827that the card should have; this option currently only affects virtio cards; set
 828@var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
 829NIC is created.  Qemu can emulate several different models of network card.
 830Valid values for @var{type} are
 831@code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er},
 832@code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
 833@code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
 834Not all devices are supported on all targets.  Use -net nic,model=?
 835for a list of available devices for your target.
 836
 837@item -net user[,@var{option}][,@var{option}][,...]
 838Use the user mode network stack which requires no administrator
 839privilege to run. Valid options are:
 840
 841@table @code
 842@item vlan=@var{n}
 843Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default).
 844
 845@item name=@var{name}
 846Assign symbolic name for use in monitor commands.
 847
 848@item net=@var{addr}[/@var{mask}]
 849Set IP network address the guest will see. Optionally specify the netmask,
 850either in the form a.b.c.d or as number of valid top-most bits. Default is
 85110.0.2.0/8.
 852
 853@item host=@var{addr}
 854Specify the guest-visible address of the host. Default is the 2nd IP in the
 855guest network, i.e. x.x.x.2.
 856
 857@item restrict=y|yes|n|no
 858If this options is enabled, the guest will be isolated, i.e. it will not be
 859able to contact the host and no guest IP packets will be routed over the host
 860to the outside. This option does not affect explicitly set forwarding rule.
 861
 862@item hostname=@var{name}
 863Specifies the client hostname reported by the builtin DHCP server.
 864
 865@item dhcpstart=@var{addr}
 866Specify the first of the 16 IPs the built-in DHCP server can assign. Default
 867is the 16th to 31st IP in the guest network, i.e. x.x.x.16 to x.x.x.31.
 868
 869@item dns=@var{addr}
 870Specify the guest-visible address of the virtual nameserver. The address must
 871be different from the host address. Default is the 3rd IP in the guest network,
 872i.e. x.x.x.3.
 873
 874@item tftp=@var{dir}
 875When using the user mode network stack, activate a built-in TFTP
 876server. The files in @var{dir} will be exposed as the root of a TFTP server.
 877The TFTP client on the guest must be configured in binary mode (use the command
 878@code{bin} of the Unix TFTP client).
 879
 880@item bootfile=@var{file}
 881When using the user mode network stack, broadcast @var{file} as the BOOTP
 882filename. In conjunction with @option{tftp}, this can be used to network boot
 883a guest from a local directory.
 884
 885Example (using pxelinux):
 886@example
 887qemu -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
 888@end example
 889
 890@item smb=@var{dir}[,smbserver=@var{addr}]
 891When using the user mode network stack, activate a built-in SMB
 892server so that Windows OSes can access to the host files in @file{@var{dir}}
 893transparently. The IP address of the SMB server can be set to @var{addr}. By
 894default the 4th IP in the guest network is used, i.e. x.x.x.4.
 895
 896In the guest Windows OS, the line:
 897@example
 89810.0.2.4 smbserver
 899@end example
 900must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
 901or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
 902
 903Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
 904
 905Note that a SAMBA server must be installed on the host OS in
 906@file{/usr/sbin/smbd}. QEMU was tested successfully with smbd versions from
 907Red Hat 9, Fedora Core 3 and OpenSUSE 11.x.
 908
 909@item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
 910Redirect incoming TCP or UDP connections to the host port @var{hostport} to
 911the guest IP address @var{guestaddr} on guest port @var{guestport}. If
 912@var{guestaddr} is not specified, its value is x.x.x.15 (default first address
 913given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
 914be bound to a specific host interface. If no connection type is set, TCP is
 915used. This option can be given multiple times.
 916
 917For example, to redirect host X11 connection from screen 1 to guest
 918screen 0, use the following:
 919
 920@example
 921# on the host
 922qemu -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...]
 923# this host xterm should open in the guest X11 server
 924xterm -display :1
 925@end example
 926
 927To redirect telnet connections from host port 5555 to telnet port on
 928the guest, use the following:
 929
 930@example
 931# on the host
 932qemu -net user,hostfwd=tcp:5555::23 [...]
 933telnet localhost 5555
 934@end example
 935
 936Then when you use on the host @code{telnet localhost 5555}, you
 937connect to the guest telnet server.
 938
 939@item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
 940Forward guest TCP connections to the IP address @var{server} on port @var{port}
 941to the character device @var{dev}. This option can be given multiple times.
 942
 943@end table
 944
 945Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still
 946processed and applied to -net user. Mixing them with the new configuration
 947syntax gives undefined results. Their use for new applications is discouraged
 948as they will be removed from future versions.
 949
 950@item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}]
 951Connect the host TAP network interface @var{name} to VLAN @var{n}, use
 952the network script @var{file} to configure it and the network script
 953@var{dfile} to deconfigure it. If @var{name} is not provided, the OS
 954automatically provides one. @option{fd}=@var{h} can be used to specify
 955the handle of an already opened host TAP interface. The default network
 956configure script is @file{/etc/qemu-ifup} and the default network
 957deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no}
 958or @option{downscript=no} to disable script execution. Example:
 959
 960@example
 961qemu linux.img -net nic -net tap
 962@end example
 963
 964More complicated example (two NICs, each one connected to a TAP device)
 965@example
 966qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
 967               -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
 968@end example
 969
 970@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
 971
 972Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
 973machine using a TCP socket connection. If @option{listen} is
 974specified, QEMU waits for incoming connections on @var{port}
 975(@var{host} is optional). @option{connect} is used to connect to
 976another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
 977specifies an already opened TCP socket.
 978
 979Example:
 980@example
 981# launch a first QEMU instance
 982qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
 983               -net socket,listen=:1234
 984# connect the VLAN 0 of this instance to the VLAN 0
 985# of the first instance
 986qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
 987               -net socket,connect=127.0.0.1:1234
 988@end example
 989
 990@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}]
 991
 992Create a VLAN @var{n} shared with another QEMU virtual
 993machines using a UDP multicast socket, effectively making a bus for
 994every QEMU with same multicast address @var{maddr} and @var{port}.
 995NOTES:
 996@enumerate
 997@item
 998Several QEMU can be running on different hosts and share same bus (assuming
 999correct multicast setup for these hosts).
1000@item
1001mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
1002@url{http://user-mode-linux.sf.net}.
1003@item
1004Use @option{fd=h} to specify an already opened UDP multicast socket.
1005@end enumerate
1006
1007Example:
1008@example
1009# launch one QEMU instance
1010qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1011               -net socket,mcast=230.0.0.1:1234
1012# launch another QEMU instance on same "bus"
1013qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1014               -net socket,mcast=230.0.0.1:1234
1015# launch yet another QEMU instance on same "bus"
1016qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
1017               -net socket,mcast=230.0.0.1:1234
1018@end example
1019
1020Example (User Mode Linux compat.):
1021@example
1022# launch QEMU instance (note mcast address selected
1023# is UML's default)
1024qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1025               -net socket,mcast=239.192.168.1:1102
1026# launch UML
1027/path/to/linux ubd0=/path/to/root_fs eth0=mcast
1028@end example
1029
1030@item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
1031Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
1032listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
1033and MODE @var{octalmode} to change default ownership and permissions for
1034communication port. This option is available only if QEMU has been compiled
1035with vde support enabled.
1036
1037Example:
1038@example
1039# launch vde switch
1040vde_switch -F -sock /tmp/myswitch
1041# launch QEMU instance
1042qemu linux.img -net nic -net vde,sock=/tmp/myswitch
1043@end example
1044
1045@item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
1046Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
1047At most @var{len} bytes (64k by default) per packet are stored. The file format is
1048libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
1049
1050@item -net none
1051Indicate that no network devices should be configured. It is used to
1052override the default configuration (@option{-net nic -net user}) which
1053is activated if no @option{-net} options are provided.
1054
1055@end table
1056ETEXI
1057
1058DEF("bt", HAS_ARG, QEMU_OPTION_bt, \
1059    "\n" \
1060    "-bt hci,null    dumb bluetooth HCI - doesn't respond to commands\n" \
1061    "-bt hci,host[:id]\n" \
1062    "                use host's HCI with the given name\n" \
1063    "-bt hci[,vlan=n]\n" \
1064    "                emulate a standard HCI in virtual scatternet 'n'\n" \
1065    "-bt vhci[,vlan=n]\n" \
1066    "                add host computer to virtual scatternet 'n' using VHCI\n" \
1067    "-bt device:dev[,vlan=n]\n" \
1068    "                emulate a bluetooth device 'dev' in scatternet 'n'\n")
1069STEXI
1070Bluetooth(R) options:
1071@table @option
1072
1073@item -bt hci[...]
1074Defines the function of the corresponding Bluetooth HCI.  -bt options
1075are matched with the HCIs present in the chosen machine type.  For
1076example when emulating a machine with only one HCI built into it, only
1077the first @code{-bt hci[...]} option is valid and defines the HCI's
1078logic.  The Transport Layer is decided by the machine type.  Currently
1079the machines @code{n800} and @code{n810} have one HCI and all other
1080machines have none.
1081
1082@anchor{bt-hcis}
1083The following three types are recognized:
1084
1085@table @code
1086@item -bt hci,null
1087(default) The corresponding Bluetooth HCI assumes no internal logic
1088and will not respond to any HCI commands or emit events.
1089
1090@item -bt hci,host[:@var{id}]
1091(@code{bluez} only) The corresponding HCI passes commands / events
1092to / from the physical HCI identified by the name @var{id} (default:
1093@code{hci0}) on the computer running QEMU.  Only available on @code{bluez}
1094capable systems like Linux.
1095
1096@item -bt hci[,vlan=@var{n}]
1097Add a virtual, standard HCI that will participate in the Bluetooth
1098scatternet @var{n} (default @code{0}).  Similarly to @option{-net}
1099VLANs, devices inside a bluetooth network @var{n} can only communicate
1100with other devices in the same network (scatternet).
1101@end table
1102
1103@item -bt vhci[,vlan=@var{n}]
1104(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
1105to the host bluetooth stack instead of to the emulated target.  This
1106allows the host and target machines to participate in a common scatternet
1107and communicate.  Requires the Linux @code{vhci} driver installed.  Can
1108be used as following:
1109
1110@example
1111qemu [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
1112@end example
1113
1114@item -bt device:@var{dev}[,vlan=@var{n}]
1115Emulate a bluetooth device @var{dev} and place it in network @var{n}
1116(default @code{0}).  QEMU can only emulate one type of bluetooth devices
1117currently:
1118
1119@table @code
1120@item keyboard
1121Virtual wireless keyboard implementing the HIDP bluetooth profile.
1122@end table
1123@end table
1124ETEXI
1125
1126DEFHEADING()
1127
1128DEFHEADING(Linux/Multiboot boot specific:)
1129STEXI
1130
1131When using these options, you can use a given Linux or Multiboot
1132kernel without installing it in the disk image. It can be useful
1133for easier testing of various kernels.
1134
1135@table @option
1136ETEXI
1137
1138DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \
1139    "-kernel bzImage use 'bzImage' as kernel image\n")
1140STEXI
1141@item -kernel @var{bzImage}
1142Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel
1143or in multiboot format.
1144ETEXI
1145
1146DEF("append", HAS_ARG, QEMU_OPTION_append, \
1147    "-append cmdline use 'cmdline' as kernel command line\n")
1148STEXI
1149@item -append @var{cmdline}
1150Use @var{cmdline} as kernel command line
1151ETEXI
1152
1153DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \
1154           "-initrd file    use 'file' as initial ram disk\n")
1155STEXI
1156@item -initrd @var{file}
1157Use @var{file} as initial ram disk.
1158
1159@item -initrd "@var{file1} arg=foo,@var{file2}"
1160
1161This syntax is only available with multiboot.
1162
1163Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the
1164first module.
1165ETEXI
1166
1167STEXI
1168@end table
1169ETEXI
1170
1171DEFHEADING()
1172
1173DEFHEADING(Debug/Expert options:)
1174
1175STEXI
1176@table @option
1177ETEXI
1178
1179DEF("serial", HAS_ARG, QEMU_OPTION_serial, \
1180    "-serial dev     redirect the serial port to char device 'dev'\n")
1181STEXI
1182@item -serial @var{dev}
1183Redirect the virtual serial port to host character device
1184@var{dev}. The default device is @code{vc} in graphical mode and
1185@code{stdio} in non graphical mode.
1186
1187This option can be used several times to simulate up to 4 serial
1188ports.
1189
1190Use @code{-serial none} to disable all serial ports.
1191
1192Available character devices are:
1193@table @code
1194@item vc[:WxH]
1195Virtual console. Optionally, a width and height can be given in pixel with
1196@example
1197vc:800x600
1198@end example
1199It is also possible to specify width or height in characters:
1200@example
1201vc:80Cx24C
1202@end example
1203@item pty
1204[Linux only] Pseudo TTY (a new PTY is automatically allocated)
1205@item none
1206No device is allocated.
1207@item null
1208void device
1209@item /dev/XXX
1210[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
1211parameters are set according to the emulated ones.
1212@item /dev/parport@var{N}
1213[Linux only, parallel port only] Use host parallel port
1214@var{N}. Currently SPP and EPP parallel port features can be used.
1215@item file:@var{filename}
1216Write output to @var{filename}. No character can be read.
1217@item stdio
1218[Unix only] standard input/output
1219@item pipe:@var{filename}
1220name pipe @var{filename}
1221@item COM@var{n}
1222[Windows only] Use host serial port @var{n}
1223@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
1224This implements UDP Net Console.
1225When @var{remote_host} or @var{src_ip} are not specified
1226they default to @code{0.0.0.0}.
1227When not using a specified @var{src_port} a random port is automatically chosen.
1228@item msmouse
1229Three button serial mouse. Configure the guest to use Microsoft protocol.
1230
1231If you just want a simple readonly console you can use @code{netcat} or
1232@code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
1233@code{nc -u -l -p 4555}. Any time qemu writes something to that port it
1234will appear in the netconsole session.
1235
1236If you plan to send characters back via netconsole or you want to stop
1237and start qemu a lot of times, you should have qemu use the same
1238source port each time by using something like @code{-serial
1239udp::4555@@:4556} to qemu. Another approach is to use a patched
1240version of netcat which can listen to a TCP port and send and receive
1241characters via udp.  If you have a patched version of netcat which
1242activates telnet remote echo and single char transfer, then you can
1243use the following options to step up a netcat redirector to allow
1244telnet on port 5555 to access the qemu port.
1245@table @code
1246@item Qemu Options:
1247-serial udp::4555@@:4556
1248@item netcat options:
1249-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
1250@item telnet options:
1251localhost 5555
1252@end table
1253
1254@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay]
1255The TCP Net Console has two modes of operation.  It can send the serial
1256I/O to a location or wait for a connection from a location.  By default
1257the TCP Net Console is sent to @var{host} at the @var{port}.  If you use
1258the @var{server} option QEMU will wait for a client socket application
1259to connect to the port before continuing, unless the @code{nowait}
1260option was specified.  The @code{nodelay} option disables the Nagle buffering
1261algorithm.  If @var{host} is omitted, 0.0.0.0 is assumed. Only
1262one TCP connection at a time is accepted. You can use @code{telnet} to
1263connect to the corresponding character device.
1264@table @code
1265@item Example to send tcp console to 192.168.0.2 port 4444
1266-serial tcp:192.168.0.2:4444
1267@item Example to listen and wait on port 4444 for connection
1268-serial tcp::4444,server
1269@item Example to not wait and listen on ip 192.168.0.100 port 4444
1270-serial tcp:192.168.0.100:4444,server,nowait
1271@end table
1272
1273@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
1274The telnet protocol is used instead of raw tcp sockets.  The options
1275work the same as if you had specified @code{-serial tcp}.  The
1276difference is that the port acts like a telnet server or client using
1277telnet option negotiation.  This will also allow you to send the
1278MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
1279sequence.  Typically in unix telnet you do it with Control-] and then
1280type "send break" followed by pressing the enter key.
1281
1282@item unix:@var{path}[,server][,nowait]
1283A unix domain socket is used instead of a tcp socket.  The option works the
1284same as if you had specified @code{-serial tcp} except the unix domain socket
1285@var{path} is used for connections.
1286
1287@item mon:@var{dev_string}
1288This is a special option to allow the monitor to be multiplexed onto
1289another serial port.  The monitor is accessed with key sequence of
1290@key{Control-a} and then pressing @key{c}. See monitor access
1291@ref{pcsys_keys} in the -nographic section for more keys.
1292@var{dev_string} should be any one of the serial devices specified
1293above.  An example to multiplex the monitor onto a telnet server
1294listening on port 4444 would be:
1295@table @code
1296@item -serial mon:telnet::4444,server,nowait
1297@end table
1298
1299@item braille
1300Braille device.  This will use BrlAPI to display the braille output on a real
1301or fake device.
1302
1303@end table
1304ETEXI
1305
1306DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \
1307    "-parallel dev   redirect the parallel port to char device 'dev'\n")
1308STEXI
1309@item -parallel @var{dev}
1310Redirect the virtual parallel port to host device @var{dev} (same
1311devices as the serial port). On Linux hosts, @file{/dev/parportN} can
1312be used to use hardware devices connected on the corresponding host
1313parallel port.
1314
1315This option can be used several times to simulate up to 3 parallel
1316ports.
1317
1318Use @code{-parallel none} to disable all parallel ports.
1319ETEXI
1320
1321DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \
1322    "-monitor dev    redirect the monitor to char device 'dev'\n")
1323STEXI
1324@item -monitor @var{dev}
1325Redirect the monitor to host device @var{dev} (same devices as the
1326serial port).
1327The default device is @code{vc} in graphical mode and @code{stdio} in
1328non graphical mode.
1329ETEXI
1330
1331DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \
1332    "-pidfile file   write PID to 'file'\n")
1333STEXI
1334@item -pidfile @var{file}
1335Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
1336from a script.
1337ETEXI
1338
1339DEF("singlestep", 0, QEMU_OPTION_singlestep, \
1340    "-singlestep   always run in singlestep mode\n")
1341STEXI
1342@item -singlestep
1343Run the emulation in single step mode.
1344ETEXI
1345
1346DEF("S", 0, QEMU_OPTION_S, \
1347    "-S              freeze CPU at startup (use 'c' to start execution)\n")
1348STEXI
1349@item -S
1350Do not start CPU at startup (you must type 'c' in the monitor).
1351ETEXI
1352
1353DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \
1354    "-gdb dev        wait for gdb connection on 'dev'\n")
1355STEXI
1356@item -gdb @var{dev}
1357Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical
1358connections will likely be TCP-based, but also UDP, pseudo TTY, or even
1359stdio are reasonable use case. The latter is allowing to start qemu from
1360within gdb and establish the connection via a pipe:
1361@example
1362(gdb) target remote | exec qemu -gdb stdio ...
1363@end example
1364ETEXI
1365
1366DEF("s", 0, QEMU_OPTION_s, \
1367    "-s              shorthand for -gdb tcp::%s\n")
1368STEXI
1369@item -s
1370Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
1371(@pxref{gdb_usage}).
1372ETEXI
1373
1374DEF("d", HAS_ARG, QEMU_OPTION_d, \
1375    "-d item1,...    output log to %s (use -d ? for a list of log items)\n")
1376STEXI
1377@item -d
1378Output log in /tmp/qemu.log
1379ETEXI
1380
1381DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \
1382    "-hdachs c,h,s[,t]\n" \
1383    "                force hard disk 0 physical geometry and the optional BIOS\n" \
1384    "                translation (t=none or lba) (usually qemu can guess them)\n")
1385STEXI
1386@item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
1387Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
1388@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
1389translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
1390all those parameters. This option is useful for old MS-DOS disk
1391images.
1392ETEXI
1393
1394DEF("L", HAS_ARG, QEMU_OPTION_L, \
1395    "-L path         set the directory for the BIOS, VGA BIOS and keymaps\n")
1396STEXI
1397@item -L  @var{path}
1398Set the directory for the BIOS, VGA BIOS and keymaps.
1399ETEXI
1400
1401DEF("bios", HAS_ARG, QEMU_OPTION_bios, \
1402    "-bios file      set the filename for the BIOS\n")
1403STEXI
1404@item -bios @var{file}
1405Set the filename for the BIOS.
1406ETEXI
1407
1408#ifdef CONFIG_KQEMU
1409DEF("kernel-kqemu", 0, QEMU_OPTION_kernel_kqemu, \
1410    "-kernel-kqemu   enable KQEMU full virtualization (default is user mode only)\n")
1411#endif
1412STEXI
1413@item -kernel-kqemu
1414Enable KQEMU full virtualization (default is user mode only).
1415ETEXI
1416
1417#ifdef CONFIG_KQEMU
1418DEF("enable-kqemu", 0, QEMU_OPTION_enable_kqemu, \
1419    "-enable-kqemu   enable KQEMU kernel module usage\n")
1420#endif
1421STEXI
1422@item -enable-kqemu
1423Enable KQEMU kernel module usage. KQEMU options are only available if
1424KQEMU support is enabled when compiling.
1425ETEXI
1426
1427#ifdef CONFIG_KVM
1428DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \
1429    "-enable-kvm     enable KVM full virtualization support\n")
1430#endif
1431STEXI
1432@item -enable-kvm
1433Enable KVM full virtualization support. This option is only available
1434if KVM support is enabled when compiling.
1435ETEXI
1436
1437#ifdef CONFIG_XEN
1438DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid,
1439    "-xen-domid id   specify xen guest domain id\n")
1440DEF("xen-create", 0, QEMU_OPTION_xen_create,
1441    "-xen-create     create domain using xen hypercalls, bypassing xend\n"
1442    "                warning: should not be used when xend is in use\n")
1443DEF("xen-attach", 0, QEMU_OPTION_xen_attach,
1444    "-xen-attach     attach to existing xen domain\n"
1445    "                xend will use this when starting qemu\n")
1446#endif
1447
1448DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \
1449    "-no-reboot      exit instead of rebooting\n")
1450STEXI
1451@item -no-reboot
1452Exit instead of rebooting.
1453ETEXI
1454
1455DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \
1456    "-no-shutdown    stop before shutdown\n")
1457STEXI
1458@item -no-shutdown
1459Don't exit QEMU on guest shutdown, but instead only stop the emulation.
1460This allows for instance switching to monitor to commit changes to the
1461disk image.
1462ETEXI
1463
1464DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \
1465    "-loadvm [tag|id]\n" \
1466    "                start right away with a saved state (loadvm in monitor)\n")
1467STEXI
1468@item -loadvm @var{file}
1469Start right away with a saved state (@code{loadvm} in monitor)
1470ETEXI
1471
1472#ifndef _WIN32
1473DEF("daemonize", 0, QEMU_OPTION_daemonize, \
1474    "-daemonize      daemonize QEMU after initializing\n")
1475#endif
1476STEXI
1477@item -daemonize
1478Daemonize the QEMU process after initialization.  QEMU will not detach from
1479standard IO until it is ready to receive connections on any of its devices.
1480This option is a useful way for external programs to launch QEMU without having
1481to cope with initialization race conditions.
1482ETEXI
1483
1484DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \
1485    "-option-rom rom load a file, rom, into the option ROM space\n")
1486STEXI
1487@item -option-rom @var{file}
1488Load the contents of @var{file} as an option ROM.
1489This option is useful to load things like EtherBoot.
1490ETEXI
1491
1492DEF("clock", HAS_ARG, QEMU_OPTION_clock, \
1493    "-clock          force the use of the given methods for timer alarm.\n" \
1494    "                To see what timers are available use -clock ?\n")
1495STEXI
1496@item -clock @var{method}
1497Force the use of the given methods for timer alarm. To see what timers
1498are available use -clock ?.
1499ETEXI
1500
1501DEF("localtime", 0, QEMU_OPTION_localtime, \
1502    "-localtime      set the real time clock to local time [default=utc]\n")
1503STEXI
1504@item -localtime
1505Set the real time clock to local time (the default is to UTC
1506time). This option is needed to have correct date in MS-DOS or
1507Windows.
1508ETEXI
1509
1510DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, \
1511    "-startdate      select initial date of the clock\n")
1512STEXI
1513
1514@item -startdate @var{date}
1515Set the initial date of the real time clock. Valid formats for
1516@var{date} are: @code{now} or @code{2006-06-17T16:01:21} or
1517@code{2006-06-17}. The default value is @code{now}.
1518ETEXI
1519
1520DEF("icount", HAS_ARG, QEMU_OPTION_icount, \
1521    "-icount [N|auto]\n" \
1522    "                enable virtual instruction counter with 2^N clock ticks per\n" \
1523    "                instruction\n")
1524STEXI
1525@item -icount [N|auto]
1526Enable virtual instruction counter.  The virtual cpu will execute one
1527instruction every 2^N ns of virtual time.  If @code{auto} is specified
1528then the virtual cpu speed will be automatically adjusted to keep virtual
1529time within a few seconds of real time.
1530
1531Note that while this option can give deterministic behavior, it does not
1532provide cycle accurate emulation.  Modern CPUs contain superscalar out of
1533order cores with complex cache hierarchies.  The number of instructions
1534executed often has little or no correlation with actual performance.
1535ETEXI
1536
1537DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \
1538    "-watchdog i6300esb|ib700\n" \
1539    "                enable virtual hardware watchdog [default=none]\n")
1540STEXI
1541@item -watchdog @var{model}
1542Create a virtual hardware watchdog device.  Once enabled (by a guest
1543action), the watchdog must be periodically polled by an agent inside
1544the guest or else the guest will be restarted.
1545
1546The @var{model} is the model of hardware watchdog to emulate.  Choices
1547for model are: @code{ib700} (iBASE 700) which is a very simple ISA
1548watchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O
1549controller hub) which is a much more featureful PCI-based dual-timer
1550watchdog.  Choose a model for which your guest has drivers.
1551
1552Use @code{-watchdog ?} to list available hardware models.  Only one
1553watchdog can be enabled for a guest.
1554ETEXI
1555
1556DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \
1557    "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \
1558    "                action when watchdog fires [default=reset]\n")
1559STEXI
1560@item -watchdog-action @var{action}
1561
1562The @var{action} controls what QEMU will do when the watchdog timer
1563expires.
1564The default is
1565@code{reset} (forcefully reset the guest).
1566Other possible actions are:
1567@code{shutdown} (attempt to gracefully shutdown the guest),
1568@code{poweroff} (forcefully poweroff the guest),
1569@code{pause} (pause the guest),
1570@code{debug} (print a debug message and continue), or
1571@code{none} (do nothing).
1572
1573Note that the @code{shutdown} action requires that the guest responds
1574to ACPI signals, which it may not be able to do in the sort of
1575situations where the watchdog would have expired, and thus
1576@code{-watchdog-action shutdown} is not recommended for production use.
1577
1578Examples:
1579
1580@table @code
1581@item -watchdog i6300esb -watchdog-action pause
1582@item -watchdog ib700
1583@end table
1584ETEXI
1585
1586DEF("echr", HAS_ARG, QEMU_OPTION_echr, \
1587    "-echr chr       set terminal escape character instead of ctrl-a\n")
1588STEXI
1589
1590@item -echr numeric_ascii_value
1591Change the escape character used for switching to the monitor when using
1592monitor and serial sharing.  The default is @code{0x01} when using the
1593@code{-nographic} option.  @code{0x01} is equal to pressing
1594@code{Control-a}.  You can select a different character from the ascii
1595control keys where 1 through 26 map to Control-a through Control-z.  For
1596instance you could use the either of the following to change the escape
1597character to Control-t.
1598@table @code
1599@item -echr 0x14
1600@item -echr 20
1601@end table
1602ETEXI
1603
1604DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \
1605    "-virtioconsole c\n" \
1606    "                set virtio console\n")
1607STEXI
1608@item -virtioconsole @var{c}
1609Set virtio console.
1610ETEXI
1611
1612DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \
1613    "-show-cursor    show cursor\n")
1614STEXI
1615ETEXI
1616
1617DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \
1618    "-tb-size n      set TB size\n")
1619STEXI
1620ETEXI
1621
1622DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \
1623    "-incoming p     prepare for incoming migration, listen on port p\n")
1624STEXI
1625ETEXI
1626
1627#ifndef _WIN32
1628DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \
1629    "-chroot dir     Chroot to dir just before starting the VM.\n")
1630#endif
1631STEXI
1632@item -chroot dir
1633Immediately before starting guest execution, chroot to the specified
1634directory.  Especially useful in combination with -runas.
1635ETEXI
1636
1637#ifndef _WIN32
1638DEF("runas", HAS_ARG, QEMU_OPTION_runas, \
1639    "-runas user     Change to user id user just before starting the VM.\n")
1640#endif
1641STEXI
1642@item -runas user
1643Immediately before starting guest execution, drop root privileges, switching
1644to the specified user.
1645ETEXI
1646
1647STEXI
1648@end table
1649ETEXI
1650
1651#if defined(TARGET_SPARC) || defined(TARGET_PPC)
1652DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env,
1653    "-prom-env variable=value\n"
1654    "                set OpenBIOS nvram variables\n")
1655#endif
1656#if defined(TARGET_ARM) || defined(TARGET_M68K)
1657DEF("semihosting", 0, QEMU_OPTION_semihosting,
1658    "-semihosting    semihosting mode\n")
1659#endif
1660#if defined(TARGET_ARM)
1661DEF("old-param", 0, QEMU_OPTION_old_param,
1662    "-old-param      old param mode\n")
1663#endif
1664