doc: Add explanation that -alt-grab and -ctrl-grab affect special keys
[qemu.git] / qemu-options.hx
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
8
9 DEFHEADING(Standard options:)
10 STEXI
11 @table @option
12 ETEXI
13
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
21
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
29
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
37
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
45
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
67
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
76
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
88
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
106
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
117
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
128
129 Define a new drive. Valid options are:
130
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
164
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.
169
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.
174
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.
178
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.
182
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.
189
190 Instead of @option{-cdrom} you can use:
191 @example
192 qemu -drive file=file,index=2,media=cdrom
193 @end example
194
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
203
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
208
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
213
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
218
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
224
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
235
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
245
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
255
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
264
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
272
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
280
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}.
294
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.
297
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
304
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
308
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
319
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
330
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
337
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
347
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.
359
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
366
367 The default is @code{en-us}.
368 ETEXI
369
370
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
380
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.
391
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
400
401 Note that Linux's i810_audio OSS kernel (for AC97) module might
402 require manually specifying clocking.
403
404 @example
405 modprobe i810_audio clocking=48000
406 @end example
407 ETEXI
408
409 STEXI
410 @end table
411 ETEXI
412
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
419
420 @item -usb
421 @findex -usb
422 Enable the USB driver (will be the default soon)
423 ETEXI
424
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
429
430 @item -usbdevice @var{devname}
431 @findex -usbdevice
432 Add the USB device @var{devname}. @xref{usb_devices}.
433
434 @table @option
435
436 @item mouse
437 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
438
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.
443
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.
448
449 @item host:@var{bus}.@var{addr}
450 Pass through the host device identified by @var{bus}.@var{addr} (Linux only).
451
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).
455
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.
459
460 @item braille
461 Braille device.  This will use BrlAPI to display the braille output on a real
462 or fake device.
463
464 @item net:@var{options}
465 Network adapter that supports CDC ethernet and RNDIS protocols.
466
467 @end table
468 ETEXI
469
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
485
486 DEFHEADING(File system options:)
487
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)
491
492 STEXI
493
494 The general form of a File system device option is:
495 @table @option
496
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.
502
503 Options to each backend are described below.
504
505 @item -fsdev local ,id=@var{id} ,path=@var{path} ,security_model=@var{security_model}
506
507 Create a file-system-"device" for local-filesystem.
508
509 @option{local} is only available on Linux.
510
511 @option{path} specifies the path to be exported. @option{path} is required.
512
513 @option{security_model} specifies the security model to be followed.
514 @option{security_model} is required.
515
516 @end table
517 ETEXI
518
519 DEFHEADING(Virtual File system pass-through options:)
520
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)
524
525 STEXI
526
527 The general form of a Virtual File system pass-through option is:
528 @table @option
529
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.
535
536 Options to each backend are described below.
537
538 @item -virtfs local ,path=@var{path} ,mount_tag=@var{mount_tag} ,security_model=@var{security_model}
539
540 Create a Virtual file-system-pass through for local-filesystem.
541
542 @option{local} is only available on Linux.
543
544 @option{path} specifies the path to be exported. @option{path} is required.
545
546 @option{security_model} specifies the security model to be followed.
547 @option{security_model} is required.
548
549
550 @option{mount_tag} specifies the tag with which the exported file is mounted.
551 @option{mount_tag} is required.
552
553 @end table
554 ETEXI
555
556 DEFHEADING()
557
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
571
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
580
581 STEXI
582 @end table
583 ETEXI
584
585 DEFHEADING()
586
587 DEFHEADING(Display options:)
588
589 STEXI
590 @table @option
591 ETEXI
592
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
623
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
636
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
647
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
658
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). Note that this also
666 affects the special keys (for fullscreen, monitor-mode switching, etc).
667 ETEXI
668
669 DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab,
670     "-ctrl-grab      use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n",
671     QEMU_ARCH_ALL)
672 STEXI
673 @item -ctrl-grab
674 @findex -ctrl-grab
675 Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also
676 affects the special keys (for fullscreen, monitor-mode switching, etc).
677 ETEXI
678
679 DEF("no-quit", 0, QEMU_OPTION_no_quit,
680     "-no-quit        disable SDL window close capability\n", QEMU_ARCH_ALL)
681 STEXI
682 @item -no-quit
683 @findex -no-quit
684 Disable SDL window close capability.
685 ETEXI
686
687 DEF("sdl", 0, QEMU_OPTION_sdl,
688     "-sdl            enable SDL\n", QEMU_ARCH_ALL)
689 STEXI
690 @item -sdl
691 @findex -sdl
692 Enable SDL.
693 ETEXI
694
695 DEF("spice", HAS_ARG, QEMU_OPTION_spice,
696     "-spice <args>   enable spice\n", QEMU_ARCH_ALL)
697 STEXI
698 @item -spice @var{option}[,@var{option}[,...]]
699 @findex -spice
700 Enable the spice remote desktop protocol. Valid options are
701
702 @table @option
703
704 @item port=<nr>
705 Set the TCP port spice is listening on for plaintext channels.
706
707 @item addr=<addr>
708 Set the IP address spice is listening on.  Default is any address.
709
710 @item ipv4
711 @item ipv6
712 Force using the specified IP version.
713
714 @item password=<secret>
715 Set the password you need to authenticate.
716
717 @item disable-ticketing
718 Allow client connects without authentication.
719
720 @item tls-port=<nr>
721 Set the TCP port spice is listening on for encrypted channels.
722
723 @item x509-dir=<dir>
724 Set the x509 file directory. Expects same filenames as -vnc $display,x509=$dir
725
726 @item x509-key-file=<file>
727 @item x509-key-password=<file>
728 @item x509-cert-file=<file>
729 @item x509-cacert-file=<file>
730 @item x509-dh-key-file=<file>
731 The x509 file names can also be configured individually.
732
733 @item tls-ciphers=<list>
734 Specify which ciphers to use.
735
736 @item tls-channel=[main|display|inputs|record|playback|tunnel]
737 @item plaintext-channel=[main|display|inputs|record|playback|tunnel]
738 Force specific channel to be used with or without TLS encryption.  The
739 options can be specified multiple times to configure multiple
740 channels.  The special name "default" can be used to set the default
741 mode.  For channels which are not explicitly forced into one mode the
742 spice client is allowed to pick tls/plaintext as he pleases.
743
744 @item image-compression=[auto_glz|auto_lz|quic|glz|lz|off]
745 Configure image compression (lossless).
746 Default is auto_glz.
747
748 @item jpeg-wan-compression=[auto|never|always]
749 @item zlib-glz-wan-compression=[auto|never|always]
750 Configure wan image compression (lossy for slow links).
751 Default is auto.
752
753 @item streaming-video=[off|all|filter]
754 Configure video stream detection.  Default is filter.
755
756 @item agent-mouse=[on|off]
757 Enable/disable passing mouse events via vdagent.  Default is on.
758
759 @item playback-compression=[on|off]
760 Enable/disable audio stream compression (using celt 0.5.1).  Default is on.
761
762 @end table
763 ETEXI
764
765 DEF("portrait", 0, QEMU_OPTION_portrait,
766     "-portrait       rotate graphical output 90 deg left (only PXA LCD)\n",
767     QEMU_ARCH_ALL)
768 STEXI
769 @item -portrait
770 @findex -portrait
771 Rotate graphical output 90 deg left (only PXA LCD).
772 ETEXI
773
774 DEF("vga", HAS_ARG, QEMU_OPTION_vga,
775     "-vga [std|cirrus|vmware|qxl|xenfb|none]\n"
776     "                select video card type\n", QEMU_ARCH_ALL)
777 STEXI
778 @item -vga @var{type}
779 @findex -vga
780 Select type of VGA card to emulate. Valid values for @var{type} are
781 @table @option
782 @item cirrus
783 Cirrus Logic GD5446 Video card. All Windows versions starting from
784 Windows 95 should recognize and use this graphic card. For optimal
785 performances, use 16 bit color depth in the guest and the host OS.
786 (This one is the default)
787 @item std
788 Standard VGA card with Bochs VBE extensions.  If your guest OS
789 supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
790 to use high resolution modes (>= 1280x1024x16) then you should use
791 this option.
792 @item vmware
793 VMWare SVGA-II compatible adapter. Use it if you have sufficiently
794 recent XFree86/XOrg server or Windows guest with a driver for this
795 card.
796 @item qxl
797 QXL paravirtual graphic card.  It is VGA compatible (including VESA
798 2.0 VBE support).  Works best with qxl guest drivers installed though.
799 Recommended choice when using the spice protocol.
800 @item none
801 Disable VGA card.
802 @end table
803 ETEXI
804
805 DEF("full-screen", 0, QEMU_OPTION_full_screen,
806     "-full-screen    start in full screen\n", QEMU_ARCH_ALL)
807 STEXI
808 @item -full-screen
809 @findex -full-screen
810 Start in full screen.
811 ETEXI
812
813 DEF("g", 1, QEMU_OPTION_g ,
814     "-g WxH[xDEPTH]  Set the initial graphical resolution and depth\n",
815     QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
816 STEXI
817 @item -g @var{width}x@var{height}[x@var{depth}]
818 @findex -g
819 Set the initial graphical resolution and depth (PPC, SPARC only).
820 ETEXI
821
822 DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
823     "-vnc display    start a VNC server on display\n", QEMU_ARCH_ALL)
824 STEXI
825 @item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
826 @findex -vnc
827 Normally, QEMU uses SDL to display the VGA output.  With this option,
828 you can have QEMU listen on VNC display @var{display} and redirect the VGA
829 display over the VNC session.  It is very useful to enable the usb
830 tablet device when using this option (option @option{-usbdevice
831 tablet}). When using the VNC display, you must use the @option{-k}
832 parameter to set the keyboard layout if you are not using en-us. Valid
833 syntax for the @var{display} is
834
835 @table @option
836
837 @item @var{host}:@var{d}
838
839 TCP connections will only be allowed from @var{host} on display @var{d}.
840 By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
841 be omitted in which case the server will accept connections from any host.
842
843 @item unix:@var{path}
844
845 Connections will be allowed over UNIX domain sockets where @var{path} is the
846 location of a unix socket to listen for connections on.
847
848 @item none
849
850 VNC is initialized but not started. The monitor @code{change} command
851 can be used to later start the VNC server.
852
853 @end table
854
855 Following the @var{display} value there may be one or more @var{option} flags
856 separated by commas. Valid options are
857
858 @table @option
859
860 @item reverse
861
862 Connect to a listening VNC client via a ``reverse'' connection. The
863 client is specified by the @var{display}. For reverse network
864 connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
865 is a TCP port number, not a display number.
866
867 @item password
868
869 Require that password based authentication is used for client connections.
870 The password must be set separately using the @code{change} command in the
871 @ref{pcsys_monitor}
872
873 @item tls
874
875 Require that client use TLS when communicating with the VNC server. This
876 uses anonymous TLS credentials so is susceptible to a man-in-the-middle
877 attack. It is recommended that this option be combined with either the
878 @option{x509} or @option{x509verify} options.
879
880 @item x509=@var{/path/to/certificate/dir}
881
882 Valid if @option{tls} is specified. Require that x509 credentials are used
883 for negotiating the TLS session. The server will send its x509 certificate
884 to the client. It is recommended that a password be set on the VNC server
885 to provide authentication of the client when this is used. The path following
886 this option specifies where the x509 certificates are to be loaded from.
887 See the @ref{vnc_security} section for details on generating certificates.
888
889 @item x509verify=@var{/path/to/certificate/dir}
890
891 Valid if @option{tls} is specified. Require that x509 credentials are used
892 for negotiating the TLS session. The server will send its x509 certificate
893 to the client, and request that the client send its own x509 certificate.
894 The server will validate the client's certificate against the CA certificate,
895 and reject clients when validation fails. If the certificate authority is
896 trusted, this is a sufficient authentication mechanism. You may still wish
897 to set a password on the VNC server as a second authentication layer. The
898 path following this option specifies where the x509 certificates are to
899 be loaded from. See the @ref{vnc_security} section for details on generating
900 certificates.
901
902 @item sasl
903
904 Require that the client use SASL to authenticate with the VNC server.
905 The exact choice of authentication method used is controlled from the
906 system / user's SASL configuration file for the 'qemu' service. This
907 is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
908 unprivileged user, an environment variable SASL_CONF_PATH can be used
909 to make it search alternate locations for the service config.
910 While some SASL auth methods can also provide data encryption (eg GSSAPI),
911 it is recommended that SASL always be combined with the 'tls' and
912 'x509' settings to enable use of SSL and server certificates. This
913 ensures a data encryption preventing compromise of authentication
914 credentials. See the @ref{vnc_security} section for details on using
915 SASL authentication.
916
917 @item acl
918
919 Turn on access control lists for checking of the x509 client certificate
920 and SASL party. For x509 certs, the ACL check is made against the
921 certificate's distinguished name. This is something that looks like
922 @code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
923 made against the username, which depending on the SASL plugin, may
924 include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
925 When the @option{acl} flag is set, the initial access list will be
926 empty, with a @code{deny} policy. Thus no one will be allowed to
927 use the VNC server until the ACLs have been loaded. This can be
928 achieved using the @code{acl} monitor command.
929
930 @item lossy
931
932 Enable lossy compression methods (gradient, JPEG, ...). If this
933 option is set, VNC client may receive lossy framebuffer updates
934 depending on its encoding settings. Enabling this option can save
935 a lot of bandwidth at the expense of quality.
936
937 @item non-adaptive
938
939 Disable adaptive encodings. Adaptive encodings are enabled by default.
940 An adaptive encoding will try to detect frequently updated screen regions,
941 and send updates in these regions using a lossy encoding (like JPEG).
942 This can be really helpful to save bandwidth when playing videos. Disabling
943 adaptive encodings allows to restore the original static behavior of encodings
944 like Tight.
945
946 @end table
947 ETEXI
948
949 STEXI
950 @end table
951 ETEXI
952
953 DEFHEADING()
954
955 DEFHEADING(i386 target only:)
956 STEXI
957 @table @option
958 ETEXI
959
960 DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack,
961     "-win2k-hack     use it when installing Windows 2000 to avoid a disk full bug\n",
962     QEMU_ARCH_I386)
963 STEXI
964 @item -win2k-hack
965 @findex -win2k-hack
966 Use it when installing Windows 2000 to avoid a disk full bug. After
967 Windows 2000 is installed, you no longer need this option (this option
968 slows down the IDE transfers).
969 ETEXI
970
971 HXCOMM Deprecated by -rtc
972 DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386)
973
974 DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk,
975     "-no-fd-bootchk  disable boot signature checking for floppy disks\n",
976     QEMU_ARCH_I386)
977 STEXI
978 @item -no-fd-bootchk
979 @findex -no-fd-bootchk
980 Disable boot signature checking for floppy disks in Bochs BIOS. It may
981 be needed to boot from old floppy disks.
982 TODO: check reference to Bochs BIOS.
983 ETEXI
984
985 DEF("no-acpi", 0, QEMU_OPTION_no_acpi,
986            "-no-acpi        disable ACPI\n", QEMU_ARCH_I386)
987 STEXI
988 @item -no-acpi
989 @findex -no-acpi
990 Disable ACPI (Advanced Configuration and Power Interface) support. Use
991 it if your guest OS complains about ACPI problems (PC target machine
992 only).
993 ETEXI
994
995 DEF("no-hpet", 0, QEMU_OPTION_no_hpet,
996     "-no-hpet        disable HPET\n", QEMU_ARCH_I386)
997 STEXI
998 @item -no-hpet
999 @findex -no-hpet
1000 Disable HPET support.
1001 ETEXI
1002
1003 DEF("balloon", HAS_ARG, QEMU_OPTION_balloon,
1004     "-balloon none   disable balloon device\n"
1005     "-balloon virtio[,addr=str]\n"
1006     "                enable virtio balloon device (default)\n", QEMU_ARCH_ALL)
1007 STEXI
1008 @item -balloon none
1009 @findex -balloon
1010 Disable balloon device.
1011 @item -balloon virtio[,addr=@var{addr}]
1012 Enable virtio balloon device (default), optionally with PCI address
1013 @var{addr}.
1014 ETEXI
1015
1016 DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable,
1017     "-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"
1018     "                ACPI table description\n", QEMU_ARCH_I386)
1019 STEXI
1020 @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}]...]
1021 @findex -acpitable
1022 Add ACPI table with specified header fields and context from specified files.
1023 ETEXI
1024
1025 DEF("smbios", HAS_ARG, QEMU_OPTION_smbios,
1026     "-smbios file=binary\n"
1027     "                load SMBIOS entry from binary file\n"
1028     "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n"
1029     "                specify SMBIOS type 0 fields\n"
1030     "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n"
1031     "              [,uuid=uuid][,sku=str][,family=str]\n"
1032     "                specify SMBIOS type 1 fields\n", QEMU_ARCH_I386)
1033 STEXI
1034 @item -smbios file=@var{binary}
1035 @findex -smbios
1036 Load SMBIOS entry from binary file.
1037
1038 @item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}]
1039 @findex -smbios
1040 Specify SMBIOS type 0 fields
1041
1042 @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}]
1043 Specify SMBIOS type 1 fields
1044 ETEXI
1045
1046 DEFHEADING()
1047 STEXI
1048 @end table
1049 ETEXI
1050
1051 DEFHEADING(Network options:)
1052 STEXI
1053 @table @option
1054 ETEXI
1055
1056 HXCOMM Legacy slirp options (now moved to -net user):
1057 #ifdef CONFIG_SLIRP
1058 DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL)
1059 DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL)
1060 DEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL)
1061 #ifndef _WIN32
1062 DEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL)
1063 #endif
1064 #endif
1065
1066 DEF("net", HAS_ARG, QEMU_OPTION_net,
1067     "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n"
1068     "                create a new Network Interface Card and connect it to VLAN 'n'\n"
1069 #ifdef CONFIG_SLIRP
1070     "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=y|n]\n"
1071     "         [,hostname=host][,dhcpstart=addr][,dns=addr][,tftp=dir][,bootfile=f]\n"
1072     "         [,hostfwd=rule][,guestfwd=rule]"
1073 #ifndef _WIN32
1074                                              "[,smb=dir[,smbserver=addr]]\n"
1075 #endif
1076     "                connect the user mode network stack to VLAN 'n', configure its\n"
1077     "                DHCP server and enabled optional services\n"
1078 #endif
1079 #ifdef _WIN32
1080     "-net tap[,vlan=n][,name=str],ifname=name\n"
1081     "                connect the host TAP network interface to VLAN 'n'\n"
1082 #else
1083     "-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"
1084     "                connect the host TAP network interface to VLAN 'n' and use the\n"
1085     "                network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n"
1086     "                and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n"
1087     "                use '[down]script=no' to disable script execution\n"
1088     "                use 'fd=h' to connect to an already opened TAP interface\n"
1089     "                use 'sndbuf=nbytes' to limit the size of the send buffer (the\n"
1090     "                default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n"
1091     "                use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n"
1092     "                use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n"
1093     "                use vhost=on to enable experimental in kernel accelerator\n"
1094     "                    (only has effect for virtio guests which use MSIX)\n"
1095     "                use vhostforce=on to force vhost on for non-MSIX virtio guests\n"
1096     "                use 'vhostfd=h' to connect to an already opened vhost net device\n"
1097 #endif
1098     "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n"
1099     "                connect the vlan 'n' to another VLAN using a socket connection\n"
1100     "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port[,localaddr=addr]]\n"
1101     "                connect the vlan 'n' to multicast maddr and port\n"
1102     "                use 'localaddr=addr' to specify the host address to send packets from\n"
1103 #ifdef CONFIG_VDE
1104     "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n"
1105     "                connect the vlan 'n' to port 'n' of a vde switch running\n"
1106     "                on host and listening for incoming connections on 'socketpath'.\n"
1107     "                Use group 'groupname' and mode 'octalmode' to change default\n"
1108     "                ownership and permissions for communication port.\n"
1109 #endif
1110     "-net dump[,vlan=n][,file=f][,len=n]\n"
1111     "                dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n"
1112     "-net none       use it alone to have zero network devices. If no -net option\n"
1113     "                is provided, the default is '-net nic -net user'\n", QEMU_ARCH_ALL)
1114 DEF("netdev", HAS_ARG, QEMU_OPTION_netdev,
1115     "-netdev ["
1116 #ifdef CONFIG_SLIRP
1117     "user|"
1118 #endif
1119     "tap|"
1120 #ifdef CONFIG_VDE
1121     "vde|"
1122 #endif
1123     "socket],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL)
1124 STEXI
1125 @item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}]
1126 @findex -net
1127 Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
1128 = 0 is the default). The NIC is an e1000 by default on the PC
1129 target. Optionally, the MAC address can be changed to @var{mac}, the
1130 device address set to @var{addr} (PCI cards only),
1131 and a @var{name} can be assigned for use in monitor commands.
1132 Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
1133 that the card should have; this option currently only affects virtio cards; set
1134 @var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
1135 NIC is created.  Qemu can emulate several different models of network card.
1136 Valid values for @var{type} are
1137 @code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er},
1138 @code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
1139 @code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
1140 Not all devices are supported on all targets.  Use -net nic,model=?
1141 for a list of available devices for your target.
1142
1143 @item -net user[,@var{option}][,@var{option}][,...]
1144 Use the user mode network stack which requires no administrator
1145 privilege to run. Valid options are:
1146
1147 @table @option
1148 @item vlan=@var{n}
1149 Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default).
1150
1151 @item name=@var{name}
1152 Assign symbolic name for use in monitor commands.
1153
1154 @item net=@var{addr}[/@var{mask}]
1155 Set IP network address the guest will see. Optionally specify the netmask,
1156 either in the form a.b.c.d or as number of valid top-most bits. Default is
1157 10.0.2.0/24.
1158
1159 @item host=@var{addr}
1160 Specify the guest-visible address of the host. Default is the 2nd IP in the
1161 guest network, i.e. x.x.x.2.
1162
1163 @item restrict=y|yes|n|no
1164 If this options is enabled, the guest will be isolated, i.e. it will not be
1165 able to contact the host and no guest IP packets will be routed over the host
1166 to the outside. This option does not affect explicitly set forwarding rule.
1167
1168 @item hostname=@var{name}
1169 Specifies the client hostname reported by the builtin DHCP server.
1170
1171 @item dhcpstart=@var{addr}
1172 Specify the first of the 16 IPs the built-in DHCP server can assign. Default
1173 is the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31.
1174
1175 @item dns=@var{addr}
1176 Specify the guest-visible address of the virtual nameserver. The address must
1177 be different from the host address. Default is the 3rd IP in the guest network,
1178 i.e. x.x.x.3.
1179
1180 @item tftp=@var{dir}
1181 When using the user mode network stack, activate a built-in TFTP
1182 server. The files in @var{dir} will be exposed as the root of a TFTP server.
1183 The TFTP client on the guest must be configured in binary mode (use the command
1184 @code{bin} of the Unix TFTP client).
1185
1186 @item bootfile=@var{file}
1187 When using the user mode network stack, broadcast @var{file} as the BOOTP
1188 filename. In conjunction with @option{tftp}, this can be used to network boot
1189 a guest from a local directory.
1190
1191 Example (using pxelinux):
1192 @example
1193 qemu -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
1194 @end example
1195
1196 @item smb=@var{dir}[,smbserver=@var{addr}]
1197 When using the user mode network stack, activate a built-in SMB
1198 server so that Windows OSes can access to the host files in @file{@var{dir}}
1199 transparently. The IP address of the SMB server can be set to @var{addr}. By
1200 default the 4th IP in the guest network is used, i.e. x.x.x.4.
1201
1202 In the guest Windows OS, the line:
1203 @example
1204 10.0.2.4 smbserver
1205 @end example
1206 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
1207 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
1208
1209 Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
1210
1211 Note that a SAMBA server must be installed on the host OS in
1212 @file{/usr/sbin/smbd}. QEMU was tested successfully with smbd versions from
1213 Red Hat 9, Fedora Core 3 and OpenSUSE 11.x.
1214
1215 @item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
1216 Redirect incoming TCP or UDP connections to the host port @var{hostport} to
1217 the guest IP address @var{guestaddr} on guest port @var{guestport}. If
1218 @var{guestaddr} is not specified, its value is x.x.x.15 (default first address
1219 given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
1220 be bound to a specific host interface. If no connection type is set, TCP is
1221 used. This option can be given multiple times.
1222
1223 For example, to redirect host X11 connection from screen 1 to guest
1224 screen 0, use the following:
1225
1226 @example
1227 # on the host
1228 qemu -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...]
1229 # this host xterm should open in the guest X11 server
1230 xterm -display :1
1231 @end example
1232
1233 To redirect telnet connections from host port 5555 to telnet port on
1234 the guest, use the following:
1235
1236 @example
1237 # on the host
1238 qemu -net user,hostfwd=tcp::5555-:23 [...]
1239 telnet localhost 5555
1240 @end example
1241
1242 Then when you use on the host @code{telnet localhost 5555}, you
1243 connect to the guest telnet server.
1244
1245 @item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
1246 Forward guest TCP connections to the IP address @var{server} on port @var{port}
1247 to the character device @var{dev}. This option can be given multiple times.
1248
1249 @end table
1250
1251 Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still
1252 processed and applied to -net user. Mixing them with the new configuration
1253 syntax gives undefined results. Their use for new applications is discouraged
1254 as they will be removed from future versions.
1255
1256 @item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}] [,script=@var{file}][,downscript=@var{dfile}]
1257 Connect the host TAP network interface @var{name} to VLAN @var{n}, use
1258 the network script @var{file} to configure it and the network script
1259 @var{dfile} to deconfigure it. If @var{name} is not provided, the OS
1260 automatically provides one. @option{fd}=@var{h} can be used to specify
1261 the handle of an already opened host TAP interface. The default network
1262 configure script is @file{/etc/qemu-ifup} and the default network
1263 deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no}
1264 or @option{downscript=no} to disable script execution. Example:
1265
1266 @example
1267 qemu linux.img -net nic -net tap
1268 @end example
1269
1270 More complicated example (two NICs, each one connected to a TAP device)
1271 @example
1272 qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
1273                -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
1274 @end example
1275
1276 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
1277
1278 Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
1279 machine using a TCP socket connection. If @option{listen} is
1280 specified, QEMU waits for incoming connections on @var{port}
1281 (@var{host} is optional). @option{connect} is used to connect to
1282 another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
1283 specifies an already opened TCP socket.
1284
1285 Example:
1286 @example
1287 # launch a first QEMU instance
1288 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1289                -net socket,listen=:1234
1290 # connect the VLAN 0 of this instance to the VLAN 0
1291 # of the first instance
1292 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1293                -net socket,connect=127.0.0.1:1234
1294 @end example
1295
1296 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]]
1297
1298 Create a VLAN @var{n} shared with another QEMU virtual
1299 machines using a UDP multicast socket, effectively making a bus for
1300 every QEMU with same multicast address @var{maddr} and @var{port}.
1301 NOTES:
1302 @enumerate
1303 @item
1304 Several QEMU can be running on different hosts and share same bus (assuming
1305 correct multicast setup for these hosts).
1306 @item
1307 mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
1308 @url{http://user-mode-linux.sf.net}.
1309 @item
1310 Use @option{fd=h} to specify an already opened UDP multicast socket.
1311 @end enumerate
1312
1313 Example:
1314 @example
1315 # launch one QEMU instance
1316 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1317                -net socket,mcast=230.0.0.1:1234
1318 # launch another QEMU instance on same "bus"
1319 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1320                -net socket,mcast=230.0.0.1:1234
1321 # launch yet another QEMU instance on same "bus"
1322 qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
1323                -net socket,mcast=230.0.0.1:1234
1324 @end example
1325
1326 Example (User Mode Linux compat.):
1327 @example
1328 # launch QEMU instance (note mcast address selected
1329 # is UML's default)
1330 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1331                -net socket,mcast=239.192.168.1:1102
1332 # launch UML
1333 /path/to/linux ubd0=/path/to/root_fs eth0=mcast
1334 @end example
1335
1336 Example (send packets from host's 1.2.3.4):
1337 @example
1338 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1339                -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4
1340 @end example
1341
1342 @item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
1343 Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
1344 listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
1345 and MODE @var{octalmode} to change default ownership and permissions for
1346 communication port. This option is available only if QEMU has been compiled
1347 with vde support enabled.
1348
1349 Example:
1350 @example
1351 # launch vde switch
1352 vde_switch -F -sock /tmp/myswitch
1353 # launch QEMU instance
1354 qemu linux.img -net nic -net vde,sock=/tmp/myswitch
1355 @end example
1356
1357 @item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
1358 Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
1359 At most @var{len} bytes (64k by default) per packet are stored. The file format is
1360 libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
1361
1362 @item -net none
1363 Indicate that no network devices should be configured. It is used to
1364 override the default configuration (@option{-net nic -net user}) which
1365 is activated if no @option{-net} options are provided.
1366
1367 @end table
1368 ETEXI
1369
1370 DEFHEADING()
1371
1372 DEFHEADING(Character device options:)
1373
1374 DEF("chardev", HAS_ARG, QEMU_OPTION_chardev,
1375     "-chardev null,id=id[,mux=on|off]\n"
1376     "-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n"
1377     "         [,server][,nowait][,telnet][,mux=on|off] (tcp)\n"
1378     "-chardev socket,id=id,path=path[,server][,nowait][,telnet],[mux=on|off] (unix)\n"
1379     "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n"
1380     "         [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n"
1381     "-chardev msmouse,id=id[,mux=on|off]\n"
1382     "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n"
1383     "         [,mux=on|off]\n"
1384     "-chardev file,id=id,path=path[,mux=on|off]\n"
1385     "-chardev pipe,id=id,path=path[,mux=on|off]\n"
1386 #ifdef _WIN32
1387     "-chardev console,id=id[,mux=on|off]\n"
1388     "-chardev serial,id=id,path=path[,mux=on|off]\n"
1389 #else
1390     "-chardev pty,id=id[,mux=on|off]\n"
1391     "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n"
1392 #endif
1393 #ifdef CONFIG_BRLAPI
1394     "-chardev braille,id=id[,mux=on|off]\n"
1395 #endif
1396 #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
1397         || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
1398     "-chardev tty,id=id,path=path[,mux=on|off]\n"
1399 #endif
1400 #if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__)
1401     "-chardev parport,id=id,path=path[,mux=on|off]\n"
1402 #endif
1403 #if defined(CONFIG_SPICE)
1404     "-chardev spicevmc,id=id,name=name[,debug=debug]\n"
1405 #endif
1406     , QEMU_ARCH_ALL
1407 )
1408
1409 STEXI
1410
1411 The general form of a character device option is:
1412 @table @option
1413
1414 @item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}]
1415 @findex -chardev
1416 Backend is one of:
1417 @option{null},
1418 @option{socket},
1419 @option{udp},
1420 @option{msmouse},
1421 @option{vc},
1422 @option{file},
1423 @option{pipe},
1424 @option{console},
1425 @option{serial},
1426 @option{pty},
1427 @option{stdio},
1428 @option{braille},
1429 @option{tty},
1430 @option{parport},
1431 @option{spicevmc}.
1432 The specific backend will determine the applicable options.
1433
1434 All devices must have an id, which can be any string up to 127 characters long.
1435 It is used to uniquely identify this device in other command line directives.
1436
1437 A character device may be used in multiplexing mode by multiple front-ends.
1438 The key sequence of @key{Control-a} and @key{c} will rotate the input focus
1439 between attached front-ends. Specify @option{mux=on} to enable this mode.
1440
1441 Options to each backend are described below.
1442
1443 @item -chardev null ,id=@var{id}
1444 A void device. This device will not emit any data, and will drop any data it
1445 receives. The null backend does not take any options.
1446
1447 @item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet]
1448
1449 Create a two-way stream socket, which can be either a TCP or a unix socket. A
1450 unix socket will be created if @option{path} is specified. Behaviour is
1451 undefined if TCP options are specified for a unix socket.
1452
1453 @option{server} specifies that the socket shall be a listening socket.
1454
1455 @option{nowait} specifies that QEMU should not block waiting for a client to
1456 connect to a listening socket.
1457
1458 @option{telnet} specifies that traffic on the socket should interpret telnet
1459 escape sequences.
1460
1461 TCP and unix socket options are given below:
1462
1463 @table @option
1464
1465 @item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay]
1466
1467 @option{host} for a listening socket specifies the local address to be bound.
1468 For a connecting socket species the remote host to connect to. @option{host} is
1469 optional for listening sockets. If not specified it defaults to @code{0.0.0.0}.
1470
1471 @option{port} for a listening socket specifies the local port to be bound. For a
1472 connecting socket specifies the port on the remote host to connect to.
1473 @option{port} can be given as either a port number or a service name.
1474 @option{port} is required.
1475
1476 @option{to} is only relevant to listening sockets. If it is specified, and
1477 @option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up
1478 to and including @option{to} until it succeeds. @option{to} must be specified
1479 as a port number.
1480
1481 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1482 If neither is specified the socket may use either protocol.
1483
1484 @option{nodelay} disables the Nagle algorithm.
1485
1486 @item unix options: path=@var{path}
1487
1488 @option{path} specifies the local path of the unix socket. @option{path} is
1489 required.
1490
1491 @end table
1492
1493 @item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6]
1494
1495 Sends all traffic from the guest to a remote host over UDP.
1496
1497 @option{host} specifies the remote host to connect to. If not specified it
1498 defaults to @code{localhost}.
1499
1500 @option{port} specifies the port on the remote host to connect to. @option{port}
1501 is required.
1502
1503 @option{localaddr} specifies the local address to bind to. If not specified it
1504 defaults to @code{0.0.0.0}.
1505
1506 @option{localport} specifies the local port to bind to. If not specified any
1507 available local port will be used.
1508
1509 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1510 If neither is specified the device may use either protocol.
1511
1512 @item -chardev msmouse ,id=@var{id}
1513
1514 Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not
1515 take any options.
1516
1517 @item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]]
1518
1519 Connect to a QEMU text console. @option{vc} may optionally be given a specific
1520 size.
1521
1522 @option{width} and @option{height} specify the width and height respectively of
1523 the console, in pixels.
1524
1525 @option{cols} and @option{rows} specify that the console be sized to fit a text
1526 console with the given dimensions.
1527
1528 @item -chardev file ,id=@var{id} ,path=@var{path}
1529
1530 Log all traffic received from the guest to a file.
1531
1532 @option{path} specifies the path of the file to be opened. This file will be
1533 created if it does not already exist, and overwritten if it does. @option{path}
1534 is required.
1535
1536 @item -chardev pipe ,id=@var{id} ,path=@var{path}
1537
1538 Create a two-way connection to the guest. The behaviour differs slightly between
1539 Windows hosts and other hosts:
1540
1541 On Windows, a single duplex pipe will be created at
1542 @file{\\.pipe\@option{path}}.
1543
1544 On other hosts, 2 pipes will be created called @file{@option{path}.in} and
1545 @file{@option{path}.out}. Data written to @file{@option{path}.in} will be
1546 received by the guest. Data written by the guest can be read from
1547 @file{@option{path}.out}. QEMU will not create these fifos, and requires them to
1548 be present.
1549
1550 @option{path} forms part of the pipe path as described above. @option{path} is
1551 required.
1552
1553 @item -chardev console ,id=@var{id}
1554
1555 Send traffic from the guest to QEMU's standard output. @option{console} does not
1556 take any options.
1557
1558 @option{console} is only available on Windows hosts.
1559
1560 @item -chardev serial ,id=@var{id} ,path=@option{path}
1561
1562 Send traffic from the guest to a serial device on the host.
1563
1564 @option{serial} is
1565 only available on Windows hosts.
1566
1567 @option{path} specifies the name of the serial device to open.
1568
1569 @item -chardev pty ,id=@var{id}
1570
1571 Create a new pseudo-terminal on the host and connect to it. @option{pty} does
1572 not take any options.
1573
1574 @option{pty} is not available on Windows hosts.
1575
1576 @item -chardev stdio ,id=@var{id} [,signal=on|off]
1577 Connect to standard input and standard output of the qemu process.
1578
1579 @option{signal} controls if signals are enabled on the terminal, that includes
1580 exiting QEMU with the key sequence @key{Control-c}. This option is enabled by
1581 default, use @option{signal=off} to disable it.
1582
1583 @option{stdio} is not available on Windows hosts.
1584
1585 @item -chardev braille ,id=@var{id}
1586
1587 Connect to a local BrlAPI server. @option{braille} does not take any options.
1588
1589 @item -chardev tty ,id=@var{id} ,path=@var{path}
1590
1591 Connect to a local tty device.
1592
1593 @option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and
1594 DragonFlyBSD hosts.
1595
1596 @option{path} specifies the path to the tty. @option{path} is required.
1597
1598 @item -chardev parport ,id=@var{id} ,path=@var{path}
1599
1600 @option{parport} is only available on Linux, FreeBSD and DragonFlyBSD hosts.
1601
1602 Connect to a local parallel port.
1603
1604 @option{path} specifies the path to the parallel port device. @option{path} is
1605 required.
1606
1607 #if defined(CONFIG_SPICE)
1608 @item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name}
1609
1610 @option{debug} debug level for spicevmc
1611
1612 @option{name} name of spice channel to connect to
1613
1614 Connect to a spice virtual machine channel, such as vdiport.
1615 #endif
1616
1617 @end table
1618 ETEXI
1619
1620 DEFHEADING()
1621
1622 DEFHEADING(Bluetooth(R) options:)
1623
1624 DEF("bt", HAS_ARG, QEMU_OPTION_bt, \
1625     "-bt hci,null    dumb bluetooth HCI - doesn't respond to commands\n" \
1626     "-bt hci,host[:id]\n" \
1627     "                use host's HCI with the given name\n" \
1628     "-bt hci[,vlan=n]\n" \
1629     "                emulate a standard HCI in virtual scatternet 'n'\n" \
1630     "-bt vhci[,vlan=n]\n" \
1631     "                add host computer to virtual scatternet 'n' using VHCI\n" \
1632     "-bt device:dev[,vlan=n]\n" \
1633     "                emulate a bluetooth device 'dev' in scatternet 'n'\n",
1634     QEMU_ARCH_ALL)
1635 STEXI
1636 @table @option
1637
1638 @item -bt hci[...]
1639 @findex -bt
1640 Defines the function of the corresponding Bluetooth HCI.  -bt options
1641 are matched with the HCIs present in the chosen machine type.  For
1642 example when emulating a machine with only one HCI built into it, only
1643 the first @code{-bt hci[...]} option is valid and defines the HCI's
1644 logic.  The Transport Layer is decided by the machine type.  Currently
1645 the machines @code{n800} and @code{n810} have one HCI and all other
1646 machines have none.
1647
1648 @anchor{bt-hcis}
1649 The following three types are recognized:
1650
1651 @table @option
1652 @item -bt hci,null
1653 (default) The corresponding Bluetooth HCI assumes no internal logic
1654 and will not respond to any HCI commands or emit events.
1655
1656 @item -bt hci,host[:@var{id}]
1657 (@code{bluez} only) The corresponding HCI passes commands / events
1658 to / from the physical HCI identified by the name @var{id} (default:
1659 @code{hci0}) on the computer running QEMU.  Only available on @code{bluez}
1660 capable systems like Linux.
1661
1662 @item -bt hci[,vlan=@var{n}]
1663 Add a virtual, standard HCI that will participate in the Bluetooth
1664 scatternet @var{n} (default @code{0}).  Similarly to @option{-net}
1665 VLANs, devices inside a bluetooth network @var{n} can only communicate
1666 with other devices in the same network (scatternet).
1667 @end table
1668
1669 @item -bt vhci[,vlan=@var{n}]
1670 (Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
1671 to the host bluetooth stack instead of to the emulated target.  This
1672 allows the host and target machines to participate in a common scatternet
1673 and communicate.  Requires the Linux @code{vhci} driver installed.  Can
1674 be used as following:
1675
1676 @example
1677 qemu [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
1678 @end example
1679
1680 @item -bt device:@var{dev}[,vlan=@var{n}]
1681 Emulate a bluetooth device @var{dev} and place it in network @var{n}
1682 (default @code{0}).  QEMU can only emulate one type of bluetooth devices
1683 currently:
1684
1685 @table @option
1686 @item keyboard
1687 Virtual wireless keyboard implementing the HIDP bluetooth profile.
1688 @end table
1689 @end table
1690 ETEXI
1691
1692 DEFHEADING()
1693
1694 DEFHEADING(Linux/Multiboot boot specific:)
1695 STEXI
1696
1697 When using these options, you can use a given Linux or Multiboot
1698 kernel without installing it in the disk image. It can be useful
1699 for easier testing of various kernels.
1700
1701 @table @option
1702 ETEXI
1703
1704 DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \
1705     "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL)
1706 STEXI
1707 @item -kernel @var{bzImage}
1708 @findex -kernel
1709 Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel
1710 or in multiboot format.
1711 ETEXI
1712
1713 DEF("append", HAS_ARG, QEMU_OPTION_append, \
1714     "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL)
1715 STEXI
1716 @item -append @var{cmdline}
1717 @findex -append
1718 Use @var{cmdline} as kernel command line
1719 ETEXI
1720
1721 DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \
1722            "-initrd file    use 'file' as initial ram disk\n", QEMU_ARCH_ALL)
1723 STEXI
1724 @item -initrd @var{file}
1725 @findex -initrd
1726 Use @var{file} as initial ram disk.
1727
1728 @item -initrd "@var{file1} arg=foo,@var{file2}"
1729
1730 This syntax is only available with multiboot.
1731
1732 Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the
1733 first module.
1734 ETEXI
1735
1736 STEXI
1737 @end table
1738 ETEXI
1739
1740 DEFHEADING()
1741
1742 DEFHEADING(Debug/Expert options:)
1743
1744 STEXI
1745 @table @option
1746 ETEXI
1747
1748 DEF("serial", HAS_ARG, QEMU_OPTION_serial, \
1749     "-serial dev     redirect the serial port to char device 'dev'\n",
1750     QEMU_ARCH_ALL)
1751 STEXI
1752 @item -serial @var{dev}
1753 @findex -serial
1754 Redirect the virtual serial port to host character device
1755 @var{dev}. The default device is @code{vc} in graphical mode and
1756 @code{stdio} in non graphical mode.
1757
1758 This option can be used several times to simulate up to 4 serial
1759 ports.
1760
1761 Use @code{-serial none} to disable all serial ports.
1762
1763 Available character devices are:
1764 @table @option
1765 @item vc[:@var{W}x@var{H}]
1766 Virtual console. Optionally, a width and height can be given in pixel with
1767 @example
1768 vc:800x600
1769 @end example
1770 It is also possible to specify width or height in characters:
1771 @example
1772 vc:80Cx24C
1773 @end example
1774 @item pty
1775 [Linux only] Pseudo TTY (a new PTY is automatically allocated)
1776 @item none
1777 No device is allocated.
1778 @item null
1779 void device
1780 @item /dev/XXX
1781 [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
1782 parameters are set according to the emulated ones.
1783 @item /dev/parport@var{N}
1784 [Linux only, parallel port only] Use host parallel port
1785 @var{N}. Currently SPP and EPP parallel port features can be used.
1786 @item file:@var{filename}
1787 Write output to @var{filename}. No character can be read.
1788 @item stdio
1789 [Unix only] standard input/output
1790 @item pipe:@var{filename}
1791 name pipe @var{filename}
1792 @item COM@var{n}
1793 [Windows only] Use host serial port @var{n}
1794 @item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
1795 This implements UDP Net Console.
1796 When @var{remote_host} or @var{src_ip} are not specified
1797 they default to @code{0.0.0.0}.
1798 When not using a specified @var{src_port} a random port is automatically chosen.
1799
1800 If you just want a simple readonly console you can use @code{netcat} or
1801 @code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
1802 @code{nc -u -l -p 4555}. Any time qemu writes something to that port it
1803 will appear in the netconsole session.
1804
1805 If you plan to send characters back via netconsole or you want to stop
1806 and start qemu a lot of times, you should have qemu use the same
1807 source port each time by using something like @code{-serial
1808 udp::4555@@:4556} to qemu. Another approach is to use a patched
1809 version of netcat which can listen to a TCP port and send and receive
1810 characters via udp.  If you have a patched version of netcat which
1811 activates telnet remote echo and single char transfer, then you can
1812 use the following options to step up a netcat redirector to allow
1813 telnet on port 5555 to access the qemu port.
1814 @table @code
1815 @item Qemu Options:
1816 -serial udp::4555@@:4556
1817 @item netcat options:
1818 -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
1819 @item telnet options:
1820 localhost 5555
1821 @end table
1822
1823 @item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay]
1824 The TCP Net Console has two modes of operation.  It can send the serial
1825 I/O to a location or wait for a connection from a location.  By default
1826 the TCP Net Console is sent to @var{host} at the @var{port}.  If you use
1827 the @var{server} option QEMU will wait for a client socket application
1828 to connect to the port before continuing, unless the @code{nowait}
1829 option was specified.  The @code{nodelay} option disables the Nagle buffering
1830 algorithm.  If @var{host} is omitted, 0.0.0.0 is assumed. Only
1831 one TCP connection at a time is accepted. You can use @code{telnet} to
1832 connect to the corresponding character device.
1833 @table @code
1834 @item Example to send tcp console to 192.168.0.2 port 4444
1835 -serial tcp:192.168.0.2:4444
1836 @item Example to listen and wait on port 4444 for connection
1837 -serial tcp::4444,server
1838 @item Example to not wait and listen on ip 192.168.0.100 port 4444
1839 -serial tcp:192.168.0.100:4444,server,nowait
1840 @end table
1841
1842 @item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
1843 The telnet protocol is used instead of raw tcp sockets.  The options
1844 work the same as if you had specified @code{-serial tcp}.  The
1845 difference is that the port acts like a telnet server or client using
1846 telnet option negotiation.  This will also allow you to send the
1847 MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
1848 sequence.  Typically in unix telnet you do it with Control-] and then
1849 type "send break" followed by pressing the enter key.
1850
1851 @item unix:@var{path}[,server][,nowait]
1852 A unix domain socket is used instead of a tcp socket.  The option works the
1853 same as if you had specified @code{-serial tcp} except the unix domain socket
1854 @var{path} is used for connections.
1855
1856 @item mon:@var{dev_string}
1857 This is a special option to allow the monitor to be multiplexed onto
1858 another serial port.  The monitor is accessed with key sequence of
1859 @key{Control-a} and then pressing @key{c}. See monitor access
1860 @ref{pcsys_keys} in the -nographic section for more keys.
1861 @var{dev_string} should be any one of the serial devices specified
1862 above.  An example to multiplex the monitor onto a telnet server
1863 listening on port 4444 would be:
1864 @table @code
1865 @item -serial mon:telnet::4444,server,nowait
1866 @end table
1867
1868 @item braille
1869 Braille device.  This will use BrlAPI to display the braille output on a real
1870 or fake device.
1871
1872 @item msmouse
1873 Three button serial mouse. Configure the guest to use Microsoft protocol.
1874 @end table
1875 ETEXI
1876
1877 DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \
1878     "-parallel dev   redirect the parallel port to char device 'dev'\n",
1879     QEMU_ARCH_ALL)
1880 STEXI
1881 @item -parallel @var{dev}
1882 @findex -parallel
1883 Redirect the virtual parallel port to host device @var{dev} (same
1884 devices as the serial port). On Linux hosts, @file{/dev/parportN} can
1885 be used to use hardware devices connected on the corresponding host
1886 parallel port.
1887
1888 This option can be used several times to simulate up to 3 parallel
1889 ports.
1890
1891 Use @code{-parallel none} to disable all parallel ports.
1892 ETEXI
1893
1894 DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \
1895     "-monitor dev    redirect the monitor to char device 'dev'\n",
1896     QEMU_ARCH_ALL)
1897 STEXI
1898 @item -monitor @var{dev}
1899 @findex -monitor
1900 Redirect the monitor to host device @var{dev} (same devices as the
1901 serial port).
1902 The default device is @code{vc} in graphical mode and @code{stdio} in
1903 non graphical mode.
1904 ETEXI
1905 DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \
1906     "-qmp dev        like -monitor but opens in 'control' mode\n",
1907     QEMU_ARCH_ALL)
1908 STEXI
1909 @item -qmp @var{dev}
1910 @findex -qmp
1911 Like -monitor but opens in 'control' mode.
1912 ETEXI
1913
1914 DEF("mon", HAS_ARG, QEMU_OPTION_mon, \
1915     "-mon chardev=[name][,mode=readline|control][,default]\n", QEMU_ARCH_ALL)
1916 STEXI
1917 @item -mon chardev=[name][,mode=readline|control][,default]
1918 @findex -mon
1919 Setup monitor on chardev @var{name}.
1920 ETEXI
1921
1922 DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \
1923     "-debugcon dev   redirect the debug console to char device 'dev'\n",
1924     QEMU_ARCH_ALL)
1925 STEXI
1926 @item -debugcon @var{dev}
1927 @findex -debugcon
1928 Redirect the debug console to host device @var{dev} (same devices as the
1929 serial port).  The debug console is an I/O port which is typically port
1930 0xe9; writing to that I/O port sends output to this device.
1931 The default device is @code{vc} in graphical mode and @code{stdio} in
1932 non graphical mode.
1933 ETEXI
1934
1935 DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \
1936     "-pidfile file   write PID to 'file'\n", QEMU_ARCH_ALL)
1937 STEXI
1938 @item -pidfile @var{file}
1939 @findex -pidfile
1940 Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
1941 from a script.
1942 ETEXI
1943
1944 DEF("singlestep", 0, QEMU_OPTION_singlestep, \
1945     "-singlestep     always run in singlestep mode\n", QEMU_ARCH_ALL)
1946 STEXI
1947 @item -singlestep
1948 @findex -singlestep
1949 Run the emulation in single step mode.
1950 ETEXI
1951
1952 DEF("S", 0, QEMU_OPTION_S, \
1953     "-S              freeze CPU at startup (use 'c' to start execution)\n",
1954     QEMU_ARCH_ALL)
1955 STEXI
1956 @item -S
1957 @findex -S
1958 Do not start CPU at startup (you must type 'c' in the monitor).
1959 ETEXI
1960
1961 DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \
1962     "-gdb dev        wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL)
1963 STEXI
1964 @item -gdb @var{dev}
1965 @findex -gdb
1966 Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical
1967 connections will likely be TCP-based, but also UDP, pseudo TTY, or even
1968 stdio are reasonable use case. The latter is allowing to start qemu from
1969 within gdb and establish the connection via a pipe:
1970 @example
1971 (gdb) target remote | exec qemu -gdb stdio ...
1972 @end example
1973 ETEXI
1974
1975 DEF("s", 0, QEMU_OPTION_s, \
1976     "-s              shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n",
1977     QEMU_ARCH_ALL)
1978 STEXI
1979 @item -s
1980 @findex -s
1981 Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
1982 (@pxref{gdb_usage}).
1983 ETEXI
1984
1985 DEF("d", HAS_ARG, QEMU_OPTION_d, \
1986     "-d item1,...    output log to /tmp/qemu.log (use -d ? for a list of log items)\n",
1987     QEMU_ARCH_ALL)
1988 STEXI
1989 @item -d
1990 @findex -d
1991 Output log in /tmp/qemu.log
1992 ETEXI
1993
1994 DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \
1995     "-hdachs c,h,s[,t]\n" \
1996     "                force hard disk 0 physical geometry and the optional BIOS\n" \
1997     "                translation (t=none or lba) (usually qemu can guess them)\n",
1998     QEMU_ARCH_ALL)
1999 STEXI
2000 @item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
2001 @findex -hdachs
2002 Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
2003 @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
2004 translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
2005 all those parameters. This option is useful for old MS-DOS disk
2006 images.
2007 ETEXI
2008
2009 DEF("L", HAS_ARG, QEMU_OPTION_L, \
2010     "-L path         set the directory for the BIOS, VGA BIOS and keymaps\n",
2011     QEMU_ARCH_ALL)
2012 STEXI
2013 @item -L  @var{path}
2014 @findex -L
2015 Set the directory for the BIOS, VGA BIOS and keymaps.
2016 ETEXI
2017
2018 DEF("bios", HAS_ARG, QEMU_OPTION_bios, \
2019     "-bios file      set the filename for the BIOS\n", QEMU_ARCH_ALL)
2020 STEXI
2021 @item -bios @var{file}
2022 @findex -bios
2023 Set the filename for the BIOS.
2024 ETEXI
2025
2026 DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \
2027     "-enable-kvm     enable KVM full virtualization support\n", QEMU_ARCH_ALL)
2028 STEXI
2029 @item -enable-kvm
2030 @findex -enable-kvm
2031 Enable KVM full virtualization support. This option is only available
2032 if KVM support is enabled when compiling.
2033 ETEXI
2034
2035 DEF("machine", HAS_ARG, QEMU_OPTION_machine, \
2036     "-machine accel=accel1[:accel2]    use an accelerator (kvm,xen,tcg), default is tcg\n", QEMU_ARCH_ALL)
2037 STEXI
2038 @item -machine accel=@var{accels}
2039 @findex -machine
2040 This is use to enable an accelerator, in kvm,xen,tcg.
2041 By default, it use only tcg. If there a more than one accelerator
2042 specified, the next one is used if the first don't work.
2043 ETEXI
2044
2045 DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid,
2046     "-xen-domid id   specify xen guest domain id\n", QEMU_ARCH_ALL)
2047 DEF("xen-create", 0, QEMU_OPTION_xen_create,
2048     "-xen-create     create domain using xen hypercalls, bypassing xend\n"
2049     "                warning: should not be used when xend is in use\n",
2050     QEMU_ARCH_ALL)
2051 DEF("xen-attach", 0, QEMU_OPTION_xen_attach,
2052     "-xen-attach     attach to existing xen domain\n"
2053     "                xend will use this when starting qemu\n",
2054     QEMU_ARCH_ALL)
2055 STEXI
2056 @item -xen-domid @var{id}
2057 @findex -xen-domid
2058 Specify xen guest domain @var{id} (XEN only).
2059 @item -xen-create
2060 @findex -xen-create
2061 Create domain using xen hypercalls, bypassing xend.
2062 Warning: should not be used when xend is in use (XEN only).
2063 @item -xen-attach
2064 @findex -xen-attach
2065 Attach to existing xen domain.
2066 xend will use this when starting qemu (XEN only).
2067 ETEXI
2068
2069 DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \
2070     "-no-reboot      exit instead of rebooting\n", QEMU_ARCH_ALL)
2071 STEXI
2072 @item -no-reboot
2073 @findex -no-reboot
2074 Exit instead of rebooting.
2075 ETEXI
2076
2077 DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \
2078     "-no-shutdown    stop before shutdown\n", QEMU_ARCH_ALL)
2079 STEXI
2080 @item -no-shutdown
2081 @findex -no-shutdown
2082 Don't exit QEMU on guest shutdown, but instead only stop the emulation.
2083 This allows for instance switching to monitor to commit changes to the
2084 disk image.
2085 ETEXI
2086
2087 DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \
2088     "-loadvm [tag|id]\n" \
2089     "                start right away with a saved state (loadvm in monitor)\n",
2090     QEMU_ARCH_ALL)
2091 STEXI
2092 @item -loadvm @var{file}
2093 @findex -loadvm
2094 Start right away with a saved state (@code{loadvm} in monitor)
2095 ETEXI
2096
2097 #ifndef _WIN32
2098 DEF("daemonize", 0, QEMU_OPTION_daemonize, \
2099     "-daemonize      daemonize QEMU after initializing\n", QEMU_ARCH_ALL)
2100 #endif
2101 STEXI
2102 @item -daemonize
2103 @findex -daemonize
2104 Daemonize the QEMU process after initialization.  QEMU will not detach from
2105 standard IO until it is ready to receive connections on any of its devices.
2106 This option is a useful way for external programs to launch QEMU without having
2107 to cope with initialization race conditions.
2108 ETEXI
2109
2110 DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \
2111     "-option-rom rom load a file, rom, into the option ROM space\n",
2112     QEMU_ARCH_ALL)
2113 STEXI
2114 @item -option-rom @var{file}
2115 @findex -option-rom
2116 Load the contents of @var{file} as an option ROM.
2117 This option is useful to load things like EtherBoot.
2118 ETEXI
2119
2120 DEF("clock", HAS_ARG, QEMU_OPTION_clock, \
2121     "-clock          force the use of the given methods for timer alarm.\n" \
2122     "                To see what timers are available use -clock ?\n",
2123     QEMU_ARCH_ALL)
2124 STEXI
2125 @item -clock @var{method}
2126 @findex -clock
2127 Force the use of the given methods for timer alarm. To see what timers
2128 are available use -clock ?.
2129 ETEXI
2130
2131 HXCOMM Options deprecated by -rtc
2132 DEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL)
2133 DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL)
2134
2135 DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \
2136     "-rtc [base=utc|localtime|date][,clock=host|vm][,driftfix=none|slew]\n" \
2137     "                set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n",
2138     QEMU_ARCH_ALL)
2139
2140 STEXI
2141
2142 @item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew]
2143 @findex -rtc
2144 Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current
2145 UTC or local time, respectively. @code{localtime} is required for correct date in
2146 MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the
2147 format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC.
2148
2149 By default the RTC is driven by the host system time. This allows to use the
2150 RTC as accurate reference clock inside the guest, specifically if the host
2151 time is smoothly following an accurate external reference clock, e.g. via NTP.
2152 If you want to isolate the guest time from the host, even prevent it from
2153 progressing during suspension, you can set @option{clock} to @code{vm} instead.
2154
2155 Enable @option{driftfix} (i386 targets only) if you experience time drift problems,
2156 specifically with Windows' ACPI HAL. This option will try to figure out how
2157 many timer interrupts were not processed by the Windows guest and will
2158 re-inject them.
2159 ETEXI
2160
2161 DEF("icount", HAS_ARG, QEMU_OPTION_icount, \
2162     "-icount [N|auto]\n" \
2163     "                enable virtual instruction counter with 2^N clock ticks per\n" \
2164     "                instruction\n", QEMU_ARCH_ALL)
2165 STEXI
2166 @item -icount [@var{N}|auto]
2167 @findex -icount
2168 Enable virtual instruction counter.  The virtual cpu will execute one
2169 instruction every 2^@var{N} ns of virtual time.  If @code{auto} is specified
2170 then the virtual cpu speed will be automatically adjusted to keep virtual
2171 time within a few seconds of real time.
2172
2173 Note that while this option can give deterministic behavior, it does not
2174 provide cycle accurate emulation.  Modern CPUs contain superscalar out of
2175 order cores with complex cache hierarchies.  The number of instructions
2176 executed often has little or no correlation with actual performance.
2177 ETEXI
2178
2179 DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \
2180     "-watchdog i6300esb|ib700\n" \
2181     "                enable virtual hardware watchdog [default=none]\n",
2182     QEMU_ARCH_ALL)
2183 STEXI
2184 @item -watchdog @var{model}
2185 @findex -watchdog
2186 Create a virtual hardware watchdog device.  Once enabled (by a guest
2187 action), the watchdog must be periodically polled by an agent inside
2188 the guest or else the guest will be restarted.
2189
2190 The @var{model} is the model of hardware watchdog to emulate.  Choices
2191 for model are: @code{ib700} (iBASE 700) which is a very simple ISA
2192 watchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O
2193 controller hub) which is a much more featureful PCI-based dual-timer
2194 watchdog.  Choose a model for which your guest has drivers.
2195
2196 Use @code{-watchdog ?} to list available hardware models.  Only one
2197 watchdog can be enabled for a guest.
2198 ETEXI
2199
2200 DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \
2201     "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \
2202     "                action when watchdog fires [default=reset]\n",
2203     QEMU_ARCH_ALL)
2204 STEXI
2205 @item -watchdog-action @var{action}
2206
2207 The @var{action} controls what QEMU will do when the watchdog timer
2208 expires.
2209 The default is
2210 @code{reset} (forcefully reset the guest).
2211 Other possible actions are:
2212 @code{shutdown} (attempt to gracefully shutdown the guest),
2213 @code{poweroff} (forcefully poweroff the guest),
2214 @code{pause} (pause the guest),
2215 @code{debug} (print a debug message and continue), or
2216 @code{none} (do nothing).
2217
2218 Note that the @code{shutdown} action requires that the guest responds
2219 to ACPI signals, which it may not be able to do in the sort of
2220 situations where the watchdog would have expired, and thus
2221 @code{-watchdog-action shutdown} is not recommended for production use.
2222
2223 Examples:
2224
2225 @table @code
2226 @item -watchdog i6300esb -watchdog-action pause
2227 @item -watchdog ib700
2228 @end table
2229 ETEXI
2230
2231 DEF("echr", HAS_ARG, QEMU_OPTION_echr, \
2232     "-echr chr       set terminal escape character instead of ctrl-a\n",
2233     QEMU_ARCH_ALL)
2234 STEXI
2235
2236 @item -echr @var{numeric_ascii_value}
2237 @findex -echr
2238 Change the escape character used for switching to the monitor when using
2239 monitor and serial sharing.  The default is @code{0x01} when using the
2240 @code{-nographic} option.  @code{0x01} is equal to pressing
2241 @code{Control-a}.  You can select a different character from the ascii
2242 control keys where 1 through 26 map to Control-a through Control-z.  For
2243 instance you could use the either of the following to change the escape
2244 character to Control-t.
2245 @table @code
2246 @item -echr 0x14
2247 @item -echr 20
2248 @end table
2249 ETEXI
2250
2251 DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \
2252     "-virtioconsole c\n" \
2253     "                set virtio console\n", QEMU_ARCH_ALL)
2254 STEXI
2255 @item -virtioconsole @var{c}
2256 @findex -virtioconsole
2257 Set virtio console.
2258
2259 This option is maintained for backward compatibility.
2260
2261 Please use @code{-device virtconsole} for the new way of invocation.
2262 ETEXI
2263
2264 DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \
2265     "-show-cursor    show cursor\n", QEMU_ARCH_ALL)
2266 STEXI
2267 @item -show-cursor
2268 @findex -show-cursor
2269 Show cursor.
2270 ETEXI
2271
2272 DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \
2273     "-tb-size n      set TB size\n", QEMU_ARCH_ALL)
2274 STEXI
2275 @item -tb-size @var{n}
2276 @findex -tb-size
2277 Set TB size.
2278 ETEXI
2279
2280 DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \
2281     "-incoming p     prepare for incoming migration, listen on port p\n",
2282     QEMU_ARCH_ALL)
2283 STEXI
2284 @item -incoming @var{port}
2285 @findex -incoming
2286 Prepare for incoming migration, listen on @var{port}.
2287 ETEXI
2288
2289 DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \
2290     "-nodefaults     don't create default devices\n", QEMU_ARCH_ALL)
2291 STEXI
2292 @item -nodefaults
2293 @findex -nodefaults
2294 Don't create default devices.
2295 ETEXI
2296
2297 #ifndef _WIN32
2298 DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \
2299     "-chroot dir     chroot to dir just before starting the VM\n",
2300     QEMU_ARCH_ALL)
2301 #endif
2302 STEXI
2303 @item -chroot @var{dir}
2304 @findex -chroot
2305 Immediately before starting guest execution, chroot to the specified
2306 directory.  Especially useful in combination with -runas.
2307 ETEXI
2308
2309 #ifndef _WIN32
2310 DEF("runas", HAS_ARG, QEMU_OPTION_runas, \
2311     "-runas user     change to user id user just before starting the VM\n",
2312     QEMU_ARCH_ALL)
2313 #endif
2314 STEXI
2315 @item -runas @var{user}
2316 @findex -runas
2317 Immediately before starting guest execution, drop root privileges, switching
2318 to the specified user.
2319 ETEXI
2320
2321 DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env,
2322     "-prom-env variable=value\n"
2323     "                set OpenBIOS nvram variables\n",
2324     QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
2325 STEXI
2326 @item -prom-env @var{variable}=@var{value}
2327 @findex -prom-env
2328 Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only).
2329 ETEXI
2330 DEF("semihosting", 0, QEMU_OPTION_semihosting,
2331     "-semihosting    semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K)
2332 STEXI
2333 @item -semihosting
2334 @findex -semihosting
2335 Semihosting mode (ARM, M68K only).
2336 ETEXI
2337 DEF("old-param", 0, QEMU_OPTION_old_param,
2338     "-old-param      old param mode\n", QEMU_ARCH_ARM)
2339 STEXI
2340 @item -old-param
2341 @findex -old-param (ARM)
2342 Old param mode (ARM only).
2343 ETEXI
2344
2345 DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig,
2346     "-readconfig <file>\n", QEMU_ARCH_ALL)
2347 STEXI
2348 @item -readconfig @var{file}
2349 @findex -readconfig
2350 Read device configuration from @var{file}.
2351 ETEXI
2352 DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig,
2353     "-writeconfig <file>\n"
2354     "                read/write config file\n", QEMU_ARCH_ALL)
2355 STEXI
2356 @item -writeconfig @var{file}
2357 @findex -writeconfig
2358 Write device configuration to @var{file}.
2359 ETEXI
2360 DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig,
2361     "-nodefconfig\n"
2362     "                do not load default config files at startup\n",
2363     QEMU_ARCH_ALL)
2364 STEXI
2365 @item -nodefconfig
2366 @findex -nodefconfig
2367 Normally QEMU loads a configuration file from @var{sysconfdir}/qemu.conf and
2368 @var{sysconfdir}/target-@var{ARCH}.conf on startup.  The @code{-nodefconfig}
2369 option will prevent QEMU from loading these configuration files at startup.
2370 ETEXI
2371 #ifdef CONFIG_SIMPLE_TRACE
2372 DEF("trace", HAS_ARG, QEMU_OPTION_trace,
2373     "-trace\n"
2374     "                Specify a trace file to log traces to\n",
2375     QEMU_ARCH_ALL)
2376 STEXI
2377 @item -trace
2378 @findex -trace
2379 Specify a trace file to log output traces to.
2380 ETEXI
2381 #endif
2382
2383 HXCOMM This is the last statement. Insert new options before this line!
2384 STEXI
2385 @end table
2386 ETEXI