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