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