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