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 "vhost-user|" 1464 "socket|" 1465 "hubport],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL) 1466STEXI 1467@item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}] 1468@findex -net 1469Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n} 1470= 0 is the default). The NIC is an e1000 by default on the PC 1471target. Optionally, the MAC address can be changed to @var{mac}, the 1472device address set to @var{addr} (PCI cards only), 1473and a @var{name} can be assigned for use in monitor commands. 1474Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors 1475that the card should have; this option currently only affects virtio cards; set 1476@var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single 1477NIC is created. QEMU can emulate several different models of network card. 1478Valid values for @var{type} are 1479@code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er}, 1480@code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139}, 1481@code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}. 1482Not all devices are supported on all targets. Use @code{-net nic,model=help} 1483for a list of available devices for your target. 1484 1485@item -netdev user,id=@var{id}[,@var{option}][,@var{option}][,...] 1486@findex -netdev 1487@item -net user[,@var{option}][,@var{option}][,...] 1488Use the user mode network stack which requires no administrator 1489privilege to run. Valid options are: 1490 1491@table @option 1492@item vlan=@var{n} 1493Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default). 1494 1495@item id=@var{id} 1496@item name=@var{name} 1497Assign symbolic name for use in monitor commands. 1498 1499@item net=@var{addr}[/@var{mask}] 1500Set IP network address the guest will see. Optionally specify the netmask, 1501either in the form a.b.c.d or as number of valid top-most bits. Default is 150210.0.2.0/24. 1503 1504@item host=@var{addr} 1505Specify the guest-visible address of the host. Default is the 2nd IP in the 1506guest network, i.e. x.x.x.2. 1507 1508@item restrict=on|off 1509If this option is enabled, the guest will be isolated, i.e. it will not be 1510able to contact the host and no guest IP packets will be routed over the host 1511to the outside. This option does not affect any explicitly set forwarding rules. 1512 1513@item hostname=@var{name} 1514Specifies the client hostname reported by the built-in DHCP server. 1515 1516@item dhcpstart=@var{addr} 1517Specify the first of the 16 IPs the built-in DHCP server can assign. Default 1518is the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31. 1519 1520@item dns=@var{addr} 1521Specify the guest-visible address of the virtual nameserver. The address must 1522be different from the host address. Default is the 3rd IP in the guest network, 1523i.e. x.x.x.3. 1524 1525@item dnssearch=@var{domain} 1526Provides an entry for the domain-search list sent by the built-in 1527DHCP server. More than one domain suffix can be transmitted by specifying 1528this option multiple times. If supported, this will cause the guest to 1529automatically try to append the given domain suffix(es) in case a domain name 1530can not be resolved. 1531 1532Example: 1533@example 1534qemu -net user,dnssearch=mgmt.example.org,dnssearch=example.org [...] 1535@end example 1536 1537@item tftp=@var{dir} 1538When using the user mode network stack, activate a built-in TFTP 1539server. The files in @var{dir} will be exposed as the root of a TFTP server. 1540The TFTP client on the guest must be configured in binary mode (use the command 1541@code{bin} of the Unix TFTP client). 1542 1543@item bootfile=@var{file} 1544When using the user mode network stack, broadcast @var{file} as the BOOTP 1545filename. In conjunction with @option{tftp}, this can be used to network boot 1546a guest from a local directory. 1547 1548Example (using pxelinux): 1549@example 1550qemu-system-i386 -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0 1551@end example 1552 1553@item smb=@var{dir}[,smbserver=@var{addr}] 1554When using the user mode network stack, activate a built-in SMB 1555server so that Windows OSes can access to the host files in @file{@var{dir}} 1556transparently. The IP address of the SMB server can be set to @var{addr}. By 1557default the 4th IP in the guest network is used, i.e. x.x.x.4. 1558 1559In the guest Windows OS, the line: 1560@example 156110.0.2.4 smbserver 1562@end example 1563must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me) 1564or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000). 1565 1566Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}. 1567 1568Note that a SAMBA server must be installed on the host OS. 1569QEMU was tested successfully with smbd versions from Red Hat 9, 1570Fedora Core 3 and OpenSUSE 11.x. 1571 1572@item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport} 1573Redirect incoming TCP or UDP connections to the host port @var{hostport} to 1574the guest IP address @var{guestaddr} on guest port @var{guestport}. If 1575@var{guestaddr} is not specified, its value is x.x.x.15 (default first address 1576given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can 1577be bound to a specific host interface. If no connection type is set, TCP is 1578used. This option can be given multiple times. 1579 1580For example, to redirect host X11 connection from screen 1 to guest 1581screen 0, use the following: 1582 1583@example 1584# on the host 1585qemu-system-i386 -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...] 1586# this host xterm should open in the guest X11 server 1587xterm -display :1 1588@end example 1589 1590To redirect telnet connections from host port 5555 to telnet port on 1591the guest, use the following: 1592 1593@example 1594# on the host 1595qemu-system-i386 -net user,hostfwd=tcp::5555-:23 [...] 1596telnet localhost 5555 1597@end example 1598 1599Then when you use on the host @code{telnet localhost 5555}, you 1600connect to the guest telnet server. 1601 1602@item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev} 1603@item guestfwd=[tcp]:@var{server}:@var{port}-@var{cmd:command} 1604Forward guest TCP connections to the IP address @var{server} on port @var{port} 1605to the character device @var{dev} or to a program executed by @var{cmd:command} 1606which gets spawned for each connection. This option can be given multiple times. 1607 1608You can either use a chardev directly and have that one used throughout QEMU's 1609lifetime, like in the following example: 1610 1611@example 1612# open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it whenever 1613# the guest accesses it 1614qemu -net user,guestfwd=tcp:10.0.2.100:1234-tcp:10.10.1.1:4321 [...] 1615@end example 1616 1617Or you can execute a command on every TCP connection established by the guest, 1618so that QEMU behaves similar to an inetd process for that virtual server: 1619 1620@example 1621# call "netcat 10.10.1.1 4321" on every TCP connection to 10.0.2.100:1234 1622# and connect the TCP stream to its stdin/stdout 1623qemu -net 'user,guestfwd=tcp:10.0.2.100:1234-cmd:netcat 10.10.1.1 4321' 1624@end example 1625 1626@end table 1627 1628Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still 1629processed and applied to -net user. Mixing them with the new configuration 1630syntax gives undefined results. Their use for new applications is discouraged 1631as they will be removed from future versions. 1632 1633@item -netdev tap,id=@var{id}[,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}] 1634@item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}] 1635Connect the host TAP network interface @var{name} to VLAN @var{n}. 1636 1637Use the network script @var{file} to configure it and the network script 1638@var{dfile} to deconfigure it. If @var{name} is not provided, the OS 1639automatically provides one. The default network configure script is 1640@file{/etc/qemu-ifup} and the default network deconfigure script is 1641@file{/etc/qemu-ifdown}. Use @option{script=no} or @option{downscript=no} 1642to disable script execution. 1643 1644If running QEMU as an unprivileged user, use the network helper 1645@var{helper} to configure the TAP interface. The default network 1646helper executable is @file{/path/to/qemu-bridge-helper}. 1647 1648@option{fd}=@var{h} can be used to specify the handle of an already 1649opened host TAP interface. 1650 1651Examples: 1652 1653@example 1654#launch a QEMU instance with the default network script 1655qemu-system-i386 linux.img -net nic -net tap 1656@end example 1657 1658@example 1659#launch a QEMU instance with two NICs, each one connected 1660#to a TAP device 1661qemu-system-i386 linux.img \ 1662 -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \ 1663 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1 1664@end example 1665 1666@example 1667#launch a QEMU instance with the default network helper to 1668#connect a TAP device to bridge br0 1669qemu-system-i386 linux.img \ 1670 -net nic -net tap,"helper=/path/to/qemu-bridge-helper" 1671@end example 1672 1673@item -netdev bridge,id=@var{id}[,br=@var{bridge}][,helper=@var{helper}] 1674@item -net bridge[,vlan=@var{n}][,name=@var{name}][,br=@var{bridge}][,helper=@var{helper}] 1675Connect a host TAP network interface to a host bridge device. 1676 1677Use the network helper @var{helper} to configure the TAP interface and 1678attach it to the bridge. The default network helper executable is 1679@file{/path/to/qemu-bridge-helper} and the default bridge 1680device is @file{br0}. 1681 1682Examples: 1683 1684@example 1685#launch a QEMU instance with the default network helper to 1686#connect a TAP device to bridge br0 1687qemu-system-i386 linux.img -net bridge -net nic,model=virtio 1688@end example 1689 1690@example 1691#launch a QEMU instance with the default network helper to 1692#connect a TAP device to bridge qemubr0 1693qemu-system-i386 linux.img -net bridge,br=qemubr0 -net nic,model=virtio 1694@end example 1695 1696@item -netdev socket,id=@var{id}[,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 1697@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 1698 1699Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual 1700machine using a TCP socket connection. If @option{listen} is 1701specified, QEMU waits for incoming connections on @var{port} 1702(@var{host} is optional). @option{connect} is used to connect to 1703another QEMU instance using the @option{listen} option. @option{fd}=@var{h} 1704specifies an already opened TCP socket. 1705 1706Example: 1707@example 1708# launch a first QEMU instance 1709qemu-system-i386 linux.img \ 1710 -net nic,macaddr=52:54:00:12:34:56 \ 1711 -net socket,listen=:1234 1712# connect the VLAN 0 of this instance to the VLAN 0 1713# of the first instance 1714qemu-system-i386 linux.img \ 1715 -net nic,macaddr=52:54:00:12:34:57 \ 1716 -net socket,connect=127.0.0.1:1234 1717@end example 1718 1719@item -netdev socket,id=@var{id}[,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] 1720@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] 1721 1722Create a VLAN @var{n} shared with another QEMU virtual 1723machines using a UDP multicast socket, effectively making a bus for 1724every QEMU with same multicast address @var{maddr} and @var{port}. 1725NOTES: 1726@enumerate 1727@item 1728Several QEMU can be running on different hosts and share same bus (assuming 1729correct multicast setup for these hosts). 1730@item 1731mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see 1732@url{http://user-mode-linux.sf.net}. 1733@item 1734Use @option{fd=h} to specify an already opened UDP multicast socket. 1735@end enumerate 1736 1737Example: 1738@example 1739# launch one QEMU instance 1740qemu-system-i386 linux.img \ 1741 -net nic,macaddr=52:54:00:12:34:56 \ 1742 -net socket,mcast=230.0.0.1:1234 1743# launch another QEMU instance on same "bus" 1744qemu-system-i386 linux.img \ 1745 -net nic,macaddr=52:54:00:12:34:57 \ 1746 -net socket,mcast=230.0.0.1:1234 1747# launch yet another QEMU instance on same "bus" 1748qemu-system-i386 linux.img \ 1749 -net nic,macaddr=52:54:00:12:34:58 \ 1750 -net socket,mcast=230.0.0.1:1234 1751@end example 1752 1753Example (User Mode Linux compat.): 1754@example 1755# launch QEMU instance (note mcast address selected 1756# is UML's default) 1757qemu-system-i386 linux.img \ 1758 -net nic,macaddr=52:54:00:12:34:56 \ 1759 -net socket,mcast=239.192.168.1:1102 1760# launch UML 1761/path/to/linux ubd0=/path/to/root_fs eth0=mcast 1762@end example 1763 1764Example (send packets from host's 1.2.3.4): 1765@example 1766qemu-system-i386 linux.img \ 1767 -net nic,macaddr=52:54:00:12:34:56 \ 1768 -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4 1769@end example 1770 1771@item -netdev vde,id=@var{id}[,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 1772@item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 1773Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and 1774listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname} 1775and MODE @var{octalmode} to change default ownership and permissions for 1776communication port. This option is only available if QEMU has been compiled 1777with vde support enabled. 1778 1779Example: 1780@example 1781# launch vde switch 1782vde_switch -F -sock /tmp/myswitch 1783# launch QEMU instance 1784qemu-system-i386 linux.img -net nic -net vde,sock=/tmp/myswitch 1785@end example 1786 1787@item -netdev hubport,id=@var{id},hubid=@var{hubid} 1788 1789Create a hub port on QEMU "vlan" @var{hubid}. 1790 1791The hubport netdev lets you connect a NIC to a QEMU "vlan" instead of a single 1792netdev. @code{-net} and @code{-device} with parameter @option{vlan} create the 1793required hub automatically. 1794 1795@item -netdev vhost-user,chardev=@var{id}[,vhostforce=on|off] 1796 1797Establish a vhost-user netdev, backed by a chardev @var{id}. The chardev should 1798be a unix domain socket backed one. The vhost-user uses a specifically defined 1799protocol to pass vhost ioctl replacement messages to an application on the other 1800end of the socket. On non-MSIX guests, the feature can be forced with 1801@var{vhostforce}. 1802 1803Example: 1804@example 1805qemu -m 512 -object memory-backend-file,id=mem,size=512M,mem-path=/hugetlbfs,share=on \ 1806 -numa node,memdev=mem \ 1807 -chardev socket,path=/path/to/socket \ 1808 -netdev type=vhost-user,id=net0,chardev=chr0 \ 1809 -device virtio-net-pci,netdev=net0 1810@end example 1811 1812@item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}] 1813Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default). 1814At most @var{len} bytes (64k by default) per packet are stored. The file format is 1815libpcap, so it can be analyzed with tools such as tcpdump or Wireshark. 1816 1817@item -net none 1818Indicate that no network devices should be configured. It is used to 1819override the default configuration (@option{-net nic -net user}) which 1820is activated if no @option{-net} options are provided. 1821ETEXI 1822 1823STEXI 1824@end table 1825ETEXI 1826DEFHEADING() 1827 1828DEFHEADING(Character device options:) 1829STEXI 1830 1831The general form of a character device option is: 1832@table @option 1833ETEXI 1834 1835DEF("chardev", HAS_ARG, QEMU_OPTION_chardev, 1836 "-chardev null,id=id[,mux=on|off]\n" 1837 "-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n" 1838 " [,server][,nowait][,telnet][,mux=on|off] (tcp)\n" 1839 "-chardev socket,id=id,path=path[,server][,nowait][,telnet],[mux=on|off] (unix)\n" 1840 "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n" 1841 " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n" 1842 "-chardev msmouse,id=id[,mux=on|off]\n" 1843 "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n" 1844 " [,mux=on|off]\n" 1845 "-chardev ringbuf,id=id[,size=size]\n" 1846 "-chardev file,id=id,path=path[,mux=on|off]\n" 1847 "-chardev pipe,id=id,path=path[,mux=on|off]\n" 1848#ifdef _WIN32 1849 "-chardev console,id=id[,mux=on|off]\n" 1850 "-chardev serial,id=id,path=path[,mux=on|off]\n" 1851#else 1852 "-chardev pty,id=id[,mux=on|off]\n" 1853 "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n" 1854#endif 1855#ifdef CONFIG_BRLAPI 1856 "-chardev braille,id=id[,mux=on|off]\n" 1857#endif 1858#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \ 1859 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) 1860 "-chardev serial,id=id,path=path[,mux=on|off]\n" 1861 "-chardev tty,id=id,path=path[,mux=on|off]\n" 1862#endif 1863#if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__) 1864 "-chardev parallel,id=id,path=path[,mux=on|off]\n" 1865 "-chardev parport,id=id,path=path[,mux=on|off]\n" 1866#endif 1867#if defined(CONFIG_SPICE) 1868 "-chardev spicevmc,id=id,name=name[,debug=debug]\n" 1869 "-chardev spiceport,id=id,name=name[,debug=debug]\n" 1870#endif 1871 , QEMU_ARCH_ALL 1872) 1873 1874STEXI 1875@item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}] 1876@findex -chardev 1877Backend is one of: 1878@option{null}, 1879@option{socket}, 1880@option{udp}, 1881@option{msmouse}, 1882@option{vc}, 1883@option{ringbuf}, 1884@option{file}, 1885@option{pipe}, 1886@option{console}, 1887@option{serial}, 1888@option{pty}, 1889@option{stdio}, 1890@option{braille}, 1891@option{tty}, 1892@option{parallel}, 1893@option{parport}, 1894@option{spicevmc}. 1895@option{spiceport}. 1896The specific backend will determine the applicable options. 1897 1898All devices must have an id, which can be any string up to 127 characters long. 1899It is used to uniquely identify this device in other command line directives. 1900 1901A character device may be used in multiplexing mode by multiple front-ends. 1902The key sequence of @key{Control-a} and @key{c} will rotate the input focus 1903between attached front-ends. Specify @option{mux=on} to enable this mode. 1904 1905Options to each backend are described below. 1906 1907@item -chardev null ,id=@var{id} 1908A void device. This device will not emit any data, and will drop any data it 1909receives. The null backend does not take any options. 1910 1911@item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet] 1912 1913Create a two-way stream socket, which can be either a TCP or a unix socket. A 1914unix socket will be created if @option{path} is specified. Behaviour is 1915undefined if TCP options are specified for a unix socket. 1916 1917@option{server} specifies that the socket shall be a listening socket. 1918 1919@option{nowait} specifies that QEMU should not block waiting for a client to 1920connect to a listening socket. 1921 1922@option{telnet} specifies that traffic on the socket should interpret telnet 1923escape sequences. 1924 1925TCP and unix socket options are given below: 1926 1927@table @option 1928 1929@item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay] 1930 1931@option{host} for a listening socket specifies the local address to be bound. 1932For a connecting socket species the remote host to connect to. @option{host} is 1933optional for listening sockets. If not specified it defaults to @code{0.0.0.0}. 1934 1935@option{port} for a listening socket specifies the local port to be bound. For a 1936connecting socket specifies the port on the remote host to connect to. 1937@option{port} can be given as either a port number or a service name. 1938@option{port} is required. 1939 1940@option{to} is only relevant to listening sockets. If it is specified, and 1941@option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up 1942to and including @option{to} until it succeeds. @option{to} must be specified 1943as a port number. 1944 1945@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 1946If neither is specified the socket may use either protocol. 1947 1948@option{nodelay} disables the Nagle algorithm. 1949 1950@item unix options: path=@var{path} 1951 1952@option{path} specifies the local path of the unix socket. @option{path} is 1953required. 1954 1955@end table 1956 1957@item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6] 1958 1959Sends all traffic from the guest to a remote host over UDP. 1960 1961@option{host} specifies the remote host to connect to. If not specified it 1962defaults to @code{localhost}. 1963 1964@option{port} specifies the port on the remote host to connect to. @option{port} 1965is required. 1966 1967@option{localaddr} specifies the local address to bind to. If not specified it 1968defaults to @code{0.0.0.0}. 1969 1970@option{localport} specifies the local port to bind to. If not specified any 1971available local port will be used. 1972 1973@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 1974If neither is specified the device may use either protocol. 1975 1976@item -chardev msmouse ,id=@var{id} 1977 1978Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not 1979take any options. 1980 1981@item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]] 1982 1983Connect to a QEMU text console. @option{vc} may optionally be given a specific 1984size. 1985 1986@option{width} and @option{height} specify the width and height respectively of 1987the console, in pixels. 1988 1989@option{cols} and @option{rows} specify that the console be sized to fit a text 1990console with the given dimensions. 1991 1992@item -chardev ringbuf ,id=@var{id} [,size=@var{size}] 1993 1994Create a ring buffer with fixed size @option{size}. 1995@var{size} must be a power of two, and defaults to @code{64K}). 1996 1997@item -chardev file ,id=@var{id} ,path=@var{path} 1998 1999Log all traffic received from the guest to a file. 2000 2001@option{path} specifies the path of the file to be opened. This file will be 2002created if it does not already exist, and overwritten if it does. @option{path} 2003is required. 2004 2005@item -chardev pipe ,id=@var{id} ,path=@var{path} 2006 2007Create a two-way connection to the guest. The behaviour differs slightly between 2008Windows hosts and other hosts: 2009 2010On Windows, a single duplex pipe will be created at 2011@file{\\.pipe\@option{path}}. 2012 2013On other hosts, 2 pipes will be created called @file{@option{path}.in} and 2014@file{@option{path}.out}. Data written to @file{@option{path}.in} will be 2015received by the guest. Data written by the guest can be read from 2016@file{@option{path}.out}. QEMU will not create these fifos, and requires them to 2017be present. 2018 2019@option{path} forms part of the pipe path as described above. @option{path} is 2020required. 2021 2022@item -chardev console ,id=@var{id} 2023 2024Send traffic from the guest to QEMU's standard output. @option{console} does not 2025take any options. 2026 2027@option{console} is only available on Windows hosts. 2028 2029@item -chardev serial ,id=@var{id} ,path=@option{path} 2030 2031Send traffic from the guest to a serial device on the host. 2032 2033On Unix hosts serial will actually accept any tty device, 2034not only serial lines. 2035 2036@option{path} specifies the name of the serial device to open. 2037 2038@item -chardev pty ,id=@var{id} 2039 2040Create a new pseudo-terminal on the host and connect to it. @option{pty} does 2041not take any options. 2042 2043@option{pty} is not available on Windows hosts. 2044 2045@item -chardev stdio ,id=@var{id} [,signal=on|off] 2046Connect to standard input and standard output of the QEMU process. 2047 2048@option{signal} controls if signals are enabled on the terminal, that includes 2049exiting QEMU with the key sequence @key{Control-c}. This option is enabled by 2050default, use @option{signal=off} to disable it. 2051 2052@option{stdio} is not available on Windows hosts. 2053 2054@item -chardev braille ,id=@var{id} 2055 2056Connect to a local BrlAPI server. @option{braille} does not take any options. 2057 2058@item -chardev tty ,id=@var{id} ,path=@var{path} 2059 2060@option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and 2061DragonFlyBSD hosts. It is an alias for @option{serial}. 2062 2063@option{path} specifies the path to the tty. @option{path} is required. 2064 2065@item -chardev parallel ,id=@var{id} ,path=@var{path} 2066@item -chardev parport ,id=@var{id} ,path=@var{path} 2067 2068@option{parallel} is only available on Linux, FreeBSD and DragonFlyBSD hosts. 2069 2070Connect to a local parallel port. 2071 2072@option{path} specifies the path to the parallel port device. @option{path} is 2073required. 2074 2075@item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name} 2076 2077@option{spicevmc} is only available when spice support is built in. 2078 2079@option{debug} debug level for spicevmc 2080 2081@option{name} name of spice channel to connect to 2082 2083Connect to a spice virtual machine channel, such as vdiport. 2084 2085@item -chardev spiceport ,id=@var{id} ,debug=@var{debug}, name=@var{name} 2086 2087@option{spiceport} is only available when spice support is built in. 2088 2089@option{debug} debug level for spicevmc 2090 2091@option{name} name of spice port to connect to 2092 2093Connect to a spice port, allowing a Spice client to handle the traffic 2094identified by a name (preferably a fqdn). 2095ETEXI 2096 2097STEXI 2098@end table 2099ETEXI 2100DEFHEADING() 2101 2102DEFHEADING(Device URL Syntax:) 2103STEXI 2104 2105In addition to using normal file images for the emulated storage devices, 2106QEMU can also use networked resources such as iSCSI devices. These are 2107specified using a special URL syntax. 2108 2109@table @option 2110@item iSCSI 2111iSCSI support allows QEMU to access iSCSI resources directly and use as 2112images for the guest storage. Both disk and cdrom images are supported. 2113 2114Syntax for specifying iSCSI LUNs is 2115``iscsi://<target-ip>[:<port>]/<target-iqn>/<lun>'' 2116 2117By default qemu will use the iSCSI initiator-name 2118'iqn.2008-11.org.linux-kvm[:<name>]' but this can also be set from the command 2119line or a configuration file. 2120 2121 2122Example (without authentication): 2123@example 2124qemu-system-i386 -iscsi initiator-name=iqn.2001-04.com.example:my-initiator \ 2125 -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \ 2126 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 2127@end example 2128 2129Example (CHAP username/password via URL): 2130@example 2131qemu-system-i386 -drive file=iscsi://user%password@@192.0.2.1/iqn.2001-04.com.example/1 2132@end example 2133 2134Example (CHAP username/password via environment variables): 2135@example 2136LIBISCSI_CHAP_USERNAME="user" \ 2137LIBISCSI_CHAP_PASSWORD="password" \ 2138qemu-system-i386 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 2139@end example 2140 2141iSCSI support is an optional feature of QEMU and only available when 2142compiled and linked against libiscsi. 2143ETEXI 2144DEF("iscsi", HAS_ARG, QEMU_OPTION_iscsi, 2145 "-iscsi [user=user][,password=password]\n" 2146 " [,header-digest=CRC32C|CR32C-NONE|NONE-CRC32C|NONE\n" 2147 " [,initiator-name=initiator-iqn][,id=target-iqn]\n" 2148 " iSCSI session parameters\n", QEMU_ARCH_ALL) 2149STEXI 2150 2151iSCSI parameters such as username and password can also be specified via 2152a configuration file. See qemu-doc for more information and examples. 2153 2154@item NBD 2155QEMU supports NBD (Network Block Devices) both using TCP protocol as well 2156as Unix Domain Sockets. 2157 2158Syntax for specifying a NBD device using TCP 2159``nbd:<server-ip>:<port>[:exportname=<export>]'' 2160 2161Syntax for specifying a NBD device using Unix Domain Sockets 2162``nbd:unix:<domain-socket>[:exportname=<export>]'' 2163 2164 2165Example for TCP 2166@example 2167qemu-system-i386 --drive file=nbd:192.0.2.1:30000 2168@end example 2169 2170Example for Unix Domain Sockets 2171@example 2172qemu-system-i386 --drive file=nbd:unix:/tmp/nbd-socket 2173@end example 2174 2175@item SSH 2176QEMU supports SSH (Secure Shell) access to remote disks. 2177 2178Examples: 2179@example 2180qemu-system-i386 -drive file=ssh://user@@host/path/to/disk.img 2181qemu-system-i386 -drive file.driver=ssh,file.user=user,file.host=host,file.port=22,file.path=/path/to/disk.img 2182@end example 2183 2184Currently authentication must be done using ssh-agent. Other 2185authentication methods may be supported in future. 2186 2187@item Sheepdog 2188Sheepdog is a distributed storage system for QEMU. 2189QEMU supports using either local sheepdog devices or remote networked 2190devices. 2191 2192Syntax for specifying a sheepdog device 2193@example 2194sheepdog[+tcp|+unix]://[host:port]/vdiname[?socket=path][#snapid|#tag] 2195@end example 2196 2197Example 2198@example 2199qemu-system-i386 --drive file=sheepdog://192.0.2.1:30000/MyVirtualMachine 2200@end example 2201 2202See also @url{http://http://www.osrg.net/sheepdog/}. 2203 2204@item GlusterFS 2205GlusterFS is an user space distributed file system. 2206QEMU supports the use of GlusterFS volumes for hosting VM disk images using 2207TCP, Unix Domain Sockets and RDMA transport protocols. 2208 2209Syntax for specifying a VM disk image on GlusterFS volume is 2210@example 2211gluster[+transport]://[server[:port]]/volname/image[?socket=...] 2212@end example 2213 2214 2215Example 2216@example 2217qemu-system-x86_64 --drive file=gluster://192.0.2.1/testvol/a.img 2218@end example 2219 2220See also @url{http://www.gluster.org}. 2221 2222@item HTTP/HTTPS/FTP/FTPS/TFTP 2223QEMU supports read-only access to files accessed over http(s), ftp(s) and tftp. 2224 2225Syntax using a single filename: 2226@example 2227<protocol>://[<username>[:<password>]@@]<host>/<path> 2228@end example 2229 2230where: 2231@table @option 2232@item protocol 2233'http', 'https', 'ftp', 'ftps', or 'tftp'. 2234 2235@item username 2236Optional username for authentication to the remote server. 2237 2238@item password 2239Optional password for authentication to the remote server. 2240 2241@item host 2242Address of the remote server. 2243 2244@item path 2245Path on the remote server, including any query string. 2246@end table 2247 2248The following options are also supported: 2249@table @option 2250@item url 2251The full URL when passing options to the driver explicitly. 2252 2253@item readahead 2254The amount of data to read ahead with each range request to the remote server. 2255This value may optionally have the suffix 'T', 'G', 'M', 'K', 'k' or 'b'. If it 2256does not have a suffix, it will be assumed to be in bytes. The value must be a 2257multiple of 512 bytes. It defaults to 256k. 2258 2259@item sslverify 2260Whether to verify the remote server's certificate when connecting over SSL. It 2261can have the value 'on' or 'off'. It defaults to 'on'. 2262@end table 2263 2264Note that when passing options to qemu explicitly, @option{driver} is the value 2265of <protocol>. 2266 2267Example: boot from a remote Fedora 20 live ISO image 2268@example 2269qemu-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 2270 2271qemu-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 2272@end example 2273 2274Example: boot from a remote Fedora 20 cloud image using a local overlay for 2275writes, copy-on-read, and a readahead of 64k 2276@example 2277qemu-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 2278 2279qemu-system-x86_64 -drive file=/tmp/Fedora-x86_64-20-20131211.1-sda.qcow2,copy-on-read=on 2280@end example 2281 2282Example: boot from an image stored on a VMware vSphere server with a self-signed 2283certificate using a local overlay for writes and a readahead of 64k 2284@example 2285qemu-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 2286 2287qemu-system-x86_64 -drive file=/tmp/test.qcow2 2288@end example 2289ETEXI 2290 2291STEXI 2292@end table 2293ETEXI 2294 2295DEFHEADING(Bluetooth(R) options:) 2296STEXI 2297@table @option 2298ETEXI 2299 2300DEF("bt", HAS_ARG, QEMU_OPTION_bt, \ 2301 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \ 2302 "-bt hci,host[:id]\n" \ 2303 " use host's HCI with the given name\n" \ 2304 "-bt hci[,vlan=n]\n" \ 2305 " emulate a standard HCI in virtual scatternet 'n'\n" \ 2306 "-bt vhci[,vlan=n]\n" \ 2307 " add host computer to virtual scatternet 'n' using VHCI\n" \ 2308 "-bt device:dev[,vlan=n]\n" \ 2309 " emulate a bluetooth device 'dev' in scatternet 'n'\n", 2310 QEMU_ARCH_ALL) 2311STEXI 2312@item -bt hci[...] 2313@findex -bt 2314Defines the function of the corresponding Bluetooth HCI. -bt options 2315are matched with the HCIs present in the chosen machine type. For 2316example when emulating a machine with only one HCI built into it, only 2317the first @code{-bt hci[...]} option is valid and defines the HCI's 2318logic. The Transport Layer is decided by the machine type. Currently 2319the machines @code{n800} and @code{n810} have one HCI and all other 2320machines have none. 2321 2322@anchor{bt-hcis} 2323The following three types are recognized: 2324 2325@table @option 2326@item -bt hci,null 2327(default) The corresponding Bluetooth HCI assumes no internal logic 2328and will not respond to any HCI commands or emit events. 2329 2330@item -bt hci,host[:@var{id}] 2331(@code{bluez} only) The corresponding HCI passes commands / events 2332to / from the physical HCI identified by the name @var{id} (default: 2333@code{hci0}) on the computer running QEMU. Only available on @code{bluez} 2334capable systems like Linux. 2335 2336@item -bt hci[,vlan=@var{n}] 2337Add a virtual, standard HCI that will participate in the Bluetooth 2338scatternet @var{n} (default @code{0}). Similarly to @option{-net} 2339VLANs, devices inside a bluetooth network @var{n} can only communicate 2340with other devices in the same network (scatternet). 2341@end table 2342 2343@item -bt vhci[,vlan=@var{n}] 2344(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached 2345to the host bluetooth stack instead of to the emulated target. This 2346allows the host and target machines to participate in a common scatternet 2347and communicate. Requires the Linux @code{vhci} driver installed. Can 2348be used as following: 2349 2350@example 2351qemu-system-i386 [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5 2352@end example 2353 2354@item -bt device:@var{dev}[,vlan=@var{n}] 2355Emulate a bluetooth device @var{dev} and place it in network @var{n} 2356(default @code{0}). QEMU can only emulate one type of bluetooth devices 2357currently: 2358 2359@table @option 2360@item keyboard 2361Virtual wireless keyboard implementing the HIDP bluetooth profile. 2362@end table 2363ETEXI 2364 2365STEXI 2366@end table 2367ETEXI 2368DEFHEADING() 2369 2370#ifdef CONFIG_TPM 2371DEFHEADING(TPM device options:) 2372 2373DEF("tpmdev", HAS_ARG, QEMU_OPTION_tpmdev, \ 2374 "-tpmdev passthrough,id=id[,path=path][,cancel-path=path]\n" 2375 " use path to provide path to a character device; default is /dev/tpm0\n" 2376 " use cancel-path to provide path to TPM's cancel sysfs entry; if\n" 2377 " not provided it will be searched for in /sys/class/misc/tpm?/device\n", 2378 QEMU_ARCH_ALL) 2379STEXI 2380 2381The general form of a TPM device option is: 2382@table @option 2383 2384@item -tpmdev @var{backend} ,id=@var{id} [,@var{options}] 2385@findex -tpmdev 2386Backend type must be: 2387@option{passthrough}. 2388 2389The specific backend type will determine the applicable options. 2390The @code{-tpmdev} option creates the TPM backend and requires a 2391@code{-device} option that specifies the TPM frontend interface model. 2392 2393Options to each backend are described below. 2394 2395Use 'help' to print all available TPM backend types. 2396@example 2397qemu -tpmdev help 2398@end example 2399 2400@item -tpmdev passthrough, id=@var{id}, path=@var{path}, cancel-path=@var{cancel-path} 2401 2402(Linux-host only) Enable access to the host's TPM using the passthrough 2403driver. 2404 2405@option{path} specifies the path to the host's TPM device, i.e., on 2406a Linux host this would be @code{/dev/tpm0}. 2407@option{path} is optional and by default @code{/dev/tpm0} is used. 2408 2409@option{cancel-path} specifies the path to the host TPM device's sysfs 2410entry allowing for cancellation of an ongoing TPM command. 2411@option{cancel-path} is optional and by default QEMU will search for the 2412sysfs entry to use. 2413 2414Some notes about using the host's TPM with the passthrough driver: 2415 2416The TPM device accessed by the passthrough driver must not be 2417used by any other application on the host. 2418 2419Since the host's firmware (BIOS/UEFI) has already initialized the TPM, 2420the VM's firmware (BIOS/UEFI) will not be able to initialize the 2421TPM again and may therefore not show a TPM-specific menu that would 2422otherwise allow the user to configure the TPM, e.g., allow the user to 2423enable/disable or activate/deactivate the TPM. 2424Further, if TPM ownership is released from within a VM then the host's TPM 2425will get disabled and deactivated. To enable and activate the 2426TPM again afterwards, the host has to be rebooted and the user is 2427required to enter the firmware's menu to enable and activate the TPM. 2428If the TPM is left disabled and/or deactivated most TPM commands will fail. 2429 2430To create a passthrough TPM use the following two options: 2431@example 2432-tpmdev passthrough,id=tpm0 -device tpm-tis,tpmdev=tpm0 2433@end example 2434Note that the @code{-tpmdev} id is @code{tpm0} and is referenced by 2435@code{tpmdev=tpm0} in the device option. 2436 2437@end table 2438 2439ETEXI 2440 2441DEFHEADING() 2442 2443#endif 2444 2445DEFHEADING(Linux/Multiboot boot specific:) 2446STEXI 2447 2448When using these options, you can use a given Linux or Multiboot 2449kernel without installing it in the disk image. It can be useful 2450for easier testing of various kernels. 2451 2452@table @option 2453ETEXI 2454 2455DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \ 2456 "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL) 2457STEXI 2458@item -kernel @var{bzImage} 2459@findex -kernel 2460Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel 2461or in multiboot format. 2462ETEXI 2463 2464DEF("append", HAS_ARG, QEMU_OPTION_append, \ 2465 "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL) 2466STEXI 2467@item -append @var{cmdline} 2468@findex -append 2469Use @var{cmdline} as kernel command line 2470ETEXI 2471 2472DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \ 2473 "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL) 2474STEXI 2475@item -initrd @var{file} 2476@findex -initrd 2477Use @var{file} as initial ram disk. 2478 2479@item -initrd "@var{file1} arg=foo,@var{file2}" 2480 2481This syntax is only available with multiboot. 2482 2483Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the 2484first module. 2485ETEXI 2486 2487DEF("dtb", HAS_ARG, QEMU_OPTION_dtb, \ 2488 "-dtb file use 'file' as device tree image\n", QEMU_ARCH_ALL) 2489STEXI 2490@item -dtb @var{file} 2491@findex -dtb 2492Use @var{file} as a device tree binary (dtb) image and pass it to the kernel 2493on boot. 2494ETEXI 2495 2496STEXI 2497@end table 2498ETEXI 2499DEFHEADING() 2500 2501DEFHEADING(Debug/Expert options:) 2502STEXI 2503@table @option 2504ETEXI 2505 2506DEF("serial", HAS_ARG, QEMU_OPTION_serial, \ 2507 "-serial dev redirect the serial port to char device 'dev'\n", 2508 QEMU_ARCH_ALL) 2509STEXI 2510@item -serial @var{dev} 2511@findex -serial 2512Redirect the virtual serial port to host character device 2513@var{dev}. The default device is @code{vc} in graphical mode and 2514@code{stdio} in non graphical mode. 2515 2516This option can be used several times to simulate up to 4 serial 2517ports. 2518 2519Use @code{-serial none} to disable all serial ports. 2520 2521Available character devices are: 2522@table @option 2523@item vc[:@var{W}x@var{H}] 2524Virtual console. Optionally, a width and height can be given in pixel with 2525@example 2526vc:800x600 2527@end example 2528It is also possible to specify width or height in characters: 2529@example 2530vc:80Cx24C 2531@end example 2532@item pty 2533[Linux only] Pseudo TTY (a new PTY is automatically allocated) 2534@item none 2535No device is allocated. 2536@item null 2537void device 2538@item chardev:@var{id} 2539Use a named character device defined with the @code{-chardev} option. 2540@item /dev/XXX 2541[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port 2542parameters are set according to the emulated ones. 2543@item /dev/parport@var{N} 2544[Linux only, parallel port only] Use host parallel port 2545@var{N}. Currently SPP and EPP parallel port features can be used. 2546@item file:@var{filename} 2547Write output to @var{filename}. No character can be read. 2548@item stdio 2549[Unix only] standard input/output 2550@item pipe:@var{filename} 2551name pipe @var{filename} 2552@item COM@var{n} 2553[Windows only] Use host serial port @var{n} 2554@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}] 2555This implements UDP Net Console. 2556When @var{remote_host} or @var{src_ip} are not specified 2557they default to @code{0.0.0.0}. 2558When not using a specified @var{src_port} a random port is automatically chosen. 2559 2560If you just want a simple readonly console you can use @code{netcat} or 2561@code{nc}, by starting QEMU with: @code{-serial udp::4555} and nc as: 2562@code{nc -u -l -p 4555}. Any time QEMU writes something to that port it 2563will appear in the netconsole session. 2564 2565If you plan to send characters back via netconsole or you want to stop 2566and start QEMU a lot of times, you should have QEMU use the same 2567source port each time by using something like @code{-serial 2568udp::4555@@:4556} to QEMU. Another approach is to use a patched 2569version of netcat which can listen to a TCP port and send and receive 2570characters via udp. If you have a patched version of netcat which 2571activates telnet remote echo and single char transfer, then you can 2572use the following options to step up a netcat redirector to allow 2573telnet on port 5555 to access the QEMU port. 2574@table @code 2575@item QEMU Options: 2576-serial udp::4555@@:4556 2577@item netcat options: 2578-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T 2579@item telnet options: 2580localhost 5555 2581@end table 2582 2583@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay] 2584The TCP Net Console has two modes of operation. It can send the serial 2585I/O to a location or wait for a connection from a location. By default 2586the TCP Net Console is sent to @var{host} at the @var{port}. If you use 2587the @var{server} option QEMU will wait for a client socket application 2588to connect to the port before continuing, unless the @code{nowait} 2589option was specified. The @code{nodelay} option disables the Nagle buffering 2590algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only 2591one TCP connection at a time is accepted. You can use @code{telnet} to 2592connect to the corresponding character device. 2593@table @code 2594@item Example to send tcp console to 192.168.0.2 port 4444 2595-serial tcp:192.168.0.2:4444 2596@item Example to listen and wait on port 4444 for connection 2597-serial tcp::4444,server 2598@item Example to not wait and listen on ip 192.168.0.100 port 4444 2599-serial tcp:192.168.0.100:4444,server,nowait 2600@end table 2601 2602@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay] 2603The telnet protocol is used instead of raw tcp sockets. The options 2604work the same as if you had specified @code{-serial tcp}. The 2605difference is that the port acts like a telnet server or client using 2606telnet option negotiation. This will also allow you to send the 2607MAGIC_SYSRQ sequence if you use a telnet that supports sending the break 2608sequence. Typically in unix telnet you do it with Control-] and then 2609type "send break" followed by pressing the enter key. 2610 2611@item unix:@var{path}[,server][,nowait] 2612A unix domain socket is used instead of a tcp socket. The option works the 2613same as if you had specified @code{-serial tcp} except the unix domain socket 2614@var{path} is used for connections. 2615 2616@item mon:@var{dev_string} 2617This is a special option to allow the monitor to be multiplexed onto 2618another serial port. The monitor is accessed with key sequence of 2619@key{Control-a} and then pressing @key{c}. 2620@var{dev_string} should be any one of the serial devices specified 2621above. An example to multiplex the monitor onto a telnet server 2622listening on port 4444 would be: 2623@table @code 2624@item -serial mon:telnet::4444,server,nowait 2625@end table 2626When the monitor is multiplexed to stdio in this way, Ctrl+C will not terminate 2627QEMU any more but will be passed to the guest instead. 2628 2629@item braille 2630Braille device. This will use BrlAPI to display the braille output on a real 2631or fake device. 2632 2633@item msmouse 2634Three button serial mouse. Configure the guest to use Microsoft protocol. 2635@end table 2636ETEXI 2637 2638DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \ 2639 "-parallel dev redirect the parallel port to char device 'dev'\n", 2640 QEMU_ARCH_ALL) 2641STEXI 2642@item -parallel @var{dev} 2643@findex -parallel 2644Redirect the virtual parallel port to host device @var{dev} (same 2645devices as the serial port). On Linux hosts, @file{/dev/parportN} can 2646be used to use hardware devices connected on the corresponding host 2647parallel port. 2648 2649This option can be used several times to simulate up to 3 parallel 2650ports. 2651 2652Use @code{-parallel none} to disable all parallel ports. 2653ETEXI 2654 2655DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \ 2656 "-monitor dev redirect the monitor to char device 'dev'\n", 2657 QEMU_ARCH_ALL) 2658STEXI 2659@item -monitor @var{dev} 2660@findex -monitor 2661Redirect the monitor to host device @var{dev} (same devices as the 2662serial port). 2663The default device is @code{vc} in graphical mode and @code{stdio} in 2664non graphical mode. 2665Use @code{-monitor none} to disable the default monitor. 2666ETEXI 2667DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \ 2668 "-qmp dev like -monitor but opens in 'control' mode\n", 2669 QEMU_ARCH_ALL) 2670STEXI 2671@item -qmp @var{dev} 2672@findex -qmp 2673Like -monitor but opens in 'control' mode. 2674ETEXI 2675 2676DEF("mon", HAS_ARG, QEMU_OPTION_mon, \ 2677 "-mon [chardev=]name[,mode=readline|control][,default]\n", QEMU_ARCH_ALL) 2678STEXI 2679@item -mon [chardev=]name[,mode=readline|control][,default] 2680@findex -mon 2681Setup monitor on chardev @var{name}. 2682ETEXI 2683 2684DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \ 2685 "-debugcon dev redirect the debug console to char device 'dev'\n", 2686 QEMU_ARCH_ALL) 2687STEXI 2688@item -debugcon @var{dev} 2689@findex -debugcon 2690Redirect the debug console to host device @var{dev} (same devices as the 2691serial port). The debug console is an I/O port which is typically port 26920xe9; writing to that I/O port sends output to this device. 2693The default device is @code{vc} in graphical mode and @code{stdio} in 2694non graphical mode. 2695ETEXI 2696 2697DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \ 2698 "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL) 2699STEXI 2700@item -pidfile @var{file} 2701@findex -pidfile 2702Store the QEMU process PID in @var{file}. It is useful if you launch QEMU 2703from a script. 2704ETEXI 2705 2706DEF("singlestep", 0, QEMU_OPTION_singlestep, \ 2707 "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL) 2708STEXI 2709@item -singlestep 2710@findex -singlestep 2711Run the emulation in single step mode. 2712ETEXI 2713 2714DEF("S", 0, QEMU_OPTION_S, \ 2715 "-S freeze CPU at startup (use 'c' to start execution)\n", 2716 QEMU_ARCH_ALL) 2717STEXI 2718@item -S 2719@findex -S 2720Do not start CPU at startup (you must type 'c' in the monitor). 2721ETEXI 2722 2723DEF("realtime", HAS_ARG, QEMU_OPTION_realtime, 2724 "-realtime [mlock=on|off]\n" 2725 " run qemu with realtime features\n" 2726 " mlock=on|off controls mlock support (default: on)\n", 2727 QEMU_ARCH_ALL) 2728STEXI 2729@item -realtime mlock=on|off 2730@findex -realtime 2731Run qemu with realtime features. 2732mlocking qemu and guest memory can be enabled via @option{mlock=on} 2733(enabled by default). 2734ETEXI 2735 2736DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \ 2737 "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL) 2738STEXI 2739@item -gdb @var{dev} 2740@findex -gdb 2741Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical 2742connections will likely be TCP-based, but also UDP, pseudo TTY, or even 2743stdio are reasonable use case. The latter is allowing to start QEMU from 2744within gdb and establish the connection via a pipe: 2745@example 2746(gdb) target remote | exec qemu-system-i386 -gdb stdio ... 2747@end example 2748ETEXI 2749 2750DEF("s", 0, QEMU_OPTION_s, \ 2751 "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n", 2752 QEMU_ARCH_ALL) 2753STEXI 2754@item -s 2755@findex -s 2756Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234 2757(@pxref{gdb_usage}). 2758ETEXI 2759 2760DEF("d", HAS_ARG, QEMU_OPTION_d, \ 2761 "-d item1,... enable logging of specified items (use '-d help' for a list of log items)\n", 2762 QEMU_ARCH_ALL) 2763STEXI 2764@item -d @var{item1}[,...] 2765@findex -d 2766Enable logging of specified items. Use '-d help' for a list of log items. 2767ETEXI 2768 2769DEF("D", HAS_ARG, QEMU_OPTION_D, \ 2770 "-D logfile output log to logfile (default stderr)\n", 2771 QEMU_ARCH_ALL) 2772STEXI 2773@item -D @var{logfile} 2774@findex -D 2775Output log in @var{logfile} instead of to stderr 2776ETEXI 2777 2778DEF("L", HAS_ARG, QEMU_OPTION_L, \ 2779 "-L path set the directory for the BIOS, VGA BIOS and keymaps\n", 2780 QEMU_ARCH_ALL) 2781STEXI 2782@item -L @var{path} 2783@findex -L 2784Set the directory for the BIOS, VGA BIOS and keymaps. 2785ETEXI 2786 2787DEF("bios", HAS_ARG, QEMU_OPTION_bios, \ 2788 "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL) 2789STEXI 2790@item -bios @var{file} 2791@findex -bios 2792Set the filename for the BIOS. 2793ETEXI 2794 2795DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \ 2796 "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL) 2797STEXI 2798@item -enable-kvm 2799@findex -enable-kvm 2800Enable KVM full virtualization support. This option is only available 2801if KVM support is enabled when compiling. 2802ETEXI 2803 2804DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid, 2805 "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL) 2806DEF("xen-create", 0, QEMU_OPTION_xen_create, 2807 "-xen-create create domain using xen hypercalls, bypassing xend\n" 2808 " warning: should not be used when xend is in use\n", 2809 QEMU_ARCH_ALL) 2810DEF("xen-attach", 0, QEMU_OPTION_xen_attach, 2811 "-xen-attach attach to existing xen domain\n" 2812 " xend will use this when starting QEMU\n", 2813 QEMU_ARCH_ALL) 2814STEXI 2815@item -xen-domid @var{id} 2816@findex -xen-domid 2817Specify xen guest domain @var{id} (XEN only). 2818@item -xen-create 2819@findex -xen-create 2820Create domain using xen hypercalls, bypassing xend. 2821Warning: should not be used when xend is in use (XEN only). 2822@item -xen-attach 2823@findex -xen-attach 2824Attach to existing xen domain. 2825xend will use this when starting QEMU (XEN only). 2826ETEXI 2827 2828DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \ 2829 "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL) 2830STEXI 2831@item -no-reboot 2832@findex -no-reboot 2833Exit instead of rebooting. 2834ETEXI 2835 2836DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \ 2837 "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL) 2838STEXI 2839@item -no-shutdown 2840@findex -no-shutdown 2841Don't exit QEMU on guest shutdown, but instead only stop the emulation. 2842This allows for instance switching to monitor to commit changes to the 2843disk image. 2844ETEXI 2845 2846DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \ 2847 "-loadvm [tag|id]\n" \ 2848 " start right away with a saved state (loadvm in monitor)\n", 2849 QEMU_ARCH_ALL) 2850STEXI 2851@item -loadvm @var{file} 2852@findex -loadvm 2853Start right away with a saved state (@code{loadvm} in monitor) 2854ETEXI 2855 2856#ifndef _WIN32 2857DEF("daemonize", 0, QEMU_OPTION_daemonize, \ 2858 "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL) 2859#endif 2860STEXI 2861@item -daemonize 2862@findex -daemonize 2863Daemonize the QEMU process after initialization. QEMU will not detach from 2864standard IO until it is ready to receive connections on any of its devices. 2865This option is a useful way for external programs to launch QEMU without having 2866to cope with initialization race conditions. 2867ETEXI 2868 2869DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \ 2870 "-option-rom rom load a file, rom, into the option ROM space\n", 2871 QEMU_ARCH_ALL) 2872STEXI 2873@item -option-rom @var{file} 2874@findex -option-rom 2875Load the contents of @var{file} as an option ROM. 2876This option is useful to load things like EtherBoot. 2877ETEXI 2878 2879DEF("clock", HAS_ARG, QEMU_OPTION_clock, \ 2880 "-clock force the use of the given methods for timer alarm.\n" \ 2881 " To see what timers are available use '-clock help'\n", 2882 QEMU_ARCH_ALL) 2883STEXI 2884@item -clock @var{method} 2885@findex -clock 2886Force the use of the given methods for timer alarm. To see what timers 2887are available use @code{-clock help}. 2888ETEXI 2889 2890HXCOMM Options deprecated by -rtc 2891DEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL) 2892DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL) 2893 2894DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \ 2895 "-rtc [base=utc|localtime|date][,clock=host|rt|vm][,driftfix=none|slew]\n" \ 2896 " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n", 2897 QEMU_ARCH_ALL) 2898 2899STEXI 2900 2901@item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew] 2902@findex -rtc 2903Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current 2904UTC or local time, respectively. @code{localtime} is required for correct date in 2905MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the 2906format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC. 2907 2908By default the RTC is driven by the host system time. This allows using of the 2909RTC as accurate reference clock inside the guest, specifically if the host 2910time is smoothly following an accurate external reference clock, e.g. via NTP. 2911If you want to isolate the guest time from the host, you can set @option{clock} 2912to @code{rt} instead. To even prevent it from progressing during suspension, 2913you can set it to @code{vm}. 2914 2915Enable @option{driftfix} (i386 targets only) if you experience time drift problems, 2916specifically with Windows' ACPI HAL. This option will try to figure out how 2917many timer interrupts were not processed by the Windows guest and will 2918re-inject them. 2919ETEXI 2920 2921DEF("icount", HAS_ARG, QEMU_OPTION_icount, \ 2922 "-icount [N|auto]\n" \ 2923 " enable virtual instruction counter with 2^N clock ticks per\n" \ 2924 " instruction\n", QEMU_ARCH_ALL) 2925STEXI 2926@item -icount [@var{N}|auto] 2927@findex -icount 2928Enable virtual instruction counter. The virtual cpu will execute one 2929instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified 2930then the virtual cpu speed will be automatically adjusted to keep virtual 2931time within a few seconds of real time. 2932 2933Note that while this option can give deterministic behavior, it does not 2934provide cycle accurate emulation. Modern CPUs contain superscalar out of 2935order cores with complex cache hierarchies. The number of instructions 2936executed often has little or no correlation with actual performance. 2937ETEXI 2938 2939DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \ 2940 "-watchdog i6300esb|ib700\n" \ 2941 " enable virtual hardware watchdog [default=none]\n", 2942 QEMU_ARCH_ALL) 2943STEXI 2944@item -watchdog @var{model} 2945@findex -watchdog 2946Create a virtual hardware watchdog device. Once enabled (by a guest 2947action), the watchdog must be periodically polled by an agent inside 2948the guest or else the guest will be restarted. 2949 2950The @var{model} is the model of hardware watchdog to emulate. Choices 2951for model are: @code{ib700} (iBASE 700) which is a very simple ISA 2952watchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O 2953controller hub) which is a much more featureful PCI-based dual-timer 2954watchdog. Choose a model for which your guest has drivers. 2955 2956Use @code{-watchdog help} to list available hardware models. Only one 2957watchdog can be enabled for a guest. 2958ETEXI 2959 2960DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \ 2961 "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \ 2962 " action when watchdog fires [default=reset]\n", 2963 QEMU_ARCH_ALL) 2964STEXI 2965@item -watchdog-action @var{action} 2966@findex -watchdog-action 2967 2968The @var{action} controls what QEMU will do when the watchdog timer 2969expires. 2970The default is 2971@code{reset} (forcefully reset the guest). 2972Other possible actions are: 2973@code{shutdown} (attempt to gracefully shutdown the guest), 2974@code{poweroff} (forcefully poweroff the guest), 2975@code{pause} (pause the guest), 2976@code{debug} (print a debug message and continue), or 2977@code{none} (do nothing). 2978 2979Note that the @code{shutdown} action requires that the guest responds 2980to ACPI signals, which it may not be able to do in the sort of 2981situations where the watchdog would have expired, and thus 2982@code{-watchdog-action shutdown} is not recommended for production use. 2983 2984Examples: 2985 2986@table @code 2987@item -watchdog i6300esb -watchdog-action pause 2988@item -watchdog ib700 2989@end table 2990ETEXI 2991 2992DEF("echr", HAS_ARG, QEMU_OPTION_echr, \ 2993 "-echr chr set terminal escape character instead of ctrl-a\n", 2994 QEMU_ARCH_ALL) 2995STEXI 2996 2997@item -echr @var{numeric_ascii_value} 2998@findex -echr 2999Change the escape character used for switching to the monitor when using 3000monitor and serial sharing. The default is @code{0x01} when using the 3001@code{-nographic} option. @code{0x01} is equal to pressing 3002@code{Control-a}. You can select a different character from the ascii 3003control keys where 1 through 26 map to Control-a through Control-z. For 3004instance you could use the either of the following to change the escape 3005character to Control-t. 3006@table @code 3007@item -echr 0x14 3008@item -echr 20 3009@end table 3010ETEXI 3011 3012DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \ 3013 "-virtioconsole c\n" \ 3014 " set virtio console\n", QEMU_ARCH_ALL) 3015STEXI 3016@item -virtioconsole @var{c} 3017@findex -virtioconsole 3018Set virtio console. 3019 3020This option is maintained for backward compatibility. 3021 3022Please use @code{-device virtconsole} for the new way of invocation. 3023ETEXI 3024 3025DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \ 3026 "-show-cursor show cursor\n", QEMU_ARCH_ALL) 3027STEXI 3028@item -show-cursor 3029@findex -show-cursor 3030Show cursor. 3031ETEXI 3032 3033DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \ 3034 "-tb-size n set TB size\n", QEMU_ARCH_ALL) 3035STEXI 3036@item -tb-size @var{n} 3037@findex -tb-size 3038Set TB size. 3039ETEXI 3040 3041DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ 3042 "-incoming p prepare for incoming migration, listen on port p\n", 3043 QEMU_ARCH_ALL) 3044STEXI 3045@item -incoming @var{port} 3046@findex -incoming 3047Prepare for incoming migration, listen on @var{port}. 3048ETEXI 3049 3050DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \ 3051 "-nodefaults don't create default devices\n", QEMU_ARCH_ALL) 3052STEXI 3053@item -nodefaults 3054@findex -nodefaults 3055Don't create default devices. Normally, QEMU sets the default devices like serial 3056port, parallel port, virtual console, monitor device, VGA adapter, floppy and 3057CD-ROM drive and others. The @code{-nodefaults} option will disable all those 3058default devices. 3059ETEXI 3060 3061#ifndef _WIN32 3062DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \ 3063 "-chroot dir chroot to dir just before starting the VM\n", 3064 QEMU_ARCH_ALL) 3065#endif 3066STEXI 3067@item -chroot @var{dir} 3068@findex -chroot 3069Immediately before starting guest execution, chroot to the specified 3070directory. Especially useful in combination with -runas. 3071ETEXI 3072 3073#ifndef _WIN32 3074DEF("runas", HAS_ARG, QEMU_OPTION_runas, \ 3075 "-runas user change to user id user just before starting the VM\n", 3076 QEMU_ARCH_ALL) 3077#endif 3078STEXI 3079@item -runas @var{user} 3080@findex -runas 3081Immediately before starting guest execution, drop root privileges, switching 3082to the specified user. 3083ETEXI 3084 3085DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env, 3086 "-prom-env variable=value\n" 3087 " set OpenBIOS nvram variables\n", 3088 QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 3089STEXI 3090@item -prom-env @var{variable}=@var{value} 3091@findex -prom-env 3092Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only). 3093ETEXI 3094DEF("semihosting", 0, QEMU_OPTION_semihosting, 3095 "-semihosting semihosting mode\n", 3096 QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32) 3097STEXI 3098@item -semihosting 3099@findex -semihosting 3100Semihosting mode (ARM, M68K, Xtensa only). 3101ETEXI 3102DEF("old-param", 0, QEMU_OPTION_old_param, 3103 "-old-param old param mode\n", QEMU_ARCH_ARM) 3104STEXI 3105@item -old-param 3106@findex -old-param (ARM) 3107Old param mode (ARM only). 3108ETEXI 3109 3110DEF("sandbox", HAS_ARG, QEMU_OPTION_sandbox, \ 3111 "-sandbox <arg> Enable seccomp mode 2 system call filter (default 'off').\n", 3112 QEMU_ARCH_ALL) 3113STEXI 3114@item -sandbox @var{arg} 3115@findex -sandbox 3116Enable Seccomp mode 2 system call filter. 'on' will enable syscall filtering and 'off' will 3117disable it. The default is 'off'. 3118ETEXI 3119 3120DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig, 3121 "-readconfig <file>\n", QEMU_ARCH_ALL) 3122STEXI 3123@item -readconfig @var{file} 3124@findex -readconfig 3125Read device configuration from @var{file}. This approach is useful when you want to spawn 3126QEMU process with many command line options but you don't want to exceed the command line 3127character limit. 3128ETEXI 3129DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig, 3130 "-writeconfig <file>\n" 3131 " read/write config file\n", QEMU_ARCH_ALL) 3132STEXI 3133@item -writeconfig @var{file} 3134@findex -writeconfig 3135Write device configuration to @var{file}. The @var{file} can be either filename to save 3136command line and device configuration into file or dash @code{-}) character to print the 3137output to stdout. This can be later used as input file for @code{-readconfig} option. 3138ETEXI 3139DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig, 3140 "-nodefconfig\n" 3141 " do not load default config files at startup\n", 3142 QEMU_ARCH_ALL) 3143STEXI 3144@item -nodefconfig 3145@findex -nodefconfig 3146Normally QEMU loads configuration files from @var{sysconfdir} and @var{datadir} at startup. 3147The @code{-nodefconfig} option will prevent QEMU from loading any of those config files. 3148ETEXI 3149DEF("no-user-config", 0, QEMU_OPTION_nouserconfig, 3150 "-no-user-config\n" 3151 " do not load user-provided config files at startup\n", 3152 QEMU_ARCH_ALL) 3153STEXI 3154@item -no-user-config 3155@findex -no-user-config 3156The @code{-no-user-config} option makes QEMU not load any of the user-provided 3157config files on @var{sysconfdir}, but won't make it skip the QEMU-provided config 3158files from @var{datadir}. 3159ETEXI 3160DEF("trace", HAS_ARG, QEMU_OPTION_trace, 3161 "-trace [events=<file>][,file=<file>]\n" 3162 " specify tracing options\n", 3163 QEMU_ARCH_ALL) 3164STEXI 3165HXCOMM This line is not accurate, as some sub-options are backend-specific but 3166HXCOMM HX does not support conditional compilation of text. 3167@item -trace [events=@var{file}][,file=@var{file}] 3168@findex -trace 3169 3170Specify tracing options. 3171 3172@table @option 3173@item events=@var{file} 3174Immediately enable events listed in @var{file}. 3175The file must contain one event name (as listed in the @var{trace-events} file) 3176per line. 3177This option is only available if QEMU has been compiled with 3178either @var{simple} or @var{stderr} tracing backend. 3179@item file=@var{file} 3180Log output traces to @var{file}. 3181 3182This option is only available if QEMU has been compiled with 3183the @var{simple} tracing backend. 3184@end table 3185ETEXI 3186 3187HXCOMM Internal use 3188DEF("qtest", HAS_ARG, QEMU_OPTION_qtest, "", QEMU_ARCH_ALL) 3189DEF("qtest-log", HAS_ARG, QEMU_OPTION_qtest_log, "", QEMU_ARCH_ALL) 3190 3191#ifdef __linux__ 3192DEF("enable-fips", 0, QEMU_OPTION_enablefips, 3193 "-enable-fips enable FIPS 140-2 compliance\n", 3194 QEMU_ARCH_ALL) 3195#endif 3196STEXI 3197@item -enable-fips 3198@findex -enable-fips 3199Enable FIPS 140-2 compliance mode. 3200ETEXI 3201 3202HXCOMM Deprecated by -machine accel=tcg property 3203DEF("no-kvm", 0, QEMU_OPTION_no_kvm, "", QEMU_ARCH_I386) 3204 3205HXCOMM Deprecated by kvm-pit driver properties 3206DEF("no-kvm-pit-reinjection", 0, QEMU_OPTION_no_kvm_pit_reinjection, 3207 "", QEMU_ARCH_I386) 3208 3209HXCOMM Deprecated (ignored) 3210DEF("no-kvm-pit", 0, QEMU_OPTION_no_kvm_pit, "", QEMU_ARCH_I386) 3211 3212HXCOMM Deprecated by -machine kernel_irqchip=on|off property 3213DEF("no-kvm-irqchip", 0, QEMU_OPTION_no_kvm_irqchip, "", QEMU_ARCH_I386) 3214 3215HXCOMM Deprecated (ignored) 3216DEF("tdf", 0, QEMU_OPTION_tdf,"", QEMU_ARCH_ALL) 3217 3218DEF("object", HAS_ARG, QEMU_OPTION_object, 3219 "-object TYPENAME[,PROP1=VALUE1,...]\n" 3220 " create an new object of type TYPENAME setting properties\n" 3221 " in the order they are specified. Note that the 'id'\n" 3222 " property must be set. These objects are placed in the\n" 3223 " '/objects' path.\n", 3224 QEMU_ARCH_ALL) 3225STEXI 3226@item -object @var{typename}[,@var{prop1}=@var{value1},...] 3227@findex -object 3228Create an new object of type @var{typename} setting properties 3229in the order they are specified. Note that the 'id' 3230property must be set. These objects are placed in the 3231'/objects' path. 3232ETEXI 3233 3234DEF("msg", HAS_ARG, QEMU_OPTION_msg, 3235 "-msg timestamp[=on|off]\n" 3236 " change the format of messages\n" 3237 " on|off controls leading timestamps (default:on)\n", 3238 QEMU_ARCH_ALL) 3239STEXI 3240@item -msg timestamp[=on|off] 3241@findex -msg 3242prepend a timestamp to each log message.(default:on) 3243ETEXI 3244 3245HXCOMM This is the last statement. Insert new options before this line! 3246STEXI 3247@end table 3248ETEXI 3249
