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