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