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