x86: Factor out pc_new_cpu
[qemu-kvm/fedora.git] / qemu-options.hx
blobdc54115e5216188ee9890b45285a19c7092611bc
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) is used to construct
5 HXCOMM option structures, enums and help message.
6 HXCOMM HXCOMM can be used for comments, discarded from both texi and C
8 DEFHEADING(Standard options:)
9 STEXI
10 @table @option
11 ETEXI
13 DEF("help", 0, QEMU_OPTION_h,
14 "-h or -help display this help and exit\n")
15 STEXI
16 @item -h
17 Display help and exit
18 ETEXI
20 DEF("version", 0, QEMU_OPTION_version,
21 "-version display version information and exit\n")
22 STEXI
23 @item -version
24 Display version information and exit
25 ETEXI
27 DEF("M", HAS_ARG, QEMU_OPTION_M,
28 "-M machine select emulated machine (-M ? for list)\n")
29 STEXI
30 @item -M @var{machine}
31 Select the emulated @var{machine} (@code{-M ?} for list)
32 ETEXI
34 DEF("cpu", HAS_ARG, QEMU_OPTION_cpu,
35 "-cpu cpu select CPU (-cpu ? for list)\n")
36 STEXI
37 @item -cpu @var{model}
38 Select CPU model (-cpu ? for list and additional feature selection)
39 ETEXI
41 DEF("smp", HAS_ARG, QEMU_OPTION_smp,
42 "-smp n set the number of CPUs to 'n' [default=1]\n")
43 STEXI
44 @item -smp @var{n}
45 Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
46 CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs
47 to 4.
48 ETEXI
50 DEF("numa", HAS_ARG, QEMU_OPTION_numa,
51 "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n")
52 STEXI
53 @item -numa @var{opts}
54 Simulate a multi node NUMA system. If mem and cpus are omitted, resources
55 are split equally.
56 ETEXI
58 DEF("fda", HAS_ARG, QEMU_OPTION_fda,
59 "-fda/-fdb file use 'file' as floppy disk 0/1 image\n")
60 DEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "")
61 STEXI
62 @item -fda @var{file}
63 @item -fdb @var{file}
64 Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can
65 use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}).
66 ETEXI
68 DEF("hda", HAS_ARG, QEMU_OPTION_hda,
69 "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n")
70 DEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "")
71 DEF("hdc", HAS_ARG, QEMU_OPTION_hdc,
72 "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n")
73 DEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "")
74 STEXI
75 @item -hda @var{file}
76 @item -hdb @var{file}
77 @item -hdc @var{file}
78 @item -hdd @var{file}
79 Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
80 ETEXI
82 DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom,
83 "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n")
84 STEXI
85 @item -cdrom @var{file}
86 Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and
87 @option{-cdrom} at the same time). You can use the host CD-ROM by
88 using @file{/dev/cdrom} as filename (@pxref{host_drives}).
89 ETEXI
91 DEF("drive", HAS_ARG, QEMU_OPTION_drive,
92 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n"
93 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n"
94 " [,cache=writethrough|writeback|none][,format=f][,serial=s]\n"
95 " [,addr=A]\n"
96 " use 'file' as a drive image\n")
97 STEXI
98 @item -drive @var{option}[,@var{option}[,@var{option}[,...]]]
100 Define a new drive. Valid options are:
102 @table @code
103 @item file=@var{file}
104 This option defines which disk image (@pxref{disk_images}) to use with
105 this drive. If the filename contains comma, you must double it
106 (for instance, "file=my,,file" to use file "my,file").
107 @item if=@var{interface}
108 This option defines on which type on interface the drive is connected.
109 Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio.
110 @item bus=@var{bus},unit=@var{unit}
111 These options define where is connected the drive by defining the bus number and
112 the unit id.
113 @item index=@var{index}
114 This option defines where is connected the drive by using an index in the list
115 of available connectors of a given interface type.
116 @item media=@var{media}
117 This option defines the type of the media: disk or cdrom.
118 @item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}]
119 These options have the same definition as they have in @option{-hdachs}.
120 @item snapshot=@var{snapshot}
121 @var{snapshot} is "on" or "off" and allows to enable snapshot for given drive (see @option{-snapshot}).
122 @item cache=@var{cache}
123 @var{cache} is "none", "writeback", or "writethrough" and controls how the host cache is used to access block data.
124 @item format=@var{format}
125 Specify which disk @var{format} will be used rather than detecting
126 the format. Can be used to specifiy format=raw to avoid interpreting
127 an untrusted format header.
128 @item serial=@var{serial}
129 This option specifies the serial number to assign to the device.
130 @item addr=@var{addr}
131 Specify the controller's PCI address (if=virtio only).
132 @end table
134 By default, writethrough caching is used for all block device. This means that
135 the host page cache will be used to read and write data but write notification
136 will be sent to the guest only when the data has been reported as written by
137 the storage subsystem.
139 Writeback caching will report data writes as completed as soon as the data is
140 present in the host page cache. This is safe as long as you trust your host.
141 If your host crashes or loses power, then the guest may experience data
142 corruption. When using the @option{-snapshot} option, writeback caching is
143 used by default.
145 The host page cache can be avoided entirely with @option{cache=none}. This will
146 attempt to do disk IO directly to the guests memory. QEMU may still perform
147 an internal copy of the data.
149 Some block drivers perform badly with @option{cache=writethrough}, most notably,
150 qcow2. If performance is more important than correctness,
151 @option{cache=writeback} should be used with qcow2. By default, if no explicit
152 caching is specified for a qcow2 disk image, @option{cache=writeback} will be
153 used. For all other disk types, @option{cache=writethrough} is the default.
155 Instead of @option{-cdrom} you can use:
156 @example
157 qemu -drive file=file,index=2,media=cdrom
158 @end example
160 Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
161 use:
162 @example
163 qemu -drive file=file,index=0,media=disk
164 qemu -drive file=file,index=1,media=disk
165 qemu -drive file=file,index=2,media=disk
166 qemu -drive file=file,index=3,media=disk
167 @end example
169 You can connect a CDROM to the slave of ide0:
170 @example
171 qemu -drive file=file,if=ide,index=1,media=cdrom
172 @end example
174 If you don't specify the "file=" argument, you define an empty drive:
175 @example
176 qemu -drive if=ide,index=1,media=cdrom
177 @end example
179 You can connect a SCSI disk with unit ID 6 on the bus #0:
180 @example
181 qemu -drive file=file,if=scsi,bus=0,unit=6
182 @end example
184 Instead of @option{-fda}, @option{-fdb}, you can use:
185 @example
186 qemu -drive file=file,index=0,if=floppy
187 qemu -drive file=file,index=1,if=floppy
188 @end example
190 By default, @var{interface} is "ide" and @var{index} is automatically
191 incremented:
192 @example
193 qemu -drive file=a -drive file=b"
194 @end example
195 is interpreted like:
196 @example
197 qemu -hda a -hdb b
198 @end example
199 ETEXI
201 DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock,
202 "-mtdblock file use 'file' as on-board Flash memory image\n")
203 STEXI
205 @item -mtdblock file
206 Use 'file' as on-board Flash memory image.
207 ETEXI
209 DEF("sd", HAS_ARG, QEMU_OPTION_sd,
210 "-sd file use 'file' as SecureDigital card image\n")
211 STEXI
212 @item -sd file
213 Use 'file' as SecureDigital card image.
214 ETEXI
216 DEF("pflash", HAS_ARG, QEMU_OPTION_pflash,
217 "-pflash file use 'file' as a parallel flash image\n")
218 STEXI
219 @item -pflash file
220 Use 'file' as a parallel flash image.
221 ETEXI
223 DEF("boot", HAS_ARG, QEMU_OPTION_boot,
224 "-boot [a|c|d|n] boot on floppy (a), hard disk (c), CD-ROM (d), or network (n)\n")
225 STEXI
226 @item -boot [a|c|d|n]
227 Boot on floppy (a), hard disk (c), CD-ROM (d), or Etherboot (n). Hard disk boot
228 is the default.
229 ETEXI
231 DEF("snapshot", 0, QEMU_OPTION_snapshot,
232 "-snapshot write to temporary files instead of disk image files\n")
233 STEXI
234 @item -snapshot
235 Write to temporary files instead of disk image files. In this case,
236 the raw disk image you use is not written back. You can however force
237 the write back by pressing @key{C-a s} (@pxref{disk_images}).
238 ETEXI
240 DEF("m", HAS_ARG, QEMU_OPTION_m,
241 "-m megs set virtual RAM size to megs MB [default=%d]\n")
242 STEXI
243 @item -m @var{megs}
244 Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally,
245 a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
246 gigabytes respectively.
247 ETEXI
249 DEF("k", HAS_ARG, QEMU_OPTION_k,
250 "-k language use keyboard layout (for example 'fr' for French)\n")
251 STEXI
252 @item -k @var{language}
254 Use keyboard layout @var{language} (for example @code{fr} for
255 French). This option is only needed where it is not easy to get raw PC
256 keycodes (e.g. on Macs, with some X11 servers or with a VNC
257 display). You don't normally need to use it on PC/Linux or PC/Windows
258 hosts.
260 The available layouts are:
261 @example
262 ar de-ch es fo fr-ca hu ja mk no pt-br sv
263 da en-gb et fr fr-ch is lt nl pl ru th
264 de en-us fi fr-be hr it lv nl-be pt sl tr
265 @end example
267 The default is @code{en-us}.
268 ETEXI
271 #ifdef HAS_AUDIO
272 DEF("audio-help", 0, QEMU_OPTION_audio_help,
273 "-audio-help print list of audio drivers and their options\n")
274 #endif
275 STEXI
276 @item -audio-help
278 Will show the audio subsystem help: list of drivers, tunable
279 parameters.
280 ETEXI
282 #ifdef HAS_AUDIO
283 DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw,
284 "-soundhw c1,... enable audio support\n"
285 " and only specified sound cards (comma separated list)\n"
286 " use -soundhw ? to get the list of supported cards\n"
287 " use -soundhw all to enable all of them\n")
288 #endif
289 STEXI
290 @item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
292 Enable audio and selected sound hardware. Use ? to print all
293 available sound hardware.
295 @example
296 qemu -soundhw sb16,adlib disk.img
297 qemu -soundhw es1370 disk.img
298 qemu -soundhw ac97 disk.img
299 qemu -soundhw all disk.img
300 qemu -soundhw ?
301 @end example
303 Note that Linux's i810_audio OSS kernel (for AC97) module might
304 require manually specifying clocking.
306 @example
307 modprobe i810_audio clocking=48000
308 @end example
309 ETEXI
311 STEXI
312 @end table
313 ETEXI
315 DEF("usb", 0, QEMU_OPTION_usb,
316 "-usb enable the USB driver (will be the default soon)\n")
317 STEXI
318 USB options:
319 @table @option
321 @item -usb
322 Enable the USB driver (will be the default soon)
323 ETEXI
325 DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice,
326 "-usbdevice name add the host or guest USB device 'name'\n")
327 STEXI
329 @item -usbdevice @var{devname}
330 Add the USB device @var{devname}. @xref{usb_devices}.
332 @table @code
334 @item mouse
335 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
337 @item tablet
338 Pointer device that uses absolute coordinates (like a touchscreen). This
339 means qemu is able to report the mouse position without having to grab the
340 mouse. Also overrides the PS/2 mouse emulation when activated.
342 @item disk:[format=@var{format}]:file
343 Mass storage device based on file. The optional @var{format} argument
344 will be used rather than detecting the format. Can be used to specifiy
345 format=raw to avoid interpreting an untrusted format header.
347 @item host:bus.addr
348 Pass through the host device identified by bus.addr (Linux only).
350 @item host:vendor_id:product_id
351 Pass through the host device identified by vendor_id:product_id (Linux only).
353 @item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
354 Serial converter to host character device @var{dev}, see @code{-serial} for the
355 available devices.
357 @item braille
358 Braille device. This will use BrlAPI to display the braille output on a real
359 or fake device.
361 @item net:options
362 Network adapter that supports CDC ethernet and RNDIS protocols.
364 @end table
365 ETEXI
367 DEF("name", HAS_ARG, QEMU_OPTION_name,
368 "-name string set the name of the guest\n")
369 STEXI
370 @item -name @var{name}
371 Sets the @var{name} of the guest.
372 This name will be displayed in the SDL window caption.
373 The @var{name} will also be used for the VNC server.
374 ETEXI
376 DEF("uuid", HAS_ARG, QEMU_OPTION_uuid,
377 "-uuid %%08x-%%04x-%%04x-%%04x-%%012x\n"
378 " specify machine UUID\n")
379 STEXI
380 @item -uuid @var{uuid}
381 Set system UUID.
382 ETEXI
384 STEXI
385 @end table
386 ETEXI
388 DEFHEADING()
390 DEFHEADING(Display options:)
392 STEXI
393 @table @option
394 ETEXI
396 DEF("nographic", 0, QEMU_OPTION_nographic,
397 "-nographic disable graphical output and redirect serial I/Os to console\n")
398 STEXI
399 @item -nographic
401 Normally, QEMU uses SDL to display the VGA output. With this option,
402 you can totally disable graphical output so that QEMU is a simple
403 command line application. The emulated serial port is redirected on
404 the console. Therefore, you can still use QEMU to debug a Linux kernel
405 with a serial console.
406 ETEXI
408 #ifdef CONFIG_CURSES
409 DEF("curses", 0, QEMU_OPTION_curses,
410 "-curses use a curses/ncurses interface instead of SDL\n")
411 #endif
412 STEXI
413 @item -curses
415 Normally, QEMU uses SDL to display the VGA output. With this option,
416 QEMU can display the VGA output when in text mode using a
417 curses/ncurses interface. Nothing is displayed in graphical mode.
418 ETEXI
420 #ifdef CONFIG_SDL
421 DEF("no-frame", 0, QEMU_OPTION_no_frame,
422 "-no-frame open SDL window without a frame and window decorations\n")
423 #endif
424 STEXI
425 @item -no-frame
427 Do not use decorations for SDL windows and start them using the whole
428 available screen space. This makes the using QEMU in a dedicated desktop
429 workspace more convenient.
430 ETEXI
432 #ifdef CONFIG_SDL
433 DEF("alt-grab", 0, QEMU_OPTION_alt_grab,
434 "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n")
435 #endif
436 STEXI
437 @item -alt-grab
439 Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt).
440 ETEXI
442 #ifdef CONFIG_SDL
443 DEF("no-quit", 0, QEMU_OPTION_no_quit,
444 "-no-quit disable SDL window close capability\n")
445 #endif
446 STEXI
447 @item -no-quit
449 Disable SDL window close capability.
450 ETEXI
452 #ifdef CONFIG_SDL
453 DEF("sdl", 0, QEMU_OPTION_sdl,
454 "-sdl enable SDL\n")
455 #endif
456 STEXI
457 @item -sdl
459 Enable SDL.
460 ETEXI
462 DEF("portrait", 0, QEMU_OPTION_portrait,
463 "-portrait rotate graphical output 90 deg left (only PXA LCD)\n")
464 STEXI
465 @item -portrait
467 Rotate graphical output 90 deg left (only PXA LCD).
468 ETEXI
470 DEF("vga", HAS_ARG, QEMU_OPTION_vga,
471 "-vga [std|cirrus|vmware|xenfb|none]\n"
472 " select video card type\n")
473 STEXI
474 @item -vga @var{type}
475 Select type of VGA card to emulate. Valid values for @var{type} are
476 @table @code
477 @item cirrus
478 Cirrus Logic GD5446 Video card. All Windows versions starting from
479 Windows 95 should recognize and use this graphic card. For optimal
480 performances, use 16 bit color depth in the guest and the host OS.
481 (This one is the default)
482 @item std
483 Standard VGA card with Bochs VBE extensions. If your guest OS
484 supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
485 to use high resolution modes (>= 1280x1024x16) then you should use
486 this option.
487 @item vmware
488 VMWare SVGA-II compatible adapter. Use it if you have sufficiently
489 recent XFree86/XOrg server or Windows guest with a driver for this
490 card.
491 @item none
492 Disable VGA card.
493 @end table
494 ETEXI
496 DEF("full-screen", 0, QEMU_OPTION_full_screen,
497 "-full-screen start in full screen\n")
498 STEXI
499 @item -full-screen
500 Start in full screen.
501 ETEXI
503 #if defined(TARGET_PPC) || defined(TARGET_SPARC)
504 DEF("g", 1, QEMU_OPTION_g ,
505 "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n")
506 #endif
507 STEXI
508 ETEXI
510 DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
511 "-vnc display start a VNC server on display\n")
512 STEXI
513 @item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
515 Normally, QEMU uses SDL to display the VGA output. With this option,
516 you can have QEMU listen on VNC display @var{display} and redirect the VGA
517 display over the VNC session. It is very useful to enable the usb
518 tablet device when using this option (option @option{-usbdevice
519 tablet}). When using the VNC display, you must use the @option{-k}
520 parameter to set the keyboard layout if you are not using en-us. Valid
521 syntax for the @var{display} is
523 @table @code
525 @item @var{host}:@var{d}
527 TCP connections will only be allowed from @var{host} on display @var{d}.
528 By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
529 be omitted in which case the server will accept connections from any host.
531 @item @code{unix}:@var{path}
533 Connections will be allowed over UNIX domain sockets where @var{path} is the
534 location of a unix socket to listen for connections on.
536 @item none
538 VNC is initialized but not started. The monitor @code{change} command
539 can be used to later start the VNC server.
541 @end table
543 Following the @var{display} value there may be one or more @var{option} flags
544 separated by commas. Valid options are
546 @table @code
548 @item reverse
550 Connect to a listening VNC client via a ``reverse'' connection. The
551 client is specified by the @var{display}. For reverse network
552 connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
553 is a TCP port number, not a display number.
555 @item password
557 Require that password based authentication is used for client connections.
558 The password must be set separately using the @code{change} command in the
559 @ref{pcsys_monitor}
561 @item tls
563 Require that client use TLS when communicating with the VNC server. This
564 uses anonymous TLS credentials so is susceptible to a man-in-the-middle
565 attack. It is recommended that this option be combined with either the
566 @var{x509} or @var{x509verify} options.
568 @item x509=@var{/path/to/certificate/dir}
570 Valid if @option{tls} is specified. Require that x509 credentials are used
571 for negotiating the TLS session. The server will send its x509 certificate
572 to the client. It is recommended that a password be set on the VNC server
573 to provide authentication of the client when this is used. The path following
574 this option specifies where the x509 certificates are to be loaded from.
575 See the @ref{vnc_security} section for details on generating certificates.
577 @item x509verify=@var{/path/to/certificate/dir}
579 Valid if @option{tls} is specified. Require that x509 credentials are used
580 for negotiating the TLS session. The server will send its x509 certificate
581 to the client, and request that the client send its own x509 certificate.
582 The server will validate the client's certificate against the CA certificate,
583 and reject clients when validation fails. If the certificate authority is
584 trusted, this is a sufficient authentication mechanism. You may still wish
585 to set a password on the VNC server as a second authentication layer. The
586 path following this option specifies where the x509 certificates are to
587 be loaded from. See the @ref{vnc_security} section for details on generating
588 certificates.
590 @item sasl
592 Require that the client use SASL to authenticate with the VNC server.
593 The exact choice of authentication method used is controlled from the
594 system / user's SASL configuration file for the 'qemu' service. This
595 is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
596 unprivileged user, an environment variable SASL_CONF_PATH can be used
597 to make it search alternate locations for the service config.
598 While some SASL auth methods can also provide data encryption (eg GSSAPI),
599 it is recommended that SASL always be combined with the 'tls' and
600 'x509' settings to enable use of SSL and server certificates. This
601 ensures a data encryption preventing compromise of authentication
602 credentials. See the @ref{vnc_security} section for details on using
603 SASL authentication.
605 @item acl
607 Turn on access control lists for checking of the x509 client certificate
608 and SASL party. For x509 certs, the ACL check is made against the
609 certificate's distinguished name. This is something that looks like
610 @code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
611 made against the username, which depending on the SASL plugin, may
612 include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
613 When the @option{acl} flag is set, the initial access list will be
614 empty, with a @code{deny} policy. Thus no one will be allowed to
615 use the VNC server until the ACLs have been loaded. This can be
616 achieved using the @code{acl} monitor command.
618 @end table
619 ETEXI
621 STEXI
622 @end table
623 ETEXI
625 DEFHEADING()
627 #ifdef TARGET_I386
628 DEFHEADING(i386 target only:)
629 #endif
630 STEXI
631 @table @option
632 ETEXI
634 #ifdef TARGET_I386
635 DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack,
636 "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n")
637 #endif
638 STEXI
639 @item -win2k-hack
640 Use it when installing Windows 2000 to avoid a disk full bug. After
641 Windows 2000 is installed, you no longer need this option (this option
642 slows down the IDE transfers).
643 ETEXI
645 #ifdef TARGET_I386
646 DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack,
647 "-rtc-td-hack use it to fix time drift in Windows ACPI HAL\n")
648 #endif
649 STEXI
650 @item -rtc-td-hack
651 Use it if you experience time drift problem in Windows with ACPI HAL.
652 This option will try to figure out how many timer interrupts were not
653 processed by the Windows guest and will re-inject them.
654 ETEXI
656 #ifdef TARGET_I386
657 DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk,
658 "-no-fd-bootchk disable boot signature checking for floppy disks\n")
659 #endif
660 STEXI
661 @item -no-fd-bootchk
662 Disable boot signature checking for floppy disks in Bochs BIOS. It may
663 be needed to boot from old floppy disks.
664 ETEXI
666 #ifdef TARGET_I386
667 DEF("no-acpi", 0, QEMU_OPTION_no_acpi,
668 "-no-acpi disable ACPI\n")
669 #endif
670 STEXI
671 @item -no-acpi
672 Disable ACPI (Advanced Configuration and Power Interface) support. Use
673 it if your guest OS complains about ACPI problems (PC target machine
674 only).
675 ETEXI
677 #ifdef TARGET_I386
678 DEF("no-hpet", 0, QEMU_OPTION_no_hpet,
679 "-no-hpet disable HPET\n")
680 #endif
681 STEXI
682 @item -no-hpet
683 Disable HPET support.
684 ETEXI
686 #ifdef TARGET_I386
687 DEF("no-virtio-balloon", 0, QEMU_OPTION_no_virtio_balloon,
688 "-no-virtio-balloon disable virtio balloon device\n")
689 #endif
690 STEXI
691 @item -no-virtio-balloon
692 Disable virtio-balloon device.
693 ETEXI
695 #ifdef TARGET_I386
696 DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable,
697 "-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"
698 " ACPI table description\n")
699 #endif
700 STEXI
701 @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}]...]
702 Add ACPI table with specified header fields and context from specified files.
703 ETEXI
705 #ifdef TARGET_I386
706 DEF("smbios", HAS_ARG, QEMU_OPTION_smbios,
707 "-smbios file=binary\n"
708 " Load SMBIOS entry from binary file\n"
709 "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%%d.%%d]\n"
710 " Specify SMBIOS type 0 fields\n"
711 "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n"
712 " [,uuid=uuid][,sku=str][,family=str]\n"
713 " Specify SMBIOS type 1 fields\n")
714 #endif
715 STEXI
716 @item -smbios file=@var{binary}
717 Load SMBIOS entry from binary file.
719 @item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}]
720 Specify SMBIOS type 0 fields
722 @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}]
723 Specify SMBIOS type 1 fields
724 ETEXI
726 #ifdef TARGET_I386
727 DEFHEADING()
728 #endif
729 STEXI
730 @end table
731 ETEXI
733 DEFHEADING(Network options:)
734 STEXI
735 @table @option
736 ETEXI
738 HXCOMM Legacy slirp options (now moved to -net user):
739 #ifdef CONFIG_SLIRP
740 DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "")
741 DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "")
742 DEF("redir", HAS_ARG, QEMU_OPTION_redir, "")
743 #ifndef _WIN32
744 DEF("smb", HAS_ARG, QEMU_OPTION_smb, "")
745 #endif
746 #endif
748 DEF("net", HAS_ARG, QEMU_OPTION_net,
749 "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n"
750 " create a new Network Interface Card and connect it to VLAN 'n'\n"
751 #ifdef CONFIG_SLIRP
752 "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=y|n]\n"
753 " [,hostname=host][,dhcpstart=addr][,dns=addr][,tftp=dir][,bootfile=f]\n"
754 " [,hostfwd=rule][,guestfwd=rule]"
755 #ifndef _WIN32
756 "[,smb=dir[,smbserver=addr]]\n"
757 #endif
758 " connect the user mode network stack to VLAN 'n', configure its\n"
759 " DHCP server and enabled optional services\n"
760 #endif
761 #ifdef _WIN32
762 "-net tap[,vlan=n][,name=str],ifname=name\n"
763 " connect the host TAP network interface to VLAN 'n'\n"
764 #else
765 "-net tap[,vlan=n][,name=str][,fd=h][,ifname=name][,script=file][,downscript=dfile]"
766 #ifdef TUNSETSNDBUF
767 "[,sndbuf=nbytes]"
768 #endif
769 "\n"
770 " connect the host TAP network interface to VLAN 'n' and use the\n"
771 " network scripts 'file' (default=%s)\n"
772 " and 'dfile' (default=%s);\n"
773 " use '[down]script=no' to disable script execution;\n"
774 " use 'fd=h' to connect to an already opened TAP interface\n"
775 #ifdef TUNSETSNDBUF
776 " use 'sndbuf=nbytes' to limit the size of the send buffer\n"
777 #endif
778 #endif
779 "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n"
780 " connect the vlan 'n' to another VLAN using a socket connection\n"
781 "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port]\n"
782 " connect the vlan 'n' to multicast maddr and port\n"
783 #ifdef CONFIG_VDE
784 "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n"
785 " connect the vlan 'n' to port 'n' of a vde switch running\n"
786 " on host and listening for incoming connections on 'socketpath'.\n"
787 " Use group 'groupname' and mode 'octalmode' to change default\n"
788 " ownership and permissions for communication port.\n"
789 #endif
790 "-net dump[,vlan=n][,file=f][,len=n]\n"
791 " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n"
792 "-net none use it alone to have zero network devices; if no -net option\n"
793 " is provided, the default is '-net nic -net user'\n")
794 STEXI
795 @item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}][,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}]
796 Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
797 = 0 is the default). The NIC is an ne2k_pci by default on the PC
798 target. Optionally, the MAC address can be changed to @var{mac}, the
799 device address set to @var{addr} (PCI cards only),
800 and a @var{name} can be assigned for use in monitor commands.
801 Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
802 that the card should have; this option currently only affects virtio cards; set
803 @var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
804 NIC is created. Qemu can emulate several different models of network card.
805 Valid values for @var{type} are
806 @code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er},
807 @code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
808 @code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
809 Not all devices are supported on all targets. Use -net nic,model=?
810 for a list of available devices for your target.
812 @item -net user[,@var{option}][,@var{option}][,...]
813 Use the user mode network stack which requires no administrator
814 privilege to run. Valid options are:
816 @table @code
817 @item vlan=@var{n}
818 Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default).
820 @item name=@var{name}
821 Assign symbolic name for use in monitor commands.
823 @item net=@var{addr}[/@var{mask}]
824 Set IP network address the guest will see. Optionally specify the netmask,
825 either in the form a.b.c.d or as number of valid top-most bits. Default is
826 10.0.2.0/8.
828 @item host=@var{addr}
829 Specify the guest-visible address of the host. Default is the 2nd IP in the
830 guest network, i.e. x.x.x.2.
832 @item restrict=y|yes|n|no
833 If this options is enabled, the guest will be isolated, i.e. it will not be
834 able to contact the host and no guest IP packets will be routed over the host
835 to the outside. This option does not affect explicitly set forwarding rule.
837 @item hostname=@var{name}
838 Specifies the client hostname reported by the builtin DHCP server.
840 @item dhcpstart=@var{addr}
841 Specify the first of the 16 IPs the built-in DHCP server can assign. Default
842 is the 16th to 31st IP in the guest network, i.e. x.x.x.16 to x.x.x.31.
844 @item dns=@var{addr}
845 Specify the guest-visible address of the virtual nameserver. The address must
846 be different from the host address. Default is the 3rd IP in the guest network,
847 i.e. x.x.x.3.
849 @item tftp=@var{dir}
850 When using the user mode network stack, activate a built-in TFTP
851 server. The files in @var{dir} will be exposed as the root of a TFTP server.
852 The TFTP client on the guest must be configured in binary mode (use the command
853 @code{bin} of the Unix TFTP client).
855 @item bootfile=@var{file}
856 When using the user mode network stack, broadcast @var{file} as the BOOTP
857 filename. In conjunction with @option{tftp}, this can be used to network boot
858 a guest from a local directory.
860 Example (using pxelinux):
861 @example
862 qemu -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
863 @end example
865 @item smb=@var{dir}[,smbserver=@var{addr}]
866 When using the user mode network stack, activate a built-in SMB
867 server so that Windows OSes can access to the host files in @file{@var{dir}}
868 transparently. The IP address of the SMB server can be set to @var{addr}. By
869 default the 4th IP in the guest network is used, i.e. x.x.x.4.
871 In the guest Windows OS, the line:
872 @example
873 10.0.2.4 smbserver
874 @end example
875 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
876 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
878 Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
880 Note that a SAMBA server must be installed on the host OS in
881 @file{/usr/sbin/smbd}. QEMU was tested successfully with smbd versions from
882 Red Hat 9, Fedora Core 3 and OpenSUSE 11.x.
884 @item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
885 Redirect incoming TCP or UDP connections to the host port @var{hostport} to
886 the guest IP address @var{guestaddr} on guest port @var{guestport}. If
887 @var{guestaddr} is not specified, its value is x.x.x.15 (default first address
888 given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
889 be bound to a specific host interface. If no connection type is set, TCP is
890 used. This option can be given multiple times.
892 For example, to redirect host X11 connection from screen 1 to guest
893 screen 0, use the following:
895 @example
896 # on the host
897 qemu -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...]
898 # this host xterm should open in the guest X11 server
899 xterm -display :1
900 @end example
902 To redirect telnet connections from host port 5555 to telnet port on
903 the guest, use the following:
905 @example
906 # on the host
907 qemu -net user,hostfwd=tcp:5555::23 [...]
908 telnet localhost 5555
909 @end example
911 Then when you use on the host @code{telnet localhost 5555}, you
912 connect to the guest telnet server.
914 @item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
915 Forward guest TCP connections to the IP address @var{server} on port @var{port}
916 to the character device @var{dev}. This option can be given multiple times.
918 @end table
920 Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still
921 processed and applied to -net user. Mixing them with the new configuration
922 syntax gives undefined results. Their use for new applications is discouraged
923 as they will be removed from future versions.
925 @item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}]
926 Connect the host TAP network interface @var{name} to VLAN @var{n}, use
927 the network script @var{file} to configure it and the network script
928 @var{dfile} to deconfigure it. If @var{name} is not provided, the OS
929 automatically provides one. @option{fd}=@var{h} can be used to specify
930 the handle of an already opened host TAP interface. The default network
931 configure script is @file{/etc/qemu-ifup} and the default network
932 deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no}
933 or @option{downscript=no} to disable script execution. Example:
935 @example
936 qemu linux.img -net nic -net tap
937 @end example
939 More complicated example (two NICs, each one connected to a TAP device)
940 @example
941 qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
942 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
943 @end example
945 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
947 Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
948 machine using a TCP socket connection. If @option{listen} is
949 specified, QEMU waits for incoming connections on @var{port}
950 (@var{host} is optional). @option{connect} is used to connect to
951 another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
952 specifies an already opened TCP socket.
954 Example:
955 @example
956 # launch a first QEMU instance
957 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
958 -net socket,listen=:1234
959 # connect the VLAN 0 of this instance to the VLAN 0
960 # of the first instance
961 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
962 -net socket,connect=127.0.0.1:1234
963 @end example
965 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}]
967 Create a VLAN @var{n} shared with another QEMU virtual
968 machines using a UDP multicast socket, effectively making a bus for
969 every QEMU with same multicast address @var{maddr} and @var{port}.
970 NOTES:
971 @enumerate
972 @item
973 Several QEMU can be running on different hosts and share same bus (assuming
974 correct multicast setup for these hosts).
975 @item
976 mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
977 @url{http://user-mode-linux.sf.net}.
978 @item
979 Use @option{fd=h} to specify an already opened UDP multicast socket.
980 @end enumerate
982 Example:
983 @example
984 # launch one QEMU instance
985 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
986 -net socket,mcast=230.0.0.1:1234
987 # launch another QEMU instance on same "bus"
988 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
989 -net socket,mcast=230.0.0.1:1234
990 # launch yet another QEMU instance on same "bus"
991 qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
992 -net socket,mcast=230.0.0.1:1234
993 @end example
995 Example (User Mode Linux compat.):
996 @example
997 # launch QEMU instance (note mcast address selected
998 # is UML's default)
999 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1000 -net socket,mcast=239.192.168.1:1102
1001 # launch UML
1002 /path/to/linux ubd0=/path/to/root_fs eth0=mcast
1003 @end example
1005 @item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
1006 Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
1007 listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
1008 and MODE @var{octalmode} to change default ownership and permissions for
1009 communication port. This option is available only if QEMU has been compiled
1010 with vde support enabled.
1012 Example:
1013 @example
1014 # launch vde switch
1015 vde_switch -F -sock /tmp/myswitch
1016 # launch QEMU instance
1017 qemu linux.img -net nic -net vde,sock=/tmp/myswitch
1018 @end example
1020 @item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
1021 Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
1022 At most @var{len} bytes (64k by default) per packet are stored. The file format is
1023 libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
1025 @item -net none
1026 Indicate that no network devices should be configured. It is used to
1027 override the default configuration (@option{-net nic -net user}) which
1028 is activated if no @option{-net} options are provided.
1030 @end table
1031 ETEXI
1033 DEF("bt", HAS_ARG, QEMU_OPTION_bt, \
1034 "\n" \
1035 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \
1036 "-bt hci,host[:id]\n" \
1037 " use host's HCI with the given name\n" \
1038 "-bt hci[,vlan=n]\n" \
1039 " emulate a standard HCI in virtual scatternet 'n'\n" \
1040 "-bt vhci[,vlan=n]\n" \
1041 " add host computer to virtual scatternet 'n' using VHCI\n" \
1042 "-bt device:dev[,vlan=n]\n" \
1043 " emulate a bluetooth device 'dev' in scatternet 'n'\n")
1044 STEXI
1045 Bluetooth(R) options:
1046 @table @option
1048 @item -bt hci[...]
1049 Defines the function of the corresponding Bluetooth HCI. -bt options
1050 are matched with the HCIs present in the chosen machine type. For
1051 example when emulating a machine with only one HCI built into it, only
1052 the first @code{-bt hci[...]} option is valid and defines the HCI's
1053 logic. The Transport Layer is decided by the machine type. Currently
1054 the machines @code{n800} and @code{n810} have one HCI and all other
1055 machines have none.
1057 @anchor{bt-hcis}
1058 The following three types are recognized:
1060 @table @code
1061 @item -bt hci,null
1062 (default) The corresponding Bluetooth HCI assumes no internal logic
1063 and will not respond to any HCI commands or emit events.
1065 @item -bt hci,host[:@var{id}]
1066 (@code{bluez} only) The corresponding HCI passes commands / events
1067 to / from the physical HCI identified by the name @var{id} (default:
1068 @code{hci0}) on the computer running QEMU. Only available on @code{bluez}
1069 capable systems like Linux.
1071 @item -bt hci[,vlan=@var{n}]
1072 Add a virtual, standard HCI that will participate in the Bluetooth
1073 scatternet @var{n} (default @code{0}). Similarly to @option{-net}
1074 VLANs, devices inside a bluetooth network @var{n} can only communicate
1075 with other devices in the same network (scatternet).
1076 @end table
1078 @item -bt vhci[,vlan=@var{n}]
1079 (Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
1080 to the host bluetooth stack instead of to the emulated target. This
1081 allows the host and target machines to participate in a common scatternet
1082 and communicate. Requires the Linux @code{vhci} driver installed. Can
1083 be used as following:
1085 @example
1086 qemu [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
1087 @end example
1089 @item -bt device:@var{dev}[,vlan=@var{n}]
1090 Emulate a bluetooth device @var{dev} and place it in network @var{n}
1091 (default @code{0}). QEMU can only emulate one type of bluetooth devices
1092 currently:
1094 @table @code
1095 @item keyboard
1096 Virtual wireless keyboard implementing the HIDP bluetooth profile.
1097 @end table
1098 @end table
1099 ETEXI
1101 DEFHEADING()
1103 DEFHEADING(Linux/Multiboot boot specific:)
1104 STEXI
1106 When using these options, you can use a given Linux or Multiboot
1107 kernel without installing it in the disk image. It can be useful
1108 for easier testing of various kernels.
1110 @table @option
1111 ETEXI
1113 DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \
1114 "-kernel bzImage use 'bzImage' as kernel image\n")
1115 STEXI
1116 @item -kernel @var{bzImage}
1117 Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel
1118 or in multiboot format.
1119 ETEXI
1121 DEF("append", HAS_ARG, QEMU_OPTION_append, \
1122 "-append cmdline use 'cmdline' as kernel command line\n")
1123 STEXI
1124 @item -append @var{cmdline}
1125 Use @var{cmdline} as kernel command line
1126 ETEXI
1128 DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \
1129 "-initrd file use 'file' as initial ram disk\n")
1130 STEXI
1131 @item -initrd @var{file}
1132 Use @var{file} as initial ram disk.
1134 @item -initrd "@var{file1} arg=foo,@var{file2}"
1136 This syntax is only available with multiboot.
1138 Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the
1139 first module.
1140 ETEXI
1142 STEXI
1143 @end table
1144 ETEXI
1146 DEFHEADING()
1148 DEFHEADING(Debug/Expert options:)
1150 STEXI
1151 @table @option
1152 ETEXI
1154 DEF("serial", HAS_ARG, QEMU_OPTION_serial, \
1155 "-serial dev redirect the serial port to char device 'dev'\n")
1156 STEXI
1157 @item -serial @var{dev}
1158 Redirect the virtual serial port to host character device
1159 @var{dev}. The default device is @code{vc} in graphical mode and
1160 @code{stdio} in non graphical mode.
1162 This option can be used several times to simulate up to 4 serial
1163 ports.
1165 Use @code{-serial none} to disable all serial ports.
1167 Available character devices are:
1168 @table @code
1169 @item vc[:WxH]
1170 Virtual console. Optionally, a width and height can be given in pixel with
1171 @example
1172 vc:800x600
1173 @end example
1174 It is also possible to specify width or height in characters:
1175 @example
1176 vc:80Cx24C
1177 @end example
1178 @item pty
1179 [Linux only] Pseudo TTY (a new PTY is automatically allocated)
1180 @item none
1181 No device is allocated.
1182 @item null
1183 void device
1184 @item /dev/XXX
1185 [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
1186 parameters are set according to the emulated ones.
1187 @item /dev/parport@var{N}
1188 [Linux only, parallel port only] Use host parallel port
1189 @var{N}. Currently SPP and EPP parallel port features can be used.
1190 @item file:@var{filename}
1191 Write output to @var{filename}. No character can be read.
1192 @item stdio
1193 [Unix only] standard input/output
1194 @item pipe:@var{filename}
1195 name pipe @var{filename}
1196 @item COM@var{n}
1197 [Windows only] Use host serial port @var{n}
1198 @item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
1199 This implements UDP Net Console.
1200 When @var{remote_host} or @var{src_ip} are not specified
1201 they default to @code{0.0.0.0}.
1202 When not using a specified @var{src_port} a random port is automatically chosen.
1203 @item msmouse
1204 Three button serial mouse. Configure the guest to use Microsoft protocol.
1206 If you just want a simple readonly console you can use @code{netcat} or
1207 @code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
1208 @code{nc -u -l -p 4555}. Any time qemu writes something to that port it
1209 will appear in the netconsole session.
1211 If you plan to send characters back via netconsole or you want to stop
1212 and start qemu a lot of times, you should have qemu use the same
1213 source port each time by using something like @code{-serial
1214 udp::4555@@:4556} to qemu. Another approach is to use a patched
1215 version of netcat which can listen to a TCP port and send and receive
1216 characters via udp. If you have a patched version of netcat which
1217 activates telnet remote echo and single char transfer, then you can
1218 use the following options to step up a netcat redirector to allow
1219 telnet on port 5555 to access the qemu port.
1220 @table @code
1221 @item Qemu Options:
1222 -serial udp::4555@@:4556
1223 @item netcat options:
1224 -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
1225 @item telnet options:
1226 localhost 5555
1227 @end table
1229 @item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay]
1230 The TCP Net Console has two modes of operation. It can send the serial
1231 I/O to a location or wait for a connection from a location. By default
1232 the TCP Net Console is sent to @var{host} at the @var{port}. If you use
1233 the @var{server} option QEMU will wait for a client socket application
1234 to connect to the port before continuing, unless the @code{nowait}
1235 option was specified. The @code{nodelay} option disables the Nagle buffering
1236 algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only
1237 one TCP connection at a time is accepted. You can use @code{telnet} to
1238 connect to the corresponding character device.
1239 @table @code
1240 @item Example to send tcp console to 192.168.0.2 port 4444
1241 -serial tcp:192.168.0.2:4444
1242 @item Example to listen and wait on port 4444 for connection
1243 -serial tcp::4444,server
1244 @item Example to not wait and listen on ip 192.168.0.100 port 4444
1245 -serial tcp:192.168.0.100:4444,server,nowait
1246 @end table
1248 @item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
1249 The telnet protocol is used instead of raw tcp sockets. The options
1250 work the same as if you had specified @code{-serial tcp}. The
1251 difference is that the port acts like a telnet server or client using
1252 telnet option negotiation. This will also allow you to send the
1253 MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
1254 sequence. Typically in unix telnet you do it with Control-] and then
1255 type "send break" followed by pressing the enter key.
1257 @item unix:@var{path}[,server][,nowait]
1258 A unix domain socket is used instead of a tcp socket. The option works the
1259 same as if you had specified @code{-serial tcp} except the unix domain socket
1260 @var{path} is used for connections.
1262 @item mon:@var{dev_string}
1263 This is a special option to allow the monitor to be multiplexed onto
1264 another serial port. The monitor is accessed with key sequence of
1265 @key{Control-a} and then pressing @key{c}. See monitor access
1266 @ref{pcsys_keys} in the -nographic section for more keys.
1267 @var{dev_string} should be any one of the serial devices specified
1268 above. An example to multiplex the monitor onto a telnet server
1269 listening on port 4444 would be:
1270 @table @code
1271 @item -serial mon:telnet::4444,server,nowait
1272 @end table
1274 @item braille
1275 Braille device. This will use BrlAPI to display the braille output on a real
1276 or fake device.
1278 @end table
1279 ETEXI
1281 DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \
1282 "-parallel dev redirect the parallel port to char device 'dev'\n")
1283 STEXI
1284 @item -parallel @var{dev}
1285 Redirect the virtual parallel port to host device @var{dev} (same
1286 devices as the serial port). On Linux hosts, @file{/dev/parportN} can
1287 be used to use hardware devices connected on the corresponding host
1288 parallel port.
1290 This option can be used several times to simulate up to 3 parallel
1291 ports.
1293 Use @code{-parallel none} to disable all parallel ports.
1294 ETEXI
1296 DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \
1297 "-monitor dev redirect the monitor to char device 'dev'\n")
1298 STEXI
1299 @item -monitor @var{dev}
1300 Redirect the monitor to host device @var{dev} (same devices as the
1301 serial port).
1302 The default device is @code{vc} in graphical mode and @code{stdio} in
1303 non graphical mode.
1304 ETEXI
1306 DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \
1307 "-pidfile file write PID to 'file'\n")
1308 STEXI
1309 @item -pidfile @var{file}
1310 Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
1311 from a script.
1312 ETEXI
1314 DEF("singlestep", 0, QEMU_OPTION_singlestep, \
1315 "-singlestep always run in singlestep mode\n")
1316 STEXI
1317 @item -singlestep
1318 Run the emulation in single step mode.
1319 ETEXI
1321 DEF("S", 0, QEMU_OPTION_S, \
1322 "-S freeze CPU at startup (use 'c' to start execution)\n")
1323 STEXI
1324 @item -S
1325 Do not start CPU at startup (you must type 'c' in the monitor).
1326 ETEXI
1328 DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \
1329 "-gdb dev wait for gdb connection on 'dev'\n")
1330 STEXI
1331 @item -gdb @var{dev}
1332 Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical
1333 connections will likely be TCP-based, but also UDP, pseudo TTY, or even
1334 stdio are reasonable use case. The latter is allowing to start qemu from
1335 within gdb and establish the connection via a pipe:
1336 @example
1337 (gdb) target remote | exec qemu -gdb stdio ...
1338 @end example
1339 ETEXI
1341 DEF("s", 0, QEMU_OPTION_s, \
1342 "-s shorthand for -gdb tcp::%s\n")
1343 STEXI
1344 @item -s
1345 Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
1346 (@pxref{gdb_usage}).
1347 ETEXI
1349 DEF("d", HAS_ARG, QEMU_OPTION_d, \
1350 "-d item1,... output log to %s (use -d ? for a list of log items)\n")
1351 STEXI
1352 @item -d
1353 Output log in /tmp/qemu.log
1354 ETEXI
1356 DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \
1357 "-hdachs c,h,s[,t]\n" \
1358 " force hard disk 0 physical geometry and the optional BIOS\n" \
1359 " translation (t=none or lba) (usually qemu can guess them)\n")
1360 STEXI
1361 @item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
1362 Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
1363 @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
1364 translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
1365 all those parameters. This option is useful for old MS-DOS disk
1366 images.
1367 ETEXI
1369 DEF("L", HAS_ARG, QEMU_OPTION_L, \
1370 "-L path set the directory for the BIOS, VGA BIOS and keymaps\n")
1371 STEXI
1372 @item -L @var{path}
1373 Set the directory for the BIOS, VGA BIOS and keymaps.
1374 ETEXI
1376 DEF("bios", HAS_ARG, QEMU_OPTION_bios, \
1377 "-bios file set the filename for the BIOS\n")
1378 STEXI
1379 @item -bios @var{file}
1380 Set the filename for the BIOS.
1381 ETEXI
1383 #ifdef CONFIG_KQEMU
1384 DEF("kernel-kqemu", 0, QEMU_OPTION_kernel_kqemu, \
1385 "-kernel-kqemu enable KQEMU full virtualization (default is user mode only)\n")
1386 #endif
1387 STEXI
1388 @item -kernel-kqemu
1389 Enable KQEMU full virtualization (default is user mode only).
1390 ETEXI
1392 #ifdef CONFIG_KQEMU
1393 DEF("no-kqemu", 0, QEMU_OPTION_no_kqemu, \
1394 "-no-kqemu disable KQEMU kernel module usage\n")
1395 #endif
1396 STEXI
1397 @item -no-kqemu
1398 Disable KQEMU kernel module usage. KQEMU options are only available if
1399 KQEMU support is enabled when compiling.
1400 ETEXI
1402 #ifdef CONFIG_KVM
1403 DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \
1404 "-enable-kvm enable KVM full virtualization support\n")
1405 #endif
1406 STEXI
1407 @item -enable-kvm
1408 Enable KVM full virtualization support. This option is only available
1409 if KVM support is enabled when compiling.
1410 ETEXI
1412 #ifdef CONFIG_XEN
1413 DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid,
1414 "-xen-domid id specify xen guest domain id\n")
1415 DEF("xen-create", 0, QEMU_OPTION_xen_create,
1416 "-xen-create create domain using xen hypercalls, bypassing xend\n"
1417 " warning: should not be used when xend is in use\n")
1418 DEF("xen-attach", 0, QEMU_OPTION_xen_attach,
1419 "-xen-attach attach to existing xen domain\n"
1420 " xend will use this when starting qemu\n")
1421 #endif
1423 DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \
1424 "-no-reboot exit instead of rebooting\n")
1425 STEXI
1426 @item -no-reboot
1427 Exit instead of rebooting.
1428 ETEXI
1430 DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \
1431 "-no-shutdown stop before shutdown\n")
1432 STEXI
1433 @item -no-shutdown
1434 Don't exit QEMU on guest shutdown, but instead only stop the emulation.
1435 This allows for instance switching to monitor to commit changes to the
1436 disk image.
1437 ETEXI
1439 DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \
1440 "-loadvm [tag|id]\n" \
1441 " start right away with a saved state (loadvm in monitor)\n")
1442 STEXI
1443 @item -loadvm @var{file}
1444 Start right away with a saved state (@code{loadvm} in monitor)
1445 ETEXI
1447 #ifndef _WIN32
1448 DEF("daemonize", 0, QEMU_OPTION_daemonize, \
1449 "-daemonize daemonize QEMU after initializing\n")
1450 #endif
1451 STEXI
1452 @item -daemonize
1453 Daemonize the QEMU process after initialization. QEMU will not detach from
1454 standard IO until it is ready to receive connections on any of its devices.
1455 This option is a useful way for external programs to launch QEMU without having
1456 to cope with initialization race conditions.
1457 ETEXI
1459 DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \
1460 "-option-rom rom load a file, rom, into the option ROM space\n")
1461 STEXI
1462 @item -option-rom @var{file}
1463 Load the contents of @var{file} as an option ROM.
1464 This option is useful to load things like EtherBoot.
1465 ETEXI
1467 DEF("clock", HAS_ARG, QEMU_OPTION_clock, \
1468 "-clock force the use of the given methods for timer alarm.\n" \
1469 " To see what timers are available use -clock ?\n")
1470 STEXI
1471 @item -clock @var{method}
1472 Force the use of the given methods for timer alarm. To see what timers
1473 are available use -clock ?.
1474 ETEXI
1476 DEF("localtime", 0, QEMU_OPTION_localtime, \
1477 "-localtime set the real time clock to local time [default=utc]\n")
1478 STEXI
1479 @item -localtime
1480 Set the real time clock to local time (the default is to UTC
1481 time). This option is needed to have correct date in MS-DOS or
1482 Windows.
1483 ETEXI
1485 DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, \
1486 "-startdate select initial date of the clock\n")
1487 STEXI
1489 @item -startdate @var{date}
1490 Set the initial date of the real time clock. Valid formats for
1491 @var{date} are: @code{now} or @code{2006-06-17T16:01:21} or
1492 @code{2006-06-17}. The default value is @code{now}.
1493 ETEXI
1495 DEF("icount", HAS_ARG, QEMU_OPTION_icount, \
1496 "-icount [N|auto]\n" \
1497 " enable virtual instruction counter with 2^N clock ticks per\n" \
1498 " instruction\n")
1499 STEXI
1500 @item -icount [N|auto]
1501 Enable virtual instruction counter. The virtual cpu will execute one
1502 instruction every 2^N ns of virtual time. If @code{auto} is specified
1503 then the virtual cpu speed will be automatically adjusted to keep virtual
1504 time within a few seconds of real time.
1506 Note that while this option can give deterministic behavior, it does not
1507 provide cycle accurate emulation. Modern CPUs contain superscalar out of
1508 order cores with complex cache hierarchies. The number of instructions
1509 executed often has little or no correlation with actual performance.
1510 ETEXI
1512 DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \
1513 "-watchdog i6300esb|ib700\n" \
1514 " enable virtual hardware watchdog [default=none]\n")
1515 STEXI
1516 @item -watchdog @var{model}
1517 Create a virtual hardware watchdog device. Once enabled (by a guest
1518 action), the watchdog must be periodically polled by an agent inside
1519 the guest or else the guest will be restarted.
1521 The @var{model} is the model of hardware watchdog to emulate. Choices
1522 for model are: @code{ib700} (iBASE 700) which is a very simple ISA
1523 watchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O
1524 controller hub) which is a much more featureful PCI-based dual-timer
1525 watchdog. Choose a model for which your guest has drivers.
1527 Use @code{-watchdog ?} to list available hardware models. Only one
1528 watchdog can be enabled for a guest.
1529 ETEXI
1531 DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \
1532 "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \
1533 " action when watchdog fires [default=reset]\n")
1534 STEXI
1535 @item -watchdog-action @var{action}
1537 The @var{action} controls what QEMU will do when the watchdog timer
1538 expires.
1539 The default is
1540 @code{reset} (forcefully reset the guest).
1541 Other possible actions are:
1542 @code{shutdown} (attempt to gracefully shutdown the guest),
1543 @code{poweroff} (forcefully poweroff the guest),
1544 @code{pause} (pause the guest),
1545 @code{debug} (print a debug message and continue), or
1546 @code{none} (do nothing).
1548 Note that the @code{shutdown} action requires that the guest responds
1549 to ACPI signals, which it may not be able to do in the sort of
1550 situations where the watchdog would have expired, and thus
1551 @code{-watchdog-action shutdown} is not recommended for production use.
1553 Examples:
1555 @table @code
1556 @item -watchdog i6300esb -watchdog-action pause
1557 @item -watchdog ib700
1558 @end table
1559 ETEXI
1561 DEF("echr", HAS_ARG, QEMU_OPTION_echr, \
1562 "-echr chr set terminal escape character instead of ctrl-a\n")
1563 STEXI
1565 @item -echr numeric_ascii_value
1566 Change the escape character used for switching to the monitor when using
1567 monitor and serial sharing. The default is @code{0x01} when using the
1568 @code{-nographic} option. @code{0x01} is equal to pressing
1569 @code{Control-a}. You can select a different character from the ascii
1570 control keys where 1 through 26 map to Control-a through Control-z. For
1571 instance you could use the either of the following to change the escape
1572 character to Control-t.
1573 @table @code
1574 @item -echr 0x14
1575 @item -echr 20
1576 @end table
1577 ETEXI
1579 DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \
1580 "-virtioconsole c\n" \
1581 " set virtio console\n")
1582 STEXI
1583 @item -virtioconsole @var{c}
1584 Set virtio console.
1585 ETEXI
1587 DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \
1588 "-show-cursor show cursor\n")
1589 STEXI
1590 ETEXI
1592 DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \
1593 "-tb-size n set TB size\n")
1594 STEXI
1595 ETEXI
1597 DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \
1598 "-incoming p prepare for incoming migration, listen on port p\n")
1599 STEXI
1600 ETEXI
1602 #ifndef _WIN32
1603 DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \
1604 "-chroot dir Chroot to dir just before starting the VM.\n")
1605 #endif
1606 STEXI
1607 @item -chroot dir
1608 Immediately before starting guest execution, chroot to the specified
1609 directory. Especially useful in combination with -runas.
1610 ETEXI
1612 #ifndef _WIN32
1613 DEF("runas", HAS_ARG, QEMU_OPTION_runas, \
1614 "-runas user Change to user id user just before starting the VM.\n")
1615 #endif
1616 STEXI
1617 @item -runas user
1618 Immediately before starting guest execution, drop root privileges, switching
1619 to the specified user.
1620 ETEXI
1622 STEXI
1623 @end table
1624 ETEXI
1626 #if defined(TARGET_SPARC) || defined(TARGET_PPC)
1627 DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env,
1628 "-prom-env variable=value\n"
1629 " set OpenBIOS nvram variables\n")
1630 #endif
1631 #if defined(TARGET_ARM) || defined(TARGET_M68K)
1632 DEF("semihosting", 0, QEMU_OPTION_semihosting,
1633 "-semihosting semihosting mode\n")
1634 #endif
1635 #if defined(TARGET_ARM)
1636 DEF("old-param", 0, QEMU_OPTION_old_param,
1637 "-old-param old param mode\n")
1638 #endif