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