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