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