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