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