exec: Remove a type cast which is no longer needed
[qemu.git] / qemu-options.hx
blobef60730e4794fad73dbff76009ec74c4ddee9284
1 HXCOMM Use DEFHEADING() to define headings in both help text and texi
2 HXCOMM Text between STEXI and ETEXI are copied to texi version and
3 HXCOMM discarded from C version
4 HXCOMM DEF(option, HAS_ARG/0, opt_enum, opt_help, arch_mask) is used to
5 HXCOMM construct option structures, enums and help message for specified
6 HXCOMM architectures.
7 HXCOMM HXCOMM can be used for comments, discarded from both texi and C
9 DEFHEADING(Standard options:)
10 STEXI
11 @table @option
12 ETEXI
14 DEF("help", 0, QEMU_OPTION_h,
15 "-h or -help display this help and exit\n", QEMU_ARCH_ALL)
16 STEXI
17 @item -h
18 @findex -h
19 Display help and exit
20 ETEXI
22 DEF("version", 0, QEMU_OPTION_version,
23 "-version display version information and exit\n", QEMU_ARCH_ALL)
24 STEXI
25 @item -version
26 @findex -version
27 Display version information and exit
28 ETEXI
30 DEF("M", HAS_ARG, QEMU_OPTION_M,
31 "-M machine select emulated machine (-M ? for list)\n", QEMU_ARCH_ALL)
32 STEXI
33 @item -M @var{machine}
34 @findex -M
35 Select the emulated @var{machine} (@code{-M ?} for list)
36 ETEXI
38 DEF("cpu", HAS_ARG, QEMU_OPTION_cpu,
39 "-cpu cpu select CPU (-cpu ? for list)\n", QEMU_ARCH_ALL)
40 STEXI
41 @item -cpu @var{model}
42 @findex -cpu
43 Select CPU model (-cpu ? for list and additional feature selection)
44 ETEXI
46 DEF("smp", HAS_ARG, QEMU_OPTION_smp,
47 "-smp n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n"
48 " set the number of CPUs to 'n' [default=1]\n"
49 " maxcpus= maximum number of total cpus, including\n"
50 " offline CPUs for hotplug, etc\n"
51 " cores= number of CPU cores on one socket\n"
52 " threads= number of threads on one CPU core\n"
53 " sockets= number of discrete sockets in the system\n",
54 QEMU_ARCH_ALL)
55 STEXI
56 @item -smp @var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}]
57 @findex -smp
58 Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
59 CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs
60 to 4.
61 For the PC target, the number of @var{cores} per socket, the number
62 of @var{threads} per cores and the total number of @var{sockets} can be
63 specified. Missing values will be computed. If any on the three values is
64 given, the total number of CPUs @var{n} can be omitted. @var{maxcpus}
65 specifies the maximum number of hotpluggable CPUs.
66 ETEXI
68 DEF("numa", HAS_ARG, QEMU_OPTION_numa,
69 "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL)
70 STEXI
71 @item -numa @var{opts}
72 @findex -numa
73 Simulate a multi node NUMA system. If mem and cpus are omitted, resources
74 are split equally.
75 ETEXI
77 DEF("fda", HAS_ARG, QEMU_OPTION_fda,
78 "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL)
79 DEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL)
80 STEXI
81 @item -fda @var{file}
82 @item -fdb @var{file}
83 @findex -fda
84 @findex -fdb
85 Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can
86 use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}).
87 ETEXI
89 DEF("hda", HAS_ARG, QEMU_OPTION_hda,
90 "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL)
91 DEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL)
92 DEF("hdc", HAS_ARG, QEMU_OPTION_hdc,
93 "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL)
94 DEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL)
95 STEXI
96 @item -hda @var{file}
97 @item -hdb @var{file}
98 @item -hdc @var{file}
99 @item -hdd @var{file}
100 @findex -hda
101 @findex -hdb
102 @findex -hdc
103 @findex -hdd
104 Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
105 ETEXI
107 DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom,
108 "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n",
109 QEMU_ARCH_ALL)
110 STEXI
111 @item -cdrom @var{file}
112 @findex -cdrom
113 Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and
114 @option{-cdrom} at the same time). You can use the host CD-ROM by
115 using @file{/dev/cdrom} as filename (@pxref{host_drives}).
116 ETEXI
118 DEF("drive", HAS_ARG, QEMU_OPTION_drive,
119 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n"
120 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n"
121 " [,cache=writethrough|writeback|none|unsafe][,format=f]\n"
122 " [,serial=s][,addr=A][,id=name][,aio=threads|native]\n"
123 " [,readonly=on|off]\n"
124 " use 'file' as a drive image\n", QEMU_ARCH_ALL)
125 STEXI
126 @item -drive @var{option}[,@var{option}[,@var{option}[,...]]]
127 @findex -drive
129 Define a new drive. Valid options are:
131 @table @option
132 @item file=@var{file}
133 This option defines which disk image (@pxref{disk_images}) to use with
134 this drive. If the filename contains comma, you must double it
135 (for instance, "file=my,,file" to use file "my,file").
136 @item if=@var{interface}
137 This option defines on which type on interface the drive is connected.
138 Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio.
139 @item bus=@var{bus},unit=@var{unit}
140 These options define where is connected the drive by defining the bus number and
141 the unit id.
142 @item index=@var{index}
143 This option defines where is connected the drive by using an index in the list
144 of available connectors of a given interface type.
145 @item media=@var{media}
146 This option defines the type of the media: disk or cdrom.
147 @item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}]
148 These options have the same definition as they have in @option{-hdachs}.
149 @item snapshot=@var{snapshot}
150 @var{snapshot} is "on" or "off" and allows to enable snapshot for given drive (see @option{-snapshot}).
151 @item cache=@var{cache}
152 @var{cache} is "none", "writeback", "unsafe", or "writethrough" and controls how the host cache is used to access block data.
153 @item aio=@var{aio}
154 @var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO.
155 @item format=@var{format}
156 Specify which disk @var{format} will be used rather than detecting
157 the format. Can be used to specifiy format=raw to avoid interpreting
158 an untrusted format header.
159 @item serial=@var{serial}
160 This option specifies the serial number to assign to the device.
161 @item addr=@var{addr}
162 Specify the controller's PCI address (if=virtio only).
163 @end table
165 By default, writethrough caching is used for all block device. This means that
166 the host page cache will be used to read and write data but write notification
167 will be sent to the guest only when the data has been reported as written by
168 the storage subsystem.
170 Writeback caching will report data writes as completed as soon as the data is
171 present in the host page cache. This is safe as long as you trust your host.
172 If your host crashes or loses power, then the guest may experience data
173 corruption.
175 The host page cache can be avoided entirely with @option{cache=none}. This will
176 attempt to do disk IO directly to the guests memory. QEMU may still perform
177 an internal copy of the data.
179 Some block drivers perform badly with @option{cache=writethrough}, most notably,
180 qcow2. If performance is more important than correctness,
181 @option{cache=writeback} should be used with qcow2.
183 In case you don't care about data integrity over host failures, use
184 cache=unsafe. This option tells qemu that it never needs to write any data
185 to the disk but can instead keeps things in cache. If anything goes wrong,
186 like your host losing power, the disk storage getting disconnected accidently,
187 etc. you're image will most probably be rendered unusable. When using
188 the @option{-snapshot} option, unsafe caching is always used.
190 Instead of @option{-cdrom} you can use:
191 @example
192 qemu -drive file=file,index=2,media=cdrom
193 @end example
195 Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
196 use:
197 @example
198 qemu -drive file=file,index=0,media=disk
199 qemu -drive file=file,index=1,media=disk
200 qemu -drive file=file,index=2,media=disk
201 qemu -drive file=file,index=3,media=disk
202 @end example
204 You can connect a CDROM to the slave of ide0:
205 @example
206 qemu -drive file=file,if=ide,index=1,media=cdrom
207 @end example
209 If you don't specify the "file=" argument, you define an empty drive:
210 @example
211 qemu -drive if=ide,index=1,media=cdrom
212 @end example
214 You can connect a SCSI disk with unit ID 6 on the bus #0:
215 @example
216 qemu -drive file=file,if=scsi,bus=0,unit=6
217 @end example
219 Instead of @option{-fda}, @option{-fdb}, you can use:
220 @example
221 qemu -drive file=file,index=0,if=floppy
222 qemu -drive file=file,index=1,if=floppy
223 @end example
225 By default, @var{interface} is "ide" and @var{index} is automatically
226 incremented:
227 @example
228 qemu -drive file=a -drive file=b"
229 @end example
230 is interpreted like:
231 @example
232 qemu -hda a -hdb b
233 @end example
234 ETEXI
236 DEF("set", HAS_ARG, QEMU_OPTION_set,
237 "-set group.id.arg=value\n"
238 " set <arg> parameter for item <id> of type <group>\n"
239 " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL)
240 STEXI
241 @item -set
242 @findex -set
243 TODO
244 ETEXI
246 DEF("global", HAS_ARG, QEMU_OPTION_global,
247 "-global driver.property=value\n"
248 " set a global default for a driver property\n",
249 QEMU_ARCH_ALL)
250 STEXI
251 @item -global
252 @findex -global
253 TODO
254 ETEXI
256 DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock,
257 "-mtdblock file use 'file' as on-board Flash memory image\n",
258 QEMU_ARCH_ALL)
259 STEXI
260 @item -mtdblock @var{file}
261 @findex -mtdblock
262 Use @var{file} as on-board Flash memory image.
263 ETEXI
265 DEF("sd", HAS_ARG, QEMU_OPTION_sd,
266 "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL)
267 STEXI
268 @item -sd @var{file}
269 @findex -sd
270 Use @var{file} as SecureDigital card image.
271 ETEXI
273 DEF("pflash", HAS_ARG, QEMU_OPTION_pflash,
274 "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL)
275 STEXI
276 @item -pflash @var{file}
277 @findex -pflash
278 Use @var{file} as a parallel flash image.
279 ETEXI
281 DEF("boot", HAS_ARG, QEMU_OPTION_boot,
282 "-boot [order=drives][,once=drives][,menu=on|off]\n"
283 " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n",
284 QEMU_ARCH_ALL)
285 STEXI
286 @item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off]
287 @findex -boot
288 Specify boot order @var{drives} as a string of drive letters. Valid
289 drive letters depend on the target achitecture. The x86 PC uses: a, b
290 (floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot
291 from network adapter 1-4), hard disk boot is the default. To apply a
292 particular boot order only on the first startup, specify it via
293 @option{once}.
295 Interactive boot menus/prompts can be enabled via @option{menu=on} as far
296 as firmware/BIOS supports them. The default is non-interactive boot.
298 @example
299 # try to boot from network first, then from hard disk
300 qemu -boot order=nc
301 # boot from CD-ROM first, switch back to default order after reboot
302 qemu -boot once=d
303 @end example
305 Note: The legacy format '-boot @var{drives}' is still supported but its
306 use is discouraged as it may be removed from future versions.
307 ETEXI
309 DEF("snapshot", 0, QEMU_OPTION_snapshot,
310 "-snapshot write to temporary files instead of disk image files\n",
311 QEMU_ARCH_ALL)
312 STEXI
313 @item -snapshot
314 @findex -snapshot
315 Write to temporary files instead of disk image files. In this case,
316 the raw disk image you use is not written back. You can however force
317 the write back by pressing @key{C-a s} (@pxref{disk_images}).
318 ETEXI
320 DEF("m", HAS_ARG, QEMU_OPTION_m,
321 "-m megs set virtual RAM size to megs MB [default="
322 stringify(DEFAULT_RAM_SIZE) "]\n", QEMU_ARCH_ALL)
323 STEXI
324 @item -m @var{megs}
325 @findex -m
326 Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally,
327 a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
328 gigabytes respectively.
329 ETEXI
331 DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath,
332 "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL)
333 STEXI
334 @item -mem-path @var{path}
335 Allocate guest RAM from a temporarily created file in @var{path}.
336 ETEXI
338 #ifdef MAP_POPULATE
339 DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc,
340 "-mem-prealloc preallocate guest memory (use with -mem-path)\n",
341 QEMU_ARCH_ALL)
342 STEXI
343 @item -mem-prealloc
344 Preallocate memory when using -mem-path.
345 ETEXI
346 #endif
348 DEF("k", HAS_ARG, QEMU_OPTION_k,
349 "-k language use keyboard layout (for example 'fr' for French)\n",
350 QEMU_ARCH_ALL)
351 STEXI
352 @item -k @var{language}
353 @findex -k
354 Use keyboard layout @var{language} (for example @code{fr} for
355 French). This option is only needed where it is not easy to get raw PC
356 keycodes (e.g. on Macs, with some X11 servers or with a VNC
357 display). You don't normally need to use it on PC/Linux or PC/Windows
358 hosts.
360 The available layouts are:
361 @example
362 ar de-ch es fo fr-ca hu ja mk no pt-br sv
363 da en-gb et fr fr-ch is lt nl pl ru th
364 de en-us fi fr-be hr it lv nl-be pt sl tr
365 @end example
367 The default is @code{en-us}.
368 ETEXI
371 DEF("audio-help", 0, QEMU_OPTION_audio_help,
372 "-audio-help print list of audio drivers and their options\n",
373 QEMU_ARCH_ALL)
374 STEXI
375 @item -audio-help
376 @findex -audio-help
377 Will show the audio subsystem help: list of drivers, tunable
378 parameters.
379 ETEXI
381 DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw,
382 "-soundhw c1,... enable audio support\n"
383 " and only specified sound cards (comma separated list)\n"
384 " use -soundhw ? to get the list of supported cards\n"
385 " use -soundhw all to enable all of them\n", QEMU_ARCH_ALL)
386 STEXI
387 @item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
388 @findex -soundhw
389 Enable audio and selected sound hardware. Use ? to print all
390 available sound hardware.
392 @example
393 qemu -soundhw sb16,adlib disk.img
394 qemu -soundhw es1370 disk.img
395 qemu -soundhw ac97 disk.img
396 qemu -soundhw hda disk.img
397 qemu -soundhw all disk.img
398 qemu -soundhw ?
399 @end example
401 Note that Linux's i810_audio OSS kernel (for AC97) module might
402 require manually specifying clocking.
404 @example
405 modprobe i810_audio clocking=48000
406 @end example
407 ETEXI
409 STEXI
410 @end table
411 ETEXI
413 DEF("usb", 0, QEMU_OPTION_usb,
414 "-usb enable the USB driver (will be the default soon)\n",
415 QEMU_ARCH_ALL)
416 STEXI
417 USB options:
418 @table @option
420 @item -usb
421 @findex -usb
422 Enable the USB driver (will be the default soon)
423 ETEXI
425 DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice,
426 "-usbdevice name add the host or guest USB device 'name'\n",
427 QEMU_ARCH_ALL)
428 STEXI
430 @item -usbdevice @var{devname}
431 @findex -usbdevice
432 Add the USB device @var{devname}. @xref{usb_devices}.
434 @table @option
436 @item mouse
437 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
439 @item tablet
440 Pointer device that uses absolute coordinates (like a touchscreen). This
441 means qemu is able to report the mouse position without having to grab the
442 mouse. Also overrides the PS/2 mouse emulation when activated.
444 @item disk:[format=@var{format}]:@var{file}
445 Mass storage device based on file. The optional @var{format} argument
446 will be used rather than detecting the format. Can be used to specifiy
447 @code{format=raw} to avoid interpreting an untrusted format header.
449 @item host:@var{bus}.@var{addr}
450 Pass through the host device identified by @var{bus}.@var{addr} (Linux only).
452 @item host:@var{vendor_id}:@var{product_id}
453 Pass through the host device identified by @var{vendor_id}:@var{product_id}
454 (Linux only).
456 @item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
457 Serial converter to host character device @var{dev}, see @code{-serial} for the
458 available devices.
460 @item braille
461 Braille device. This will use BrlAPI to display the braille output on a real
462 or fake device.
464 @item net:@var{options}
465 Network adapter that supports CDC ethernet and RNDIS protocols.
467 @end table
468 ETEXI
470 DEF("device", HAS_ARG, QEMU_OPTION_device,
471 "-device driver[,prop[=value][,...]]\n"
472 " add device (based on driver)\n"
473 " prop=value,... sets driver properties\n"
474 " use -device ? to print all possible drivers\n"
475 " use -device driver,? to print all possible properties\n",
476 QEMU_ARCH_ALL)
477 STEXI
478 @item -device @var{driver}[,@var{prop}[=@var{value}][,...]]
479 @findex -device
480 Add device @var{driver}. @var{prop}=@var{value} sets driver
481 properties. Valid properties depend on the driver. To get help on
482 possible drivers and properties, use @code{-device ?} and
483 @code{-device @var{driver},?}.
484 ETEXI
486 DEFHEADING(File system options:)
488 DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev,
489 "-fsdev local,id=id,path=path,security_model=[mapped|passthrough|none]\n",
490 QEMU_ARCH_ALL)
492 STEXI
494 The general form of a File system device option is:
495 @table @option
497 @item -fsdev @var{fstype} ,id=@var{id} [,@var{options}]
498 @findex -fsdev
499 Fstype is one of:
500 @option{local},
501 The specific Fstype will determine the applicable options.
503 Options to each backend are described below.
505 @item -fsdev local ,id=@var{id} ,path=@var{path} ,security_model=@var{security_model}
507 Create a file-system-"device" for local-filesystem.
509 @option{local} is only available on Linux.
511 @option{path} specifies the path to be exported. @option{path} is required.
513 @option{security_model} specifies the security model to be followed.
514 @option{security_model} is required.
516 @end table
517 ETEXI
519 DEFHEADING(Virtual File system pass-through options:)
521 DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs,
522 "-virtfs local,path=path,mount_tag=tag,security_model=[mapped|passthrough|none]\n",
523 QEMU_ARCH_ALL)
525 STEXI
527 The general form of a Virtual File system pass-through option is:
528 @table @option
530 @item -virtfs @var{fstype} [,@var{options}]
531 @findex -virtfs
532 Fstype is one of:
533 @option{local},
534 The specific Fstype will determine the applicable options.
536 Options to each backend are described below.
538 @item -virtfs local ,path=@var{path} ,mount_tag=@var{mount_tag} ,security_model=@var{security_model}
540 Create a Virtual file-system-pass through for local-filesystem.
542 @option{local} is only available on Linux.
544 @option{path} specifies the path to be exported. @option{path} is required.
546 @option{security_model} specifies the security model to be followed.
547 @option{security_model} is required.
550 @option{mount_tag} specifies the tag with which the exported file is mounted.
551 @option{mount_tag} is required.
553 @end table
554 ETEXI
556 DEFHEADING()
558 DEF("name", HAS_ARG, QEMU_OPTION_name,
559 "-name string1[,process=string2]\n"
560 " set the name of the guest\n"
561 " string1 sets the window title and string2 the process name (on Linux)\n",
562 QEMU_ARCH_ALL)
563 STEXI
564 @item -name @var{name}
565 @findex -name
566 Sets the @var{name} of the guest.
567 This name will be displayed in the SDL window caption.
568 The @var{name} will also be used for the VNC server.
569 Also optionally set the top visible process name in Linux.
570 ETEXI
572 DEF("uuid", HAS_ARG, QEMU_OPTION_uuid,
573 "-uuid %08x-%04x-%04x-%04x-%012x\n"
574 " specify machine UUID\n", QEMU_ARCH_ALL)
575 STEXI
576 @item -uuid @var{uuid}
577 @findex -uuid
578 Set system UUID.
579 ETEXI
581 STEXI
582 @end table
583 ETEXI
585 DEFHEADING()
587 DEFHEADING(Display options:)
589 STEXI
590 @table @option
591 ETEXI
593 DEF("display", HAS_ARG, QEMU_OPTION_display,
594 "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n"
595 " [,window_close=on|off]|curses|none|\n"
596 " vnc=<display>[,<optargs>]\n"
597 " select display type\n", QEMU_ARCH_ALL)
598 STEXI
599 @item -display @var{type}
600 @findex -display
601 Select type of display to use. This option is a replacement for the
602 old style -sdl/-curses/... options. Valid values for @var{type} are
603 @table @option
604 @item sdl
605 Display video output via SDL (usually in a separate graphics
606 window; see the SDL documentation for other possibilities).
607 @item curses
608 Display video output via curses. For graphics device models which
609 support a text mode, QEMU can display this output using a
610 curses/ncurses interface. Nothing is displayed when the graphics
611 device is in graphical mode or if the graphics device does not support
612 a text mode. Generally only the VGA device models support text mode.
613 @item none
614 Do not display video output. The guest will still see an emulated
615 graphics card, but its output will not be displayed to the QEMU
616 user. This option differs from the -nographic option in that it
617 only affects what is done with video output; -nographic also changes
618 the destination of the serial and parallel port data.
619 @item vnc
620 Start a VNC server on display <arg>
621 @end table
622 ETEXI
624 DEF("nographic", 0, QEMU_OPTION_nographic,
625 "-nographic disable graphical output and redirect serial I/Os to console\n",
626 QEMU_ARCH_ALL)
627 STEXI
628 @item -nographic
629 @findex -nographic
630 Normally, QEMU uses SDL to display the VGA output. With this option,
631 you can totally disable graphical output so that QEMU is a simple
632 command line application. The emulated serial port is redirected on
633 the console. Therefore, you can still use QEMU to debug a Linux kernel
634 with a serial console.
635 ETEXI
637 DEF("curses", 0, QEMU_OPTION_curses,
638 "-curses use a curses/ncurses interface instead of SDL\n",
639 QEMU_ARCH_ALL)
640 STEXI
641 @item -curses
642 @findex curses
643 Normally, QEMU uses SDL to display the VGA output. With this option,
644 QEMU can display the VGA output when in text mode using a
645 curses/ncurses interface. Nothing is displayed in graphical mode.
646 ETEXI
648 DEF("no-frame", 0, QEMU_OPTION_no_frame,
649 "-no-frame open SDL window without a frame and window decorations\n",
650 QEMU_ARCH_ALL)
651 STEXI
652 @item -no-frame
653 @findex -no-frame
654 Do not use decorations for SDL windows and start them using the whole
655 available screen space. This makes the using QEMU in a dedicated desktop
656 workspace more convenient.
657 ETEXI
659 DEF("alt-grab", 0, QEMU_OPTION_alt_grab,
660 "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n",
661 QEMU_ARCH_ALL)
662 STEXI
663 @item -alt-grab
664 @findex -alt-grab
665 Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt).
666 ETEXI
668 DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab,
669 "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n",
670 QEMU_ARCH_ALL)
671 STEXI
672 @item -ctrl-grab
673 @findex -ctrl-grab
674 Use Right-Ctrl to grab mouse (instead of Ctrl-Alt).
675 ETEXI
677 DEF("no-quit", 0, QEMU_OPTION_no_quit,
678 "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL)
679 STEXI
680 @item -no-quit
681 @findex -no-quit
682 Disable SDL window close capability.
683 ETEXI
685 DEF("sdl", 0, QEMU_OPTION_sdl,
686 "-sdl enable SDL\n", QEMU_ARCH_ALL)
687 STEXI
688 @item -sdl
689 @findex -sdl
690 Enable SDL.
691 ETEXI
693 DEF("spice", HAS_ARG, QEMU_OPTION_spice,
694 "-spice <args> enable spice\n", QEMU_ARCH_ALL)
695 STEXI
696 @item -spice @var{option}[,@var{option}[,...]]
697 @findex -spice
698 Enable the spice remote desktop protocol. Valid options are
700 @table @option
702 @item port=<nr>
703 Set the TCP port spice is listening on for plaintext channels.
705 @item addr=<addr>
706 Set the IP address spice is listening on. Default is any address.
708 @item ipv4
709 @item ipv6
710 Force using the specified IP version.
712 @item password=<secret>
713 Set the password you need to authenticate.
715 @item disable-ticketing
716 Allow client connects without authentication.
718 @item tls-port=<nr>
719 Set the TCP port spice is listening on for encrypted channels.
721 @item x509-dir=<dir>
722 Set the x509 file directory. Expects same filenames as -vnc $display,x509=$dir
724 @item x509-key-file=<file>
725 @item x509-key-password=<file>
726 @item x509-cert-file=<file>
727 @item x509-cacert-file=<file>
728 @item x509-dh-key-file=<file>
729 The x509 file names can also be configured individually.
731 @item tls-ciphers=<list>
732 Specify which ciphers to use.
734 @item tls-channel=[main|display|inputs|record|playback|tunnel]
735 @item plaintext-channel=[main|display|inputs|record|playback|tunnel]
736 Force specific channel to be used with or without TLS encryption. The
737 options can be specified multiple times to configure multiple
738 channels. The special name "default" can be used to set the default
739 mode. For channels which are not explicitly forced into one mode the
740 spice client is allowed to pick tls/plaintext as he pleases.
742 @item image-compression=[auto_glz|auto_lz|quic|glz|lz|off]
743 Configure image compression (lossless).
744 Default is auto_glz.
746 @item jpeg-wan-compression=[auto|never|always]
747 @item zlib-glz-wan-compression=[auto|never|always]
748 Configure wan image compression (lossy for slow links).
749 Default is auto.
751 @item streaming-video=[off|all|filter]
752 Configure video stream detection. Default is filter.
754 @item agent-mouse=[on|off]
755 Enable/disable passing mouse events via vdagent. Default is on.
757 @item playback-compression=[on|off]
758 Enable/disable audio stream compression (using celt 0.5.1). Default is on.
760 @end table
761 ETEXI
763 DEF("portrait", 0, QEMU_OPTION_portrait,
764 "-portrait rotate graphical output 90 deg left (only PXA LCD)\n",
765 QEMU_ARCH_ALL)
766 STEXI
767 @item -portrait
768 @findex -portrait
769 Rotate graphical output 90 deg left (only PXA LCD).
770 ETEXI
772 DEF("vga", HAS_ARG, QEMU_OPTION_vga,
773 "-vga [std|cirrus|vmware|qxl|xenfb|none]\n"
774 " select video card type\n", QEMU_ARCH_ALL)
775 STEXI
776 @item -vga @var{type}
777 @findex -vga
778 Select type of VGA card to emulate. Valid values for @var{type} are
779 @table @option
780 @item cirrus
781 Cirrus Logic GD5446 Video card. All Windows versions starting from
782 Windows 95 should recognize and use this graphic card. For optimal
783 performances, use 16 bit color depth in the guest and the host OS.
784 (This one is the default)
785 @item std
786 Standard VGA card with Bochs VBE extensions. If your guest OS
787 supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
788 to use high resolution modes (>= 1280x1024x16) then you should use
789 this option.
790 @item vmware
791 VMWare SVGA-II compatible adapter. Use it if you have sufficiently
792 recent XFree86/XOrg server or Windows guest with a driver for this
793 card.
794 @item qxl
795 QXL paravirtual graphic card. It is VGA compatible (including VESA
796 2.0 VBE support). Works best with qxl guest drivers installed though.
797 Recommended choice when using the spice protocol.
798 @item none
799 Disable VGA card.
800 @end table
801 ETEXI
803 DEF("full-screen", 0, QEMU_OPTION_full_screen,
804 "-full-screen start in full screen\n", QEMU_ARCH_ALL)
805 STEXI
806 @item -full-screen
807 @findex -full-screen
808 Start in full screen.
809 ETEXI
811 DEF("g", 1, QEMU_OPTION_g ,
812 "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n",
813 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
814 STEXI
815 @item -g @var{width}x@var{height}[x@var{depth}]
816 @findex -g
817 Set the initial graphical resolution and depth (PPC, SPARC only).
818 ETEXI
820 DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
821 "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL)
822 STEXI
823 @item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
824 @findex -vnc
825 Normally, QEMU uses SDL to display the VGA output. With this option,
826 you can have QEMU listen on VNC display @var{display} and redirect the VGA
827 display over the VNC session. It is very useful to enable the usb
828 tablet device when using this option (option @option{-usbdevice
829 tablet}). When using the VNC display, you must use the @option{-k}
830 parameter to set the keyboard layout if you are not using en-us. Valid
831 syntax for the @var{display} is
833 @table @option
835 @item @var{host}:@var{d}
837 TCP connections will only be allowed from @var{host} on display @var{d}.
838 By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
839 be omitted in which case the server will accept connections from any host.
841 @item unix:@var{path}
843 Connections will be allowed over UNIX domain sockets where @var{path} is the
844 location of a unix socket to listen for connections on.
846 @item none
848 VNC is initialized but not started. The monitor @code{change} command
849 can be used to later start the VNC server.
851 @end table
853 Following the @var{display} value there may be one or more @var{option} flags
854 separated by commas. Valid options are
856 @table @option
858 @item reverse
860 Connect to a listening VNC client via a ``reverse'' connection. The
861 client is specified by the @var{display}. For reverse network
862 connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
863 is a TCP port number, not a display number.
865 @item password
867 Require that password based authentication is used for client connections.
868 The password must be set separately using the @code{change} command in the
869 @ref{pcsys_monitor}
871 @item tls
873 Require that client use TLS when communicating with the VNC server. This
874 uses anonymous TLS credentials so is susceptible to a man-in-the-middle
875 attack. It is recommended that this option be combined with either the
876 @option{x509} or @option{x509verify} options.
878 @item x509=@var{/path/to/certificate/dir}
880 Valid if @option{tls} is specified. Require that x509 credentials are used
881 for negotiating the TLS session. The server will send its x509 certificate
882 to the client. It is recommended that a password be set on the VNC server
883 to provide authentication of the client when this is used. The path following
884 this option specifies where the x509 certificates are to be loaded from.
885 See the @ref{vnc_security} section for details on generating certificates.
887 @item x509verify=@var{/path/to/certificate/dir}
889 Valid if @option{tls} is specified. Require that x509 credentials are used
890 for negotiating the TLS session. The server will send its x509 certificate
891 to the client, and request that the client send its own x509 certificate.
892 The server will validate the client's certificate against the CA certificate,
893 and reject clients when validation fails. If the certificate authority is
894 trusted, this is a sufficient authentication mechanism. You may still wish
895 to set a password on the VNC server as a second authentication layer. The
896 path following this option specifies where the x509 certificates are to
897 be loaded from. See the @ref{vnc_security} section for details on generating
898 certificates.
900 @item sasl
902 Require that the client use SASL to authenticate with the VNC server.
903 The exact choice of authentication method used is controlled from the
904 system / user's SASL configuration file for the 'qemu' service. This
905 is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
906 unprivileged user, an environment variable SASL_CONF_PATH can be used
907 to make it search alternate locations for the service config.
908 While some SASL auth methods can also provide data encryption (eg GSSAPI),
909 it is recommended that SASL always be combined with the 'tls' and
910 'x509' settings to enable use of SSL and server certificates. This
911 ensures a data encryption preventing compromise of authentication
912 credentials. See the @ref{vnc_security} section for details on using
913 SASL authentication.
915 @item acl
917 Turn on access control lists for checking of the x509 client certificate
918 and SASL party. For x509 certs, the ACL check is made against the
919 certificate's distinguished name. This is something that looks like
920 @code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
921 made against the username, which depending on the SASL plugin, may
922 include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
923 When the @option{acl} flag is set, the initial access list will be
924 empty, with a @code{deny} policy. Thus no one will be allowed to
925 use the VNC server until the ACLs have been loaded. This can be
926 achieved using the @code{acl} monitor command.
928 @item lossy
930 Enable lossy compression methods (gradient, JPEG, ...). If this
931 option is set, VNC client may receive lossy framebuffer updates
932 depending on its encoding settings. Enabling this option can save
933 a lot of bandwidth at the expense of quality.
935 @item non-adaptive
937 Disable adaptive encodings. Adaptive encodings are enabled by default.
938 An adaptive encoding will try to detect frequently updated screen regions,
939 and send updates in these regions using a lossy encoding (like JPEG).
940 This can be really helpfull to save bandwidth when playing videos. Disabling
941 adaptive encodings allow to restore the original static behavior of encodings
942 like Tight.
944 @end table
945 ETEXI
947 STEXI
948 @end table
949 ETEXI
951 DEFHEADING()
953 DEFHEADING(i386 target only:)
954 STEXI
955 @table @option
956 ETEXI
958 DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack,
959 "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n",
960 QEMU_ARCH_I386)
961 STEXI
962 @item -win2k-hack
963 @findex -win2k-hack
964 Use it when installing Windows 2000 to avoid a disk full bug. After
965 Windows 2000 is installed, you no longer need this option (this option
966 slows down the IDE transfers).
967 ETEXI
969 HXCOMM Deprecated by -rtc
970 DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386)
972 DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk,
973 "-no-fd-bootchk disable boot signature checking for floppy disks\n",
974 QEMU_ARCH_I386)
975 STEXI
976 @item -no-fd-bootchk
977 @findex -no-fd-bootchk
978 Disable boot signature checking for floppy disks in Bochs BIOS. It may
979 be needed to boot from old floppy disks.
980 TODO: check reference to Bochs BIOS.
981 ETEXI
983 DEF("no-acpi", 0, QEMU_OPTION_no_acpi,
984 "-no-acpi disable ACPI\n", QEMU_ARCH_I386)
985 STEXI
986 @item -no-acpi
987 @findex -no-acpi
988 Disable ACPI (Advanced Configuration and Power Interface) support. Use
989 it if your guest OS complains about ACPI problems (PC target machine
990 only).
991 ETEXI
993 DEF("no-hpet", 0, QEMU_OPTION_no_hpet,
994 "-no-hpet disable HPET\n", QEMU_ARCH_I386)
995 STEXI
996 @item -no-hpet
997 @findex -no-hpet
998 Disable HPET support.
999 ETEXI
1001 DEF("balloon", HAS_ARG, QEMU_OPTION_balloon,
1002 "-balloon none disable balloon device\n"
1003 "-balloon virtio[,addr=str]\n"
1004 " enable virtio balloon device (default)\n", QEMU_ARCH_ALL)
1005 STEXI
1006 @item -balloon none
1007 @findex -balloon
1008 Disable balloon device.
1009 @item -balloon virtio[,addr=@var{addr}]
1010 Enable virtio balloon device (default), optionally with PCI address
1011 @var{addr}.
1012 ETEXI
1014 DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable,
1015 "-acpitable [sig=str][,rev=n][,oem_id=str][,oem_table_id=str][,oem_rev=n][,asl_compiler_id=str][,asl_compiler_rev=n][,data=file1[:file2]...]\n"
1016 " ACPI table description\n", QEMU_ARCH_I386)
1017 STEXI
1018 @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}]...]
1019 @findex -acpitable
1020 Add ACPI table with specified header fields and context from specified files.
1021 ETEXI
1023 DEF("smbios", HAS_ARG, QEMU_OPTION_smbios,
1024 "-smbios file=binary\n"
1025 " load SMBIOS entry from binary file\n"
1026 "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n"
1027 " specify SMBIOS type 0 fields\n"
1028 "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n"
1029 " [,uuid=uuid][,sku=str][,family=str]\n"
1030 " specify SMBIOS type 1 fields\n", QEMU_ARCH_I386)
1031 STEXI
1032 @item -smbios file=@var{binary}
1033 @findex -smbios
1034 Load SMBIOS entry from binary file.
1036 @item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}]
1037 @findex -smbios
1038 Specify SMBIOS type 0 fields
1040 @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}]
1041 Specify SMBIOS type 1 fields
1042 ETEXI
1044 DEFHEADING()
1045 STEXI
1046 @end table
1047 ETEXI
1049 DEFHEADING(Network options:)
1050 STEXI
1051 @table @option
1052 ETEXI
1054 HXCOMM Legacy slirp options (now moved to -net user):
1055 #ifdef CONFIG_SLIRP
1056 DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL)
1057 DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL)
1058 DEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL)
1059 #ifndef _WIN32
1060 DEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL)
1061 #endif
1062 #endif
1064 DEF("net", HAS_ARG, QEMU_OPTION_net,
1065 "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n"
1066 " create a new Network Interface Card and connect it to VLAN 'n'\n"
1067 #ifdef CONFIG_SLIRP
1068 "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=y|n]\n"
1069 " [,hostname=host][,dhcpstart=addr][,dns=addr][,tftp=dir][,bootfile=f]\n"
1070 " [,hostfwd=rule][,guestfwd=rule]"
1071 #ifndef _WIN32
1072 "[,smb=dir[,smbserver=addr]]\n"
1073 #endif
1074 " connect the user mode network stack to VLAN 'n', configure its\n"
1075 " DHCP server and enabled optional services\n"
1076 #endif
1077 #ifdef _WIN32
1078 "-net tap[,vlan=n][,name=str],ifname=name\n"
1079 " connect the host TAP network interface to VLAN 'n'\n"
1080 #else
1081 "-net tap[,vlan=n][,name=str][,fd=h][,ifname=name][,script=file][,downscript=dfile][,sndbuf=nbytes][,vnet_hdr=on|off][,vhost=on|off][,vhostfd=h][,vhostforce=on|off]\n"
1082 " connect the host TAP network interface to VLAN 'n' and use the\n"
1083 " network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n"
1084 " and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n"
1085 " use '[down]script=no' to disable script execution\n"
1086 " use 'fd=h' to connect to an already opened TAP interface\n"
1087 " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n"
1088 " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n"
1089 " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n"
1090 " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n"
1091 " use vhost=on to enable experimental in kernel accelerator\n"
1092 " (only has effect for virtio guests which use MSIX)\n"
1093 " use vhostforce=on to force vhost on for non-MSIX virtio guests\n"
1094 " use 'vhostfd=h' to connect to an already opened vhost net device\n"
1095 #endif
1096 "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n"
1097 " connect the vlan 'n' to another VLAN using a socket connection\n"
1098 "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port[,localaddr=addr]]\n"
1099 " connect the vlan 'n' to multicast maddr and port\n"
1100 " use 'localaddr=addr' to specify the host address to send packets from\n"
1101 #ifdef CONFIG_VDE
1102 "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n"
1103 " connect the vlan 'n' to port 'n' of a vde switch running\n"
1104 " on host and listening for incoming connections on 'socketpath'.\n"
1105 " Use group 'groupname' and mode 'octalmode' to change default\n"
1106 " ownership and permissions for communication port.\n"
1107 #endif
1108 "-net dump[,vlan=n][,file=f][,len=n]\n"
1109 " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n"
1110 "-net none use it alone to have zero network devices. If no -net option\n"
1111 " is provided, the default is '-net nic -net user'\n", QEMU_ARCH_ALL)
1112 DEF("netdev", HAS_ARG, QEMU_OPTION_netdev,
1113 "-netdev ["
1114 #ifdef CONFIG_SLIRP
1115 "user|"
1116 #endif
1117 "tap|"
1118 #ifdef CONFIG_VDE
1119 "vde|"
1120 #endif
1121 "socket],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL)
1122 STEXI
1123 @item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}]
1124 @findex -net
1125 Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
1126 = 0 is the default). The NIC is an e1000 by default on the PC
1127 target. Optionally, the MAC address can be changed to @var{mac}, the
1128 device address set to @var{addr} (PCI cards only),
1129 and a @var{name} can be assigned for use in monitor commands.
1130 Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
1131 that the card should have; this option currently only affects virtio cards; set
1132 @var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
1133 NIC is created. Qemu can emulate several different models of network card.
1134 Valid values for @var{type} are
1135 @code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er},
1136 @code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
1137 @code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
1138 Not all devices are supported on all targets. Use -net nic,model=?
1139 for a list of available devices for your target.
1141 @item -net user[,@var{option}][,@var{option}][,...]
1142 Use the user mode network stack which requires no administrator
1143 privilege to run. Valid options are:
1145 @table @option
1146 @item vlan=@var{n}
1147 Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default).
1149 @item name=@var{name}
1150 Assign symbolic name for use in monitor commands.
1152 @item net=@var{addr}[/@var{mask}]
1153 Set IP network address the guest will see. Optionally specify the netmask,
1154 either in the form a.b.c.d or as number of valid top-most bits. Default is
1155 10.0.2.0/8.
1157 @item host=@var{addr}
1158 Specify the guest-visible address of the host. Default is the 2nd IP in the
1159 guest network, i.e. x.x.x.2.
1161 @item restrict=y|yes|n|no
1162 If this options is enabled, the guest will be isolated, i.e. it will not be
1163 able to contact the host and no guest IP packets will be routed over the host
1164 to the outside. This option does not affect explicitly set forwarding rule.
1166 @item hostname=@var{name}
1167 Specifies the client hostname reported by the builtin DHCP server.
1169 @item dhcpstart=@var{addr}
1170 Specify the first of the 16 IPs the built-in DHCP server can assign. Default
1171 is the 16th to 31st IP in the guest network, i.e. x.x.x.16 to x.x.x.31.
1173 @item dns=@var{addr}
1174 Specify the guest-visible address of the virtual nameserver. The address must
1175 be different from the host address. Default is the 3rd IP in the guest network,
1176 i.e. x.x.x.3.
1178 @item tftp=@var{dir}
1179 When using the user mode network stack, activate a built-in TFTP
1180 server. The files in @var{dir} will be exposed as the root of a TFTP server.
1181 The TFTP client on the guest must be configured in binary mode (use the command
1182 @code{bin} of the Unix TFTP client).
1184 @item bootfile=@var{file}
1185 When using the user mode network stack, broadcast @var{file} as the BOOTP
1186 filename. In conjunction with @option{tftp}, this can be used to network boot
1187 a guest from a local directory.
1189 Example (using pxelinux):
1190 @example
1191 qemu -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
1192 @end example
1194 @item smb=@var{dir}[,smbserver=@var{addr}]
1195 When using the user mode network stack, activate a built-in SMB
1196 server so that Windows OSes can access to the host files in @file{@var{dir}}
1197 transparently. The IP address of the SMB server can be set to @var{addr}. By
1198 default the 4th IP in the guest network is used, i.e. x.x.x.4.
1200 In the guest Windows OS, the line:
1201 @example
1202 10.0.2.4 smbserver
1203 @end example
1204 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
1205 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
1207 Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
1209 Note that a SAMBA server must be installed on the host OS in
1210 @file{/usr/sbin/smbd}. QEMU was tested successfully with smbd versions from
1211 Red Hat 9, Fedora Core 3 and OpenSUSE 11.x.
1213 @item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
1214 Redirect incoming TCP or UDP connections to the host port @var{hostport} to
1215 the guest IP address @var{guestaddr} on guest port @var{guestport}. If
1216 @var{guestaddr} is not specified, its value is x.x.x.15 (default first address
1217 given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
1218 be bound to a specific host interface. If no connection type is set, TCP is
1219 used. This option can be given multiple times.
1221 For example, to redirect host X11 connection from screen 1 to guest
1222 screen 0, use the following:
1224 @example
1225 # on the host
1226 qemu -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...]
1227 # this host xterm should open in the guest X11 server
1228 xterm -display :1
1229 @end example
1231 To redirect telnet connections from host port 5555 to telnet port on
1232 the guest, use the following:
1234 @example
1235 # on the host
1236 qemu -net user,hostfwd=tcp::5555-:23 [...]
1237 telnet localhost 5555
1238 @end example
1240 Then when you use on the host @code{telnet localhost 5555}, you
1241 connect to the guest telnet server.
1243 @item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
1244 Forward guest TCP connections to the IP address @var{server} on port @var{port}
1245 to the character device @var{dev}. This option can be given multiple times.
1247 @end table
1249 Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still
1250 processed and applied to -net user. Mixing them with the new configuration
1251 syntax gives undefined results. Their use for new applications is discouraged
1252 as they will be removed from future versions.
1254 @item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}] [,script=@var{file}][,downscript=@var{dfile}]
1255 Connect the host TAP network interface @var{name} to VLAN @var{n}, use
1256 the network script @var{file} to configure it and the network script
1257 @var{dfile} to deconfigure it. If @var{name} is not provided, the OS
1258 automatically provides one. @option{fd}=@var{h} can be used to specify
1259 the handle of an already opened host TAP interface. The default network
1260 configure script is @file{/etc/qemu-ifup} and the default network
1261 deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no}
1262 or @option{downscript=no} to disable script execution. Example:
1264 @example
1265 qemu linux.img -net nic -net tap
1266 @end example
1268 More complicated example (two NICs, each one connected to a TAP device)
1269 @example
1270 qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
1271 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
1272 @end example
1274 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
1276 Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
1277 machine using a TCP socket connection. If @option{listen} is
1278 specified, QEMU waits for incoming connections on @var{port}
1279 (@var{host} is optional). @option{connect} is used to connect to
1280 another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
1281 specifies an already opened TCP socket.
1283 Example:
1284 @example
1285 # launch a first QEMU instance
1286 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1287 -net socket,listen=:1234
1288 # connect the VLAN 0 of this instance to the VLAN 0
1289 # of the first instance
1290 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1291 -net socket,connect=127.0.0.1:1234
1292 @end example
1294 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]]
1296 Create a VLAN @var{n} shared with another QEMU virtual
1297 machines using a UDP multicast socket, effectively making a bus for
1298 every QEMU with same multicast address @var{maddr} and @var{port}.
1299 NOTES:
1300 @enumerate
1301 @item
1302 Several QEMU can be running on different hosts and share same bus (assuming
1303 correct multicast setup for these hosts).
1304 @item
1305 mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
1306 @url{http://user-mode-linux.sf.net}.
1307 @item
1308 Use @option{fd=h} to specify an already opened UDP multicast socket.
1309 @end enumerate
1311 Example:
1312 @example
1313 # launch one QEMU instance
1314 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1315 -net socket,mcast=230.0.0.1:1234
1316 # launch another QEMU instance on same "bus"
1317 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1318 -net socket,mcast=230.0.0.1:1234
1319 # launch yet another QEMU instance on same "bus"
1320 qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
1321 -net socket,mcast=230.0.0.1:1234
1322 @end example
1324 Example (User Mode Linux compat.):
1325 @example
1326 # launch QEMU instance (note mcast address selected
1327 # is UML's default)
1328 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1329 -net socket,mcast=239.192.168.1:1102
1330 # launch UML
1331 /path/to/linux ubd0=/path/to/root_fs eth0=mcast
1332 @end example
1334 Example (send packets from host's 1.2.3.4):
1335 @example
1336 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1337 -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4
1338 @end example
1340 @item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
1341 Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
1342 listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
1343 and MODE @var{octalmode} to change default ownership and permissions for
1344 communication port. This option is available only if QEMU has been compiled
1345 with vde support enabled.
1347 Example:
1348 @example
1349 # launch vde switch
1350 vde_switch -F -sock /tmp/myswitch
1351 # launch QEMU instance
1352 qemu linux.img -net nic -net vde,sock=/tmp/myswitch
1353 @end example
1355 @item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
1356 Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
1357 At most @var{len} bytes (64k by default) per packet are stored. The file format is
1358 libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
1360 @item -net none
1361 Indicate that no network devices should be configured. It is used to
1362 override the default configuration (@option{-net nic -net user}) which
1363 is activated if no @option{-net} options are provided.
1365 @end table
1366 ETEXI
1368 DEFHEADING()
1370 DEFHEADING(Character device options:)
1372 DEF("chardev", HAS_ARG, QEMU_OPTION_chardev,
1373 "-chardev null,id=id[,mux=on|off]\n"
1374 "-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n"
1375 " [,server][,nowait][,telnet][,mux=on|off] (tcp)\n"
1376 "-chardev socket,id=id,path=path[,server][,nowait][,telnet],[mux=on|off] (unix)\n"
1377 "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n"
1378 " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n"
1379 "-chardev msmouse,id=id[,mux=on|off]\n"
1380 "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n"
1381 " [,mux=on|off]\n"
1382 "-chardev file,id=id,path=path[,mux=on|off]\n"
1383 "-chardev pipe,id=id,path=path[,mux=on|off]\n"
1384 #ifdef _WIN32
1385 "-chardev console,id=id[,mux=on|off]\n"
1386 "-chardev serial,id=id,path=path[,mux=on|off]\n"
1387 #else
1388 "-chardev pty,id=id[,mux=on|off]\n"
1389 "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n"
1390 #endif
1391 #ifdef CONFIG_BRLAPI
1392 "-chardev braille,id=id[,mux=on|off]\n"
1393 #endif
1394 #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
1395 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
1396 "-chardev tty,id=id,path=path[,mux=on|off]\n"
1397 #endif
1398 #if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__)
1399 "-chardev parport,id=id,path=path[,mux=on|off]\n"
1400 #endif
1401 #if defined(CONFIG_SPICE)
1402 "-chardev spicevmc,id=id,name=name[,debug=debug]\n"
1403 #endif
1404 , QEMU_ARCH_ALL
1407 STEXI
1409 The general form of a character device option is:
1410 @table @option
1412 @item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}]
1413 @findex -chardev
1414 Backend is one of:
1415 @option{null},
1416 @option{socket},
1417 @option{udp},
1418 @option{msmouse},
1419 @option{vc},
1420 @option{file},
1421 @option{pipe},
1422 @option{console},
1423 @option{serial},
1424 @option{pty},
1425 @option{stdio},
1426 @option{braille},
1427 @option{tty},
1428 @option{parport},
1429 @option{spicevmc}.
1430 The specific backend will determine the applicable options.
1432 All devices must have an id, which can be any string up to 127 characters long.
1433 It is used to uniquely identify this device in other command line directives.
1435 A character device may be used in multiplexing mode by multiple front-ends.
1436 The key sequence of @key{Control-a} and @key{c} will rotate the input focus
1437 between attached front-ends. Specify @option{mux=on} to enable this mode.
1439 Options to each backend are described below.
1441 @item -chardev null ,id=@var{id}
1442 A void device. This device will not emit any data, and will drop any data it
1443 receives. The null backend does not take any options.
1445 @item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet]
1447 Create a two-way stream socket, which can be either a TCP or a unix socket. A
1448 unix socket will be created if @option{path} is specified. Behaviour is
1449 undefined if TCP options are specified for a unix socket.
1451 @option{server} specifies that the socket shall be a listening socket.
1453 @option{nowait} specifies that QEMU should not block waiting for a client to
1454 connect to a listening socket.
1456 @option{telnet} specifies that traffic on the socket should interpret telnet
1457 escape sequences.
1459 TCP and unix socket options are given below:
1461 @table @option
1463 @item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay]
1465 @option{host} for a listening socket specifies the local address to be bound.
1466 For a connecting socket species the remote host to connect to. @option{host} is
1467 optional for listening sockets. If not specified it defaults to @code{0.0.0.0}.
1469 @option{port} for a listening socket specifies the local port to be bound. For a
1470 connecting socket specifies the port on the remote host to connect to.
1471 @option{port} can be given as either a port number or a service name.
1472 @option{port} is required.
1474 @option{to} is only relevant to listening sockets. If it is specified, and
1475 @option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up
1476 to and including @option{to} until it succeeds. @option{to} must be specified
1477 as a port number.
1479 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1480 If neither is specified the socket may use either protocol.
1482 @option{nodelay} disables the Nagle algorithm.
1484 @item unix options: path=@var{path}
1486 @option{path} specifies the local path of the unix socket. @option{path} is
1487 required.
1489 @end table
1491 @item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6]
1493 Sends all traffic from the guest to a remote host over UDP.
1495 @option{host} specifies the remote host to connect to. If not specified it
1496 defaults to @code{localhost}.
1498 @option{port} specifies the port on the remote host to connect to. @option{port}
1499 is required.
1501 @option{localaddr} specifies the local address to bind to. If not specified it
1502 defaults to @code{0.0.0.0}.
1504 @option{localport} specifies the local port to bind to. If not specified any
1505 available local port will be used.
1507 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1508 If neither is specified the device may use either protocol.
1510 @item -chardev msmouse ,id=@var{id}
1512 Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not
1513 take any options.
1515 @item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]]
1517 Connect to a QEMU text console. @option{vc} may optionally be given a specific
1518 size.
1520 @option{width} and @option{height} specify the width and height respectively of
1521 the console, in pixels.
1523 @option{cols} and @option{rows} specify that the console be sized to fit a text
1524 console with the given dimensions.
1526 @item -chardev file ,id=@var{id} ,path=@var{path}
1528 Log all traffic received from the guest to a file.
1530 @option{path} specifies the path of the file to be opened. This file will be
1531 created if it does not already exist, and overwritten if it does. @option{path}
1532 is required.
1534 @item -chardev pipe ,id=@var{id} ,path=@var{path}
1536 Create a two-way connection to the guest. The behaviour differs slightly between
1537 Windows hosts and other hosts:
1539 On Windows, a single duplex pipe will be created at
1540 @file{\\.pipe\@option{path}}.
1542 On other hosts, 2 pipes will be created called @file{@option{path}.in} and
1543 @file{@option{path}.out}. Data written to @file{@option{path}.in} will be
1544 received by the guest. Data written by the guest can be read from
1545 @file{@option{path}.out}. QEMU will not create these fifos, and requires them to
1546 be present.
1548 @option{path} forms part of the pipe path as described above. @option{path} is
1549 required.
1551 @item -chardev console ,id=@var{id}
1553 Send traffic from the guest to QEMU's standard output. @option{console} does not
1554 take any options.
1556 @option{console} is only available on Windows hosts.
1558 @item -chardev serial ,id=@var{id} ,path=@option{path}
1560 Send traffic from the guest to a serial device on the host.
1562 @option{serial} is
1563 only available on Windows hosts.
1565 @option{path} specifies the name of the serial device to open.
1567 @item -chardev pty ,id=@var{id}
1569 Create a new pseudo-terminal on the host and connect to it. @option{pty} does
1570 not take any options.
1572 @option{pty} is not available on Windows hosts.
1574 @item -chardev stdio ,id=@var{id} [,signal=on|off]
1575 Connect to standard input and standard output of the qemu process.
1577 @option{signal} controls if signals are enabled on the terminal, that includes
1578 exiting QEMU with the key sequence @key{Control-c}. This option is enabled by
1579 default, use @option{signal=off} to disable it.
1581 @option{stdio} is not available on Windows hosts.
1583 @item -chardev braille ,id=@var{id}
1585 Connect to a local BrlAPI server. @option{braille} does not take any options.
1587 @item -chardev tty ,id=@var{id} ,path=@var{path}
1589 Connect to a local tty device.
1591 @option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and
1592 DragonFlyBSD hosts.
1594 @option{path} specifies the path to the tty. @option{path} is required.
1596 @item -chardev parport ,id=@var{id} ,path=@var{path}
1598 @option{parport} is only available on Linux, FreeBSD and DragonFlyBSD hosts.
1600 Connect to a local parallel port.
1602 @option{path} specifies the path to the parallel port device. @option{path} is
1603 required.
1605 #if defined(CONFIG_SPICE)
1606 @item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name}
1608 @option{debug} debug level for spicevmc
1610 @option{name} name of spice channel to connect to
1612 Connect to a spice virtual machine channel, such as vdiport.
1613 #endif
1615 @end table
1616 ETEXI
1618 DEFHEADING()
1620 DEFHEADING(Bluetooth(R) options:)
1622 DEF("bt", HAS_ARG, QEMU_OPTION_bt, \
1623 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \
1624 "-bt hci,host[:id]\n" \
1625 " use host's HCI with the given name\n" \
1626 "-bt hci[,vlan=n]\n" \
1627 " emulate a standard HCI in virtual scatternet 'n'\n" \
1628 "-bt vhci[,vlan=n]\n" \
1629 " add host computer to virtual scatternet 'n' using VHCI\n" \
1630 "-bt device:dev[,vlan=n]\n" \
1631 " emulate a bluetooth device 'dev' in scatternet 'n'\n",
1632 QEMU_ARCH_ALL)
1633 STEXI
1634 @table @option
1636 @item -bt hci[...]
1637 @findex -bt
1638 Defines the function of the corresponding Bluetooth HCI. -bt options
1639 are matched with the HCIs present in the chosen machine type. For
1640 example when emulating a machine with only one HCI built into it, only
1641 the first @code{-bt hci[...]} option is valid and defines the HCI's
1642 logic. The Transport Layer is decided by the machine type. Currently
1643 the machines @code{n800} and @code{n810} have one HCI and all other
1644 machines have none.
1646 @anchor{bt-hcis}
1647 The following three types are recognized:
1649 @table @option
1650 @item -bt hci,null
1651 (default) The corresponding Bluetooth HCI assumes no internal logic
1652 and will not respond to any HCI commands or emit events.
1654 @item -bt hci,host[:@var{id}]
1655 (@code{bluez} only) The corresponding HCI passes commands / events
1656 to / from the physical HCI identified by the name @var{id} (default:
1657 @code{hci0}) on the computer running QEMU. Only available on @code{bluez}
1658 capable systems like Linux.
1660 @item -bt hci[,vlan=@var{n}]
1661 Add a virtual, standard HCI that will participate in the Bluetooth
1662 scatternet @var{n} (default @code{0}). Similarly to @option{-net}
1663 VLANs, devices inside a bluetooth network @var{n} can only communicate
1664 with other devices in the same network (scatternet).
1665 @end table
1667 @item -bt vhci[,vlan=@var{n}]
1668 (Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
1669 to the host bluetooth stack instead of to the emulated target. This
1670 allows the host and target machines to participate in a common scatternet
1671 and communicate. Requires the Linux @code{vhci} driver installed. Can
1672 be used as following:
1674 @example
1675 qemu [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
1676 @end example
1678 @item -bt device:@var{dev}[,vlan=@var{n}]
1679 Emulate a bluetooth device @var{dev} and place it in network @var{n}
1680 (default @code{0}). QEMU can only emulate one type of bluetooth devices
1681 currently:
1683 @table @option
1684 @item keyboard
1685 Virtual wireless keyboard implementing the HIDP bluetooth profile.
1686 @end table
1687 @end table
1688 ETEXI
1690 DEFHEADING()
1692 DEFHEADING(Linux/Multiboot boot specific:)
1693 STEXI
1695 When using these options, you can use a given Linux or Multiboot
1696 kernel without installing it in the disk image. It can be useful
1697 for easier testing of various kernels.
1699 @table @option
1700 ETEXI
1702 DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \
1703 "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL)
1704 STEXI
1705 @item -kernel @var{bzImage}
1706 @findex -kernel
1707 Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel
1708 or in multiboot format.
1709 ETEXI
1711 DEF("append", HAS_ARG, QEMU_OPTION_append, \
1712 "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL)
1713 STEXI
1714 @item -append @var{cmdline}
1715 @findex -append
1716 Use @var{cmdline} as kernel command line
1717 ETEXI
1719 DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \
1720 "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL)
1721 STEXI
1722 @item -initrd @var{file}
1723 @findex -initrd
1724 Use @var{file} as initial ram disk.
1726 @item -initrd "@var{file1} arg=foo,@var{file2}"
1728 This syntax is only available with multiboot.
1730 Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the
1731 first module.
1732 ETEXI
1734 STEXI
1735 @end table
1736 ETEXI
1738 DEFHEADING()
1740 DEFHEADING(Debug/Expert options:)
1742 STEXI
1743 @table @option
1744 ETEXI
1746 DEF("serial", HAS_ARG, QEMU_OPTION_serial, \
1747 "-serial dev redirect the serial port to char device 'dev'\n",
1748 QEMU_ARCH_ALL)
1749 STEXI
1750 @item -serial @var{dev}
1751 @findex -serial
1752 Redirect the virtual serial port to host character device
1753 @var{dev}. The default device is @code{vc} in graphical mode and
1754 @code{stdio} in non graphical mode.
1756 This option can be used several times to simulate up to 4 serial
1757 ports.
1759 Use @code{-serial none} to disable all serial ports.
1761 Available character devices are:
1762 @table @option
1763 @item vc[:@var{W}x@var{H}]
1764 Virtual console. Optionally, a width and height can be given in pixel with
1765 @example
1766 vc:800x600
1767 @end example
1768 It is also possible to specify width or height in characters:
1769 @example
1770 vc:80Cx24C
1771 @end example
1772 @item pty
1773 [Linux only] Pseudo TTY (a new PTY is automatically allocated)
1774 @item none
1775 No device is allocated.
1776 @item null
1777 void device
1778 @item /dev/XXX
1779 [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
1780 parameters are set according to the emulated ones.
1781 @item /dev/parport@var{N}
1782 [Linux only, parallel port only] Use host parallel port
1783 @var{N}. Currently SPP and EPP parallel port features can be used.
1784 @item file:@var{filename}
1785 Write output to @var{filename}. No character can be read.
1786 @item stdio
1787 [Unix only] standard input/output
1788 @item pipe:@var{filename}
1789 name pipe @var{filename}
1790 @item COM@var{n}
1791 [Windows only] Use host serial port @var{n}
1792 @item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
1793 This implements UDP Net Console.
1794 When @var{remote_host} or @var{src_ip} are not specified
1795 they default to @code{0.0.0.0}.
1796 When not using a specified @var{src_port} a random port is automatically chosen.
1798 If you just want a simple readonly console you can use @code{netcat} or
1799 @code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
1800 @code{nc -u -l -p 4555}. Any time qemu writes something to that port it
1801 will appear in the netconsole session.
1803 If you plan to send characters back via netconsole or you want to stop
1804 and start qemu a lot of times, you should have qemu use the same
1805 source port each time by using something like @code{-serial
1806 udp::4555@@:4556} to qemu. Another approach is to use a patched
1807 version of netcat which can listen to a TCP port and send and receive
1808 characters via udp. If you have a patched version of netcat which
1809 activates telnet remote echo and single char transfer, then you can
1810 use the following options to step up a netcat redirector to allow
1811 telnet on port 5555 to access the qemu port.
1812 @table @code
1813 @item Qemu Options:
1814 -serial udp::4555@@:4556
1815 @item netcat options:
1816 -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
1817 @item telnet options:
1818 localhost 5555
1819 @end table
1821 @item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay]
1822 The TCP Net Console has two modes of operation. It can send the serial
1823 I/O to a location or wait for a connection from a location. By default
1824 the TCP Net Console is sent to @var{host} at the @var{port}. If you use
1825 the @var{server} option QEMU will wait for a client socket application
1826 to connect to the port before continuing, unless the @code{nowait}
1827 option was specified. The @code{nodelay} option disables the Nagle buffering
1828 algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only
1829 one TCP connection at a time is accepted. You can use @code{telnet} to
1830 connect to the corresponding character device.
1831 @table @code
1832 @item Example to send tcp console to 192.168.0.2 port 4444
1833 -serial tcp:192.168.0.2:4444
1834 @item Example to listen and wait on port 4444 for connection
1835 -serial tcp::4444,server
1836 @item Example to not wait and listen on ip 192.168.0.100 port 4444
1837 -serial tcp:192.168.0.100:4444,server,nowait
1838 @end table
1840 @item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
1841 The telnet protocol is used instead of raw tcp sockets. The options
1842 work the same as if you had specified @code{-serial tcp}. The
1843 difference is that the port acts like a telnet server or client using
1844 telnet option negotiation. This will also allow you to send the
1845 MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
1846 sequence. Typically in unix telnet you do it with Control-] and then
1847 type "send break" followed by pressing the enter key.
1849 @item unix:@var{path}[,server][,nowait]
1850 A unix domain socket is used instead of a tcp socket. The option works the
1851 same as if you had specified @code{-serial tcp} except the unix domain socket
1852 @var{path} is used for connections.
1854 @item mon:@var{dev_string}
1855 This is a special option to allow the monitor to be multiplexed onto
1856 another serial port. The monitor is accessed with key sequence of
1857 @key{Control-a} and then pressing @key{c}. See monitor access
1858 @ref{pcsys_keys} in the -nographic section for more keys.
1859 @var{dev_string} should be any one of the serial devices specified
1860 above. An example to multiplex the monitor onto a telnet server
1861 listening on port 4444 would be:
1862 @table @code
1863 @item -serial mon:telnet::4444,server,nowait
1864 @end table
1866 @item braille
1867 Braille device. This will use BrlAPI to display the braille output on a real
1868 or fake device.
1870 @item msmouse
1871 Three button serial mouse. Configure the guest to use Microsoft protocol.
1872 @end table
1873 ETEXI
1875 DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \
1876 "-parallel dev redirect the parallel port to char device 'dev'\n",
1877 QEMU_ARCH_ALL)
1878 STEXI
1879 @item -parallel @var{dev}
1880 @findex -parallel
1881 Redirect the virtual parallel port to host device @var{dev} (same
1882 devices as the serial port). On Linux hosts, @file{/dev/parportN} can
1883 be used to use hardware devices connected on the corresponding host
1884 parallel port.
1886 This option can be used several times to simulate up to 3 parallel
1887 ports.
1889 Use @code{-parallel none} to disable all parallel ports.
1890 ETEXI
1892 DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \
1893 "-monitor dev redirect the monitor to char device 'dev'\n",
1894 QEMU_ARCH_ALL)
1895 STEXI
1896 @item -monitor @var{dev}
1897 @findex -monitor
1898 Redirect the monitor to host device @var{dev} (same devices as the
1899 serial port).
1900 The default device is @code{vc} in graphical mode and @code{stdio} in
1901 non graphical mode.
1902 ETEXI
1903 DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \
1904 "-qmp dev like -monitor but opens in 'control' mode\n",
1905 QEMU_ARCH_ALL)
1906 STEXI
1907 @item -qmp @var{dev}
1908 @findex -qmp
1909 Like -monitor but opens in 'control' mode.
1910 ETEXI
1912 DEF("mon", HAS_ARG, QEMU_OPTION_mon, \
1913 "-mon chardev=[name][,mode=readline|control][,default]\n", QEMU_ARCH_ALL)
1914 STEXI
1915 @item -mon chardev=[name][,mode=readline|control][,default]
1916 @findex -mon
1917 Setup monitor on chardev @var{name}.
1918 ETEXI
1920 DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \
1921 "-debugcon dev redirect the debug console to char device 'dev'\n",
1922 QEMU_ARCH_ALL)
1923 STEXI
1924 @item -debugcon @var{dev}
1925 @findex -debugcon
1926 Redirect the debug console to host device @var{dev} (same devices as the
1927 serial port). The debug console is an I/O port which is typically port
1928 0xe9; writing to that I/O port sends output to this device.
1929 The default device is @code{vc} in graphical mode and @code{stdio} in
1930 non graphical mode.
1931 ETEXI
1933 DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \
1934 "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL)
1935 STEXI
1936 @item -pidfile @var{file}
1937 @findex -pidfile
1938 Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
1939 from a script.
1940 ETEXI
1942 DEF("singlestep", 0, QEMU_OPTION_singlestep, \
1943 "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL)
1944 STEXI
1945 @item -singlestep
1946 @findex -singlestep
1947 Run the emulation in single step mode.
1948 ETEXI
1950 DEF("S", 0, QEMU_OPTION_S, \
1951 "-S freeze CPU at startup (use 'c' to start execution)\n",
1952 QEMU_ARCH_ALL)
1953 STEXI
1954 @item -S
1955 @findex -S
1956 Do not start CPU at startup (you must type 'c' in the monitor).
1957 ETEXI
1959 DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \
1960 "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL)
1961 STEXI
1962 @item -gdb @var{dev}
1963 @findex -gdb
1964 Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical
1965 connections will likely be TCP-based, but also UDP, pseudo TTY, or even
1966 stdio are reasonable use case. The latter is allowing to start qemu from
1967 within gdb and establish the connection via a pipe:
1968 @example
1969 (gdb) target remote | exec qemu -gdb stdio ...
1970 @end example
1971 ETEXI
1973 DEF("s", 0, QEMU_OPTION_s, \
1974 "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n",
1975 QEMU_ARCH_ALL)
1976 STEXI
1977 @item -s
1978 @findex -s
1979 Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
1980 (@pxref{gdb_usage}).
1981 ETEXI
1983 DEF("d", HAS_ARG, QEMU_OPTION_d, \
1984 "-d item1,... output log to /tmp/qemu.log (use -d ? for a list of log items)\n",
1985 QEMU_ARCH_ALL)
1986 STEXI
1987 @item -d
1988 @findex -d
1989 Output log in /tmp/qemu.log
1990 ETEXI
1992 DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \
1993 "-hdachs c,h,s[,t]\n" \
1994 " force hard disk 0 physical geometry and the optional BIOS\n" \
1995 " translation (t=none or lba) (usually qemu can guess them)\n",
1996 QEMU_ARCH_ALL)
1997 STEXI
1998 @item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
1999 @findex -hdachs
2000 Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
2001 @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
2002 translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
2003 all those parameters. This option is useful for old MS-DOS disk
2004 images.
2005 ETEXI
2007 DEF("L", HAS_ARG, QEMU_OPTION_L, \
2008 "-L path set the directory for the BIOS, VGA BIOS and keymaps\n",
2009 QEMU_ARCH_ALL)
2010 STEXI
2011 @item -L @var{path}
2012 @findex -L
2013 Set the directory for the BIOS, VGA BIOS and keymaps.
2014 ETEXI
2016 DEF("bios", HAS_ARG, QEMU_OPTION_bios, \
2017 "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL)
2018 STEXI
2019 @item -bios @var{file}
2020 @findex -bios
2021 Set the filename for the BIOS.
2022 ETEXI
2024 DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \
2025 "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL)
2026 STEXI
2027 @item -enable-kvm
2028 @findex -enable-kvm
2029 Enable KVM full virtualization support. This option is only available
2030 if KVM support is enabled when compiling.
2031 ETEXI
2033 DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid,
2034 "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL)
2035 DEF("xen-create", 0, QEMU_OPTION_xen_create,
2036 "-xen-create create domain using xen hypercalls, bypassing xend\n"
2037 " warning: should not be used when xend is in use\n",
2038 QEMU_ARCH_ALL)
2039 DEF("xen-attach", 0, QEMU_OPTION_xen_attach,
2040 "-xen-attach attach to existing xen domain\n"
2041 " xend will use this when starting qemu\n",
2042 QEMU_ARCH_ALL)
2043 STEXI
2044 @item -xen-domid @var{id}
2045 @findex -xen-domid
2046 Specify xen guest domain @var{id} (XEN only).
2047 @item -xen-create
2048 @findex -xen-create
2049 Create domain using xen hypercalls, bypassing xend.
2050 Warning: should not be used when xend is in use (XEN only).
2051 @item -xen-attach
2052 @findex -xen-attach
2053 Attach to existing xen domain.
2054 xend will use this when starting qemu (XEN only).
2055 ETEXI
2057 DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \
2058 "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL)
2059 STEXI
2060 @item -no-reboot
2061 @findex -no-reboot
2062 Exit instead of rebooting.
2063 ETEXI
2065 DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \
2066 "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL)
2067 STEXI
2068 @item -no-shutdown
2069 @findex -no-shutdown
2070 Don't exit QEMU on guest shutdown, but instead only stop the emulation.
2071 This allows for instance switching to monitor to commit changes to the
2072 disk image.
2073 ETEXI
2075 DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \
2076 "-loadvm [tag|id]\n" \
2077 " start right away with a saved state (loadvm in monitor)\n",
2078 QEMU_ARCH_ALL)
2079 STEXI
2080 @item -loadvm @var{file}
2081 @findex -loadvm
2082 Start right away with a saved state (@code{loadvm} in monitor)
2083 ETEXI
2085 #ifndef _WIN32
2086 DEF("daemonize", 0, QEMU_OPTION_daemonize, \
2087 "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL)
2088 #endif
2089 STEXI
2090 @item -daemonize
2091 @findex -daemonize
2092 Daemonize the QEMU process after initialization. QEMU will not detach from
2093 standard IO until it is ready to receive connections on any of its devices.
2094 This option is a useful way for external programs to launch QEMU without having
2095 to cope with initialization race conditions.
2096 ETEXI
2098 DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \
2099 "-option-rom rom load a file, rom, into the option ROM space\n",
2100 QEMU_ARCH_ALL)
2101 STEXI
2102 @item -option-rom @var{file}
2103 @findex -option-rom
2104 Load the contents of @var{file} as an option ROM.
2105 This option is useful to load things like EtherBoot.
2106 ETEXI
2108 DEF("clock", HAS_ARG, QEMU_OPTION_clock, \
2109 "-clock force the use of the given methods for timer alarm.\n" \
2110 " To see what timers are available use -clock ?\n",
2111 QEMU_ARCH_ALL)
2112 STEXI
2113 @item -clock @var{method}
2114 @findex -clock
2115 Force the use of the given methods for timer alarm. To see what timers
2116 are available use -clock ?.
2117 ETEXI
2119 HXCOMM Options deprecated by -rtc
2120 DEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL)
2121 DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL)
2123 DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \
2124 "-rtc [base=utc|localtime|date][,clock=host|vm][,driftfix=none|slew]\n" \
2125 " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n",
2126 QEMU_ARCH_ALL)
2128 STEXI
2130 @item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew]
2131 @findex -rtc
2132 Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current
2133 UTC or local time, respectively. @code{localtime} is required for correct date in
2134 MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the
2135 format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC.
2137 By default the RTC is driven by the host system time. This allows to use the
2138 RTC as accurate reference clock inside the guest, specifically if the host
2139 time is smoothly following an accurate external reference clock, e.g. via NTP.
2140 If you want to isolate the guest time from the host, even prevent it from
2141 progressing during suspension, you can set @option{clock} to @code{vm} instead.
2143 Enable @option{driftfix} (i386 targets only) if you experience time drift problems,
2144 specifically with Windows' ACPI HAL. This option will try to figure out how
2145 many timer interrupts were not processed by the Windows guest and will
2146 re-inject them.
2147 ETEXI
2149 DEF("icount", HAS_ARG, QEMU_OPTION_icount, \
2150 "-icount [N|auto]\n" \
2151 " enable virtual instruction counter with 2^N clock ticks per\n" \
2152 " instruction\n", QEMU_ARCH_ALL)
2153 STEXI
2154 @item -icount [@var{N}|auto]
2155 @findex -icount
2156 Enable virtual instruction counter. The virtual cpu will execute one
2157 instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified
2158 then the virtual cpu speed will be automatically adjusted to keep virtual
2159 time within a few seconds of real time.
2161 Note that while this option can give deterministic behavior, it does not
2162 provide cycle accurate emulation. Modern CPUs contain superscalar out of
2163 order cores with complex cache hierarchies. The number of instructions
2164 executed often has little or no correlation with actual performance.
2165 ETEXI
2167 DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \
2168 "-watchdog i6300esb|ib700\n" \
2169 " enable virtual hardware watchdog [default=none]\n",
2170 QEMU_ARCH_ALL)
2171 STEXI
2172 @item -watchdog @var{model}
2173 @findex -watchdog
2174 Create a virtual hardware watchdog device. Once enabled (by a guest
2175 action), the watchdog must be periodically polled by an agent inside
2176 the guest or else the guest will be restarted.
2178 The @var{model} is the model of hardware watchdog to emulate. Choices
2179 for model are: @code{ib700} (iBASE 700) which is a very simple ISA
2180 watchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O
2181 controller hub) which is a much more featureful PCI-based dual-timer
2182 watchdog. Choose a model for which your guest has drivers.
2184 Use @code{-watchdog ?} to list available hardware models. Only one
2185 watchdog can be enabled for a guest.
2186 ETEXI
2188 DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \
2189 "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \
2190 " action when watchdog fires [default=reset]\n",
2191 QEMU_ARCH_ALL)
2192 STEXI
2193 @item -watchdog-action @var{action}
2195 The @var{action} controls what QEMU will do when the watchdog timer
2196 expires.
2197 The default is
2198 @code{reset} (forcefully reset the guest).
2199 Other possible actions are:
2200 @code{shutdown} (attempt to gracefully shutdown the guest),
2201 @code{poweroff} (forcefully poweroff the guest),
2202 @code{pause} (pause the guest),
2203 @code{debug} (print a debug message and continue), or
2204 @code{none} (do nothing).
2206 Note that the @code{shutdown} action requires that the guest responds
2207 to ACPI signals, which it may not be able to do in the sort of
2208 situations where the watchdog would have expired, and thus
2209 @code{-watchdog-action shutdown} is not recommended for production use.
2211 Examples:
2213 @table @code
2214 @item -watchdog i6300esb -watchdog-action pause
2215 @item -watchdog ib700
2216 @end table
2217 ETEXI
2219 DEF("echr", HAS_ARG, QEMU_OPTION_echr, \
2220 "-echr chr set terminal escape character instead of ctrl-a\n",
2221 QEMU_ARCH_ALL)
2222 STEXI
2224 @item -echr @var{numeric_ascii_value}
2225 @findex -echr
2226 Change the escape character used for switching to the monitor when using
2227 monitor and serial sharing. The default is @code{0x01} when using the
2228 @code{-nographic} option. @code{0x01} is equal to pressing
2229 @code{Control-a}. You can select a different character from the ascii
2230 control keys where 1 through 26 map to Control-a through Control-z. For
2231 instance you could use the either of the following to change the escape
2232 character to Control-t.
2233 @table @code
2234 @item -echr 0x14
2235 @item -echr 20
2236 @end table
2237 ETEXI
2239 DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \
2240 "-virtioconsole c\n" \
2241 " set virtio console\n", QEMU_ARCH_ALL)
2242 STEXI
2243 @item -virtioconsole @var{c}
2244 @findex -virtioconsole
2245 Set virtio console.
2247 This option is maintained for backward compatibility.
2249 Please use @code{-device virtconsole} for the new way of invocation.
2250 ETEXI
2252 DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \
2253 "-show-cursor show cursor\n", QEMU_ARCH_ALL)
2254 STEXI
2255 @item -show-cursor
2256 @findex -show-cursor
2257 Show cursor.
2258 ETEXI
2260 DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \
2261 "-tb-size n set TB size\n", QEMU_ARCH_ALL)
2262 STEXI
2263 @item -tb-size @var{n}
2264 @findex -tb-size
2265 Set TB size.
2266 ETEXI
2268 DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \
2269 "-incoming p prepare for incoming migration, listen on port p\n",
2270 QEMU_ARCH_ALL)
2271 STEXI
2272 @item -incoming @var{port}
2273 @findex -incoming
2274 Prepare for incoming migration, listen on @var{port}.
2275 ETEXI
2277 DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \
2278 "-nodefaults don't create default devices\n", QEMU_ARCH_ALL)
2279 STEXI
2280 @item -nodefaults
2281 @findex -nodefaults
2282 Don't create default devices.
2283 ETEXI
2285 #ifndef _WIN32
2286 DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \
2287 "-chroot dir chroot to dir just before starting the VM\n",
2288 QEMU_ARCH_ALL)
2289 #endif
2290 STEXI
2291 @item -chroot @var{dir}
2292 @findex -chroot
2293 Immediately before starting guest execution, chroot to the specified
2294 directory. Especially useful in combination with -runas.
2295 ETEXI
2297 #ifndef _WIN32
2298 DEF("runas", HAS_ARG, QEMU_OPTION_runas, \
2299 "-runas user change to user id user just before starting the VM\n",
2300 QEMU_ARCH_ALL)
2301 #endif
2302 STEXI
2303 @item -runas @var{user}
2304 @findex -runas
2305 Immediately before starting guest execution, drop root privileges, switching
2306 to the specified user.
2307 ETEXI
2309 DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env,
2310 "-prom-env variable=value\n"
2311 " set OpenBIOS nvram variables\n",
2312 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
2313 STEXI
2314 @item -prom-env @var{variable}=@var{value}
2315 @findex -prom-env
2316 Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only).
2317 ETEXI
2318 DEF("semihosting", 0, QEMU_OPTION_semihosting,
2319 "-semihosting semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K)
2320 STEXI
2321 @item -semihosting
2322 @findex -semihosting
2323 Semihosting mode (ARM, M68K only).
2324 ETEXI
2325 DEF("old-param", 0, QEMU_OPTION_old_param,
2326 "-old-param old param mode\n", QEMU_ARCH_ARM)
2327 STEXI
2328 @item -old-param
2329 @findex -old-param (ARM)
2330 Old param mode (ARM only).
2331 ETEXI
2333 DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig,
2334 "-readconfig <file>\n", QEMU_ARCH_ALL)
2335 STEXI
2336 @item -readconfig @var{file}
2337 @findex -readconfig
2338 Read device configuration from @var{file}.
2339 ETEXI
2340 DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig,
2341 "-writeconfig <file>\n"
2342 " read/write config file\n", QEMU_ARCH_ALL)
2343 STEXI
2344 @item -writeconfig @var{file}
2345 @findex -writeconfig
2346 Write device configuration to @var{file}.
2347 ETEXI
2348 DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig,
2349 "-nodefconfig\n"
2350 " do not load default config files at startup\n",
2351 QEMU_ARCH_ALL)
2352 STEXI
2353 @item -nodefconfig
2354 @findex -nodefconfig
2355 Normally QEMU loads a configuration file from @var{sysconfdir}/qemu.conf and
2356 @var{sysconfdir}/target-@var{ARCH}.conf on startup. The @code{-nodefconfig}
2357 option will prevent QEMU from loading these configuration files at startup.
2358 ETEXI
2359 #ifdef CONFIG_SIMPLE_TRACE
2360 DEF("trace", HAS_ARG, QEMU_OPTION_trace,
2361 "-trace\n"
2362 " Specify a trace file to log traces to\n",
2363 QEMU_ARCH_ALL)
2364 STEXI
2365 @item -trace
2366 @findex -trace
2367 Specify a trace file to log output traces to.
2368 ETEXI
2369 #endif
2371 HXCOMM This is the last statement. Insert new options before this line!
2372 STEXI
2373 @end table
2374 ETEXI