1HXCOMM Use DEFHEADING() to define headings in both help text and texi 2HXCOMM Text between STEXI and ETEXI are copied to texi version and 3HXCOMM discarded from C version 4HXCOMM DEF(option, HAS_ARG/0, opt_enum, opt_help, arch_mask) is used to 5HXCOMM construct option structures, enums and help message for specified 6HXCOMM architectures. 7HXCOMM HXCOMM can be used for comments, discarded from both texi and C 8 9DEFHEADING(Standard options:) 10STEXI 11@table @option 12ETEXI 13 14DEF("help", 0, QEMU_OPTION_h, 15 "-h or -help display this help and exit\n", QEMU_ARCH_ALL) 16STEXI 17@item -h 18@findex -h 19Display help and exit 20ETEXI 21 22DEF("version", 0, QEMU_OPTION_version, 23 "-version display version information and exit\n", QEMU_ARCH_ALL) 24STEXI 25@item -version 26@findex -version 27Display version information and exit 28ETEXI 29 30DEF("machine", HAS_ARG, QEMU_OPTION_machine, \ 31 "-machine [type=]name[,prop[=value][,...]]\n" 32 " selects emulated machine ('-machine help' for list)\n" 33 " property accel=accel1[:accel2[:...]] selects accelerator\n" 34 " supported accelerators are kvm, xen, tcg (default: tcg)\n" 35 " kernel_irqchip=on|off controls accelerated irqchip support\n" 36 " kvm_shadow_mem=size of KVM shadow MMU\n" 37 " dump-guest-core=on|off include guest memory in a core dump (default=on)\n" 38 " mem-merge=on|off controls memory merge support (default: on)\n", 39 QEMU_ARCH_ALL) 40STEXI 41@item -machine [type=]@var{name}[,prop=@var{value}[,...]] 42@findex -machine 43Select the emulated machine by @var{name}. Use @code{-machine help} to list 44available machines. Supported machine properties are: 45@table @option 46@item accel=@var{accels1}[:@var{accels2}[:...]] 47This is used to enable an accelerator. Depending on the target architecture, 48kvm, xen, or tcg can be available. By default, tcg is used. If there is more 49than one accelerator specified, the next one is used if the previous one fails 50to initialize. 51@item kernel_irqchip=on|off 52Enables in-kernel irqchip support for the chosen accelerator when available. 53@item kvm_shadow_mem=size 54Defines the size of the KVM shadow MMU. 55@item dump-guest-core=on|off 56Include guest memory in a core dump. The default is on. 57@item mem-merge=on|off 58Enables or disables memory merge support. This feature, when supported by 59the host, de-duplicates identical memory pages among VMs instances 60(enabled by default). 61@end table 62ETEXI 63 64HXCOMM Deprecated by -machine 65DEF("M", HAS_ARG, QEMU_OPTION_M, "", QEMU_ARCH_ALL) 66 67DEF("cpu", HAS_ARG, QEMU_OPTION_cpu, 68 "-cpu cpu select CPU ('-cpu help' for list)\n", QEMU_ARCH_ALL) 69STEXI 70@item -cpu @var{model} 71@findex -cpu 72Select CPU model (@code{-cpu help} for list and additional feature selection) 73ETEXI 74 75DEF("smp", HAS_ARG, QEMU_OPTION_smp, 76 "-smp n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n" 77 " set the number of CPUs to 'n' [default=1]\n" 78 " maxcpus= maximum number of total cpus, including\n" 79 " offline CPUs for hotplug, etc\n" 80 " cores= number of CPU cores on one socket\n" 81 " threads= number of threads on one CPU core\n" 82 " sockets= number of discrete sockets in the system\n", 83 QEMU_ARCH_ALL) 84STEXI 85@item -smp @var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}] 86@findex -smp 87Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255 88CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs 89to 4. 90For the PC target, the number of @var{cores} per socket, the number 91of @var{threads} per cores and the total number of @var{sockets} can be 92specified. Missing values will be computed. If any on the three values is 93given, the total number of CPUs @var{n} can be omitted. @var{maxcpus} 94specifies the maximum number of hotpluggable CPUs. 95ETEXI 96 97DEF("numa", HAS_ARG, QEMU_OPTION_numa, 98 "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL) 99STEXI 100@item -numa @var{opts} 101@findex -numa 102Simulate a multi node NUMA system. If mem and cpus are omitted, resources 103are split equally. 104ETEXI 105 106DEF("add-fd", HAS_ARG, QEMU_OPTION_add_fd, 107 "-add-fd fd=fd,set=set[,opaque=opaque]\n" 108 " Add 'fd' to fd 'set'\n", QEMU_ARCH_ALL) 109STEXI 110@item -add-fd fd=@var{fd},set=@var{set}[,opaque=@var{opaque}] 111@findex -add-fd 112 113Add a file descriptor to an fd set. Valid options are: 114 115@table @option 116@item fd=@var{fd} 117This option defines the file descriptor of which a duplicate is added to fd set. 118The file descriptor cannot be stdin, stdout, or stderr. 119@item set=@var{set} 120This option defines the ID of the fd set to add the file descriptor to. 121@item opaque=@var{opaque} 122This option defines a free-form string that can be used to describe @var{fd}. 123@end table 124 125You can open an image using pre-opened file descriptors from an fd set: 126@example 127qemu-system-i386 128-add-fd fd=3,set=2,opaque="rdwr:/path/to/file" 129-add-fd fd=4,set=2,opaque="rdonly:/path/to/file" 130-drive file=/dev/fdset/2,index=0,media=disk 131@end example 132ETEXI 133 134DEF("set", HAS_ARG, QEMU_OPTION_set, 135 "-set group.id.arg=value\n" 136 " set <arg> parameter for item <id> of type <group>\n" 137 " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL) 138STEXI 139@item -set @var{group}.@var{id}.@var{arg}=@var{value} 140@findex -set 141Set parameter @var{arg} for item @var{id} of type @var{group}\n" 142ETEXI 143 144DEF("global", HAS_ARG, QEMU_OPTION_global, 145 "-global driver.prop=value\n" 146 " set a global default for a driver property\n", 147 QEMU_ARCH_ALL) 148STEXI 149@item -global @var{driver}.@var{prop}=@var{value} 150@findex -global 151Set default value of @var{driver}'s property @var{prop} to @var{value}, e.g.: 152 153@example 154qemu-system-i386 -global ide-drive.physical_block_size=4096 -drive file=file,if=ide,index=0,media=disk 155@end example 156 157In particular, you can use this to set driver properties for devices which are 158created automatically by the machine model. To create a device which is not 159created automatically and set properties on it, use -@option{device}. 160ETEXI 161 162DEF("boot", HAS_ARG, QEMU_OPTION_boot, 163 "-boot [order=drives][,once=drives][,menu=on|off]\n" 164 " [,splash=sp_name][,splash-time=sp_time][,reboot-timeout=rb_time]\n" 165 " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n" 166 " 'sp_name': the file's name that would be passed to bios as logo picture, if menu=on\n" 167 " 'sp_time': the period that splash picture last if menu=on, unit is ms\n" 168 " 'rb_timeout': the timeout before guest reboot when boot failed, unit is ms\n", 169 QEMU_ARCH_ALL) 170STEXI 171@item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off][,splash=@var{sp_name}][,splash-time=@var{sp_time}][,reboot-timeout=@var{rb_timeout}] 172@findex -boot 173Specify boot order @var{drives} as a string of drive letters. Valid 174drive letters depend on the target achitecture. The x86 PC uses: a, b 175(floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot 176from network adapter 1-4), hard disk boot is the default. To apply a 177particular boot order only on the first startup, specify it via 178@option{once}. 179 180Interactive boot menus/prompts can be enabled via @option{menu=on} as far 181as firmware/BIOS supports them. The default is non-interactive boot. 182 183A splash picture could be passed to bios, enabling user to show it as logo, 184when option splash=@var{sp_name} is given and menu=on, If firmware/BIOS 185supports them. Currently Seabios for X86 system support it. 186limitation: The splash file could be a jpeg file or a BMP file in 24 BPP 187format(true color). The resolution should be supported by the SVGA mode, so 188the recommended is 320x240, 640x480, 800x640. 189 190A timeout could be passed to bios, guest will pause for @var{rb_timeout} ms 191when boot failed, then reboot. If @var{rb_timeout} is '-1', guest will not 192reboot, qemu passes '-1' to bios by default. Currently Seabios for X86 193system support it. 194 195@example 196# try to boot from network first, then from hard disk 197qemu-system-i386 -boot order=nc 198# boot from CD-ROM first, switch back to default order after reboot 199qemu-system-i386 -boot once=d 200# boot with a splash picture for 5 seconds. 201qemu-system-i386 -boot menu=on,splash=/root/boot.bmp,splash-time=5000 202@end example 203 204Note: The legacy format '-boot @var{drives}' is still supported but its 205use is discouraged as it may be removed from future versions. 206ETEXI 207 208DEF("m", HAS_ARG, QEMU_OPTION_m, 209 "-m megs set virtual RAM size to megs MB [default=" 210 stringify(DEFAULT_RAM_SIZE) "]\n", QEMU_ARCH_ALL) 211STEXI 212@item -m @var{megs} 213@findex -m 214Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally, 215a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or 216gigabytes respectively. 217ETEXI 218 219DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath, 220 "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL) 221STEXI 222@item -mem-path @var{path} 223@findex -mem-path 224Allocate guest RAM from a temporarily created file in @var{path}. 225ETEXI 226 227#ifdef MAP_POPULATE 228DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc, 229 "-mem-prealloc preallocate guest memory (use with -mem-path)\n", 230 QEMU_ARCH_ALL) 231STEXI 232@item -mem-prealloc 233@findex -mem-prealloc 234Preallocate memory when using -mem-path. 235ETEXI 236#endif 237 238DEF("k", HAS_ARG, QEMU_OPTION_k, 239 "-k language use keyboard layout (for example 'fr' for French)\n", 240 QEMU_ARCH_ALL) 241STEXI 242@item -k @var{language} 243@findex -k 244Use keyboard layout @var{language} (for example @code{fr} for 245French). This option is only needed where it is not easy to get raw PC 246keycodes (e.g. on Macs, with some X11 servers or with a VNC 247display). You don't normally need to use it on PC/Linux or PC/Windows 248hosts. 249 250The available layouts are: 251@example 252ar de-ch es fo fr-ca hu ja mk no pt-br sv 253da en-gb et fr fr-ch is lt nl pl ru th 254de en-us fi fr-be hr it lv nl-be pt sl tr 255@end example 256 257The default is @code{en-us}. 258ETEXI 259 260 261DEF("audio-help", 0, QEMU_OPTION_audio_help, 262 "-audio-help print list of audio drivers and their options\n", 263 QEMU_ARCH_ALL) 264STEXI 265@item -audio-help 266@findex -audio-help 267Will show the audio subsystem help: list of drivers, tunable 268parameters. 269ETEXI 270 271DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw, 272 "-soundhw c1,... enable audio support\n" 273 " and only specified sound cards (comma separated list)\n" 274 " use '-soundhw help' to get the list of supported cards\n" 275 " use '-soundhw all' to enable all of them\n", QEMU_ARCH_ALL) 276STEXI 277@item -soundhw @var{card1}[,@var{card2},...] or -soundhw all 278@findex -soundhw 279Enable audio and selected sound hardware. Use 'help' to print all 280available sound hardware. 281 282@example 283qemu-system-i386 -soundhw sb16,adlib disk.img 284qemu-system-i386 -soundhw es1370 disk.img 285qemu-system-i386 -soundhw ac97 disk.img 286qemu-system-i386 -soundhw hda disk.img 287qemu-system-i386 -soundhw all disk.img 288qemu-system-i386 -soundhw help 289@end example 290 291Note that Linux's i810_audio OSS kernel (for AC97) module might 292require manually specifying clocking. 293 294@example 295modprobe i810_audio clocking=48000 296@end example 297ETEXI 298 299DEF("balloon", HAS_ARG, QEMU_OPTION_balloon, 300 "-balloon none disable balloon device\n" 301 "-balloon virtio[,addr=str]\n" 302 " enable virtio balloon device (default)\n", QEMU_ARCH_ALL) 303STEXI 304@item -balloon none 305@findex -balloon 306Disable balloon device. 307@item -balloon virtio[,addr=@var{addr}] 308Enable virtio balloon device (default), optionally with PCI address 309@var{addr}. 310ETEXI 311 312DEF("device", HAS_ARG, QEMU_OPTION_device, 313 "-device driver[,prop[=value][,...]]\n" 314 " add device (based on driver)\n" 315 " prop=value,... sets driver properties\n" 316 " use '-device help' to print all possible drivers\n" 317 " use '-device driver,help' to print all possible properties\n", 318 QEMU_ARCH_ALL) 319STEXI 320@item -device @var{driver}[,@var{prop}[=@var{value}][,...]] 321@findex -device 322Add device @var{driver}. @var{prop}=@var{value} sets driver 323properties. Valid properties depend on the driver. To get help on 324possible drivers and properties, use @code{-device help} and 325@code{-device @var{driver},help}. 326ETEXI 327 328DEF("name", HAS_ARG, QEMU_OPTION_name, 329 "-name string1[,process=string2]\n" 330 " set the name of the guest\n" 331 " string1 sets the window title and string2 the process name (on Linux)\n", 332 QEMU_ARCH_ALL) 333STEXI 334@item -name @var{name} 335@findex -name 336Sets the @var{name} of the guest. 337This name will be displayed in the SDL window caption. 338The @var{name} will also be used for the VNC server. 339Also optionally set the top visible process name in Linux. 340ETEXI 341 342DEF("uuid", HAS_ARG, QEMU_OPTION_uuid, 343 "-uuid %08x-%04x-%04x-%04x-%012x\n" 344 " specify machine UUID\n", QEMU_ARCH_ALL) 345STEXI 346@item -uuid @var{uuid} 347@findex -uuid 348Set system UUID. 349ETEXI 350 351STEXI 352@end table 353ETEXI 354DEFHEADING() 355 356DEFHEADING(Block device options:) 357STEXI 358@table @option 359ETEXI 360 361DEF("fda", HAS_ARG, QEMU_OPTION_fda, 362 "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL) 363DEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL) 364STEXI 365@item -fda @var{file} 366@item -fdb @var{file} 367@findex -fda 368@findex -fdb 369Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can 370use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}). 371ETEXI 372 373DEF("hda", HAS_ARG, QEMU_OPTION_hda, 374 "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL) 375DEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL) 376DEF("hdc", HAS_ARG, QEMU_OPTION_hdc, 377 "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL) 378DEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL) 379STEXI 380@item -hda @var{file} 381@item -hdb @var{file} 382@item -hdc @var{file} 383@item -hdd @var{file} 384@findex -hda 385@findex -hdb 386@findex -hdc 387@findex -hdd 388Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}). 389ETEXI 390 391DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom, 392 "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n", 393 QEMU_ARCH_ALL) 394STEXI 395@item -cdrom @var{file} 396@findex -cdrom 397Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and 398@option{-cdrom} at the same time). You can use the host CD-ROM by 399using @file{/dev/cdrom} as filename (@pxref{host_drives}). 400ETEXI 401 402DEF("drive", HAS_ARG, QEMU_OPTION_drive, 403 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n" 404 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n" 405 " [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n" 406 " [,serial=s][,addr=A][,id=name][,aio=threads|native]\n" 407 " [,readonly=on|off][,copy-on-read=on|off]\n" 408 " [[,bps=b]|[[,bps_rd=r][,bps_wr=w]]][[,iops=i]|[[,iops_rd=r][,iops_wr=w]]\n" 409 " use 'file' as a drive image\n", QEMU_ARCH_ALL) 410STEXI 411@item -drive @var{option}[,@var{option}[,@var{option}[,...]]] 412@findex -drive 413 414Define a new drive. Valid options are: 415 416@table @option 417@item file=@var{file} 418This option defines which disk image (@pxref{disk_images}) to use with 419this drive. If the filename contains comma, you must double it 420(for instance, "file=my,,file" to use file "my,file"). 421 422Special files such as iSCSI devices can be specified using protocol 423specific URLs. See the section for "Device URL Syntax" for more information. 424@item if=@var{interface} 425This option defines on which type on interface the drive is connected. 426Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio. 427@item bus=@var{bus},unit=@var{unit} 428These options define where is connected the drive by defining the bus number and 429the unit id. 430@item index=@var{index} 431This option defines where is connected the drive by using an index in the list 432of available connectors of a given interface type. 433@item media=@var{media} 434This option defines the type of the media: disk or cdrom. 435@item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}] 436These options have the same definition as they have in @option{-hdachs}. 437@item snapshot=@var{snapshot} 438@var{snapshot} is "on" or "off" and allows to enable snapshot for given drive (see @option{-snapshot}). 439@item cache=@var{cache} 440@var{cache} is "none", "writeback", "unsafe", "directsync" or "writethrough" and controls how the host cache is used to access block data. 441@item aio=@var{aio} 442@var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO. 443@item format=@var{format} 444Specify which disk @var{format} will be used rather than detecting 445the format. Can be used to specifiy format=raw to avoid interpreting 446an untrusted format header. 447@item serial=@var{serial} 448This option specifies the serial number to assign to the device. 449@item addr=@var{addr} 450Specify the controller's PCI address (if=virtio only). 451@item werror=@var{action},rerror=@var{action} 452Specify which @var{action} to take on write and read errors. Valid actions are: 453"ignore" (ignore the error and try to continue), "stop" (pause QEMU), 454"report" (report the error to the guest), "enospc" (pause QEMU only if the 455host disk is full; report the error to the guest otherwise). 456The default setting is @option{werror=enospc} and @option{rerror=report}. 457@item readonly 458Open drive @option{file} as read-only. Guest write attempts will fail. 459@item copy-on-read=@var{copy-on-read} 460@var{copy-on-read} is "on" or "off" and enables whether to copy read backing 461file sectors into the image file. 462@end table 463 464By default, the @option{cache=writeback} mode is used. It will report data 465writes as completed as soon as the data is present in the host page cache. 466This is safe as long as your guest OS makes sure to correctly flush disk caches 467where needed. If your guest OS does not handle volatile disk write caches 468correctly and your host crashes or loses power, then the guest may experience 469data corruption. 470 471For such guests, you should consider using @option{cache=writethrough}. This 472means that the host page cache will be used to read and write data, but write 473notification will be sent to the guest only after QEMU has made sure to flush 474each write to the disk. Be aware that this has a major impact on performance. 475 476The host page cache can be avoided entirely with @option{cache=none}. This will 477attempt to do disk IO directly to the guest's memory. QEMU may still perform 478an internal copy of the data. Note that this is considered a writeback mode and 479the guest OS must handle the disk write cache correctly in order to avoid data 480corruption on host crashes. 481 482The host page cache can be avoided while only sending write notifications to 483the guest when the data has been flushed to the disk using 484@option{cache=directsync}. 485 486In case you don't care about data integrity over host failures, use 487@option{cache=unsafe}. This option tells QEMU that it never needs to write any 488data to the disk but can instead keep things in cache. If anything goes wrong, 489like your host losing power, the disk storage getting disconnected accidentally, 490etc. your image will most probably be rendered unusable. When using 491the @option{-snapshot} option, unsafe caching is always used. 492 493Copy-on-read avoids accessing the same backing file sectors repeatedly and is 494useful when the backing file is over a slow network. By default copy-on-read 495is off. 496 497Instead of @option{-cdrom} you can use: 498@example 499qemu-system-i386 -drive file=file,index=2,media=cdrom 500@end example 501 502Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can 503use: 504@example 505qemu-system-i386 -drive file=file,index=0,media=disk 506qemu-system-i386 -drive file=file,index=1,media=disk 507qemu-system-i386 -drive file=file,index=2,media=disk 508qemu-system-i386 -drive file=file,index=3,media=disk 509@end example 510 511You can open an image using pre-opened file descriptors from an fd set: 512@example 513qemu-system-i386 514-add-fd fd=3,set=2,opaque="rdwr:/path/to/file" 515-add-fd fd=4,set=2,opaque="rdonly:/path/to/file" 516-drive file=/dev/fdset/2,index=0,media=disk 517@end example 518 519You can connect a CDROM to the slave of ide0: 520@example 521qemu-system-i386 -drive file=file,if=ide,index=1,media=cdrom 522@end example 523 524If you don't specify the "file=" argument, you define an empty drive: 525@example 526qemu-system-i386 -drive if=ide,index=1,media=cdrom 527@end example 528 529You can connect a SCSI disk with unit ID 6 on the bus #0: 530@example 531qemu-system-i386 -drive file=file,if=scsi,bus=0,unit=6 532@end example 533 534Instead of @option{-fda}, @option{-fdb}, you can use: 535@example 536qemu-system-i386 -drive file=file,index=0,if=floppy 537qemu-system-i386 -drive file=file,index=1,if=floppy 538@end example 539 540By default, @var{interface} is "ide" and @var{index} is automatically 541incremented: 542@example 543qemu-system-i386 -drive file=a -drive file=b" 544@end example 545is interpreted like: 546@example 547qemu-system-i386 -hda a -hdb b 548@end example 549ETEXI 550 551DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock, 552 "-mtdblock file use 'file' as on-board Flash memory image\n", 553 QEMU_ARCH_ALL) 554STEXI 555@item -mtdblock @var{file} 556@findex -mtdblock 557Use @var{file} as on-board Flash memory image. 558ETEXI 559 560DEF("sd", HAS_ARG, QEMU_OPTION_sd, 561 "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL) 562STEXI 563@item -sd @var{file} 564@findex -sd 565Use @var{file} as SecureDigital card image. 566ETEXI 567 568DEF("pflash", HAS_ARG, QEMU_OPTION_pflash, 569 "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL) 570STEXI 571@item -pflash @var{file} 572@findex -pflash 573Use @var{file} as a parallel flash image. 574ETEXI 575 576DEF("snapshot", 0, QEMU_OPTION_snapshot, 577 "-snapshot write to temporary files instead of disk image files\n", 578 QEMU_ARCH_ALL) 579STEXI 580@item -snapshot 581@findex -snapshot 582Write to temporary files instead of disk image files. In this case, 583the raw disk image you use is not written back. You can however force 584the write back by pressing @key{C-a s} (@pxref{disk_images}). 585ETEXI 586 587DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \ 588 "-hdachs c,h,s[,t]\n" \ 589 " force hard disk 0 physical geometry and the optional BIOS\n" \ 590 " translation (t=none or lba) (usually QEMU can guess them)\n", 591 QEMU_ARCH_ALL) 592STEXI 593@item -hdachs @var{c},@var{h},@var{s},[,@var{t}] 594@findex -hdachs 595Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <= 596@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS 597translation mode (@var{t}=none, lba or auto). Usually QEMU can guess 598all those parameters. This option is useful for old MS-DOS disk 599images. 600ETEXI 601 602DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev, 603 "-fsdev fsdriver,id=id[,path=path,][security_model={mapped-xattr|mapped-file|passthrough|none}]\n" 604 " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n", 605 QEMU_ARCH_ALL) 606 607STEXI 608 609@item -fsdev @var{fsdriver},id=@var{id},path=@var{path},[security_model=@var{security_model}][,writeout=@var{writeout}][,readonly][,socket=@var{socket}|sock_fd=@var{sock_fd}] 610@findex -fsdev 611Define a new file system device. Valid options are: 612@table @option 613@item @var{fsdriver} 614This option specifies the fs driver backend to use. 615Currently "local", "handle" and "proxy" file system drivers are supported. 616@item id=@var{id} 617Specifies identifier for this device 618@item path=@var{path} 619Specifies the export path for the file system device. Files under 620this path will be available to the 9p client on the guest. 621@item security_model=@var{security_model} 622Specifies the security model to be used for this export path. 623Supported security models are "passthrough", "mapped-xattr", "mapped-file" and "none". 624In "passthrough" security model, files are stored using the same 625credentials as they are created on the guest. This requires QEMU 626to run as root. In "mapped-xattr" security model, some of the file 627attributes like uid, gid, mode bits and link target are stored as 628file attributes. For "mapped-file" these attributes are stored in the 629hidden .virtfs_metadata directory. Directories exported by this security model cannot 630interact with other unix tools. "none" security model is same as 631passthrough except the sever won't report failures if it fails to 632set file attributes like ownership. Security model is mandatory 633only for local fsdriver. Other fsdrivers (like handle, proxy) don't take 634security model as a parameter. 635@item writeout=@var{writeout} 636This is an optional argument. The only supported value is "immediate". 637This means that host page cache will be used to read and write data but 638write notification will be sent to the guest only when the data has been 639reported as written by the storage subsystem. 640@item readonly 641Enables exporting 9p share as a readonly mount for guests. By default 642read-write access is given. 643@item socket=@var{socket} 644Enables proxy filesystem driver to use passed socket file for communicating 645with virtfs-proxy-helper 646@item sock_fd=@var{sock_fd} 647Enables proxy filesystem driver to use passed socket descriptor for 648communicating with virtfs-proxy-helper. Usually a helper like libvirt 649will create socketpair and pass one of the fds as sock_fd 650@end table 651 652-fsdev option is used along with -device driver "virtio-9p-pci". 653@item -device virtio-9p-pci,fsdev=@var{id},mount_tag=@var{mount_tag} 654Options for virtio-9p-pci driver are: 655@table @option 656@item fsdev=@var{id} 657Specifies the id value specified along with -fsdev option 658@item mount_tag=@var{mount_tag} 659Specifies the tag name to be used by the guest to mount this export point 660@end table 661 662ETEXI 663 664DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs, 665 "-virtfs local,path=path,mount_tag=tag,security_model=[mapped-xattr|mapped-file|passthrough|none]\n" 666 " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n", 667 QEMU_ARCH_ALL) 668 669STEXI 670 671@item -virtfs @var{fsdriver}[,path=@var{path}],mount_tag=@var{mount_tag}[,security_model=@var{security_model}][,writeout=@var{writeout}][,readonly][,socket=@var{socket}|sock_fd=@var{sock_fd}] 672@findex -virtfs 673 674The general form of a Virtual File system pass-through options are: 675@table @option 676@item @var{fsdriver} 677This option specifies the fs driver backend to use. 678Currently "local", "handle" and "proxy" file system drivers are supported. 679@item id=@var{id} 680Specifies identifier for this device 681@item path=@var{path} 682Specifies the export path for the file system device. Files under 683this path will be available to the 9p client on the guest. 684@item security_model=@var{security_model} 685Specifies the security model to be used for this export path. 686Supported security models are "passthrough", "mapped-xattr", "mapped-file" and "none". 687In "passthrough" security model, files are stored using the same 688credentials as they are created on the guest. This requires QEMU 689to run as root. In "mapped-xattr" security model, some of the file 690attributes like uid, gid, mode bits and link target are stored as 691file attributes. For "mapped-file" these attributes are stored in the 692hidden .virtfs_metadata directory. Directories exported by this security model cannot 693interact with other unix tools. "none" security model is same as 694passthrough except the sever won't report failures if it fails to 695set file attributes like ownership. Security model is mandatory only 696for local fsdriver. Other fsdrivers (like handle, proxy) don't take security 697model as a parameter. 698@item writeout=@var{writeout} 699This is an optional argument. The only supported value is "immediate". 700This means that host page cache will be used to read and write data but 701write notification will be sent to the guest only when the data has been 702reported as written by the storage subsystem. 703@item readonly 704Enables exporting 9p share as a readonly mount for guests. By default 705read-write access is given. 706@item socket=@var{socket} 707Enables proxy filesystem driver to use passed socket file for 708communicating with virtfs-proxy-helper. Usually a helper like libvirt 709will create socketpair and pass one of the fds as sock_fd 710@item sock_fd 711Enables proxy filesystem driver to use passed 'sock_fd' as the socket 712descriptor for interfacing with virtfs-proxy-helper 713@end table 714ETEXI 715 716DEF("virtfs_synth", 0, QEMU_OPTION_virtfs_synth, 717 "-virtfs_synth Create synthetic file system image\n", 718 QEMU_ARCH_ALL) 719STEXI 720@item -virtfs_synth 721@findex -virtfs_synth 722Create synthetic file system image 723ETEXI 724 725STEXI 726@end table 727ETEXI 728DEFHEADING() 729 730DEFHEADING(USB options:) 731STEXI 732@table @option 733ETEXI 734 735DEF("usb", 0, QEMU_OPTION_usb, 736 "-usb enable the USB driver (will be the default soon)\n", 737 QEMU_ARCH_ALL) 738STEXI 739@item -usb 740@findex -usb 741Enable the USB driver (will be the default soon) 742ETEXI 743 744DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice, 745 "-usbdevice name add the host or guest USB device 'name'\n", 746 QEMU_ARCH_ALL) 747STEXI 748 749@item -usbdevice @var{devname} 750@findex -usbdevice 751Add the USB device @var{devname}. @xref{usb_devices}. 752 753@table @option 754 755@item mouse 756Virtual Mouse. This will override the PS/2 mouse emulation when activated. 757 758@item tablet 759Pointer device that uses absolute coordinates (like a touchscreen). This 760means QEMU is able to report the mouse position without having to grab the 761mouse. Also overrides the PS/2 mouse emulation when activated. 762 763@item disk:[format=@var{format}]:@var{file} 764Mass storage device based on file. The optional @var{format} argument 765will be used rather than detecting the format. Can be used to specifiy 766@code{format=raw} to avoid interpreting an untrusted format header. 767 768@item host:@var{bus}.@var{addr} 769Pass through the host device identified by @var{bus}.@var{addr} (Linux only). 770 771@item host:@var{vendor_id}:@var{product_id} 772Pass through the host device identified by @var{vendor_id}:@var{product_id} 773(Linux only). 774 775@item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev} 776Serial converter to host character device @var{dev}, see @code{-serial} for the 777available devices. 778 779@item braille 780Braille device. This will use BrlAPI to display the braille output on a real 781or fake device. 782 783@item net:@var{options} 784Network adapter that supports CDC ethernet and RNDIS protocols. 785 786@end table 787ETEXI 788 789STEXI 790@end table 791ETEXI 792DEFHEADING() 793 794DEFHEADING(Display options:) 795STEXI 796@table @option 797ETEXI 798 799DEF("display", HAS_ARG, QEMU_OPTION_display, 800 "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n" 801 " [,window_close=on|off]|curses|none|\n" 802 " vnc=<display>[,<optargs>]\n" 803 " select display type\n", QEMU_ARCH_ALL) 804STEXI 805@item -display @var{type} 806@findex -display 807Select type of display to use. This option is a replacement for the 808old style -sdl/-curses/... options. Valid values for @var{type} are 809@table @option 810@item sdl 811Display video output via SDL (usually in a separate graphics 812window; see the SDL documentation for other possibilities). 813@item curses 814Display video output via curses. For graphics device models which 815support a text mode, QEMU can display this output using a 816curses/ncurses interface. Nothing is displayed when the graphics 817device is in graphical mode or if the graphics device does not support 818a text mode. Generally only the VGA device models support text mode. 819@item none 820Do not display video output. The guest will still see an emulated 821graphics card, but its output will not be displayed to the QEMU 822user. This option differs from the -nographic option in that it 823only affects what is done with video output; -nographic also changes 824the destination of the serial and parallel port data. 825@item vnc 826Start a VNC server on display <arg> 827@end table 828ETEXI 829 830DEF("nographic", 0, QEMU_OPTION_nographic, 831 "-nographic disable graphical output and redirect serial I/Os to console\n", 832 QEMU_ARCH_ALL) 833STEXI 834@item -nographic 835@findex -nographic 836Normally, QEMU uses SDL to display the VGA output. With this option, 837you can totally disable graphical output so that QEMU is a simple 838command line application. The emulated serial port is redirected on 839the console. Therefore, you can still use QEMU to debug a Linux kernel 840with a serial console. 841ETEXI 842 843DEF("curses", 0, QEMU_OPTION_curses, 844 "-curses use a curses/ncurses interface instead of SDL\n", 845 QEMU_ARCH_ALL) 846STEXI 847@item -curses 848@findex -curses 849Normally, QEMU uses SDL to display the VGA output. With this option, 850QEMU can display the VGA output when in text mode using a 851curses/ncurses interface. Nothing is displayed in graphical mode. 852ETEXI 853 854DEF("no-frame", 0, QEMU_OPTION_no_frame, 855 "-no-frame open SDL window without a frame and window decorations\n", 856 QEMU_ARCH_ALL) 857STEXI 858@item -no-frame 859@findex -no-frame 860Do not use decorations for SDL windows and start them using the whole 861available screen space. This makes the using QEMU in a dedicated desktop 862workspace more convenient. 863ETEXI 864 865DEF("alt-grab", 0, QEMU_OPTION_alt_grab, 866 "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n", 867 QEMU_ARCH_ALL) 868STEXI 869@item -alt-grab 870@findex -alt-grab 871Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also 872affects the special keys (for fullscreen, monitor-mode switching, etc). 873ETEXI 874 875DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab, 876 "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n", 877 QEMU_ARCH_ALL) 878STEXI 879@item -ctrl-grab 880@findex -ctrl-grab 881Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also 882affects the special keys (for fullscreen, monitor-mode switching, etc). 883ETEXI 884 885DEF("no-quit", 0, QEMU_OPTION_no_quit, 886 "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL) 887STEXI 888@item -no-quit 889@findex -no-quit 890Disable SDL window close capability. 891ETEXI 892 893DEF("sdl", 0, QEMU_OPTION_sdl, 894 "-sdl enable SDL\n", QEMU_ARCH_ALL) 895STEXI 896@item -sdl 897@findex -sdl 898Enable SDL. 899ETEXI 900 901DEF("spice", HAS_ARG, QEMU_OPTION_spice, 902 "-spice [port=port][,tls-port=secured-port][,x509-dir=<dir>]\n" 903 " [,x509-key-file=<file>][,x509-key-password=<file>]\n" 904 " [,x509-cert-file=<file>][,x509-cacert-file=<file>]\n" 905 " [,x509-dh-key-file=<file>][,addr=addr][,ipv4|ipv6]\n" 906 " [,tls-ciphers=<list>]\n" 907 " [,tls-channel=[main|display|cursor|inputs|record|playback]]\n" 908 " [,plaintext-channel=[main|display|cursor|inputs|record|playback]]\n" 909 " [,sasl][,password=<secret>][,disable-ticketing]\n" 910 " [,image-compression=[auto_glz|auto_lz|quic|glz|lz|off]]\n" 911 " [,jpeg-wan-compression=[auto|never|always]]\n" 912 " [,zlib-glz-wan-compression=[auto|never|always]]\n" 913 " [,streaming-video=[off|all|filter]][,disable-copy-paste]\n" 914 " [,agent-mouse=[on|off]][,playback-compression=[on|off]]\n" 915 " [,seamless-migration=[on|off]]\n" 916 " enable spice\n" 917 " at least one of {port, tls-port} is mandatory\n", 918 QEMU_ARCH_ALL) 919STEXI 920@item -spice @var{option}[,@var{option}[,...]] 921@findex -spice 922Enable the spice remote desktop protocol. Valid options are 923 924@table @option 925 926@item port=<nr> 927Set the TCP port spice is listening on for plaintext channels. 928 929@item addr=<addr> 930Set the IP address spice is listening on. Default is any address. 931 932@item ipv4 933@item ipv6 934Force using the specified IP version. 935 936@item password=<secret> 937Set the password you need to authenticate. 938 939@item sasl 940Require that the client use SASL to authenticate with the spice. 941The exact choice of authentication method used is controlled from the 942system / user's SASL configuration file for the 'qemu' service. This 943is typically found in /etc/sasl2/qemu.conf. If running QEMU as an 944unprivileged user, an environment variable SASL_CONF_PATH can be used 945to make it search alternate locations for the service config. 946While some SASL auth methods can also provide data encryption (eg GSSAPI), 947it is recommended that SASL always be combined with the 'tls' and 948'x509' settings to enable use of SSL and server certificates. This 949ensures a data encryption preventing compromise of authentication 950credentials. 951 952@item disable-ticketing 953Allow client connects without authentication. 954 955@item disable-copy-paste 956Disable copy paste between the client and the guest. 957 958@item tls-port=<nr> 959Set the TCP port spice is listening on for encrypted channels. 960 961@item x509-dir=<dir> 962Set the x509 file directory. Expects same filenames as -vnc $display,x509=$dir 963 964@item x509-key-file=<file> 965@item x509-key-password=<file> 966@item x509-cert-file=<file> 967@item x509-cacert-file=<file> 968@item x509-dh-key-file=<file> 969The x509 file names can also be configured individually. 970 971@item tls-ciphers=<list> 972Specify which ciphers to use. 973 974@item tls-channel=[main|display|cursor|inputs|record|playback] 975@item plaintext-channel=[main|display|cursor|inputs|record|playback] 976Force specific channel to be used with or without TLS encryption. The 977options can be specified multiple times to configure multiple 978channels. The special name "default" can be used to set the default 979mode. For channels which are not explicitly forced into one mode the 980spice client is allowed to pick tls/plaintext as he pleases. 981 982@item image-compression=[auto_glz|auto_lz|quic|glz|lz|off] 983Configure image compression (lossless). 984Default is auto_glz. 985 986@item jpeg-wan-compression=[auto|never|always] 987@item zlib-glz-wan-compression=[auto|never|always] 988Configure wan image compression (lossy for slow links). 989Default is auto. 990 991@item streaming-video=[off|all|filter] 992Configure video stream detection. Default is filter. 993 994@item agent-mouse=[on|off] 995Enable/disable passing mouse events via vdagent. Default is on. 996 997@item playback-compression=[on|off] 998Enable/disable audio stream compression (using celt 0.5.1). Default is on. 999 1000@item seamless-migration=[on|off] 1001Enable/disable spice seamless migration. Default is off. 1002 1003@end table 1004ETEXI 1005 1006DEF("portrait", 0, QEMU_OPTION_portrait, 1007 "-portrait rotate graphical output 90 deg left (only PXA LCD)\n", 1008 QEMU_ARCH_ALL) 1009STEXI 1010@item -portrait 1011@findex -portrait 1012Rotate graphical output 90 deg left (only PXA LCD). 1013ETEXI 1014 1015DEF("rotate", HAS_ARG, QEMU_OPTION_rotate, 1016 "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n", 1017 QEMU_ARCH_ALL) 1018STEXI 1019@item -rotate @var{deg} 1020@findex -rotate 1021Rotate graphical output some deg left (only PXA LCD). 1022ETEXI 1023 1024DEF("vga", HAS_ARG, QEMU_OPTION_vga, 1025 "-vga [std|cirrus|vmware|qxl|xenfb|none]\n" 1026 " select video card type\n", QEMU_ARCH_ALL) 1027STEXI 1028@item -vga @var{type} 1029@findex -vga 1030Select type of VGA card to emulate. Valid values for @var{type} are 1031@table @option 1032@item cirrus 1033Cirrus Logic GD5446 Video card. All Windows versions starting from 1034Windows 95 should recognize and use this graphic card. For optimal 1035performances, use 16 bit color depth in the guest and the host OS. 1036(This one is the default) 1037@item std 1038Standard VGA card with Bochs VBE extensions. If your guest OS 1039supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want 1040to use high resolution modes (>= 1280x1024x16) then you should use 1041this option. 1042@item vmware 1043VMWare SVGA-II compatible adapter. Use it if you have sufficiently 1044recent XFree86/XOrg server or Windows guest with a driver for this 1045card. 1046@item qxl 1047QXL paravirtual graphic card. It is VGA compatible (including VESA 10482.0 VBE support). Works best with qxl guest drivers installed though. 1049Recommended choice when using the spice protocol. 1050@item none 1051Disable VGA card. 1052@end table 1053ETEXI 1054 1055DEF("full-screen", 0, QEMU_OPTION_full_screen, 1056 "-full-screen start in full screen\n", QEMU_ARCH_ALL) 1057STEXI 1058@item -full-screen 1059@findex -full-screen 1060Start in full screen. 1061ETEXI 1062 1063DEF("g", 1, QEMU_OPTION_g , 1064 "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n", 1065 QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 1066STEXI 1067@item -g @var{width}x@var{height}[x@var{depth}] 1068@findex -g 1069Set the initial graphical resolution and depth (PPC, SPARC only). 1070ETEXI 1071 1072DEF("vnc", HAS_ARG, QEMU_OPTION_vnc , 1073 "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL) 1074STEXI 1075@item -vnc @var{display}[,@var{option}[,@var{option}[,...]]] 1076@findex -vnc 1077Normally, QEMU uses SDL to display the VGA output. With this option, 1078you can have QEMU listen on VNC display @var{display} and redirect the VGA 1079display over the VNC session. It is very useful to enable the usb 1080tablet device when using this option (option @option{-usbdevice 1081tablet}). When using the VNC display, you must use the @option{-k} 1082parameter to set the keyboard layout if you are not using en-us. Valid 1083syntax for the @var{display} is 1084 1085@table @option 1086 1087@item @var{host}:@var{d} 1088 1089TCP connections will only be allowed from @var{host} on display @var{d}. 1090By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can 1091be omitted in which case the server will accept connections from any host. 1092 1093@item unix:@var{path} 1094 1095Connections will be allowed over UNIX domain sockets where @var{path} is the 1096location of a unix socket to listen for connections on. 1097 1098@item none 1099 1100VNC is initialized but not started. The monitor @code{change} command 1101can be used to later start the VNC server. 1102 1103@end table 1104 1105Following the @var{display} value there may be one or more @var{option} flags 1106separated by commas. Valid options are 1107 1108@table @option 1109 1110@item reverse 1111 1112Connect to a listening VNC client via a ``reverse'' connection. The 1113client is specified by the @var{display}. For reverse network 1114connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument 1115is a TCP port number, not a display number. 1116 1117@item websocket 1118 1119Opens an additional TCP listening port dedicated to VNC Websocket connections. 1120By defintion the Websocket port is 5700+@var{display}. If @var{host} is 1121specified connections will only be allowed from this host. 1122As an alternative the Websocket port could be specified by using 1123@code{websocket}=@var{port}. 1124 1125@item password 1126 1127Require that password based authentication is used for client connections. 1128 1129The password must be set separately using the @code{set_password} command in 1130the @ref{pcsys_monitor}. The syntax to change your password is: 1131@code{set_password <protocol> <password>} where <protocol> could be either 1132"vnc" or "spice". 1133 1134If you would like to change <protocol> password expiration, you should use 1135@code{expire_password <protocol> <expiration-time>} where expiration time could 1136be one of the following options: now, never, +seconds or UNIX time of 1137expiration, e.g. +60 to make password expire in 60 seconds, or 1335196800 1138to make password expire on "Mon Apr 23 12:00:00 EDT 2012" (UNIX time for this 1139date and time). 1140 1141You can also use keywords "now" or "never" for the expiration time to 1142allow <protocol> password to expire immediately or never expire. 1143 1144@item tls 1145 1146Require that client use TLS when communicating with the VNC server. This 1147uses anonymous TLS credentials so is susceptible to a man-in-the-middle 1148attack. It is recommended that this option be combined with either the 1149@option{x509} or @option{x509verify} options. 1150 1151@item x509=@var{/path/to/certificate/dir} 1152 1153Valid if @option{tls} is specified. Require that x509 credentials are used 1154for negotiating the TLS session. The server will send its x509 certificate 1155to the client. It is recommended that a password be set on the VNC server 1156to provide authentication of the client when this is used. The path following 1157this option specifies where the x509 certificates are to be loaded from. 1158See the @ref{vnc_security} section for details on generating certificates. 1159 1160@item x509verify=@var{/path/to/certificate/dir} 1161 1162Valid if @option{tls} is specified. Require that x509 credentials are used 1163for negotiating the TLS session. The server will send its x509 certificate 1164to the client, and request that the client send its own x509 certificate. 1165The server will validate the client's certificate against the CA certificate, 1166and reject clients when validation fails. If the certificate authority is 1167trusted, this is a sufficient authentication mechanism. You may still wish 1168to set a password on the VNC server as a second authentication layer. The 1169path following this option specifies where the x509 certificates are to 1170be loaded from. See the @ref{vnc_security} section for details on generating 1171certificates. 1172 1173@item sasl 1174 1175Require that the client use SASL to authenticate with the VNC server. 1176The exact choice of authentication method used is controlled from the 1177system / user's SASL configuration file for the 'qemu' service. This 1178is typically found in /etc/sasl2/qemu.conf. If running QEMU as an 1179unprivileged user, an environment variable SASL_CONF_PATH can be used 1180to make it search alternate locations for the service config. 1181While some SASL auth methods can also provide data encryption (eg GSSAPI), 1182it is recommended that SASL always be combined with the 'tls' and 1183'x509' settings to enable use of SSL and server certificates. This 1184ensures a data encryption preventing compromise of authentication 1185credentials. See the @ref{vnc_security} section for details on using 1186SASL authentication. 1187 1188@item acl 1189 1190Turn on access control lists for checking of the x509 client certificate 1191and SASL party. For x509 certs, the ACL check is made against the 1192certificate's distinguished name. This is something that looks like 1193@code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is 1194made against the username, which depending on the SASL plugin, may 1195include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}. 1196When the @option{acl} flag is set, the initial access list will be 1197empty, with a @code{deny} policy. Thus no one will be allowed to 1198use the VNC server until the ACLs have been loaded. This can be 1199achieved using the @code{acl} monitor command. 1200 1201@item lossy 1202 1203Enable lossy compression methods (gradient, JPEG, ...). If this 1204option is set, VNC client may receive lossy framebuffer updates 1205depending on its encoding settings. Enabling this option can save 1206a lot of bandwidth at the expense of quality. 1207 1208@item non-adaptive 1209 1210Disable adaptive encodings. Adaptive encodings are enabled by default. 1211An adaptive encoding will try to detect frequently updated screen regions, 1212and send updates in these regions using a lossy encoding (like JPEG). 1213This can be really helpful to save bandwidth when playing videos. Disabling 1214adaptive encodings allows to restore the original static behavior of encodings 1215like Tight. 1216 1217@item share=[allow-exclusive|force-shared|ignore] 1218 1219Set display sharing policy. 'allow-exclusive' allows clients to ask 1220for exclusive access. As suggested by the rfb spec this is 1221implemented by dropping other connections. Connecting multiple 1222clients in parallel requires all clients asking for a shared session 1223(vncviewer: -shared switch). This is the default. 'force-shared' 1224disables exclusive client access. Useful for shared desktop sessions, 1225where you don't want someone forgetting specify -shared disconnect 1226everybody else. 'ignore' completely ignores the shared flag and 1227allows everybody connect unconditionally. Doesn't conform to the rfb 1228spec but is traditional QEMU behavior. 1229 1230@end table 1231ETEXI 1232 1233STEXI 1234@end table 1235ETEXI 1236ARCHHEADING(, QEMU_ARCH_I386) 1237 1238ARCHHEADING(i386 target only:, QEMU_ARCH_I386) 1239STEXI 1240@table @option 1241ETEXI 1242 1243DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack, 1244 "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n", 1245 QEMU_ARCH_I386) 1246STEXI 1247@item -win2k-hack 1248@findex -win2k-hack 1249Use it when installing Windows 2000 to avoid a disk full bug. After 1250Windows 2000 is installed, you no longer need this option (this option 1251slows down the IDE transfers). 1252ETEXI 1253 1254HXCOMM Deprecated by -rtc 1255DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386) 1256 1257DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk, 1258 "-no-fd-bootchk disable boot signature checking for floppy disks\n", 1259 QEMU_ARCH_I386) 1260STEXI 1261@item -no-fd-bootchk 1262@findex -no-fd-bootchk 1263Disable boot signature checking for floppy disks in Bochs BIOS. It may 1264be needed to boot from old floppy disks. 1265TODO: check reference to Bochs BIOS. 1266ETEXI 1267 1268DEF("no-acpi", 0, QEMU_OPTION_no_acpi, 1269 "-no-acpi disable ACPI\n", QEMU_ARCH_I386) 1270STEXI 1271@item -no-acpi 1272@findex -no-acpi 1273Disable ACPI (Advanced Configuration and Power Interface) support. Use 1274it if your guest OS complains about ACPI problems (PC target machine 1275only). 1276ETEXI 1277 1278DEF("no-hpet", 0, QEMU_OPTION_no_hpet, 1279 "-no-hpet disable HPET\n", QEMU_ARCH_I386) 1280STEXI 1281@item -no-hpet 1282@findex -no-hpet 1283Disable HPET support. 1284ETEXI 1285 1286DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable, 1287 "-acpitable [sig=str][,rev=n][,oem_id=str][,oem_table_id=str][,oem_rev=n][,asl_compiler_id=str][,asl_compiler_rev=n][,{data|file}=file1[:file2]...]\n" 1288 " ACPI table description\n", QEMU_ARCH_I386) 1289STEXI 1290@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}]...] 1291@findex -acpitable 1292Add ACPI table with specified header fields and context from specified files. 1293For file=, take whole ACPI table from the specified files, including all 1294ACPI headers (possible overridden by other options). 1295For data=, only data 1296portion of the table is used, all header information is specified in the 1297command line. 1298ETEXI 1299 1300DEF("smbios", HAS_ARG, QEMU_OPTION_smbios, 1301 "-smbios file=binary\n" 1302 " load SMBIOS entry from binary file\n" 1303 "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n" 1304 " specify SMBIOS type 0 fields\n" 1305 "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 1306 " [,uuid=uuid][,sku=str][,family=str]\n" 1307 " specify SMBIOS type 1 fields\n", QEMU_ARCH_I386) 1308STEXI 1309@item -smbios file=@var{binary} 1310@findex -smbios 1311Load SMBIOS entry from binary file. 1312 1313@item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}] 1314Specify SMBIOS type 0 fields 1315 1316@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}] 1317Specify SMBIOS type 1 fields 1318ETEXI 1319 1320STEXI 1321@end table 1322ETEXI 1323DEFHEADING() 1324 1325DEFHEADING(Network options:) 1326STEXI 1327@table @option 1328ETEXI 1329 1330HXCOMM Legacy slirp options (now moved to -net user): 1331#ifdef CONFIG_SLIRP 1332DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL) 1333DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL) 1334DEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL) 1335#ifndef _WIN32 1336DEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL) 1337#endif 1338#endif 1339 1340DEF("net", HAS_ARG, QEMU_OPTION_net, 1341 "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" 1342 " create a new Network Interface Card and connect it to VLAN 'n'\n" 1343#ifdef CONFIG_SLIRP 1344 "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=on|off]\n" 1345 " [,hostname=host][,dhcpstart=addr][,dns=addr][,dnssearch=domain][,tftp=dir]\n" 1346 " [,bootfile=f][,hostfwd=rule][,guestfwd=rule]" 1347#ifndef _WIN32 1348 "[,smb=dir[,smbserver=addr]]\n" 1349#endif 1350 " connect the user mode network stack to VLAN 'n', configure its\n" 1351 " DHCP server and enabled optional services\n" 1352#endif 1353#ifdef _WIN32 1354 "-net tap[,vlan=n][,name=str],ifname=name\n" 1355 " connect the host TAP network interface to VLAN 'n'\n" 1356#else 1357 "-net tap[,vlan=n][,name=str][,fd=h][,ifname=name][,script=file][,downscript=dfile][,helper=helper][,sndbuf=nbytes][,vnet_hdr=on|off][,vhost=on|off][,vhostfd=h][,vhostforce=on|off]\n" 1358 " connect the host TAP network interface to VLAN 'n'\n" 1359 " use network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n" 1360 " to configure it and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n" 1361 " to deconfigure it\n" 1362 " use '[down]script=no' to disable script execution\n" 1363 " use network helper 'helper' (default=" DEFAULT_BRIDGE_HELPER ") to\n" 1364 " configure it\n" 1365 " use 'fd=h' to connect to an already opened TAP interface\n" 1366 " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n" 1367 " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n" 1368 " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n" 1369 " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n" 1370 " use vhost=on to enable experimental in kernel accelerator\n" 1371 " (only has effect for virtio guests which use MSIX)\n" 1372 " use vhostforce=on to force vhost on for non-MSIX virtio guests\n" 1373 " use 'vhostfd=h' to connect to an already opened vhost net device\n" 1374 "-net bridge[,vlan=n][,name=str][,br=bridge][,helper=helper]\n" 1375 " connects a host TAP network interface to a host bridge device 'br'\n" 1376 " (default=" DEFAULT_BRIDGE_INTERFACE ") using the program 'helper'\n" 1377 " (default=" DEFAULT_BRIDGE_HELPER ")\n" 1378#endif 1379 "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n" 1380 " connect the vlan 'n' to another VLAN using a socket connection\n" 1381 "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port[,localaddr=addr]]\n" 1382 " connect the vlan 'n' to multicast maddr and port\n" 1383 " use 'localaddr=addr' to specify the host address to send packets from\n" 1384 "-net socket[,vlan=n][,name=str][,fd=h][,udp=host:port][,localaddr=host:port]\n" 1385 " connect the vlan 'n' to another VLAN using an UDP tunnel\n" 1386#ifdef CONFIG_VDE 1387 "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n" 1388 " connect the vlan 'n' to port 'n' of a vde switch running\n" 1389 " on host and listening for incoming connections on 'socketpath'.\n" 1390 " Use group 'groupname' and mode 'octalmode' to change default\n" 1391 " ownership and permissions for communication port.\n" 1392#endif 1393 "-net dump[,vlan=n][,file=f][,len=n]\n" 1394 " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n" 1395 "-net none use it alone to have zero network devices. If no -net option\n" 1396 " is provided, the default is '-net nic -net user'\n", QEMU_ARCH_ALL) 1397DEF("netdev", HAS_ARG, QEMU_OPTION_netdev, 1398 "-netdev [" 1399#ifdef CONFIG_SLIRP 1400 "user|" 1401#endif 1402 "tap|" 1403 "bridge|" 1404#ifdef CONFIG_VDE 1405 "vde|" 1406#endif 1407 "socket],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL) 1408STEXI 1409@item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}] 1410@findex -net 1411Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n} 1412= 0 is the default). The NIC is an e1000 by default on the PC 1413target. Optionally, the MAC address can be changed to @var{mac}, the 1414device address set to @var{addr} (PCI cards only), 1415and a @var{name} can be assigned for use in monitor commands. 1416Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors 1417that the card should have; this option currently only affects virtio cards; set 1418@var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single 1419NIC is created. QEMU can emulate several different models of network card. 1420Valid values for @var{type} are 1421@code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er}, 1422@code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139}, 1423@code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}. 1424Not all devices are supported on all targets. Use @code{-net nic,model=help} 1425for a list of available devices for your target. 1426 1427@item -netdev user,id=@var{id}[,@var{option}][,@var{option}][,...] 1428@findex -netdev 1429@item -net user[,@var{option}][,@var{option}][,...] 1430Use the user mode network stack which requires no administrator 1431privilege to run. Valid options are: 1432 1433@table @option 1434@item vlan=@var{n} 1435Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default). 1436 1437@item id=@var{id} 1438@item name=@var{name} 1439Assign symbolic name for use in monitor commands. 1440 1441@item net=@var{addr}[/@var{mask}] 1442Set IP network address the guest will see. Optionally specify the netmask, 1443either in the form a.b.c.d or as number of valid top-most bits. Default is 144410.0.2.0/24. 1445 1446@item host=@var{addr} 1447Specify the guest-visible address of the host. Default is the 2nd IP in the 1448guest network, i.e. x.x.x.2. 1449 1450@item restrict=on|off 1451If this option is enabled, the guest will be isolated, i.e. it will not be 1452able to contact the host and no guest IP packets will be routed over the host 1453to the outside. This option does not affect any explicitly set forwarding rules. 1454 1455@item hostname=@var{name} 1456Specifies the client hostname reported by the built-in DHCP server. 1457 1458@item dhcpstart=@var{addr} 1459Specify the first of the 16 IPs the built-in DHCP server can assign. Default 1460is the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31. 1461 1462@item dns=@var{addr} 1463Specify the guest-visible address of the virtual nameserver. The address must 1464be different from the host address. Default is the 3rd IP in the guest network, 1465i.e. x.x.x.3. 1466 1467@item dnssearch=@var{domain} 1468Provides an entry for the domain-search list sent by the built-in 1469DHCP server. More than one domain suffix can be transmitted by specifying 1470this option multiple times. If supported, this will cause the guest to 1471automatically try to append the given domain suffix(es) in case a domain name 1472can not be resolved. 1473 1474Example: 1475@example 1476qemu -net user,dnssearch=mgmt.example.org,dnssearch=example.org [...] 1477@end example 1478 1479@item tftp=@var{dir} 1480When using the user mode network stack, activate a built-in TFTP 1481server. The files in @var{dir} will be exposed as the root of a TFTP server. 1482The TFTP client on the guest must be configured in binary mode (use the command 1483@code{bin} of the Unix TFTP client). 1484 1485@item bootfile=@var{file} 1486When using the user mode network stack, broadcast @var{file} as the BOOTP 1487filename. In conjunction with @option{tftp}, this can be used to network boot 1488a guest from a local directory. 1489 1490Example (using pxelinux): 1491@example 1492qemu-system-i386 -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0 1493@end example 1494 1495@item smb=@var{dir}[,smbserver=@var{addr}] 1496When using the user mode network stack, activate a built-in SMB 1497server so that Windows OSes can access to the host files in @file{@var{dir}} 1498transparently. The IP address of the SMB server can be set to @var{addr}. By 1499default the 4th IP in the guest network is used, i.e. x.x.x.4. 1500 1501In the guest Windows OS, the line: 1502@example 150310.0.2.4 smbserver 1504@end example 1505must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me) 1506or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000). 1507 1508Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}. 1509 1510Note that a SAMBA server must be installed on the host OS. 1511QEMU was tested successfully with smbd versions from Red Hat 9, 1512Fedora Core 3 and OpenSUSE 11.x. 1513 1514@item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport} 1515Redirect incoming TCP or UDP connections to the host port @var{hostport} to 1516the guest IP address @var{guestaddr} on guest port @var{guestport}. If 1517@var{guestaddr} is not specified, its value is x.x.x.15 (default first address 1518given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can 1519be bound to a specific host interface. If no connection type is set, TCP is 1520used. This option can be given multiple times. 1521 1522For example, to redirect host X11 connection from screen 1 to guest 1523screen 0, use the following: 1524 1525@example 1526# on the host 1527qemu-system-i386 -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...] 1528# this host xterm should open in the guest X11 server 1529xterm -display :1 1530@end example 1531 1532To redirect telnet connections from host port 5555 to telnet port on 1533the guest, use the following: 1534 1535@example 1536# on the host 1537qemu-system-i386 -net user,hostfwd=tcp::5555-:23 [...] 1538telnet localhost 5555 1539@end example 1540 1541Then when you use on the host @code{telnet localhost 5555}, you 1542connect to the guest telnet server. 1543 1544@item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev} 1545@item guestfwd=[tcp]:@var{server}:@var{port}-@var{cmd:command} 1546Forward guest TCP connections to the IP address @var{server} on port @var{port} 1547to the character device @var{dev} or to a program executed by @var{cmd:command} 1548which gets spawned for each connection. This option can be given multiple times. 1549 1550You can either use a chardev directly and have that one used throughout QEMU's 1551lifetime, like in the following example: 1552 1553@example 1554# open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it whenever 1555# the guest accesses it 1556qemu -net user,guestfwd=tcp:10.0.2.100:1234-tcp:10.10.1.1:4321 [...] 1557@end example 1558 1559Or you can execute a command on every TCP connection established by the guest, 1560so that QEMU behaves similar to an inetd process for that virtual server: 1561 1562@example 1563# call "netcat 10.10.1.1 4321" on every TCP connection to 10.0.2.100:1234 1564# and connect the TCP stream to its stdin/stdout 1565qemu -net 'user,guestfwd=tcp:10.0.2.100:1234-cmd:netcat 10.10.1.1 4321' 1566@end example 1567 1568@end table 1569 1570Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still 1571processed and applied to -net user. Mixing them with the new configuration 1572syntax gives undefined results. Their use for new applications is discouraged 1573as they will be removed from future versions. 1574 1575@item -netdev tap,id=@var{id}[,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}] 1576@item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}] 1577Connect the host TAP network interface @var{name} to VLAN @var{n}. 1578 1579Use the network script @var{file} to configure it and the network script 1580@var{dfile} to deconfigure it. If @var{name} is not provided, the OS 1581automatically provides one. The default network configure script is 1582@file{/etc/qemu-ifup} and the default network deconfigure script is 1583@file{/etc/qemu-ifdown}. Use @option{script=no} or @option{downscript=no} 1584to disable script execution. 1585 1586If running QEMU as an unprivileged user, use the network helper 1587@var{helper} to configure the TAP interface. The default network 1588helper executable is @file{/usr/local/libexec/qemu-bridge-helper}. 1589 1590@option{fd}=@var{h} can be used to specify the handle of an already 1591opened host TAP interface. 1592 1593Examples: 1594 1595@example 1596#launch a QEMU instance with the default network script 1597qemu-system-i386 linux.img -net nic -net tap 1598@end example 1599 1600@example 1601#launch a QEMU instance with two NICs, each one connected 1602#to a TAP device 1603qemu-system-i386 linux.img \ 1604 -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \ 1605 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1 1606@end example 1607 1608@example 1609#launch a QEMU instance with the default network helper to 1610#connect a TAP device to bridge br0 1611qemu-system-i386 linux.img \ 1612 -net nic -net tap,"helper=/usr/local/libexec/qemu-bridge-helper" 1613@end example 1614 1615@item -netdev bridge,id=@var{id}[,br=@var{bridge}][,helper=@var{helper}] 1616@item -net bridge[,vlan=@var{n}][,name=@var{name}][,br=@var{bridge}][,helper=@var{helper}] 1617Connect a host TAP network interface to a host bridge device. 1618 1619Use the network helper @var{helper} to configure the TAP interface and 1620attach it to the bridge. The default network helper executable is 1621@file{/usr/local/libexec/qemu-bridge-helper} and the default bridge 1622device is @file{br0}. 1623 1624Examples: 1625 1626@example 1627#launch a QEMU instance with the default network helper to 1628#connect a TAP device to bridge br0 1629qemu-system-i386 linux.img -net bridge -net nic,model=virtio 1630@end example 1631 1632@example 1633#launch a QEMU instance with the default network helper to 1634#connect a TAP device to bridge qemubr0 1635qemu-system-i386 linux.img -net bridge,br=qemubr0 -net nic,model=virtio 1636@end example 1637 1638@item -netdev socket,id=@var{id}[,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 1639@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 1640 1641Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual 1642machine using a TCP socket connection. If @option{listen} is 1643specified, QEMU waits for incoming connections on @var{port} 1644(@var{host} is optional). @option{connect} is used to connect to 1645another QEMU instance using the @option{listen} option. @option{fd}=@var{h} 1646specifies an already opened TCP socket. 1647 1648Example: 1649@example 1650# launch a first QEMU instance 1651qemu-system-i386 linux.img \ 1652 -net nic,macaddr=52:54:00:12:34:56 \ 1653 -net socket,listen=:1234 1654# connect the VLAN 0 of this instance to the VLAN 0 1655# of the first instance 1656qemu-system-i386 linux.img \ 1657 -net nic,macaddr=52:54:00:12:34:57 \ 1658 -net socket,connect=127.0.0.1:1234 1659@end example 1660 1661@item -netdev socket,id=@var{id}[,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] 1662@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] 1663 1664Create a VLAN @var{n} shared with another QEMU virtual 1665machines using a UDP multicast socket, effectively making a bus for 1666every QEMU with same multicast address @var{maddr} and @var{port}. 1667NOTES: 1668@enumerate 1669@item 1670Several QEMU can be running on different hosts and share same bus (assuming 1671correct multicast setup for these hosts). 1672@item 1673mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see 1674@url{http://user-mode-linux.sf.net}. 1675@item 1676Use @option{fd=h} to specify an already opened UDP multicast socket. 1677@end enumerate 1678 1679Example: 1680@example 1681# launch one QEMU instance 1682qemu-system-i386 linux.img \ 1683 -net nic,macaddr=52:54:00:12:34:56 \ 1684 -net socket,mcast=230.0.0.1:1234 1685# launch another QEMU instance on same "bus" 1686qemu-system-i386 linux.img \ 1687 -net nic,macaddr=52:54:00:12:34:57 \ 1688 -net socket,mcast=230.0.0.1:1234 1689# launch yet another QEMU instance on same "bus" 1690qemu-system-i386 linux.img \ 1691 -net nic,macaddr=52:54:00:12:34:58 \ 1692 -net socket,mcast=230.0.0.1:1234 1693@end example 1694 1695Example (User Mode Linux compat.): 1696@example 1697# launch QEMU instance (note mcast address selected 1698# is UML's default) 1699qemu-system-i386 linux.img \ 1700 -net nic,macaddr=52:54:00:12:34:56 \ 1701 -net socket,mcast=239.192.168.1:1102 1702# launch UML 1703/path/to/linux ubd0=/path/to/root_fs eth0=mcast 1704@end example 1705 1706Example (send packets from host's 1.2.3.4): 1707@example 1708qemu-system-i386 linux.img \ 1709 -net nic,macaddr=52:54:00:12:34:56 \ 1710 -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4 1711@end example 1712 1713@item -netdev vde,id=@var{id}[,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 1714@item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 1715Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and 1716listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname} 1717and MODE @var{octalmode} to change default ownership and permissions for 1718communication port. This option is only available if QEMU has been compiled 1719with vde support enabled. 1720 1721Example: 1722@example 1723# launch vde switch 1724vde_switch -F -sock /tmp/myswitch 1725# launch QEMU instance 1726qemu-system-i386 linux.img -net nic -net vde,sock=/tmp/myswitch 1727@end example 1728 1729@item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}] 1730Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default). 1731At most @var{len} bytes (64k by default) per packet are stored. The file format is 1732libpcap, so it can be analyzed with tools such as tcpdump or Wireshark. 1733 1734@item -net none 1735Indicate that no network devices should be configured. It is used to 1736override the default configuration (@option{-net nic -net user}) which 1737is activated if no @option{-net} options are provided. 1738ETEXI 1739 1740STEXI 1741@end table 1742ETEXI 1743DEFHEADING() 1744 1745DEFHEADING(Character device options:) 1746STEXI 1747 1748The general form of a character device option is: 1749@table @option 1750ETEXI 1751 1752DEF("chardev", HAS_ARG, QEMU_OPTION_chardev, 1753 "-chardev null,id=id[,mux=on|off]\n" 1754 "-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n" 1755 " [,server][,nowait][,telnet][,mux=on|off] (tcp)\n" 1756 "-chardev socket,id=id,path=path[,server][,nowait][,telnet],[mux=on|off] (unix)\n" 1757 "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n" 1758 " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n" 1759 "-chardev msmouse,id=id[,mux=on|off]\n" 1760 "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n" 1761 " [,mux=on|off]\n" 1762 "-chardev ringbuf,id=id[,size=size]\n" 1763 "-chardev file,id=id,path=path[,mux=on|off]\n" 1764 "-chardev pipe,id=id,path=path[,mux=on|off]\n" 1765#ifdef _WIN32 1766 "-chardev console,id=id[,mux=on|off]\n" 1767 "-chardev serial,id=id,path=path[,mux=on|off]\n" 1768#else 1769 "-chardev pty,id=id[,mux=on|off]\n" 1770 "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n" 1771#endif 1772#ifdef CONFIG_BRLAPI 1773 "-chardev braille,id=id[,mux=on|off]\n" 1774#endif 1775#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \ 1776 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) 1777 "-chardev serial,id=id,path=path[,mux=on|off]\n" 1778 "-chardev tty,id=id,path=path[,mux=on|off]\n" 1779#endif 1780#if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__) 1781 "-chardev parallel,id=id,path=path[,mux=on|off]\n" 1782 "-chardev parport,id=id,path=path[,mux=on|off]\n" 1783#endif 1784#if defined(CONFIG_SPICE) 1785 "-chardev spicevmc,id=id,name=name[,debug=debug]\n" 1786 "-chardev spiceport,id=id,name=name[,debug=debug]\n" 1787#endif 1788 , QEMU_ARCH_ALL 1789) 1790 1791STEXI 1792@item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}] 1793@findex -chardev 1794Backend is one of: 1795@option{null}, 1796@option{socket}, 1797@option{udp}, 1798@option{msmouse}, 1799@option{vc}, 1800@option{ringbuf}, 1801@option{file}, 1802@option{pipe}, 1803@option{console}, 1804@option{serial}, 1805@option{pty}, 1806@option{stdio}, 1807@option{braille}, 1808@option{tty}, 1809@option{parallel}, 1810@option{parport}, 1811@option{spicevmc}. 1812@option{spiceport}. 1813The specific backend will determine the applicable options. 1814 1815All devices must have an id, which can be any string up to 127 characters long. 1816It is used to uniquely identify this device in other command line directives. 1817 1818A character device may be used in multiplexing mode by multiple front-ends. 1819The key sequence of @key{Control-a} and @key{c} will rotate the input focus 1820between attached front-ends. Specify @option{mux=on} to enable this mode. 1821 1822Options to each backend are described below. 1823 1824@item -chardev null ,id=@var{id} 1825A void device. This device will not emit any data, and will drop any data it 1826receives. The null backend does not take any options. 1827 1828@item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet] 1829 1830Create a two-way stream socket, which can be either a TCP or a unix socket. A 1831unix socket will be created if @option{path} is specified. Behaviour is 1832undefined if TCP options are specified for a unix socket. 1833 1834@option{server} specifies that the socket shall be a listening socket. 1835 1836@option{nowait} specifies that QEMU should not block waiting for a client to 1837connect to a listening socket. 1838 1839@option{telnet} specifies that traffic on the socket should interpret telnet 1840escape sequences. 1841 1842TCP and unix socket options are given below: 1843 1844@table @option 1845 1846@item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay] 1847 1848@option{host} for a listening socket specifies the local address to be bound. 1849For a connecting socket species the remote host to connect to. @option{host} is 1850optional for listening sockets. If not specified it defaults to @code{0.0.0.0}. 1851 1852@option{port} for a listening socket specifies the local port to be bound. For a 1853connecting socket specifies the port on the remote host to connect to. 1854@option{port} can be given as either a port number or a service name. 1855@option{port} is required. 1856 1857@option{to} is only relevant to listening sockets. If it is specified, and 1858@option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up 1859to and including @option{to} until it succeeds. @option{to} must be specified 1860as a port number. 1861 1862@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 1863If neither is specified the socket may use either protocol. 1864 1865@option{nodelay} disables the Nagle algorithm. 1866 1867@item unix options: path=@var{path} 1868 1869@option{path} specifies the local path of the unix socket. @option{path} is 1870required. 1871 1872@end table 1873 1874@item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6] 1875 1876Sends all traffic from the guest to a remote host over UDP. 1877 1878@option{host} specifies the remote host to connect to. If not specified it 1879defaults to @code{localhost}. 1880 1881@option{port} specifies the port on the remote host to connect to. @option{port} 1882is required. 1883 1884@option{localaddr} specifies the local address to bind to. If not specified it 1885defaults to @code{0.0.0.0}. 1886 1887@option{localport} specifies the local port to bind to. If not specified any 1888available local port will be used. 1889 1890@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 1891If neither is specified the device may use either protocol. 1892 1893@item -chardev msmouse ,id=@var{id} 1894 1895Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not 1896take any options. 1897 1898@item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]] 1899 1900Connect to a QEMU text console. @option{vc} may optionally be given a specific 1901size. 1902 1903@option{width} and @option{height} specify the width and height respectively of 1904the console, in pixels. 1905 1906@option{cols} and @option{rows} specify that the console be sized to fit a text 1907console with the given dimensions. 1908 1909@item -chardev ringbuf ,id=@var{id} [,size=@var{size}] 1910 1911Create a ring buffer with fixed size @option{size}. 1912@var{size} must be a power of two, and defaults to @code{64K}). 1913 1914@item -chardev file ,id=@var{id} ,path=@var{path} 1915 1916Log all traffic received from the guest to a file. 1917 1918@option{path} specifies the path of the file to be opened. This file will be 1919created if it does not already exist, and overwritten if it does. @option{path} 1920is required. 1921 1922@item -chardev pipe ,id=@var{id} ,path=@var{path} 1923 1924Create a two-way connection to the guest. The behaviour differs slightly between 1925Windows hosts and other hosts: 1926 1927On Windows, a single duplex pipe will be created at 1928@file{\\.pipe\@option{path}}. 1929 1930On other hosts, 2 pipes will be created called @file{@option{path}.in} and 1931@file{@option{path}.out}. Data written to @file{@option{path}.in} will be 1932received by the guest. Data written by the guest can be read from 1933@file{@option{path}.out}. QEMU will not create these fifos, and requires them to 1934be present. 1935 1936@option{path} forms part of the pipe path as described above. @option{path} is 1937required. 1938 1939@item -chardev console ,id=@var{id} 1940 1941Send traffic from the guest to QEMU's standard output. @option{console} does not 1942take any options. 1943 1944@option{console} is only available on Windows hosts. 1945 1946@item -chardev serial ,id=@var{id} ,path=@option{path} 1947 1948Send traffic from the guest to a serial device on the host. 1949 1950On Unix hosts serial will actually accept any tty device, 1951not only serial lines. 1952 1953@option{path} specifies the name of the serial device to open. 1954 1955@item -chardev pty ,id=@var{id} 1956 1957Create a new pseudo-terminal on the host and connect to it. @option{pty} does 1958not take any options. 1959 1960@option{pty} is not available on Windows hosts. 1961 1962@item -chardev stdio ,id=@var{id} [,signal=on|off] 1963Connect to standard input and standard output of the QEMU process. 1964 1965@option{signal} controls if signals are enabled on the terminal, that includes 1966exiting QEMU with the key sequence @key{Control-c}. This option is enabled by 1967default, use @option{signal=off} to disable it. 1968 1969@option{stdio} is not available on Windows hosts. 1970 1971@item -chardev braille ,id=@var{id} 1972 1973Connect to a local BrlAPI server. @option{braille} does not take any options. 1974 1975@item -chardev tty ,id=@var{id} ,path=@var{path} 1976 1977@option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and 1978DragonFlyBSD hosts. It is an alias for @option{serial}. 1979 1980@option{path} specifies the path to the tty. @option{path} is required. 1981 1982@item -chardev parallel ,id=@var{id} ,path=@var{path} 1983@item -chardev parport ,id=@var{id} ,path=@var{path} 1984 1985@option{parallel} is only available on Linux, FreeBSD and DragonFlyBSD hosts. 1986 1987Connect to a local parallel port. 1988 1989@option{path} specifies the path to the parallel port device. @option{path} is 1990required. 1991 1992@item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name} 1993 1994@option{spicevmc} is only available when spice support is built in. 1995 1996@option{debug} debug level for spicevmc 1997 1998@option{name} name of spice channel to connect to 1999 2000Connect to a spice virtual machine channel, such as vdiport. 2001 2002@item -chardev spiceport ,id=@var{id} ,debug=@var{debug}, name=@var{name} 2003 2004@option{spiceport} is only available when spice support is built in. 2005 2006@option{debug} debug level for spicevmc 2007 2008@option{name} name of spice port to connect to 2009 2010Connect to a spice port, allowing a Spice client to handle the traffic 2011identified by a name (preferably a fqdn). 2012ETEXI 2013 2014STEXI 2015@end table 2016ETEXI 2017DEFHEADING() 2018 2019DEFHEADING(Device URL Syntax:) 2020STEXI 2021 2022In addition to using normal file images for the emulated storage devices, 2023QEMU can also use networked resources such as iSCSI devices. These are 2024specified using a special URL syntax. 2025 2026@table @option 2027@item iSCSI 2028iSCSI support allows QEMU to access iSCSI resources directly and use as 2029images for the guest storage. Both disk and cdrom images are supported. 2030 2031Syntax for specifying iSCSI LUNs is 2032``iscsi://<target-ip>[:<port>]/<target-iqn>/<lun>'' 2033 2034By default qemu will use the iSCSI initiator-name 2035'iqn.2008-11.org.linux-kvm[:<name>]' but this can also be set from the command 2036line or a configuration file. 2037 2038 2039Example (without authentication): 2040@example 2041qemu-system-i386 -iscsi initiator-name=iqn.2001-04.com.example:my-initiator \ 2042 -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \ 2043 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 2044@end example 2045 2046Example (CHAP username/password via URL): 2047@example 2048qemu-system-i386 -drive file=iscsi://user%password@@192.0.2.1/iqn.2001-04.com.example/1 2049@end example 2050 2051Example (CHAP username/password via environment variables): 2052@example 2053LIBISCSI_CHAP_USERNAME="user" \ 2054LIBISCSI_CHAP_PASSWORD="password" \ 2055qemu-system-i386 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 2056@end example 2057 2058iSCSI support is an optional feature of QEMU and only available when 2059compiled and linked against libiscsi. 2060ETEXI 2061DEF("iscsi", HAS_ARG, QEMU_OPTION_iscsi, 2062 "-iscsi [user=user][,password=password]\n" 2063 " [,header-digest=CRC32C|CR32C-NONE|NONE-CRC32C|NONE\n" 2064 " [,initiator-name=iqn]\n" 2065 " iSCSI session parameters\n", QEMU_ARCH_ALL) 2066STEXI 2067 2068iSCSI parameters such as username and password can also be specified via 2069a configuration file. See qemu-doc for more information and examples. 2070 2071@item NBD 2072QEMU supports NBD (Network Block Devices) both using TCP protocol as well 2073as Unix Domain Sockets. 2074 2075Syntax for specifying a NBD device using TCP 2076``nbd:<server-ip>:<port>[:exportname=<export>]'' 2077 2078Syntax for specifying a NBD device using Unix Domain Sockets 2079``nbd:unix:<domain-socket>[:exportname=<export>]'' 2080 2081 2082Example for TCP 2083@example 2084qemu-system-i386 --drive file=nbd:192.0.2.1:30000 2085@end example 2086 2087Example for Unix Domain Sockets 2088@example 2089qemu-system-i386 --drive file=nbd:unix:/tmp/nbd-socket 2090@end example 2091 2092@item Sheepdog 2093Sheepdog is a distributed storage system for QEMU. 2094QEMU supports using either local sheepdog devices or remote networked 2095devices. 2096 2097Syntax for specifying a sheepdog device 2098@table @list 2099``sheepdog:<vdiname>'' 2100 2101``sheepdog:<vdiname>:<snapid>'' 2102 2103``sheepdog:<vdiname>:<tag>'' 2104 2105``sheepdog:<host>:<port>:<vdiname>'' 2106 2107``sheepdog:<host>:<port>:<vdiname>:<snapid>'' 2108 2109``sheepdog:<host>:<port>:<vdiname>:<tag>'' 2110@end table 2111 2112Example 2113@example 2114qemu-system-i386 --drive file=sheepdog:192.0.2.1:30000:MyVirtualMachine 2115@end example 2116 2117See also @url{http://http://www.osrg.net/sheepdog/}. 2118 2119@item GlusterFS 2120GlusterFS is an user space distributed file system. 2121QEMU supports the use of GlusterFS volumes for hosting VM disk images using 2122TCP, Unix Domain Sockets and RDMA transport protocols. 2123 2124Syntax for specifying a VM disk image on GlusterFS volume is 2125@example 2126gluster[+transport]://[server[:port]]/volname/image[?socket=...] 2127@end example 2128 2129 2130Example 2131@example 2132qemu-system-x86_84 --drive file=gluster://192.0.2.1/testvol/a.img 2133@end example 2134 2135See also @url{http://www.gluster.org}. 2136ETEXI 2137 2138STEXI 2139@end table 2140ETEXI 2141 2142DEFHEADING(Bluetooth(R) options:) 2143STEXI 2144@table @option 2145ETEXI 2146 2147DEF("bt", HAS_ARG, QEMU_OPTION_bt, \ 2148 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \ 2149 "-bt hci,host[:id]\n" \ 2150 " use host's HCI with the given name\n" \ 2151 "-bt hci[,vlan=n]\n" \ 2152 " emulate a standard HCI in virtual scatternet 'n'\n" \ 2153 "-bt vhci[,vlan=n]\n" \ 2154 " add host computer to virtual scatternet 'n' using VHCI\n" \ 2155 "-bt device:dev[,vlan=n]\n" \ 2156 " emulate a bluetooth device 'dev' in scatternet 'n'\n", 2157 QEMU_ARCH_ALL) 2158STEXI 2159@item -bt hci[...] 2160@findex -bt 2161Defines the function of the corresponding Bluetooth HCI. -bt options 2162are matched with the HCIs present in the chosen machine type. For 2163example when emulating a machine with only one HCI built into it, only 2164the first @code{-bt hci[...]} option is valid and defines the HCI's 2165logic. The Transport Layer is decided by the machine type. Currently 2166the machines @code{n800} and @code{n810} have one HCI and all other 2167machines have none. 2168 2169@anchor{bt-hcis} 2170The following three types are recognized: 2171 2172@table @option 2173@item -bt hci,null 2174(default) The corresponding Bluetooth HCI assumes no internal logic 2175and will not respond to any HCI commands or emit events. 2176 2177@item -bt hci,host[:@var{id}] 2178(@code{bluez} only) The corresponding HCI passes commands / events 2179to / from the physical HCI identified by the name @var{id} (default: 2180@code{hci0}) on the computer running QEMU. Only available on @code{bluez} 2181capable systems like Linux. 2182 2183@item -bt hci[,vlan=@var{n}] 2184Add a virtual, standard HCI that will participate in the Bluetooth 2185scatternet @var{n} (default @code{0}). Similarly to @option{-net} 2186VLANs, devices inside a bluetooth network @var{n} can only communicate 2187with other devices in the same network (scatternet). 2188@end table 2189 2190@item -bt vhci[,vlan=@var{n}] 2191(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached 2192to the host bluetooth stack instead of to the emulated target. This 2193allows the host and target machines to participate in a common scatternet 2194and communicate. Requires the Linux @code{vhci} driver installed. Can 2195be used as following: 2196 2197@example 2198qemu-system-i386 [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5 2199@end example 2200 2201@item -bt device:@var{dev}[,vlan=@var{n}] 2202Emulate a bluetooth device @var{dev} and place it in network @var{n} 2203(default @code{0}). QEMU can only emulate one type of bluetooth devices 2204currently: 2205 2206@table @option 2207@item keyboard 2208Virtual wireless keyboard implementing the HIDP bluetooth profile. 2209@end table 2210ETEXI 2211 2212STEXI 2213@end table 2214ETEXI 2215DEFHEADING() 2216 2217DEFHEADING(Linux/Multiboot boot specific:) 2218STEXI 2219 2220When using these options, you can use a given Linux or Multiboot 2221kernel without installing it in the disk image. It can be useful 2222for easier testing of various kernels. 2223 2224@table @option 2225ETEXI 2226 2227DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \ 2228 "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL) 2229STEXI 2230@item -kernel @var{bzImage} 2231@findex -kernel 2232Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel 2233or in multiboot format. 2234ETEXI 2235 2236DEF("append", HAS_ARG, QEMU_OPTION_append, \ 2237 "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL) 2238STEXI 2239@item -append @var{cmdline} 2240@findex -append 2241Use @var{cmdline} as kernel command line 2242ETEXI 2243 2244DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \ 2245 "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL) 2246STEXI 2247@item -initrd @var{file} 2248@findex -initrd 2249Use @var{file} as initial ram disk. 2250 2251@item -initrd "@var{file1} arg=foo,@var{file2}" 2252 2253This syntax is only available with multiboot. 2254 2255Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the 2256first module. 2257ETEXI 2258 2259DEF("dtb", HAS_ARG, QEMU_OPTION_dtb, \ 2260 "-dtb file use 'file' as device tree image\n", QEMU_ARCH_ALL) 2261STEXI 2262@item -dtb @var{file} 2263@findex -dtb 2264Use @var{file} as a device tree binary (dtb) image and pass it to the kernel 2265on boot. 2266ETEXI 2267 2268STEXI 2269@end table 2270ETEXI 2271DEFHEADING() 2272 2273DEFHEADING(Debug/Expert options:) 2274STEXI 2275@table @option 2276ETEXI 2277 2278DEF("serial", HAS_ARG, QEMU_OPTION_serial, \ 2279 "-serial dev redirect the serial port to char device 'dev'\n", 2280 QEMU_ARCH_ALL) 2281STEXI 2282@item -serial @var{dev} 2283@findex -serial 2284Redirect the virtual serial port to host character device 2285@var{dev}. The default device is @code{vc} in graphical mode and 2286@code{stdio} in non graphical mode. 2287 2288This option can be used several times to simulate up to 4 serial 2289ports. 2290 2291Use @code{-serial none} to disable all serial ports. 2292 2293Available character devices are: 2294@table @option 2295@item vc[:@var{W}x@var{H}] 2296Virtual console. Optionally, a width and height can be given in pixel with 2297@example 2298vc:800x600 2299@end example 2300It is also possible to specify width or height in characters: 2301@example 2302vc:80Cx24C 2303@end example 2304@item pty 2305[Linux only] Pseudo TTY (a new PTY is automatically allocated) 2306@item none 2307No device is allocated. 2308@item null 2309void device 2310@item /dev/XXX 2311[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port 2312parameters are set according to the emulated ones. 2313@item /dev/parport@var{N} 2314[Linux only, parallel port only] Use host parallel port 2315@var{N}. Currently SPP and EPP parallel port features can be used. 2316@item file:@var{filename} 2317Write output to @var{filename}. No character can be read. 2318@item stdio 2319[Unix only] standard input/output 2320@item pipe:@var{filename} 2321name pipe @var{filename} 2322@item COM@var{n} 2323[Windows only] Use host serial port @var{n} 2324@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}] 2325This implements UDP Net Console. 2326When @var{remote_host} or @var{src_ip} are not specified 2327they default to @code{0.0.0.0}. 2328When not using a specified @var{src_port} a random port is automatically chosen. 2329 2330If you just want a simple readonly console you can use @code{netcat} or 2331@code{nc}, by starting QEMU with: @code{-serial udp::4555} and nc as: 2332@code{nc -u -l -p 4555}. Any time QEMU writes something to that port it 2333will appear in the netconsole session. 2334 2335If you plan to send characters back via netconsole or you want to stop 2336and start QEMU a lot of times, you should have QEMU use the same 2337source port each time by using something like @code{-serial 2338udp::4555@@:4556} to QEMU. Another approach is to use a patched 2339version of netcat which can listen to a TCP port and send and receive 2340characters via udp. If you have a patched version of netcat which 2341activates telnet remote echo and single char transfer, then you can 2342use the following options to step up a netcat redirector to allow 2343telnet on port 5555 to access the QEMU port. 2344@table @code 2345@item QEMU Options: 2346-serial udp::4555@@:4556 2347@item netcat options: 2348-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T 2349@item telnet options: 2350localhost 5555 2351@end table 2352 2353@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay] 2354The TCP Net Console has two modes of operation. It can send the serial 2355I/O to a location or wait for a connection from a location. By default 2356the TCP Net Console is sent to @var{host} at the @var{port}. If you use 2357the @var{server} option QEMU will wait for a client socket application 2358to connect to the port before continuing, unless the @code{nowait} 2359option was specified. The @code{nodelay} option disables the Nagle buffering 2360algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only 2361one TCP connection at a time is accepted. You can use @code{telnet} to 2362connect to the corresponding character device. 2363@table @code 2364@item Example to send tcp console to 192.168.0.2 port 4444 2365-serial tcp:192.168.0.2:4444 2366@item Example to listen and wait on port 4444 for connection 2367-serial tcp::4444,server 2368@item Example to not wait and listen on ip 192.168.0.100 port 4444 2369-serial tcp:192.168.0.100:4444,server,nowait 2370@end table 2371 2372@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay] 2373The telnet protocol is used instead of raw tcp sockets. The options 2374work the same as if you had specified @code{-serial tcp}. The 2375difference is that the port acts like a telnet server or client using 2376telnet option negotiation. This will also allow you to send the 2377MAGIC_SYSRQ sequence if you use a telnet that supports sending the break 2378sequence. Typically in unix telnet you do it with Control-] and then 2379type "send break" followed by pressing the enter key. 2380 2381@item unix:@var{path}[,server][,nowait] 2382A unix domain socket is used instead of a tcp socket. The option works the 2383same as if you had specified @code{-serial tcp} except the unix domain socket 2384@var{path} is used for connections. 2385 2386@item mon:@var{dev_string} 2387This is a special option to allow the monitor to be multiplexed onto 2388another serial port. The monitor is accessed with key sequence of 2389@key{Control-a} and then pressing @key{c}. See monitor access 2390@ref{pcsys_keys} in the -nographic section for more keys. 2391@var{dev_string} should be any one of the serial devices specified 2392above. An example to multiplex the monitor onto a telnet server 2393listening on port 4444 would be: 2394@table @code 2395@item -serial mon:telnet::4444,server,nowait 2396@end table 2397 2398@item braille 2399Braille device. This will use BrlAPI to display the braille output on a real 2400or fake device. 2401 2402@item msmouse 2403Three button serial mouse. Configure the guest to use Microsoft protocol. 2404@end table 2405ETEXI 2406 2407DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \ 2408 "-parallel dev redirect the parallel port to char device 'dev'\n", 2409 QEMU_ARCH_ALL) 2410STEXI 2411@item -parallel @var{dev} 2412@findex -parallel 2413Redirect the virtual parallel port to host device @var{dev} (same 2414devices as the serial port). On Linux hosts, @file{/dev/parportN} can 2415be used to use hardware devices connected on the corresponding host 2416parallel port. 2417 2418This option can be used several times to simulate up to 3 parallel 2419ports. 2420 2421Use @code{-parallel none} to disable all parallel ports. 2422ETEXI 2423 2424DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \ 2425 "-monitor dev redirect the monitor to char device 'dev'\n", 2426 QEMU_ARCH_ALL) 2427STEXI 2428@item -monitor @var{dev} 2429@findex -monitor 2430Redirect the monitor to host device @var{dev} (same devices as the 2431serial port). 2432The default device is @code{vc} in graphical mode and @code{stdio} in 2433non graphical mode. 2434ETEXI 2435DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \ 2436 "-qmp dev like -monitor but opens in 'control' mode\n", 2437 QEMU_ARCH_ALL) 2438STEXI 2439@item -qmp @var{dev} 2440@findex -qmp 2441Like -monitor but opens in 'control' mode. 2442ETEXI 2443 2444DEF("mon", HAS_ARG, QEMU_OPTION_mon, \ 2445 "-mon chardev=[name][,mode=readline|control][,default]\n", QEMU_ARCH_ALL) 2446STEXI 2447@item -mon chardev=[name][,mode=readline|control][,default] 2448@findex -mon 2449Setup monitor on chardev @var{name}. 2450ETEXI 2451 2452DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \ 2453 "-debugcon dev redirect the debug console to char device 'dev'\n", 2454 QEMU_ARCH_ALL) 2455STEXI 2456@item -debugcon @var{dev} 2457@findex -debugcon 2458Redirect the debug console to host device @var{dev} (same devices as the 2459serial port). The debug console is an I/O port which is typically port 24600xe9; writing to that I/O port sends output to this device. 2461The default device is @code{vc} in graphical mode and @code{stdio} in 2462non graphical mode. 2463ETEXI 2464 2465DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \ 2466 "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL) 2467STEXI 2468@item -pidfile @var{file} 2469@findex -pidfile 2470Store the QEMU process PID in @var{file}. It is useful if you launch QEMU 2471from a script. 2472ETEXI 2473 2474DEF("singlestep", 0, QEMU_OPTION_singlestep, \ 2475 "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL) 2476STEXI 2477@item -singlestep 2478@findex -singlestep 2479Run the emulation in single step mode. 2480ETEXI 2481 2482DEF("S", 0, QEMU_OPTION_S, \ 2483 "-S freeze CPU at startup (use 'c' to start execution)\n", 2484 QEMU_ARCH_ALL) 2485STEXI 2486@item -S 2487@findex -S 2488Do not start CPU at startup (you must type 'c' in the monitor). 2489ETEXI 2490 2491DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \ 2492 "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL) 2493STEXI 2494@item -gdb @var{dev} 2495@findex -gdb 2496Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical 2497connections will likely be TCP-based, but also UDP, pseudo TTY, or even 2498stdio are reasonable use case. The latter is allowing to start QEMU from 2499within gdb and establish the connection via a pipe: 2500@example 2501(gdb) target remote | exec qemu-system-i386 -gdb stdio ... 2502@end example 2503ETEXI 2504 2505DEF("s", 0, QEMU_OPTION_s, \ 2506 "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n", 2507 QEMU_ARCH_ALL) 2508STEXI 2509@item -s 2510@findex -s 2511Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234 2512(@pxref{gdb_usage}). 2513ETEXI 2514 2515DEF("d", HAS_ARG, QEMU_OPTION_d, \ 2516 "-d item1,... output log to /tmp/qemu.log (use '-d help' for a list of log items)\n", 2517 QEMU_ARCH_ALL) 2518STEXI 2519@item -d 2520@findex -d 2521Output log in /tmp/qemu.log 2522ETEXI 2523 2524DEF("D", HAS_ARG, QEMU_OPTION_D, \ 2525 "-D logfile output log to logfile (instead of the default /tmp/qemu.log)\n", 2526 QEMU_ARCH_ALL) 2527STEXI 2528@item -D @var{logfile} 2529@findex -D 2530Output log in @var{logfile} instead of /tmp/qemu.log 2531ETEXI 2532 2533DEF("L", HAS_ARG, QEMU_OPTION_L, \ 2534 "-L path set the directory for the BIOS, VGA BIOS and keymaps\n", 2535 QEMU_ARCH_ALL) 2536STEXI 2537@item -L @var{path} 2538@findex -L 2539Set the directory for the BIOS, VGA BIOS and keymaps. 2540ETEXI 2541 2542DEF("bios", HAS_ARG, QEMU_OPTION_bios, \ 2543 "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL) 2544STEXI 2545@item -bios @var{file} 2546@findex -bios 2547Set the filename for the BIOS. 2548ETEXI 2549 2550DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \ 2551 "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL) 2552STEXI 2553@item -enable-kvm 2554@findex -enable-kvm 2555Enable KVM full virtualization support. This option is only available 2556if KVM support is enabled when compiling. 2557ETEXI 2558 2559DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid, 2560 "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL) 2561DEF("xen-create", 0, QEMU_OPTION_xen_create, 2562 "-xen-create create domain using xen hypercalls, bypassing xend\n" 2563 " warning: should not be used when xend is in use\n", 2564 QEMU_ARCH_ALL) 2565DEF("xen-attach", 0, QEMU_OPTION_xen_attach, 2566 "-xen-attach attach to existing xen domain\n" 2567 " xend will use this when starting QEMU\n", 2568 QEMU_ARCH_ALL) 2569STEXI 2570@item -xen-domid @var{id} 2571@findex -xen-domid 2572Specify xen guest domain @var{id} (XEN only). 2573@item -xen-create 2574@findex -xen-create 2575Create domain using xen hypercalls, bypassing xend. 2576Warning: should not be used when xend is in use (XEN only). 2577@item -xen-attach 2578@findex -xen-attach 2579Attach to existing xen domain. 2580xend will use this when starting QEMU (XEN only). 2581ETEXI 2582 2583DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \ 2584 "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL) 2585STEXI 2586@item -no-reboot 2587@findex -no-reboot 2588Exit instead of rebooting. 2589ETEXI 2590 2591DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \ 2592 "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL) 2593STEXI 2594@item -no-shutdown 2595@findex -no-shutdown 2596Don't exit QEMU on guest shutdown, but instead only stop the emulation. 2597This allows for instance switching to monitor to commit changes to the 2598disk image. 2599ETEXI 2600 2601DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \ 2602 "-loadvm [tag|id]\n" \ 2603 " start right away with a saved state (loadvm in monitor)\n", 2604 QEMU_ARCH_ALL) 2605STEXI 2606@item -loadvm @var{file} 2607@findex -loadvm 2608Start right away with a saved state (@code{loadvm} in monitor) 2609ETEXI 2610 2611#ifndef _WIN32 2612DEF("daemonize", 0, QEMU_OPTION_daemonize, \ 2613 "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL) 2614#endif 2615STEXI 2616@item -daemonize 2617@findex -daemonize 2618Daemonize the QEMU process after initialization. QEMU will not detach from 2619standard IO until it is ready to receive connections on any of its devices. 2620This option is a useful way for external programs to launch QEMU without having 2621to cope with initialization race conditions. 2622ETEXI 2623 2624DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \ 2625 "-option-rom rom load a file, rom, into the option ROM space\n", 2626 QEMU_ARCH_ALL) 2627STEXI 2628@item -option-rom @var{file} 2629@findex -option-rom 2630Load the contents of @var{file} as an option ROM. 2631This option is useful to load things like EtherBoot. 2632ETEXI 2633 2634DEF("clock", HAS_ARG, QEMU_OPTION_clock, \ 2635 "-clock force the use of the given methods for timer alarm.\n" \ 2636 " To see what timers are available use '-clock help'\n", 2637 QEMU_ARCH_ALL) 2638STEXI 2639@item -clock @var{method} 2640@findex -clock 2641Force the use of the given methods for timer alarm. To see what timers 2642are available use @code{-clock help}. 2643ETEXI 2644 2645HXCOMM Options deprecated by -rtc 2646DEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL) 2647DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL) 2648 2649DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \ 2650 "-rtc [base=utc|localtime|date][,clock=host|rt|vm][,driftfix=none|slew]\n" \ 2651 " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n", 2652 QEMU_ARCH_ALL) 2653 2654STEXI 2655 2656@item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew] 2657@findex -rtc 2658Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current 2659UTC or local time, respectively. @code{localtime} is required for correct date in 2660MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the 2661format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC. 2662 2663By default the RTC is driven by the host system time. This allows to use the 2664RTC as accurate reference clock inside the guest, specifically if the host 2665time is smoothly following an accurate external reference clock, e.g. via NTP. 2666If you want to isolate the guest time from the host, you can set @option{clock} 2667to @code{rt} instead. To even prevent it from progressing during suspension, 2668you can set it to @code{vm}. 2669 2670Enable @option{driftfix} (i386 targets only) if you experience time drift problems, 2671specifically with Windows' ACPI HAL. This option will try to figure out how 2672many timer interrupts were not processed by the Windows guest and will 2673re-inject them. 2674ETEXI 2675 2676DEF("icount", HAS_ARG, QEMU_OPTION_icount, \ 2677 "-icount [N|auto]\n" \ 2678 " enable virtual instruction counter with 2^N clock ticks per\n" \ 2679 " instruction\n", QEMU_ARCH_ALL) 2680STEXI 2681@item -icount [@var{N}|auto] 2682@findex -icount 2683Enable virtual instruction counter. The virtual cpu will execute one 2684instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified 2685then the virtual cpu speed will be automatically adjusted to keep virtual 2686time within a few seconds of real time. 2687 2688Note that while this option can give deterministic behavior, it does not 2689provide cycle accurate emulation. Modern CPUs contain superscalar out of 2690order cores with complex cache hierarchies. The number of instructions 2691executed often has little or no correlation with actual performance. 2692ETEXI 2693 2694DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \ 2695 "-watchdog i6300esb|ib700\n" \ 2696 " enable virtual hardware watchdog [default=none]\n", 2697 QEMU_ARCH_ALL) 2698STEXI 2699@item -watchdog @var{model} 2700@findex -watchdog 2701Create a virtual hardware watchdog device. Once enabled (by a guest 2702action), the watchdog must be periodically polled by an agent inside 2703the guest or else the guest will be restarted. 2704 2705The @var{model} is the model of hardware watchdog to emulate. Choices 2706for model are: @code{ib700} (iBASE 700) which is a very simple ISA 2707watchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O 2708controller hub) which is a much more featureful PCI-based dual-timer 2709watchdog. Choose a model for which your guest has drivers. 2710 2711Use @code{-watchdog help} to list available hardware models. Only one 2712watchdog can be enabled for a guest. 2713ETEXI 2714 2715DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \ 2716 "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \ 2717 " action when watchdog fires [default=reset]\n", 2718 QEMU_ARCH_ALL) 2719STEXI 2720@item -watchdog-action @var{action} 2721@findex -watchdog-action 2722 2723The @var{action} controls what QEMU will do when the watchdog timer 2724expires. 2725The default is 2726@code{reset} (forcefully reset the guest). 2727Other possible actions are: 2728@code{shutdown} (attempt to gracefully shutdown the guest), 2729@code{poweroff} (forcefully poweroff the guest), 2730@code{pause} (pause the guest), 2731@code{debug} (print a debug message and continue), or 2732@code{none} (do nothing). 2733 2734Note that the @code{shutdown} action requires that the guest responds 2735to ACPI signals, which it may not be able to do in the sort of 2736situations where the watchdog would have expired, and thus 2737@code{-watchdog-action shutdown} is not recommended for production use. 2738 2739Examples: 2740 2741@table @code 2742@item -watchdog i6300esb -watchdog-action pause 2743@item -watchdog ib700 2744@end table 2745ETEXI 2746 2747DEF("echr", HAS_ARG, QEMU_OPTION_echr, \ 2748 "-echr chr set terminal escape character instead of ctrl-a\n", 2749 QEMU_ARCH_ALL) 2750STEXI 2751 2752@item -echr @var{numeric_ascii_value} 2753@findex -echr 2754Change the escape character used for switching to the monitor when using 2755monitor and serial sharing. The default is @code{0x01} when using the 2756@code{-nographic} option. @code{0x01} is equal to pressing 2757@code{Control-a}. You can select a different character from the ascii 2758control keys where 1 through 26 map to Control-a through Control-z. For 2759instance you could use the either of the following to change the escape 2760character to Control-t. 2761@table @code 2762@item -echr 0x14 2763@item -echr 20 2764@end table 2765ETEXI 2766 2767DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \ 2768 "-virtioconsole c\n" \ 2769 " set virtio console\n", QEMU_ARCH_ALL) 2770STEXI 2771@item -virtioconsole @var{c} 2772@findex -virtioconsole 2773Set virtio console. 2774 2775This option is maintained for backward compatibility. 2776 2777Please use @code{-device virtconsole} for the new way of invocation. 2778ETEXI 2779 2780DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \ 2781 "-show-cursor show cursor\n", QEMU_ARCH_ALL) 2782STEXI 2783@item -show-cursor 2784@findex -show-cursor 2785Show cursor. 2786ETEXI 2787 2788DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \ 2789 "-tb-size n set TB size\n", QEMU_ARCH_ALL) 2790STEXI 2791@item -tb-size @var{n} 2792@findex -tb-size 2793Set TB size. 2794ETEXI 2795 2796DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ 2797 "-incoming p prepare for incoming migration, listen on port p\n", 2798 QEMU_ARCH_ALL) 2799STEXI 2800@item -incoming @var{port} 2801@findex -incoming 2802Prepare for incoming migration, listen on @var{port}. 2803ETEXI 2804 2805DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \ 2806 "-nodefaults don't create default devices\n", QEMU_ARCH_ALL) 2807STEXI 2808@item -nodefaults 2809@findex -nodefaults 2810Don't create default devices. Normally, QEMU sets the default devices like serial 2811port, parallel port, virtual console, monitor device, VGA adapter, floppy and 2812CD-ROM drive and others. The @code{-nodefaults} option will disable all those 2813default devices. 2814ETEXI 2815 2816#ifndef _WIN32 2817DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \ 2818 "-chroot dir chroot to dir just before starting the VM\n", 2819 QEMU_ARCH_ALL) 2820#endif 2821STEXI 2822@item -chroot @var{dir} 2823@findex -chroot 2824Immediately before starting guest execution, chroot to the specified 2825directory. Especially useful in combination with -runas. 2826ETEXI 2827 2828#ifndef _WIN32 2829DEF("runas", HAS_ARG, QEMU_OPTION_runas, \ 2830 "-runas user change to user id user just before starting the VM\n", 2831 QEMU_ARCH_ALL) 2832#endif 2833STEXI 2834@item -runas @var{user} 2835@findex -runas 2836Immediately before starting guest execution, drop root privileges, switching 2837to the specified user. 2838ETEXI 2839 2840DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env, 2841 "-prom-env variable=value\n" 2842 " set OpenBIOS nvram variables\n", 2843 QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 2844STEXI 2845@item -prom-env @var{variable}=@var{value} 2846@findex -prom-env 2847Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only). 2848ETEXI 2849DEF("semihosting", 0, QEMU_OPTION_semihosting, 2850 "-semihosting semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA) 2851STEXI 2852@item -semihosting 2853@findex -semihosting 2854Semihosting mode (ARM, M68K, Xtensa only). 2855ETEXI 2856DEF("old-param", 0, QEMU_OPTION_old_param, 2857 "-old-param old param mode\n", QEMU_ARCH_ARM) 2858STEXI 2859@item -old-param 2860@findex -old-param (ARM) 2861Old param mode (ARM only). 2862ETEXI 2863 2864DEF("sandbox", HAS_ARG, QEMU_OPTION_sandbox, \ 2865 "-sandbox <arg> Enable seccomp mode 2 system call filter (default 'off').\n", 2866 QEMU_ARCH_ALL) 2867STEXI 2868@item -sandbox @var{arg} 2869@findex -sandbox 2870Enable Seccomp mode 2 system call filter. 'on' will enable syscall filtering and 'off' will 2871disable it. The default is 'off'. 2872ETEXI 2873 2874DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig, 2875 "-readconfig <file>\n", QEMU_ARCH_ALL) 2876STEXI 2877@item -readconfig @var{file} 2878@findex -readconfig 2879Read device configuration from @var{file}. This approach is useful when you want to spawn 2880QEMU process with many command line options but you don't want to exceed the command line 2881character limit. 2882ETEXI 2883DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig, 2884 "-writeconfig <file>\n" 2885 " read/write config file\n", QEMU_ARCH_ALL) 2886STEXI 2887@item -writeconfig @var{file} 2888@findex -writeconfig 2889Write device configuration to @var{file}. The @var{file} can be either filename to save 2890command line and device configuration into file or dash @code{-}) character to print the 2891output to stdout. This can be later used as input file for @code{-readconfig} option. 2892ETEXI 2893DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig, 2894 "-nodefconfig\n" 2895 " do not load default config files at startup\n", 2896 QEMU_ARCH_ALL) 2897STEXI 2898@item -nodefconfig 2899@findex -nodefconfig 2900Normally QEMU loads configuration files from @var{sysconfdir} and @var{datadir} at startup. 2901The @code{-nodefconfig} option will prevent QEMU from loading any of those config files. 2902ETEXI 2903DEF("no-user-config", 0, QEMU_OPTION_nouserconfig, 2904 "-no-user-config\n" 2905 " do not load user-provided config files at startup\n", 2906 QEMU_ARCH_ALL) 2907STEXI 2908@item -no-user-config 2909@findex -no-user-config 2910The @code{-no-user-config} option makes QEMU not load any of the user-provided 2911config files on @var{sysconfdir}, but won't make it skip the QEMU-provided config 2912files from @var{datadir}. 2913ETEXI 2914DEF("trace", HAS_ARG, QEMU_OPTION_trace, 2915 "-trace [events=<file>][,file=<file>]\n" 2916 " specify tracing options\n", 2917 QEMU_ARCH_ALL) 2918STEXI 2919HXCOMM This line is not accurate, as some sub-options are backend-specific but 2920HXCOMM HX does not support conditional compilation of text. 2921@item -trace [events=@var{file}][,file=@var{file}] 2922@findex -trace 2923 2924Specify tracing options. 2925 2926@table @option 2927@item events=@var{file} 2928Immediately enable events listed in @var{file}. 2929The file must contain one event name (as listed in the @var{trace-events} file) 2930per line. 2931This option is only available if QEMU has been compiled with 2932either @var{simple} or @var{stderr} tracing backend. 2933@item file=@var{file} 2934Log output traces to @var{file}. 2935 2936This option is only available if QEMU has been compiled with 2937the @var{simple} tracing backend. 2938@end table 2939ETEXI 2940 2941HXCOMM Internal use 2942DEF("qtest", HAS_ARG, QEMU_OPTION_qtest, "", QEMU_ARCH_ALL) 2943DEF("qtest-log", HAS_ARG, QEMU_OPTION_qtest_log, "", QEMU_ARCH_ALL) 2944 2945#ifdef __linux__ 2946DEF("enable-fips", 0, QEMU_OPTION_enablefips, 2947 "-enable-fips enable FIPS 140-2 compliance\n", 2948 QEMU_ARCH_ALL) 2949#endif 2950STEXI 2951@item -enable-fips 2952@findex -enable-fips 2953Enable FIPS 140-2 compliance mode. 2954ETEXI 2955 2956HXCOMM Deprecated by -machine accel=tcg property 2957DEF("no-kvm", 0, QEMU_OPTION_no_kvm, "", QEMU_ARCH_I386) 2958 2959HXCOMM Deprecated by kvm-pit driver properties 2960DEF("no-kvm-pit-reinjection", 0, QEMU_OPTION_no_kvm_pit_reinjection, 2961 "", QEMU_ARCH_I386) 2962 2963HXCOMM Deprecated (ignored) 2964DEF("no-kvm-pit", 0, QEMU_OPTION_no_kvm_pit, "", QEMU_ARCH_I386) 2965 2966HXCOMM Deprecated by -machine kernel_irqchip=on|off property 2967DEF("no-kvm-irqchip", 0, QEMU_OPTION_no_kvm_irqchip, "", QEMU_ARCH_I386) 2968 2969HXCOMM Deprecated (ignored) 2970DEF("tdf", 0, QEMU_OPTION_tdf,"", QEMU_ARCH_ALL) 2971 2972DEF("object", HAS_ARG, QEMU_OPTION_object, 2973 "-object TYPENAME[,PROP1=VALUE1,...]\n" 2974 " create an new object of type TYPENAME setting properties\n" 2975 " in the order they are specified. Note that the 'id'\n" 2976 " property must be set. These objects are placed in the\n" 2977 " '/objects' path.\n", 2978 QEMU_ARCH_ALL) 2979STEXI 2980@item -object @var{typename}[,@var{prop1}=@var{value1},...] 2981@findex -object 2982Create an new object of type @var{typename} setting properties 2983in the order they are specified. Note that the 'id' 2984property must be set. These objects are placed in the 2985'/objects' path. 2986ETEXI 2987 2988HXCOMM This is the last statement. Insert new options before this line! 2989STEXI 2990@end table 2991ETEXI 2992
