blob: e754ba116b04283ba446acee40363738f08bfd66 [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
Blue Swirlad960902010-03-29 19:23:52 +00004HXCOMM DEF(option, HAS_ARG/0, opt_enum, opt_help, arch_mask) is used to
5HXCOMM construct option structures, enums and help message for specified
6HXCOMM architectures.
blueswir15824d652009-03-28 06:44:27 +00007HXCOMM HXCOMM can be used for comments, discarded from both texi and C
8
9DEFHEADING(Standard options:)
10STEXI
11@table @option
12ETEXI
13
14DEF("help", 0, QEMU_OPTION_h,
Blue Swirlad960902010-03-29 19:23:52 +000015 "-h or -help display this help and exit\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +000016STEXI
17@item -h
Stefan Weil6616b2a2010-02-05 23:52:05 +010018@findex -h
blueswir15824d652009-03-28 06:44:27 +000019Display help and exit
20ETEXI
21
pbrook9bd7e6d2009-04-07 22:58:45 +000022DEF("version", 0, QEMU_OPTION_version,
Blue Swirlad960902010-03-29 19:23:52 +000023 "-version display version information and exit\n", QEMU_ARCH_ALL)
pbrook9bd7e6d2009-04-07 22:58:45 +000024STEXI
25@item -version
Stefan Weil6616b2a2010-02-05 23:52:05 +010026@findex -version
pbrook9bd7e6d2009-04-07 22:58:45 +000027Display version information and exit
28ETEXI
29
blueswir15824d652009-03-28 06:44:27 +000030DEF("M", HAS_ARG, QEMU_OPTION_M,
Blue Swirlad960902010-03-29 19:23:52 +000031 "-M machine select emulated machine (-M ? for list)\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +000032STEXI
33@item -M @var{machine}
Stefan Weil6616b2a2010-02-05 23:52:05 +010034@findex -M
blueswir15824d652009-03-28 06:44:27 +000035Select the emulated @var{machine} (@code{-M ?} for list)
36ETEXI
37
38DEF("cpu", HAS_ARG, QEMU_OPTION_cpu,
Blue Swirlad960902010-03-29 19:23:52 +000039 "-cpu cpu select CPU (-cpu ? for list)\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +000040STEXI
41@item -cpu @var{model}
Stefan Weil6616b2a2010-02-05 23:52:05 +010042@findex -cpu
blueswir15824d652009-03-28 06:44:27 +000043Select CPU model (-cpu ? for list and additional feature selection)
44ETEXI
45
46DEF("smp", HAS_ARG, QEMU_OPTION_smp,
Andre Przywara58a04db2009-08-28 10:49:57 +020047 "-smp n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n"
Jes Sorensen6be68d72009-07-23 17:03:42 +020048 " set the number of CPUs to 'n' [default=1]\n"
49 " maxcpus= maximum number of total cpus, including\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -070050 " offline CPUs for hotplug, etc\n"
Andre Przywara58a04db2009-08-28 10:49:57 +020051 " cores= number of CPU cores on one socket\n"
52 " threads= number of threads on one CPU core\n"
Blue Swirlad960902010-03-29 19:23:52 +000053 " sockets= number of discrete sockets in the system\n",
54 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +000055STEXI
Andre Przywara58a04db2009-08-28 10:49:57 +020056@item -smp @var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}]
Stefan Weil6616b2a2010-02-05 23:52:05 +010057@findex -smp
blueswir15824d652009-03-28 06:44:27 +000058Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
59CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs
60to 4.
Andre Przywara58a04db2009-08-28 10:49:57 +020061For the PC target, the number of @var{cores} per socket, the number
62of @var{threads} per cores and the total number of @var{sockets} can be
63specified. Missing values will be computed. If any on the three values is
64given, the total number of CPUs @var{n} can be omitted. @var{maxcpus}
65specifies the maximum number of hotpluggable CPUs.
blueswir15824d652009-03-28 06:44:27 +000066ETEXI
67
aliguori268a3622009-04-21 22:30:27 +000068DEF("numa", HAS_ARG, QEMU_OPTION_numa,
Blue Swirlad960902010-03-29 19:23:52 +000069 "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL)
aliguori268a3622009-04-21 22:30:27 +000070STEXI
71@item -numa @var{opts}
Stefan Weil6616b2a2010-02-05 23:52:05 +010072@findex -numa
aliguori268a3622009-04-21 22:30:27 +000073Simulate a multi node NUMA system. If mem and cpus are omitted, resources
74are split equally.
75ETEXI
76
blueswir15824d652009-03-28 06:44:27 +000077DEF("fda", HAS_ARG, QEMU_OPTION_fda,
Blue Swirlad960902010-03-29 19:23:52 +000078 "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL)
79DEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +000080STEXI
81@item -fda @var{file}
82@item -fdb @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +010083@findex -fda
84@findex -fdb
blueswir15824d652009-03-28 06:44:27 +000085Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can
86use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}).
87ETEXI
88
89DEF("hda", HAS_ARG, QEMU_OPTION_hda,
Blue Swirlad960902010-03-29 19:23:52 +000090 "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL)
91DEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +000092DEF("hdc", HAS_ARG, QEMU_OPTION_hdc,
Blue Swirlad960902010-03-29 19:23:52 +000093 "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL)
94DEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +000095STEXI
96@item -hda @var{file}
97@item -hdb @var{file}
98@item -hdc @var{file}
99@item -hdd @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100100@findex -hda
101@findex -hdb
102@findex -hdc
103@findex -hdd
blueswir15824d652009-03-28 06:44:27 +0000104Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
105ETEXI
106
107DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom,
Blue Swirlad960902010-03-29 19:23:52 +0000108 "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n",
109 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000110STEXI
111@item -cdrom @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100112@findex -cdrom
blueswir15824d652009-03-28 06:44:27 +0000113Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and
114@option{-cdrom} at the same time). You can use the host CD-ROM by
115using @file{/dev/cdrom} as filename (@pxref{host_drives}).
116ETEXI
117
118DEF("drive", HAS_ARG, QEMU_OPTION_drive,
119 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n"
120 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n"
121 " [,cache=writethrough|writeback|none][,format=f][,serial=s]\n"
Naphtali Sprei3f3ed592010-01-17 16:48:14 +0200122 " [,addr=A][,id=name][,aio=threads|native][,readonly=on|off]\n"
Blue Swirlad960902010-03-29 19:23:52 +0000123 " use 'file' as a drive image\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000124STEXI
125@item -drive @var{option}[,@var{option}[,@var{option}[,...]]]
Stefan Weil6616b2a2010-02-05 23:52:05 +0100126@findex -drive
blueswir15824d652009-03-28 06:44:27 +0000127
128Define a new drive. Valid options are:
129
Kevin Wolfb3f046c2009-10-09 10:58:35 +0200130@table @option
blueswir15824d652009-03-28 06:44:27 +0000131@item file=@var{file}
132This option defines which disk image (@pxref{disk_images}) to use with
133this drive. If the filename contains comma, you must double it
134(for instance, "file=my,,file" to use file "my,file").
135@item if=@var{interface}
136This option defines on which type on interface the drive is connected.
137Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio.
138@item bus=@var{bus},unit=@var{unit}
139These options define where is connected the drive by defining the bus number and
140the unit id.
141@item index=@var{index}
142This option defines where is connected the drive by using an index in the list
143of available connectors of a given interface type.
144@item media=@var{media}
145This option defines the type of the media: disk or cdrom.
146@item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}]
147These options have the same definition as they have in @option{-hdachs}.
148@item snapshot=@var{snapshot}
149@var{snapshot} is "on" or "off" and allows to enable snapshot for given drive (see @option{-snapshot}).
150@item cache=@var{cache}
151@var{cache} is "none", "writeback", or "writethrough" and controls how the host cache is used to access block data.
Christoph Hellwig5c6c3a62009-08-20 16:58:35 +0200152@item aio=@var{aio}
153@var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO.
blueswir15824d652009-03-28 06:44:27 +0000154@item format=@var{format}
155Specify which disk @var{format} will be used rather than detecting
156the format. Can be used to specifiy format=raw to avoid interpreting
157an untrusted format header.
158@item serial=@var{serial}
159This option specifies the serial number to assign to the device.
Markus Armbrusterc2cc47a2009-06-18 15:14:10 +0200160@item addr=@var{addr}
161Specify the controller's PCI address (if=virtio only).
blueswir15824d652009-03-28 06:44:27 +0000162@end table
163
164By default, writethrough caching is used for all block device. This means that
165the host page cache will be used to read and write data but write notification
166will be sent to the guest only when the data has been reported as written by
167the storage subsystem.
168
169Writeback caching will report data writes as completed as soon as the data is
170present in the host page cache. This is safe as long as you trust your host.
171If your host crashes or loses power, then the guest may experience data
172corruption. When using the @option{-snapshot} option, writeback caching is
173used by default.
174
Aurelien Jarnoc304d312009-05-03 23:29:14 +0200175The host page cache can be avoided entirely with @option{cache=none}. This will
blueswir15824d652009-03-28 06:44:27 +0000176attempt to do disk IO directly to the guests memory. QEMU may still perform
177an internal copy of the data.
178
179Some block drivers perform badly with @option{cache=writethrough}, most notably,
180qcow2. If performance is more important than correctness,
Kevin Wolf0aa217e2009-06-30 13:06:04 +0200181@option{cache=writeback} should be used with qcow2.
blueswir15824d652009-03-28 06:44:27 +0000182
183Instead of @option{-cdrom} you can use:
184@example
185qemu -drive file=file,index=2,media=cdrom
186@end example
187
188Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
189use:
190@example
191qemu -drive file=file,index=0,media=disk
192qemu -drive file=file,index=1,media=disk
193qemu -drive file=file,index=2,media=disk
194qemu -drive file=file,index=3,media=disk
195@end example
196
197You can connect a CDROM to the slave of ide0:
198@example
199qemu -drive file=file,if=ide,index=1,media=cdrom
200@end example
201
202If you don't specify the "file=" argument, you define an empty drive:
203@example
204qemu -drive if=ide,index=1,media=cdrom
205@end example
206
207You can connect a SCSI disk with unit ID 6 on the bus #0:
208@example
209qemu -drive file=file,if=scsi,bus=0,unit=6
210@end example
211
212Instead of @option{-fda}, @option{-fdb}, you can use:
213@example
214qemu -drive file=file,index=0,if=floppy
215qemu -drive file=file,index=1,if=floppy
216@end example
217
218By default, @var{interface} is "ide" and @var{index} is automatically
219incremented:
220@example
221qemu -drive file=a -drive file=b"
222@end example
223is interpreted like:
224@example
225qemu -hda a -hdb b
226@end example
227ETEXI
228
Stefan Weil6616b2a2010-02-05 23:52:05 +0100229DEF("set", HAS_ARG, QEMU_OPTION_set,
230 "-set group.id.arg=value\n"
231 " set <arg> parameter for item <id> of type <group>\n"
Blue Swirlad960902010-03-29 19:23:52 +0000232 " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL)
Stefan Weil6616b2a2010-02-05 23:52:05 +0100233STEXI
234@item -set
235@findex -set
236TODO
237ETEXI
238
239DEF("global", HAS_ARG, QEMU_OPTION_global,
240 "-global driver.property=value\n"
Blue Swirlad960902010-03-29 19:23:52 +0000241 " set a global default for a driver property\n",
242 QEMU_ARCH_ALL)
Stefan Weil6616b2a2010-02-05 23:52:05 +0100243STEXI
244@item -global
245@findex -global
246TODO
247ETEXI
248
blueswir15824d652009-03-28 06:44:27 +0000249DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock,
Blue Swirlad960902010-03-29 19:23:52 +0000250 "-mtdblock file use 'file' as on-board Flash memory image\n",
251 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000252STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +0200253@item -mtdblock @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100254@findex -mtdblock
Kevin Wolf4e257e52009-10-09 10:58:36 +0200255Use @var{file} as on-board Flash memory image.
blueswir15824d652009-03-28 06:44:27 +0000256ETEXI
257
258DEF("sd", HAS_ARG, QEMU_OPTION_sd,
Blue Swirlad960902010-03-29 19:23:52 +0000259 "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000260STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +0200261@item -sd @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100262@findex -sd
Kevin Wolf4e257e52009-10-09 10:58:36 +0200263Use @var{file} as SecureDigital card image.
blueswir15824d652009-03-28 06:44:27 +0000264ETEXI
265
266DEF("pflash", HAS_ARG, QEMU_OPTION_pflash,
Blue Swirlad960902010-03-29 19:23:52 +0000267 "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000268STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +0200269@item -pflash @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100270@findex -pflash
Kevin Wolf4e257e52009-10-09 10:58:36 +0200271Use @var{file} as a parallel flash image.
blueswir15824d652009-03-28 06:44:27 +0000272ETEXI
273
274DEF("boot", HAS_ARG, QEMU_OPTION_boot,
Jan Kiszka2221dde2009-07-02 00:19:02 +0200275 "-boot [order=drives][,once=drives][,menu=on|off]\n"
Blue Swirlad960902010-03-29 19:23:52 +0000276 " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n",
277 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000278STEXI
Jan Kiszka2221dde2009-07-02 00:19:02 +0200279@item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off]
Stefan Weil6616b2a2010-02-05 23:52:05 +0100280@findex -boot
Jan Kiszka2221dde2009-07-02 00:19:02 +0200281Specify boot order @var{drives} as a string of drive letters. Valid
282drive letters depend on the target achitecture. The x86 PC uses: a, b
283(floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot
284from network adapter 1-4), hard disk boot is the default. To apply a
285particular boot order only on the first startup, specify it via
286@option{once}.
287
288Interactive boot menus/prompts can be enabled via @option{menu=on} as far
289as firmware/BIOS supports them. The default is non-interactive boot.
290
291@example
292# try to boot from network first, then from hard disk
293qemu -boot order=nc
294# boot from CD-ROM first, switch back to default order after reboot
295qemu -boot once=d
296@end example
297
298Note: The legacy format '-boot @var{drives}' is still supported but its
299use is discouraged as it may be removed from future versions.
blueswir15824d652009-03-28 06:44:27 +0000300ETEXI
301
302DEF("snapshot", 0, QEMU_OPTION_snapshot,
Blue Swirlad960902010-03-29 19:23:52 +0000303 "-snapshot write to temporary files instead of disk image files\n",
304 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000305STEXI
306@item -snapshot
Stefan Weil6616b2a2010-02-05 23:52:05 +0100307@findex -snapshot
blueswir15824d652009-03-28 06:44:27 +0000308Write to temporary files instead of disk image files. In this case,
309the raw disk image you use is not written back. You can however force
310the write back by pressing @key{C-a s} (@pxref{disk_images}).
311ETEXI
312
313DEF("m", HAS_ARG, QEMU_OPTION_m,
Paolo Bonzinibec7c2d2010-02-04 16:49:58 +0100314 "-m megs set virtual RAM size to megs MB [default="
Blue Swirlad960902010-03-29 19:23:52 +0000315 stringify(DEFAULT_RAM_SIZE) "]\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000316STEXI
317@item -m @var{megs}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100318@findex -m
blueswir15824d652009-03-28 06:44:27 +0000319Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally,
320a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
321gigabytes respectively.
322ETEXI
323
Marcelo Tosattic9027602010-03-01 20:25:08 -0300324DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath,
Blue Swirlad960902010-03-29 19:23:52 +0000325 "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL)
Marcelo Tosattic9027602010-03-01 20:25:08 -0300326STEXI
327@item -mem-path @var{path}
328Allocate guest RAM from a temporarily created file in @var{path}.
329ETEXI
330
331#ifdef MAP_POPULATE
332DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc,
Blue Swirlad960902010-03-29 19:23:52 +0000333 "-mem-prealloc preallocate guest memory (use with -mem-path)\n",
334 QEMU_ARCH_ALL)
Marcelo Tosattic9027602010-03-01 20:25:08 -0300335STEXI
336@item -mem-prealloc
337Preallocate memory when using -mem-path.
338ETEXI
339#endif
340
blueswir15824d652009-03-28 06:44:27 +0000341DEF("k", HAS_ARG, QEMU_OPTION_k,
Blue Swirlad960902010-03-29 19:23:52 +0000342 "-k language use keyboard layout (for example 'fr' for French)\n",
343 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000344STEXI
345@item -k @var{language}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100346@findex -k
blueswir15824d652009-03-28 06:44:27 +0000347Use keyboard layout @var{language} (for example @code{fr} for
348French). This option is only needed where it is not easy to get raw PC
349keycodes (e.g. on Macs, with some X11 servers or with a VNC
350display). You don't normally need to use it on PC/Linux or PC/Windows
351hosts.
352
353The available layouts are:
354@example
355ar de-ch es fo fr-ca hu ja mk no pt-br sv
356da en-gb et fr fr-ch is lt nl pl ru th
357de en-us fi fr-be hr it lv nl-be pt sl tr
358@end example
359
360The default is @code{en-us}.
361ETEXI
362
363
blueswir15824d652009-03-28 06:44:27 +0000364DEF("audio-help", 0, QEMU_OPTION_audio_help,
Blue Swirlad960902010-03-29 19:23:52 +0000365 "-audio-help print list of audio drivers and their options\n",
366 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000367STEXI
368@item -audio-help
Stefan Weil6616b2a2010-02-05 23:52:05 +0100369@findex -audio-help
blueswir15824d652009-03-28 06:44:27 +0000370Will show the audio subsystem help: list of drivers, tunable
371parameters.
372ETEXI
373
blueswir15824d652009-03-28 06:44:27 +0000374DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw,
375 "-soundhw c1,... enable audio support\n"
376 " and only specified sound cards (comma separated list)\n"
377 " use -soundhw ? to get the list of supported cards\n"
Blue Swirlad960902010-03-29 19:23:52 +0000378 " use -soundhw all to enable all of them\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000379STEXI
380@item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
Stefan Weil6616b2a2010-02-05 23:52:05 +0100381@findex -soundhw
blueswir15824d652009-03-28 06:44:27 +0000382Enable audio and selected sound hardware. Use ? to print all
383available sound hardware.
384
385@example
386qemu -soundhw sb16,adlib disk.img
387qemu -soundhw es1370 disk.img
388qemu -soundhw ac97 disk.img
389qemu -soundhw all disk.img
390qemu -soundhw ?
391@end example
392
393Note that Linux's i810_audio OSS kernel (for AC97) module might
394require manually specifying clocking.
395
396@example
397modprobe i810_audio clocking=48000
398@end example
399ETEXI
400
401STEXI
402@end table
403ETEXI
404
405DEF("usb", 0, QEMU_OPTION_usb,
Blue Swirlad960902010-03-29 19:23:52 +0000406 "-usb enable the USB driver (will be the default soon)\n",
407 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000408STEXI
409USB options:
410@table @option
411
412@item -usb
Stefan Weil6616b2a2010-02-05 23:52:05 +0100413@findex -usb
blueswir15824d652009-03-28 06:44:27 +0000414Enable the USB driver (will be the default soon)
415ETEXI
416
417DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice,
Blue Swirlad960902010-03-29 19:23:52 +0000418 "-usbdevice name add the host or guest USB device 'name'\n",
419 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000420STEXI
421
422@item -usbdevice @var{devname}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100423@findex -usbdevice
blueswir15824d652009-03-28 06:44:27 +0000424Add the USB device @var{devname}. @xref{usb_devices}.
425
Kevin Wolfb3f046c2009-10-09 10:58:35 +0200426@table @option
blueswir15824d652009-03-28 06:44:27 +0000427
428@item mouse
429Virtual Mouse. This will override the PS/2 mouse emulation when activated.
430
431@item tablet
432Pointer device that uses absolute coordinates (like a touchscreen). This
433means qemu is able to report the mouse position without having to grab the
434mouse. Also overrides the PS/2 mouse emulation when activated.
435
Kevin Wolf4e257e52009-10-09 10:58:36 +0200436@item disk:[format=@var{format}]:@var{file}
blueswir15824d652009-03-28 06:44:27 +0000437Mass storage device based on file. The optional @var{format} argument
438will be used rather than detecting the format. Can be used to specifiy
Kevin Wolf4e257e52009-10-09 10:58:36 +0200439@code{format=raw} to avoid interpreting an untrusted format header.
blueswir15824d652009-03-28 06:44:27 +0000440
Kevin Wolf4e257e52009-10-09 10:58:36 +0200441@item host:@var{bus}.@var{addr}
442Pass through the host device identified by @var{bus}.@var{addr} (Linux only).
blueswir15824d652009-03-28 06:44:27 +0000443
Kevin Wolf4e257e52009-10-09 10:58:36 +0200444@item host:@var{vendor_id}:@var{product_id}
445Pass through the host device identified by @var{vendor_id}:@var{product_id}
446(Linux only).
blueswir15824d652009-03-28 06:44:27 +0000447
448@item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
449Serial converter to host character device @var{dev}, see @code{-serial} for the
450available devices.
451
452@item braille
453Braille device. This will use BrlAPI to display the braille output on a real
454or fake device.
455
Kevin Wolf4e257e52009-10-09 10:58:36 +0200456@item net:@var{options}
blueswir15824d652009-03-28 06:44:27 +0000457Network adapter that supports CDC ethernet and RNDIS protocols.
458
459@end table
460ETEXI
461
Gerd Hoffmannbd3c9482009-07-15 13:59:26 +0200462DEF("device", HAS_ARG, QEMU_OPTION_device,
Markus Armbruster40ea2852010-01-29 19:49:01 +0100463 "-device driver[,prop[=value][,...]]\n"
464 " add device (based on driver)\n"
465 " prop=value,... sets driver properties\n"
Stefan Weil69a319d2010-01-20 22:58:35 +0100466 " use -device ? to print all possible drivers\n"
Stefan Weil6616b2a2010-02-05 23:52:05 +0100467 " use -device driver,? to print all possible options\n"
Blue Swirlad960902010-03-29 19:23:52 +0000468 " use -device driver,option=? to print a help for value\n",
469 QEMU_ARCH_ALL)
Stefan Weil3dbf2c72010-01-16 18:19:44 +0100470STEXI
Stefan Weil6616b2a2010-02-05 23:52:05 +0100471@item -device @var{driver}[,@var{option}[=@var{value}][,...]]
472@findex -device
473Add device @var{driver}. Depending on the device type,
474@var{option} (with default or given @var{value}) may be useful.
475To get a help on possible @var{driver}s, @var{option}s or @var{value}s, use
476@code{-device ?},
477@code{-device @var{driver},?} or
478@code{-device @var{driver},@var{option}=?}.
Stefan Weil3dbf2c72010-01-16 18:19:44 +0100479ETEXI
480
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530481#ifdef CONFIG_LINUX
482DEFHEADING(File system options:)
483
484DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev,
485 "-fsdev local,id=id,path=path\n",
486 QEMU_ARCH_ALL)
487
488STEXI
489
490The general form of a File system device option is:
491@table @option
492
493@item -fsdev @var{fstype} ,id=@var{id} [,@var{options}]
494@findex -fsdev
495Fstype is one of:
496@option{local},
497The specific Fstype will determine the applicable options.
498
499Options to each backend are described below.
500
501@item -fsdev local ,id=@var{id} ,path=@var{path}
502
503Create a file-system-"device" for local-filesystem.
504
505@option{local} is only available on Linux.
506
507@option{path} specifies the path to be exported. @option{path} is required.
508
509@end table
510ETEXI
511#endif
512
513DEFHEADING()
514
blueswir15824d652009-03-28 06:44:27 +0000515DEF("name", HAS_ARG, QEMU_OPTION_name,
Bruce Rogersca1a8a02010-01-06 12:33:57 -0700516 "-name string1[,process=string2]\n"
517 " set the name of the guest\n"
Blue Swirlad960902010-03-29 19:23:52 +0000518 " string1 sets the window title and string2 the process name (on Linux)\n",
519 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000520STEXI
521@item -name @var{name}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100522@findex -name
blueswir15824d652009-03-28 06:44:27 +0000523Sets the @var{name} of the guest.
524This name will be displayed in the SDL window caption.
525The @var{name} will also be used for the VNC server.
Andi Kleen18894652009-07-02 09:34:17 +0200526Also optionally set the top visible process name in Linux.
blueswir15824d652009-03-28 06:44:27 +0000527ETEXI
528
529DEF("uuid", HAS_ARG, QEMU_OPTION_uuid,
Paolo Bonzinie8105eb2010-02-04 16:49:59 +0100530 "-uuid %08x-%04x-%04x-%04x-%012x\n"
Blue Swirlad960902010-03-29 19:23:52 +0000531 " specify machine UUID\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000532STEXI
533@item -uuid @var{uuid}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100534@findex -uuid
blueswir15824d652009-03-28 06:44:27 +0000535Set system UUID.
536ETEXI
537
538STEXI
539@end table
540ETEXI
541
542DEFHEADING()
543
544DEFHEADING(Display options:)
545
546STEXI
547@table @option
548ETEXI
549
550DEF("nographic", 0, QEMU_OPTION_nographic,
Blue Swirlad960902010-03-29 19:23:52 +0000551 "-nographic disable graphical output and redirect serial I/Os to console\n",
552 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000553STEXI
554@item -nographic
Stefan Weil6616b2a2010-02-05 23:52:05 +0100555@findex -nographic
blueswir15824d652009-03-28 06:44:27 +0000556Normally, QEMU uses SDL to display the VGA output. With this option,
557you can totally disable graphical output so that QEMU is a simple
558command line application. The emulated serial port is redirected on
559the console. Therefore, you can still use QEMU to debug a Linux kernel
560with a serial console.
561ETEXI
562
563#ifdef CONFIG_CURSES
564DEF("curses", 0, QEMU_OPTION_curses,
Blue Swirlad960902010-03-29 19:23:52 +0000565 "-curses use a curses/ncurses interface instead of SDL\n",
566 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000567#endif
568STEXI
569@item -curses
Stefan Weil6616b2a2010-02-05 23:52:05 +0100570@findex curses
blueswir15824d652009-03-28 06:44:27 +0000571Normally, QEMU uses SDL to display the VGA output. With this option,
572QEMU can display the VGA output when in text mode using a
573curses/ncurses interface. Nothing is displayed in graphical mode.
574ETEXI
575
576#ifdef CONFIG_SDL
577DEF("no-frame", 0, QEMU_OPTION_no_frame,
Blue Swirlad960902010-03-29 19:23:52 +0000578 "-no-frame open SDL window without a frame and window decorations\n",
579 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000580#endif
581STEXI
582@item -no-frame
Stefan Weil6616b2a2010-02-05 23:52:05 +0100583@findex -no-frame
blueswir15824d652009-03-28 06:44:27 +0000584Do not use decorations for SDL windows and start them using the whole
585available screen space. This makes the using QEMU in a dedicated desktop
586workspace more convenient.
587ETEXI
588
589#ifdef CONFIG_SDL
590DEF("alt-grab", 0, QEMU_OPTION_alt_grab,
Blue Swirlad960902010-03-29 19:23:52 +0000591 "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n",
592 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000593#endif
594STEXI
595@item -alt-grab
Stefan Weil6616b2a2010-02-05 23:52:05 +0100596@findex -alt-grab
blueswir15824d652009-03-28 06:44:27 +0000597Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt).
598ETEXI
599
600#ifdef CONFIG_SDL
Dustin Kirkland0ca9f8a2009-09-17 15:48:04 -0500601DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab,
Blue Swirlad960902010-03-29 19:23:52 +0000602 "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n",
603 QEMU_ARCH_ALL)
Dustin Kirkland0ca9f8a2009-09-17 15:48:04 -0500604#endif
605STEXI
606@item -ctrl-grab
Stefan Weil6616b2a2010-02-05 23:52:05 +0100607@findex -ctrl-grab
Dustin Kirkland0ca9f8a2009-09-17 15:48:04 -0500608Use Right-Ctrl to grab mouse (instead of Ctrl-Alt).
609ETEXI
610
611#ifdef CONFIG_SDL
blueswir15824d652009-03-28 06:44:27 +0000612DEF("no-quit", 0, QEMU_OPTION_no_quit,
Blue Swirlad960902010-03-29 19:23:52 +0000613 "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000614#endif
615STEXI
616@item -no-quit
Stefan Weil6616b2a2010-02-05 23:52:05 +0100617@findex -no-quit
blueswir15824d652009-03-28 06:44:27 +0000618Disable SDL window close capability.
619ETEXI
620
621#ifdef CONFIG_SDL
622DEF("sdl", 0, QEMU_OPTION_sdl,
Blue Swirlad960902010-03-29 19:23:52 +0000623 "-sdl enable SDL\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000624#endif
625STEXI
626@item -sdl
Stefan Weil6616b2a2010-02-05 23:52:05 +0100627@findex -sdl
blueswir15824d652009-03-28 06:44:27 +0000628Enable SDL.
629ETEXI
630
631DEF("portrait", 0, QEMU_OPTION_portrait,
Blue Swirlad960902010-03-29 19:23:52 +0000632 "-portrait rotate graphical output 90 deg left (only PXA LCD)\n",
633 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000634STEXI
635@item -portrait
Stefan Weil6616b2a2010-02-05 23:52:05 +0100636@findex -portrait
blueswir15824d652009-03-28 06:44:27 +0000637Rotate graphical output 90 deg left (only PXA LCD).
638ETEXI
639
640DEF("vga", HAS_ARG, QEMU_OPTION_vga,
aliguori94909d92009-04-22 15:19:53 +0000641 "-vga [std|cirrus|vmware|xenfb|none]\n"
Blue Swirlad960902010-03-29 19:23:52 +0000642 " select video card type\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000643STEXI
644@item -vga @var{type}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100645@findex -vga
blueswir15824d652009-03-28 06:44:27 +0000646Select type of VGA card to emulate. Valid values for @var{type} are
Kevin Wolfb3f046c2009-10-09 10:58:35 +0200647@table @option
blueswir15824d652009-03-28 06:44:27 +0000648@item cirrus
649Cirrus Logic GD5446 Video card. All Windows versions starting from
650Windows 95 should recognize and use this graphic card. For optimal
651performances, use 16 bit color depth in the guest and the host OS.
652(This one is the default)
653@item std
654Standard VGA card with Bochs VBE extensions. If your guest OS
655supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
656to use high resolution modes (>= 1280x1024x16) then you should use
657this option.
658@item vmware
659VMWare SVGA-II compatible adapter. Use it if you have sufficiently
660recent XFree86/XOrg server or Windows guest with a driver for this
661card.
662@item none
663Disable VGA card.
664@end table
665ETEXI
666
667DEF("full-screen", 0, QEMU_OPTION_full_screen,
Blue Swirlad960902010-03-29 19:23:52 +0000668 "-full-screen start in full screen\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000669STEXI
670@item -full-screen
Stefan Weil6616b2a2010-02-05 23:52:05 +0100671@findex -full-screen
blueswir15824d652009-03-28 06:44:27 +0000672Start in full screen.
673ETEXI
674
blueswir15824d652009-03-28 06:44:27 +0000675DEF("g", 1, QEMU_OPTION_g ,
Blue Swirlad960902010-03-29 19:23:52 +0000676 "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n",
677 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
blueswir15824d652009-03-28 06:44:27 +0000678STEXI
Stefan Weil95d5f082010-01-20 22:25:27 +0100679@item -g @var{width}x@var{height}[x@var{depth}]
Stefan Weil6616b2a2010-02-05 23:52:05 +0100680@findex -g
Stefan Weil95d5f082010-01-20 22:25:27 +0100681Set the initial graphical resolution and depth (PPC, SPARC only).
blueswir15824d652009-03-28 06:44:27 +0000682ETEXI
683
684DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
Blue Swirlad960902010-03-29 19:23:52 +0000685 "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000686STEXI
687@item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
Stefan Weil6616b2a2010-02-05 23:52:05 +0100688@findex -vnc
blueswir15824d652009-03-28 06:44:27 +0000689Normally, QEMU uses SDL to display the VGA output. With this option,
690you can have QEMU listen on VNC display @var{display} and redirect the VGA
691display over the VNC session. It is very useful to enable the usb
692tablet device when using this option (option @option{-usbdevice
693tablet}). When using the VNC display, you must use the @option{-k}
694parameter to set the keyboard layout if you are not using en-us. Valid
695syntax for the @var{display} is
696
Kevin Wolfb3f046c2009-10-09 10:58:35 +0200697@table @option
blueswir15824d652009-03-28 06:44:27 +0000698
699@item @var{host}:@var{d}
700
701TCP connections will only be allowed from @var{host} on display @var{d}.
702By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
703be omitted in which case the server will accept connections from any host.
704
Kevin Wolf4e257e52009-10-09 10:58:36 +0200705@item unix:@var{path}
blueswir15824d652009-03-28 06:44:27 +0000706
707Connections will be allowed over UNIX domain sockets where @var{path} is the
708location of a unix socket to listen for connections on.
709
710@item none
711
712VNC is initialized but not started. The monitor @code{change} command
713can be used to later start the VNC server.
714
715@end table
716
717Following the @var{display} value there may be one or more @var{option} flags
718separated by commas. Valid options are
719
Kevin Wolfb3f046c2009-10-09 10:58:35 +0200720@table @option
blueswir15824d652009-03-28 06:44:27 +0000721
722@item reverse
723
724Connect to a listening VNC client via a ``reverse'' connection. The
725client is specified by the @var{display}. For reverse network
726connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
727is a TCP port number, not a display number.
728
729@item password
730
731Require that password based authentication is used for client connections.
732The password must be set separately using the @code{change} command in the
733@ref{pcsys_monitor}
734
735@item tls
736
737Require that client use TLS when communicating with the VNC server. This
738uses anonymous TLS credentials so is susceptible to a man-in-the-middle
739attack. It is recommended that this option be combined with either the
Kevin Wolf4e257e52009-10-09 10:58:36 +0200740@option{x509} or @option{x509verify} options.
blueswir15824d652009-03-28 06:44:27 +0000741
742@item x509=@var{/path/to/certificate/dir}
743
744Valid if @option{tls} is specified. Require that x509 credentials are used
745for negotiating the TLS session. The server will send its x509 certificate
746to the client. It is recommended that a password be set on the VNC server
747to provide authentication of the client when this is used. The path following
748this option specifies where the x509 certificates are to be loaded from.
749See the @ref{vnc_security} section for details on generating certificates.
750
751@item x509verify=@var{/path/to/certificate/dir}
752
753Valid if @option{tls} is specified. Require that x509 credentials are used
754for negotiating the TLS session. The server will send its x509 certificate
755to the client, and request that the client send its own x509 certificate.
756The server will validate the client's certificate against the CA certificate,
757and reject clients when validation fails. If the certificate authority is
758trusted, this is a sufficient authentication mechanism. You may still wish
759to set a password on the VNC server as a second authentication layer. The
760path following this option specifies where the x509 certificates are to
761be loaded from. See the @ref{vnc_security} section for details on generating
762certificates.
763
764@item sasl
765
766Require that the client use SASL to authenticate with the VNC server.
767The exact choice of authentication method used is controlled from the
768system / user's SASL configuration file for the 'qemu' service. This
769is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
770unprivileged user, an environment variable SASL_CONF_PATH can be used
771to make it search alternate locations for the service config.
772While some SASL auth methods can also provide data encryption (eg GSSAPI),
773it is recommended that SASL always be combined with the 'tls' and
774'x509' settings to enable use of SSL and server certificates. This
775ensures a data encryption preventing compromise of authentication
776credentials. See the @ref{vnc_security} section for details on using
777SASL authentication.
778
779@item acl
780
781Turn on access control lists for checking of the x509 client certificate
782and SASL party. For x509 certs, the ACL check is made against the
783certificate's distinguished name. This is something that looks like
784@code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
785made against the username, which depending on the SASL plugin, may
786include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
787When the @option{acl} flag is set, the initial access list will be
788empty, with a @code{deny} policy. Thus no one will be allowed to
789use the VNC server until the ACLs have been loaded. This can be
790achieved using the @code{acl} monitor command.
791
792@end table
793ETEXI
794
795STEXI
796@end table
797ETEXI
798
799DEFHEADING()
800
blueswir15824d652009-03-28 06:44:27 +0000801DEFHEADING(i386 target only:)
blueswir15824d652009-03-28 06:44:27 +0000802STEXI
803@table @option
804ETEXI
805
blueswir15824d652009-03-28 06:44:27 +0000806DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack,
Blue Swirlad960902010-03-29 19:23:52 +0000807 "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n",
808 QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +0000809STEXI
810@item -win2k-hack
Stefan Weil6616b2a2010-02-05 23:52:05 +0100811@findex -win2k-hack
blueswir15824d652009-03-28 06:44:27 +0000812Use it when installing Windows 2000 to avoid a disk full bug. After
813Windows 2000 is installed, you no longer need this option (this option
814slows down the IDE transfers).
815ETEXI
816
Jan Kiszka1ed2fc12009-09-15 13:36:04 +0200817HXCOMM Deprecated by -rtc
Blue Swirlad960902010-03-29 19:23:52 +0000818DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +0000819
blueswir15824d652009-03-28 06:44:27 +0000820DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk,
Blue Swirlad960902010-03-29 19:23:52 +0000821 "-no-fd-bootchk disable boot signature checking for floppy disks\n",
822 QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +0000823STEXI
824@item -no-fd-bootchk
Stefan Weil6616b2a2010-02-05 23:52:05 +0100825@findex -no-fd-bootchk
blueswir15824d652009-03-28 06:44:27 +0000826Disable boot signature checking for floppy disks in Bochs BIOS. It may
827be needed to boot from old floppy disks.
Stefan Weil6616b2a2010-02-05 23:52:05 +0100828TODO: check reference to Bochs BIOS.
blueswir15824d652009-03-28 06:44:27 +0000829ETEXI
830
blueswir15824d652009-03-28 06:44:27 +0000831DEF("no-acpi", 0, QEMU_OPTION_no_acpi,
Blue Swirlad960902010-03-29 19:23:52 +0000832 "-no-acpi disable ACPI\n", QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +0000833STEXI
834@item -no-acpi
Stefan Weil6616b2a2010-02-05 23:52:05 +0100835@findex -no-acpi
blueswir15824d652009-03-28 06:44:27 +0000836Disable ACPI (Advanced Configuration and Power Interface) support. Use
837it if your guest OS complains about ACPI problems (PC target machine
838only).
839ETEXI
840
blueswir15824d652009-03-28 06:44:27 +0000841DEF("no-hpet", 0, QEMU_OPTION_no_hpet,
Blue Swirlad960902010-03-29 19:23:52 +0000842 "-no-hpet disable HPET\n", QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +0000843STEXI
844@item -no-hpet
Stefan Weil6616b2a2010-02-05 23:52:05 +0100845@findex -no-hpet
blueswir15824d652009-03-28 06:44:27 +0000846Disable HPET support.
847ETEXI
848
Markus Armbruster7d4c3d52009-06-26 19:15:14 +0200849DEF("balloon", HAS_ARG, QEMU_OPTION_balloon,
850 "-balloon none disable balloon device\n"
851 "-balloon virtio[,addr=str]\n"
Blue Swirlad960902010-03-29 19:23:52 +0000852 " enable virtio balloon device (default)\n", QEMU_ARCH_ALL)
Eduardo Habkostdf97b922009-06-10 16:34:08 -0300853STEXI
Markus Armbruster7d4c3d52009-06-26 19:15:14 +0200854@item -balloon none
Stefan Weil6616b2a2010-02-05 23:52:05 +0100855@findex -balloon
Markus Armbruster7d4c3d52009-06-26 19:15:14 +0200856Disable balloon device.
857@item -balloon virtio[,addr=@var{addr}]
858Enable virtio balloon device (default), optionally with PCI address
859@var{addr}.
Eduardo Habkostdf97b922009-06-10 16:34:08 -0300860ETEXI
861
blueswir15824d652009-03-28 06:44:27 +0000862DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable,
863 "-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"
Blue Swirlad960902010-03-29 19:23:52 +0000864 " ACPI table description\n", QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +0000865STEXI
866@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}]...]
Stefan Weil6616b2a2010-02-05 23:52:05 +0100867@findex -acpitable
blueswir15824d652009-03-28 06:44:27 +0000868Add ACPI table with specified header fields and context from specified files.
869ETEXI
870
aliguorib6f6e3d2009-04-17 18:59:56 +0000871DEF("smbios", HAS_ARG, QEMU_OPTION_smbios,
872 "-smbios file=binary\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -0700873 " load SMBIOS entry from binary file\n"
Paolo Bonzinie8105eb2010-02-04 16:49:59 +0100874 "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -0700875 " specify SMBIOS type 0 fields\n"
aliguorib6f6e3d2009-04-17 18:59:56 +0000876 "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n"
877 " [,uuid=uuid][,sku=str][,family=str]\n"
Blue Swirlad960902010-03-29 19:23:52 +0000878 " specify SMBIOS type 1 fields\n", QEMU_ARCH_I386)
aliguorib6f6e3d2009-04-17 18:59:56 +0000879STEXI
880@item -smbios file=@var{binary}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100881@findex -smbios
aliguorib6f6e3d2009-04-17 18:59:56 +0000882Load SMBIOS entry from binary file.
883
884@item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}]
Stefan Weil6616b2a2010-02-05 23:52:05 +0100885@findex -smbios
aliguorib6f6e3d2009-04-17 18:59:56 +0000886Specify SMBIOS type 0 fields
887
Blue Swirl609c1da2010-03-18 18:41:49 +0000888@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}]
aliguorib6f6e3d2009-04-17 18:59:56 +0000889Specify SMBIOS type 1 fields
890ETEXI
891
blueswir15824d652009-03-28 06:44:27 +0000892DEFHEADING()
blueswir15824d652009-03-28 06:44:27 +0000893STEXI
894@end table
895ETEXI
896
897DEFHEADING(Network options:)
898STEXI
899@table @option
900ETEXI
901
Jan Kiszkaad196a92009-06-24 14:42:28 +0200902HXCOMM Legacy slirp options (now moved to -net user):
903#ifdef CONFIG_SLIRP
Blue Swirlad960902010-03-29 19:23:52 +0000904DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL)
905DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL)
906DEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL)
Jan Kiszkaad196a92009-06-24 14:42:28 +0200907#ifndef _WIN32
Blue Swirlad960902010-03-29 19:23:52 +0000908DEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL)
Jan Kiszkaad196a92009-06-24 14:42:28 +0200909#endif
910#endif
911
Blue Swirlbab79442009-06-09 21:50:02 +0300912DEF("net", HAS_ARG, QEMU_OPTION_net,
Michael S. Tsirkinffe63702009-06-21 19:51:18 +0300913 "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n"
blueswir15824d652009-03-28 06:44:27 +0000914 " create a new Network Interface Card and connect it to VLAN 'n'\n"
915#ifdef CONFIG_SLIRP
Jan Kiszkac92ef6a2009-06-24 14:42:28 +0200916 "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=y|n]\n"
917 " [,hostname=host][,dhcpstart=addr][,dns=addr][,tftp=dir][,bootfile=f]\n"
918 " [,hostfwd=rule][,guestfwd=rule]"
Jan Kiszkaad196a92009-06-24 14:42:28 +0200919#ifndef _WIN32
Jan Kiszkac92ef6a2009-06-24 14:42:28 +0200920 "[,smb=dir[,smbserver=addr]]\n"
Jan Kiszkaad196a92009-06-24 14:42:28 +0200921#endif
922 " connect the user mode network stack to VLAN 'n', configure its\n"
923 " DHCP server and enabled optional services\n"
blueswir15824d652009-03-28 06:44:27 +0000924#endif
925#ifdef _WIN32
926 "-net tap[,vlan=n][,name=str],ifname=name\n"
927 " connect the host TAP network interface to VLAN 'n'\n"
928#else
Michael S. Tsirkin82b0d802010-03-17 13:08:24 +0200929 "-net tap[,vlan=n][,name=str][,fd=h][,ifname=name][,script=file][,downscript=dfile][,sndbuf=nbytes][,vnet_hdr=on|off][,vhost=on|off][,vhostfd=h]\n"
blueswir15824d652009-03-28 06:44:27 +0000930 " connect the host TAP network interface to VLAN 'n' and use the\n"
Paolo Bonzinibec7c2d2010-02-04 16:49:58 +0100931 " network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n"
932 " and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -0700933 " use '[down]script=no' to disable script execution\n"
blueswir15824d652009-03-28 06:44:27 +0000934 " use 'fd=h' to connect to an already opened TAP interface\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -0700935 " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n"
936 " default of 'sndbuf=1048576' can be disabled using 'sndbuf=0')\n"
937 " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n"
938 " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n"
Michael S. Tsirkin82b0d802010-03-17 13:08:24 +0200939 " use vhost=on to enable experimental in kernel accelerator\n"
940 " use 'vhostfd=h' to connect to an already opened vhost net device\n"
Mark McLoughlin0df0ff62009-06-18 18:21:34 +0100941#endif
blueswir15824d652009-03-28 06:44:27 +0000942 "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n"
943 " connect the vlan 'n' to another VLAN using a socket connection\n"
944 "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port]\n"
945 " connect the vlan 'n' to multicast maddr and port\n"
946#ifdef CONFIG_VDE
947 "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n"
948 " connect the vlan 'n' to port 'n' of a vde switch running\n"
949 " on host and listening for incoming connections on 'socketpath'.\n"
950 " Use group 'groupname' and mode 'octalmode' to change default\n"
951 " ownership and permissions for communication port.\n"
952#endif
aliguoribb9ea792009-04-21 19:56:28 +0000953 "-net dump[,vlan=n][,file=f][,len=n]\n"
954 " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -0700955 "-net none use it alone to have zero network devices. If no -net option\n"
Blue Swirlad960902010-03-29 19:23:52 +0000956 " is provided, the default is '-net nic -net user'\n", QEMU_ARCH_ALL)
Mark McLoughlina1ea4582009-10-08 19:58:26 +0100957DEF("netdev", HAS_ARG, QEMU_OPTION_netdev,
958 "-netdev ["
959#ifdef CONFIG_SLIRP
960 "user|"
961#endif
962 "tap|"
963#ifdef CONFIG_VDE
964 "vde|"
965#endif
Blue Swirlad960902010-03-29 19:23:52 +0000966 "socket],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000967STEXI
Blue Swirl609c1da2010-03-18 18:41:49 +0000968@item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}]
Stefan Weil6616b2a2010-02-05 23:52:05 +0100969@findex -net
blueswir15824d652009-03-28 06:44:27 +0000970Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
Anthony Liguori0d6b0b12009-08-14 11:20:47 -0500971= 0 is the default). The NIC is an e1000 by default on the PC
Markus Armbruster5607c382009-06-18 15:14:08 +0200972target. Optionally, the MAC address can be changed to @var{mac}, the
973device address set to @var{addr} (PCI cards only),
Michael S. Tsirkinffe63702009-06-21 19:51:18 +0300974and a @var{name} can be assigned for use in monitor commands.
975Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
976that the card should have; this option currently only affects virtio cards; set
977@var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
978NIC is created. Qemu can emulate several different models of network card.
blueswir15824d652009-03-28 06:44:27 +0000979Valid values for @var{type} are
Michael S. Tsirkinffe63702009-06-21 19:51:18 +0300980@code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er},
blueswir15824d652009-03-28 06:44:27 +0000981@code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
982@code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
983Not all devices are supported on all targets. Use -net nic,model=?
984for a list of available devices for your target.
985
Jan Kiszkaad196a92009-06-24 14:42:28 +0200986@item -net user[,@var{option}][,@var{option}][,...]
blueswir15824d652009-03-28 06:44:27 +0000987Use the user mode network stack which requires no administrator
Jan Kiszkaad196a92009-06-24 14:42:28 +0200988privilege to run. Valid options are:
blueswir15824d652009-03-28 06:44:27 +0000989
Kevin Wolfb3f046c2009-10-09 10:58:35 +0200990@table @option
Jan Kiszkaad196a92009-06-24 14:42:28 +0200991@item vlan=@var{n}
992Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default).
993
994@item name=@var{name}
995Assign symbolic name for use in monitor commands.
996
Jan Kiszkac92ef6a2009-06-24 14:42:28 +0200997@item net=@var{addr}[/@var{mask}]
998Set IP network address the guest will see. Optionally specify the netmask,
999either in the form a.b.c.d or as number of valid top-most bits. Default is
100010.0.2.0/8.
1001
1002@item host=@var{addr}
1003Specify the guest-visible address of the host. Default is the 2nd IP in the
1004guest network, i.e. x.x.x.2.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001005
1006@item restrict=y|yes|n|no
1007If this options is enabled, the guest will be isolated, i.e. it will not be
1008able to contact the host and no guest IP packets will be routed over the host
1009to the outside. This option does not affect explicitly set forwarding rule.
1010
1011@item hostname=@var{name}
1012Specifies the client hostname reported by the builtin DHCP server.
1013
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001014@item dhcpstart=@var{addr}
1015Specify the first of the 16 IPs the built-in DHCP server can assign. Default
1016is the 16th to 31st IP in the guest network, i.e. x.x.x.16 to x.x.x.31.
1017
1018@item dns=@var{addr}
1019Specify the guest-visible address of the virtual nameserver. The address must
1020be different from the host address. Default is the 3rd IP in the guest network,
1021i.e. x.x.x.3.
1022
Jan Kiszkaad196a92009-06-24 14:42:28 +02001023@item tftp=@var{dir}
1024When using the user mode network stack, activate a built-in TFTP
1025server. The files in @var{dir} will be exposed as the root of a TFTP server.
1026The TFTP client on the guest must be configured in binary mode (use the command
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001027@code{bin} of the Unix TFTP client).
Jan Kiszkaad196a92009-06-24 14:42:28 +02001028
1029@item bootfile=@var{file}
1030When using the user mode network stack, broadcast @var{file} as the BOOTP
1031filename. In conjunction with @option{tftp}, this can be used to network boot
1032a guest from a local directory.
1033
1034Example (using pxelinux):
1035@example
1036qemu -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
1037@end example
1038
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001039@item smb=@var{dir}[,smbserver=@var{addr}]
Jan Kiszkaad196a92009-06-24 14:42:28 +02001040When using the user mode network stack, activate a built-in SMB
1041server so that Windows OSes can access to the host files in @file{@var{dir}}
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001042transparently. The IP address of the SMB server can be set to @var{addr}. By
1043default the 4th IP in the guest network is used, i.e. x.x.x.4.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001044
1045In the guest Windows OS, the line:
1046@example
104710.0.2.4 smbserver
1048@end example
1049must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
1050or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
1051
1052Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
1053
1054Note that a SAMBA server must be installed on the host OS in
1055@file{/usr/sbin/smbd}. QEMU was tested successfully with smbd versions from
1056Red Hat 9, Fedora Core 3 and OpenSUSE 11.x.
1057
Jan Kiszka3c6a0582009-06-24 14:42:28 +02001058@item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001059Redirect incoming TCP or UDP connections to the host port @var{hostport} to
1060the guest IP address @var{guestaddr} on guest port @var{guestport}. If
1061@var{guestaddr} is not specified, its value is x.x.x.15 (default first address
Jan Kiszka3c6a0582009-06-24 14:42:28 +02001062given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
1063be bound to a specific host interface. If no connection type is set, TCP is
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001064used. This option can be given multiple times.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001065
1066For example, to redirect host X11 connection from screen 1 to guest
1067screen 0, use the following:
1068
1069@example
1070# on the host
Jan Kiszka3c6a0582009-06-24 14:42:28 +02001071qemu -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...]
Jan Kiszkaad196a92009-06-24 14:42:28 +02001072# this host xterm should open in the guest X11 server
1073xterm -display :1
1074@end example
1075
1076To redirect telnet connections from host port 5555 to telnet port on
1077the guest, use the following:
1078
1079@example
1080# on the host
Aurelien Jarnoaa375202010-02-27 10:50:32 +01001081qemu -net user,hostfwd=tcp::5555-:23 [...]
Jan Kiszkaad196a92009-06-24 14:42:28 +02001082telnet localhost 5555
1083@end example
1084
1085Then when you use on the host @code{telnet localhost 5555}, you
1086connect to the guest telnet server.
1087
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001088@item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
Jan Kiszka3c6a0582009-06-24 14:42:28 +02001089Forward guest TCP connections to the IP address @var{server} on port @var{port}
1090to the character device @var{dev}. This option can be given multiple times.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001091
1092@end table
1093
1094Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still
1095processed and applied to -net user. Mixing them with the new configuration
1096syntax gives undefined results. Their use for new applications is discouraged
1097as they will be removed from future versions.
blueswir15824d652009-03-28 06:44:27 +00001098
Blue Swirl609c1da2010-03-18 18:41:49 +00001099@item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}] [,script=@var{file}][,downscript=@var{dfile}]
blueswir15824d652009-03-28 06:44:27 +00001100Connect the host TAP network interface @var{name} to VLAN @var{n}, use
1101the network script @var{file} to configure it and the network script
1102@var{dfile} to deconfigure it. If @var{name} is not provided, the OS
1103automatically provides one. @option{fd}=@var{h} can be used to specify
1104the handle of an already opened host TAP interface. The default network
1105configure script is @file{/etc/qemu-ifup} and the default network
1106deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no}
1107or @option{downscript=no} to disable script execution. Example:
1108
1109@example
1110qemu linux.img -net nic -net tap
1111@end example
1112
1113More complicated example (two NICs, each one connected to a TAP device)
1114@example
1115qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
1116 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
1117@end example
1118
Blue Swirl609c1da2010-03-18 18:41:49 +00001119@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
blueswir15824d652009-03-28 06:44:27 +00001120
1121Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
1122machine using a TCP socket connection. If @option{listen} is
1123specified, QEMU waits for incoming connections on @var{port}
1124(@var{host} is optional). @option{connect} is used to connect to
1125another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
1126specifies an already opened TCP socket.
1127
1128Example:
1129@example
1130# launch a first QEMU instance
1131qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1132 -net socket,listen=:1234
1133# connect the VLAN 0 of this instance to the VLAN 0
1134# of the first instance
1135qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1136 -net socket,connect=127.0.0.1:1234
1137@end example
1138
Blue Swirl609c1da2010-03-18 18:41:49 +00001139@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,mcast=@var{maddr}:@var{port}]
blueswir15824d652009-03-28 06:44:27 +00001140
1141Create a VLAN @var{n} shared with another QEMU virtual
1142machines using a UDP multicast socket, effectively making a bus for
1143every QEMU with same multicast address @var{maddr} and @var{port}.
1144NOTES:
1145@enumerate
1146@item
1147Several QEMU can be running on different hosts and share same bus (assuming
1148correct multicast setup for these hosts).
1149@item
1150mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
1151@url{http://user-mode-linux.sf.net}.
1152@item
1153Use @option{fd=h} to specify an already opened UDP multicast socket.
1154@end enumerate
1155
1156Example:
1157@example
1158# launch one QEMU instance
1159qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1160 -net socket,mcast=230.0.0.1:1234
1161# launch another QEMU instance on same "bus"
1162qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1163 -net socket,mcast=230.0.0.1:1234
1164# launch yet another QEMU instance on same "bus"
1165qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
1166 -net socket,mcast=230.0.0.1:1234
1167@end example
1168
1169Example (User Mode Linux compat.):
1170@example
1171# launch QEMU instance (note mcast address selected
1172# is UML's default)
1173qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1174 -net socket,mcast=239.192.168.1:1102
1175# launch UML
1176/path/to/linux ubd0=/path/to/root_fs eth0=mcast
1177@end example
1178
Blue Swirl609c1da2010-03-18 18:41:49 +00001179@item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
blueswir15824d652009-03-28 06:44:27 +00001180Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
1181listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
1182and MODE @var{octalmode} to change default ownership and permissions for
1183communication port. This option is available only if QEMU has been compiled
1184with vde support enabled.
1185
1186Example:
1187@example
1188# launch vde switch
1189vde_switch -F -sock /tmp/myswitch
1190# launch QEMU instance
1191qemu linux.img -net nic -net vde,sock=/tmp/myswitch
1192@end example
1193
aliguoribb9ea792009-04-21 19:56:28 +00001194@item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
1195Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
1196At most @var{len} bytes (64k by default) per packet are stored. The file format is
1197libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
1198
blueswir15824d652009-03-28 06:44:27 +00001199@item -net none
1200Indicate that no network devices should be configured. It is used to
1201override the default configuration (@option{-net nic -net user}) which
1202is activated if no @option{-net} options are provided.
blueswir15824d652009-03-28 06:44:27 +00001203
1204@end table
1205ETEXI
1206
Matthew Booth7273a2d2009-10-30 13:41:12 +00001207DEFHEADING()
1208
1209DEFHEADING(Character device options:)
1210
1211DEF("chardev", HAS_ARG, QEMU_OPTION_chardev,
Jan Kiszka97331282010-04-06 16:55:54 +02001212 "-chardev null,id=id[,mux=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00001213 "-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n"
Jan Kiszka97331282010-04-06 16:55:54 +02001214 " [,server][,nowait][,telnet][,mux=on|off] (tcp)\n"
1215 "-chardev socket,id=id,path=path[,server][,nowait][,telnet],[mux=on|off] (unix)\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00001216 "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n"
Jan Kiszka97331282010-04-06 16:55:54 +02001217 " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n"
1218 "-chardev msmouse,id=id[,mux=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00001219 "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n"
Jan Kiszka97331282010-04-06 16:55:54 +02001220 " [,mux=on|off]\n"
1221 "-chardev file,id=id,path=path[,mux=on|off]\n"
1222 "-chardev pipe,id=id,path=path[,mux=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00001223#ifdef _WIN32
Jan Kiszka97331282010-04-06 16:55:54 +02001224 "-chardev console,id=id[,mux=on|off]\n"
1225 "-chardev serial,id=id,path=path[,mux=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00001226#else
Jan Kiszka97331282010-04-06 16:55:54 +02001227 "-chardev pty,id=id[,mux=on|off]\n"
1228 "-chardev stdio,id=id[,mux=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00001229#endif
1230#ifdef CONFIG_BRLAPI
Jan Kiszka97331282010-04-06 16:55:54 +02001231 "-chardev braille,id=id[,mux=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00001232#endif
1233#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
1234 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
Jan Kiszka97331282010-04-06 16:55:54 +02001235 "-chardev tty,id=id,path=path[,mux=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00001236#endif
1237#if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__)
Jan Kiszka97331282010-04-06 16:55:54 +02001238 "-chardev parport,id=id,path=path[,mux=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00001239#endif
Blue Swirlad960902010-03-29 19:23:52 +00001240 , QEMU_ARCH_ALL
Matthew Booth7273a2d2009-10-30 13:41:12 +00001241)
1242
1243STEXI
1244
1245The general form of a character device option is:
1246@table @option
1247
Jan Kiszka97331282010-04-06 16:55:54 +02001248@item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}]
Stefan Weil6616b2a2010-02-05 23:52:05 +01001249@findex -chardev
Matthew Booth7273a2d2009-10-30 13:41:12 +00001250Backend is one of:
1251@option{null},
1252@option{socket},
1253@option{udp},
1254@option{msmouse},
1255@option{vc},
1256@option{file},
1257@option{pipe},
1258@option{console},
1259@option{serial},
1260@option{pty},
1261@option{stdio},
1262@option{braille},
1263@option{tty},
1264@option{parport}.
1265The specific backend will determine the applicable options.
1266
1267All devices must have an id, which can be any string up to 127 characters long.
1268It is used to uniquely identify this device in other command line directives.
1269
Jan Kiszka97331282010-04-06 16:55:54 +02001270A character device may be used in multiplexing mode by multiple front-ends.
1271The key sequence of @key{Control-a} and @key{c} will rotate the input focus
1272between attached front-ends. Specify @option{mux=on} to enable this mode.
1273
Matthew Booth7273a2d2009-10-30 13:41:12 +00001274Options to each backend are described below.
1275
1276@item -chardev null ,id=@var{id}
1277A void device. This device will not emit any data, and will drop any data it
1278receives. The null backend does not take any options.
1279
1280@item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet]
1281
1282Create a two-way stream socket, which can be either a TCP or a unix socket. A
1283unix socket will be created if @option{path} is specified. Behaviour is
1284undefined if TCP options are specified for a unix socket.
1285
1286@option{server} specifies that the socket shall be a listening socket.
1287
1288@option{nowait} specifies that QEMU should not block waiting for a client to
1289connect to a listening socket.
1290
1291@option{telnet} specifies that traffic on the socket should interpret telnet
1292escape sequences.
1293
1294TCP and unix socket options are given below:
1295
1296@table @option
1297
Aurelien Jarno8d533562010-03-27 11:52:05 +01001298@item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay]
Matthew Booth7273a2d2009-10-30 13:41:12 +00001299
1300@option{host} for a listening socket specifies the local address to be bound.
1301For a connecting socket species the remote host to connect to. @option{host} is
1302optional for listening sockets. If not specified it defaults to @code{0.0.0.0}.
1303
1304@option{port} for a listening socket specifies the local port to be bound. For a
1305connecting socket specifies the port on the remote host to connect to.
1306@option{port} can be given as either a port number or a service name.
1307@option{port} is required.
1308
1309@option{to} is only relevant to listening sockets. If it is specified, and
1310@option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up
1311to and including @option{to} until it succeeds. @option{to} must be specified
1312as a port number.
1313
1314@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1315If neither is specified the socket may use either protocol.
1316
1317@option{nodelay} disables the Nagle algorithm.
1318
1319@item unix options: path=@var{path}
1320
1321@option{path} specifies the local path of the unix socket. @option{path} is
1322required.
1323
1324@end table
1325
1326@item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6]
1327
1328Sends all traffic from the guest to a remote host over UDP.
1329
1330@option{host} specifies the remote host to connect to. If not specified it
1331defaults to @code{localhost}.
1332
1333@option{port} specifies the port on the remote host to connect to. @option{port}
1334is required.
1335
1336@option{localaddr} specifies the local address to bind to. If not specified it
1337defaults to @code{0.0.0.0}.
1338
1339@option{localport} specifies the local port to bind to. If not specified any
1340available local port will be used.
1341
1342@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1343If neither is specified the device may use either protocol.
1344
1345@item -chardev msmouse ,id=@var{id}
1346
1347Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not
1348take any options.
1349
1350@item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]]
1351
1352Connect to a QEMU text console. @option{vc} may optionally be given a specific
1353size.
1354
1355@option{width} and @option{height} specify the width and height respectively of
1356the console, in pixels.
1357
1358@option{cols} and @option{rows} specify that the console be sized to fit a text
1359console with the given dimensions.
1360
1361@item -chardev file ,id=@var{id} ,path=@var{path}
1362
1363Log all traffic received from the guest to a file.
1364
1365@option{path} specifies the path of the file to be opened. This file will be
1366created if it does not already exist, and overwritten if it does. @option{path}
1367is required.
1368
1369@item -chardev pipe ,id=@var{id} ,path=@var{path}
1370
1371Create a two-way connection to the guest. The behaviour differs slightly between
1372Windows hosts and other hosts:
1373
1374On Windows, a single duplex pipe will be created at
1375@file{\\.pipe\@option{path}}.
1376
1377On other hosts, 2 pipes will be created called @file{@option{path}.in} and
1378@file{@option{path}.out}. Data written to @file{@option{path}.in} will be
1379received by the guest. Data written by the guest can be read from
1380@file{@option{path}.out}. QEMU will not create these fifos, and requires them to
1381be present.
1382
1383@option{path} forms part of the pipe path as described above. @option{path} is
1384required.
1385
1386@item -chardev console ,id=@var{id}
1387
1388Send traffic from the guest to QEMU's standard output. @option{console} does not
1389take any options.
1390
1391@option{console} is only available on Windows hosts.
1392
1393@item -chardev serial ,id=@var{id} ,path=@option{path}
1394
1395Send traffic from the guest to a serial device on the host.
1396
1397@option{serial} is
1398only available on Windows hosts.
1399
1400@option{path} specifies the name of the serial device to open.
1401
1402@item -chardev pty ,id=@var{id}
1403
1404Create a new pseudo-terminal on the host and connect to it. @option{pty} does
1405not take any options.
1406
1407@option{pty} is not available on Windows hosts.
1408
1409@item -chardev stdio ,id=@var{id}
1410Connect to standard input and standard output of the qemu process.
1411@option{stdio} does not take any options. @option{stdio} is not available on
1412Windows hosts.
1413
1414@item -chardev braille ,id=@var{id}
1415
1416Connect to a local BrlAPI server. @option{braille} does not take any options.
1417
1418@item -chardev tty ,id=@var{id} ,path=@var{path}
1419
1420Connect to a local tty device.
1421
1422@option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and
1423DragonFlyBSD hosts.
1424
1425@option{path} specifies the path to the tty. @option{path} is required.
1426
1427@item -chardev parport ,id=@var{id} ,path=@var{path}
1428
1429@option{parport} is only available on Linux, FreeBSD and DragonFlyBSD hosts.
1430
1431Connect to a local parallel port.
1432
1433@option{path} specifies the path to the parallel port device. @option{path} is
1434required.
1435
1436@end table
1437ETEXI
1438
1439DEFHEADING()
1440
1441DEFHEADING(Bluetooth(R) options:)
1442
blueswir15824d652009-03-28 06:44:27 +00001443DEF("bt", HAS_ARG, QEMU_OPTION_bt, \
blueswir15824d652009-03-28 06:44:27 +00001444 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \
1445 "-bt hci,host[:id]\n" \
1446 " use host's HCI with the given name\n" \
1447 "-bt hci[,vlan=n]\n" \
1448 " emulate a standard HCI in virtual scatternet 'n'\n" \
1449 "-bt vhci[,vlan=n]\n" \
1450 " add host computer to virtual scatternet 'n' using VHCI\n" \
1451 "-bt device:dev[,vlan=n]\n" \
Blue Swirlad960902010-03-29 19:23:52 +00001452 " emulate a bluetooth device 'dev' in scatternet 'n'\n",
1453 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001454STEXI
blueswir15824d652009-03-28 06:44:27 +00001455@table @option
1456
1457@item -bt hci[...]
Stefan Weil6616b2a2010-02-05 23:52:05 +01001458@findex -bt
blueswir15824d652009-03-28 06:44:27 +00001459Defines the function of the corresponding Bluetooth HCI. -bt options
1460are matched with the HCIs present in the chosen machine type. For
1461example when emulating a machine with only one HCI built into it, only
1462the first @code{-bt hci[...]} option is valid and defines the HCI's
1463logic. The Transport Layer is decided by the machine type. Currently
1464the machines @code{n800} and @code{n810} have one HCI and all other
1465machines have none.
1466
1467@anchor{bt-hcis}
1468The following three types are recognized:
1469
Kevin Wolfb3f046c2009-10-09 10:58:35 +02001470@table @option
blueswir15824d652009-03-28 06:44:27 +00001471@item -bt hci,null
1472(default) The corresponding Bluetooth HCI assumes no internal logic
1473and will not respond to any HCI commands or emit events.
1474
1475@item -bt hci,host[:@var{id}]
1476(@code{bluez} only) The corresponding HCI passes commands / events
1477to / from the physical HCI identified by the name @var{id} (default:
1478@code{hci0}) on the computer running QEMU. Only available on @code{bluez}
1479capable systems like Linux.
1480
1481@item -bt hci[,vlan=@var{n}]
1482Add a virtual, standard HCI that will participate in the Bluetooth
1483scatternet @var{n} (default @code{0}). Similarly to @option{-net}
1484VLANs, devices inside a bluetooth network @var{n} can only communicate
1485with other devices in the same network (scatternet).
1486@end table
1487
1488@item -bt vhci[,vlan=@var{n}]
1489(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
1490to the host bluetooth stack instead of to the emulated target. This
1491allows the host and target machines to participate in a common scatternet
1492and communicate. Requires the Linux @code{vhci} driver installed. Can
1493be used as following:
1494
1495@example
1496qemu [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
1497@end example
1498
1499@item -bt device:@var{dev}[,vlan=@var{n}]
1500Emulate a bluetooth device @var{dev} and place it in network @var{n}
1501(default @code{0}). QEMU can only emulate one type of bluetooth devices
1502currently:
1503
Kevin Wolfb3f046c2009-10-09 10:58:35 +02001504@table @option
blueswir15824d652009-03-28 06:44:27 +00001505@item keyboard
1506Virtual wireless keyboard implementing the HIDP bluetooth profile.
1507@end table
1508@end table
1509ETEXI
1510
1511DEFHEADING()
1512
Alexander Graf7677f052009-06-28 16:55:55 +02001513DEFHEADING(Linux/Multiboot boot specific:)
blueswir15824d652009-03-28 06:44:27 +00001514STEXI
Alexander Graf7677f052009-06-28 16:55:55 +02001515
1516When using these options, you can use a given Linux or Multiboot
1517kernel without installing it in the disk image. It can be useful
blueswir15824d652009-03-28 06:44:27 +00001518for easier testing of various kernels.
1519
1520@table @option
1521ETEXI
1522
1523DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \
Blue Swirlad960902010-03-29 19:23:52 +00001524 "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001525STEXI
1526@item -kernel @var{bzImage}
Stefan Weil6616b2a2010-02-05 23:52:05 +01001527@findex -kernel
Alexander Graf7677f052009-06-28 16:55:55 +02001528Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel
1529or in multiboot format.
blueswir15824d652009-03-28 06:44:27 +00001530ETEXI
1531
1532DEF("append", HAS_ARG, QEMU_OPTION_append, \
Blue Swirlad960902010-03-29 19:23:52 +00001533 "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001534STEXI
1535@item -append @var{cmdline}
Stefan Weil6616b2a2010-02-05 23:52:05 +01001536@findex -append
blueswir15824d652009-03-28 06:44:27 +00001537Use @var{cmdline} as kernel command line
1538ETEXI
1539
1540DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \
Blue Swirlad960902010-03-29 19:23:52 +00001541 "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001542STEXI
1543@item -initrd @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01001544@findex -initrd
blueswir15824d652009-03-28 06:44:27 +00001545Use @var{file} as initial ram disk.
Alexander Graf7677f052009-06-28 16:55:55 +02001546
1547@item -initrd "@var{file1} arg=foo,@var{file2}"
1548
1549This syntax is only available with multiboot.
1550
1551Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the
1552first module.
blueswir15824d652009-03-28 06:44:27 +00001553ETEXI
1554
1555STEXI
1556@end table
1557ETEXI
1558
1559DEFHEADING()
1560
1561DEFHEADING(Debug/Expert options:)
1562
1563STEXI
1564@table @option
1565ETEXI
1566
1567DEF("serial", HAS_ARG, QEMU_OPTION_serial, \
Blue Swirlad960902010-03-29 19:23:52 +00001568 "-serial dev redirect the serial port to char device 'dev'\n",
1569 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001570STEXI
1571@item -serial @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01001572@findex -serial
blueswir15824d652009-03-28 06:44:27 +00001573Redirect the virtual serial port to host character device
1574@var{dev}. The default device is @code{vc} in graphical mode and
1575@code{stdio} in non graphical mode.
1576
1577This option can be used several times to simulate up to 4 serial
1578ports.
1579
1580Use @code{-serial none} to disable all serial ports.
1581
1582Available character devices are:
Kevin Wolfb3f046c2009-10-09 10:58:35 +02001583@table @option
Kevin Wolf4e257e52009-10-09 10:58:36 +02001584@item vc[:@var{W}x@var{H}]
blueswir15824d652009-03-28 06:44:27 +00001585Virtual console. Optionally, a width and height can be given in pixel with
1586@example
1587vc:800x600
1588@end example
1589It is also possible to specify width or height in characters:
1590@example
1591vc:80Cx24C
1592@end example
1593@item pty
1594[Linux only] Pseudo TTY (a new PTY is automatically allocated)
1595@item none
1596No device is allocated.
1597@item null
1598void device
1599@item /dev/XXX
1600[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
1601parameters are set according to the emulated ones.
1602@item /dev/parport@var{N}
1603[Linux only, parallel port only] Use host parallel port
1604@var{N}. Currently SPP and EPP parallel port features can be used.
1605@item file:@var{filename}
1606Write output to @var{filename}. No character can be read.
1607@item stdio
1608[Unix only] standard input/output
1609@item pipe:@var{filename}
1610name pipe @var{filename}
1611@item COM@var{n}
1612[Windows only] Use host serial port @var{n}
1613@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
1614This implements UDP Net Console.
1615When @var{remote_host} or @var{src_ip} are not specified
1616they default to @code{0.0.0.0}.
1617When not using a specified @var{src_port} a random port is automatically chosen.
blueswir15824d652009-03-28 06:44:27 +00001618
1619If you just want a simple readonly console you can use @code{netcat} or
1620@code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
1621@code{nc -u -l -p 4555}. Any time qemu writes something to that port it
1622will appear in the netconsole session.
1623
1624If you plan to send characters back via netconsole or you want to stop
1625and start qemu a lot of times, you should have qemu use the same
1626source port each time by using something like @code{-serial
1627udp::4555@@:4556} to qemu. Another approach is to use a patched
1628version of netcat which can listen to a TCP port and send and receive
1629characters via udp. If you have a patched version of netcat which
1630activates telnet remote echo and single char transfer, then you can
1631use the following options to step up a netcat redirector to allow
1632telnet on port 5555 to access the qemu port.
1633@table @code
1634@item Qemu Options:
1635-serial udp::4555@@:4556
1636@item netcat options:
1637-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
1638@item telnet options:
1639localhost 5555
1640@end table
1641
1642@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay]
1643The TCP Net Console has two modes of operation. It can send the serial
1644I/O to a location or wait for a connection from a location. By default
1645the TCP Net Console is sent to @var{host} at the @var{port}. If you use
1646the @var{server} option QEMU will wait for a client socket application
1647to connect to the port before continuing, unless the @code{nowait}
1648option was specified. The @code{nodelay} option disables the Nagle buffering
1649algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only
1650one TCP connection at a time is accepted. You can use @code{telnet} to
1651connect to the corresponding character device.
1652@table @code
1653@item Example to send tcp console to 192.168.0.2 port 4444
1654-serial tcp:192.168.0.2:4444
1655@item Example to listen and wait on port 4444 for connection
1656-serial tcp::4444,server
1657@item Example to not wait and listen on ip 192.168.0.100 port 4444
1658-serial tcp:192.168.0.100:4444,server,nowait
1659@end table
1660
1661@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
1662The telnet protocol is used instead of raw tcp sockets. The options
1663work the same as if you had specified @code{-serial tcp}. The
1664difference is that the port acts like a telnet server or client using
1665telnet option negotiation. This will also allow you to send the
1666MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
1667sequence. Typically in unix telnet you do it with Control-] and then
1668type "send break" followed by pressing the enter key.
1669
1670@item unix:@var{path}[,server][,nowait]
1671A unix domain socket is used instead of a tcp socket. The option works the
1672same as if you had specified @code{-serial tcp} except the unix domain socket
1673@var{path} is used for connections.
1674
1675@item mon:@var{dev_string}
1676This is a special option to allow the monitor to be multiplexed onto
1677another serial port. The monitor is accessed with key sequence of
1678@key{Control-a} and then pressing @key{c}. See monitor access
1679@ref{pcsys_keys} in the -nographic section for more keys.
1680@var{dev_string} should be any one of the serial devices specified
1681above. An example to multiplex the monitor onto a telnet server
1682listening on port 4444 would be:
1683@table @code
1684@item -serial mon:telnet::4444,server,nowait
1685@end table
1686
1687@item braille
1688Braille device. This will use BrlAPI to display the braille output on a real
1689or fake device.
1690
Kevin Wolfbe8b28a2009-10-09 10:58:37 +02001691@item msmouse
1692Three button serial mouse. Configure the guest to use Microsoft protocol.
blueswir15824d652009-03-28 06:44:27 +00001693@end table
1694ETEXI
1695
1696DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \
Blue Swirlad960902010-03-29 19:23:52 +00001697 "-parallel dev redirect the parallel port to char device 'dev'\n",
1698 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001699STEXI
1700@item -parallel @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01001701@findex -parallel
blueswir15824d652009-03-28 06:44:27 +00001702Redirect the virtual parallel port to host device @var{dev} (same
1703devices as the serial port). On Linux hosts, @file{/dev/parportN} can
1704be used to use hardware devices connected on the corresponding host
1705parallel port.
1706
1707This option can be used several times to simulate up to 3 parallel
1708ports.
1709
1710Use @code{-parallel none} to disable all parallel ports.
1711ETEXI
1712
1713DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \
Blue Swirlad960902010-03-29 19:23:52 +00001714 "-monitor dev redirect the monitor to char device 'dev'\n",
1715 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001716STEXI
Gerd Hoffmann4e307fc2009-12-08 13:11:37 +01001717@item -monitor @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01001718@findex -monitor
blueswir15824d652009-03-28 06:44:27 +00001719Redirect the monitor to host device @var{dev} (same devices as the
1720serial port).
1721The default device is @code{vc} in graphical mode and @code{stdio} in
1722non graphical mode.
1723ETEXI
Gerd Hoffmann6ca55822009-12-08 13:11:52 +01001724DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \
Blue Swirlad960902010-03-29 19:23:52 +00001725 "-qmp dev like -monitor but opens in 'control' mode\n",
1726 QEMU_ARCH_ALL)
Stefan Weil95d5f082010-01-20 22:25:27 +01001727STEXI
1728@item -qmp @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01001729@findex -qmp
Stefan Weil95d5f082010-01-20 22:25:27 +01001730Like -monitor but opens in 'control' mode.
1731ETEXI
blueswir15824d652009-03-28 06:44:27 +00001732
Gerd Hoffmann22a0e042009-12-08 13:11:51 +01001733DEF("mon", HAS_ARG, QEMU_OPTION_mon, \
Blue Swirlad960902010-03-29 19:23:52 +00001734 "-mon chardev=[name][,mode=readline|control][,default]\n", QEMU_ARCH_ALL)
Gerd Hoffmann22a0e042009-12-08 13:11:51 +01001735STEXI
1736@item -mon chardev=[name][,mode=readline|control][,default]
Stefan Weil6616b2a2010-02-05 23:52:05 +01001737@findex -mon
Gerd Hoffmann22a0e042009-12-08 13:11:51 +01001738Setup monitor on chardev @var{name}.
1739ETEXI
1740
H. Peter Anvinc9f398e2009-12-29 13:51:36 -08001741DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \
Blue Swirlad960902010-03-29 19:23:52 +00001742 "-debugcon dev redirect the debug console to char device 'dev'\n",
1743 QEMU_ARCH_ALL)
H. Peter Anvinc9f398e2009-12-29 13:51:36 -08001744STEXI
1745@item -debugcon @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01001746@findex -debugcon
H. Peter Anvinc9f398e2009-12-29 13:51:36 -08001747Redirect the debug console to host device @var{dev} (same devices as the
1748serial port). The debug console is an I/O port which is typically port
17490xe9; writing to that I/O port sends output to this device.
1750The default device is @code{vc} in graphical mode and @code{stdio} in
1751non graphical mode.
1752ETEXI
1753
blueswir15824d652009-03-28 06:44:27 +00001754DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \
Blue Swirlad960902010-03-29 19:23:52 +00001755 "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001756STEXI
1757@item -pidfile @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01001758@findex -pidfile
blueswir15824d652009-03-28 06:44:27 +00001759Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
1760from a script.
1761ETEXI
1762
aurel321b530a62009-04-05 20:08:59 +00001763DEF("singlestep", 0, QEMU_OPTION_singlestep, \
Blue Swirlad960902010-03-29 19:23:52 +00001764 "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL)
aurel321b530a62009-04-05 20:08:59 +00001765STEXI
1766@item -singlestep
Stefan Weil6616b2a2010-02-05 23:52:05 +01001767@findex -singlestep
aurel321b530a62009-04-05 20:08:59 +00001768Run the emulation in single step mode.
1769ETEXI
1770
blueswir15824d652009-03-28 06:44:27 +00001771DEF("S", 0, QEMU_OPTION_S, \
Blue Swirlad960902010-03-29 19:23:52 +00001772 "-S freeze CPU at startup (use 'c' to start execution)\n",
1773 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001774STEXI
1775@item -S
Stefan Weil6616b2a2010-02-05 23:52:05 +01001776@findex -S
blueswir15824d652009-03-28 06:44:27 +00001777Do not start CPU at startup (you must type 'c' in the monitor).
1778ETEXI
1779
aliguori59030a82009-04-05 18:43:41 +00001780DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \
Blue Swirlad960902010-03-29 19:23:52 +00001781 "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001782STEXI
aliguori59030a82009-04-05 18:43:41 +00001783@item -gdb @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01001784@findex -gdb
aliguori59030a82009-04-05 18:43:41 +00001785Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical
1786connections will likely be TCP-based, but also UDP, pseudo TTY, or even
1787stdio are reasonable use case. The latter is allowing to start qemu from
1788within gdb and establish the connection via a pipe:
1789@example
1790(gdb) target remote | exec qemu -gdb stdio ...
1791@end example
blueswir15824d652009-03-28 06:44:27 +00001792ETEXI
1793
aliguori59030a82009-04-05 18:43:41 +00001794DEF("s", 0, QEMU_OPTION_s, \
Blue Swirlad960902010-03-29 19:23:52 +00001795 "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n",
1796 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001797STEXI
aliguori59030a82009-04-05 18:43:41 +00001798@item -s
Stefan Weil6616b2a2010-02-05 23:52:05 +01001799@findex -s
aliguori59030a82009-04-05 18:43:41 +00001800Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
1801(@pxref{gdb_usage}).
blueswir15824d652009-03-28 06:44:27 +00001802ETEXI
1803
1804DEF("d", HAS_ARG, QEMU_OPTION_d, \
Blue Swirlad960902010-03-29 19:23:52 +00001805 "-d item1,... output log to /tmp/qemu.log (use -d ? for a list of log items)\n",
1806 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001807STEXI
1808@item -d
Stefan Weil6616b2a2010-02-05 23:52:05 +01001809@findex -d
blueswir15824d652009-03-28 06:44:27 +00001810Output log in /tmp/qemu.log
1811ETEXI
1812
1813DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \
1814 "-hdachs c,h,s[,t]\n" \
1815 " force hard disk 0 physical geometry and the optional BIOS\n" \
Blue Swirlad960902010-03-29 19:23:52 +00001816 " translation (t=none or lba) (usually qemu can guess them)\n",
1817 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001818STEXI
1819@item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
Stefan Weil6616b2a2010-02-05 23:52:05 +01001820@findex -hdachs
blueswir15824d652009-03-28 06:44:27 +00001821Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
1822@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
1823translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
1824all those parameters. This option is useful for old MS-DOS disk
1825images.
1826ETEXI
1827
1828DEF("L", HAS_ARG, QEMU_OPTION_L, \
Blue Swirlad960902010-03-29 19:23:52 +00001829 "-L path set the directory for the BIOS, VGA BIOS and keymaps\n",
1830 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001831STEXI
1832@item -L @var{path}
Stefan Weil6616b2a2010-02-05 23:52:05 +01001833@findex -L
blueswir15824d652009-03-28 06:44:27 +00001834Set the directory for the BIOS, VGA BIOS and keymaps.
1835ETEXI
1836
1837DEF("bios", HAS_ARG, QEMU_OPTION_bios, \
Blue Swirlad960902010-03-29 19:23:52 +00001838 "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001839STEXI
1840@item -bios @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01001841@findex -bios
blueswir15824d652009-03-28 06:44:27 +00001842Set the filename for the BIOS.
1843ETEXI
1844
blueswir15824d652009-03-28 06:44:27 +00001845DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \
Blue Swirlad960902010-03-29 19:23:52 +00001846 "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001847STEXI
1848@item -enable-kvm
Stefan Weil6616b2a2010-02-05 23:52:05 +01001849@findex -enable-kvm
blueswir15824d652009-03-28 06:44:27 +00001850Enable KVM full virtualization support. This option is only available
1851if KVM support is enabled when compiling.
1852ETEXI
1853
aliguorie37630c2009-04-22 15:19:10 +00001854DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid,
Blue Swirlad960902010-03-29 19:23:52 +00001855 "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL)
aliguorie37630c2009-04-22 15:19:10 +00001856DEF("xen-create", 0, QEMU_OPTION_xen_create,
1857 "-xen-create create domain using xen hypercalls, bypassing xend\n"
Blue Swirlad960902010-03-29 19:23:52 +00001858 " warning: should not be used when xend is in use\n",
1859 QEMU_ARCH_ALL)
aliguorie37630c2009-04-22 15:19:10 +00001860DEF("xen-attach", 0, QEMU_OPTION_xen_attach,
1861 "-xen-attach attach to existing xen domain\n"
Blue Swirlad960902010-03-29 19:23:52 +00001862 " xend will use this when starting qemu\n",
1863 QEMU_ARCH_ALL)
Stefan Weil95d5f082010-01-20 22:25:27 +01001864STEXI
1865@item -xen-domid @var{id}
Stefan Weil6616b2a2010-02-05 23:52:05 +01001866@findex -xen-domid
Stefan Weil95d5f082010-01-20 22:25:27 +01001867Specify xen guest domain @var{id} (XEN only).
1868@item -xen-create
Stefan Weil6616b2a2010-02-05 23:52:05 +01001869@findex -xen-create
Stefan Weil95d5f082010-01-20 22:25:27 +01001870Create domain using xen hypercalls, bypassing xend.
1871Warning: should not be used when xend is in use (XEN only).
1872@item -xen-attach
Stefan Weil6616b2a2010-02-05 23:52:05 +01001873@findex -xen-attach
Stefan Weil95d5f082010-01-20 22:25:27 +01001874Attach to existing xen domain.
1875xend will use this when starting qemu (XEN only).
1876ETEXI
aliguorie37630c2009-04-22 15:19:10 +00001877
blueswir15824d652009-03-28 06:44:27 +00001878DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \
Blue Swirlad960902010-03-29 19:23:52 +00001879 "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001880STEXI
1881@item -no-reboot
Stefan Weil6616b2a2010-02-05 23:52:05 +01001882@findex -no-reboot
blueswir15824d652009-03-28 06:44:27 +00001883Exit instead of rebooting.
1884ETEXI
1885
1886DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \
Blue Swirlad960902010-03-29 19:23:52 +00001887 "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001888STEXI
1889@item -no-shutdown
Stefan Weil6616b2a2010-02-05 23:52:05 +01001890@findex -no-shutdown
blueswir15824d652009-03-28 06:44:27 +00001891Don't exit QEMU on guest shutdown, but instead only stop the emulation.
1892This allows for instance switching to monitor to commit changes to the
1893disk image.
1894ETEXI
1895
1896DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \
1897 "-loadvm [tag|id]\n" \
Blue Swirlad960902010-03-29 19:23:52 +00001898 " start right away with a saved state (loadvm in monitor)\n",
1899 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001900STEXI
1901@item -loadvm @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01001902@findex -loadvm
blueswir15824d652009-03-28 06:44:27 +00001903Start right away with a saved state (@code{loadvm} in monitor)
1904ETEXI
1905
1906#ifndef _WIN32
1907DEF("daemonize", 0, QEMU_OPTION_daemonize, \
Blue Swirlad960902010-03-29 19:23:52 +00001908 "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001909#endif
1910STEXI
1911@item -daemonize
Stefan Weil6616b2a2010-02-05 23:52:05 +01001912@findex -daemonize
blueswir15824d652009-03-28 06:44:27 +00001913Daemonize the QEMU process after initialization. QEMU will not detach from
1914standard IO until it is ready to receive connections on any of its devices.
1915This option is a useful way for external programs to launch QEMU without having
1916to cope with initialization race conditions.
1917ETEXI
1918
1919DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \
Blue Swirlad960902010-03-29 19:23:52 +00001920 "-option-rom rom load a file, rom, into the option ROM space\n",
1921 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001922STEXI
1923@item -option-rom @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01001924@findex -option-rom
blueswir15824d652009-03-28 06:44:27 +00001925Load the contents of @var{file} as an option ROM.
1926This option is useful to load things like EtherBoot.
1927ETEXI
1928
1929DEF("clock", HAS_ARG, QEMU_OPTION_clock, \
1930 "-clock force the use of the given methods for timer alarm.\n" \
Blue Swirlad960902010-03-29 19:23:52 +00001931 " To see what timers are available use -clock ?\n",
1932 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001933STEXI
1934@item -clock @var{method}
Stefan Weil6616b2a2010-02-05 23:52:05 +01001935@findex -clock
blueswir15824d652009-03-28 06:44:27 +00001936Force the use of the given methods for timer alarm. To see what timers
1937are available use -clock ?.
1938ETEXI
1939
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02001940HXCOMM Options deprecated by -rtc
Blue Swirlad960902010-03-29 19:23:52 +00001941DEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL)
1942DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001943
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02001944DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \
Jan Kiszka68752042009-09-15 13:36:04 +02001945 "-rtc [base=utc|localtime|date][,clock=host|vm][,driftfix=none|slew]\n" \
Blue Swirlad960902010-03-29 19:23:52 +00001946 " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n",
1947 QEMU_ARCH_ALL)
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02001948
blueswir15824d652009-03-28 06:44:27 +00001949STEXI
1950
Jan Kiszka68752042009-09-15 13:36:04 +02001951@item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew]
Stefan Weil6616b2a2010-02-05 23:52:05 +01001952@findex -rtc
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02001953Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current
1954UTC or local time, respectively. @code{localtime} is required for correct date in
1955MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the
1956format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC.
1957
Jan Kiszka68752042009-09-15 13:36:04 +02001958By default the RTC is driven by the host system time. This allows to use the
1959RTC as accurate reference clock inside the guest, specifically if the host
1960time is smoothly following an accurate external reference clock, e.g. via NTP.
1961If you want to isolate the guest time from the host, even prevent it from
1962progressing during suspension, you can set @option{clock} to @code{vm} instead.
1963
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02001964Enable @option{driftfix} (i386 targets only) if you experience time drift problems,
1965specifically with Windows' ACPI HAL. This option will try to figure out how
1966many timer interrupts were not processed by the Windows guest and will
1967re-inject them.
blueswir15824d652009-03-28 06:44:27 +00001968ETEXI
1969
1970DEF("icount", HAS_ARG, QEMU_OPTION_icount, \
1971 "-icount [N|auto]\n" \
aliguoribc14ca22009-04-05 18:43:37 +00001972 " enable virtual instruction counter with 2^N clock ticks per\n" \
Blue Swirlad960902010-03-29 19:23:52 +00001973 " instruction\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001974STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +02001975@item -icount [@var{N}|auto]
Stefan Weil6616b2a2010-02-05 23:52:05 +01001976@findex -icount
blueswir15824d652009-03-28 06:44:27 +00001977Enable virtual instruction counter. The virtual cpu will execute one
Kevin Wolf4e257e52009-10-09 10:58:36 +02001978instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified
blueswir15824d652009-03-28 06:44:27 +00001979then the virtual cpu speed will be automatically adjusted to keep virtual
1980time within a few seconds of real time.
1981
1982Note that while this option can give deterministic behavior, it does not
1983provide cycle accurate emulation. Modern CPUs contain superscalar out of
1984order cores with complex cache hierarchies. The number of instructions
1985executed often has little or no correlation with actual performance.
1986ETEXI
1987
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01001988DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \
1989 "-watchdog i6300esb|ib700\n" \
Blue Swirlad960902010-03-29 19:23:52 +00001990 " enable virtual hardware watchdog [default=none]\n",
1991 QEMU_ARCH_ALL)
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01001992STEXI
1993@item -watchdog @var{model}
Stefan Weil6616b2a2010-02-05 23:52:05 +01001994@findex -watchdog
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01001995Create a virtual hardware watchdog device. Once enabled (by a guest
1996action), the watchdog must be periodically polled by an agent inside
1997the guest or else the guest will be restarted.
1998
1999The @var{model} is the model of hardware watchdog to emulate. Choices
2000for model are: @code{ib700} (iBASE 700) which is a very simple ISA
2001watchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O
2002controller hub) which is a much more featureful PCI-based dual-timer
2003watchdog. Choose a model for which your guest has drivers.
2004
2005Use @code{-watchdog ?} to list available hardware models. Only one
2006watchdog can be enabled for a guest.
2007ETEXI
2008
2009DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \
2010 "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \
Blue Swirlad960902010-03-29 19:23:52 +00002011 " action when watchdog fires [default=reset]\n",
2012 QEMU_ARCH_ALL)
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01002013STEXI
2014@item -watchdog-action @var{action}
2015
2016The @var{action} controls what QEMU will do when the watchdog timer
2017expires.
2018The default is
2019@code{reset} (forcefully reset the guest).
2020Other possible actions are:
2021@code{shutdown} (attempt to gracefully shutdown the guest),
2022@code{poweroff} (forcefully poweroff the guest),
2023@code{pause} (pause the guest),
2024@code{debug} (print a debug message and continue), or
2025@code{none} (do nothing).
2026
2027Note that the @code{shutdown} action requires that the guest responds
2028to ACPI signals, which it may not be able to do in the sort of
2029situations where the watchdog would have expired, and thus
2030@code{-watchdog-action shutdown} is not recommended for production use.
2031
2032Examples:
2033
2034@table @code
2035@item -watchdog i6300esb -watchdog-action pause
2036@item -watchdog ib700
2037@end table
2038ETEXI
2039
blueswir15824d652009-03-28 06:44:27 +00002040DEF("echr", HAS_ARG, QEMU_OPTION_echr, \
Blue Swirlad960902010-03-29 19:23:52 +00002041 "-echr chr set terminal escape character instead of ctrl-a\n",
2042 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002043STEXI
2044
Kevin Wolf4e257e52009-10-09 10:58:36 +02002045@item -echr @var{numeric_ascii_value}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002046@findex -echr
blueswir15824d652009-03-28 06:44:27 +00002047Change the escape character used for switching to the monitor when using
2048monitor and serial sharing. The default is @code{0x01} when using the
2049@code{-nographic} option. @code{0x01} is equal to pressing
2050@code{Control-a}. You can select a different character from the ascii
2051control keys where 1 through 26 map to Control-a through Control-z. For
2052instance you could use the either of the following to change the escape
2053character to Control-t.
2054@table @code
2055@item -echr 0x14
2056@item -echr 20
2057@end table
2058ETEXI
2059
2060DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \
2061 "-virtioconsole c\n" \
Blue Swirlad960902010-03-29 19:23:52 +00002062 " set virtio console\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002063STEXI
2064@item -virtioconsole @var{c}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002065@findex -virtioconsole
blueswir15824d652009-03-28 06:44:27 +00002066Set virtio console.
Amit Shah98b19252010-01-20 00:36:52 +05302067
2068This option is maintained for backward compatibility.
2069
2070Please use @code{-device virtconsole} for the new way of invocation.
blueswir15824d652009-03-28 06:44:27 +00002071ETEXI
2072
2073DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \
Blue Swirlad960902010-03-29 19:23:52 +00002074 "-show-cursor show cursor\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002075STEXI
Stefan Weil95d5f082010-01-20 22:25:27 +01002076@item -show-cursor
Stefan Weil6616b2a2010-02-05 23:52:05 +01002077@findex -show-cursor
Stefan Weil95d5f082010-01-20 22:25:27 +01002078Show cursor.
blueswir15824d652009-03-28 06:44:27 +00002079ETEXI
2080
2081DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \
Blue Swirlad960902010-03-29 19:23:52 +00002082 "-tb-size n set TB size\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002083STEXI
Stefan Weil95d5f082010-01-20 22:25:27 +01002084@item -tb-size @var{n}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002085@findex -tb-size
Stefan Weil95d5f082010-01-20 22:25:27 +01002086Set TB size.
blueswir15824d652009-03-28 06:44:27 +00002087ETEXI
2088
2089DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \
Blue Swirlad960902010-03-29 19:23:52 +00002090 "-incoming p prepare for incoming migration, listen on port p\n",
2091 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002092STEXI
Stefan Weil95d5f082010-01-20 22:25:27 +01002093@item -incoming @var{port}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002094@findex -incoming
Stefan Weil95d5f082010-01-20 22:25:27 +01002095Prepare for incoming migration, listen on @var{port}.
blueswir15824d652009-03-28 06:44:27 +00002096ETEXI
2097
Gerd Hoffmannd8c208d2009-12-08 13:11:46 +01002098DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \
Blue Swirlad960902010-03-29 19:23:52 +00002099 "-nodefaults don't create default devices\n", QEMU_ARCH_ALL)
Gerd Hoffmannd8c208d2009-12-08 13:11:46 +01002100STEXI
Stefan Weil3dbf2c72010-01-16 18:19:44 +01002101@item -nodefaults
Stefan Weil6616b2a2010-02-05 23:52:05 +01002102@findex -nodefaults
Stefan Weil3dbf2c72010-01-16 18:19:44 +01002103Don't create default devices.
Gerd Hoffmannd8c208d2009-12-08 13:11:46 +01002104ETEXI
2105
blueswir15824d652009-03-28 06:44:27 +00002106#ifndef _WIN32
2107DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \
Blue Swirlad960902010-03-29 19:23:52 +00002108 "-chroot dir chroot to dir just before starting the VM\n",
2109 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002110#endif
2111STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +02002112@item -chroot @var{dir}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002113@findex -chroot
blueswir15824d652009-03-28 06:44:27 +00002114Immediately before starting guest execution, chroot to the specified
2115directory. Especially useful in combination with -runas.
2116ETEXI
2117
2118#ifndef _WIN32
2119DEF("runas", HAS_ARG, QEMU_OPTION_runas, \
Blue Swirlad960902010-03-29 19:23:52 +00002120 "-runas user change to user id user just before starting the VM\n",
2121 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002122#endif
2123STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +02002124@item -runas @var{user}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002125@findex -runas
blueswir15824d652009-03-28 06:44:27 +00002126Immediately before starting guest execution, drop root privileges, switching
2127to the specified user.
2128ETEXI
2129
blueswir15824d652009-03-28 06:44:27 +00002130DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env,
2131 "-prom-env variable=value\n"
Blue Swirlad960902010-03-29 19:23:52 +00002132 " set OpenBIOS nvram variables\n",
2133 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
Stefan Weil95d5f082010-01-20 22:25:27 +01002134STEXI
2135@item -prom-env @var{variable}=@var{value}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002136@findex -prom-env
Stefan Weil95d5f082010-01-20 22:25:27 +01002137Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only).
2138ETEXI
blueswir15824d652009-03-28 06:44:27 +00002139DEF("semihosting", 0, QEMU_OPTION_semihosting,
Blue Swirlad960902010-03-29 19:23:52 +00002140 "-semihosting semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K)
Stefan Weil95d5f082010-01-20 22:25:27 +01002141STEXI
2142@item -semihosting
Stefan Weil6616b2a2010-02-05 23:52:05 +01002143@findex -semihosting
Stefan Weil95d5f082010-01-20 22:25:27 +01002144Semihosting mode (ARM, M68K only).
2145ETEXI
blueswir15824d652009-03-28 06:44:27 +00002146DEF("old-param", 0, QEMU_OPTION_old_param,
Blue Swirlad960902010-03-29 19:23:52 +00002147 "-old-param old param mode\n", QEMU_ARCH_ARM)
Stefan Weil95d5f082010-01-20 22:25:27 +01002148STEXI
2149@item -old-param
Stefan Weil6616b2a2010-02-05 23:52:05 +01002150@findex -old-param (ARM)
Stefan Weil95d5f082010-01-20 22:25:27 +01002151Old param mode (ARM only).
2152ETEXI
2153
Gerd Hoffmann715a6642009-10-14 10:39:28 +02002154DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig,
Blue Swirlad960902010-03-29 19:23:52 +00002155 "-readconfig <file>\n", QEMU_ARCH_ALL)
Stefan Weil3dbf2c72010-01-16 18:19:44 +01002156STEXI
2157@item -readconfig @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002158@findex -readconfig
Stefan Weil3dbf2c72010-01-16 18:19:44 +01002159Read device configuration from @var{file}.
2160ETEXI
Gerd Hoffmann715a6642009-10-14 10:39:28 +02002161DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig,
2162 "-writeconfig <file>\n"
Blue Swirlad960902010-03-29 19:23:52 +00002163 " read/write config file\n", QEMU_ARCH_ALL)
Stefan Weil3dbf2c72010-01-16 18:19:44 +01002164STEXI
2165@item -writeconfig @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002166@findex -writeconfig
Stefan Weil3dbf2c72010-01-16 18:19:44 +01002167Write device configuration to @var{file}.
2168ETEXI
Anthony Liguori292444c2010-01-21 10:57:58 -06002169DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig,
2170 "-nodefconfig\n"
Blue Swirlad960902010-03-29 19:23:52 +00002171 " do not load default config files at startup\n",
2172 QEMU_ARCH_ALL)
Anthony Liguori292444c2010-01-21 10:57:58 -06002173STEXI
2174@item -nodefconfig
Stefan Weil6616b2a2010-02-05 23:52:05 +01002175@findex -nodefconfig
Anthony Liguori292444c2010-01-21 10:57:58 -06002176Normally QEMU loads a configuration file from @var{sysconfdir}/qemu.conf and
2177@var{sysconfdir}/target-@var{ARCH}.conf on startup. The @code{-nodefconfig}
2178option will prevent QEMU from loading these configuration files at startup.
2179ETEXI
Stefan Weil3dbf2c72010-01-16 18:19:44 +01002180
2181HXCOMM This is the last statement. Insert new options before this line!
2182STEXI
2183@end table
2184ETEXI