qemu-options.hx

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