qemu-options.hx

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