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, hax, hvf, whpx or tcg (default: tcg)\n" 35 " kernel_irqchip=on|off|split controls accelerated irqchip support (default=off)\n" 36 " vmport=on|off|auto controls emulation of vmport (default: auto)\n" 37 " kvm_shadow_mem=size of KVM shadow MMU in bytes\n" 38 " dump-guest-core=on|off include guest memory in a core dump (default=on)\n" 39 " mem-merge=on|off controls memory merge support (default: on)\n" 40 " igd-passthru=on|off controls IGD GFX passthrough support (default=off)\n" 41 " aes-key-wrap=on|off controls support for AES key wrapping (default=on)\n" 42 " dea-key-wrap=on|off controls support for DEA key wrapping (default=on)\n" 43 " suppress-vmdesc=on|off disables self-describing migration (default=off)\n" 44 " nvdimm=on|off controls NVDIMM support (default=off)\n" 45 " enforce-config-section=on|off enforce configuration section migration (default=off)\n" 46 " memory-encryption=@var{} memory encryption object to use (default=none)\n", 47 QEMU_ARCH_ALL) 48STEXI 49@item -machine [type=]@var{name}[,prop=@var{value}[,...]] 50@findex -machine 51Select the emulated machine by @var{name}. Use @code{-machine help} to list 52available machines. 53 54For architectures which aim to support live migration compatibility 55across releases, each release will introduce a new versioned machine 56type. For example, the 2.8.0 release introduced machine types 57``pc-i440fx-2.8'' and ``pc-q35-2.8'' for the x86_64/i686 architectures. 58 59To allow live migration of guests from QEMU version 2.8.0, to QEMU 60version 2.9.0, the 2.9.0 version must support the ``pc-i440fx-2.8'' 61and ``pc-q35-2.8'' machines too. To allow users live migrating VMs 62to skip multiple intermediate releases when upgrading, new releases 63of QEMU will support machine types from many previous versions. 64 65Supported machine properties are: 66@table @option 67@item accel=@var{accels1}[:@var{accels2}[:...]] 68This is used to enable an accelerator. Depending on the target architecture, 69kvm, xen, hax, hvf, whpx or tcg can be available. By default, tcg is used. If there is 70more than one accelerator specified, the next one is used if the previous one 71fails to initialize. 72@item kernel_irqchip=on|off 73Controls in-kernel irqchip support for the chosen accelerator when available. 74@item gfx_passthru=on|off 75Enables IGD GFX passthrough support for the chosen machine when available. 76@item vmport=on|off|auto 77Enables emulation of VMWare IO port, for vmmouse etc. auto says to select the 78value based on accel. For accel=xen the default is off otherwise the default 79is on. 80@item kvm_shadow_mem=size 81Defines the size of the KVM shadow MMU. 82@item dump-guest-core=on|off 83Include guest memory in a core dump. The default is on. 84@item mem-merge=on|off 85Enables or disables memory merge support. This feature, when supported by 86the host, de-duplicates identical memory pages among VMs instances 87(enabled by default). 88@item aes-key-wrap=on|off 89Enables or disables AES key wrapping support on s390-ccw hosts. This feature 90controls whether AES wrapping keys will be created to allow 91execution of AES cryptographic functions. The default is on. 92@item dea-key-wrap=on|off 93Enables or disables DEA key wrapping support on s390-ccw hosts. This feature 94controls whether DEA wrapping keys will be created to allow 95execution of DEA cryptographic functions. The default is on. 96@item nvdimm=on|off 97Enables or disables NVDIMM support. The default is off. 98@item enforce-config-section=on|off 99If @option{enforce-config-section} is set to @var{on}, force migration 100code to send configuration section even if the machine-type sets the 101@option{migration.send-configuration} property to @var{off}. 102NOTE: this parameter is deprecated. Please use @option{-global} 103@option{migration.send-configuration}=@var{on|off} instead. 104@item memory-encryption=@var{} 105Memory encryption object to use. The default is none. 106@end table 107ETEXI 108 109HXCOMM Deprecated by -machine 110DEF("M", HAS_ARG, QEMU_OPTION_M, "", QEMU_ARCH_ALL) 111 112DEF("cpu", HAS_ARG, QEMU_OPTION_cpu, 113 "-cpu cpu select CPU ('-cpu help' for list)\n", QEMU_ARCH_ALL) 114STEXI 115@item -cpu @var{model} 116@findex -cpu 117Select CPU model (@code{-cpu help} for list and additional feature selection) 118ETEXI 119 120DEF("accel", HAS_ARG, QEMU_OPTION_accel, 121 "-accel [accel=]accelerator[,thread=single|multi]\n" 122 " select accelerator (kvm, xen, hax, hvf, whpx or tcg; use 'help' for a list)\n" 123 " thread=single|multi (enable multi-threaded TCG)\n", QEMU_ARCH_ALL) 124STEXI 125@item -accel @var{name}[,prop=@var{value}[,...]] 126@findex -accel 127This is used to enable an accelerator. Depending on the target architecture, 128kvm, xen, hax, hvf, whpx or tcg can be available. By default, tcg is used. If there is 129more than one accelerator specified, the next one is used if the previous one 130fails to initialize. 131@table @option 132@item thread=single|multi 133Controls number of TCG threads. When the TCG is multi-threaded there will be one 134thread per vCPU therefor taking advantage of additional host cores. The default 135is to enable multi-threading where both the back-end and front-ends support it and 136no incompatible TCG features have been enabled (e.g. icount/replay). 137@end table 138ETEXI 139 140DEF("smp", HAS_ARG, QEMU_OPTION_smp, 141 "-smp [cpus=]n[,maxcpus=cpus][,cores=cores][,threads=threads][,dies=dies][,sockets=sockets]\n" 142 " set the number of CPUs to 'n' [default=1]\n" 143 " maxcpus= maximum number of total cpus, including\n" 144 " offline CPUs for hotplug, etc\n" 145 " cores= number of CPU cores on one socket (for PC, it's on one die)\n" 146 " threads= number of threads on one CPU core\n" 147 " dies= number of CPU dies on one socket (for PC only)\n" 148 " sockets= number of discrete sockets in the system\n", 149 QEMU_ARCH_ALL) 150STEXI 151@item -smp [cpus=]@var{n}[,cores=@var{cores}][,threads=@var{threads}][,dies=dies][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}] 152@findex -smp 153Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255 154CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs 155to 4. 156For the PC target, the number of @var{cores} per die, the number of @var{threads} 157per cores, the number of @var{dies} per packages and the total number of 158@var{sockets} can be specified. Missing values will be computed. 159If any on the three values is given, the total number of CPUs @var{n} can be omitted. 160@var{maxcpus} specifies the maximum number of hotpluggable CPUs. 161ETEXI 162 163DEF("numa", HAS_ARG, QEMU_OPTION_numa, 164 "-numa node[,mem=size][,cpus=firstcpu[-lastcpu]][,nodeid=node]\n" 165 "-numa node[,memdev=id][,cpus=firstcpu[-lastcpu]][,nodeid=node]\n" 166 "-numa dist,src=source,dst=destination,val=distance\n" 167 "-numa cpu,node-id=node[,socket-id=x][,core-id=y][,thread-id=z]\n", 168 QEMU_ARCH_ALL) 169STEXI 170@item -numa node[,mem=@var{size}][,cpus=@var{firstcpu}[-@var{lastcpu}]][,nodeid=@var{node}] 171@itemx -numa node[,memdev=@var{id}][,cpus=@var{firstcpu}[-@var{lastcpu}]][,nodeid=@var{node}] 172@itemx -numa dist,src=@var{source},dst=@var{destination},val=@var{distance} 173@itemx -numa cpu,node-id=@var{node}[,socket-id=@var{x}][,core-id=@var{y}][,thread-id=@var{z}] 174@findex -numa 175Define a NUMA node and assign RAM and VCPUs to it. 176Set the NUMA distance from a source node to a destination node. 177 178Legacy VCPU assignment uses @samp{cpus} option where 179@var{firstcpu} and @var{lastcpu} are CPU indexes. Each 180@samp{cpus} option represent a contiguous range of CPU indexes 181(or a single VCPU if @var{lastcpu} is omitted). A non-contiguous 182set of VCPUs can be represented by providing multiple @samp{cpus} 183options. If @samp{cpus} is omitted on all nodes, VCPUs are automatically 184split between them. 185 186For example, the following option assigns VCPUs 0, 1, 2 and 5 to 187a NUMA node: 188@example 189-numa node,cpus=0-2,cpus=5 190@end example 191 192@samp{cpu} option is a new alternative to @samp{cpus} option 193which uses @samp{socket-id|core-id|thread-id} properties to assign 194CPU objects to a @var{node} using topology layout properties of CPU. 195The set of properties is machine specific, and depends on used 196machine type/@samp{smp} options. It could be queried with 197@samp{hotpluggable-cpus} monitor command. 198@samp{node-id} property specifies @var{node} to which CPU object 199will be assigned, it's required for @var{node} to be declared 200with @samp{node} option before it's used with @samp{cpu} option. 201 202For example: 203@example 204-M pc \ 205-smp 1,sockets=2,maxcpus=2 \ 206-numa node,nodeid=0 -numa node,nodeid=1 \ 207-numa cpu,node-id=0,socket-id=0 -numa cpu,node-id=1,socket-id=1 208@end example 209 210@samp{mem} assigns a given RAM amount to a node. @samp{memdev} 211assigns RAM from a given memory backend device to a node. If 212@samp{mem} and @samp{memdev} are omitted in all nodes, RAM is 213split equally between them. 214 215@samp{mem} and @samp{memdev} are mutually exclusive. Furthermore, 216if one node uses @samp{memdev}, all of them have to use it. 217 218@var{source} and @var{destination} are NUMA node IDs. 219@var{distance} is the NUMA distance from @var{source} to @var{destination}. 220The distance from a node to itself is always 10. If any pair of nodes is 221given a distance, then all pairs must be given distances. Although, when 222distances are only given in one direction for each pair of nodes, then 223the distances in the opposite directions are assumed to be the same. If, 224however, an asymmetrical pair of distances is given for even one node 225pair, then all node pairs must be provided distance values for both 226directions, even when they are symmetrical. When a node is unreachable 227from another node, set the pair's distance to 255. 228 229Note that the -@option{numa} option doesn't allocate any of the 230specified resources, it just assigns existing resources to NUMA 231nodes. This means that one still has to use the @option{-m}, 232@option{-smp} options to allocate RAM and VCPUs respectively. 233 234ETEXI 235 236DEF("add-fd", HAS_ARG, QEMU_OPTION_add_fd, 237 "-add-fd fd=fd,set=set[,opaque=opaque]\n" 238 " Add 'fd' to fd 'set'\n", QEMU_ARCH_ALL) 239STEXI 240@item -add-fd fd=@var{fd},set=@var{set}[,opaque=@var{opaque}] 241@findex -add-fd 242 243Add a file descriptor to an fd set. Valid options are: 244 245@table @option 246@item fd=@var{fd} 247This option defines the file descriptor of which a duplicate is added to fd set. 248The file descriptor cannot be stdin, stdout, or stderr. 249@item set=@var{set} 250This option defines the ID of the fd set to add the file descriptor to. 251@item opaque=@var{opaque} 252This option defines a free-form string that can be used to describe @var{fd}. 253@end table 254 255You can open an image using pre-opened file descriptors from an fd set: 256@example 257@value{qemu_system} \ 258 -add-fd fd=3,set=2,opaque="rdwr:/path/to/file" \ 259 -add-fd fd=4,set=2,opaque="rdonly:/path/to/file" \ 260 -drive file=/dev/fdset/2,index=0,media=disk 261@end example 262ETEXI 263 264DEF("set", HAS_ARG, QEMU_OPTION_set, 265 "-set group.id.arg=value\n" 266 " set <arg> parameter for item <id> of type <group>\n" 267 " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL) 268STEXI 269@item -set @var{group}.@var{id}.@var{arg}=@var{value} 270@findex -set 271Set parameter @var{arg} for item @var{id} of type @var{group} 272ETEXI 273 274DEF("global", HAS_ARG, QEMU_OPTION_global, 275 "-global driver.property=value\n" 276 "-global driver=driver,property=property,value=value\n" 277 " set a global default for a driver property\n", 278 QEMU_ARCH_ALL) 279STEXI 280@item -global @var{driver}.@var{prop}=@var{value} 281@itemx -global driver=@var{driver},property=@var{property},value=@var{value} 282@findex -global 283Set default value of @var{driver}'s property @var{prop} to @var{value}, e.g.: 284 285@example 286@value{qemu_system_x86} -global ide-hd.physical_block_size=4096 disk-image.img 287@end example 288 289In particular, you can use this to set driver properties for devices which are 290created automatically by the machine model. To create a device which is not 291created automatically and set properties on it, use -@option{device}. 292 293-global @var{driver}.@var{prop}=@var{value} is shorthand for -global 294driver=@var{driver},property=@var{prop},value=@var{value}. The 295longhand syntax works even when @var{driver} contains a dot. 296ETEXI 297 298DEF("boot", HAS_ARG, QEMU_OPTION_boot, 299 "-boot [order=drives][,once=drives][,menu=on|off]\n" 300 " [,splash=sp_name][,splash-time=sp_time][,reboot-timeout=rb_time][,strict=on|off]\n" 301 " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n" 302 " 'sp_name': the file's name that would be passed to bios as logo picture, if menu=on\n" 303 " 'sp_time': the period that splash picture last if menu=on, unit is ms\n" 304 " 'rb_timeout': the timeout before guest reboot when boot failed, unit is ms\n", 305 QEMU_ARCH_ALL) 306STEXI 307@item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off][,splash=@var{sp_name}][,splash-time=@var{sp_time}][,reboot-timeout=@var{rb_timeout}][,strict=on|off] 308@findex -boot 309Specify boot order @var{drives} as a string of drive letters. Valid 310drive letters depend on the target architecture. The x86 PC uses: a, b 311(floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot 312from network adapter 1-4), hard disk boot is the default. To apply a 313particular boot order only on the first startup, specify it via 314@option{once}. Note that the @option{order} or @option{once} parameter 315should not be used together with the @option{bootindex} property of 316devices, since the firmware implementations normally do not support both 317at the same time. 318 319Interactive boot menus/prompts can be enabled via @option{menu=on} as far 320as firmware/BIOS supports them. The default is non-interactive boot. 321 322A splash picture could be passed to bios, enabling user to show it as logo, 323when option splash=@var{sp_name} is given and menu=on, If firmware/BIOS 324supports them. Currently Seabios for X86 system support it. 325limitation: The splash file could be a jpeg file or a BMP file in 24 BPP 326format(true color). The resolution should be supported by the SVGA mode, so 327the recommended is 320x240, 640x480, 800x640. 328 329A timeout could be passed to bios, guest will pause for @var{rb_timeout} ms 330when boot failed, then reboot. If @option{reboot-timeout} is not set, 331guest will not reboot by default. Currently Seabios for X86 332system support it. 333 334Do strict boot via @option{strict=on} as far as firmware/BIOS 335supports it. This only effects when boot priority is changed by 336bootindex options. The default is non-strict boot. 337 338@example 339# try to boot from network first, then from hard disk 340@value{qemu_system_x86} -boot order=nc 341# boot from CD-ROM first, switch back to default order after reboot 342@value{qemu_system_x86} -boot once=d 343# boot with a splash picture for 5 seconds. 344@value{qemu_system_x86} -boot menu=on,splash=/root/boot.bmp,splash-time=5000 345@end example 346 347Note: The legacy format '-boot @var{drives}' is still supported but its 348use is discouraged as it may be removed from future versions. 349ETEXI 350 351DEF("m", HAS_ARG, QEMU_OPTION_m, 352 "-m [size=]megs[,slots=n,maxmem=size]\n" 353 " configure guest RAM\n" 354 " size: initial amount of guest memory\n" 355 " slots: number of hotplug slots (default: none)\n" 356 " maxmem: maximum amount of guest memory (default: none)\n" 357 "NOTE: Some architectures might enforce a specific granularity\n", 358 QEMU_ARCH_ALL) 359STEXI 360@item -m [size=]@var{megs}[,slots=n,maxmem=size] 361@findex -m 362Sets guest startup RAM size to @var{megs} megabytes. Default is 128 MiB. 363Optionally, a suffix of ``M'' or ``G'' can be used to signify a value in 364megabytes or gigabytes respectively. Optional pair @var{slots}, @var{maxmem} 365could be used to set amount of hotpluggable memory slots and maximum amount of 366memory. Note that @var{maxmem} must be aligned to the page size. 367 368For example, the following command-line sets the guest startup RAM size to 3691GB, creates 3 slots to hotplug additional memory and sets the maximum 370memory the guest can reach to 4GB: 371 372@example 373@value{qemu_system} -m 1G,slots=3,maxmem=4G 374@end example 375 376If @var{slots} and @var{maxmem} are not specified, memory hotplug won't 377be enabled and the guest startup RAM will never increase. 378ETEXI 379 380DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath, 381 "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL) 382STEXI 383@item -mem-path @var{path} 384@findex -mem-path 385Allocate guest RAM from a temporarily created file in @var{path}. 386ETEXI 387 388DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc, 389 "-mem-prealloc preallocate guest memory (use with -mem-path)\n", 390 QEMU_ARCH_ALL) 391STEXI 392@item -mem-prealloc 393@findex -mem-prealloc 394Preallocate memory when using -mem-path. 395ETEXI 396 397DEF("k", HAS_ARG, QEMU_OPTION_k, 398 "-k language use keyboard layout (for example 'fr' for French)\n", 399 QEMU_ARCH_ALL) 400STEXI 401@item -k @var{language} 402@findex -k 403Use keyboard layout @var{language} (for example @code{fr} for 404French). This option is only needed where it is not easy to get raw PC 405keycodes (e.g. on Macs, with some X11 servers or with a VNC or curses 406display). You don't normally need to use it on PC/Linux or PC/Windows 407hosts. 408 409The available layouts are: 410@example 411ar de-ch es fo fr-ca hu ja mk no pt-br sv 412da en-gb et fr fr-ch is lt nl pl ru th 413de en-us fi fr-be hr it lv nl-be pt sl tr 414@end example 415 416The default is @code{en-us}. 417ETEXI 418 419 420HXCOMM Deprecated by -audiodev 421DEF("audio-help", 0, QEMU_OPTION_audio_help, 422 "-audio-help show -audiodev equivalent of the currently specified audio settings\n", 423 QEMU_ARCH_ALL) 424STEXI 425@item -audio-help 426@findex -audio-help 427Will show the -audiodev equivalent of the currently specified 428(deprecated) environment variables. 429ETEXI 430 431DEF("audiodev", HAS_ARG, QEMU_OPTION_audiodev, 432 "-audiodev [driver=]driver,id=id[,prop[=value][,...]]\n" 433 " specifies the audio backend to use\n" 434 " id= identifier of the backend\n" 435 " timer-period= timer period in microseconds\n" 436 " in|out.mixing-engine= use mixing engine to mix streams inside QEMU\n" 437 " in|out.fixed-settings= use fixed settings for host audio\n" 438 " in|out.frequency= frequency to use with fixed settings\n" 439 " in|out.channels= number of channels to use with fixed settings\n" 440 " in|out.format= sample format to use with fixed settings\n" 441 " valid values: s8, s16, s32, u8, u16, u32\n" 442 " in|out.voices= number of voices to use\n" 443 " in|out.buffer-length= length of buffer in microseconds\n" 444 "-audiodev none,id=id,[,prop[=value][,...]]\n" 445 " dummy driver that discards all output\n" 446#ifdef CONFIG_AUDIO_ALSA 447 "-audiodev alsa,id=id[,prop[=value][,...]]\n" 448 " in|out.dev= name of the audio device to use\n" 449 " in|out.period-length= length of period in microseconds\n" 450 " in|out.try-poll= attempt to use poll mode\n" 451 " threshold= threshold (in microseconds) when playback starts\n" 452#endif 453#ifdef CONFIG_AUDIO_COREAUDIO 454 "-audiodev coreaudio,id=id[,prop[=value][,...]]\n" 455 " in|out.buffer-count= number of buffers\n" 456#endif 457#ifdef CONFIG_AUDIO_DSOUND 458 "-audiodev dsound,id=id[,prop[=value][,...]]\n" 459 " latency= add extra latency to playback in microseconds\n" 460#endif 461#ifdef CONFIG_AUDIO_OSS 462 "-audiodev oss,id=id[,prop[=value][,...]]\n" 463 " in|out.dev= path of the audio device to use\n" 464 " in|out.buffer-count= number of buffers\n" 465 " in|out.try-poll= attempt to use poll mode\n" 466 " try-mmap= try using memory mapped access\n" 467 " exclusive= open device in exclusive mode\n" 468 " dsp-policy= set timing policy (0..10), -1 to use fragment mode\n" 469#endif 470#ifdef CONFIG_AUDIO_PA 471 "-audiodev pa,id=id[,prop[=value][,...]]\n" 472 " server= PulseAudio server address\n" 473 " in|out.name= source/sink device name\n" 474 " in|out.latency= desired latency in microseconds\n" 475#endif 476#ifdef CONFIG_AUDIO_SDL 477 "-audiodev sdl,id=id[,prop[=value][,...]]\n" 478#endif 479#ifdef CONFIG_SPICE 480 "-audiodev spice,id=id[,prop[=value][,...]]\n" 481#endif 482 "-audiodev wav,id=id[,prop[=value][,...]]\n" 483 " path= path of wav file to record\n", 484 QEMU_ARCH_ALL) 485STEXI 486@item -audiodev [driver=]@var{driver},id=@var{id}[,@var{prop}[=@var{value}][,...]] 487@findex -audiodev 488Adds a new audio backend @var{driver} identified by @var{id}. There are 489global and driver specific properties. Some values can be set 490differently for input and output, they're marked with @code{in|out.}. 491You can set the input's property with @code{in.@var{prop}} and the 492output's property with @code{out.@var{prop}}. For example: 493@example 494-audiodev alsa,id=example,in.frequency=44110,out.frequency=8000 495-audiodev alsa,id=example,out.channels=1 # leaves in.channels unspecified 496@end example 497 498NOTE: parameter validation is known to be incomplete, in many cases 499specifying an invalid option causes QEMU to print an error message and 500continue emulation without sound. 501 502Valid global options are: 503 504@table @option 505@item id=@var{identifier} 506Identifies the audio backend. 507 508@item timer-period=@var{period} 509Sets the timer @var{period} used by the audio subsystem in microseconds. 510Default is 10000 (10 ms). 511 512@item in|out.mixing-engine=on|off 513Use QEMU's mixing engine to mix all streams inside QEMU and convert 514audio formats when not supported by the backend. When off, 515@var{fixed-settings} must be off too. Note that disabling this option 516means that the selected backend must support multiple streams and the 517audio formats used by the virtual cards, otherwise you'll get no sound. 518It's not recommended to disable this option unless you want to use 5.1 519or 7.1 audio, as mixing engine only supports mono and stereo audio. 520Default is on. 521 522@item in|out.fixed-settings=on|off 523Use fixed settings for host audio. When off, it will change based on 524how the guest opens the sound card. In this case you must not specify 525@var{frequency}, @var{channels} or @var{format}. Default is on. 526 527@item in|out.frequency=@var{frequency} 528Specify the @var{frequency} to use when using @var{fixed-settings}. 529Default is 44100Hz. 530 531@item in|out.channels=@var{channels} 532Specify the number of @var{channels} to use when using 533@var{fixed-settings}. Default is 2 (stereo). 534 535@item in|out.format=@var{format} 536Specify the sample @var{format} to use when using @var{fixed-settings}. 537Valid values are: @code{s8}, @code{s16}, @code{s32}, @code{u8}, 538@code{u16}, @code{u32}. Default is @code{s16}. 539 540@item in|out.voices=@var{voices} 541Specify the number of @var{voices} to use. Default is 1. 542 543@item in|out.buffer-length=@var{usecs} 544Sets the size of the buffer in microseconds. 545 546@end table 547 548@item -audiodev none,id=@var{id}[,@var{prop}[=@var{value}][,...]] 549Creates a dummy backend that discards all outputs. This backend has no 550backend specific properties. 551 552@item -audiodev alsa,id=@var{id}[,@var{prop}[=@var{value}][,...]] 553Creates backend using the ALSA. This backend is only available on 554Linux. 555 556ALSA specific options are: 557 558@table @option 559 560@item in|out.dev=@var{device} 561Specify the ALSA @var{device} to use for input and/or output. Default 562is @code{default}. 563 564@item in|out.period-length=@var{usecs} 565Sets the period length in microseconds. 566 567@item in|out.try-poll=on|off 568Attempt to use poll mode with the device. Default is on. 569 570@item threshold=@var{threshold} 571Threshold (in microseconds) when playback starts. Default is 0. 572 573@end table 574 575@item -audiodev coreaudio,id=@var{id}[,@var{prop}[=@var{value}][,...]] 576Creates a backend using Apple's Core Audio. This backend is only 577available on Mac OS and only supports playback. 578 579Core Audio specific options are: 580 581@table @option 582 583@item in|out.buffer-count=@var{count} 584Sets the @var{count} of the buffers. 585 586@end table 587 588@item -audiodev dsound,id=@var{id}[,@var{prop}[=@var{value}][,...]] 589Creates a backend using Microsoft's DirectSound. This backend is only 590available on Windows and only supports playback. 591 592DirectSound specific options are: 593 594@table @option 595 596@item latency=@var{usecs} 597Add extra @var{usecs} microseconds latency to playback. Default is 59810000 (10 ms). 599 600@end table 601 602@item -audiodev oss,id=@var{id}[,@var{prop}[=@var{value}][,...]] 603Creates a backend using OSS. This backend is available on most 604Unix-like systems. 605 606OSS specific options are: 607 608@table @option 609 610@item in|out.dev=@var{device} 611Specify the file name of the OSS @var{device} to use. Default is 612@code{/dev/dsp}. 613 614@item in|out.buffer-count=@var{count} 615Sets the @var{count} of the buffers. 616 617@item in|out.try-poll=on|of 618Attempt to use poll mode with the device. Default is on. 619 620@item try-mmap=on|off 621Try using memory mapped device access. Default is off. 622 623@item exclusive=on|off 624Open the device in exclusive mode (vmix won't work in this case). 625Default is off. 626 627@item dsp-policy=@var{policy} 628Sets the timing policy (between 0 and 10, where smaller number means 629smaller latency but higher CPU usage). Use -1 to use buffer sizes 630specified by @code{buffer} and @code{buffer-count}. This option is 631ignored if you do not have OSS 4. Default is 5. 632 633@end table 634 635@item -audiodev pa,id=@var{id}[,@var{prop}[=@var{value}][,...]] 636Creates a backend using PulseAudio. This backend is available on most 637systems. 638 639PulseAudio specific options are: 640 641@table @option 642 643@item server=@var{server} 644Sets the PulseAudio @var{server} to connect to. 645 646@item in|out.name=@var{sink} 647Use the specified source/sink for recording/playback. 648 649@item in|out.latency=@var{usecs} 650Desired latency in microseconds. The PulseAudio server will try to honor this 651value but actual latencies may be lower or higher. 652 653@end table 654 655@item -audiodev sdl,id=@var{id}[,@var{prop}[=@var{value}][,...]] 656Creates a backend using SDL. This backend is available on most systems, 657but you should use your platform's native backend if possible. This 658backend has no backend specific properties. 659 660@item -audiodev spice,id=@var{id}[,@var{prop}[=@var{value}][,...]] 661Creates a backend that sends audio through SPICE. This backend requires 662@code{-spice} and automatically selected in that case, so usually you 663can ignore this option. This backend has no backend specific 664properties. 665 666@item -audiodev wav,id=@var{id}[,@var{prop}[=@var{value}][,...]] 667Creates a backend that writes audio to a WAV file. 668 669Backend specific options are: 670 671@table @option 672 673@item path=@var{path} 674Write recorded audio into the specified file. Default is 675@code{qemu.wav}. 676 677@end table 678ETEXI 679 680DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw, 681 "-soundhw c1,... enable audio support\n" 682 " and only specified sound cards (comma separated list)\n" 683 " use '-soundhw help' to get the list of supported cards\n" 684 " use '-soundhw all' to enable all of them\n", QEMU_ARCH_ALL) 685STEXI 686@item -soundhw @var{card1}[,@var{card2},...] or -soundhw all 687@findex -soundhw 688Enable audio and selected sound hardware. Use 'help' to print all 689available sound hardware. For example: 690 691@example 692@value{qemu_system_x86} -soundhw sb16,adlib disk.img 693@value{qemu_system_x86} -soundhw es1370 disk.img 694@value{qemu_system_x86} -soundhw ac97 disk.img 695@value{qemu_system_x86} -soundhw hda disk.img 696@value{qemu_system_x86} -soundhw all disk.img 697@value{qemu_system_x86} -soundhw help 698@end example 699 700Note that Linux's i810_audio OSS kernel (for AC97) module might 701require manually specifying clocking. 702 703@example 704modprobe i810_audio clocking=48000 705@end example 706ETEXI 707 708DEF("device", HAS_ARG, QEMU_OPTION_device, 709 "-device driver[,prop[=value][,...]]\n" 710 " add device (based on driver)\n" 711 " prop=value,... sets driver properties\n" 712 " use '-device help' to print all possible drivers\n" 713 " use '-device driver,help' to print all possible properties\n", 714 QEMU_ARCH_ALL) 715STEXI 716@item -device @var{driver}[,@var{prop}[=@var{value}][,...]] 717@findex -device 718Add device @var{driver}. @var{prop}=@var{value} sets driver 719properties. Valid properties depend on the driver. To get help on 720possible drivers and properties, use @code{-device help} and 721@code{-device @var{driver},help}. 722 723Some drivers are: 724@item -device ipmi-bmc-sim,id=@var{id}[,slave_addr=@var{val}][,sdrfile=@var{file}][,furareasize=@var{val}][,furdatafile=@var{file}][,guid=@var{uuid}] 725 726Add an IPMI BMC. This is a simulation of a hardware management 727interface processor that normally sits on a system. It provides 728a watchdog and the ability to reset and power control the system. 729You need to connect this to an IPMI interface to make it useful 730 731The IPMI slave address to use for the BMC. The default is 0x20. 732This address is the BMC's address on the I2C network of management 733controllers. If you don't know what this means, it is safe to ignore 734it. 735 736@table @option 737@item id=@var{id} 738The BMC id for interfaces to use this device. 739@item slave_addr=@var{val} 740Define slave address to use for the BMC. The default is 0x20. 741@item sdrfile=@var{file} 742file containing raw Sensor Data Records (SDR) data. The default is none. 743@item fruareasize=@var{val} 744size of a Field Replaceable Unit (FRU) area. The default is 1024. 745@item frudatafile=@var{file} 746file containing raw Field Replaceable Unit (FRU) inventory data. The default is none. 747@item guid=@var{uuid} 748value for the GUID for the BMC, in standard UUID format. If this is set, 749get "Get GUID" command to the BMC will return it. Otherwise "Get GUID" 750will return an error. 751@end table 752 753@item -device ipmi-bmc-extern,id=@var{id},chardev=@var{id}[,slave_addr=@var{val}] 754 755Add a connection to an external IPMI BMC simulator. Instead of 756locally emulating the BMC like the above item, instead connect 757to an external entity that provides the IPMI services. 758 759A connection is made to an external BMC simulator. If you do this, it 760is strongly recommended that you use the "reconnect=" chardev option 761to reconnect to the simulator if the connection is lost. Note that if 762this is not used carefully, it can be a security issue, as the 763interface has the ability to send resets, NMIs, and power off the VM. 764It's best if QEMU makes a connection to an external simulator running 765on a secure port on localhost, so neither the simulator nor QEMU is 766exposed to any outside network. 767 768See the "lanserv/README.vm" file in the OpenIPMI library for more 769details on the external interface. 770 771@item -device isa-ipmi-kcs,bmc=@var{id}[,ioport=@var{val}][,irq=@var{val}] 772 773Add a KCS IPMI interafce on the ISA bus. This also adds a 774corresponding ACPI and SMBIOS entries, if appropriate. 775 776@table @option 777@item bmc=@var{id} 778The BMC to connect to, one of ipmi-bmc-sim or ipmi-bmc-extern above. 779@item ioport=@var{val} 780Define the I/O address of the interface. The default is 0xca0 for KCS. 781@item irq=@var{val} 782Define the interrupt to use. The default is 5. To disable interrupts, 783set this to 0. 784@end table 785 786@item -device isa-ipmi-bt,bmc=@var{id}[,ioport=@var{val}][,irq=@var{val}] 787 788Like the KCS interface, but defines a BT interface. The default port is 7890xe4 and the default interrupt is 5. 790 791ETEXI 792 793DEF("name", HAS_ARG, QEMU_OPTION_name, 794 "-name string1[,process=string2][,debug-threads=on|off]\n" 795 " set the name of the guest\n" 796 " string1 sets the window title and string2 the process name\n" 797 " When debug-threads is enabled, individual threads are given a separate name\n" 798 " NOTE: The thread names are for debugging and not a stable API.\n", 799 QEMU_ARCH_ALL) 800STEXI 801@item -name @var{name} 802@findex -name 803Sets the @var{name} of the guest. 804This name will be displayed in the SDL window caption. 805The @var{name} will also be used for the VNC server. 806Also optionally set the top visible process name in Linux. 807Naming of individual threads can also be enabled on Linux to aid debugging. 808ETEXI 809 810DEF("uuid", HAS_ARG, QEMU_OPTION_uuid, 811 "-uuid %08x-%04x-%04x-%04x-%012x\n" 812 " specify machine UUID\n", QEMU_ARCH_ALL) 813STEXI 814@item -uuid @var{uuid} 815@findex -uuid 816Set system UUID. 817ETEXI 818 819STEXI 820@end table 821ETEXI 822DEFHEADING() 823 824DEFHEADING(Block device options:) 825STEXI 826@table @option 827ETEXI 828 829DEF("fda", HAS_ARG, QEMU_OPTION_fda, 830 "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL) 831DEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL) 832STEXI 833@item -fda @var{file} 834@itemx -fdb @var{file} 835@findex -fda 836@findex -fdb 837Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). 838ETEXI 839 840DEF("hda", HAS_ARG, QEMU_OPTION_hda, 841 "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL) 842DEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL) 843DEF("hdc", HAS_ARG, QEMU_OPTION_hdc, 844 "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL) 845DEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL) 846STEXI 847@item -hda @var{file} 848@itemx -hdb @var{file} 849@itemx -hdc @var{file} 850@itemx -hdd @var{file} 851@findex -hda 852@findex -hdb 853@findex -hdc 854@findex -hdd 855Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}). 856ETEXI 857 858DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom, 859 "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n", 860 QEMU_ARCH_ALL) 861STEXI 862@item -cdrom @var{file} 863@findex -cdrom 864Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and 865@option{-cdrom} at the same time). You can use the host CD-ROM by 866using @file{/dev/cdrom} as filename (@pxref{host_drives}). 867ETEXI 868 869DEF("blockdev", HAS_ARG, QEMU_OPTION_blockdev, 870 "-blockdev [driver=]driver[,node-name=N][,discard=ignore|unmap]\n" 871 " [,cache.direct=on|off][,cache.no-flush=on|off]\n" 872 " [,read-only=on|off][,auto-read-only=on|off]\n" 873 " [,force-share=on|off][,detect-zeroes=on|off|unmap]\n" 874 " [,driver specific parameters...]\n" 875 " configure a block backend\n", QEMU_ARCH_ALL) 876STEXI 877@item -blockdev @var{option}[,@var{option}[,@var{option}[,...]]] 878@findex -blockdev 879 880Define a new block driver node. Some of the options apply to all block drivers, 881other options are only accepted for a specific block driver. See below for a 882list of generic options and options for the most common block drivers. 883 884Options that expect a reference to another node (e.g. @code{file}) can be 885given in two ways. Either you specify the node name of an already existing node 886(file=@var{node-name}), or you define a new node inline, adding options 887for the referenced node after a dot (file.filename=@var{path},file.aio=native). 888 889A block driver node created with @option{-blockdev} can be used for a guest 890device by specifying its node name for the @code{drive} property in a 891@option{-device} argument that defines a block device. 892 893@table @option 894@item Valid options for any block driver node: 895 896@table @code 897@item driver 898Specifies the block driver to use for the given node. 899@item node-name 900This defines the name of the block driver node by which it will be referenced 901later. The name must be unique, i.e. it must not match the name of a different 902block driver node, or (if you use @option{-drive} as well) the ID of a drive. 903 904If no node name is specified, it is automatically generated. The generated node 905name is not intended to be predictable and changes between QEMU invocations. 906For the top level, an explicit node name must be specified. 907@item read-only 908Open the node read-only. Guest write attempts will fail. 909 910Note that some block drivers support only read-only access, either generally or 911in certain configurations. In this case, the default value 912@option{read-only=off} does not work and the option must be specified 913explicitly. 914@item auto-read-only 915If @option{auto-read-only=on} is set, QEMU may fall back to read-only usage 916even when @option{read-only=off} is requested, or even switch between modes as 917needed, e.g. depending on whether the image file is writable or whether a 918writing user is attached to the node. 919@item force-share 920Override the image locking system of QEMU by forcing the node to utilize 921weaker shared access for permissions where it would normally request exclusive 922access. When there is the potential for multiple instances to have the same 923file open (whether this invocation of QEMU is the first or the second 924instance), both instances must permit shared access for the second instance to 925succeed at opening the file. 926 927Enabling @option{force-share=on} requires @option{read-only=on}. 928@item cache.direct 929The host page cache can be avoided with @option{cache.direct=on}. This will 930attempt to do disk IO directly to the guest's memory. QEMU may still perform an 931internal copy of the data. 932@item cache.no-flush 933In case you don't care about data integrity over host failures, you can use 934@option{cache.no-flush=on}. This option tells QEMU that it never needs to write 935any data to the disk but can instead keep things in cache. If anything goes 936wrong, like your host losing power, the disk storage getting disconnected 937accidentally, etc. your image will most probably be rendered unusable. 938@item discard=@var{discard} 939@var{discard} is one of "ignore" (or "off") or "unmap" (or "on") and controls 940whether @code{discard} (also known as @code{trim} or @code{unmap}) requests are 941ignored or passed to the filesystem. Some machine types may not support 942discard requests. 943@item detect-zeroes=@var{detect-zeroes} 944@var{detect-zeroes} is "off", "on" or "unmap" and enables the automatic 945conversion of plain zero writes by the OS to driver specific optimized 946zero write commands. You may even choose "unmap" if @var{discard} is set 947to "unmap" to allow a zero write to be converted to an @code{unmap} operation. 948@end table 949 950@item Driver-specific options for @code{file} 951 952This is the protocol-level block driver for accessing regular files. 953 954@table @code 955@item filename 956The path to the image file in the local filesystem 957@item aio 958Specifies the AIO backend (threads/native, default: threads) 959@item locking 960Specifies whether the image file is protected with Linux OFD / POSIX locks. The 961default is to use the Linux Open File Descriptor API if available, otherwise no 962lock is applied. (auto/on/off, default: auto) 963@end table 964Example: 965@example 966-blockdev driver=file,node-name=disk,filename=disk.img 967@end example 968 969@item Driver-specific options for @code{raw} 970 971This is the image format block driver for raw images. It is usually 972stacked on top of a protocol level block driver such as @code{file}. 973 974@table @code 975@item file 976Reference to or definition of the data source block driver node 977(e.g. a @code{file} driver node) 978@end table 979Example 1: 980@example 981-blockdev driver=file,node-name=disk_file,filename=disk.img 982-blockdev driver=raw,node-name=disk,file=disk_file 983@end example 984Example 2: 985@example 986-blockdev driver=raw,node-name=disk,file.driver=file,file.filename=disk.img 987@end example 988 989@item Driver-specific options for @code{qcow2} 990 991This is the image format block driver for qcow2 images. It is usually 992stacked on top of a protocol level block driver such as @code{file}. 993 994@table @code 995@item file 996Reference to or definition of the data source block driver node 997(e.g. a @code{file} driver node) 998 999@item backing 1000Reference to or definition of the backing file block device (default is taken 1001from the image file). It is allowed to pass @code{null} here in order to disable 1002the default backing file. 1003 1004@item lazy-refcounts 1005Whether to enable the lazy refcounts feature (on/off; default is taken from the 1006image file) 1007 1008@item cache-size 1009The maximum total size of the L2 table and refcount block caches in bytes 1010(default: the sum of l2-cache-size and refcount-cache-size) 1011 1012@item l2-cache-size 1013The maximum size of the L2 table cache in bytes 1014(default: if cache-size is not specified - 32M on Linux platforms, and 8M on 1015non-Linux platforms; otherwise, as large as possible within the cache-size, 1016while permitting the requested or the minimal refcount cache size) 1017 1018@item refcount-cache-size 1019The maximum size of the refcount block cache in bytes 1020(default: 4 times the cluster size; or if cache-size is specified, the part of 1021it which is not used for the L2 cache) 1022 1023@item cache-clean-interval 1024Clean unused entries in the L2 and refcount caches. The interval is in seconds. 1025The default value is 600 on supporting platforms, and 0 on other platforms. 1026Setting it to 0 disables this feature. 1027 1028@item pass-discard-request 1029Whether discard requests to the qcow2 device should be forwarded to the data 1030source (on/off; default: on if discard=unmap is specified, off otherwise) 1031 1032@item pass-discard-snapshot 1033Whether discard requests for the data source should be issued when a snapshot 1034operation (e.g. deleting a snapshot) frees clusters in the qcow2 file (on/off; 1035default: on) 1036 1037@item pass-discard-other 1038Whether discard requests for the data source should be issued on other 1039occasions where a cluster gets freed (on/off; default: off) 1040 1041@item overlap-check 1042Which overlap checks to perform for writes to the image 1043(none/constant/cached/all; default: cached). For details or finer 1044granularity control refer to the QAPI documentation of @code{blockdev-add}. 1045@end table 1046 1047Example 1: 1048@example 1049-blockdev driver=file,node-name=my_file,filename=/tmp/disk.qcow2 1050-blockdev driver=qcow2,node-name=hda,file=my_file,overlap-check=none,cache-size=16777216 1051@end example 1052Example 2: 1053@example 1054-blockdev driver=qcow2,node-name=disk,file.driver=http,file.filename=http://example.com/image.qcow2 1055@end example 1056 1057@item Driver-specific options for other drivers 1058Please refer to the QAPI documentation of the @code{blockdev-add} QMP command. 1059 1060@end table 1061 1062ETEXI 1063 1064DEF("drive", HAS_ARG, QEMU_OPTION_drive, 1065 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n" 1066 " [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n" 1067 " [,snapshot=on|off][,rerror=ignore|stop|report]\n" 1068 " [,werror=ignore|stop|report|enospc][,id=name][,aio=threads|native]\n" 1069 " [,readonly=on|off][,copy-on-read=on|off]\n" 1070 " [,discard=ignore|unmap][,detect-zeroes=on|off|unmap]\n" 1071 " [[,bps=b]|[[,bps_rd=r][,bps_wr=w]]]\n" 1072 " [[,iops=i]|[[,iops_rd=r][,iops_wr=w]]]\n" 1073 " [[,bps_max=bm]|[[,bps_rd_max=rm][,bps_wr_max=wm]]]\n" 1074 " [[,iops_max=im]|[[,iops_rd_max=irm][,iops_wr_max=iwm]]]\n" 1075 " [[,iops_size=is]]\n" 1076 " [[,group=g]]\n" 1077 " use 'file' as a drive image\n", QEMU_ARCH_ALL) 1078STEXI 1079@item -drive @var{option}[,@var{option}[,@var{option}[,...]]] 1080@findex -drive 1081 1082Define a new drive. This includes creating a block driver node (the backend) as 1083well as a guest device, and is mostly a shortcut for defining the corresponding 1084@option{-blockdev} and @option{-device} options. 1085 1086@option{-drive} accepts all options that are accepted by @option{-blockdev}. In 1087addition, it knows the following options: 1088 1089@table @option 1090@item file=@var{file} 1091This option defines which disk image (@pxref{disk_images}) to use with 1092this drive. If the filename contains comma, you must double it 1093(for instance, "file=my,,file" to use file "my,file"). 1094 1095Special files such as iSCSI devices can be specified using protocol 1096specific URLs. See the section for "Device URL Syntax" for more information. 1097@item if=@var{interface} 1098This option defines on which type on interface the drive is connected. 1099Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio, none. 1100@item bus=@var{bus},unit=@var{unit} 1101These options define where is connected the drive by defining the bus number and 1102the unit id. 1103@item index=@var{index} 1104This option defines where is connected the drive by using an index in the list 1105of available connectors of a given interface type. 1106@item media=@var{media} 1107This option defines the type of the media: disk or cdrom. 1108@item snapshot=@var{snapshot} 1109@var{snapshot} is "on" or "off" and controls snapshot mode for the given drive 1110(see @option{-snapshot}). 1111@item cache=@var{cache} 1112@var{cache} is "none", "writeback", "unsafe", "directsync" or "writethrough" 1113and controls how the host cache is used to access block data. This is a 1114shortcut that sets the @option{cache.direct} and @option{cache.no-flush} 1115options (as in @option{-blockdev}), and additionally @option{cache.writeback}, 1116which provides a default for the @option{write-cache} option of block guest 1117devices (as in @option{-device}). The modes correspond to the following 1118settings: 1119 1120@c Our texi2pod.pl script doesn't support @multitable, so fall back to using 1121@c plain ASCII art (well, UTF-8 art really). This looks okay both in the manpage 1122@c and the HTML output. 1123@example 1124@ │ cache.writeback cache.direct cache.no-flush 1125─────────────┼───────────────────────────────────────────────── 1126writeback │ on off off 1127none │ on on off 1128writethrough │ off off off 1129directsync │ off on off 1130unsafe │ on off on 1131@end example 1132 1133The default mode is @option{cache=writeback}. 1134 1135@item aio=@var{aio} 1136@var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO. 1137@item format=@var{format} 1138Specify which disk @var{format} will be used rather than detecting 1139the format. Can be used to specify format=raw to avoid interpreting 1140an untrusted format header. 1141@item werror=@var{action},rerror=@var{action} 1142Specify which @var{action} to take on write and read errors. Valid actions are: 1143"ignore" (ignore the error and try to continue), "stop" (pause QEMU), 1144"report" (report the error to the guest), "enospc" (pause QEMU only if the 1145host disk is full; report the error to the guest otherwise). 1146The default setting is @option{werror=enospc} and @option{rerror=report}. 1147@item copy-on-read=@var{copy-on-read} 1148@var{copy-on-read} is "on" or "off" and enables whether to copy read backing 1149file sectors into the image file. 1150@item bps=@var{b},bps_rd=@var{r},bps_wr=@var{w} 1151Specify bandwidth throttling limits in bytes per second, either for all request 1152types or for reads or writes only. Small values can lead to timeouts or hangs 1153inside the guest. A safe minimum for disks is 2 MB/s. 1154@item bps_max=@var{bm},bps_rd_max=@var{rm},bps_wr_max=@var{wm} 1155Specify bursts in bytes per second, either for all request types or for reads 1156or writes only. Bursts allow the guest I/O to spike above the limit 1157temporarily. 1158@item iops=@var{i},iops_rd=@var{r},iops_wr=@var{w} 1159Specify request rate limits in requests per second, either for all request 1160types or for reads or writes only. 1161@item iops_max=@var{bm},iops_rd_max=@var{rm},iops_wr_max=@var{wm} 1162Specify bursts in requests per second, either for all request types or for reads 1163or writes only. Bursts allow the guest I/O to spike above the limit 1164temporarily. 1165@item iops_size=@var{is} 1166Let every @var{is} bytes of a request count as a new request for iops 1167throttling purposes. Use this option to prevent guests from circumventing iops 1168limits by sending fewer but larger requests. 1169@item group=@var{g} 1170Join a throttling quota group with given name @var{g}. All drives that are 1171members of the same group are accounted for together. Use this option to 1172prevent guests from circumventing throttling limits by using many small disks 1173instead of a single larger disk. 1174@end table 1175 1176By default, the @option{cache.writeback=on} mode is used. It will report data 1177writes as completed as soon as the data is present in the host page cache. 1178This is safe as long as your guest OS makes sure to correctly flush disk caches 1179where needed. If your guest OS does not handle volatile disk write caches 1180correctly and your host crashes or loses power, then the guest may experience 1181data corruption. 1182 1183For such guests, you should consider using @option{cache.writeback=off}. This 1184means that the host page cache will be used to read and write data, but write 1185notification will be sent to the guest only after QEMU has made sure to flush 1186each write to the disk. Be aware that this has a major impact on performance. 1187 1188When using the @option{-snapshot} option, unsafe caching is always used. 1189 1190Copy-on-read avoids accessing the same backing file sectors repeatedly and is 1191useful when the backing file is over a slow network. By default copy-on-read 1192is off. 1193 1194Instead of @option{-cdrom} you can use: 1195@example 1196@value{qemu_system} -drive file=file,index=2,media=cdrom 1197@end example 1198 1199Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can 1200use: 1201@example 1202@value{qemu_system} -drive file=file,index=0,media=disk 1203@value{qemu_system} -drive file=file,index=1,media=disk 1204@value{qemu_system} -drive file=file,index=2,media=disk 1205@value{qemu_system} -drive file=file,index=3,media=disk 1206@end example 1207 1208You can open an image using pre-opened file descriptors from an fd set: 1209@example 1210@value{qemu_system} \ 1211 -add-fd fd=3,set=2,opaque="rdwr:/path/to/file" \ 1212 -add-fd fd=4,set=2,opaque="rdonly:/path/to/file" \ 1213 -drive file=/dev/fdset/2,index=0,media=disk 1214@end example 1215 1216You can connect a CDROM to the slave of ide0: 1217@example 1218@value{qemu_system_x86} -drive file=file,if=ide,index=1,media=cdrom 1219@end example 1220 1221If you don't specify the "file=" argument, you define an empty drive: 1222@example 1223@value{qemu_system_x86} -drive if=ide,index=1,media=cdrom 1224@end example 1225 1226Instead of @option{-fda}, @option{-fdb}, you can use: 1227@example 1228@value{qemu_system_x86} -drive file=file,index=0,if=floppy 1229@value{qemu_system_x86} -drive file=file,index=1,if=floppy 1230@end example 1231 1232By default, @var{interface} is "ide" and @var{index} is automatically 1233incremented: 1234@example 1235@value{qemu_system_x86} -drive file=a -drive file=b" 1236@end example 1237is interpreted like: 1238@example 1239@value{qemu_system_x86} -hda a -hdb b 1240@end example 1241ETEXI 1242 1243DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock, 1244 "-mtdblock file use 'file' as on-board Flash memory image\n", 1245 QEMU_ARCH_ALL) 1246STEXI 1247@item -mtdblock @var{file} 1248@findex -mtdblock 1249Use @var{file} as on-board Flash memory image. 1250ETEXI 1251 1252DEF("sd", HAS_ARG, QEMU_OPTION_sd, 1253 "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL) 1254STEXI 1255@item -sd @var{file} 1256@findex -sd 1257Use @var{file} as SecureDigital card image. 1258ETEXI 1259 1260DEF("pflash", HAS_ARG, QEMU_OPTION_pflash, 1261 "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL) 1262STEXI 1263@item -pflash @var{file} 1264@findex -pflash 1265Use @var{file} as a parallel flash image. 1266ETEXI 1267 1268DEF("snapshot", 0, QEMU_OPTION_snapshot, 1269 "-snapshot write to temporary files instead of disk image files\n", 1270 QEMU_ARCH_ALL) 1271STEXI 1272@item -snapshot 1273@findex -snapshot 1274Write to temporary files instead of disk image files. In this case, 1275the raw disk image you use is not written back. You can however force 1276the write back by pressing @key{C-a s} (@pxref{disk_images}). 1277ETEXI 1278 1279DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev, 1280 "-fsdev local,id=id,path=path,security_model=mapped-xattr|mapped-file|passthrough|none\n" 1281 " [,writeout=immediate][,readonly][,fmode=fmode][,dmode=dmode]\n" 1282 " [[,throttling.bps-total=b]|[[,throttling.bps-read=r][,throttling.bps-write=w]]]\n" 1283 " [[,throttling.iops-total=i]|[[,throttling.iops-read=r][,throttling.iops-write=w]]]\n" 1284 " [[,throttling.bps-total-max=bm]|[[,throttling.bps-read-max=rm][,throttling.bps-write-max=wm]]]\n" 1285 " [[,throttling.iops-total-max=im]|[[,throttling.iops-read-max=irm][,throttling.iops-write-max=iwm]]]\n" 1286 " [[,throttling.iops-size=is]]\n" 1287 "-fsdev proxy,id=id,socket=socket[,writeout=immediate][,readonly]\n" 1288 "-fsdev proxy,id=id,sock_fd=sock_fd[,writeout=immediate][,readonly]\n" 1289 "-fsdev synth,id=id\n", 1290 QEMU_ARCH_ALL) 1291 1292STEXI 1293 1294@item -fsdev local,id=@var{id},path=@var{path},security_model=@var{security_model} [,writeout=@var{writeout}][,readonly][,fmode=@var{fmode}][,dmode=@var{dmode}] [,throttling.@var{option}=@var{value}[,throttling.@var{option}=@var{value}[,...]]] 1295@itemx -fsdev proxy,id=@var{id},socket=@var{socket}[,writeout=@var{writeout}][,readonly] 1296@itemx -fsdev proxy,id=@var{id},sock_fd=@var{sock_fd}[,writeout=@var{writeout}][,readonly] 1297@itemx -fsdev synth,id=@var{id}[,readonly] 1298@findex -fsdev 1299Define a new file system device. Valid options are: 1300@table @option 1301@item local 1302Accesses to the filesystem are done by QEMU. 1303@item proxy 1304Accesses to the filesystem are done by virtfs-proxy-helper(1). 1305@item synth 1306Synthetic filesystem, only used by QTests. 1307@item id=@var{id} 1308Specifies identifier for this device. 1309@item path=@var{path} 1310Specifies the export path for the file system device. Files under 1311this path will be available to the 9p client on the guest. 1312@item security_model=@var{security_model} 1313Specifies the security model to be used for this export path. 1314Supported security models are "passthrough", "mapped-xattr", "mapped-file" and "none". 1315In "passthrough" security model, files are stored using the same 1316credentials as they are created on the guest. This requires QEMU 1317to run as root. In "mapped-xattr" security model, some of the file 1318attributes like uid, gid, mode bits and link target are stored as 1319file attributes. For "mapped-file" these attributes are stored in the 1320hidden .virtfs_metadata directory. Directories exported by this security model cannot 1321interact with other unix tools. "none" security model is same as 1322passthrough except the sever won't report failures if it fails to 1323set file attributes like ownership. Security model is mandatory 1324only for local fsdriver. Other fsdrivers (like proxy) don't take 1325security model as a parameter. 1326@item writeout=@var{writeout} 1327This is an optional argument. The only supported value is "immediate". 1328This means that host page cache will be used to read and write data but 1329write notification will be sent to the guest only when the data has been 1330reported as written by the storage subsystem. 1331@item readonly 1332Enables exporting 9p share as a readonly mount for guests. By default 1333read-write access is given. 1334@item socket=@var{socket} 1335Enables proxy filesystem driver to use passed socket file for communicating 1336with virtfs-proxy-helper(1). 1337@item sock_fd=@var{sock_fd} 1338Enables proxy filesystem driver to use passed socket descriptor for 1339communicating with virtfs-proxy-helper(1). Usually a helper like libvirt 1340will create socketpair and pass one of the fds as sock_fd. 1341@item fmode=@var{fmode} 1342Specifies the default mode for newly created files on the host. Works only 1343with security models "mapped-xattr" and "mapped-file". 1344@item dmode=@var{dmode} 1345Specifies the default mode for newly created directories on the host. Works 1346only with security models "mapped-xattr" and "mapped-file". 1347@item throttling.bps-total=@var{b},throttling.bps-read=@var{r},throttling.bps-write=@var{w} 1348Specify bandwidth throttling limits in bytes per second, either for all request 1349types or for reads or writes only. 1350@item throttling.bps-total-max=@var{bm},bps-read-max=@var{rm},bps-write-max=@var{wm} 1351Specify bursts in bytes per second, either for all request types or for reads 1352or writes only. Bursts allow the guest I/O to spike above the limit 1353temporarily. 1354@item throttling.iops-total=@var{i},throttling.iops-read=@var{r}, throttling.iops-write=@var{w} 1355Specify request rate limits in requests per second, either for all request 1356types or for reads or writes only. 1357@item throttling.iops-total-max=@var{im},throttling.iops-read-max=@var{irm}, throttling.iops-write-max=@var{iwm} 1358Specify bursts in requests per second, either for all request types or for reads 1359or writes only. Bursts allow the guest I/O to spike above the limit temporarily. 1360@item throttling.iops-size=@var{is} 1361Let every @var{is} bytes of a request count as a new request for iops 1362throttling purposes. 1363@end table 1364 1365-fsdev option is used along with -device driver "virtio-9p-...". 1366@item -device virtio-9p-@var{type},fsdev=@var{id},mount_tag=@var{mount_tag} 1367Options for virtio-9p-... driver are: 1368@table @option 1369@item @var{type} 1370Specifies the variant to be used. Supported values are "pci", "ccw" or "device", 1371depending on the machine type. 1372@item fsdev=@var{id} 1373Specifies the id value specified along with -fsdev option. 1374@item mount_tag=@var{mount_tag} 1375Specifies the tag name to be used by the guest to mount this export point. 1376@end table 1377 1378ETEXI 1379 1380DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs, 1381 "-virtfs local,path=path,mount_tag=tag,security_model=mapped-xattr|mapped-file|passthrough|none\n" 1382 " [,id=id][,writeout=immediate][,readonly][,fmode=fmode][,dmode=dmode][,multidevs=remap|forbid|warn]\n" 1383 "-virtfs proxy,mount_tag=tag,socket=socket[,id=id][,writeout=immediate][,readonly]\n" 1384 "-virtfs proxy,mount_tag=tag,sock_fd=sock_fd[,id=id][,writeout=immediate][,readonly]\n" 1385 "-virtfs synth,mount_tag=tag[,id=id][,readonly]\n", 1386 QEMU_ARCH_ALL) 1387 1388STEXI 1389 1390@item -virtfs local,path=@var{path},mount_tag=@var{mount_tag} ,security_model=@var{security_model}[,writeout=@var{writeout}][,readonly] [,fmode=@var{fmode}][,dmode=@var{dmode}][,multidevs=@var{multidevs}] 1391@itemx -virtfs proxy,socket=@var{socket},mount_tag=@var{mount_tag} [,writeout=@var{writeout}][,readonly] 1392@itemx -virtfs proxy,sock_fd=@var{sock_fd},mount_tag=@var{mount_tag} [,writeout=@var{writeout}][,readonly] 1393@itemx -virtfs synth,mount_tag=@var{mount_tag} 1394@findex -virtfs 1395 1396Define a new filesystem device and expose it to the guest using a virtio-9p-device. The general form of a Virtual File system pass-through options are: 1397@table @option 1398@item local 1399Accesses to the filesystem are done by QEMU. 1400@item proxy 1401Accesses to the filesystem are done by virtfs-proxy-helper(1). 1402@item synth 1403Synthetic filesystem, only used by QTests. 1404@item id=@var{id} 1405Specifies identifier for the filesystem device 1406@item path=@var{path} 1407Specifies the export path for the file system device. Files under 1408this path will be available to the 9p client on the guest. 1409@item security_model=@var{security_model} 1410Specifies the security model to be used for this export path. 1411Supported security models are "passthrough", "mapped-xattr", "mapped-file" and "none". 1412In "passthrough" security model, files are stored using the same 1413credentials as they are created on the guest. This requires QEMU 1414to run as root. In "mapped-xattr" security model, some of the file 1415attributes like uid, gid, mode bits and link target are stored as 1416file attributes. For "mapped-file" these attributes are stored in the 1417hidden .virtfs_metadata directory. Directories exported by this security model cannot 1418interact with other unix tools. "none" security model is same as 1419passthrough except the sever won't report failures if it fails to 1420set file attributes like ownership. Security model is mandatory only 1421for local fsdriver. Other fsdrivers (like proxy) don't take security 1422model as a parameter. 1423@item writeout=@var{writeout} 1424This is an optional argument. The only supported value is "immediate". 1425This means that host page cache will be used to read and write data but 1426write notification will be sent to the guest only when the data has been 1427reported as written by the storage subsystem. 1428@item readonly 1429Enables exporting 9p share as a readonly mount for guests. By default 1430read-write access is given. 1431@item socket=@var{socket} 1432Enables proxy filesystem driver to use passed socket file for 1433communicating with virtfs-proxy-helper(1). Usually a helper like libvirt 1434will create socketpair and pass one of the fds as sock_fd. 1435@item sock_fd 1436Enables proxy filesystem driver to use passed 'sock_fd' as the socket 1437descriptor for interfacing with virtfs-proxy-helper(1). 1438@item fmode=@var{fmode} 1439Specifies the default mode for newly created files on the host. Works only 1440with security models "mapped-xattr" and "mapped-file". 1441@item dmode=@var{dmode} 1442Specifies the default mode for newly created directories on the host. Works 1443only with security models "mapped-xattr" and "mapped-file". 1444@item mount_tag=@var{mount_tag} 1445Specifies the tag name to be used by the guest to mount this export point. 1446@item multidevs=@var{multidevs} 1447Specifies how to deal with multiple devices being shared with a 9p export. 1448Supported behaviours are either "remap", "forbid" or "warn". The latter is 1449the default behaviour on which virtfs 9p expects only one device to be 1450shared with the same export, and if more than one device is shared and 1451accessed via the same 9p export then only a warning message is logged 1452(once) by qemu on host side. In order to avoid file ID collisions on guest 1453you should either create a separate virtfs export for each device to be 1454shared with guests (recommended way) or you might use "remap" instead which 1455allows you to share multiple devices with only one export instead, which is 1456achieved by remapping the original inode numbers from host to guest in a 1457way that would prevent such collisions. Remapping inodes in such use cases 1458is required because the original device IDs from host are never passed and 1459exposed on guest. Instead all files of an export shared with virtfs always 1460share the same device id on guest. So two files with identical inode 1461numbers but from actually different devices on host would otherwise cause a 1462file ID collision and hence potential misbehaviours on guest. "forbid" on 1463the other hand assumes like "warn" that only one device is shared by the 1464same export, however it will not only log a warning message but also 1465deny access to additional devices on guest. Note though that "forbid" does 1466currently not block all possible file access operations (e.g. readdir() 1467would still return entries from other devices). 1468@end table 1469ETEXI 1470 1471DEF("virtfs_synth", 0, QEMU_OPTION_virtfs_synth, 1472 "-virtfs_synth Create synthetic file system image\n", 1473 QEMU_ARCH_ALL) 1474STEXI 1475@item -virtfs_synth 1476@findex -virtfs_synth 1477Create synthetic file system image. Note that this option is now deprecated. 1478Please use @code{-fsdev synth} and @code{-device virtio-9p-...} instead. 1479ETEXI 1480 1481DEF("iscsi", HAS_ARG, QEMU_OPTION_iscsi, 1482 "-iscsi [user=user][,password=password]\n" 1483 " [,header-digest=CRC32C|CR32C-NONE|NONE-CRC32C|NONE\n" 1484 " [,initiator-name=initiator-iqn][,id=target-iqn]\n" 1485 " [,timeout=timeout]\n" 1486 " iSCSI session parameters\n", QEMU_ARCH_ALL) 1487 1488STEXI 1489@item -iscsi 1490@findex -iscsi 1491Configure iSCSI session parameters. 1492ETEXI 1493 1494STEXI 1495@end table 1496ETEXI 1497DEFHEADING() 1498 1499DEFHEADING(USB options:) 1500STEXI 1501@table @option 1502ETEXI 1503 1504DEF("usb", 0, QEMU_OPTION_usb, 1505 "-usb enable on-board USB host controller (if not enabled by default)\n", 1506 QEMU_ARCH_ALL) 1507STEXI 1508@item -usb 1509@findex -usb 1510Enable USB emulation on machine types with an on-board USB host controller (if 1511not enabled by default). Note that on-board USB host controllers may not 1512support USB 3.0. In this case @option{-device qemu-xhci} can be used instead 1513on machines with PCI. 1514ETEXI 1515 1516DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice, 1517 "-usbdevice name add the host or guest USB device 'name'\n", 1518 QEMU_ARCH_ALL) 1519STEXI 1520 1521@item -usbdevice @var{devname} 1522@findex -usbdevice 1523Add the USB device @var{devname}. Note that this option is deprecated, 1524please use @code{-device usb-...} instead. @xref{usb_devices}. 1525 1526@table @option 1527 1528@item mouse 1529Virtual Mouse. This will override the PS/2 mouse emulation when activated. 1530 1531@item tablet 1532Pointer device that uses absolute coordinates (like a touchscreen). This 1533means QEMU is able to report the mouse position without having to grab the 1534mouse. Also overrides the PS/2 mouse emulation when activated. 1535 1536@item braille 1537Braille device. This will use BrlAPI to display the braille output on a real 1538or fake device. 1539 1540@end table 1541ETEXI 1542 1543STEXI 1544@end table 1545ETEXI 1546DEFHEADING() 1547 1548DEFHEADING(Display options:) 1549STEXI 1550@table @option 1551ETEXI 1552 1553DEF("display", HAS_ARG, QEMU_OPTION_display, 1554#if defined(CONFIG_SPICE) 1555 "-display spice-app[,gl=on|off]\n" 1556#endif 1557#if defined(CONFIG_SDL) 1558 "-display sdl[,alt_grab=on|off][,ctrl_grab=on|off]\n" 1559 " [,window_close=on|off][,gl=on|core|es|off]\n" 1560#endif 1561#if defined(CONFIG_GTK) 1562 "-display gtk[,grab_on_hover=on|off][,gl=on|off]|\n" 1563#endif 1564#if defined(CONFIG_VNC) 1565 "-display vnc=<display>[,<optargs>]\n" 1566#endif 1567#if defined(CONFIG_CURSES) 1568 "-display curses[,charset=<encoding>]\n" 1569#endif 1570#if defined(CONFIG_OPENGL) 1571 "-display egl-headless[,rendernode=<file>]\n" 1572#endif 1573 "-display none\n" 1574 " select display backend type\n" 1575 " The default display is equivalent to\n " 1576#if defined(CONFIG_GTK) 1577 "\"-display gtk\"\n" 1578#elif defined(CONFIG_SDL) 1579 "\"-display sdl\"\n" 1580#elif defined(CONFIG_COCOA) 1581 "\"-display cocoa\"\n" 1582#elif defined(CONFIG_VNC) 1583 "\"-vnc localhost:0,to=99,id=default\"\n" 1584#else 1585 "\"-display none\"\n" 1586#endif 1587 , QEMU_ARCH_ALL) 1588STEXI 1589@item -display @var{type} 1590@findex -display 1591Select type of display to use. This option is a replacement for the 1592old style -sdl/-curses/... options. Valid values for @var{type} are 1593@table @option 1594@item sdl 1595Display video output via SDL (usually in a separate graphics 1596window; see the SDL documentation for other possibilities). 1597@item curses 1598Display video output via curses. For graphics device models which 1599support a text mode, QEMU can display this output using a 1600curses/ncurses interface. Nothing is displayed when the graphics 1601device is in graphical mode or if the graphics device does not support 1602a text mode. Generally only the VGA device models support text mode. 1603The font charset used by the guest can be specified with the 1604@code{charset} option, for example @code{charset=CP850} for IBM CP850 1605encoding. The default is @code{CP437}. 1606@item none 1607Do not display video output. The guest will still see an emulated 1608graphics card, but its output will not be displayed to the QEMU 1609user. This option differs from the -nographic option in that it 1610only affects what is done with video output; -nographic also changes 1611the destination of the serial and parallel port data. 1612@item gtk 1613Display video output in a GTK window. This interface provides drop-down 1614menus and other UI elements to configure and control the VM during 1615runtime. 1616@item vnc 1617Start a VNC server on display <arg> 1618@item egl-headless 1619Offload all OpenGL operations to a local DRI device. For any graphical display, 1620this display needs to be paired with either VNC or SPICE displays. 1621@item spice-app 1622Start QEMU as a Spice server and launch the default Spice client 1623application. The Spice server will redirect the serial consoles and 1624QEMU monitors. (Since 4.0) 1625@end table 1626ETEXI 1627 1628DEF("nographic", 0, QEMU_OPTION_nographic, 1629 "-nographic disable graphical output and redirect serial I/Os to console\n", 1630 QEMU_ARCH_ALL) 1631STEXI 1632@item -nographic 1633@findex -nographic 1634Normally, if QEMU is compiled with graphical window support, it displays 1635output such as guest graphics, guest console, and the QEMU monitor in a 1636window. With this option, you can totally disable graphical output so 1637that QEMU is a simple command line application. The emulated serial port 1638is redirected on the console and muxed with the monitor (unless 1639redirected elsewhere explicitly). Therefore, you can still use QEMU to 1640debug a Linux kernel with a serial console. Use @key{C-a h} for help on 1641switching between the console and monitor. 1642ETEXI 1643 1644DEF("curses", 0, QEMU_OPTION_curses, 1645 "-curses shorthand for -display curses\n", 1646 QEMU_ARCH_ALL) 1647STEXI 1648@item -curses 1649@findex -curses 1650Normally, if QEMU is compiled with graphical window support, it displays 1651output such as guest graphics, guest console, and the QEMU monitor in a 1652window. With this option, QEMU can display the VGA output when in text 1653mode using a curses/ncurses interface. Nothing is displayed in graphical 1654mode. 1655ETEXI 1656 1657DEF("alt-grab", 0, QEMU_OPTION_alt_grab, 1658 "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n", 1659 QEMU_ARCH_ALL) 1660STEXI 1661@item -alt-grab 1662@findex -alt-grab 1663Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also 1664affects the special keys (for fullscreen, monitor-mode switching, etc). 1665ETEXI 1666 1667DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab, 1668 "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n", 1669 QEMU_ARCH_ALL) 1670STEXI 1671@item -ctrl-grab 1672@findex -ctrl-grab 1673Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also 1674affects the special keys (for fullscreen, monitor-mode switching, etc). 1675ETEXI 1676 1677DEF("no-quit", 0, QEMU_OPTION_no_quit, 1678 "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL) 1679STEXI 1680@item -no-quit 1681@findex -no-quit 1682Disable SDL window close capability. 1683ETEXI 1684 1685DEF("sdl", 0, QEMU_OPTION_sdl, 1686 "-sdl shorthand for -display sdl\n", QEMU_ARCH_ALL) 1687STEXI 1688@item -sdl 1689@findex -sdl 1690Enable SDL. 1691ETEXI 1692 1693DEF("spice", HAS_ARG, QEMU_OPTION_spice, 1694 "-spice [port=port][,tls-port=secured-port][,x509-dir=<dir>]\n" 1695 " [,x509-key-file=<file>][,x509-key-password=<file>]\n" 1696 " [,x509-cert-file=<file>][,x509-cacert-file=<file>]\n" 1697 " [,x509-dh-key-file=<file>][,addr=addr][,ipv4|ipv6|unix]\n" 1698 " [,tls-ciphers=<list>]\n" 1699 " [,tls-channel=[main|display|cursor|inputs|record|playback]]\n" 1700 " [,plaintext-channel=[main|display|cursor|inputs|record|playback]]\n" 1701 " [,sasl][,password=<secret>][,disable-ticketing]\n" 1702 " [,image-compression=[auto_glz|auto_lz|quic|glz|lz|off]]\n" 1703 " [,jpeg-wan-compression=[auto|never|always]]\n" 1704 " [,zlib-glz-wan-compression=[auto|never|always]]\n" 1705 " [,streaming-video=[off|all|filter]][,disable-copy-paste]\n" 1706 " [,disable-agent-file-xfer][,agent-mouse=[on|off]]\n" 1707 " [,playback-compression=[on|off]][,seamless-migration=[on|off]]\n" 1708 " [,gl=[on|off]][,rendernode=<file>]\n" 1709 " enable spice\n" 1710 " at least one of {port, tls-port} is mandatory\n", 1711 QEMU_ARCH_ALL) 1712STEXI 1713@item -spice @var{option}[,@var{option}[,...]] 1714@findex -spice 1715Enable the spice remote desktop protocol. Valid options are 1716 1717@table @option 1718 1719@item port=<nr> 1720Set the TCP port spice is listening on for plaintext channels. 1721 1722@item addr=<addr> 1723Set the IP address spice is listening on. Default is any address. 1724 1725@item ipv4 1726@itemx ipv6 1727@itemx unix 1728Force using the specified IP version. 1729 1730@item password=<secret> 1731Set the password you need to authenticate. 1732 1733@item sasl 1734Require that the client use SASL to authenticate with the spice. 1735The exact choice of authentication method used is controlled from the 1736system / user's SASL configuration file for the 'qemu' service. This 1737is typically found in /etc/sasl2/qemu.conf. If running QEMU as an 1738unprivileged user, an environment variable SASL_CONF_PATH can be used 1739to make it search alternate locations for the service config. 1740While some SASL auth methods can also provide data encryption (eg GSSAPI), 1741it is recommended that SASL always be combined with the 'tls' and 1742'x509' settings to enable use of SSL and server certificates. This 1743ensures a data encryption preventing compromise of authentication 1744credentials. 1745 1746@item disable-ticketing 1747Allow client connects without authentication. 1748 1749@item disable-copy-paste 1750Disable copy paste between the client and the guest. 1751 1752@item disable-agent-file-xfer 1753Disable spice-vdagent based file-xfer between the client and the guest. 1754 1755@item tls-port=<nr> 1756Set the TCP port spice is listening on for encrypted channels. 1757 1758@item x509-dir=<dir> 1759Set the x509 file directory. Expects same filenames as -vnc $display,x509=$dir 1760 1761@item x509-key-file=<file> 1762@itemx x509-key-password=<file> 1763@itemx x509-cert-file=<file> 1764@itemx x509-cacert-file=<file> 1765@itemx x509-dh-key-file=<file> 1766The x509 file names can also be configured individually. 1767 1768@item tls-ciphers=<list> 1769Specify which ciphers to use. 1770 1771@item tls-channel=[main|display|cursor|inputs|record|playback] 1772@itemx plaintext-channel=[main|display|cursor|inputs|record|playback] 1773Force specific channel to be used with or without TLS encryption. The 1774options can be specified multiple times to configure multiple 1775channels. The special name "default" can be used to set the default 1776mode. For channels which are not explicitly forced into one mode the 1777spice client is allowed to pick tls/plaintext as he pleases. 1778 1779@item image-compression=[auto_glz|auto_lz|quic|glz|lz|off] 1780Configure image compression (lossless). 1781Default is auto_glz. 1782 1783@item jpeg-wan-compression=[auto|never|always] 1784@itemx zlib-glz-wan-compression=[auto|never|always] 1785Configure wan image compression (lossy for slow links). 1786Default is auto. 1787 1788@item streaming-video=[off|all|filter] 1789Configure video stream detection. Default is off. 1790 1791@item agent-mouse=[on|off] 1792Enable/disable passing mouse events via vdagent. Default is on. 1793 1794@item playback-compression=[on|off] 1795Enable/disable audio stream compression (using celt 0.5.1). Default is on. 1796 1797@item seamless-migration=[on|off] 1798Enable/disable spice seamless migration. Default is off. 1799 1800@item gl=[on|off] 1801Enable/disable OpenGL context. Default is off. 1802 1803@item rendernode=<file> 1804DRM render node for OpenGL rendering. If not specified, it will pick 1805the first available. (Since 2.9) 1806 1807@end table 1808ETEXI 1809 1810DEF("portrait", 0, QEMU_OPTION_portrait, 1811 "-portrait rotate graphical output 90 deg left (only PXA LCD)\n", 1812 QEMU_ARCH_ALL) 1813STEXI 1814@item -portrait 1815@findex -portrait 1816Rotate graphical output 90 deg left (only PXA LCD). 1817ETEXI 1818 1819DEF("rotate", HAS_ARG, QEMU_OPTION_rotate, 1820 "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n", 1821 QEMU_ARCH_ALL) 1822STEXI 1823@item -rotate @var{deg} 1824@findex -rotate 1825Rotate graphical output some deg left (only PXA LCD). 1826ETEXI 1827 1828DEF("vga", HAS_ARG, QEMU_OPTION_vga, 1829 "-vga [std|cirrus|vmware|qxl|xenfb|tcx|cg3|virtio|none]\n" 1830 " select video card type\n", QEMU_ARCH_ALL) 1831STEXI 1832@item -vga @var{type} 1833@findex -vga 1834Select type of VGA card to emulate. Valid values for @var{type} are 1835@table @option 1836@item cirrus 1837Cirrus Logic GD5446 Video card. All Windows versions starting from 1838Windows 95 should recognize and use this graphic card. For optimal 1839performances, use 16 bit color depth in the guest and the host OS. 1840(This card was the default before QEMU 2.2) 1841@item std 1842Standard VGA card with Bochs VBE extensions. If your guest OS 1843supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want 1844to use high resolution modes (>= 1280x1024x16) then you should use 1845this option. (This card is the default since QEMU 2.2) 1846@item vmware 1847VMWare SVGA-II compatible adapter. Use it if you have sufficiently 1848recent XFree86/XOrg server or Windows guest with a driver for this 1849card. 1850@item qxl 1851QXL paravirtual graphic card. It is VGA compatible (including VESA 18522.0 VBE support). Works best with qxl guest drivers installed though. 1853Recommended choice when using the spice protocol. 1854@item tcx 1855(sun4m only) Sun TCX framebuffer. This is the default framebuffer for 1856sun4m machines and offers both 8-bit and 24-bit colour depths at a 1857fixed resolution of 1024x768. 1858@item cg3 1859(sun4m only) Sun cgthree framebuffer. This is a simple 8-bit framebuffer 1860for sun4m machines available in both 1024x768 (OpenBIOS) and 1152x900 (OBP) 1861resolutions aimed at people wishing to run older Solaris versions. 1862@item virtio 1863Virtio VGA card. 1864@item none 1865Disable VGA card. 1866@end table 1867ETEXI 1868 1869DEF("full-screen", 0, QEMU_OPTION_full_screen, 1870 "-full-screen start in full screen\n", QEMU_ARCH_ALL) 1871STEXI 1872@item -full-screen 1873@findex -full-screen 1874Start in full screen. 1875ETEXI 1876 1877DEF("g", 1, QEMU_OPTION_g , 1878 "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n", 1879 QEMU_ARCH_PPC | QEMU_ARCH_SPARC | QEMU_ARCH_M68K) 1880STEXI 1881@item -g @var{width}x@var{height}[x@var{depth}] 1882@findex -g 1883Set the initial graphical resolution and depth (PPC, SPARC only). 1884ETEXI 1885 1886DEF("vnc", HAS_ARG, QEMU_OPTION_vnc , 1887 "-vnc <display> shorthand for -display vnc=<display>\n", QEMU_ARCH_ALL) 1888STEXI 1889@item -vnc @var{display}[,@var{option}[,@var{option}[,...]]] 1890@findex -vnc 1891Normally, if QEMU is compiled with graphical window support, it displays 1892output such as guest graphics, guest console, and the QEMU monitor in a 1893window. With this option, you can have QEMU listen on VNC display 1894@var{display} and redirect the VGA display over the VNC session. It is 1895very useful to enable the usb tablet device when using this option 1896(option @option{-device usb-tablet}). When using the VNC display, you 1897must use the @option{-k} parameter to set the keyboard layout if you are 1898not using en-us. Valid syntax for the @var{display} is 1899 1900@table @option 1901 1902@item to=@var{L} 1903 1904With this option, QEMU will try next available VNC @var{display}s, until the 1905number @var{L}, if the origianlly defined "-vnc @var{display}" is not 1906available, e.g. port 5900+@var{display} is already used by another 1907application. By default, to=0. 1908 1909@item @var{host}:@var{d} 1910 1911TCP connections will only be allowed from @var{host} on display @var{d}. 1912By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can 1913be omitted in which case the server will accept connections from any host. 1914 1915@item unix:@var{path} 1916 1917Connections will be allowed over UNIX domain sockets where @var{path} is the 1918location of a unix socket to listen for connections on. 1919 1920@item none 1921 1922VNC is initialized but not started. The monitor @code{change} command 1923can be used to later start the VNC server. 1924 1925@end table 1926 1927Following the @var{display} value there may be one or more @var{option} flags 1928separated by commas. Valid options are 1929 1930@table @option 1931 1932@item reverse 1933 1934Connect to a listening VNC client via a ``reverse'' connection. The 1935client is specified by the @var{display}. For reverse network 1936connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument 1937is a TCP port number, not a display number. 1938 1939@item websocket 1940 1941Opens an additional TCP listening port dedicated to VNC Websocket connections. 1942If a bare @var{websocket} option is given, the Websocket port is 19435700+@var{display}. An alternative port can be specified with the 1944syntax @code{websocket}=@var{port}. 1945 1946If @var{host} is specified connections will only be allowed from this host. 1947It is possible to control the websocket listen address independently, using 1948the syntax @code{websocket}=@var{host}:@var{port}. 1949 1950If no TLS credentials are provided, the websocket connection runs in 1951unencrypted mode. If TLS credentials are provided, the websocket connection 1952requires encrypted client connections. 1953 1954@item password 1955 1956Require that password based authentication is used for client connections. 1957 1958The password must be set separately using the @code{set_password} command in 1959the @ref{pcsys_monitor}. The syntax to change your password is: 1960@code{set_password <protocol> <password>} where <protocol> could be either 1961"vnc" or "spice". 1962 1963If you would like to change <protocol> password expiration, you should use 1964@code{expire_password <protocol> <expiration-time>} where expiration time could 1965be one of the following options: now, never, +seconds or UNIX time of 1966expiration, e.g. +60 to make password expire in 60 seconds, or 1335196800 1967to make password expire on "Mon Apr 23 12:00:00 EDT 2012" (UNIX time for this 1968date and time). 1969 1970You can also use keywords "now" or "never" for the expiration time to 1971allow <protocol> password to expire immediately or never expire. 1972 1973@item tls-creds=@var{ID} 1974 1975Provides the ID of a set of TLS credentials to use to secure the 1976VNC server. They will apply to both the normal VNC server socket 1977and the websocket socket (if enabled). Setting TLS credentials 1978will cause the VNC server socket to enable the VeNCrypt auth 1979mechanism. The credentials should have been previously created 1980using the @option{-object tls-creds} argument. 1981 1982@item tls-authz=@var{ID} 1983 1984Provides the ID of the QAuthZ authorization object against which 1985the client's x509 distinguished name will validated. This object is 1986only resolved at time of use, so can be deleted and recreated on the 1987fly while the VNC server is active. If missing, it will default 1988to denying access. 1989 1990@item sasl 1991 1992Require that the client use SASL to authenticate with the VNC server. 1993The exact choice of authentication method used is controlled from the 1994system / user's SASL configuration file for the 'qemu' service. This 1995is typically found in /etc/sasl2/qemu.conf. If running QEMU as an 1996unprivileged user, an environment variable SASL_CONF_PATH can be used 1997to make it search alternate locations for the service config. 1998While some SASL auth methods can also provide data encryption (eg GSSAPI), 1999it is recommended that SASL always be combined with the 'tls' and 2000'x509' settings to enable use of SSL and server certificates. This 2001ensures a data encryption preventing compromise of authentication 2002credentials. See the @ref{vnc_security} section for details on using 2003SASL authentication. 2004 2005@item sasl-authz=@var{ID} 2006 2007Provides the ID of the QAuthZ authorization object against which 2008the client's SASL username will validated. This object is 2009only resolved at time of use, so can be deleted and recreated on the 2010fly while the VNC server is active. If missing, it will default 2011to denying access. 2012 2013@item acl 2014 2015Legacy method for enabling authorization of clients against the 2016x509 distinguished name and SASL username. It results in the creation 2017of two @code{authz-list} objects with IDs of @code{vnc.username} and 2018@code{vnc.x509dname}. The rules for these objects must be configured 2019with the HMP ACL commands. 2020 2021This option is deprecated and should no longer be used. The new 2022@option{sasl-authz} and @option{tls-authz} options are a 2023replacement. 2024 2025@item lossy 2026 2027Enable lossy compression methods (gradient, JPEG, ...). If this 2028option is set, VNC client may receive lossy framebuffer updates 2029depending on its encoding settings. Enabling this option can save 2030a lot of bandwidth at the expense of quality. 2031 2032@item non-adaptive 2033 2034Disable adaptive encodings. Adaptive encodings are enabled by default. 2035An adaptive encoding will try to detect frequently updated screen regions, 2036and send updates in these regions using a lossy encoding (like JPEG). 2037This can be really helpful to save bandwidth when playing videos. Disabling 2038adaptive encodings restores the original static behavior of encodings 2039like Tight. 2040 2041@item share=[allow-exclusive|force-shared|ignore] 2042 2043Set display sharing policy. 'allow-exclusive' allows clients to ask 2044for exclusive access. As suggested by the rfb spec this is 2045implemented by dropping other connections. Connecting multiple 2046clients in parallel requires all clients asking for a shared session 2047(vncviewer: -shared switch). This is the default. 'force-shared' 2048disables exclusive client access. Useful for shared desktop sessions, 2049where you don't want someone forgetting specify -shared disconnect 2050everybody else. 'ignore' completely ignores the shared flag and 2051allows everybody connect unconditionally. Doesn't conform to the rfb 2052spec but is traditional QEMU behavior. 2053 2054@item key-delay-ms 2055 2056Set keyboard delay, for key down and key up events, in milliseconds. 2057Default is 10. Keyboards are low-bandwidth devices, so this slowdown 2058can help the device and guest to keep up and not lose events in case 2059events are arriving in bulk. Possible causes for the latter are flaky 2060network connections, or scripts for automated testing. 2061 2062@item audiodev=@var{audiodev} 2063 2064Use the specified @var{audiodev} when the VNC client requests audio 2065transmission. When not using an -audiodev argument, this option must 2066be omitted, otherwise is must be present and specify a valid audiodev. 2067 2068@end table 2069ETEXI 2070 2071STEXI 2072@end table 2073ETEXI 2074ARCHHEADING(, QEMU_ARCH_I386) 2075 2076ARCHHEADING(i386 target only:, QEMU_ARCH_I386) 2077STEXI 2078@table @option 2079ETEXI 2080 2081DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack, 2082 "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n", 2083 QEMU_ARCH_I386) 2084STEXI 2085@item -win2k-hack 2086@findex -win2k-hack 2087Use it when installing Windows 2000 to avoid a disk full bug. After 2088Windows 2000 is installed, you no longer need this option (this option 2089slows down the IDE transfers). 2090ETEXI 2091 2092DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk, 2093 "-no-fd-bootchk disable boot signature checking for floppy disks\n", 2094 QEMU_ARCH_I386) 2095STEXI 2096@item -no-fd-bootchk 2097@findex -no-fd-bootchk 2098Disable boot signature checking for floppy disks in BIOS. May 2099be needed to boot from old floppy disks. 2100ETEXI 2101 2102DEF("no-acpi", 0, QEMU_OPTION_no_acpi, 2103 "-no-acpi disable ACPI\n", QEMU_ARCH_I386 | QEMU_ARCH_ARM) 2104STEXI 2105@item -no-acpi 2106@findex -no-acpi 2107Disable ACPI (Advanced Configuration and Power Interface) support. Use 2108it if your guest OS complains about ACPI problems (PC target machine 2109only). 2110ETEXI 2111 2112DEF("no-hpet", 0, QEMU_OPTION_no_hpet, 2113 "-no-hpet disable HPET\n", QEMU_ARCH_I386) 2114STEXI 2115@item -no-hpet 2116@findex -no-hpet 2117Disable HPET support. 2118ETEXI 2119 2120DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable, 2121 "-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" 2122 " ACPI table description\n", QEMU_ARCH_I386) 2123STEXI 2124@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}]...] 2125@findex -acpitable 2126Add ACPI table with specified header fields and context from specified files. 2127For file=, take whole ACPI table from the specified files, including all 2128ACPI headers (possible overridden by other options). 2129For data=, only data 2130portion of the table is used, all header information is specified in the 2131command line. 2132If a SLIC table is supplied to QEMU, then the SLIC's oem_id and oem_table_id 2133fields will override the same in the RSDT and the FADT (a.k.a. FACP), in order 2134to ensure the field matches required by the Microsoft SLIC spec and the ACPI 2135spec. 2136ETEXI 2137 2138DEF("smbios", HAS_ARG, QEMU_OPTION_smbios, 2139 "-smbios file=binary\n" 2140 " load SMBIOS entry from binary file\n" 2141 "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n" 2142 " [,uefi=on|off]\n" 2143 " specify SMBIOS type 0 fields\n" 2144 "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 2145 " [,uuid=uuid][,sku=str][,family=str]\n" 2146 " specify SMBIOS type 1 fields\n" 2147 "-smbios type=2[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 2148 " [,asset=str][,location=str]\n" 2149 " specify SMBIOS type 2 fields\n" 2150 "-smbios type=3[,manufacturer=str][,version=str][,serial=str][,asset=str]\n" 2151 " [,sku=str]\n" 2152 " specify SMBIOS type 3 fields\n" 2153 "-smbios type=4[,sock_pfx=str][,manufacturer=str][,version=str][,serial=str]\n" 2154 " [,asset=str][,part=str]\n" 2155 " specify SMBIOS type 4 fields\n" 2156 "-smbios type=17[,loc_pfx=str][,bank=str][,manufacturer=str][,serial=str]\n" 2157 " [,asset=str][,part=str][,speed=%d]\n" 2158 " specify SMBIOS type 17 fields\n", 2159 QEMU_ARCH_I386 | QEMU_ARCH_ARM) 2160STEXI 2161@item -smbios file=@var{binary} 2162@findex -smbios 2163Load SMBIOS entry from binary file. 2164 2165@item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}][,uefi=on|off] 2166Specify SMBIOS type 0 fields 2167 2168@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}] 2169Specify SMBIOS type 1 fields 2170 2171@item -smbios type=2[,manufacturer=@var{str}][,product=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,location=@var{str}] 2172Specify SMBIOS type 2 fields 2173 2174@item -smbios type=3[,manufacturer=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,sku=@var{str}] 2175Specify SMBIOS type 3 fields 2176 2177@item -smbios type=4[,sock_pfx=@var{str}][,manufacturer=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,part=@var{str}] 2178Specify SMBIOS type 4 fields 2179 2180@item -smbios type=17[,loc_pfx=@var{str}][,bank=@var{str}][,manufacturer=@var{str}][,serial=@var{str}][,asset=@var{str}][,part=@var{str}][,speed=@var{%d}] 2181Specify SMBIOS type 17 fields 2182ETEXI 2183 2184STEXI 2185@end table 2186ETEXI 2187DEFHEADING() 2188 2189DEFHEADING(Network options:) 2190STEXI 2191@table @option 2192ETEXI 2193 2194DEF("netdev", HAS_ARG, QEMU_OPTION_netdev, 2195#ifdef CONFIG_SLIRP 2196 "-netdev user,id=str[,ipv4[=on|off]][,net=addr[/mask]][,host=addr]\n" 2197 " [,ipv6[=on|off]][,ipv6-net=addr[/int]][,ipv6-host=addr]\n" 2198 " [,restrict=on|off][,hostname=host][,dhcpstart=addr]\n" 2199 " [,dns=addr][,ipv6-dns=addr][,dnssearch=domain][,domainname=domain]\n" 2200 " [,tftp=dir][,tftp-server-name=name][,bootfile=f][,hostfwd=rule][,guestfwd=rule]" 2201#ifndef _WIN32 2202 "[,smb=dir[,smbserver=addr]]\n" 2203#endif 2204 " configure a user mode network backend with ID 'str',\n" 2205 " its DHCP server and optional services\n" 2206#endif 2207#ifdef _WIN32 2208 "-netdev tap,id=str,ifname=name\n" 2209 " configure a host TAP network backend with ID 'str'\n" 2210#else 2211 "-netdev tap,id=str[,fd=h][,fds=x:y:...:z][,ifname=name][,script=file][,downscript=dfile]\n" 2212 " [,br=bridge][,helper=helper][,sndbuf=nbytes][,vnet_hdr=on|off][,vhost=on|off]\n" 2213 " [,vhostfd=h][,vhostfds=x:y:...:z][,vhostforce=on|off][,queues=n]\n" 2214 " [,poll-us=n]\n" 2215 " configure a host TAP network backend with ID 'str'\n" 2216 " connected to a bridge (default=" DEFAULT_BRIDGE_INTERFACE ")\n" 2217 " use network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n" 2218 " to configure it and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n" 2219 " to deconfigure it\n" 2220 " use '[down]script=no' to disable script execution\n" 2221 " use network helper 'helper' (default=" DEFAULT_BRIDGE_HELPER ") to\n" 2222 " configure it\n" 2223 " use 'fd=h' to connect to an already opened TAP interface\n" 2224 " use 'fds=x:y:...:z' to connect to already opened multiqueue capable TAP interfaces\n" 2225 " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n" 2226 " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n" 2227 " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n" 2228 " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n" 2229 " use vhost=on to enable experimental in kernel accelerator\n" 2230 " (only has effect for virtio guests which use MSIX)\n" 2231 " use vhostforce=on to force vhost on for non-MSIX virtio guests\n" 2232 " use 'vhostfd=h' to connect to an already opened vhost net device\n" 2233 " use 'vhostfds=x:y:...:z to connect to multiple already opened vhost net devices\n" 2234 " use 'queues=n' to specify the number of queues to be created for multiqueue TAP\n" 2235 " use 'poll-us=n' to speciy the maximum number of microseconds that could be\n" 2236 " spent on busy polling for vhost net\n" 2237 "-netdev bridge,id=str[,br=bridge][,helper=helper]\n" 2238 " configure a host TAP network backend with ID 'str' that is\n" 2239 " connected to a bridge (default=" DEFAULT_BRIDGE_INTERFACE ")\n" 2240 " using the program 'helper (default=" DEFAULT_BRIDGE_HELPER ")\n" 2241#endif 2242#ifdef __linux__ 2243 "-netdev l2tpv3,id=str,src=srcaddr,dst=dstaddr[,srcport=srcport][,dstport=dstport]\n" 2244 " [,rxsession=rxsession],txsession=txsession[,ipv6=on/off][,udp=on/off]\n" 2245 " [,cookie64=on/off][,counter][,pincounter][,txcookie=txcookie]\n" 2246 " [,rxcookie=rxcookie][,offset=offset]\n" 2247 " configure a network backend with ID 'str' connected to\n" 2248 " an Ethernet over L2TPv3 pseudowire.\n" 2249 " Linux kernel 3.3+ as well as most routers can talk\n" 2250 " L2TPv3. This transport allows connecting a VM to a VM,\n" 2251 " VM to a router and even VM to Host. It is a nearly-universal\n" 2252 " standard (RFC3391). Note - this implementation uses static\n" 2253 " pre-configured tunnels (same as the Linux kernel).\n" 2254 " use 'src=' to specify source address\n" 2255 " use 'dst=' to specify destination address\n" 2256 " use 'udp=on' to specify udp encapsulation\n" 2257 " use 'srcport=' to specify source udp port\n" 2258 " use 'dstport=' to specify destination udp port\n" 2259 " use 'ipv6=on' to force v6\n" 2260 " L2TPv3 uses cookies to prevent misconfiguration as\n" 2261 " well as a weak security measure\n" 2262 " use 'rxcookie=0x012345678' to specify a rxcookie\n" 2263 " use 'txcookie=0x012345678' to specify a txcookie\n" 2264 " use 'cookie64=on' to set cookie size to 64 bit, otherwise 32\n" 2265 " use 'counter=off' to force a 'cut-down' L2TPv3 with no counter\n" 2266 " use 'pincounter=on' to work around broken counter handling in peer\n" 2267 " use 'offset=X' to add an extra offset between header and data\n" 2268#endif 2269 "-netdev socket,id=str[,fd=h][,listen=[host]:port][,connect=host:port]\n" 2270 " configure a network backend to connect to another network\n" 2271 " using a socket connection\n" 2272 "-netdev socket,id=str[,fd=h][,mcast=maddr:port[,localaddr=addr]]\n" 2273 " configure a network backend to connect to a multicast maddr and port\n" 2274 " use 'localaddr=addr' to specify the host address to send packets from\n" 2275 "-netdev socket,id=str[,fd=h][,udp=host:port][,localaddr=host:port]\n" 2276 " configure a network backend to connect to another network\n" 2277 " using an UDP tunnel\n" 2278#ifdef CONFIG_VDE 2279 "-netdev vde,id=str[,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n" 2280 " configure a network backend to connect to port 'n' of a vde switch\n" 2281 " running on host and listening for incoming connections on 'socketpath'.\n" 2282 " Use group 'groupname' and mode 'octalmode' to change default\n" 2283 " ownership and permissions for communication port.\n" 2284#endif 2285#ifdef CONFIG_NETMAP 2286 "-netdev netmap,id=str,ifname=name[,devname=nmname]\n" 2287 " attach to the existing netmap-enabled network interface 'name', or to a\n" 2288 " VALE port (created on the fly) called 'name' ('nmname' is name of the \n" 2289 " netmap device, defaults to '/dev/netmap')\n" 2290#endif 2291#ifdef CONFIG_POSIX 2292 "-netdev vhost-user,id=str,chardev=dev[,vhostforce=on|off]\n" 2293 " configure a vhost-user network, backed by a chardev 'dev'\n" 2294#endif 2295 "-netdev hubport,id=str,hubid=n[,netdev=nd]\n" 2296 " configure a hub port on the hub with ID 'n'\n", QEMU_ARCH_ALL) 2297DEF("nic", HAS_ARG, QEMU_OPTION_nic, 2298 "-nic [tap|bridge|" 2299#ifdef CONFIG_SLIRP 2300 "user|" 2301#endif 2302#ifdef __linux__ 2303 "l2tpv3|" 2304#endif 2305#ifdef CONFIG_VDE 2306 "vde|" 2307#endif 2308#ifdef CONFIG_NETMAP 2309 "netmap|" 2310#endif 2311#ifdef CONFIG_POSIX 2312 "vhost-user|" 2313#endif 2314 "socket][,option][,...][mac=macaddr]\n" 2315 " initialize an on-board / default host NIC (using MAC address\n" 2316 " macaddr) and connect it to the given host network backend\n" 2317 "-nic none use it alone to have zero network devices (the default is to\n" 2318 " provided a 'user' network connection)\n", 2319 QEMU_ARCH_ALL) 2320DEF("net", HAS_ARG, QEMU_OPTION_net, 2321 "-net nic[,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" 2322 " configure or create an on-board (or machine default) NIC and\n" 2323 " connect it to hub 0 (please use -nic unless you need a hub)\n" 2324 "-net [" 2325#ifdef CONFIG_SLIRP 2326 "user|" 2327#endif 2328 "tap|" 2329 "bridge|" 2330#ifdef CONFIG_VDE 2331 "vde|" 2332#endif 2333#ifdef CONFIG_NETMAP 2334 "netmap|" 2335#endif 2336 "socket][,option][,option][,...]\n" 2337 " old way to initialize a host network interface\n" 2338 " (use the -netdev option if possible instead)\n", QEMU_ARCH_ALL) 2339STEXI 2340@item -nic [tap|bridge|user|l2tpv3|vde|netmap|vhost-user|socket][,...][,mac=macaddr][,model=mn] 2341@findex -nic 2342This option is a shortcut for configuring both the on-board (default) guest 2343NIC hardware and the host network backend in one go. The host backend options 2344are the same as with the corresponding @option{-netdev} options below. 2345The guest NIC model can be set with @option{model=@var{modelname}}. 2346Use @option{model=help} to list the available device types. 2347The hardware MAC address can be set with @option{mac=@var{macaddr}}. 2348 2349The following two example do exactly the same, to show how @option{-nic} can 2350be used to shorten the command line length (note that the e1000 is the default 2351on i386, so the @option{model=e1000} parameter could even be omitted here, too): 2352@example 2353@value{qemu_system} -netdev user,id=n1,ipv6=off -device e1000,netdev=n1,mac=52:54:98:76:54:32 2354@value{qemu_system} -nic user,ipv6=off,model=e1000,mac=52:54:98:76:54:32 2355@end example 2356 2357@item -nic none 2358Indicate that no network devices should be configured. It is used to override 2359the default configuration (default NIC with ``user'' host network backend) 2360which is activated if no other networking options are provided. 2361 2362@item -netdev user,id=@var{id}[,@var{option}][,@var{option}][,...] 2363@findex -netdev 2364Configure user mode host network backend which requires no administrator 2365privilege to run. Valid options are: 2366 2367@table @option 2368@item id=@var{id} 2369Assign symbolic name for use in monitor commands. 2370 2371@item ipv4=on|off and ipv6=on|off 2372Specify that either IPv4 or IPv6 must be enabled. If neither is specified 2373both protocols are enabled. 2374 2375@item net=@var{addr}[/@var{mask}] 2376Set IP network address the guest will see. Optionally specify the netmask, 2377either in the form a.b.c.d or as number of valid top-most bits. Default is 237810.0.2.0/24. 2379 2380@item host=@var{addr} 2381Specify the guest-visible address of the host. Default is the 2nd IP in the 2382guest network, i.e. x.x.x.2. 2383 2384@item ipv6-net=@var{addr}[/@var{int}] 2385Set IPv6 network address the guest will see (default is fec0::/64). The 2386network prefix is given in the usual hexadecimal IPv6 address 2387notation. The prefix size is optional, and is given as the number of 2388valid top-most bits (default is 64). 2389 2390@item ipv6-host=@var{addr} 2391Specify the guest-visible IPv6 address of the host. Default is the 2nd IPv6 in 2392the guest network, i.e. xxxx::2. 2393 2394@item restrict=on|off 2395If this option is enabled, the guest will be isolated, i.e. it will not be 2396able to contact the host and no guest IP packets will be routed over the host 2397to the outside. This option does not affect any explicitly set forwarding rules. 2398 2399@item hostname=@var{name} 2400Specifies the client hostname reported by the built-in DHCP server. 2401 2402@item dhcpstart=@var{addr} 2403Specify the first of the 16 IPs the built-in DHCP server can assign. Default 2404is the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31. 2405 2406@item dns=@var{addr} 2407Specify the guest-visible address of the virtual nameserver. The address must 2408be different from the host address. Default is the 3rd IP in the guest network, 2409i.e. x.x.x.3. 2410 2411@item ipv6-dns=@var{addr} 2412Specify the guest-visible address of the IPv6 virtual nameserver. The address 2413must be different from the host address. Default is the 3rd IP in the guest 2414network, i.e. xxxx::3. 2415 2416@item dnssearch=@var{domain} 2417Provides an entry for the domain-search list sent by the built-in 2418DHCP server. More than one domain suffix can be transmitted by specifying 2419this option multiple times. If supported, this will cause the guest to 2420automatically try to append the given domain suffix(es) in case a domain name 2421can not be resolved. 2422 2423Example: 2424@example 2425@value{qemu_system} -nic user,dnssearch=mgmt.example.org,dnssearch=example.org 2426@end example 2427 2428@item domainname=@var{domain} 2429Specifies the client domain name reported by the built-in DHCP server. 2430 2431@item tftp=@var{dir} 2432When using the user mode network stack, activate a built-in TFTP 2433server. The files in @var{dir} will be exposed as the root of a TFTP server. 2434The TFTP client on the guest must be configured in binary mode (use the command 2435@code{bin} of the Unix TFTP client). 2436 2437@item tftp-server-name=@var{name} 2438In BOOTP reply, broadcast @var{name} as the "TFTP server name" (RFC2132 option 243966). This can be used to advise the guest to load boot files or configurations 2440from a different server than the host address. 2441 2442@item bootfile=@var{file} 2443When using the user mode network stack, broadcast @var{file} as the BOOTP 2444filename. In conjunction with @option{tftp}, this can be used to network boot 2445a guest from a local directory. 2446 2447Example (using pxelinux): 2448@example 2449@value{qemu_system} -hda linux.img -boot n -device e1000,netdev=n1 \ 2450 -netdev user,id=n1,tftp=/path/to/tftp/files,bootfile=/pxelinux.0 2451@end example 2452 2453@item smb=@var{dir}[,smbserver=@var{addr}] 2454When using the user mode network stack, activate a built-in SMB 2455server so that Windows OSes can access to the host files in @file{@var{dir}} 2456transparently. The IP address of the SMB server can be set to @var{addr}. By 2457default the 4th IP in the guest network is used, i.e. x.x.x.4. 2458 2459In the guest Windows OS, the line: 2460@example 246110.0.2.4 smbserver 2462@end example 2463must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me) 2464or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000). 2465 2466Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}. 2467 2468Note that a SAMBA server must be installed on the host OS. 2469 2470@item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport} 2471Redirect incoming TCP or UDP connections to the host port @var{hostport} to 2472the guest IP address @var{guestaddr} on guest port @var{guestport}. If 2473@var{guestaddr} is not specified, its value is x.x.x.15 (default first address 2474given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can 2475be bound to a specific host interface. If no connection type is set, TCP is 2476used. This option can be given multiple times. 2477 2478For example, to redirect host X11 connection from screen 1 to guest 2479screen 0, use the following: 2480 2481@example 2482# on the host 2483@value{qemu_system} -nic user,hostfwd=tcp:127.0.0.1:6001-:6000 2484# this host xterm should open in the guest X11 server 2485xterm -display :1 2486@end example 2487 2488To redirect telnet connections from host port 5555 to telnet port on 2489the guest, use the following: 2490 2491@example 2492# on the host 2493@value{qemu_system} -nic user,hostfwd=tcp::5555-:23 2494telnet localhost 5555 2495@end example 2496 2497Then when you use on the host @code{telnet localhost 5555}, you 2498connect to the guest telnet server. 2499 2500@item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev} 2501@itemx guestfwd=[tcp]:@var{server}:@var{port}-@var{cmd:command} 2502Forward guest TCP connections to the IP address @var{server} on port @var{port} 2503to the character device @var{dev} or to a program executed by @var{cmd:command} 2504which gets spawned for each connection. This option can be given multiple times. 2505 2506You can either use a chardev directly and have that one used throughout QEMU's 2507lifetime, like in the following example: 2508 2509@example 2510# open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it whenever 2511# the guest accesses it 2512@value{qemu_system} -nic user,guestfwd=tcp:10.0.2.100:1234-tcp:10.10.1.1:4321 2513@end example 2514 2515Or you can execute a command on every TCP connection established by the guest, 2516so that QEMU behaves similar to an inetd process for that virtual server: 2517 2518@example 2519# call "netcat 10.10.1.1 4321" on every TCP connection to 10.0.2.100:1234 2520# and connect the TCP stream to its stdin/stdout 2521@value{qemu_system} -nic 'user,id=n1,guestfwd=tcp:10.0.2.100:1234-cmd:netcat 10.10.1.1 4321' 2522@end example 2523 2524@end table 2525 2526@item -netdev tap,id=@var{id}[,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,br=@var{bridge}][,helper=@var{helper}] 2527Configure a host TAP network backend with ID @var{id}. 2528 2529Use the network script @var{file} to configure it and the network script 2530@var{dfile} to deconfigure it. If @var{name} is not provided, the OS 2531automatically provides one. The default network configure script is 2532@file{/etc/qemu-ifup} and the default network deconfigure script is 2533@file{/etc/qemu-ifdown}. Use @option{script=no} or @option{downscript=no} 2534to disable script execution. 2535 2536If running QEMU as an unprivileged user, use the network helper 2537@var{helper} to configure the TAP interface and attach it to the bridge. 2538The default network helper executable is @file{/path/to/qemu-bridge-helper} 2539and the default bridge device is @file{br0}. 2540 2541@option{fd}=@var{h} can be used to specify the handle of an already 2542opened host TAP interface. 2543 2544Examples: 2545 2546@example 2547#launch a QEMU instance with the default network script 2548@value{qemu_system} linux.img -nic tap 2549@end example 2550 2551@example 2552#launch a QEMU instance with two NICs, each one connected 2553#to a TAP device 2554@value{qemu_system} linux.img \ 2555 -netdev tap,id=nd0,ifname=tap0 -device e1000,netdev=nd0 \ 2556 -netdev tap,id=nd1,ifname=tap1 -device rtl8139,netdev=nd1 2557@end example 2558 2559@example 2560#launch a QEMU instance with the default network helper to 2561#connect a TAP device to bridge br0 2562@value{qemu_system} linux.img -device virtio-net-pci,netdev=n1 \ 2563 -netdev tap,id=n1,"helper=/path/to/qemu-bridge-helper" 2564@end example 2565 2566@item -netdev bridge,id=@var{id}[,br=@var{bridge}][,helper=@var{helper}] 2567Connect a host TAP network interface to a host bridge device. 2568 2569Use the network helper @var{helper} to configure the TAP interface and 2570attach it to the bridge. The default network helper executable is 2571@file{/path/to/qemu-bridge-helper} and the default bridge 2572device is @file{br0}. 2573 2574Examples: 2575 2576@example 2577#launch a QEMU instance with the default network helper to 2578#connect a TAP device to bridge br0 2579@value{qemu_system} linux.img -netdev bridge,id=n1 -device virtio-net,netdev=n1 2580@end example 2581 2582@example 2583#launch a QEMU instance with the default network helper to 2584#connect a TAP device to bridge qemubr0 2585@value{qemu_system} linux.img -netdev bridge,br=qemubr0,id=n1 -device virtio-net,netdev=n1 2586@end example 2587 2588@item -netdev socket,id=@var{id}[,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 2589 2590This host network backend can be used to connect the guest's network to 2591another QEMU virtual machine using a TCP socket connection. If @option{listen} 2592is specified, QEMU waits for incoming connections on @var{port} 2593(@var{host} is optional). @option{connect} is used to connect to 2594another QEMU instance using the @option{listen} option. @option{fd}=@var{h} 2595specifies an already opened TCP socket. 2596 2597Example: 2598@example 2599# launch a first QEMU instance 2600@value{qemu_system} linux.img \ 2601 -device e1000,netdev=n1,mac=52:54:00:12:34:56 \ 2602 -netdev socket,id=n1,listen=:1234 2603# connect the network of this instance to the network of the first instance 2604@value{qemu_system} linux.img \ 2605 -device e1000,netdev=n2,mac=52:54:00:12:34:57 \ 2606 -netdev socket,id=n2,connect=127.0.0.1:1234 2607@end example 2608 2609@item -netdev socket,id=@var{id}[,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] 2610 2611Configure a socket host network backend to share the guest's network traffic 2612with another QEMU virtual machines using a UDP multicast socket, effectively 2613making a bus for every QEMU with same multicast address @var{maddr} and @var{port}. 2614NOTES: 2615@enumerate 2616@item 2617Several QEMU can be running on different hosts and share same bus (assuming 2618correct multicast setup for these hosts). 2619@item 2620mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see 2621@url{http://user-mode-linux.sf.net}. 2622@item 2623Use @option{fd=h} to specify an already opened UDP multicast socket. 2624@end enumerate 2625 2626Example: 2627@example 2628# launch one QEMU instance 2629@value{qemu_system} linux.img \ 2630 -device e1000,netdev=n1,mac=52:54:00:12:34:56 \ 2631 -netdev socket,id=n1,mcast=230.0.0.1:1234 2632# launch another QEMU instance on same "bus" 2633@value{qemu_system} linux.img \ 2634 -device e1000,netdev=n2,mac=52:54:00:12:34:57 \ 2635 -netdev socket,id=n2,mcast=230.0.0.1:1234 2636# launch yet another QEMU instance on same "bus" 2637@value{qemu_system} linux.img \ 2638 -device e1000,netdev=n3,mac=52:54:00:12:34:58 \ 2639 -netdev socket,id=n3,mcast=230.0.0.1:1234 2640@end example 2641 2642Example (User Mode Linux compat.): 2643@example 2644# launch QEMU instance (note mcast address selected is UML's default) 2645@value{qemu_system} linux.img \ 2646 -device e1000,netdev=n1,mac=52:54:00:12:34:56 \ 2647 -netdev socket,id=n1,mcast=239.192.168.1:1102 2648# launch UML 2649/path/to/linux ubd0=/path/to/root_fs eth0=mcast 2650@end example 2651 2652Example (send packets from host's 1.2.3.4): 2653@example 2654@value{qemu_system} linux.img \ 2655 -device e1000,netdev=n1,mac=52:54:00:12:34:56 \ 2656 -netdev socket,id=n1,mcast=239.192.168.1:1102,localaddr=1.2.3.4 2657@end example 2658 2659@item -netdev l2tpv3,id=@var{id},src=@var{srcaddr},dst=@var{dstaddr}[,srcport=@var{srcport}][,dstport=@var{dstport}],txsession=@var{txsession}[,rxsession=@var{rxsession}][,ipv6][,udp][,cookie64][,counter][,pincounter][,txcookie=@var{txcookie}][,rxcookie=@var{rxcookie}][,offset=@var{offset}] 2660Configure a L2TPv3 pseudowire host network backend. L2TPv3 (RFC3391) is a 2661popular protocol to transport Ethernet (and other Layer 2) data frames between 2662two systems. It is present in routers, firewalls and the Linux kernel 2663(from version 3.3 onwards). 2664 2665This transport allows a VM to communicate to another VM, router or firewall directly. 2666 2667@table @option 2668@item src=@var{srcaddr} 2669 source address (mandatory) 2670@item dst=@var{dstaddr} 2671 destination address (mandatory) 2672@item udp 2673 select udp encapsulation (default is ip). 2674@item srcport=@var{srcport} 2675 source udp port. 2676@item dstport=@var{dstport} 2677 destination udp port. 2678@item ipv6 2679 force v6, otherwise defaults to v4. 2680@item rxcookie=@var{rxcookie} 2681@itemx txcookie=@var{txcookie} 2682 Cookies are a weak form of security in the l2tpv3 specification. 2683Their function is mostly to prevent misconfiguration. By default they are 32 2684bit. 2685@item cookie64 2686 Set cookie size to 64 bit instead of the default 32 2687@item counter=off 2688 Force a 'cut-down' L2TPv3 with no counter as in 2689draft-mkonstan-l2tpext-keyed-ipv6-tunnel-00 2690@item pincounter=on 2691 Work around broken counter handling in peer. This may also help on 2692networks which have packet reorder. 2693@item offset=@var{offset} 2694 Add an extra offset between header and data 2695@end table 2696 2697For example, to attach a VM running on host 4.3.2.1 via L2TPv3 to the bridge br-lan 2698on the remote Linux host 1.2.3.4: 2699@example 2700# Setup tunnel on linux host using raw ip as encapsulation 2701# on 1.2.3.4 2702ip l2tp add tunnel remote 4.3.2.1 local 1.2.3.4 tunnel_id 1 peer_tunnel_id 1 \ 2703 encap udp udp_sport 16384 udp_dport 16384 2704ip l2tp add session tunnel_id 1 name vmtunnel0 session_id \ 2705 0xFFFFFFFF peer_session_id 0xFFFFFFFF 2706ifconfig vmtunnel0 mtu 1500 2707ifconfig vmtunnel0 up 2708brctl addif br-lan vmtunnel0 2709 2710 2711# on 4.3.2.1 2712# launch QEMU instance - if your network has reorder or is very lossy add ,pincounter 2713 2714@value{qemu_system} linux.img -device e1000,netdev=n1 \ 2715 -netdev l2tpv3,id=n1,src=4.2.3.1,dst=1.2.3.4,udp,srcport=16384,dstport=16384,rxsession=0xffffffff,txsession=0xffffffff,counter 2716 2717@end example 2718 2719@item -netdev vde,id=@var{id}[,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 2720Configure VDE backend to connect to PORT @var{n} of a vde switch running on host and 2721listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname} 2722and MODE @var{octalmode} to change default ownership and permissions for 2723communication port. This option is only available if QEMU has been compiled 2724with vde support enabled. 2725 2726Example: 2727@example 2728# launch vde switch 2729vde_switch -F -sock /tmp/myswitch 2730# launch QEMU instance 2731@value{qemu_system} linux.img -nic vde,sock=/tmp/myswitch 2732@end example 2733 2734@item -netdev vhost-user,chardev=@var{id}[,vhostforce=on|off][,queues=n] 2735 2736Establish a vhost-user netdev, backed by a chardev @var{id}. The chardev should 2737be a unix domain socket backed one. The vhost-user uses a specifically defined 2738protocol to pass vhost ioctl replacement messages to an application on the other 2739end of the socket. On non-MSIX guests, the feature can be forced with 2740@var{vhostforce}. Use 'queues=@var{n}' to specify the number of queues to 2741be created for multiqueue vhost-user. 2742 2743Example: 2744@example 2745qemu -m 512 -object memory-backend-file,id=mem,size=512M,mem-path=/hugetlbfs,share=on \ 2746 -numa node,memdev=mem \ 2747 -chardev socket,id=chr0,path=/path/to/socket \ 2748 -netdev type=vhost-user,id=net0,chardev=chr0 \ 2749 -device virtio-net-pci,netdev=net0 2750@end example 2751 2752@item -netdev hubport,id=@var{id},hubid=@var{hubid}[,netdev=@var{nd}] 2753 2754Create a hub port on the emulated hub with ID @var{hubid}. 2755 2756The hubport netdev lets you connect a NIC to a QEMU emulated hub instead of a 2757single netdev. Alternatively, you can also connect the hubport to another 2758netdev with ID @var{nd} by using the @option{netdev=@var{nd}} option. 2759 2760@item -net nic[,netdev=@var{nd}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}] 2761@findex -net 2762Legacy option to configure or create an on-board (or machine default) Network 2763Interface Card(NIC) and connect it either to the emulated hub with ID 0 (i.e. 2764the default hub), or to the netdev @var{nd}. 2765The NIC is an e1000 by default on the PC target. Optionally, the MAC address 2766can be changed to @var{mac}, the device address set to @var{addr} (PCI cards 2767only), and a @var{name} can be assigned for use in monitor commands. 2768Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors 2769that the card should have; this option currently only affects virtio cards; set 2770@var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single 2771NIC is created. QEMU can emulate several different models of network card. 2772Use @code{-net nic,model=help} for a list of available devices for your target. 2773 2774@item -net user|tap|bridge|socket|l2tpv3|vde[,...][,name=@var{name}] 2775Configure a host network backend (with the options corresponding to the same 2776@option{-netdev} option) and connect it to the emulated hub 0 (the default 2777hub). Use @var{name} to specify the name of the hub port. 2778ETEXI 2779 2780STEXI 2781@end table 2782ETEXI 2783DEFHEADING() 2784 2785DEFHEADING(Character device options:) 2786 2787DEF("chardev", HAS_ARG, QEMU_OPTION_chardev, 2788 "-chardev help\n" 2789 "-chardev null,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2790 "-chardev socket,id=id[,host=host],port=port[,to=to][,ipv4][,ipv6][,nodelay][,reconnect=seconds]\n" 2791 " [,server][,nowait][,telnet][,websocket][,reconnect=seconds][,mux=on|off]\n" 2792 " [,logfile=PATH][,logappend=on|off][,tls-creds=ID][,tls-authz=ID] (tcp)\n" 2793 "-chardev socket,id=id,path=path[,server][,nowait][,telnet][,websocket][,reconnect=seconds]\n" 2794 " [,mux=on|off][,logfile=PATH][,logappend=on|off] (unix)\n" 2795 "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n" 2796 " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n" 2797 " [,logfile=PATH][,logappend=on|off]\n" 2798 "-chardev msmouse,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2799 "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n" 2800 " [,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2801 "-chardev ringbuf,id=id[,size=size][,logfile=PATH][,logappend=on|off]\n" 2802 "-chardev file,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2803 "-chardev pipe,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2804#ifdef _WIN32 2805 "-chardev console,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2806 "-chardev serial,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2807#else 2808 "-chardev pty,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2809 "-chardev stdio,id=id[,mux=on|off][,signal=on|off][,logfile=PATH][,logappend=on|off]\n" 2810#endif 2811#ifdef CONFIG_BRLAPI 2812 "-chardev braille,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2813#endif 2814#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \ 2815 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) 2816 "-chardev serial,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2817 "-chardev tty,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2818#endif 2819#if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__) 2820 "-chardev parallel,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2821 "-chardev parport,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2822#endif 2823#if defined(CONFIG_SPICE) 2824 "-chardev spicevmc,id=id,name=name[,debug=debug][,logfile=PATH][,logappend=on|off]\n" 2825 "-chardev spiceport,id=id,name=name[,debug=debug][,logfile=PATH][,logappend=on|off]\n" 2826#endif 2827 , QEMU_ARCH_ALL 2828) 2829 2830STEXI 2831 2832The general form of a character device option is: 2833@table @option 2834@item -chardev @var{backend},id=@var{id}[,mux=on|off][,@var{options}] 2835@findex -chardev 2836Backend is one of: 2837@option{null}, 2838@option{socket}, 2839@option{udp}, 2840@option{msmouse}, 2841@option{vc}, 2842@option{ringbuf}, 2843@option{file}, 2844@option{pipe}, 2845@option{console}, 2846@option{serial}, 2847@option{pty}, 2848@option{stdio}, 2849@option{braille}, 2850@option{tty}, 2851@option{parallel}, 2852@option{parport}, 2853@option{spicevmc}, 2854@option{spiceport}. 2855The specific backend will determine the applicable options. 2856 2857Use @code{-chardev help} to print all available chardev backend types. 2858 2859All devices must have an id, which can be any string up to 127 characters long. 2860It is used to uniquely identify this device in other command line directives. 2861 2862A character device may be used in multiplexing mode by multiple front-ends. 2863Specify @option{mux=on} to enable this mode. 2864A multiplexer is a "1:N" device, and here the "1" end is your specified chardev 2865backend, and the "N" end is the various parts of QEMU that can talk to a chardev. 2866If you create a chardev with @option{id=myid} and @option{mux=on}, QEMU will 2867create a multiplexer with your specified ID, and you can then configure multiple 2868front ends to use that chardev ID for their input/output. Up to four different 2869front ends can be connected to a single multiplexed chardev. (Without 2870multiplexing enabled, a chardev can only be used by a single front end.) 2871For instance you could use this to allow a single stdio chardev to be used by 2872two serial ports and the QEMU monitor: 2873 2874@example 2875-chardev stdio,mux=on,id=char0 \ 2876-mon chardev=char0,mode=readline \ 2877-serial chardev:char0 \ 2878-serial chardev:char0 2879@end example 2880 2881You can have more than one multiplexer in a system configuration; for instance 2882you could have a TCP port multiplexed between UART 0 and UART 1, and stdio 2883multiplexed between the QEMU monitor and a parallel port: 2884 2885@example 2886-chardev stdio,mux=on,id=char0 \ 2887-mon chardev=char0,mode=readline \ 2888-parallel chardev:char0 \ 2889-chardev tcp,...,mux=on,id=char1 \ 2890-serial chardev:char1 \ 2891-serial chardev:char1 2892@end example 2893 2894When you're using a multiplexed character device, some escape sequences are 2895interpreted in the input. @xref{mux_keys, Keys in the character backend 2896multiplexer}. 2897 2898Note that some other command line options may implicitly create multiplexed 2899character backends; for instance @option{-serial mon:stdio} creates a 2900multiplexed stdio backend connected to the serial port and the QEMU monitor, 2901and @option{-nographic} also multiplexes the console and the monitor to 2902stdio. 2903 2904There is currently no support for multiplexing in the other direction 2905(where a single QEMU front end takes input and output from multiple chardevs). 2906 2907Every backend supports the @option{logfile} option, which supplies the path 2908to a file to record all data transmitted via the backend. The @option{logappend} 2909option controls whether the log file will be truncated or appended to when 2910opened. 2911 2912@end table 2913 2914The available backends are: 2915 2916@table @option 2917@item -chardev null,id=@var{id} 2918A void device. This device will not emit any data, and will drop any data it 2919receives. The null backend does not take any options. 2920 2921@item -chardev socket,id=@var{id}[,@var{TCP options} or @var{unix options}][,server][,nowait][,telnet][,websocket][,reconnect=@var{seconds}][,tls-creds=@var{id}][,tls-authz=@var{id}] 2922 2923Create a two-way stream socket, which can be either a TCP or a unix socket. A 2924unix socket will be created if @option{path} is specified. Behaviour is 2925undefined if TCP options are specified for a unix socket. 2926 2927@option{server} specifies that the socket shall be a listening socket. 2928 2929@option{nowait} specifies that QEMU should not block waiting for a client to 2930connect to a listening socket. 2931 2932@option{telnet} specifies that traffic on the socket should interpret telnet 2933escape sequences. 2934 2935@option{websocket} specifies that the socket uses WebSocket protocol for 2936communication. 2937 2938@option{reconnect} sets the timeout for reconnecting on non-server sockets when 2939the remote end goes away. qemu will delay this many seconds and then attempt 2940to reconnect. Zero disables reconnecting, and is the default. 2941 2942@option{tls-creds} requests enablement of the TLS protocol for encryption, 2943and specifies the id of the TLS credentials to use for the handshake. The 2944credentials must be previously created with the @option{-object tls-creds} 2945argument. 2946 2947@option{tls-auth} provides the ID of the QAuthZ authorization object against 2948which the client's x509 distinguished name will be validated. This object is 2949only resolved at time of use, so can be deleted and recreated on the fly 2950while the chardev server is active. If missing, it will default to denying 2951access. 2952 2953TCP and unix socket options are given below: 2954 2955@table @option 2956 2957@item TCP options: port=@var{port}[,host=@var{host}][,to=@var{to}][,ipv4][,ipv6][,nodelay] 2958 2959@option{host} for a listening socket specifies the local address to be bound. 2960For a connecting socket species the remote host to connect to. @option{host} is 2961optional for listening sockets. If not specified it defaults to @code{0.0.0.0}. 2962 2963@option{port} for a listening socket specifies the local port to be bound. For a 2964connecting socket specifies the port on the remote host to connect to. 2965@option{port} can be given as either a port number or a service name. 2966@option{port} is required. 2967 2968@option{to} is only relevant to listening sockets. If it is specified, and 2969@option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up 2970to and including @option{to} until it succeeds. @option{to} must be specified 2971as a port number. 2972 2973@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 2974If neither is specified the socket may use either protocol. 2975 2976@option{nodelay} disables the Nagle algorithm. 2977 2978@item unix options: path=@var{path} 2979 2980@option{path} specifies the local path of the unix socket. @option{path} is 2981required. 2982 2983@end table 2984 2985@item -chardev udp,id=@var{id}[,host=@var{host}],port=@var{port}[,localaddr=@var{localaddr}][,localport=@var{localport}][,ipv4][,ipv6] 2986 2987Sends all traffic from the guest to a remote host over UDP. 2988 2989@option{host} specifies the remote host to connect to. If not specified it 2990defaults to @code{localhost}. 2991 2992@option{port} specifies the port on the remote host to connect to. @option{port} 2993is required. 2994 2995@option{localaddr} specifies the local address to bind to. If not specified it 2996defaults to @code{0.0.0.0}. 2997 2998@option{localport} specifies the local port to bind to. If not specified any 2999available local port will be used. 3000 3001@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 3002If neither is specified the device may use either protocol. 3003 3004@item -chardev msmouse,id=@var{id} 3005 3006Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not 3007take any options. 3008 3009@item -chardev vc,id=@var{id}[[,width=@var{width}][,height=@var{height}]][[,cols=@var{cols}][,rows=@var{rows}]] 3010 3011Connect to a QEMU text console. @option{vc} may optionally be given a specific 3012size. 3013 3014@option{width} and @option{height} specify the width and height respectively of 3015the console, in pixels. 3016 3017@option{cols} and @option{rows} specify that the console be sized to fit a text 3018console with the given dimensions. 3019 3020@item -chardev ringbuf,id=@var{id}[,size=@var{size}] 3021 3022Create a ring buffer with fixed size @option{size}. 3023@var{size} must be a power of two and defaults to @code{64K}. 3024 3025@item -chardev file,id=@var{id},path=@var{path} 3026 3027Log all traffic received from the guest to a file. 3028 3029@option{path} specifies the path of the file to be opened. This file will be 3030created if it does not already exist, and overwritten if it does. @option{path} 3031is required. 3032 3033@item -chardev pipe,id=@var{id},path=@var{path} 3034 3035Create a two-way connection to the guest. The behaviour differs slightly between 3036Windows hosts and other hosts: 3037 3038On Windows, a single duplex pipe will be created at 3039@file{\\.pipe\@option{path}}. 3040 3041On other hosts, 2 pipes will be created called @file{@option{path}.in} and 3042@file{@option{path}.out}. Data written to @file{@option{path}.in} will be 3043received by the guest. Data written by the guest can be read from 3044@file{@option{path}.out}. QEMU will not create these fifos, and requires them to 3045be present. 3046 3047@option{path} forms part of the pipe path as described above. @option{path} is 3048required. 3049 3050@item -chardev console,id=@var{id} 3051 3052Send traffic from the guest to QEMU's standard output. @option{console} does not 3053take any options. 3054 3055@option{console} is only available on Windows hosts. 3056 3057@item -chardev serial,id=@var{id},path=@option{path} 3058 3059Send traffic from the guest to a serial device on the host. 3060 3061On Unix hosts serial will actually accept any tty device, 3062not only serial lines. 3063 3064@option{path} specifies the name of the serial device to open. 3065 3066@item -chardev pty,id=@var{id} 3067 3068Create a new pseudo-terminal on the host and connect to it. @option{pty} does 3069not take any options. 3070 3071@option{pty} is not available on Windows hosts. 3072 3073@item -chardev stdio,id=@var{id}[,signal=on|off] 3074Connect to standard input and standard output of the QEMU process. 3075 3076@option{signal} controls if signals are enabled on the terminal, that includes 3077exiting QEMU with the key sequence @key{Control-c}. This option is enabled by 3078default, use @option{signal=off} to disable it. 3079 3080@item -chardev braille,id=@var{id} 3081 3082Connect to a local BrlAPI server. @option{braille} does not take any options. 3083 3084@item -chardev tty,id=@var{id},path=@var{path} 3085 3086@option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and 3087DragonFlyBSD hosts. It is an alias for @option{serial}. 3088 3089@option{path} specifies the path to the tty. @option{path} is required. 3090 3091@item -chardev parallel,id=@var{id},path=@var{path} 3092@itemx -chardev parport,id=@var{id},path=@var{path} 3093 3094@option{parallel} is only available on Linux, FreeBSD and DragonFlyBSD hosts. 3095 3096Connect to a local parallel port. 3097 3098@option{path} specifies the path to the parallel port device. @option{path} is 3099required. 3100 3101@item -chardev spicevmc,id=@var{id},debug=@var{debug},name=@var{name} 3102 3103@option{spicevmc} is only available when spice support is built in. 3104 3105@option{debug} debug level for spicevmc 3106 3107@option{name} name of spice channel to connect to 3108 3109Connect to a spice virtual machine channel, such as vdiport. 3110 3111@item -chardev spiceport,id=@var{id},debug=@var{debug},name=@var{name} 3112 3113@option{spiceport} is only available when spice support is built in. 3114 3115@option{debug} debug level for spicevmc 3116 3117@option{name} name of spice port to connect to 3118 3119Connect to a spice port, allowing a Spice client to handle the traffic 3120identified by a name (preferably a fqdn). 3121ETEXI 3122 3123STEXI 3124@end table 3125ETEXI 3126DEFHEADING() 3127 3128DEFHEADING(Bluetooth(R) options:) 3129STEXI 3130@table @option 3131ETEXI 3132 3133DEF("bt", HAS_ARG, QEMU_OPTION_bt, \ 3134 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \ 3135 "-bt hci,host[:id]\n" \ 3136 " use host's HCI with the given name\n" \ 3137 "-bt hci[,vlan=n]\n" \ 3138 " emulate a standard HCI in virtual scatternet 'n'\n" \ 3139 "-bt vhci[,vlan=n]\n" \ 3140 " add host computer to virtual scatternet 'n' using VHCI\n" \ 3141 "-bt device:dev[,vlan=n]\n" \ 3142 " emulate a bluetooth device 'dev' in scatternet 'n'\n", 3143 QEMU_ARCH_ALL) 3144STEXI 3145@item -bt hci[...] 3146@findex -bt 3147Defines the function of the corresponding Bluetooth HCI. -bt options 3148are matched with the HCIs present in the chosen machine type. For 3149example when emulating a machine with only one HCI built into it, only 3150the first @code{-bt hci[...]} option is valid and defines the HCI's 3151logic. The Transport Layer is decided by the machine type. Currently 3152the machines @code{n800} and @code{n810} have one HCI and all other 3153machines have none. 3154 3155Note: This option and the whole bluetooth subsystem is considered as deprecated. 3156If you still use it, please send a mail to @email{qemu-devel@@nongnu.org} where 3157you describe your usecase. 3158 3159@anchor{bt-hcis} 3160The following three types are recognized: 3161 3162@table @option 3163@item -bt hci,null 3164(default) The corresponding Bluetooth HCI assumes no internal logic 3165and will not respond to any HCI commands or emit events. 3166 3167@item -bt hci,host[:@var{id}] 3168(@code{bluez} only) The corresponding HCI passes commands / events 3169to / from the physical HCI identified by the name @var{id} (default: 3170@code{hci0}) on the computer running QEMU. Only available on @code{bluez} 3171capable systems like Linux. 3172 3173@item -bt hci[,vlan=@var{n}] 3174Add a virtual, standard HCI that will participate in the Bluetooth 3175scatternet @var{n} (default @code{0}). Similarly to @option{-net} 3176VLANs, devices inside a bluetooth network @var{n} can only communicate 3177with other devices in the same network (scatternet). 3178@end table 3179 3180@item -bt vhci[,vlan=@var{n}] 3181(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached 3182to the host bluetooth stack instead of to the emulated target. This 3183allows the host and target machines to participate in a common scatternet 3184and communicate. Requires the Linux @code{vhci} driver installed. Can 3185be used as following: 3186 3187@example 3188@value{qemu_system} [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5 3189@end example 3190 3191@item -bt device:@var{dev}[,vlan=@var{n}] 3192Emulate a bluetooth device @var{dev} and place it in network @var{n} 3193(default @code{0}). QEMU can only emulate one type of bluetooth devices 3194currently: 3195 3196@table @option 3197@item keyboard 3198Virtual wireless keyboard implementing the HIDP bluetooth profile. 3199@end table 3200ETEXI 3201 3202STEXI 3203@end table 3204ETEXI 3205DEFHEADING() 3206 3207#ifdef CONFIG_TPM 3208DEFHEADING(TPM device options:) 3209 3210DEF("tpmdev", HAS_ARG, QEMU_OPTION_tpmdev, \ 3211 "-tpmdev passthrough,id=id[,path=path][,cancel-path=path]\n" 3212 " use path to provide path to a character device; default is /dev/tpm0\n" 3213 " use cancel-path to provide path to TPM's cancel sysfs entry; if\n" 3214 " not provided it will be searched for in /sys/class/misc/tpm?/device\n" 3215 "-tpmdev emulator,id=id,chardev=dev\n" 3216 " configure the TPM device using chardev backend\n", 3217 QEMU_ARCH_ALL) 3218STEXI 3219 3220The general form of a TPM device option is: 3221@table @option 3222 3223@item -tpmdev @var{backend},id=@var{id}[,@var{options}] 3224@findex -tpmdev 3225 3226The specific backend type will determine the applicable options. 3227The @code{-tpmdev} option creates the TPM backend and requires a 3228@code{-device} option that specifies the TPM frontend interface model. 3229 3230Use @code{-tpmdev help} to print all available TPM backend types. 3231 3232@end table 3233 3234The available backends are: 3235 3236@table @option 3237 3238@item -tpmdev passthrough,id=@var{id},path=@var{path},cancel-path=@var{cancel-path} 3239 3240(Linux-host only) Enable access to the host's TPM using the passthrough 3241driver. 3242 3243@option{path} specifies the path to the host's TPM device, i.e., on 3244a Linux host this would be @code{/dev/tpm0}. 3245@option{path} is optional and by default @code{/dev/tpm0} is used. 3246 3247@option{cancel-path} specifies the path to the host TPM device's sysfs 3248entry allowing for cancellation of an ongoing TPM command. 3249@option{cancel-path} is optional and by default QEMU will search for the 3250sysfs entry to use. 3251 3252Some notes about using the host's TPM with the passthrough driver: 3253 3254The TPM device accessed by the passthrough driver must not be 3255used by any other application on the host. 3256 3257Since the host's firmware (BIOS/UEFI) has already initialized the TPM, 3258the VM's firmware (BIOS/UEFI) will not be able to initialize the 3259TPM again and may therefore not show a TPM-specific menu that would 3260otherwise allow the user to configure the TPM, e.g., allow the user to 3261enable/disable or activate/deactivate the TPM. 3262Further, if TPM ownership is released from within a VM then the host's TPM 3263will get disabled and deactivated. To enable and activate the 3264TPM again afterwards, the host has to be rebooted and the user is 3265required to enter the firmware's menu to enable and activate the TPM. 3266If the TPM is left disabled and/or deactivated most TPM commands will fail. 3267 3268To create a passthrough TPM use the following two options: 3269@example 3270-tpmdev passthrough,id=tpm0 -device tpm-tis,tpmdev=tpm0 3271@end example 3272Note that the @code{-tpmdev} id is @code{tpm0} and is referenced by 3273@code{tpmdev=tpm0} in the device option. 3274 3275@item -tpmdev emulator,id=@var{id},chardev=@var{dev} 3276 3277(Linux-host only) Enable access to a TPM emulator using Unix domain socket based 3278chardev backend. 3279 3280@option{chardev} specifies the unique ID of a character device backend that provides connection to the software TPM server. 3281 3282To create a TPM emulator backend device with chardev socket backend: 3283@example 3284 3285-chardev socket,id=chrtpm,path=/tmp/swtpm-sock -tpmdev emulator,id=tpm0,chardev=chrtpm -device tpm-tis,tpmdev=tpm0 3286 3287@end example 3288 3289ETEXI 3290 3291STEXI 3292@end table 3293ETEXI 3294DEFHEADING() 3295 3296#endif 3297 3298DEFHEADING(Linux/Multiboot boot specific:) 3299STEXI 3300 3301When using these options, you can use a given Linux or Multiboot 3302kernel without installing it in the disk image. It can be useful 3303for easier testing of various kernels. 3304 3305@table @option 3306ETEXI 3307 3308DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \ 3309 "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL) 3310STEXI 3311@item -kernel @var{bzImage} 3312@findex -kernel 3313Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel 3314or in multiboot format. 3315ETEXI 3316 3317DEF("append", HAS_ARG, QEMU_OPTION_append, \ 3318 "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL) 3319STEXI 3320@item -append @var{cmdline} 3321@findex -append 3322Use @var{cmdline} as kernel command line 3323ETEXI 3324 3325DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \ 3326 "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL) 3327STEXI 3328@item -initrd @var{file} 3329@findex -initrd 3330Use @var{file} as initial ram disk. 3331 3332@item -initrd "@var{file1} arg=foo,@var{file2}" 3333 3334This syntax is only available with multiboot. 3335 3336Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the 3337first module. 3338ETEXI 3339 3340DEF("dtb", HAS_ARG, QEMU_OPTION_dtb, \ 3341 "-dtb file use 'file' as device tree image\n", QEMU_ARCH_ALL) 3342STEXI 3343@item -dtb @var{file} 3344@findex -dtb 3345Use @var{file} as a device tree binary (dtb) image and pass it to the kernel 3346on boot. 3347ETEXI 3348 3349STEXI 3350@end table 3351ETEXI 3352DEFHEADING() 3353 3354DEFHEADING(Debug/Expert options:) 3355STEXI 3356@table @option 3357ETEXI 3358 3359DEF("fw_cfg", HAS_ARG, QEMU_OPTION_fwcfg, 3360 "-fw_cfg [name=]<name>,file=<file>\n" 3361 " add named fw_cfg entry with contents from file\n" 3362 "-fw_cfg [name=]<name>,string=<str>\n" 3363 " add named fw_cfg entry with contents from string\n", 3364 QEMU_ARCH_ALL) 3365STEXI 3366 3367@item -fw_cfg [name=]@var{name},file=@var{file} 3368@findex -fw_cfg 3369Add named fw_cfg entry with contents from file @var{file}. 3370 3371@item -fw_cfg [name=]@var{name},string=@var{str} 3372Add named fw_cfg entry with contents from string @var{str}. 3373 3374The terminating NUL character of the contents of @var{str} will not be 3375included as part of the fw_cfg item data. To insert contents with 3376embedded NUL characters, you have to use the @var{file} parameter. 3377 3378The fw_cfg entries are passed by QEMU through to the guest. 3379 3380Example: 3381@example 3382 -fw_cfg name=opt/com.mycompany/blob,file=./my_blob.bin 3383@end example 3384creates an fw_cfg entry named opt/com.mycompany/blob with contents 3385from ./my_blob.bin. 3386 3387ETEXI 3388 3389DEF("serial", HAS_ARG, QEMU_OPTION_serial, \ 3390 "-serial dev redirect the serial port to char device 'dev'\n", 3391 QEMU_ARCH_ALL) 3392STEXI 3393@item -serial @var{dev} 3394@findex -serial 3395Redirect the virtual serial port to host character device 3396@var{dev}. The default device is @code{vc} in graphical mode and 3397@code{stdio} in non graphical mode. 3398 3399This option can be used several times to simulate up to 4 serial 3400ports. 3401 3402Use @code{-serial none} to disable all serial ports. 3403 3404Available character devices are: 3405@table @option 3406@item vc[:@var{W}x@var{H}] 3407Virtual console. Optionally, a width and height can be given in pixel with 3408@example 3409vc:800x600 3410@end example 3411It is also possible to specify width or height in characters: 3412@example 3413vc:80Cx24C 3414@end example 3415@item pty 3416[Linux only] Pseudo TTY (a new PTY is automatically allocated) 3417@item none 3418No device is allocated. 3419@item null 3420void device 3421@item chardev:@var{id} 3422Use a named character device defined with the @code{-chardev} option. 3423@item /dev/XXX 3424[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port 3425parameters are set according to the emulated ones. 3426@item /dev/parport@var{N} 3427[Linux only, parallel port only] Use host parallel port 3428@var{N}. Currently SPP and EPP parallel port features can be used. 3429@item file:@var{filename} 3430Write output to @var{filename}. No character can be read. 3431@item stdio 3432[Unix only] standard input/output 3433@item pipe:@var{filename} 3434name pipe @var{filename} 3435@item COM@var{n} 3436[Windows only] Use host serial port @var{n} 3437@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}] 3438This implements UDP Net Console. 3439When @var{remote_host} or @var{src_ip} are not specified 3440they default to @code{0.0.0.0}. 3441When not using a specified @var{src_port} a random port is automatically chosen. 3442 3443If you just want a simple readonly console you can use @code{netcat} or 3444@code{nc}, by starting QEMU with: @code{-serial udp::4555} and nc as: 3445@code{nc -u -l -p 4555}. Any time QEMU writes something to that port it 3446will appear in the netconsole session. 3447 3448If you plan to send characters back via netconsole or you want to stop 3449and start QEMU a lot of times, you should have QEMU use the same 3450source port each time by using something like @code{-serial 3451udp::4555@@:4556} to QEMU. Another approach is to use a patched 3452version of netcat which can listen to a TCP port and send and receive 3453characters via udp. If you have a patched version of netcat which 3454activates telnet remote echo and single char transfer, then you can 3455use the following options to set up a netcat redirector to allow 3456telnet on port 5555 to access the QEMU port. 3457@table @code 3458@item QEMU Options: 3459-serial udp::4555@@:4556 3460@item netcat options: 3461-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T 3462@item telnet options: 3463localhost 5555 3464@end table 3465 3466@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay][,reconnect=@var{seconds}] 3467The TCP Net Console has two modes of operation. It can send the serial 3468I/O to a location or wait for a connection from a location. By default 3469the TCP Net Console is sent to @var{host} at the @var{port}. If you use 3470the @var{server} option QEMU will wait for a client socket application 3471to connect to the port before continuing, unless the @code{nowait} 3472option was specified. The @code{nodelay} option disables the Nagle buffering 3473algorithm. The @code{reconnect} option only applies if @var{noserver} is 3474set, if the connection goes down it will attempt to reconnect at the 3475given interval. If @var{host} is omitted, 0.0.0.0 is assumed. Only 3476one TCP connection at a time is accepted. You can use @code{telnet} to 3477connect to the corresponding character device. 3478@table @code 3479@item Example to send tcp console to 192.168.0.2 port 4444 3480-serial tcp:192.168.0.2:4444 3481@item Example to listen and wait on port 4444 for connection 3482-serial tcp::4444,server 3483@item Example to not wait and listen on ip 192.168.0.100 port 4444 3484-serial tcp:192.168.0.100:4444,server,nowait 3485@end table 3486 3487@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay] 3488The telnet protocol is used instead of raw tcp sockets. The options 3489work the same as if you had specified @code{-serial tcp}. The 3490difference is that the port acts like a telnet server or client using 3491telnet option negotiation. This will also allow you to send the 3492MAGIC_SYSRQ sequence if you use a telnet that supports sending the break 3493sequence. Typically in unix telnet you do it with Control-] and then 3494type "send break" followed by pressing the enter key. 3495 3496@item websocket:@var{host}:@var{port},server[,nowait][,nodelay] 3497The WebSocket protocol is used instead of raw tcp socket. The port acts as 3498a WebSocket server. Client mode is not supported. 3499 3500@item unix:@var{path}[,server][,nowait][,reconnect=@var{seconds}] 3501A unix domain socket is used instead of a tcp socket. The option works the 3502same as if you had specified @code{-serial tcp} except the unix domain socket 3503@var{path} is used for connections. 3504 3505@item mon:@var{dev_string} 3506This is a special option to allow the monitor to be multiplexed onto 3507another serial port. The monitor is accessed with key sequence of 3508@key{Control-a} and then pressing @key{c}. 3509@var{dev_string} should be any one of the serial devices specified 3510above. An example to multiplex the monitor onto a telnet server 3511listening on port 4444 would be: 3512@table @code 3513@item -serial mon:telnet::4444,server,nowait 3514@end table 3515When the monitor is multiplexed to stdio in this way, Ctrl+C will not terminate 3516QEMU any more but will be passed to the guest instead. 3517 3518@item braille 3519Braille device. This will use BrlAPI to display the braille output on a real 3520or fake device. 3521 3522@item msmouse 3523Three button serial mouse. Configure the guest to use Microsoft protocol. 3524@end table 3525ETEXI 3526 3527DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \ 3528 "-parallel dev redirect the parallel port to char device 'dev'\n", 3529 QEMU_ARCH_ALL) 3530STEXI 3531@item -parallel @var{dev} 3532@findex -parallel 3533Redirect the virtual parallel port to host device @var{dev} (same 3534devices as the serial port). On Linux hosts, @file{/dev/parportN} can 3535be used to use hardware devices connected on the corresponding host 3536parallel port. 3537 3538This option can be used several times to simulate up to 3 parallel 3539ports. 3540 3541Use @code{-parallel none} to disable all parallel ports. 3542ETEXI 3543 3544DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \ 3545 "-monitor dev redirect the monitor to char device 'dev'\n", 3546 QEMU_ARCH_ALL) 3547STEXI 3548@item -monitor @var{dev} 3549@findex -monitor 3550Redirect the monitor to host device @var{dev} (same devices as the 3551serial port). 3552The default device is @code{vc} in graphical mode and @code{stdio} in 3553non graphical mode. 3554Use @code{-monitor none} to disable the default monitor. 3555ETEXI 3556DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \ 3557 "-qmp dev like -monitor but opens in 'control' mode\n", 3558 QEMU_ARCH_ALL) 3559STEXI 3560@item -qmp @var{dev} 3561@findex -qmp 3562Like -monitor but opens in 'control' mode. 3563ETEXI 3564DEF("qmp-pretty", HAS_ARG, QEMU_OPTION_qmp_pretty, \ 3565 "-qmp-pretty dev like -qmp but uses pretty JSON formatting\n", 3566 QEMU_ARCH_ALL) 3567STEXI 3568@item -qmp-pretty @var{dev} 3569@findex -qmp-pretty 3570Like -qmp but uses pretty JSON formatting. 3571ETEXI 3572 3573DEF("mon", HAS_ARG, QEMU_OPTION_mon, \ 3574 "-mon [chardev=]name[,mode=readline|control][,pretty[=on|off]]\n", QEMU_ARCH_ALL) 3575STEXI 3576@item -mon [chardev=]name[,mode=readline|control][,pretty[=on|off]] 3577@findex -mon 3578Setup monitor on chardev @var{name}. @code{pretty} turns on JSON pretty printing 3579easing human reading and debugging. 3580ETEXI 3581 3582DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \ 3583 "-debugcon dev redirect the debug console to char device 'dev'\n", 3584 QEMU_ARCH_ALL) 3585STEXI 3586@item -debugcon @var{dev} 3587@findex -debugcon 3588Redirect the debug console to host device @var{dev} (same devices as the 3589serial port). The debug console is an I/O port which is typically port 35900xe9; writing to that I/O port sends output to this device. 3591The default device is @code{vc} in graphical mode and @code{stdio} in 3592non graphical mode. 3593ETEXI 3594 3595DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \ 3596 "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL) 3597STEXI 3598@item -pidfile @var{file} 3599@findex -pidfile 3600Store the QEMU process PID in @var{file}. It is useful if you launch QEMU 3601from a script. 3602ETEXI 3603 3604DEF("singlestep", 0, QEMU_OPTION_singlestep, \ 3605 "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL) 3606STEXI 3607@item -singlestep 3608@findex -singlestep 3609Run the emulation in single step mode. 3610ETEXI 3611 3612DEF("preconfig", 0, QEMU_OPTION_preconfig, \ 3613 "--preconfig pause QEMU before machine is initialized (experimental)\n", 3614 QEMU_ARCH_ALL) 3615STEXI 3616@item --preconfig 3617@findex --preconfig 3618Pause QEMU for interactive configuration before the machine is created, 3619which allows querying and configuring properties that will affect 3620machine initialization. Use QMP command 'x-exit-preconfig' to exit 3621the preconfig state and move to the next state (i.e. run guest if -S 3622isn't used or pause the second time if -S is used). This option is 3623experimental. 3624ETEXI 3625 3626DEF("S", 0, QEMU_OPTION_S, \ 3627 "-S freeze CPU at startup (use 'c' to start execution)\n", 3628 QEMU_ARCH_ALL) 3629STEXI 3630@item -S 3631@findex -S 3632Do not start CPU at startup (you must type 'c' in the monitor). 3633ETEXI 3634 3635DEF("realtime", HAS_ARG, QEMU_OPTION_realtime, 3636 "-realtime [mlock=on|off]\n" 3637 " run qemu with realtime features\n" 3638 " mlock=on|off controls mlock support (default: on)\n", 3639 QEMU_ARCH_ALL) 3640STEXI 3641@item -realtime mlock=on|off 3642@findex -realtime 3643Run qemu with realtime features. 3644mlocking qemu and guest memory can be enabled via @option{mlock=on} 3645(enabled by default). 3646ETEXI 3647 3648DEF("overcommit", HAS_ARG, QEMU_OPTION_overcommit, 3649 "-overcommit [mem-lock=on|off][cpu-pm=on|off]\n" 3650 " run qemu with overcommit hints\n" 3651 " mem-lock=on|off controls memory lock support (default: off)\n" 3652 " cpu-pm=on|off controls cpu power management (default: off)\n", 3653 QEMU_ARCH_ALL) 3654STEXI 3655@item -overcommit mem-lock=on|off 3656@item -overcommit cpu-pm=on|off 3657@findex -overcommit 3658Run qemu with hints about host resource overcommit. The default is 3659to assume that host overcommits all resources. 3660 3661Locking qemu and guest memory can be enabled via @option{mem-lock=on} (disabled 3662by default). This works when host memory is not overcommitted and reduces the 3663worst-case latency for guest. This is equivalent to @option{realtime}. 3664 3665Guest ability to manage power state of host cpus (increasing latency for other 3666processes on the same host cpu, but decreasing latency for guest) can be 3667enabled via @option{cpu-pm=on} (disabled by default). This works best when 3668host CPU is not overcommitted. When used, host estimates of CPU cycle and power 3669utilization will be incorrect, not taking into account guest idle time. 3670ETEXI 3671 3672DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \ 3673 "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL) 3674STEXI 3675@item -gdb @var{dev} 3676@findex -gdb 3677Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical 3678connections will likely be TCP-based, but also UDP, pseudo TTY, or even 3679stdio are reasonable use case. The latter is allowing to start QEMU from 3680within gdb and establish the connection via a pipe: 3681@example 3682(gdb) target remote | exec @value{qemu_system} -gdb stdio ... 3683@end example 3684ETEXI 3685 3686DEF("s", 0, QEMU_OPTION_s, \ 3687 "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n", 3688 QEMU_ARCH_ALL) 3689STEXI 3690@item -s 3691@findex -s 3692Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234 3693(@pxref{gdb_usage}). 3694ETEXI 3695 3696DEF("d", HAS_ARG, QEMU_OPTION_d, \ 3697 "-d item1,... enable logging of specified items (use '-d help' for a list of log items)\n", 3698 QEMU_ARCH_ALL) 3699STEXI 3700@item -d @var{item1}[,...] 3701@findex -d 3702Enable logging of specified items. Use '-d help' for a list of log items. 3703ETEXI 3704 3705DEF("D", HAS_ARG, QEMU_OPTION_D, \ 3706 "-D logfile output log to logfile (default stderr)\n", 3707 QEMU_ARCH_ALL) 3708STEXI 3709@item -D @var{logfile} 3710@findex -D 3711Output log in @var{logfile} instead of to stderr 3712ETEXI 3713 3714DEF("dfilter", HAS_ARG, QEMU_OPTION_DFILTER, \ 3715 "-dfilter range,.. filter debug output to range of addresses (useful for -d cpu,exec,etc..)\n", 3716 QEMU_ARCH_ALL) 3717STEXI 3718@item -dfilter @var{range1}[,...] 3719@findex -dfilter 3720Filter debug output to that relevant to a range of target addresses. The filter 3721spec can be either @var{start}+@var{size}, @var{start}-@var{size} or 3722@var{start}..@var{end} where @var{start} @var{end} and @var{size} are the 3723addresses and sizes required. For example: 3724@example 3725 -dfilter 0x8000..0x8fff,0xffffffc000080000+0x200,0xffffffc000060000-0x1000 3726@end example 3727Will dump output for any code in the 0x1000 sized block starting at 0x8000 and 3728the 0x200 sized block starting at 0xffffffc000080000 and another 0x1000 sized 3729block starting at 0xffffffc00005f000. 3730ETEXI 3731 3732DEF("seed", HAS_ARG, QEMU_OPTION_seed, \ 3733 "-seed number seed the pseudo-random number generator\n", 3734 QEMU_ARCH_ALL) 3735STEXI 3736@item -seed @var{number} 3737@findex -seed 3738Force the guest to use a deterministic pseudo-random number generator, seeded 3739with @var{number}. This does not affect crypto routines within the host. 3740ETEXI 3741 3742DEF("L", HAS_ARG, QEMU_OPTION_L, \ 3743 "-L path set the directory for the BIOS, VGA BIOS and keymaps\n", 3744 QEMU_ARCH_ALL) 3745STEXI 3746@item -L @var{path} 3747@findex -L 3748Set the directory for the BIOS, VGA BIOS and keymaps. 3749 3750To list all the data directories, use @code{-L help}. 3751ETEXI 3752 3753DEF("bios", HAS_ARG, QEMU_OPTION_bios, \ 3754 "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL) 3755STEXI 3756@item -bios @var{file} 3757@findex -bios 3758Set the filename for the BIOS. 3759ETEXI 3760 3761DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \ 3762 "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL) 3763STEXI 3764@item -enable-kvm 3765@findex -enable-kvm 3766Enable KVM full virtualization support. This option is only available 3767if KVM support is enabled when compiling. 3768ETEXI 3769 3770DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid, 3771 "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL) 3772DEF("xen-attach", 0, QEMU_OPTION_xen_attach, 3773 "-xen-attach attach to existing xen domain\n" 3774 " libxl will use this when starting QEMU\n", 3775 QEMU_ARCH_ALL) 3776DEF("xen-domid-restrict", 0, QEMU_OPTION_xen_domid_restrict, 3777 "-xen-domid-restrict restrict set of available xen operations\n" 3778 " to specified domain id. (Does not affect\n" 3779 " xenpv machine type).\n", 3780 QEMU_ARCH_ALL) 3781STEXI 3782@item -xen-domid @var{id} 3783@findex -xen-domid 3784Specify xen guest domain @var{id} (XEN only). 3785@item -xen-attach 3786@findex -xen-attach 3787Attach to existing xen domain. 3788libxl will use this when starting QEMU (XEN only). 3789@findex -xen-domid-restrict 3790Restrict set of available xen operations to specified domain id (XEN only). 3791ETEXI 3792 3793DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \ 3794 "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL) 3795STEXI 3796@item -no-reboot 3797@findex -no-reboot 3798Exit instead of rebooting. 3799ETEXI 3800 3801DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \ 3802 "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL) 3803STEXI 3804@item -no-shutdown 3805@findex -no-shutdown 3806Don't exit QEMU on guest shutdown, but instead only stop the emulation. 3807This allows for instance switching to monitor to commit changes to the 3808disk image. 3809ETEXI 3810 3811DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \ 3812 "-loadvm [tag|id]\n" \ 3813 " start right away with a saved state (loadvm in monitor)\n", 3814 QEMU_ARCH_ALL) 3815STEXI 3816@item -loadvm @var{file} 3817@findex -loadvm 3818Start right away with a saved state (@code{loadvm} in monitor) 3819ETEXI 3820 3821#ifndef _WIN32 3822DEF("daemonize", 0, QEMU_OPTION_daemonize, \ 3823 "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL) 3824#endif 3825STEXI 3826@item -daemonize 3827@findex -daemonize 3828Daemonize the QEMU process after initialization. QEMU will not detach from 3829standard IO until it is ready to receive connections on any of its devices. 3830This option is a useful way for external programs to launch QEMU without having 3831to cope with initialization race conditions. 3832ETEXI 3833 3834DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \ 3835 "-option-rom rom load a file, rom, into the option ROM space\n", 3836 QEMU_ARCH_ALL) 3837STEXI 3838@item -option-rom @var{file} 3839@findex -option-rom 3840Load the contents of @var{file} as an option ROM. 3841This option is useful to load things like EtherBoot. 3842ETEXI 3843 3844DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \ 3845 "-rtc [base=utc|localtime|<datetime>][,clock=host|rt|vm][,driftfix=none|slew]\n" \ 3846 " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n", 3847 QEMU_ARCH_ALL) 3848 3849STEXI 3850 3851@item -rtc [base=utc|localtime|@var{datetime}][,clock=host|rt|vm][,driftfix=none|slew] 3852@findex -rtc 3853Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current 3854UTC or local time, respectively. @code{localtime} is required for correct date in 3855MS-DOS or Windows. To start at a specific point in time, provide @var{datetime} in the 3856format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC. 3857 3858By default the RTC is driven by the host system time. This allows using of the 3859RTC as accurate reference clock inside the guest, specifically if the host 3860time is smoothly following an accurate external reference clock, e.g. via NTP. 3861If you want to isolate the guest time from the host, you can set @option{clock} 3862to @code{rt} instead, which provides a host monotonic clock if host support it. 3863To even prevent the RTC from progressing during suspension, you can set @option{clock} 3864to @code{vm} (virtual clock). @samp{clock=vm} is recommended especially in 3865icount mode in order to preserve determinism; however, note that in icount mode 3866the speed of the virtual clock is variable and can in general differ from the 3867host clock. 3868 3869Enable @option{driftfix} (i386 targets only) if you experience time drift problems, 3870specifically with Windows' ACPI HAL. This option will try to figure out how 3871many timer interrupts were not processed by the Windows guest and will 3872re-inject them. 3873ETEXI 3874 3875DEF("icount", HAS_ARG, QEMU_OPTION_icount, \ 3876 "-icount [shift=N|auto][,align=on|off][,sleep=on|off,rr=record|replay,rrfile=<filename>,rrsnapshot=<snapshot>]\n" \ 3877 " enable virtual instruction counter with 2^N clock ticks per\n" \ 3878 " instruction, enable aligning the host and virtual clocks\n" \ 3879 " or disable real time cpu sleeping\n", QEMU_ARCH_ALL) 3880STEXI 3881@item -icount [shift=@var{N}|auto][,rr=record|replay,rrfile=@var{filename},rrsnapshot=@var{snapshot}] 3882@findex -icount 3883Enable virtual instruction counter. The virtual cpu will execute one 3884instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified 3885then the virtual cpu speed will be automatically adjusted to keep virtual 3886time within a few seconds of real time. 3887 3888When the virtual cpu is sleeping, the virtual time will advance at default 3889speed unless @option{sleep=on|off} is specified. 3890With @option{sleep=on|off}, the virtual time will jump to the next timer deadline 3891instantly whenever the virtual cpu goes to sleep mode and will not advance 3892if no timer is enabled. This behavior give deterministic execution times from 3893the guest point of view. 3894 3895Note that while this option can give deterministic behavior, it does not 3896provide cycle accurate emulation. Modern CPUs contain superscalar out of 3897order cores with complex cache hierarchies. The number of instructions 3898executed often has little or no correlation with actual performance. 3899 3900@option{align=on} will activate the delay algorithm which will try 3901to synchronise the host clock and the virtual clock. The goal is to 3902have a guest running at the real frequency imposed by the shift option. 3903Whenever the guest clock is behind the host clock and if 3904@option{align=on} is specified then we print a message to the user 3905to inform about the delay. 3906Currently this option does not work when @option{shift} is @code{auto}. 3907Note: The sync algorithm will work for those shift values for which 3908the guest clock runs ahead of the host clock. Typically this happens 3909when the shift value is high (how high depends on the host machine). 3910 3911When @option{rr} option is specified deterministic record/replay is enabled. 3912Replay log is written into @var{filename} file in record mode and 3913read from this file in replay mode. 3914 3915Option rrsnapshot is used to create new vm snapshot named @var{snapshot} 3916at the start of execution recording. In replay mode this option is used 3917to load the initial VM state. 3918ETEXI 3919 3920DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \ 3921 "-watchdog model\n" \ 3922 " enable virtual hardware watchdog [default=none]\n", 3923 QEMU_ARCH_ALL) 3924STEXI 3925@item -watchdog @var{model} 3926@findex -watchdog 3927Create a virtual hardware watchdog device. Once enabled (by a guest 3928action), the watchdog must be periodically polled by an agent inside 3929the guest or else the guest will be restarted. Choose a model for 3930which your guest has drivers. 3931 3932The @var{model} is the model of hardware watchdog to emulate. Use 3933@code{-watchdog help} to list available hardware models. Only one 3934watchdog can be enabled for a guest. 3935 3936The following models may be available: 3937@table @option 3938@item ib700 3939iBASE 700 is a very simple ISA watchdog with a single timer. 3940@item i6300esb 3941Intel 6300ESB I/O controller hub is a much more featureful PCI-based 3942dual-timer watchdog. 3943@item diag288 3944A virtual watchdog for s390x backed by the diagnose 288 hypercall 3945(currently KVM only). 3946@end table 3947ETEXI 3948 3949DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \ 3950 "-watchdog-action reset|shutdown|poweroff|inject-nmi|pause|debug|none\n" \ 3951 " action when watchdog fires [default=reset]\n", 3952 QEMU_ARCH_ALL) 3953STEXI 3954@item -watchdog-action @var{action} 3955@findex -watchdog-action 3956 3957The @var{action} controls what QEMU will do when the watchdog timer 3958expires. 3959The default is 3960@code{reset} (forcefully reset the guest). 3961Other possible actions are: 3962@code{shutdown} (attempt to gracefully shutdown the guest), 3963@code{poweroff} (forcefully poweroff the guest), 3964@code{inject-nmi} (inject a NMI into the guest), 3965@code{pause} (pause the guest), 3966@code{debug} (print a debug message and continue), or 3967@code{none} (do nothing). 3968 3969Note that the @code{shutdown} action requires that the guest responds 3970to ACPI signals, which it may not be able to do in the sort of 3971situations where the watchdog would have expired, and thus 3972@code{-watchdog-action shutdown} is not recommended for production use. 3973 3974Examples: 3975 3976@table @code 3977@item -watchdog i6300esb -watchdog-action pause 3978@itemx -watchdog ib700 3979@end table 3980ETEXI 3981 3982DEF("echr", HAS_ARG, QEMU_OPTION_echr, \ 3983 "-echr chr set terminal escape character instead of ctrl-a\n", 3984 QEMU_ARCH_ALL) 3985STEXI 3986 3987@item -echr @var{numeric_ascii_value} 3988@findex -echr 3989Change the escape character used for switching to the monitor when using 3990monitor and serial sharing. The default is @code{0x01} when using the 3991@code{-nographic} option. @code{0x01} is equal to pressing 3992@code{Control-a}. You can select a different character from the ascii 3993control keys where 1 through 26 map to Control-a through Control-z. For 3994instance you could use the either of the following to change the escape 3995character to Control-t. 3996@table @code 3997@item -echr 0x14 3998@itemx -echr 20 3999@end table 4000ETEXI 4001 4002DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \ 4003 "-show-cursor show cursor\n", QEMU_ARCH_ALL) 4004STEXI 4005@item -show-cursor 4006@findex -show-cursor 4007Show cursor. 4008ETEXI 4009 4010DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \ 4011 "-tb-size n set TB size\n", QEMU_ARCH_ALL) 4012STEXI 4013@item -tb-size @var{n} 4014@findex -tb-size 4015Set TB size. 4016ETEXI 4017 4018DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ 4019 "-incoming tcp:[host]:port[,to=maxport][,ipv4][,ipv6]\n" \ 4020 "-incoming rdma:host:port[,ipv4][,ipv6]\n" \ 4021 "-incoming unix:socketpath\n" \ 4022 " prepare for incoming migration, listen on\n" \ 4023 " specified protocol and socket address\n" \ 4024 "-incoming fd:fd\n" \ 4025 "-incoming exec:cmdline\n" \ 4026 " accept incoming migration on given file descriptor\n" \ 4027 " or from given external command\n" \ 4028 "-incoming defer\n" \ 4029 " wait for the URI to be specified via migrate_incoming\n", 4030 QEMU_ARCH_ALL) 4031STEXI 4032@item -incoming tcp:[@var{host}]:@var{port}[,to=@var{maxport}][,ipv4][,ipv6] 4033@itemx -incoming rdma:@var{host}:@var{port}[,ipv4][,ipv6] 4034@findex -incoming 4035Prepare for incoming migration, listen on a given tcp port. 4036 4037@item -incoming unix:@var{socketpath} 4038Prepare for incoming migration, listen on a given unix socket. 4039 4040@item -incoming fd:@var{fd} 4041Accept incoming migration from a given filedescriptor. 4042 4043@item -incoming exec:@var{cmdline} 4044Accept incoming migration as an output from specified external command. 4045 4046@item -incoming defer 4047Wait for the URI to be specified via migrate_incoming. The monitor can 4048be used to change settings (such as migration parameters) prior to issuing 4049the migrate_incoming to allow the migration to begin. 4050ETEXI 4051 4052DEF("only-migratable", 0, QEMU_OPTION_only_migratable, \ 4053 "-only-migratable allow only migratable devices\n", QEMU_ARCH_ALL) 4054STEXI 4055@item -only-migratable 4056@findex -only-migratable 4057Only allow migratable devices. Devices will not be allowed to enter an 4058unmigratable state. 4059ETEXI 4060 4061DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \ 4062 "-nodefaults don't create default devices\n", QEMU_ARCH_ALL) 4063STEXI 4064@item -nodefaults 4065@findex -nodefaults 4066Don't create default devices. Normally, QEMU sets the default devices like serial 4067port, parallel port, virtual console, monitor device, VGA adapter, floppy and 4068CD-ROM drive and others. The @code{-nodefaults} option will disable all those 4069default devices. 4070ETEXI 4071 4072#ifndef _WIN32 4073DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \ 4074 "-chroot dir chroot to dir just before starting the VM\n", 4075 QEMU_ARCH_ALL) 4076#endif 4077STEXI 4078@item -chroot @var{dir} 4079@findex -chroot 4080Immediately before starting guest execution, chroot to the specified 4081directory. Especially useful in combination with -runas. 4082ETEXI 4083 4084#ifndef _WIN32 4085DEF("runas", HAS_ARG, QEMU_OPTION_runas, \ 4086 "-runas user change to user id user just before starting the VM\n" \ 4087 " user can be numeric uid:gid instead\n", 4088 QEMU_ARCH_ALL) 4089#endif 4090STEXI 4091@item -runas @var{user} 4092@findex -runas 4093Immediately before starting guest execution, drop root privileges, switching 4094to the specified user. 4095ETEXI 4096 4097DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env, 4098 "-prom-env variable=value\n" 4099 " set OpenBIOS nvram variables\n", 4100 QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 4101STEXI 4102@item -prom-env @var{variable}=@var{value} 4103@findex -prom-env 4104Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only). 4105ETEXI 4106DEF("semihosting", 0, QEMU_OPTION_semihosting, 4107 "-semihosting semihosting mode\n", 4108 QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32 | 4109 QEMU_ARCH_MIPS | QEMU_ARCH_NIOS2) 4110STEXI 4111@item -semihosting 4112@findex -semihosting 4113Enable semihosting mode (ARM, M68K, Xtensa, MIPS, Nios II only). 4114ETEXI 4115DEF("semihosting-config", HAS_ARG, QEMU_OPTION_semihosting_config, 4116 "-semihosting-config [enable=on|off][,target=native|gdb|auto][,chardev=id][,arg=str[,...]]\n" \ 4117 " semihosting configuration\n", 4118QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32 | 4119QEMU_ARCH_MIPS | QEMU_ARCH_NIOS2) 4120STEXI 4121@item -semihosting-config [enable=on|off][,target=native|gdb|auto][,chardev=id][,arg=str[,...]] 4122@findex -semihosting-config 4123Enable and configure semihosting (ARM, M68K, Xtensa, MIPS, Nios II only). 4124@table @option 4125@item target=@code{native|gdb|auto} 4126Defines where the semihosting calls will be addressed, to QEMU (@code{native}) 4127or to GDB (@code{gdb}). The default is @code{auto}, which means @code{gdb} 4128during debug sessions and @code{native} otherwise. 4129@item chardev=@var{str1} 4130Send the output to a chardev backend output for native or auto output when not in gdb 4131@item arg=@var{str1},arg=@var{str2},... 4132Allows the user to pass input arguments, and can be used multiple times to build 4133up a list. The old-style @code{-kernel}/@code{-append} method of passing a 4134command line is still supported for backward compatibility. If both the 4135@code{--semihosting-config arg} and the @code{-kernel}/@code{-append} are 4136specified, the former is passed to semihosting as it always takes precedence. 4137@end table 4138ETEXI 4139DEF("old-param", 0, QEMU_OPTION_old_param, 4140 "-old-param old param mode\n", QEMU_ARCH_ARM) 4141STEXI 4142@item -old-param 4143@findex -old-param (ARM) 4144Old param mode (ARM only). 4145ETEXI 4146 4147DEF("sandbox", HAS_ARG, QEMU_OPTION_sandbox, \ 4148 "-sandbox on[,obsolete=allow|deny][,elevateprivileges=allow|deny|children]\n" \ 4149 " [,spawn=allow|deny][,resourcecontrol=allow|deny]\n" \ 4150 " Enable seccomp mode 2 system call filter (default 'off').\n" \ 4151 " use 'obsolete' to allow obsolete system calls that are provided\n" \ 4152 " by the kernel, but typically no longer used by modern\n" \ 4153 " C library implementations.\n" \ 4154 " use 'elevateprivileges' to allow or deny QEMU process to elevate\n" \ 4155 " its privileges by blacklisting all set*uid|gid system calls.\n" \ 4156 " The value 'children' will deny set*uid|gid system calls for\n" \ 4157 " main QEMU process but will allow forks and execves to run unprivileged\n" \ 4158 " use 'spawn' to avoid QEMU to spawn new threads or processes by\n" \ 4159 " blacklisting *fork and execve\n" \ 4160 " use 'resourcecontrol' to disable process affinity and schedular priority\n", 4161 QEMU_ARCH_ALL) 4162STEXI 4163@item -sandbox @var{arg}[,obsolete=@var{string}][,elevateprivileges=@var{string}][,spawn=@var{string}][,resourcecontrol=@var{string}] 4164@findex -sandbox 4165Enable Seccomp mode 2 system call filter. 'on' will enable syscall filtering and 'off' will 4166disable it. The default is 'off'. 4167@table @option 4168@item obsolete=@var{string} 4169Enable Obsolete system calls 4170@item elevateprivileges=@var{string} 4171Disable set*uid|gid system calls 4172@item spawn=@var{string} 4173Disable *fork and execve 4174@item resourcecontrol=@var{string} 4175Disable process affinity and schedular priority 4176@end table 4177ETEXI 4178 4179DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig, 4180 "-readconfig <file>\n", QEMU_ARCH_ALL) 4181STEXI 4182@item -readconfig @var{file} 4183@findex -readconfig 4184Read device configuration from @var{file}. This approach is useful when you want to spawn 4185QEMU process with many command line options but you don't want to exceed the command line 4186character limit. 4187ETEXI 4188DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig, 4189 "-writeconfig <file>\n" 4190 " read/write config file\n", QEMU_ARCH_ALL) 4191STEXI 4192@item -writeconfig @var{file} 4193@findex -writeconfig 4194Write device configuration to @var{file}. The @var{file} can be either filename to save 4195command line and device configuration into file or dash @code{-}) character to print the 4196output to stdout. This can be later used as input file for @code{-readconfig} option. 4197ETEXI 4198 4199DEF("no-user-config", 0, QEMU_OPTION_nouserconfig, 4200 "-no-user-config\n" 4201 " do not load default user-provided config files at startup\n", 4202 QEMU_ARCH_ALL) 4203STEXI 4204@item -no-user-config 4205@findex -no-user-config 4206The @code{-no-user-config} option makes QEMU not load any of the user-provided 4207config files on @var{sysconfdir}. 4208ETEXI 4209 4210DEF("trace", HAS_ARG, QEMU_OPTION_trace, 4211 "-trace [[enable=]<pattern>][,events=<file>][,file=<file>]\n" 4212 " specify tracing options\n", 4213 QEMU_ARCH_ALL) 4214STEXI 4215HXCOMM This line is not accurate, as some sub-options are backend-specific but 4216HXCOMM HX does not support conditional compilation of text. 4217@item -trace [[enable=]@var{pattern}][,events=@var{file}][,file=@var{file}] 4218@findex -trace 4219@include qemu-option-trace.texi 4220ETEXI 4221DEF("plugin", HAS_ARG, QEMU_OPTION_plugin, 4222 "-plugin [file=]<file>[,arg=<string>]\n" 4223 " load a plugin\n", 4224 QEMU_ARCH_ALL) 4225STEXI 4226@item -plugin file=@var{file}[,arg=@var{string}] 4227@findex -plugin 4228 4229Load a plugin. 4230 4231@table @option 4232@item file=@var{file} 4233Load the given plugin from a shared library file. 4234@item arg=@var{string} 4235Argument string passed to the plugin. (Can be given multiple times.) 4236@end table 4237ETEXI 4238 4239HXCOMM Internal use 4240DEF("qtest", HAS_ARG, QEMU_OPTION_qtest, "", QEMU_ARCH_ALL) 4241DEF("qtest-log", HAS_ARG, QEMU_OPTION_qtest_log, "", QEMU_ARCH_ALL) 4242 4243#ifdef __linux__ 4244DEF("enable-fips", 0, QEMU_OPTION_enablefips, 4245 "-enable-fips enable FIPS 140-2 compliance\n", 4246 QEMU_ARCH_ALL) 4247#endif 4248STEXI 4249@item -enable-fips 4250@findex -enable-fips 4251Enable FIPS 140-2 compliance mode. 4252ETEXI 4253 4254HXCOMM Deprecated by -accel tcg 4255DEF("no-kvm", 0, QEMU_OPTION_no_kvm, "", QEMU_ARCH_I386) 4256 4257DEF("msg", HAS_ARG, QEMU_OPTION_msg, 4258 "-msg timestamp[=on|off]\n" 4259 " change the format of messages\n" 4260 " on|off controls leading timestamps (default:on)\n", 4261 QEMU_ARCH_ALL) 4262STEXI 4263@item -msg timestamp[=on|off] 4264@findex -msg 4265prepend a timestamp to each log message.(default:on) 4266ETEXI 4267 4268DEF("dump-vmstate", HAS_ARG, QEMU_OPTION_dump_vmstate, 4269 "-dump-vmstate <file>\n" 4270 " Output vmstate information in JSON format to file.\n" 4271 " Use the scripts/vmstate-static-checker.py file to\n" 4272 " check for possible regressions in migration code\n" 4273 " by comparing two such vmstate dumps.\n", 4274 QEMU_ARCH_ALL) 4275STEXI 4276@item -dump-vmstate @var{file} 4277@findex -dump-vmstate 4278Dump json-encoded vmstate information for current machine type to file 4279in @var{file} 4280ETEXI 4281 4282DEF("enable-sync-profile", 0, QEMU_OPTION_enable_sync_profile, 4283 "-enable-sync-profile\n" 4284 " enable synchronization profiling\n", 4285 QEMU_ARCH_ALL) 4286STEXI 4287@item -enable-sync-profile 4288@findex -enable-sync-profile 4289Enable synchronization profiling. 4290ETEXI 4291 4292STEXI 4293@end table 4294ETEXI 4295DEFHEADING() 4296 4297DEFHEADING(Generic object creation:) 4298STEXI 4299@table @option 4300ETEXI 4301 4302DEF("object", HAS_ARG, QEMU_OPTION_object, 4303 "-object TYPENAME[,PROP1=VALUE1,...]\n" 4304 " create a new object of type TYPENAME setting properties\n" 4305 " in the order they are specified. Note that the 'id'\n" 4306 " property must be set. These objects are placed in the\n" 4307 " '/objects' path.\n", 4308 QEMU_ARCH_ALL) 4309STEXI 4310@item -object @var{typename}[,@var{prop1}=@var{value1},...] 4311@findex -object 4312Create a new object of type @var{typename} setting properties 4313in the order they are specified. Note that the 'id' 4314property must be set. These objects are placed in the 4315'/objects' path. 4316 4317@table @option 4318 4319@item -object memory-backend-file,id=@var{id},size=@var{size},mem-path=@var{dir},share=@var{on|off},discard-data=@var{on|off},merge=@var{on|off},dump=@var{on|off},prealloc=@var{on|off},host-nodes=@var{host-nodes},policy=@var{default|preferred|bind|interleave},align=@var{align} 4320 4321Creates a memory file backend object, which can be used to back 4322the guest RAM with huge pages. 4323 4324The @option{id} parameter is a unique ID that will be used to reference this 4325memory region when configuring the @option{-numa} argument. 4326 4327The @option{size} option provides the size of the memory region, and accepts 4328common suffixes, eg @option{500M}. 4329 4330The @option{mem-path} provides the path to either a shared memory or huge page 4331filesystem mount. 4332 4333The @option{share} boolean option determines whether the memory 4334region is marked as private to QEMU, or shared. The latter allows 4335a co-operating external process to access the QEMU memory region. 4336 4337The @option{share} is also required for pvrdma devices due to 4338limitations in the RDMA API provided by Linux. 4339 4340Setting share=on might affect the ability to configure NUMA 4341bindings for the memory backend under some circumstances, see 4342Documentation/vm/numa_memory_policy.txt on the Linux kernel 4343source tree for additional details. 4344 4345Setting the @option{discard-data} boolean option to @var{on} 4346indicates that file contents can be destroyed when QEMU exits, 4347to avoid unnecessarily flushing data to the backing file. Note 4348that @option{discard-data} is only an optimization, and QEMU 4349might not discard file contents if it aborts unexpectedly or is 4350terminated using SIGKILL. 4351 4352The @option{merge} boolean option enables memory merge, also known as 4353MADV_MERGEABLE, so that Kernel Samepage Merging will consider the pages for 4354memory deduplication. 4355 4356Setting the @option{dump} boolean option to @var{off} excludes the memory from 4357core dumps. This feature is also known as MADV_DONTDUMP. 4358 4359The @option{prealloc} boolean option enables memory preallocation. 4360 4361The @option{host-nodes} option binds the memory range to a list of NUMA host 4362nodes. 4363 4364The @option{policy} option sets the NUMA policy to one of the following values: 4365 4366@table @option 4367@item @var{default} 4368default host policy 4369 4370@item @var{preferred} 4371prefer the given host node list for allocation 4372 4373@item @var{bind} 4374restrict memory allocation to the given host node list 4375 4376@item @var{interleave} 4377interleave memory allocations across the given host node list 4378@end table 4379 4380The @option{align} option specifies the base address alignment when 4381QEMU mmap(2) @option{mem-path}, and accepts common suffixes, eg 4382@option{2M}. Some backend store specified by @option{mem-path} 4383requires an alignment different than the default one used by QEMU, eg 4384the device DAX /dev/dax0.0 requires 2M alignment rather than 4K. In 4385such cases, users can specify the required alignment via this option. 4386 4387The @option{pmem} option specifies whether the backing file specified 4388by @option{mem-path} is in host persistent memory that can be accessed 4389using the SNIA NVM programming model (e.g. Intel NVDIMM). 4390If @option{pmem} is set to 'on', QEMU will take necessary operations to 4391guarantee the persistence of its own writes to @option{mem-path} 4392(e.g. in vNVDIMM label emulation and live migration). 4393Also, we will map the backend-file with MAP_SYNC flag, which ensures the 4394file metadata is in sync for @option{mem-path} in case of host crash 4395or a power failure. MAP_SYNC requires support from both the host kernel 4396(since Linux kernel 4.15) and the filesystem of @option{mem-path} mounted 4397with DAX option. 4398 4399@item -object memory-backend-ram,id=@var{id},merge=@var{on|off},dump=@var{on|off},share=@var{on|off},prealloc=@var{on|off},size=@var{size},host-nodes=@var{host-nodes},policy=@var{default|preferred|bind|interleave} 4400 4401Creates a memory backend object, which can be used to back the guest RAM. 4402Memory backend objects offer more control than the @option{-m} option that is 4403traditionally used to define guest RAM. Please refer to 4404@option{memory-backend-file} for a description of the options. 4405 4406@item -object memory-backend-memfd,id=@var{id},merge=@var{on|off},dump=@var{on|off},share=@var{on|off},prealloc=@var{on|off},size=@var{size},host-nodes=@var{host-nodes},policy=@var{default|preferred|bind|interleave},seal=@var{on|off},hugetlb=@var{on|off},hugetlbsize=@var{size} 4407 4408Creates an anonymous memory file backend object, which allows QEMU to 4409share the memory with an external process (e.g. when using 4410vhost-user). The memory is allocated with memfd and optional 4411sealing. (Linux only) 4412 4413The @option{seal} option creates a sealed-file, that will block 4414further resizing the memory ('on' by default). 4415 4416The @option{hugetlb} option specify the file to be created resides in 4417the hugetlbfs filesystem (since Linux 4.14). Used in conjunction with 4418the @option{hugetlb} option, the @option{hugetlbsize} option specify 4419the hugetlb page size on systems that support multiple hugetlb page 4420sizes (it must be a power of 2 value supported by the system). 4421 4422In some versions of Linux, the @option{hugetlb} option is incompatible 4423with the @option{seal} option (requires at least Linux 4.16). 4424 4425Please refer to @option{memory-backend-file} for a description of the 4426other options. 4427 4428The @option{share} boolean option is @var{on} by default with memfd. 4429 4430@item -object rng-builtin,id=@var{id} 4431 4432Creates a random number generator backend which obtains entropy from 4433QEMU builtin functions. The @option{id} parameter is a unique ID that 4434will be used to reference this entropy backend from the @option{virtio-rng} 4435device. By default, the @option{virtio-rng} device uses this RNG backend. 4436 4437@item -object rng-random,id=@var{id},filename=@var{/dev/random} 4438 4439Creates a random number generator backend which obtains entropy from 4440a device on the host. The @option{id} parameter is a unique ID that 4441will be used to reference this entropy backend from the @option{virtio-rng} 4442device. The @option{filename} parameter specifies which file to obtain 4443entropy from and if omitted defaults to @option{/dev/urandom}. 4444 4445@item -object rng-egd,id=@var{id},chardev=@var{chardevid} 4446 4447Creates a random number generator backend which obtains entropy from 4448an external daemon running on the host. The @option{id} parameter is 4449a unique ID that will be used to reference this entropy backend from 4450the @option{virtio-rng} device. The @option{chardev} parameter is 4451the unique ID of a character device backend that provides the connection 4452to the RNG daemon. 4453 4454@item -object tls-creds-anon,id=@var{id},endpoint=@var{endpoint},dir=@var{/path/to/cred/dir},verify-peer=@var{on|off} 4455 4456Creates a TLS anonymous credentials object, which can be used to provide 4457TLS support on network backends. The @option{id} parameter is a unique 4458ID which network backends will use to access the credentials. The 4459@option{endpoint} is either @option{server} or @option{client} depending 4460on whether the QEMU network backend that uses the credentials will be 4461acting as a client or as a server. If @option{verify-peer} is enabled 4462(the default) then once the handshake is completed, the peer credentials 4463will be verified, though this is a no-op for anonymous credentials. 4464 4465The @var{dir} parameter tells QEMU where to find the credential 4466files. For server endpoints, this directory may contain a file 4467@var{dh-params.pem} providing diffie-hellman parameters to use 4468for the TLS server. If the file is missing, QEMU will generate 4469a set of DH parameters at startup. This is a computationally 4470expensive operation that consumes random pool entropy, so it is 4471recommended that a persistent set of parameters be generated 4472upfront and saved. 4473 4474@item -object tls-creds-psk,id=@var{id},endpoint=@var{endpoint},dir=@var{/path/to/keys/dir}[,username=@var{username}] 4475 4476Creates a TLS Pre-Shared Keys (PSK) credentials object, which can be used to provide 4477TLS support on network backends. The @option{id} parameter is a unique 4478ID which network backends will use to access the credentials. The 4479@option{endpoint} is either @option{server} or @option{client} depending 4480on whether the QEMU network backend that uses the credentials will be 4481acting as a client or as a server. For clients only, @option{username} 4482is the username which will be sent to the server. If omitted 4483it defaults to ``qemu''. 4484 4485The @var{dir} parameter tells QEMU where to find the keys file. 4486It is called ``@var{dir}/keys.psk'' and contains ``username:key'' 4487pairs. This file can most easily be created using the GnuTLS 4488@code{psktool} program. 4489 4490For server endpoints, @var{dir} may also contain a file 4491@var{dh-params.pem} providing diffie-hellman parameters to use 4492for the TLS server. If the file is missing, QEMU will generate 4493a set of DH parameters at startup. This is a computationally 4494expensive operation that consumes random pool entropy, so it is 4495recommended that a persistent set of parameters be generated 4496up front and saved. 4497 4498@item -object tls-creds-x509,id=@var{id},endpoint=@var{endpoint},dir=@var{/path/to/cred/dir},priority=@var{priority},verify-peer=@var{on|off},passwordid=@var{id} 4499 4500Creates a TLS anonymous credentials object, which can be used to provide 4501TLS support on network backends. The @option{id} parameter is a unique 4502ID which network backends will use to access the credentials. The 4503@option{endpoint} is either @option{server} or @option{client} depending 4504on whether the QEMU network backend that uses the credentials will be 4505acting as a client or as a server. If @option{verify-peer} is enabled 4506(the default) then once the handshake is completed, the peer credentials 4507will be verified. With x509 certificates, this implies that the clients 4508must be provided with valid client certificates too. 4509 4510The @var{dir} parameter tells QEMU where to find the credential 4511files. For server endpoints, this directory may contain a file 4512@var{dh-params.pem} providing diffie-hellman parameters to use 4513for the TLS server. If the file is missing, QEMU will generate 4514a set of DH parameters at startup. This is a computationally 4515expensive operation that consumes random pool entropy, so it is 4516recommended that a persistent set of parameters be generated 4517upfront and saved. 4518 4519For x509 certificate credentials the directory will contain further files 4520providing the x509 certificates. The certificates must be stored 4521in PEM format, in filenames @var{ca-cert.pem}, @var{ca-crl.pem} (optional), 4522@var{server-cert.pem} (only servers), @var{server-key.pem} (only servers), 4523@var{client-cert.pem} (only clients), and @var{client-key.pem} (only clients). 4524 4525For the @var{server-key.pem} and @var{client-key.pem} files which 4526contain sensitive private keys, it is possible to use an encrypted 4527version by providing the @var{passwordid} parameter. This provides 4528the ID of a previously created @code{secret} object containing the 4529password for decryption. 4530 4531The @var{priority} parameter allows to override the global default 4532priority used by gnutls. This can be useful if the system administrator 4533needs to use a weaker set of crypto priorities for QEMU without 4534potentially forcing the weakness onto all applications. Or conversely 4535if one wants wants a stronger default for QEMU than for all other 4536applications, they can do this through this parameter. Its format is 4537a gnutls priority string as described at 4538@url{https://gnutls.org/manual/html_node/Priority-Strings.html}. 4539 4540@item -object filter-buffer,id=@var{id},netdev=@var{netdevid},interval=@var{t}[,queue=@var{all|rx|tx}][,status=@var{on|off}] 4541 4542Interval @var{t} can't be 0, this filter batches the packet delivery: all 4543packets arriving in a given interval on netdev @var{netdevid} are delayed 4544until the end of the interval. Interval is in microseconds. 4545@option{status} is optional that indicate whether the netfilter is 4546on (enabled) or off (disabled), the default status for netfilter will be 'on'. 4547 4548queue @var{all|rx|tx} is an option that can be applied to any netfilter. 4549 4550@option{all}: the filter is attached both to the receive and the transmit 4551 queue of the netdev (default). 4552 4553@option{rx}: the filter is attached to the receive queue of the netdev, 4554 where it will receive packets sent to the netdev. 4555 4556@option{tx}: the filter is attached to the transmit queue of the netdev, 4557 where it will receive packets sent by the netdev. 4558 4559@item -object filter-mirror,id=@var{id},netdev=@var{netdevid},outdev=@var{chardevid},queue=@var{all|rx|tx}[,vnet_hdr_support] 4560 4561filter-mirror on netdev @var{netdevid},mirror net packet to chardev@var{chardevid}, if it has the vnet_hdr_support flag, filter-mirror will mirror packet with vnet_hdr_len. 4562 4563@item -object filter-redirector,id=@var{id},netdev=@var{netdevid},indev=@var{chardevid},outdev=@var{chardevid},queue=@var{all|rx|tx}[,vnet_hdr_support] 4564 4565filter-redirector on netdev @var{netdevid},redirect filter's net packet to chardev 4566@var{chardevid},and redirect indev's packet to filter.if it has the vnet_hdr_support flag, 4567filter-redirector will redirect packet with vnet_hdr_len. 4568Create a filter-redirector we need to differ outdev id from indev id, id can not 4569be the same. we can just use indev or outdev, but at least one of indev or outdev 4570need to be specified. 4571 4572@item -object filter-rewriter,id=@var{id},netdev=@var{netdevid},queue=@var{all|rx|tx},[vnet_hdr_support] 4573 4574Filter-rewriter is a part of COLO project.It will rewrite tcp packet to 4575secondary from primary to keep secondary tcp connection,and rewrite 4576tcp packet to primary from secondary make tcp packet can be handled by 4577client.if it has the vnet_hdr_support flag, we can parse packet with vnet header. 4578 4579usage: 4580colo secondary: 4581-object filter-redirector,id=f1,netdev=hn0,queue=tx,indev=red0 4582-object filter-redirector,id=f2,netdev=hn0,queue=rx,outdev=red1 4583-object filter-rewriter,id=rew0,netdev=hn0,queue=all 4584 4585@item -object filter-dump,id=@var{id},netdev=@var{dev}[,file=@var{filename}][,maxlen=@var{len}] 4586 4587Dump the network traffic on netdev @var{dev} to the file specified by 4588@var{filename}. At most @var{len} bytes (64k by default) per packet are stored. 4589The file format is libpcap, so it can be analyzed with tools such as tcpdump 4590or Wireshark. 4591 4592@item -object colo-compare,id=@var{id},primary_in=@var{chardevid},secondary_in=@var{chardevid},outdev=@var{chardevid},iothread=@var{id}[,vnet_hdr_support][,notify_dev=@var{id}] 4593 4594Colo-compare gets packet from primary_in@var{chardevid} and secondary_in@var{chardevid}, than compare primary packet with 4595secondary packet. If the packets are same, we will output primary 4596packet to outdev@var{chardevid}, else we will notify colo-frame 4597do checkpoint and send primary packet to outdev@var{chardevid}. 4598In order to improve efficiency, we need to put the task of comparison 4599in another thread. If it has the vnet_hdr_support flag, colo compare 4600will send/recv packet with vnet_hdr_len. 4601If you want to use Xen COLO, will need the notify_dev to notify Xen 4602colo-frame to do checkpoint. 4603 4604we must use it with the help of filter-mirror and filter-redirector. 4605 4606@example 4607 4608KVM COLO 4609 4610primary: 4611-netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,downscript=/etc/qemu-ifdown 4612-device e1000,id=e0,netdev=hn0,mac=52:a4:00:12:78:66 4613-chardev socket,id=mirror0,host=3.3.3.3,port=9003,server,nowait 4614-chardev socket,id=compare1,host=3.3.3.3,port=9004,server,nowait 4615-chardev socket,id=compare0,host=3.3.3.3,port=9001,server,nowait 4616-chardev socket,id=compare0-0,host=3.3.3.3,port=9001 4617-chardev socket,id=compare_out,host=3.3.3.3,port=9005,server,nowait 4618-chardev socket,id=compare_out0,host=3.3.3.3,port=9005 4619-object iothread,id=iothread1 4620-object filter-mirror,id=m0,netdev=hn0,queue=tx,outdev=mirror0 4621-object filter-redirector,netdev=hn0,id=redire0,queue=rx,indev=compare_out 4622-object filter-redirector,netdev=hn0,id=redire1,queue=rx,outdev=compare0 4623-object colo-compare,id=comp0,primary_in=compare0-0,secondary_in=compare1,outdev=compare_out0,iothread=iothread1 4624 4625secondary: 4626-netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,down script=/etc/qemu-ifdown 4627-device e1000,netdev=hn0,mac=52:a4:00:12:78:66 4628-chardev socket,id=red0,host=3.3.3.3,port=9003 4629-chardev socket,id=red1,host=3.3.3.3,port=9004 4630-object filter-redirector,id=f1,netdev=hn0,queue=tx,indev=red0 4631-object filter-redirector,id=f2,netdev=hn0,queue=rx,outdev=red1 4632 4633 4634Xen COLO 4635 4636primary: 4637-netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,downscript=/etc/qemu-ifdown 4638-device e1000,id=e0,netdev=hn0,mac=52:a4:00:12:78:66 4639-chardev socket,id=mirror0,host=3.3.3.3,port=9003,server,nowait 4640-chardev socket,id=compare1,host=3.3.3.3,port=9004,server,nowait 4641-chardev socket,id=compare0,host=3.3.3.3,port=9001,server,nowait 4642-chardev socket,id=compare0-0,host=3.3.3.3,port=9001 4643-chardev socket,id=compare_out,host=3.3.3.3,port=9005,server,nowait 4644-chardev socket,id=compare_out0,host=3.3.3.3,port=9005 4645-chardev socket,id=notify_way,host=3.3.3.3,port=9009,server,nowait 4646-object filter-mirror,id=m0,netdev=hn0,queue=tx,outdev=mirror0 4647-object filter-redirector,netdev=hn0,id=redire0,queue=rx,indev=compare_out 4648-object filter-redirector,netdev=hn0,id=redire1,queue=rx,outdev=compare0 4649-object iothread,id=iothread1 4650-object colo-compare,id=comp0,primary_in=compare0-0,secondary_in=compare1,outdev=compare_out0,notify_dev=nofity_way,iothread=iothread1 4651 4652secondary: 4653-netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,down script=/etc/qemu-ifdown 4654-device e1000,netdev=hn0,mac=52:a4:00:12:78:66 4655-chardev socket,id=red0,host=3.3.3.3,port=9003 4656-chardev socket,id=red1,host=3.3.3.3,port=9004 4657-object filter-redirector,id=f1,netdev=hn0,queue=tx,indev=red0 4658-object filter-redirector,id=f2,netdev=hn0,queue=rx,outdev=red1 4659 4660@end example 4661 4662If you want to know the detail of above command line, you can read 4663the colo-compare git log. 4664 4665@item -object cryptodev-backend-builtin,id=@var{id}[,queues=@var{queues}] 4666 4667Creates a cryptodev backend which executes crypto opreation from 4668the QEMU cipher APIS. The @var{id} parameter is 4669a unique ID that will be used to reference this cryptodev backend from 4670the @option{virtio-crypto} device. The @var{queues} parameter is optional, 4671which specify the queue number of cryptodev backend, the default of 4672@var{queues} is 1. 4673 4674@example 4675 4676 # @value{qemu_system} \ 4677 [...] \ 4678 -object cryptodev-backend-builtin,id=cryptodev0 \ 4679 -device virtio-crypto-pci,id=crypto0,cryptodev=cryptodev0 \ 4680 [...] 4681@end example 4682 4683@item -object cryptodev-vhost-user,id=@var{id},chardev=@var{chardevid}[,queues=@var{queues}] 4684 4685Creates a vhost-user cryptodev backend, backed by a chardev @var{chardevid}. 4686The @var{id} parameter is a unique ID that will be used to reference this 4687cryptodev backend from the @option{virtio-crypto} device. 4688The chardev should be a unix domain socket backed one. The vhost-user uses 4689a specifically defined protocol to pass vhost ioctl replacement messages 4690to an application on the other end of the socket. 4691The @var{queues} parameter is optional, which specify the queue number 4692of cryptodev backend for multiqueue vhost-user, the default of @var{queues} is 1. 4693 4694@example 4695 4696 # @value{qemu_system} \ 4697 [...] \ 4698 -chardev socket,id=chardev0,path=/path/to/socket \ 4699 -object cryptodev-vhost-user,id=cryptodev0,chardev=chardev0 \ 4700 -device virtio-crypto-pci,id=crypto0,cryptodev=cryptodev0 \ 4701 [...] 4702@end example 4703 4704@item -object secret,id=@var{id},data=@var{string},format=@var{raw|base64}[,keyid=@var{secretid},iv=@var{string}] 4705@item -object secret,id=@var{id},file=@var{filename},format=@var{raw|base64}[,keyid=@var{secretid},iv=@var{string}] 4706 4707Defines a secret to store a password, encryption key, or some other sensitive 4708data. The sensitive data can either be passed directly via the @var{data} 4709parameter, or indirectly via the @var{file} parameter. Using the @var{data} 4710parameter is insecure unless the sensitive data is encrypted. 4711 4712The sensitive data can be provided in raw format (the default), or base64. 4713When encoded as JSON, the raw format only supports valid UTF-8 characters, 4714so base64 is recommended for sending binary data. QEMU will convert from 4715which ever format is provided to the format it needs internally. eg, an 4716RBD password can be provided in raw format, even though it will be base64 4717encoded when passed onto the RBD sever. 4718 4719For added protection, it is possible to encrypt the data associated with 4720a secret using the AES-256-CBC cipher. Use of encryption is indicated 4721by providing the @var{keyid} and @var{iv} parameters. The @var{keyid} 4722parameter provides the ID of a previously defined secret that contains 4723the AES-256 decryption key. This key should be 32-bytes long and be 4724base64 encoded. The @var{iv} parameter provides the random initialization 4725vector used for encryption of this particular secret and should be a 4726base64 encrypted string of the 16-byte IV. 4727 4728The simplest (insecure) usage is to provide the secret inline 4729 4730@example 4731 4732 # @value{qemu_system} -object secret,id=sec0,data=letmein,format=raw 4733 4734@end example 4735 4736The simplest secure usage is to provide the secret via a file 4737 4738 # printf "letmein" > mypasswd.txt 4739 # @value{qemu_system} -object secret,id=sec0,file=mypasswd.txt,format=raw 4740 4741For greater security, AES-256-CBC should be used. To illustrate usage, 4742consider the openssl command line tool which can encrypt the data. Note 4743that when encrypting, the plaintext must be padded to the cipher block 4744size (32 bytes) using the standard PKCS#5/6 compatible padding algorithm. 4745 4746First a master key needs to be created in base64 encoding: 4747 4748@example 4749 # openssl rand -base64 32 > key.b64 4750 # KEY=$(base64 -d key.b64 | hexdump -v -e '/1 "%02X"') 4751@end example 4752 4753Each secret to be encrypted needs to have a random initialization vector 4754generated. These do not need to be kept secret 4755 4756@example 4757 # openssl rand -base64 16 > iv.b64 4758 # IV=$(base64 -d iv.b64 | hexdump -v -e '/1 "%02X"') 4759@end example 4760 4761The secret to be defined can now be encrypted, in this case we're 4762telling openssl to base64 encode the result, but it could be left 4763as raw bytes if desired. 4764 4765@example 4766 # SECRET=$(printf "letmein" | 4767 openssl enc -aes-256-cbc -a -K $KEY -iv $IV) 4768@end example 4769 4770When launching QEMU, create a master secret pointing to @code{key.b64} 4771and specify that to be used to decrypt the user password. Pass the 4772contents of @code{iv.b64} to the second secret 4773 4774@example 4775 # @value{qemu_system} \ 4776 -object secret,id=secmaster0,format=base64,file=key.b64 \ 4777 -object secret,id=sec0,keyid=secmaster0,format=base64,\ 4778 data=$SECRET,iv=$(<iv.b64) 4779@end example 4780 4781@item -object sev-guest,id=@var{id},cbitpos=@var{cbitpos},reduced-phys-bits=@var{val},[sev-device=@var{string},policy=@var{policy},handle=@var{handle},dh-cert-file=@var{file},session-file=@var{file}] 4782 4783Create a Secure Encrypted Virtualization (SEV) guest object, which can be used 4784to provide the guest memory encryption support on AMD processors. 4785 4786When memory encryption is enabled, one of the physical address bit (aka the 4787C-bit) is utilized to mark if a memory page is protected. The @option{cbitpos} 4788is used to provide the C-bit position. The C-bit position is Host family dependent 4789hence user must provide this value. On EPYC, the value should be 47. 4790 4791When memory encryption is enabled, we loose certain bits in physical address space. 4792The @option{reduced-phys-bits} is used to provide the number of bits we loose in 4793physical address space. Similar to C-bit, the value is Host family dependent. 4794On EPYC, the value should be 5. 4795 4796The @option{sev-device} provides the device file to use for communicating with 4797the SEV firmware running inside AMD Secure Processor. The default device is 4798'/dev/sev'. If hardware supports memory encryption then /dev/sev devices are 4799created by CCP driver. 4800 4801The @option{policy} provides the guest policy to be enforced by the SEV firmware 4802and restrict what configuration and operational commands can be performed on this 4803guest by the hypervisor. The policy should be provided by the guest owner and is 4804bound to the guest and cannot be changed throughout the lifetime of the guest. 4805The default is 0. 4806 4807If guest @option{policy} allows sharing the key with another SEV guest then 4808@option{handle} can be use to provide handle of the guest from which to share 4809the key. 4810 4811The @option{dh-cert-file} and @option{session-file} provides the guest owner's 4812Public Diffie-Hillman key defined in SEV spec. The PDH and session parameters 4813are used for establishing a cryptographic session with the guest owner to 4814negotiate keys used for attestation. The file must be encoded in base64. 4815 4816e.g to launch a SEV guest 4817@example 4818 # @value{qemu_system_x86} \ 4819 ...... 4820 -object sev-guest,id=sev0,cbitpos=47,reduced-phys-bits=5 \ 4821 -machine ...,memory-encryption=sev0 4822 ..... 4823 4824@end example 4825 4826 4827@item -object authz-simple,id=@var{id},identity=@var{string} 4828 4829Create an authorization object that will control access to network services. 4830 4831The @option{identity} parameter is identifies the user and its format 4832depends on the network service that authorization object is associated 4833with. For authorizing based on TLS x509 certificates, the identity must 4834be the x509 distinguished name. Note that care must be taken to escape 4835any commas in the distinguished name. 4836 4837An example authorization object to validate a x509 distinguished name 4838would look like: 4839@example 4840 # @value{qemu_system} \ 4841 ... 4842 -object 'authz-simple,id=auth0,identity=CN=laptop.example.com,,O=Example Org,,L=London,,ST=London,,C=GB' \ 4843 ... 4844@end example 4845 4846Note the use of quotes due to the x509 distinguished name containing 4847whitespace, and escaping of ','. 4848 4849@item -object authz-listfile,id=@var{id},filename=@var{path},refresh=@var{yes|no} 4850 4851Create an authorization object that will control access to network services. 4852 4853The @option{filename} parameter is the fully qualified path to a file 4854containing the access control list rules in JSON format. 4855 4856An example set of rules that match against SASL usernames might look 4857like: 4858 4859@example 4860 @{ 4861 "rules": [ 4862 @{ "match": "fred", "policy": "allow", "format": "exact" @}, 4863 @{ "match": "bob", "policy": "allow", "format": "exact" @}, 4864 @{ "match": "danb", "policy": "deny", "format": "glob" @}, 4865 @{ "match": "dan*", "policy": "allow", "format": "exact" @}, 4866 ], 4867 "policy": "deny" 4868 @} 4869@end example 4870 4871When checking access the object will iterate over all the rules and 4872the first rule to match will have its @option{policy} value returned 4873as the result. If no rules match, then the default @option{policy} 4874value is returned. 4875 4876The rules can either be an exact string match, or they can use the 4877simple UNIX glob pattern matching to allow wildcards to be used. 4878 4879If @option{refresh} is set to true the file will be monitored 4880and automatically reloaded whenever its content changes. 4881 4882As with the @code{authz-simple} object, the format of the identity 4883strings being matched depends on the network service, but is usually 4884a TLS x509 distinguished name, or a SASL username. 4885 4886An example authorization object to validate a SASL username 4887would look like: 4888@example 4889 # @value{qemu_system} \ 4890 ... 4891 -object authz-simple,id=auth0,filename=/etc/qemu/vnc-sasl.acl,refresh=yes 4892 ... 4893@end example 4894 4895@item -object authz-pam,id=@var{id},service=@var{string} 4896 4897Create an authorization object that will control access to network services. 4898 4899The @option{service} parameter provides the name of a PAM service to use 4900for authorization. It requires that a file @code{/etc/pam.d/@var{service}} 4901exist to provide the configuration for the @code{account} subsystem. 4902 4903An example authorization object to validate a TLS x509 distinguished 4904name would look like: 4905 4906@example 4907 # @value{qemu_system} \ 4908 ... 4909 -object authz-pam,id=auth0,service=qemu-vnc 4910 ... 4911@end example 4912 4913There would then be a corresponding config file for PAM at 4914@code{/etc/pam.d/qemu-vnc} that contains: 4915 4916@example 4917account requisite pam_listfile.so item=user sense=allow \ 4918 file=/etc/qemu/vnc.allow 4919@end example 4920 4921Finally the @code{/etc/qemu/vnc.allow} file would contain 4922the list of x509 distingished names that are permitted 4923access 4924 4925@example 4926CN=laptop.example.com,O=Example Home,L=London,ST=London,C=GB 4927@end example 4928 4929 4930@end table 4931 4932ETEXI 4933 4934 4935HXCOMM This is the last statement. Insert new options before this line! 4936STEXI 4937@end table 4938ETEXI 4939
