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