blob: 4bb36175ba3a1601f90993fbd289f71ed12a854c [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
Jan Kiszka80f52a62011-07-23 12:39:46 +020030DEF("machine", HAS_ARG, QEMU_OPTION_machine, \
31 "-machine [type=]name[,prop[=value][,...]]\n"
32 " selects emulated machine (-machine ? for list)\n"
33 " property accel=accel1[:accel2[:...]] selects accelerator\n"
Jan Kiszka6a48ffa2011-10-15 13:43:48 +020034 " supported accelerators are kvm, xen, tcg (default: tcg)\n"
35 " kernel_irqchip=on|off controls accelerated irqchip support\n",
Jan Kiszka80f52a62011-07-23 12:39:46 +020036 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +000037STEXI
Jan Kiszka80f52a62011-07-23 12:39:46 +020038@item -machine [type=]@var{name}[,prop=@var{value}[,...]]
39@findex -machine
40Select the emulated machine by @var{name}. Use @code{-machine ?} to list
41available machines. Supported machine properties are:
42@table @option
43@item accel=@var{accels1}[:@var{accels2}[:...]]
44This is used to enable an accelerator. Depending on the target architecture,
45kvm, xen, or tcg can be available. By default, tcg is used. If there is more
46than one accelerator specified, the next one is used if the previous one fails
47to initialize.
Jan Kiszka6a48ffa2011-10-15 13:43:48 +020048@item kernel_irqchip=on|off
49Enables in-kernel irqchip support for the chosen accelerator when available.
Jan Kiszka80f52a62011-07-23 12:39:46 +020050@end table
blueswir15824d652009-03-28 06:44:27 +000051ETEXI
52
Jan Kiszka80f52a62011-07-23 12:39:46 +020053HXCOMM Deprecated by -machine
54DEF("M", HAS_ARG, QEMU_OPTION_M, "", QEMU_ARCH_ALL)
55
blueswir15824d652009-03-28 06:44:27 +000056DEF("cpu", HAS_ARG, QEMU_OPTION_cpu,
Blue Swirlad960902010-03-29 19:23:52 +000057 "-cpu cpu select CPU (-cpu ? for list)\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +000058STEXI
59@item -cpu @var{model}
Stefan Weil6616b2a2010-02-05 23:52:05 +010060@findex -cpu
blueswir15824d652009-03-28 06:44:27 +000061Select CPU model (-cpu ? for list and additional feature selection)
62ETEXI
63
64DEF("smp", HAS_ARG, QEMU_OPTION_smp,
Andre Przywara58a04db2009-08-28 10:49:57 +020065 "-smp n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n"
Jes Sorensen6be68d72009-07-23 17:03:42 +020066 " set the number of CPUs to 'n' [default=1]\n"
67 " maxcpus= maximum number of total cpus, including\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -070068 " offline CPUs for hotplug, etc\n"
Andre Przywara58a04db2009-08-28 10:49:57 +020069 " cores= number of CPU cores on one socket\n"
70 " threads= number of threads on one CPU core\n"
Blue Swirlad960902010-03-29 19:23:52 +000071 " sockets= number of discrete sockets in the system\n",
72 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +000073STEXI
Andre Przywara58a04db2009-08-28 10:49:57 +020074@item -smp @var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}]
Stefan Weil6616b2a2010-02-05 23:52:05 +010075@findex -smp
blueswir15824d652009-03-28 06:44:27 +000076Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
77CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs
78to 4.
Andre Przywara58a04db2009-08-28 10:49:57 +020079For the PC target, the number of @var{cores} per socket, the number
80of @var{threads} per cores and the total number of @var{sockets} can be
81specified. Missing values will be computed. If any on the three values is
82given, the total number of CPUs @var{n} can be omitted. @var{maxcpus}
83specifies the maximum number of hotpluggable CPUs.
blueswir15824d652009-03-28 06:44:27 +000084ETEXI
85
aliguori268a3622009-04-21 22:30:27 +000086DEF("numa", HAS_ARG, QEMU_OPTION_numa,
Blue Swirlad960902010-03-29 19:23:52 +000087 "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL)
aliguori268a3622009-04-21 22:30:27 +000088STEXI
89@item -numa @var{opts}
Stefan Weil6616b2a2010-02-05 23:52:05 +010090@findex -numa
aliguori268a3622009-04-21 22:30:27 +000091Simulate a multi node NUMA system. If mem and cpus are omitted, resources
92are split equally.
93ETEXI
94
blueswir15824d652009-03-28 06:44:27 +000095DEF("fda", HAS_ARG, QEMU_OPTION_fda,
Blue Swirlad960902010-03-29 19:23:52 +000096 "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL)
97DEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +000098STEXI
99@item -fda @var{file}
100@item -fdb @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100101@findex -fda
102@findex -fdb
blueswir15824d652009-03-28 06:44:27 +0000103Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can
104use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}).
105ETEXI
106
107DEF("hda", HAS_ARG, QEMU_OPTION_hda,
Blue Swirlad960902010-03-29 19:23:52 +0000108 "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL)
109DEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000110DEF("hdc", HAS_ARG, QEMU_OPTION_hdc,
Blue Swirlad960902010-03-29 19:23:52 +0000111 "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL)
112DEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000113STEXI
114@item -hda @var{file}
115@item -hdb @var{file}
116@item -hdc @var{file}
117@item -hdd @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100118@findex -hda
119@findex -hdb
120@findex -hdc
121@findex -hdd
blueswir15824d652009-03-28 06:44:27 +0000122Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
123ETEXI
124
125DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom,
Blue Swirlad960902010-03-29 19:23:52 +0000126 "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n",
127 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000128STEXI
129@item -cdrom @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100130@findex -cdrom
blueswir15824d652009-03-28 06:44:27 +0000131Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and
132@option{-cdrom} at the same time). You can use the host CD-ROM by
133using @file{/dev/cdrom} as filename (@pxref{host_drives}).
134ETEXI
135
136DEF("drive", HAS_ARG, QEMU_OPTION_drive,
137 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n"
138 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n"
Stefan Hajnoczi92196b22011-08-04 12:26:52 +0100139 " [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n"
Alexander Graf016f5cf2010-05-26 17:51:49 +0200140 " [,serial=s][,addr=A][,id=name][,aio=threads|native]\n"
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +0000141 " [,readonly=on|off][,copy-on-read=on|off]\n"
Zhi Yong Wu0563e192011-11-03 16:57:25 +0800142 " [[,bps=b]|[[,bps_rd=r][,bps_wr=w]]][[,iops=i]|[[,iops_rd=r][,iops_wr=w]]\n"
Blue Swirlad960902010-03-29 19:23:52 +0000143 " use 'file' as a drive image\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000144STEXI
145@item -drive @var{option}[,@var{option}[,@var{option}[,...]]]
Stefan Weil6616b2a2010-02-05 23:52:05 +0100146@findex -drive
blueswir15824d652009-03-28 06:44:27 +0000147
148Define a new drive. Valid options are:
149
Kevin Wolfb3f046c2009-10-09 10:58:35 +0200150@table @option
blueswir15824d652009-03-28 06:44:27 +0000151@item file=@var{file}
152This option defines which disk image (@pxref{disk_images}) to use with
153this drive. If the filename contains comma, you must double it
154(for instance, "file=my,,file" to use file "my,file").
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +1100155
156Special files such as iSCSI devices can be specified using protocol
157specific URLs. See the section for "Device URL Syntax" for more information.
blueswir15824d652009-03-28 06:44:27 +0000158@item if=@var{interface}
159This option defines on which type on interface the drive is connected.
160Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio.
161@item bus=@var{bus},unit=@var{unit}
162These options define where is connected the drive by defining the bus number and
163the unit id.
164@item index=@var{index}
165This option defines where is connected the drive by using an index in the list
166of available connectors of a given interface type.
167@item media=@var{media}
168This option defines the type of the media: disk or cdrom.
169@item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}]
170These options have the same definition as they have in @option{-hdachs}.
171@item snapshot=@var{snapshot}
172@var{snapshot} is "on" or "off" and allows to enable snapshot for given drive (see @option{-snapshot}).
173@item cache=@var{cache}
Stefan Hajnoczi92196b22011-08-04 12:26:52 +0100174@var{cache} is "none", "writeback", "unsafe", "directsync" or "writethrough" and controls how the host cache is used to access block data.
Christoph Hellwig5c6c3a62009-08-20 16:58:35 +0200175@item aio=@var{aio}
176@var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO.
blueswir15824d652009-03-28 06:44:27 +0000177@item format=@var{format}
178Specify which disk @var{format} will be used rather than detecting
179the format. Can be used to specifiy format=raw to avoid interpreting
180an untrusted format header.
181@item serial=@var{serial}
182This option specifies the serial number to assign to the device.
Markus Armbrusterc2cc47a2009-06-18 15:14:10 +0200183@item addr=@var{addr}
184Specify the controller's PCI address (if=virtio only).
Luiz Capitulinoae73e592011-07-12 17:35:08 -0300185@item werror=@var{action},rerror=@var{action}
186Specify which @var{action} to take on write and read errors. Valid actions are:
187"ignore" (ignore the error and try to continue), "stop" (pause QEMU),
188"report" (report the error to the guest), "enospc" (pause QEMU only if the
189host disk is full; report the error to the guest otherwise).
190The default setting is @option{werror=enospc} and @option{rerror=report}.
191@item readonly
192Open drive @option{file} as read-only. Guest write attempts will fail.
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +0000193@item copy-on-read=@var{copy-on-read}
194@var{copy-on-read} is "on" or "off" and enables whether to copy read backing
195file sectors into the image file.
blueswir15824d652009-03-28 06:44:27 +0000196@end table
197
198By default, writethrough caching is used for all block device. This means that
199the host page cache will be used to read and write data but write notification
200will be sent to the guest only when the data has been reported as written by
201the storage subsystem.
202
203Writeback caching will report data writes as completed as soon as the data is
204present in the host page cache. This is safe as long as you trust your host.
205If your host crashes or loses power, then the guest may experience data
Alexander Grafc3177282010-05-26 21:04:32 +0200206corruption.
blueswir15824d652009-03-28 06:44:27 +0000207
Aurelien Jarnoc304d312009-05-03 23:29:14 +0200208The host page cache can be avoided entirely with @option{cache=none}. This will
blueswir15824d652009-03-28 06:44:27 +0000209attempt to do disk IO directly to the guests memory. QEMU may still perform
210an internal copy of the data.
211
Stefan Hajnoczi92196b22011-08-04 12:26:52 +0100212The host page cache can be avoided while only sending write notifications to
213the guest when the data has been reported as written by the storage subsystem
214using @option{cache=directsync}.
215
blueswir15824d652009-03-28 06:44:27 +0000216Some block drivers perform badly with @option{cache=writethrough}, most notably,
217qcow2. If performance is more important than correctness,
Kevin Wolf0aa217e2009-06-30 13:06:04 +0200218@option{cache=writeback} should be used with qcow2.
blueswir15824d652009-03-28 06:44:27 +0000219
Alexander Graf016f5cf2010-05-26 17:51:49 +0200220In case you don't care about data integrity over host failures, use
221cache=unsafe. This option tells qemu that it never needs to write any data
222to the disk but can instead keeps things in cache. If anything goes wrong,
Stefan Weile7d81002011-12-10 00:19:46 +0100223like your host losing power, the disk storage getting disconnected accidentally,
Alexander Grafc3177282010-05-26 21:04:32 +0200224etc. you're image will most probably be rendered unusable. When using
225the @option{-snapshot} option, unsafe caching is always used.
Alexander Graf016f5cf2010-05-26 17:51:49 +0200226
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +0000227Copy-on-read avoids accessing the same backing file sectors repeatedly and is
228useful when the backing file is over a slow network. By default copy-on-read
229is off.
230
blueswir15824d652009-03-28 06:44:27 +0000231Instead of @option{-cdrom} you can use:
232@example
233qemu -drive file=file,index=2,media=cdrom
234@end example
235
236Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
237use:
238@example
239qemu -drive file=file,index=0,media=disk
240qemu -drive file=file,index=1,media=disk
241qemu -drive file=file,index=2,media=disk
242qemu -drive file=file,index=3,media=disk
243@end example
244
245You can connect a CDROM to the slave of ide0:
246@example
247qemu -drive file=file,if=ide,index=1,media=cdrom
248@end example
249
250If you don't specify the "file=" argument, you define an empty drive:
251@example
252qemu -drive if=ide,index=1,media=cdrom
253@end example
254
255You can connect a SCSI disk with unit ID 6 on the bus #0:
256@example
257qemu -drive file=file,if=scsi,bus=0,unit=6
258@end example
259
260Instead of @option{-fda}, @option{-fdb}, you can use:
261@example
262qemu -drive file=file,index=0,if=floppy
263qemu -drive file=file,index=1,if=floppy
264@end example
265
266By default, @var{interface} is "ide" and @var{index} is automatically
267incremented:
268@example
269qemu -drive file=a -drive file=b"
270@end example
271is interpreted like:
272@example
273qemu -hda a -hdb b
274@end example
275ETEXI
276
Stefan Weil6616b2a2010-02-05 23:52:05 +0100277DEF("set", HAS_ARG, QEMU_OPTION_set,
278 "-set group.id.arg=value\n"
279 " set <arg> parameter for item <id> of type <group>\n"
Blue Swirlad960902010-03-29 19:23:52 +0000280 " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL)
Stefan Weil6616b2a2010-02-05 23:52:05 +0100281STEXI
282@item -set
283@findex -set
284TODO
285ETEXI
286
287DEF("global", HAS_ARG, QEMU_OPTION_global,
288 "-global driver.property=value\n"
Blue Swirlad960902010-03-29 19:23:52 +0000289 " set a global default for a driver property\n",
290 QEMU_ARCH_ALL)
Stefan Weil6616b2a2010-02-05 23:52:05 +0100291STEXI
292@item -global
293@findex -global
294TODO
295ETEXI
296
blueswir15824d652009-03-28 06:44:27 +0000297DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock,
Blue Swirlad960902010-03-29 19:23:52 +0000298 "-mtdblock file use 'file' as on-board Flash memory image\n",
299 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000300STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +0200301@item -mtdblock @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100302@findex -mtdblock
Kevin Wolf4e257e52009-10-09 10:58:36 +0200303Use @var{file} as on-board Flash memory image.
blueswir15824d652009-03-28 06:44:27 +0000304ETEXI
305
306DEF("sd", HAS_ARG, QEMU_OPTION_sd,
Blue Swirlad960902010-03-29 19:23:52 +0000307 "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000308STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +0200309@item -sd @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100310@findex -sd
Kevin Wolf4e257e52009-10-09 10:58:36 +0200311Use @var{file} as SecureDigital card image.
blueswir15824d652009-03-28 06:44:27 +0000312ETEXI
313
314DEF("pflash", HAS_ARG, QEMU_OPTION_pflash,
Blue Swirlad960902010-03-29 19:23:52 +0000315 "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000316STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +0200317@item -pflash @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100318@findex -pflash
Kevin Wolf4e257e52009-10-09 10:58:36 +0200319Use @var{file} as a parallel flash image.
blueswir15824d652009-03-28 06:44:27 +0000320ETEXI
321
322DEF("boot", HAS_ARG, QEMU_OPTION_boot,
Jan Kiszka2221dde2009-07-02 00:19:02 +0200323 "-boot [order=drives][,once=drives][,menu=on|off]\n"
wayne3d3b8302011-07-27 18:04:55 +0800324 " [,splash=sp_name][,splash-time=sp_time]\n"
325 " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n"
326 " 'sp_name': the file's name that would be passed to bios as logo picture, if menu=on\n"
327 " 'sp_time': the period that splash picture last if menu=on, unit is ms\n",
Blue Swirlad960902010-03-29 19:23:52 +0000328 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000329STEXI
wayne3d3b8302011-07-27 18:04:55 +0800330@item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off][,splash=@var{sp_name}][,splash-time=@var{sp_time}]
Stefan Weil6616b2a2010-02-05 23:52:05 +0100331@findex -boot
Jan Kiszka2221dde2009-07-02 00:19:02 +0200332Specify boot order @var{drives} as a string of drive letters. Valid
333drive letters depend on the target achitecture. The x86 PC uses: a, b
334(floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot
335from network adapter 1-4), hard disk boot is the default. To apply a
336particular boot order only on the first startup, specify it via
337@option{once}.
338
339Interactive boot menus/prompts can be enabled via @option{menu=on} as far
340as firmware/BIOS supports them. The default is non-interactive boot.
341
wayne3d3b8302011-07-27 18:04:55 +0800342A splash picture could be passed to bios, enabling user to show it as logo,
343when option splash=@var{sp_name} is given and menu=on, If firmware/BIOS
344supports them. Currently Seabios for X86 system support it.
345limitation: The splash file could be a jpeg file or a BMP file in 24 BPP
346format(true color). The resolution should be supported by the SVGA mode, so
347the recommended is 320x240, 640x480, 800x640.
348
Jan Kiszka2221dde2009-07-02 00:19:02 +0200349@example
350# try to boot from network first, then from hard disk
351qemu -boot order=nc
352# boot from CD-ROM first, switch back to default order after reboot
353qemu -boot once=d
wayne3d3b8302011-07-27 18:04:55 +0800354# boot with a splash picture for 5 seconds.
355qemu -boot menu=on,splash=/root/boot.bmp,splash-time=5000
Jan Kiszka2221dde2009-07-02 00:19:02 +0200356@end example
357
358Note: The legacy format '-boot @var{drives}' is still supported but its
359use is discouraged as it may be removed from future versions.
blueswir15824d652009-03-28 06:44:27 +0000360ETEXI
361
362DEF("snapshot", 0, QEMU_OPTION_snapshot,
Blue Swirlad960902010-03-29 19:23:52 +0000363 "-snapshot write to temporary files instead of disk image files\n",
364 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000365STEXI
366@item -snapshot
Stefan Weil6616b2a2010-02-05 23:52:05 +0100367@findex -snapshot
blueswir15824d652009-03-28 06:44:27 +0000368Write to temporary files instead of disk image files. In this case,
369the raw disk image you use is not written back. You can however force
370the write back by pressing @key{C-a s} (@pxref{disk_images}).
371ETEXI
372
373DEF("m", HAS_ARG, QEMU_OPTION_m,
Paolo Bonzinibec7c2d2010-02-04 16:49:58 +0100374 "-m megs set virtual RAM size to megs MB [default="
Blue Swirlad960902010-03-29 19:23:52 +0000375 stringify(DEFAULT_RAM_SIZE) "]\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000376STEXI
377@item -m @var{megs}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100378@findex -m
blueswir15824d652009-03-28 06:44:27 +0000379Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally,
380a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
381gigabytes respectively.
382ETEXI
383
Marcelo Tosattic9027602010-03-01 20:25:08 -0300384DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath,
Blue Swirlad960902010-03-29 19:23:52 +0000385 "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL)
Marcelo Tosattic9027602010-03-01 20:25:08 -0300386STEXI
387@item -mem-path @var{path}
388Allocate guest RAM from a temporarily created file in @var{path}.
389ETEXI
390
391#ifdef MAP_POPULATE
392DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc,
Blue Swirlad960902010-03-29 19:23:52 +0000393 "-mem-prealloc preallocate guest memory (use with -mem-path)\n",
394 QEMU_ARCH_ALL)
Marcelo Tosattic9027602010-03-01 20:25:08 -0300395STEXI
396@item -mem-prealloc
397Preallocate memory when using -mem-path.
398ETEXI
399#endif
400
blueswir15824d652009-03-28 06:44:27 +0000401DEF("k", HAS_ARG, QEMU_OPTION_k,
Blue Swirlad960902010-03-29 19:23:52 +0000402 "-k language use keyboard layout (for example 'fr' for French)\n",
403 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000404STEXI
405@item -k @var{language}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100406@findex -k
blueswir15824d652009-03-28 06:44:27 +0000407Use keyboard layout @var{language} (for example @code{fr} for
408French). This option is only needed where it is not easy to get raw PC
409keycodes (e.g. on Macs, with some X11 servers or with a VNC
410display). You don't normally need to use it on PC/Linux or PC/Windows
411hosts.
412
413The available layouts are:
414@example
415ar de-ch es fo fr-ca hu ja mk no pt-br sv
416da en-gb et fr fr-ch is lt nl pl ru th
417de en-us fi fr-be hr it lv nl-be pt sl tr
418@end example
419
420The default is @code{en-us}.
421ETEXI
422
423
blueswir15824d652009-03-28 06:44:27 +0000424DEF("audio-help", 0, QEMU_OPTION_audio_help,
Blue Swirlad960902010-03-29 19:23:52 +0000425 "-audio-help print list of audio drivers and their options\n",
426 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000427STEXI
428@item -audio-help
Stefan Weil6616b2a2010-02-05 23:52:05 +0100429@findex -audio-help
blueswir15824d652009-03-28 06:44:27 +0000430Will show the audio subsystem help: list of drivers, tunable
431parameters.
432ETEXI
433
blueswir15824d652009-03-28 06:44:27 +0000434DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw,
435 "-soundhw c1,... enable audio support\n"
436 " and only specified sound cards (comma separated list)\n"
437 " use -soundhw ? to get the list of supported cards\n"
Blue Swirlad960902010-03-29 19:23:52 +0000438 " use -soundhw all to enable all of them\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000439STEXI
440@item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
Stefan Weil6616b2a2010-02-05 23:52:05 +0100441@findex -soundhw
blueswir15824d652009-03-28 06:44:27 +0000442Enable audio and selected sound hardware. Use ? to print all
443available sound hardware.
444
445@example
446qemu -soundhw sb16,adlib disk.img
447qemu -soundhw es1370 disk.img
448qemu -soundhw ac97 disk.img
Gerd Hoffmann7d72e762010-11-01 16:57:48 +0100449qemu -soundhw hda disk.img
blueswir15824d652009-03-28 06:44:27 +0000450qemu -soundhw all disk.img
451qemu -soundhw ?
452@end example
453
454Note that Linux's i810_audio OSS kernel (for AC97) module might
455require manually specifying clocking.
456
457@example
458modprobe i810_audio clocking=48000
459@end example
460ETEXI
461
Michael Ellermanb1746dd2011-12-19 17:19:32 +1100462DEF("balloon", HAS_ARG, QEMU_OPTION_balloon,
463 "-balloon none disable balloon device\n"
464 "-balloon virtio[,addr=str]\n"
465 " enable virtio balloon device (default)\n", QEMU_ARCH_ALL)
466STEXI
467@item -balloon none
468@findex -balloon
469Disable balloon device.
470@item -balloon virtio[,addr=@var{addr}]
471Enable virtio balloon device (default), optionally with PCI address
472@var{addr}.
473ETEXI
474
blueswir15824d652009-03-28 06:44:27 +0000475STEXI
476@end table
477ETEXI
478
479DEF("usb", 0, QEMU_OPTION_usb,
Blue Swirlad960902010-03-29 19:23:52 +0000480 "-usb enable the USB driver (will be the default soon)\n",
481 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000482STEXI
483USB options:
484@table @option
485
486@item -usb
Stefan Weil6616b2a2010-02-05 23:52:05 +0100487@findex -usb
blueswir15824d652009-03-28 06:44:27 +0000488Enable the USB driver (will be the default soon)
489ETEXI
490
491DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice,
Blue Swirlad960902010-03-29 19:23:52 +0000492 "-usbdevice name add the host or guest USB device 'name'\n",
493 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000494STEXI
495
496@item -usbdevice @var{devname}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100497@findex -usbdevice
blueswir15824d652009-03-28 06:44:27 +0000498Add the USB device @var{devname}. @xref{usb_devices}.
499
Kevin Wolfb3f046c2009-10-09 10:58:35 +0200500@table @option
blueswir15824d652009-03-28 06:44:27 +0000501
502@item mouse
503Virtual Mouse. This will override the PS/2 mouse emulation when activated.
504
505@item tablet
506Pointer device that uses absolute coordinates (like a touchscreen). This
507means qemu is able to report the mouse position without having to grab the
508mouse. Also overrides the PS/2 mouse emulation when activated.
509
Kevin Wolf4e257e52009-10-09 10:58:36 +0200510@item disk:[format=@var{format}]:@var{file}
blueswir15824d652009-03-28 06:44:27 +0000511Mass storage device based on file. The optional @var{format} argument
512will be used rather than detecting the format. Can be used to specifiy
Kevin Wolf4e257e52009-10-09 10:58:36 +0200513@code{format=raw} to avoid interpreting an untrusted format header.
blueswir15824d652009-03-28 06:44:27 +0000514
Kevin Wolf4e257e52009-10-09 10:58:36 +0200515@item host:@var{bus}.@var{addr}
516Pass through the host device identified by @var{bus}.@var{addr} (Linux only).
blueswir15824d652009-03-28 06:44:27 +0000517
Kevin Wolf4e257e52009-10-09 10:58:36 +0200518@item host:@var{vendor_id}:@var{product_id}
519Pass through the host device identified by @var{vendor_id}:@var{product_id}
520(Linux only).
blueswir15824d652009-03-28 06:44:27 +0000521
522@item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
523Serial converter to host character device @var{dev}, see @code{-serial} for the
524available devices.
525
526@item braille
527Braille device. This will use BrlAPI to display the braille output on a real
528or fake device.
529
Kevin Wolf4e257e52009-10-09 10:58:36 +0200530@item net:@var{options}
blueswir15824d652009-03-28 06:44:27 +0000531Network adapter that supports CDC ethernet and RNDIS protocols.
532
533@end table
534ETEXI
535
Gerd Hoffmannbd3c9482009-07-15 13:59:26 +0200536DEF("device", HAS_ARG, QEMU_OPTION_device,
Markus Armbruster40ea2852010-01-29 19:49:01 +0100537 "-device driver[,prop[=value][,...]]\n"
538 " add device (based on driver)\n"
539 " prop=value,... sets driver properties\n"
Stefan Weil69a319d2010-01-20 22:58:35 +0100540 " use -device ? to print all possible drivers\n"
Markus Armbruster9848bbf2010-05-11 14:02:31 +0200541 " use -device driver,? to print all possible properties\n",
Blue Swirlad960902010-03-29 19:23:52 +0000542 QEMU_ARCH_ALL)
Stefan Weil3dbf2c72010-01-16 18:19:44 +0100543STEXI
Markus Armbruster9848bbf2010-05-11 14:02:31 +0200544@item -device @var{driver}[,@var{prop}[=@var{value}][,...]]
Stefan Weil6616b2a2010-02-05 23:52:05 +0100545@findex -device
Markus Armbruster9848bbf2010-05-11 14:02:31 +0200546Add device @var{driver}. @var{prop}=@var{value} sets driver
547properties. Valid properties depend on the driver. To get help on
548possible drivers and properties, use @code{-device ?} and
549@code{-device @var{driver},?}.
Stefan Weil3dbf2c72010-01-16 18:19:44 +0100550ETEXI
551
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530552DEFHEADING()
553
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530554DEFHEADING(File system options:)
555
556DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev,
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530557 "-fsdev fsdriver,id=id[,path=path,][security_model={mapped-xattr|mapped-file|passthrough|none}]\n"
M. Mohan Kumar84a87cc2011-12-14 13:58:47 +0530558 " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n",
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530559 QEMU_ARCH_ALL)
560
561STEXI
562
M. Mohan Kumar84a87cc2011-12-14 13:58:47 +0530563@item -fsdev @var{fsdriver},id=@var{id},path=@var{path},[security_model=@var{security_model}][,writeout=@var{writeout}][,readonly][,socket=@var{socket}|sock_fd=@var{sock_fd}]
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530564@findex -fsdev
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530565Define a new file system device. Valid options are:
566@table @option
567@item @var{fsdriver}
568This option specifies the fs driver backend to use.
M. Mohan Kumarf67e3ff2011-12-14 13:58:46 +0530569Currently "local", "handle" and "proxy" file system drivers are supported.
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530570@item id=@var{id}
571Specifies identifier for this device
572@item path=@var{path}
573Specifies the export path for the file system device. Files under
574this path will be available to the 9p client on the guest.
575@item security_model=@var{security_model}
576Specifies the security model to be used for this export path.
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530577Supported security models are "passthrough", "mapped-xattr", "mapped-file" and "none".
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530578In "passthrough" security model, files are stored using the same
579credentials as they are created on the guest. This requires qemu
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530580to run as root. In "mapped-xattr" security model, some of the file
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530581attributes like uid, gid, mode bits and link target are stored as
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530582file attributes. For "mapped-file" these attributes are stored in the
583hidden .virtfs_metadata directory. Directories exported by this security model cannot
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530584interact with other unix tools. "none" security model is same as
585passthrough except the sever won't report failures if it fails to
M. Mohan Kumard9b36a62011-10-14 12:59:37 +0530586set file attributes like ownership. Security model is mandatory
M. Mohan Kumarf67e3ff2011-12-14 13:58:46 +0530587only for local fsdriver. Other fsdrivers (like handle, proxy) don't take
M. Mohan Kumard9b36a62011-10-14 12:59:37 +0530588security model as a parameter.
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530589@item writeout=@var{writeout}
590This is an optional argument. The only supported value is "immediate".
591This means that host page cache will be used to read and write data but
592write notification will be sent to the guest only when the data has been
593reported as written by the storage subsystem.
M. Mohan Kumar2c74c2c2011-10-25 12:10:39 +0530594@item readonly
595Enables exporting 9p share as a readonly mount for guests. By default
596read-write access is given.
M. Mohan Kumar84a87cc2011-12-14 13:58:47 +0530597@item socket=@var{socket}
598Enables proxy filesystem driver to use passed socket file for communicating
599with virtfs-proxy-helper
M. Mohan Kumarf67e3ff2011-12-14 13:58:46 +0530600@item sock_fd=@var{sock_fd}
601Enables proxy filesystem driver to use passed socket descriptor for
602communicating with virtfs-proxy-helper. Usually a helper like libvirt
603will create socketpair and pass one of the fds as sock_fd
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530604@end table
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530605
606-fsdev option is used along with -device driver "virtio-9p-pci".
607@item -device virtio-9p-pci,fsdev=@var{id},mount_tag=@var{mount_tag}
608Options for virtio-9p-pci driver are:
609@table @option
610@item fsdev=@var{id}
611Specifies the id value specified along with -fsdev option
612@item mount_tag=@var{mount_tag}
613Specifies the tag name to be used by the guest to mount this export point
614@end table
615
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530616ETEXI
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530617
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530618DEFHEADING()
619
Gautham R Shenoy3d54abc2010-04-29 17:45:03 +0530620DEFHEADING(Virtual File system pass-through options:)
621
622DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs,
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530623 "-virtfs local,path=path,mount_tag=tag,security_model=[mapped-xattr|mapped-file|passthrough|none]\n"
M. Mohan Kumar84a87cc2011-12-14 13:58:47 +0530624 " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n",
Gautham R Shenoy3d54abc2010-04-29 17:45:03 +0530625 QEMU_ARCH_ALL)
626
627STEXI
628
M. Mohan Kumar84a87cc2011-12-14 13:58:47 +0530629@item -virtfs @var{fsdriver}[,path=@var{path}],mount_tag=@var{mount_tag}[,security_model=@var{security_model}][,writeout=@var{writeout}][,readonly][,socket=@var{socket}|sock_fd=@var{sock_fd}]
Gautham R Shenoy3d54abc2010-04-29 17:45:03 +0530630@findex -virtfs
Gautham R Shenoy3d54abc2010-04-29 17:45:03 +0530631
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530632The general form of a Virtual File system pass-through options are:
633@table @option
634@item @var{fsdriver}
635This option specifies the fs driver backend to use.
M. Mohan Kumarf67e3ff2011-12-14 13:58:46 +0530636Currently "local", "handle" and "proxy" file system drivers are supported.
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530637@item id=@var{id}
638Specifies identifier for this device
639@item path=@var{path}
640Specifies the export path for the file system device. Files under
641this path will be available to the 9p client on the guest.
642@item security_model=@var{security_model}
643Specifies the security model to be used for this export path.
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530644Supported security models are "passthrough", "mapped-xattr", "mapped-file" and "none".
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530645In "passthrough" security model, files are stored using the same
646credentials as they are created on the guest. This requires qemu
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530647to run as root. In "mapped-xattr" security model, some of the file
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530648attributes like uid, gid, mode bits and link target are stored as
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530649file attributes. For "mapped-file" these attributes are stored in the
650hidden .virtfs_metadata directory. Directories exported by this security model cannot
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530651interact with other unix tools. "none" security model is same as
652passthrough except the sever won't report failures if it fails to
M. Mohan Kumard9b36a62011-10-14 12:59:37 +0530653set file attributes like ownership. Security model is mandatory only
M. Mohan Kumarf67e3ff2011-12-14 13:58:46 +0530654for local fsdriver. Other fsdrivers (like handle, proxy) don't take security
M. Mohan Kumard9b36a62011-10-14 12:59:37 +0530655model as a parameter.
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530656@item writeout=@var{writeout}
657This is an optional argument. The only supported value is "immediate".
658This means that host page cache will be used to read and write data but
659write notification will be sent to the guest only when the data has been
660reported as written by the storage subsystem.
M. Mohan Kumar2c74c2c2011-10-25 12:10:39 +0530661@item readonly
662Enables exporting 9p share as a readonly mount for guests. By default
663read-write access is given.
M. Mohan Kumar84a87cc2011-12-14 13:58:47 +0530664@item socket=@var{socket}
665Enables proxy filesystem driver to use passed socket file for
666communicating with virtfs-proxy-helper. Usually a helper like libvirt
667will create socketpair and pass one of the fds as sock_fd
M. Mohan Kumarf67e3ff2011-12-14 13:58:46 +0530668@item sock_fd
669Enables proxy filesystem driver to use passed 'sock_fd' as the socket
670descriptor for interfacing with virtfs-proxy-helper
Gautham R Shenoy3d54abc2010-04-29 17:45:03 +0530671@end table
672ETEXI
Gautham R Shenoy3d54abc2010-04-29 17:45:03 +0530673
Aneesh Kumar K.V9db221a2011-10-25 12:10:40 +0530674DEF("virtfs_synth", 0, QEMU_OPTION_virtfs_synth,
675 "-virtfs_synth Create synthetic file system image\n",
676 QEMU_ARCH_ALL)
677STEXI
678@item -virtfs_synth
679@findex -virtfs_synth
680Create synthetic file system image
681ETEXI
682
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530683DEFHEADING()
684
blueswir15824d652009-03-28 06:44:27 +0000685DEF("name", HAS_ARG, QEMU_OPTION_name,
Bruce Rogersca1a8a02010-01-06 12:33:57 -0700686 "-name string1[,process=string2]\n"
687 " set the name of the guest\n"
Blue Swirlad960902010-03-29 19:23:52 +0000688 " string1 sets the window title and string2 the process name (on Linux)\n",
689 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000690STEXI
691@item -name @var{name}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100692@findex -name
blueswir15824d652009-03-28 06:44:27 +0000693Sets the @var{name} of the guest.
694This name will be displayed in the SDL window caption.
695The @var{name} will also be used for the VNC server.
Andi Kleen18894652009-07-02 09:34:17 +0200696Also optionally set the top visible process name in Linux.
blueswir15824d652009-03-28 06:44:27 +0000697ETEXI
698
699DEF("uuid", HAS_ARG, QEMU_OPTION_uuid,
Paolo Bonzinie8105eb2010-02-04 16:49:59 +0100700 "-uuid %08x-%04x-%04x-%04x-%012x\n"
Blue Swirlad960902010-03-29 19:23:52 +0000701 " specify machine UUID\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000702STEXI
703@item -uuid @var{uuid}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100704@findex -uuid
blueswir15824d652009-03-28 06:44:27 +0000705Set system UUID.
706ETEXI
707
708STEXI
709@end table
710ETEXI
711
712DEFHEADING()
713
714DEFHEADING(Display options:)
715
716STEXI
717@table @option
718ETEXI
719
Jes Sorensen1472a952011-03-16 13:33:31 +0100720DEF("display", HAS_ARG, QEMU_OPTION_display,
721 "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n"
Jes Sorensen3264ff12011-03-16 13:33:33 +0100722 " [,window_close=on|off]|curses|none|\n"
723 " vnc=<display>[,<optargs>]\n"
Jes Sorensen1472a952011-03-16 13:33:31 +0100724 " select display type\n", QEMU_ARCH_ALL)
725STEXI
726@item -display @var{type}
727@findex -display
728Select type of display to use. This option is a replacement for the
729old style -sdl/-curses/... options. Valid values for @var{type} are
730@table @option
731@item sdl
732Display video output via SDL (usually in a separate graphics
733window; see the SDL documentation for other possibilities).
734@item curses
735Display video output via curses. For graphics device models which
736support a text mode, QEMU can display this output using a
737curses/ncurses interface. Nothing is displayed when the graphics
738device is in graphical mode or if the graphics device does not support
739a text mode. Generally only the VGA device models support text mode.
Jes Sorensen4171d322011-03-16 13:33:32 +0100740@item none
741Do not display video output. The guest will still see an emulated
742graphics card, but its output will not be displayed to the QEMU
743user. This option differs from the -nographic option in that it
744only affects what is done with video output; -nographic also changes
745the destination of the serial and parallel port data.
Jes Sorensen3264ff12011-03-16 13:33:33 +0100746@item vnc
747Start a VNC server on display <arg>
Jes Sorensen1472a952011-03-16 13:33:31 +0100748@end table
749ETEXI
750
blueswir15824d652009-03-28 06:44:27 +0000751DEF("nographic", 0, QEMU_OPTION_nographic,
Blue Swirlad960902010-03-29 19:23:52 +0000752 "-nographic disable graphical output and redirect serial I/Os to console\n",
753 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000754STEXI
755@item -nographic
Stefan Weil6616b2a2010-02-05 23:52:05 +0100756@findex -nographic
blueswir15824d652009-03-28 06:44:27 +0000757Normally, QEMU uses SDL to display the VGA output. With this option,
758you can totally disable graphical output so that QEMU is a simple
759command line application. The emulated serial port is redirected on
760the console. Therefore, you can still use QEMU to debug a Linux kernel
761with a serial console.
762ETEXI
763
blueswir15824d652009-03-28 06:44:27 +0000764DEF("curses", 0, QEMU_OPTION_curses,
Blue Swirlad960902010-03-29 19:23:52 +0000765 "-curses use a curses/ncurses interface instead of SDL\n",
766 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000767STEXI
768@item -curses
Stefan Weil6616b2a2010-02-05 23:52:05 +0100769@findex curses
blueswir15824d652009-03-28 06:44:27 +0000770Normally, QEMU uses SDL to display the VGA output. With this option,
771QEMU can display the VGA output when in text mode using a
772curses/ncurses interface. Nothing is displayed in graphical mode.
773ETEXI
774
blueswir15824d652009-03-28 06:44:27 +0000775DEF("no-frame", 0, QEMU_OPTION_no_frame,
Blue Swirlad960902010-03-29 19:23:52 +0000776 "-no-frame open SDL window without a frame and window decorations\n",
777 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000778STEXI
779@item -no-frame
Stefan Weil6616b2a2010-02-05 23:52:05 +0100780@findex -no-frame
blueswir15824d652009-03-28 06:44:27 +0000781Do not use decorations for SDL windows and start them using the whole
782available screen space. This makes the using QEMU in a dedicated desktop
783workspace more convenient.
784ETEXI
785
blueswir15824d652009-03-28 06:44:27 +0000786DEF("alt-grab", 0, QEMU_OPTION_alt_grab,
Blue Swirlad960902010-03-29 19:23:52 +0000787 "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n",
788 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000789STEXI
790@item -alt-grab
Stefan Weil6616b2a2010-02-05 23:52:05 +0100791@findex -alt-grab
Brad Hardsde1db2a2011-04-29 21:46:12 +1000792Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also
793affects the special keys (for fullscreen, monitor-mode switching, etc).
blueswir15824d652009-03-28 06:44:27 +0000794ETEXI
795
Dustin Kirkland0ca9f8a2009-09-17 15:48:04 -0500796DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab,
Blue Swirlad960902010-03-29 19:23:52 +0000797 "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n",
798 QEMU_ARCH_ALL)
Dustin Kirkland0ca9f8a2009-09-17 15:48:04 -0500799STEXI
800@item -ctrl-grab
Stefan Weil6616b2a2010-02-05 23:52:05 +0100801@findex -ctrl-grab
Brad Hardsde1db2a2011-04-29 21:46:12 +1000802Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also
803affects the special keys (for fullscreen, monitor-mode switching, etc).
Dustin Kirkland0ca9f8a2009-09-17 15:48:04 -0500804ETEXI
805
blueswir15824d652009-03-28 06:44:27 +0000806DEF("no-quit", 0, QEMU_OPTION_no_quit,
Blue Swirlad960902010-03-29 19:23:52 +0000807 "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000808STEXI
809@item -no-quit
Stefan Weil6616b2a2010-02-05 23:52:05 +0100810@findex -no-quit
blueswir15824d652009-03-28 06:44:27 +0000811Disable SDL window close capability.
812ETEXI
813
blueswir15824d652009-03-28 06:44:27 +0000814DEF("sdl", 0, QEMU_OPTION_sdl,
Blue Swirlad960902010-03-29 19:23:52 +0000815 "-sdl enable SDL\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000816STEXI
817@item -sdl
Stefan Weil6616b2a2010-02-05 23:52:05 +0100818@findex -sdl
blueswir15824d652009-03-28 06:44:27 +0000819Enable SDL.
820ETEXI
821
Gerd Hoffmann29b00402010-03-11 11:13:27 -0300822DEF("spice", HAS_ARG, QEMU_OPTION_spice,
823 "-spice <args> enable spice\n", QEMU_ARCH_ALL)
824STEXI
825@item -spice @var{option}[,@var{option}[,...]]
826@findex -spice
827Enable the spice remote desktop protocol. Valid options are
828
829@table @option
830
831@item port=<nr>
Gerd Hoffmannc448e852010-03-11 11:13:32 -0300832Set the TCP port spice is listening on for plaintext channels.
Gerd Hoffmann29b00402010-03-11 11:13:27 -0300833
Gerd Hoffmann333b0ee2010-08-27 14:29:16 +0200834@item addr=<addr>
835Set the IP address spice is listening on. Default is any address.
836
837@item ipv4
838@item ipv6
839Force using the specified IP version.
840
Gerd Hoffmann29b00402010-03-11 11:13:27 -0300841@item password=<secret>
842Set the password you need to authenticate.
843
Marc-André Lureau48b3ed02011-05-17 10:40:33 +0200844@item sasl
845Require that the client use SASL to authenticate with the spice.
846The exact choice of authentication method used is controlled from the
847system / user's SASL configuration file for the 'qemu' service. This
848is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
849unprivileged user, an environment variable SASL_CONF_PATH can be used
850to make it search alternate locations for the service config.
851While some SASL auth methods can also provide data encryption (eg GSSAPI),
852it is recommended that SASL always be combined with the 'tls' and
853'x509' settings to enable use of SSL and server certificates. This
854ensures a data encryption preventing compromise of authentication
855credentials.
856
Gerd Hoffmann29b00402010-03-11 11:13:27 -0300857@item disable-ticketing
858Allow client connects without authentication.
859
Hans de Goeded4970b02011-03-27 16:43:54 +0200860@item disable-copy-paste
861Disable copy paste between the client and the guest.
862
Gerd Hoffmannc448e852010-03-11 11:13:32 -0300863@item tls-port=<nr>
864Set the TCP port spice is listening on for encrypted channels.
865
866@item x509-dir=<dir>
867Set the x509 file directory. Expects same filenames as -vnc $display,x509=$dir
868
869@item x509-key-file=<file>
870@item x509-key-password=<file>
871@item x509-cert-file=<file>
872@item x509-cacert-file=<file>
873@item x509-dh-key-file=<file>
874The x509 file names can also be configured individually.
875
876@item tls-ciphers=<list>
877Specify which ciphers to use.
878
Alon Levyd70d6b32011-12-20 13:05:18 +0200879@item tls-channel=[main|display|cursor|inputs|record|playback]
880@item plaintext-channel=[main|display|cursor|inputs|record|playback]
Gerd Hoffmann17b6dea2010-08-27 14:09:56 +0200881Force specific channel to be used with or without TLS encryption. The
882options can be specified multiple times to configure multiple
883channels. The special name "default" can be used to set the default
884mode. For channels which are not explicitly forced into one mode the
885spice client is allowed to pick tls/plaintext as he pleases.
886
Yonit Halperin9f04e092010-07-14 13:26:34 +0300887@item image-compression=[auto_glz|auto_lz|quic|glz|lz|off]
888Configure image compression (lossless).
889Default is auto_glz.
890
891@item jpeg-wan-compression=[auto|never|always]
892@item zlib-glz-wan-compression=[auto|never|always]
893Configure wan image compression (lossy for slow links).
894Default is auto.
895
Gerd Hoffmann84a23f22010-08-30 16:36:53 +0200896@item streaming-video=[off|all|filter]
897Configure video stream detection. Default is filter.
898
899@item agent-mouse=[on|off]
900Enable/disable passing mouse events via vdagent. Default is on.
901
902@item playback-compression=[on|off]
903Enable/disable audio stream compression (using celt 0.5.1). Default is on.
904
Gerd Hoffmann29b00402010-03-11 11:13:27 -0300905@end table
906ETEXI
907
blueswir15824d652009-03-28 06:44:27 +0000908DEF("portrait", 0, QEMU_OPTION_portrait,
Blue Swirlad960902010-03-29 19:23:52 +0000909 "-portrait rotate graphical output 90 deg left (only PXA LCD)\n",
910 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000911STEXI
912@item -portrait
Stefan Weil6616b2a2010-02-05 23:52:05 +0100913@findex -portrait
blueswir15824d652009-03-28 06:44:27 +0000914Rotate graphical output 90 deg left (only PXA LCD).
915ETEXI
916
Vasily Khoruzhick93128052011-06-17 13:04:36 +0300917DEF("rotate", HAS_ARG, QEMU_OPTION_rotate,
918 "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n",
919 QEMU_ARCH_ALL)
920STEXI
921@item -rotate
922@findex -rotate
923Rotate graphical output some deg left (only PXA LCD).
924ETEXI
925
blueswir15824d652009-03-28 06:44:27 +0000926DEF("vga", HAS_ARG, QEMU_OPTION_vga,
Gerd Hoffmanna19cbfb2010-04-27 11:50:11 +0200927 "-vga [std|cirrus|vmware|qxl|xenfb|none]\n"
Blue Swirlad960902010-03-29 19:23:52 +0000928 " select video card type\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000929STEXI
930@item -vga @var{type}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100931@findex -vga
blueswir15824d652009-03-28 06:44:27 +0000932Select type of VGA card to emulate. Valid values for @var{type} are
Kevin Wolfb3f046c2009-10-09 10:58:35 +0200933@table @option
blueswir15824d652009-03-28 06:44:27 +0000934@item cirrus
935Cirrus Logic GD5446 Video card. All Windows versions starting from
936Windows 95 should recognize and use this graphic card. For optimal
937performances, use 16 bit color depth in the guest and the host OS.
938(This one is the default)
939@item std
940Standard VGA card with Bochs VBE extensions. If your guest OS
941supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
942to use high resolution modes (>= 1280x1024x16) then you should use
943this option.
944@item vmware
945VMWare SVGA-II compatible adapter. Use it if you have sufficiently
946recent XFree86/XOrg server or Windows guest with a driver for this
947card.
Gerd Hoffmanna19cbfb2010-04-27 11:50:11 +0200948@item qxl
949QXL paravirtual graphic card. It is VGA compatible (including VESA
9502.0 VBE support). Works best with qxl guest drivers installed though.
951Recommended choice when using the spice protocol.
blueswir15824d652009-03-28 06:44:27 +0000952@item none
953Disable VGA card.
954@end table
955ETEXI
956
957DEF("full-screen", 0, QEMU_OPTION_full_screen,
Blue Swirlad960902010-03-29 19:23:52 +0000958 "-full-screen start in full screen\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000959STEXI
960@item -full-screen
Stefan Weil6616b2a2010-02-05 23:52:05 +0100961@findex -full-screen
blueswir15824d652009-03-28 06:44:27 +0000962Start in full screen.
963ETEXI
964
blueswir15824d652009-03-28 06:44:27 +0000965DEF("g", 1, QEMU_OPTION_g ,
Blue Swirlad960902010-03-29 19:23:52 +0000966 "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n",
967 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
blueswir15824d652009-03-28 06:44:27 +0000968STEXI
Stefan Weil95d5f082010-01-20 22:25:27 +0100969@item -g @var{width}x@var{height}[x@var{depth}]
Stefan Weil6616b2a2010-02-05 23:52:05 +0100970@findex -g
Stefan Weil95d5f082010-01-20 22:25:27 +0100971Set the initial graphical resolution and depth (PPC, SPARC only).
blueswir15824d652009-03-28 06:44:27 +0000972ETEXI
973
974DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
Blue Swirlad960902010-03-29 19:23:52 +0000975 "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000976STEXI
977@item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
Stefan Weil6616b2a2010-02-05 23:52:05 +0100978@findex -vnc
blueswir15824d652009-03-28 06:44:27 +0000979Normally, QEMU uses SDL to display the VGA output. With this option,
980you can have QEMU listen on VNC display @var{display} and redirect the VGA
981display over the VNC session. It is very useful to enable the usb
982tablet device when using this option (option @option{-usbdevice
983tablet}). When using the VNC display, you must use the @option{-k}
984parameter to set the keyboard layout if you are not using en-us. Valid
985syntax for the @var{display} is
986
Kevin Wolfb3f046c2009-10-09 10:58:35 +0200987@table @option
blueswir15824d652009-03-28 06:44:27 +0000988
989@item @var{host}:@var{d}
990
991TCP connections will only be allowed from @var{host} on display @var{d}.
992By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
993be omitted in which case the server will accept connections from any host.
994
Kevin Wolf4e257e52009-10-09 10:58:36 +0200995@item unix:@var{path}
blueswir15824d652009-03-28 06:44:27 +0000996
997Connections will be allowed over UNIX domain sockets where @var{path} is the
998location of a unix socket to listen for connections on.
999
1000@item none
1001
1002VNC is initialized but not started. The monitor @code{change} command
1003can be used to later start the VNC server.
1004
1005@end table
1006
1007Following the @var{display} value there may be one or more @var{option} flags
1008separated by commas. Valid options are
1009
Kevin Wolfb3f046c2009-10-09 10:58:35 +02001010@table @option
blueswir15824d652009-03-28 06:44:27 +00001011
1012@item reverse
1013
1014Connect to a listening VNC client via a ``reverse'' connection. The
1015client is specified by the @var{display}. For reverse network
1016connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
1017is a TCP port number, not a display number.
1018
1019@item password
1020
1021Require that password based authentication is used for client connections.
1022The password must be set separately using the @code{change} command in the
1023@ref{pcsys_monitor}
1024
1025@item tls
1026
1027Require that client use TLS when communicating with the VNC server. This
1028uses anonymous TLS credentials so is susceptible to a man-in-the-middle
1029attack. It is recommended that this option be combined with either the
Kevin Wolf4e257e52009-10-09 10:58:36 +02001030@option{x509} or @option{x509verify} options.
blueswir15824d652009-03-28 06:44:27 +00001031
1032@item x509=@var{/path/to/certificate/dir}
1033
1034Valid if @option{tls} is specified. Require that x509 credentials are used
1035for negotiating the TLS session. The server will send its x509 certificate
1036to the client. It is recommended that a password be set on the VNC server
1037to provide authentication of the client when this is used. The path following
1038this option specifies where the x509 certificates are to be loaded from.
1039See the @ref{vnc_security} section for details on generating certificates.
1040
1041@item x509verify=@var{/path/to/certificate/dir}
1042
1043Valid if @option{tls} is specified. Require that x509 credentials are used
1044for negotiating the TLS session. The server will send its x509 certificate
1045to the client, and request that the client send its own x509 certificate.
1046The server will validate the client's certificate against the CA certificate,
1047and reject clients when validation fails. If the certificate authority is
1048trusted, this is a sufficient authentication mechanism. You may still wish
1049to set a password on the VNC server as a second authentication layer. The
1050path following this option specifies where the x509 certificates are to
1051be loaded from. See the @ref{vnc_security} section for details on generating
1052certificates.
1053
1054@item sasl
1055
1056Require that the client use SASL to authenticate with the VNC server.
1057The exact choice of authentication method used is controlled from the
1058system / user's SASL configuration file for the 'qemu' service. This
1059is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
1060unprivileged user, an environment variable SASL_CONF_PATH can be used
1061to make it search alternate locations for the service config.
1062While some SASL auth methods can also provide data encryption (eg GSSAPI),
1063it is recommended that SASL always be combined with the 'tls' and
1064'x509' settings to enable use of SSL and server certificates. This
1065ensures a data encryption preventing compromise of authentication
1066credentials. See the @ref{vnc_security} section for details on using
1067SASL authentication.
1068
1069@item acl
1070
1071Turn on access control lists for checking of the x509 client certificate
1072and SASL party. For x509 certs, the ACL check is made against the
1073certificate's distinguished name. This is something that looks like
1074@code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
1075made against the username, which depending on the SASL plugin, may
1076include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
1077When the @option{acl} flag is set, the initial access list will be
1078empty, with a @code{deny} policy. Thus no one will be allowed to
1079use the VNC server until the ACLs have been loaded. This can be
1080achieved using the @code{acl} monitor command.
1081
Corentin Chary6f9c78c2010-07-07 20:57:51 +02001082@item lossy
1083
1084Enable lossy compression methods (gradient, JPEG, ...). If this
1085option is set, VNC client may receive lossy framebuffer updates
1086depending on its encoding settings. Enabling this option can save
1087a lot of bandwidth at the expense of quality.
1088
Corentin Chary80e0c8c2011-02-04 09:06:08 +01001089@item non-adaptive
1090
1091Disable adaptive encodings. Adaptive encodings are enabled by default.
1092An adaptive encoding will try to detect frequently updated screen regions,
1093and send updates in these regions using a lossy encoding (like JPEG).
Stefan Weil61cc8702011-04-13 22:45:22 +02001094This can be really helpful to save bandwidth when playing videos. Disabling
1095adaptive encodings allows to restore the original static behavior of encodings
Corentin Chary80e0c8c2011-02-04 09:06:08 +01001096like Tight.
1097
Gerd Hoffmann8cf36482011-11-24 18:10:49 +01001098@item share=[allow-exclusive|force-shared|ignore]
1099
1100Set display sharing policy. 'allow-exclusive' allows clients to ask
1101for exclusive access. As suggested by the rfb spec this is
1102implemented by dropping other connections. Connecting multiple
1103clients in parallel requires all clients asking for a shared session
1104(vncviewer: -shared switch). This is the default. 'force-shared'
1105disables exclusive client access. Useful for shared desktop sessions,
1106where you don't want someone forgetting specify -shared disconnect
1107everybody else. 'ignore' completely ignores the shared flag and
1108allows everybody connect unconditionally. Doesn't conform to the rfb
1109spec but is traditional qemu behavior.
1110
blueswir15824d652009-03-28 06:44:27 +00001111@end table
1112ETEXI
1113
1114STEXI
1115@end table
1116ETEXI
1117
Michael Ellermana3adb7a2011-12-19 17:19:31 +11001118ARCHHEADING(, QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001119
Michael Ellermana3adb7a2011-12-19 17:19:31 +11001120ARCHHEADING(i386 target only:, QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001121STEXI
1122@table @option
1123ETEXI
1124
blueswir15824d652009-03-28 06:44:27 +00001125DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack,
Blue Swirlad960902010-03-29 19:23:52 +00001126 "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n",
1127 QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001128STEXI
1129@item -win2k-hack
Stefan Weil6616b2a2010-02-05 23:52:05 +01001130@findex -win2k-hack
blueswir15824d652009-03-28 06:44:27 +00001131Use it when installing Windows 2000 to avoid a disk full bug. After
1132Windows 2000 is installed, you no longer need this option (this option
1133slows down the IDE transfers).
1134ETEXI
1135
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02001136HXCOMM Deprecated by -rtc
Blue Swirlad960902010-03-29 19:23:52 +00001137DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001138
blueswir15824d652009-03-28 06:44:27 +00001139DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk,
Blue Swirlad960902010-03-29 19:23:52 +00001140 "-no-fd-bootchk disable boot signature checking for floppy disks\n",
1141 QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001142STEXI
1143@item -no-fd-bootchk
Stefan Weil6616b2a2010-02-05 23:52:05 +01001144@findex -no-fd-bootchk
blueswir15824d652009-03-28 06:44:27 +00001145Disable boot signature checking for floppy disks in Bochs BIOS. It may
1146be needed to boot from old floppy disks.
Stefan Weil6616b2a2010-02-05 23:52:05 +01001147TODO: check reference to Bochs BIOS.
blueswir15824d652009-03-28 06:44:27 +00001148ETEXI
1149
blueswir15824d652009-03-28 06:44:27 +00001150DEF("no-acpi", 0, QEMU_OPTION_no_acpi,
Blue Swirlad960902010-03-29 19:23:52 +00001151 "-no-acpi disable ACPI\n", QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001152STEXI
1153@item -no-acpi
Stefan Weil6616b2a2010-02-05 23:52:05 +01001154@findex -no-acpi
blueswir15824d652009-03-28 06:44:27 +00001155Disable ACPI (Advanced Configuration and Power Interface) support. Use
1156it if your guest OS complains about ACPI problems (PC target machine
1157only).
1158ETEXI
1159
blueswir15824d652009-03-28 06:44:27 +00001160DEF("no-hpet", 0, QEMU_OPTION_no_hpet,
Blue Swirlad960902010-03-29 19:23:52 +00001161 "-no-hpet disable HPET\n", QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001162STEXI
1163@item -no-hpet
Stefan Weil6616b2a2010-02-05 23:52:05 +01001164@findex -no-hpet
blueswir15824d652009-03-28 06:44:27 +00001165Disable HPET support.
1166ETEXI
1167
blueswir15824d652009-03-28 06:44:27 +00001168DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable,
Michael Tokarev104bf022011-05-12 18:44:17 +04001169 "-acpitable [sig=str][,rev=n][,oem_id=str][,oem_table_id=str][,oem_rev=n][,asl_compiler_id=str][,asl_compiler_rev=n][,{data|file}=file1[:file2]...]\n"
Blue Swirlad960902010-03-29 19:23:52 +00001170 " ACPI table description\n", QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001171STEXI
1172@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 +01001173@findex -acpitable
blueswir15824d652009-03-28 06:44:27 +00001174Add ACPI table with specified header fields and context from specified files.
Michael Tokarev104bf022011-05-12 18:44:17 +04001175For file=, take whole ACPI table from the specified files, including all
1176ACPI headers (possible overridden by other options).
1177For data=, only data
1178portion of the table is used, all header information is specified in the
1179command line.
blueswir15824d652009-03-28 06:44:27 +00001180ETEXI
1181
aliguorib6f6e3d2009-04-17 18:59:56 +00001182DEF("smbios", HAS_ARG, QEMU_OPTION_smbios,
1183 "-smbios file=binary\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -07001184 " load SMBIOS entry from binary file\n"
Paolo Bonzinie8105eb2010-02-04 16:49:59 +01001185 "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -07001186 " specify SMBIOS type 0 fields\n"
aliguorib6f6e3d2009-04-17 18:59:56 +00001187 "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n"
1188 " [,uuid=uuid][,sku=str][,family=str]\n"
Blue Swirlad960902010-03-29 19:23:52 +00001189 " specify SMBIOS type 1 fields\n", QEMU_ARCH_I386)
aliguorib6f6e3d2009-04-17 18:59:56 +00001190STEXI
1191@item -smbios file=@var{binary}
Stefan Weil6616b2a2010-02-05 23:52:05 +01001192@findex -smbios
aliguorib6f6e3d2009-04-17 18:59:56 +00001193Load SMBIOS entry from binary file.
1194
1195@item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}]
Stefan Weil6616b2a2010-02-05 23:52:05 +01001196@findex -smbios
aliguorib6f6e3d2009-04-17 18:59:56 +00001197Specify SMBIOS type 0 fields
1198
Blue Swirl609c1da2010-03-18 18:41:49 +00001199@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 +00001200Specify SMBIOS type 1 fields
1201ETEXI
1202
blueswir15824d652009-03-28 06:44:27 +00001203DEFHEADING()
blueswir15824d652009-03-28 06:44:27 +00001204STEXI
1205@end table
1206ETEXI
1207
1208DEFHEADING(Network options:)
1209STEXI
1210@table @option
1211ETEXI
1212
Jan Kiszkaad196a92009-06-24 14:42:28 +02001213HXCOMM Legacy slirp options (now moved to -net user):
1214#ifdef CONFIG_SLIRP
Blue Swirlad960902010-03-29 19:23:52 +00001215DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL)
1216DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL)
1217DEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL)
Jan Kiszkaad196a92009-06-24 14:42:28 +02001218#ifndef _WIN32
Blue Swirlad960902010-03-29 19:23:52 +00001219DEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL)
Jan Kiszkaad196a92009-06-24 14:42:28 +02001220#endif
1221#endif
1222
Blue Swirlbab79442009-06-09 21:50:02 +03001223DEF("net", HAS_ARG, QEMU_OPTION_net,
Michael S. Tsirkinffe63702009-06-21 19:51:18 +03001224 "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n"
blueswir15824d652009-03-28 06:44:27 +00001225 " create a new Network Interface Card and connect it to VLAN 'n'\n"
1226#ifdef CONFIG_SLIRP
Jan Kiszkac54ed5b2011-07-20 12:20:14 +02001227 "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=on|off]\n"
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001228 " [,hostname=host][,dhcpstart=addr][,dns=addr][,tftp=dir][,bootfile=f]\n"
1229 " [,hostfwd=rule][,guestfwd=rule]"
Jan Kiszkaad196a92009-06-24 14:42:28 +02001230#ifndef _WIN32
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001231 "[,smb=dir[,smbserver=addr]]\n"
Jan Kiszkaad196a92009-06-24 14:42:28 +02001232#endif
1233 " connect the user mode network stack to VLAN 'n', configure its\n"
1234 " DHCP server and enabled optional services\n"
blueswir15824d652009-03-28 06:44:27 +00001235#endif
1236#ifdef _WIN32
1237 "-net tap[,vlan=n][,name=str],ifname=name\n"
1238 " connect the host TAP network interface to VLAN 'n'\n"
1239#else
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001240 "-net tap[,vlan=n][,name=str][,fd=h][,ifname=name][,script=file][,downscript=dfile][,helper=helper][,sndbuf=nbytes][,vnet_hdr=on|off][,vhost=on|off][,vhostfd=h][,vhostforce=on|off]\n"
1241 " connect the host TAP network interface to VLAN 'n' \n"
1242 " use network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n"
1243 " to configure it and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n"
1244 " to deconfigure it\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -07001245 " use '[down]script=no' to disable script execution\n"
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001246 " use network helper 'helper' (default=" DEFAULT_BRIDGE_HELPER ") to\n"
1247 " configure it\n"
blueswir15824d652009-03-28 06:44:27 +00001248 " use 'fd=h' to connect to an already opened TAP interface\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -07001249 " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n"
Michael S. Tsirkinf157ed22011-02-01 14:25:40 +02001250 " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -07001251 " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n"
1252 " 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 +02001253 " use vhost=on to enable experimental in kernel accelerator\n"
mst@redhat.com5430a282011-02-01 22:13:42 +02001254 " (only has effect for virtio guests which use MSIX)\n"
1255 " use vhostforce=on to force vhost on for non-MSIX virtio guests\n"
Michael S. Tsirkin82b0d802010-03-17 13:08:24 +02001256 " use 'vhostfd=h' to connect to an already opened vhost net device\n"
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001257 "-net bridge[,vlan=n][,name=str][,br=bridge][,helper=helper]\n"
1258 " connects a host TAP network interface to a host bridge device 'br'\n"
1259 " (default=" DEFAULT_BRIDGE_INTERFACE ") using the program 'helper'\n"
1260 " (default=" DEFAULT_BRIDGE_HELPER ")\n"
Mark McLoughlin0df0ff62009-06-18 18:21:34 +01001261#endif
blueswir15824d652009-03-28 06:44:27 +00001262 "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n"
1263 " connect the vlan 'n' to another VLAN using a socket connection\n"
Mike Ryan3a75e742010-12-01 11:16:47 -08001264 "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port[,localaddr=addr]]\n"
blueswir15824d652009-03-28 06:44:27 +00001265 " connect the vlan 'n' to multicast maddr and port\n"
Mike Ryan3a75e742010-12-01 11:16:47 -08001266 " use 'localaddr=addr' to specify the host address to send packets from\n"
Benjamin0e0e7fa2012-01-11 09:20:54 +09001267 "-net socket[,vlan=n][,name=str][,fd=h][,udp=host:port][,localaddr=host:port]\n"
1268 " connect the vlan 'n' to another VLAN using an UDP tunnel\n"
blueswir15824d652009-03-28 06:44:27 +00001269#ifdef CONFIG_VDE
1270 "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n"
1271 " connect the vlan 'n' to port 'n' of a vde switch running\n"
1272 " on host and listening for incoming connections on 'socketpath'.\n"
1273 " Use group 'groupname' and mode 'octalmode' to change default\n"
1274 " ownership and permissions for communication port.\n"
1275#endif
aliguoribb9ea792009-04-21 19:56:28 +00001276 "-net dump[,vlan=n][,file=f][,len=n]\n"
1277 " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -07001278 "-net none use it alone to have zero network devices. If no -net option\n"
Blue Swirlad960902010-03-29 19:23:52 +00001279 " is provided, the default is '-net nic -net user'\n", QEMU_ARCH_ALL)
Mark McLoughlina1ea4582009-10-08 19:58:26 +01001280DEF("netdev", HAS_ARG, QEMU_OPTION_netdev,
1281 "-netdev ["
1282#ifdef CONFIG_SLIRP
1283 "user|"
1284#endif
1285 "tap|"
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001286 "bridge|"
Mark McLoughlina1ea4582009-10-08 19:58:26 +01001287#ifdef CONFIG_VDE
1288 "vde|"
1289#endif
Blue Swirlad960902010-03-29 19:23:52 +00001290 "socket],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001291STEXI
Blue Swirl609c1da2010-03-18 18:41:49 +00001292@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 +01001293@findex -net
blueswir15824d652009-03-28 06:44:27 +00001294Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
Anthony Liguori0d6b0b12009-08-14 11:20:47 -05001295= 0 is the default). The NIC is an e1000 by default on the PC
Markus Armbruster5607c382009-06-18 15:14:08 +02001296target. Optionally, the MAC address can be changed to @var{mac}, the
1297device address set to @var{addr} (PCI cards only),
Michael S. Tsirkinffe63702009-06-21 19:51:18 +03001298and a @var{name} can be assigned for use in monitor commands.
1299Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
1300that the card should have; this option currently only affects virtio cards; set
1301@var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
1302NIC is created. Qemu can emulate several different models of network card.
blueswir15824d652009-03-28 06:44:27 +00001303Valid values for @var{type} are
Michael S. Tsirkinffe63702009-06-21 19:51:18 +03001304@code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er},
blueswir15824d652009-03-28 06:44:27 +00001305@code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
1306@code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
1307Not all devices are supported on all targets. Use -net nic,model=?
1308for a list of available devices for your target.
1309
Jan Kiszkaad196a92009-06-24 14:42:28 +02001310@item -net user[,@var{option}][,@var{option}][,...]
blueswir15824d652009-03-28 06:44:27 +00001311Use the user mode network stack which requires no administrator
Jan Kiszkaad196a92009-06-24 14:42:28 +02001312privilege to run. Valid options are:
blueswir15824d652009-03-28 06:44:27 +00001313
Kevin Wolfb3f046c2009-10-09 10:58:35 +02001314@table @option
Jan Kiszkaad196a92009-06-24 14:42:28 +02001315@item vlan=@var{n}
1316Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default).
1317
1318@item name=@var{name}
1319Assign symbolic name for use in monitor commands.
1320
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001321@item net=@var{addr}[/@var{mask}]
1322Set IP network address the guest will see. Optionally specify the netmask,
1323either in the form a.b.c.d or as number of valid top-most bits. Default is
Brad Hardsb0b36e52011-04-24 17:19:56 +1000132410.0.2.0/24.
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001325
1326@item host=@var{addr}
1327Specify the guest-visible address of the host. Default is the 2nd IP in the
1328guest network, i.e. x.x.x.2.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001329
Jan Kiszkac54ed5b2011-07-20 12:20:14 +02001330@item restrict=on|off
Brad Hardscaef55e2011-06-09 07:50:43 +10001331If this option is enabled, the guest will be isolated, i.e. it will not be
Jan Kiszkaad196a92009-06-24 14:42:28 +02001332able to contact the host and no guest IP packets will be routed over the host
Brad Hardscaef55e2011-06-09 07:50:43 +10001333to the outside. This option does not affect any explicitly set forwarding rules.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001334
1335@item hostname=@var{name}
1336Specifies the client hostname reported by the builtin DHCP server.
1337
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001338@item dhcpstart=@var{addr}
1339Specify the first of the 16 IPs the built-in DHCP server can assign. Default
Brad Hardsb0b36e52011-04-24 17:19:56 +10001340is the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31.
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001341
1342@item dns=@var{addr}
1343Specify the guest-visible address of the virtual nameserver. The address must
1344be different from the host address. Default is the 3rd IP in the guest network,
1345i.e. x.x.x.3.
1346
Jan Kiszkaad196a92009-06-24 14:42:28 +02001347@item tftp=@var{dir}
1348When using the user mode network stack, activate a built-in TFTP
1349server. The files in @var{dir} will be exposed as the root of a TFTP server.
1350The TFTP client on the guest must be configured in binary mode (use the command
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001351@code{bin} of the Unix TFTP client).
Jan Kiszkaad196a92009-06-24 14:42:28 +02001352
1353@item bootfile=@var{file}
1354When using the user mode network stack, broadcast @var{file} as the BOOTP
1355filename. In conjunction with @option{tftp}, this can be used to network boot
1356a guest from a local directory.
1357
1358Example (using pxelinux):
1359@example
1360qemu -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
1361@end example
1362
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001363@item smb=@var{dir}[,smbserver=@var{addr}]
Jan Kiszkaad196a92009-06-24 14:42:28 +02001364When using the user mode network stack, activate a built-in SMB
1365server so that Windows OSes can access to the host files in @file{@var{dir}}
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001366transparently. The IP address of the SMB server can be set to @var{addr}. By
1367default the 4th IP in the guest network is used, i.e. x.x.x.4.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001368
1369In the guest Windows OS, the line:
1370@example
137110.0.2.4 smbserver
1372@end example
1373must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
1374or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
1375
1376Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
1377
Brade2d88302011-09-02 16:53:28 -04001378Note that a SAMBA server must be installed on the host OS.
1379QEMU was tested successfully with smbd versions from Red Hat 9,
1380Fedora Core 3 and OpenSUSE 11.x.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001381
Jan Kiszka3c6a0582009-06-24 14:42:28 +02001382@item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001383Redirect incoming TCP or UDP connections to the host port @var{hostport} to
1384the guest IP address @var{guestaddr} on guest port @var{guestport}. If
1385@var{guestaddr} is not specified, its value is x.x.x.15 (default first address
Jan Kiszka3c6a0582009-06-24 14:42:28 +02001386given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
1387be bound to a specific host interface. If no connection type is set, TCP is
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001388used. This option can be given multiple times.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001389
1390For example, to redirect host X11 connection from screen 1 to guest
1391screen 0, use the following:
1392
1393@example
1394# on the host
Jan Kiszka3c6a0582009-06-24 14:42:28 +02001395qemu -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...]
Jan Kiszkaad196a92009-06-24 14:42:28 +02001396# this host xterm should open in the guest X11 server
1397xterm -display :1
1398@end example
1399
1400To redirect telnet connections from host port 5555 to telnet port on
1401the guest, use the following:
1402
1403@example
1404# on the host
Aurelien Jarnoaa375202010-02-27 10:50:32 +01001405qemu -net user,hostfwd=tcp::5555-:23 [...]
Jan Kiszkaad196a92009-06-24 14:42:28 +02001406telnet localhost 5555
1407@end example
1408
1409Then when you use on the host @code{telnet localhost 5555}, you
1410connect to the guest telnet server.
1411
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001412@item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
Jan Kiszka3c6a0582009-06-24 14:42:28 +02001413Forward guest TCP connections to the IP address @var{server} on port @var{port}
1414to the character device @var{dev}. This option can be given multiple times.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001415
1416@end table
1417
1418Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still
1419processed and applied to -net user. Mixing them with the new configuration
1420syntax gives undefined results. Their use for new applications is discouraged
1421as they will be removed from future versions.
blueswir15824d652009-03-28 06:44:27 +00001422
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001423@item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}]
1424Connect the host TAP network interface @var{name} to VLAN @var{n}.
1425
1426Use the network script @var{file} to configure it and the network script
blueswir15824d652009-03-28 06:44:27 +00001427@var{dfile} to deconfigure it. If @var{name} is not provided, the OS
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001428automatically provides one. The default network configure script is
1429@file{/etc/qemu-ifup} and the default network deconfigure script is
1430@file{/etc/qemu-ifdown}. Use @option{script=no} or @option{downscript=no}
1431to disable script execution.
1432
1433If running QEMU as an unprivileged user, use the network helper
1434@var{helper} to configure the TAP interface. The default network
1435helper executable is @file{/usr/local/libexec/qemu-bridge-helper}.
1436
1437@option{fd}=@var{h} can be used to specify the handle of an already
1438opened host TAP interface.
1439
1440Examples:
blueswir15824d652009-03-28 06:44:27 +00001441
1442@example
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001443#launch a QEMU instance with the default network script
blueswir15824d652009-03-28 06:44:27 +00001444qemu linux.img -net nic -net tap
1445@end example
1446
blueswir15824d652009-03-28 06:44:27 +00001447@example
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001448#launch a QEMU instance with two NICs, each one connected
1449#to a TAP device
blueswir15824d652009-03-28 06:44:27 +00001450qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
1451 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
1452@end example
1453
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001454@example
1455#launch a QEMU instance with the default network helper to
1456#connect a TAP device to bridge br0
1457qemu linux.img -net nic -net tap,"helper=/usr/local/libexec/qemu-bridge-helper"
1458@end example
1459
1460@item -net bridge[,vlan=@var{n}][,name=@var{name}][,br=@var{bridge}][,helper=@var{helper}]
1461Connect a host TAP network interface to a host bridge device.
1462
1463Use the network helper @var{helper} to configure the TAP interface and
1464attach it to the bridge. The default network helper executable is
1465@file{/usr/local/libexec/qemu-bridge-helper} and the default bridge
1466device is @file{br0}.
1467
1468Examples:
1469
1470@example
1471#launch a QEMU instance with the default network helper to
1472#connect a TAP device to bridge br0
1473qemu linux.img -net bridge -net nic,model=virtio
1474@end example
1475
1476@example
1477#launch a QEMU instance with the default network helper to
1478#connect a TAP device to bridge qemubr0
1479qemu linux.img -net bridge,br=qemubr0 -net nic,model=virtio
1480@end example
1481
Blue Swirl609c1da2010-03-18 18:41:49 +00001482@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 +00001483
1484Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
1485machine using a TCP socket connection. If @option{listen} is
1486specified, QEMU waits for incoming connections on @var{port}
1487(@var{host} is optional). @option{connect} is used to connect to
1488another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
1489specifies an already opened TCP socket.
1490
1491Example:
1492@example
1493# launch a first QEMU instance
1494qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1495 -net socket,listen=:1234
1496# connect the VLAN 0 of this instance to the VLAN 0
1497# of the first instance
1498qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1499 -net socket,connect=127.0.0.1:1234
1500@end example
1501
Mike Ryan3a75e742010-12-01 11:16:47 -08001502@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]]
blueswir15824d652009-03-28 06:44:27 +00001503
1504Create a VLAN @var{n} shared with another QEMU virtual
1505machines using a UDP multicast socket, effectively making a bus for
1506every QEMU with same multicast address @var{maddr} and @var{port}.
1507NOTES:
1508@enumerate
1509@item
1510Several QEMU can be running on different hosts and share same bus (assuming
1511correct multicast setup for these hosts).
1512@item
1513mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
1514@url{http://user-mode-linux.sf.net}.
1515@item
1516Use @option{fd=h} to specify an already opened UDP multicast socket.
1517@end enumerate
1518
1519Example:
1520@example
1521# launch one QEMU instance
1522qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1523 -net socket,mcast=230.0.0.1:1234
1524# launch another QEMU instance on same "bus"
1525qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1526 -net socket,mcast=230.0.0.1:1234
1527# launch yet another QEMU instance on same "bus"
1528qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
1529 -net socket,mcast=230.0.0.1:1234
1530@end example
1531
1532Example (User Mode Linux compat.):
1533@example
1534# launch QEMU instance (note mcast address selected
1535# is UML's default)
1536qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1537 -net socket,mcast=239.192.168.1:1102
1538# launch UML
1539/path/to/linux ubd0=/path/to/root_fs eth0=mcast
1540@end example
1541
Mike Ryan3a75e742010-12-01 11:16:47 -08001542Example (send packets from host's 1.2.3.4):
1543@example
1544qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1545 -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4
1546@end example
1547
Blue Swirl609c1da2010-03-18 18:41:49 +00001548@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 +00001549Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
1550listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
1551and MODE @var{octalmode} to change default ownership and permissions for
Stefan Weilc1ba4e02011-09-05 18:13:03 +02001552communication port. This option is only available if QEMU has been compiled
blueswir15824d652009-03-28 06:44:27 +00001553with vde support enabled.
1554
1555Example:
1556@example
1557# launch vde switch
1558vde_switch -F -sock /tmp/myswitch
1559# launch QEMU instance
1560qemu linux.img -net nic -net vde,sock=/tmp/myswitch
1561@end example
1562
aliguoribb9ea792009-04-21 19:56:28 +00001563@item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
1564Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
1565At most @var{len} bytes (64k by default) per packet are stored. The file format is
1566libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
1567
blueswir15824d652009-03-28 06:44:27 +00001568@item -net none
1569Indicate that no network devices should be configured. It is used to
1570override the default configuration (@option{-net nic -net user}) which
1571is activated if no @option{-net} options are provided.
blueswir15824d652009-03-28 06:44:27 +00001572
1573@end table
1574ETEXI
1575
Matthew Booth7273a2d2009-10-30 13:41:12 +00001576DEFHEADING()
1577
1578DEFHEADING(Character device options:)
1579
1580DEF("chardev", HAS_ARG, QEMU_OPTION_chardev,
Jan Kiszka97331282010-04-06 16:55:54 +02001581 "-chardev null,id=id[,mux=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00001582 "-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n"
Jan Kiszka97331282010-04-06 16:55:54 +02001583 " [,server][,nowait][,telnet][,mux=on|off] (tcp)\n"
1584 "-chardev socket,id=id,path=path[,server][,nowait][,telnet],[mux=on|off] (unix)\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00001585 "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n"
Jan Kiszka97331282010-04-06 16:55:54 +02001586 " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n"
1587 "-chardev msmouse,id=id[,mux=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00001588 "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n"
Jan Kiszka97331282010-04-06 16:55:54 +02001589 " [,mux=on|off]\n"
1590 "-chardev file,id=id,path=path[,mux=on|off]\n"
1591 "-chardev pipe,id=id,path=path[,mux=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00001592#ifdef _WIN32
Jan Kiszka97331282010-04-06 16:55:54 +02001593 "-chardev console,id=id[,mux=on|off]\n"
1594 "-chardev serial,id=id,path=path[,mux=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00001595#else
Jan Kiszka97331282010-04-06 16:55:54 +02001596 "-chardev pty,id=id[,mux=on|off]\n"
Aurelien Jarnob7fdb3a2010-07-13 21:13:12 +02001597 "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00001598#endif
1599#ifdef CONFIG_BRLAPI
Jan Kiszka97331282010-04-06 16:55:54 +02001600 "-chardev braille,id=id[,mux=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00001601#endif
1602#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
1603 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
Jan Kiszka97331282010-04-06 16:55:54 +02001604 "-chardev tty,id=id,path=path[,mux=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00001605#endif
1606#if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__)
Jan Kiszka97331282010-04-06 16:55:54 +02001607 "-chardev parport,id=id,path=path[,mux=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00001608#endif
Alon Levycbcc6332011-01-19 10:49:50 +02001609#if defined(CONFIG_SPICE)
1610 "-chardev spicevmc,id=id,name=name[,debug=debug]\n"
1611#endif
Blue Swirlad960902010-03-29 19:23:52 +00001612 , QEMU_ARCH_ALL
Matthew Booth7273a2d2009-10-30 13:41:12 +00001613)
1614
1615STEXI
1616
1617The general form of a character device option is:
1618@table @option
1619
Jan Kiszka97331282010-04-06 16:55:54 +02001620@item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}]
Stefan Weil6616b2a2010-02-05 23:52:05 +01001621@findex -chardev
Matthew Booth7273a2d2009-10-30 13:41:12 +00001622Backend is one of:
1623@option{null},
1624@option{socket},
1625@option{udp},
1626@option{msmouse},
1627@option{vc},
1628@option{file},
1629@option{pipe},
1630@option{console},
1631@option{serial},
1632@option{pty},
1633@option{stdio},
1634@option{braille},
1635@option{tty},
Alon Levycbcc6332011-01-19 10:49:50 +02001636@option{parport},
1637@option{spicevmc}.
Matthew Booth7273a2d2009-10-30 13:41:12 +00001638The specific backend will determine the applicable options.
1639
1640All devices must have an id, which can be any string up to 127 characters long.
1641It is used to uniquely identify this device in other command line directives.
1642
Jan Kiszka97331282010-04-06 16:55:54 +02001643A character device may be used in multiplexing mode by multiple front-ends.
1644The key sequence of @key{Control-a} and @key{c} will rotate the input focus
1645between attached front-ends. Specify @option{mux=on} to enable this mode.
1646
Matthew Booth7273a2d2009-10-30 13:41:12 +00001647Options to each backend are described below.
1648
1649@item -chardev null ,id=@var{id}
1650A void device. This device will not emit any data, and will drop any data it
1651receives. The null backend does not take any options.
1652
1653@item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet]
1654
1655Create a two-way stream socket, which can be either a TCP or a unix socket. A
1656unix socket will be created if @option{path} is specified. Behaviour is
1657undefined if TCP options are specified for a unix socket.
1658
1659@option{server} specifies that the socket shall be a listening socket.
1660
1661@option{nowait} specifies that QEMU should not block waiting for a client to
1662connect to a listening socket.
1663
1664@option{telnet} specifies that traffic on the socket should interpret telnet
1665escape sequences.
1666
1667TCP and unix socket options are given below:
1668
1669@table @option
1670
Aurelien Jarno8d533562010-03-27 11:52:05 +01001671@item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay]
Matthew Booth7273a2d2009-10-30 13:41:12 +00001672
1673@option{host} for a listening socket specifies the local address to be bound.
1674For a connecting socket species the remote host to connect to. @option{host} is
1675optional for listening sockets. If not specified it defaults to @code{0.0.0.0}.
1676
1677@option{port} for a listening socket specifies the local port to be bound. For a
1678connecting socket specifies the port on the remote host to connect to.
1679@option{port} can be given as either a port number or a service name.
1680@option{port} is required.
1681
1682@option{to} is only relevant to listening sockets. If it is specified, and
1683@option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up
1684to and including @option{to} until it succeeds. @option{to} must be specified
1685as a port number.
1686
1687@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1688If neither is specified the socket may use either protocol.
1689
1690@option{nodelay} disables the Nagle algorithm.
1691
1692@item unix options: path=@var{path}
1693
1694@option{path} specifies the local path of the unix socket. @option{path} is
1695required.
1696
1697@end table
1698
1699@item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6]
1700
1701Sends all traffic from the guest to a remote host over UDP.
1702
1703@option{host} specifies the remote host to connect to. If not specified it
1704defaults to @code{localhost}.
1705
1706@option{port} specifies the port on the remote host to connect to. @option{port}
1707is required.
1708
1709@option{localaddr} specifies the local address to bind to. If not specified it
1710defaults to @code{0.0.0.0}.
1711
1712@option{localport} specifies the local port to bind to. If not specified any
1713available local port will be used.
1714
1715@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1716If neither is specified the device may use either protocol.
1717
1718@item -chardev msmouse ,id=@var{id}
1719
1720Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not
1721take any options.
1722
1723@item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]]
1724
1725Connect to a QEMU text console. @option{vc} may optionally be given a specific
1726size.
1727
1728@option{width} and @option{height} specify the width and height respectively of
1729the console, in pixels.
1730
1731@option{cols} and @option{rows} specify that the console be sized to fit a text
1732console with the given dimensions.
1733
1734@item -chardev file ,id=@var{id} ,path=@var{path}
1735
1736Log all traffic received from the guest to a file.
1737
1738@option{path} specifies the path of the file to be opened. This file will be
1739created if it does not already exist, and overwritten if it does. @option{path}
1740is required.
1741
1742@item -chardev pipe ,id=@var{id} ,path=@var{path}
1743
1744Create a two-way connection to the guest. The behaviour differs slightly between
1745Windows hosts and other hosts:
1746
1747On Windows, a single duplex pipe will be created at
1748@file{\\.pipe\@option{path}}.
1749
1750On other hosts, 2 pipes will be created called @file{@option{path}.in} and
1751@file{@option{path}.out}. Data written to @file{@option{path}.in} will be
1752received by the guest. Data written by the guest can be read from
1753@file{@option{path}.out}. QEMU will not create these fifos, and requires them to
1754be present.
1755
1756@option{path} forms part of the pipe path as described above. @option{path} is
1757required.
1758
1759@item -chardev console ,id=@var{id}
1760
1761Send traffic from the guest to QEMU's standard output. @option{console} does not
1762take any options.
1763
1764@option{console} is only available on Windows hosts.
1765
1766@item -chardev serial ,id=@var{id} ,path=@option{path}
1767
1768Send traffic from the guest to a serial device on the host.
1769
1770@option{serial} is
1771only available on Windows hosts.
1772
1773@option{path} specifies the name of the serial device to open.
1774
1775@item -chardev pty ,id=@var{id}
1776
1777Create a new pseudo-terminal on the host and connect to it. @option{pty} does
1778not take any options.
1779
1780@option{pty} is not available on Windows hosts.
1781
Aurelien Jarnob7fdb3a2010-07-13 21:13:12 +02001782@item -chardev stdio ,id=@var{id} [,signal=on|off]
Matthew Booth7273a2d2009-10-30 13:41:12 +00001783Connect to standard input and standard output of the qemu process.
Aurelien Jarnob7fdb3a2010-07-13 21:13:12 +02001784
1785@option{signal} controls if signals are enabled on the terminal, that includes
1786exiting QEMU with the key sequence @key{Control-c}. This option is enabled by
1787default, use @option{signal=off} to disable it.
1788
1789@option{stdio} is not available on Windows hosts.
Matthew Booth7273a2d2009-10-30 13:41:12 +00001790
1791@item -chardev braille ,id=@var{id}
1792
1793Connect to a local BrlAPI server. @option{braille} does not take any options.
1794
1795@item -chardev tty ,id=@var{id} ,path=@var{path}
1796
1797Connect to a local tty device.
1798
1799@option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and
1800DragonFlyBSD hosts.
1801
1802@option{path} specifies the path to the tty. @option{path} is required.
1803
1804@item -chardev parport ,id=@var{id} ,path=@var{path}
1805
1806@option{parport} is only available on Linux, FreeBSD and DragonFlyBSD hosts.
1807
1808Connect to a local parallel port.
1809
1810@option{path} specifies the path to the parallel port device. @option{path} is
1811required.
1812
Alon Levycbcc6332011-01-19 10:49:50 +02001813@item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name}
1814
Stefan Hajnoczi3a846902011-10-06 11:24:12 +01001815@option{spicevmc} is only available when spice support is built in.
1816
Alon Levycbcc6332011-01-19 10:49:50 +02001817@option{debug} debug level for spicevmc
1818
1819@option{name} name of spice channel to connect to
1820
1821Connect to a spice virtual machine channel, such as vdiport.
Alon Levycbcc6332011-01-19 10:49:50 +02001822
Matthew Booth7273a2d2009-10-30 13:41:12 +00001823@end table
1824ETEXI
1825
1826DEFHEADING()
1827
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +11001828STEXI
1829DEFHEADING(Device URL Syntax:)
1830
1831In addition to using normal file images for the emulated storage devices,
1832QEMU can also use networked resources such as iSCSI devices. These are
1833specified using a special URL syntax.
1834
1835@table @option
1836@item iSCSI
1837iSCSI support allows QEMU to access iSCSI resources directly and use as
1838images for the guest storage. Both disk and cdrom images are supported.
1839
1840Syntax for specifying iSCSI LUNs is
1841``iscsi://<target-ip>[:<port>]/<target-iqn>/<lun>''
1842
1843Example (without authentication):
1844@example
1845qemu -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \
1846--drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1
1847@end example
1848
1849Example (CHAP username/password via URL):
1850@example
1851qemu --drive file=iscsi://user%password@@192.0.2.1/iqn.2001-04.com.example/1
1852@end example
1853
1854Example (CHAP username/password via environment variables):
1855@example
1856LIBISCSI_CHAP_USERNAME="user" \
1857LIBISCSI_CHAP_PASSWORD="password" \
1858qemu --drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1
1859@end example
1860
1861iSCSI support is an optional feature of QEMU and only available when
1862compiled and linked against libiscsi.
1863
Ronnie Sahlberg08ae3302011-10-27 20:33:21 +11001864@item NBD
1865QEMU supports NBD (Network Block Devices) both using TCP protocol as well
1866as Unix Domain Sockets.
1867
1868Syntax for specifying a NBD device using TCP
1869``nbd:<server-ip>:<port>[:exportname=<export>]''
1870
1871Syntax for specifying a NBD device using Unix Domain Sockets
1872``nbd:unix:<domain-socket>[:exportname=<export>]''
1873
1874
1875Example for TCP
1876@example
1877qemu --drive file=nbd:192.0.2.1:30000
1878@end example
1879
1880Example for Unix Domain Sockets
1881@example
1882qemu --drive file=nbd:unix:/tmp/nbd-socket
1883@end example
1884
Ronnie Sahlbergd9990222011-10-28 20:13:39 +11001885@item Sheepdog
1886Sheepdog is a distributed storage system for QEMU.
1887QEMU supports using either local sheepdog devices or remote networked
1888devices.
1889
1890Syntax for specifying a sheepdog device
1891@table @list
1892``sheepdog:<vdiname>''
1893
1894``sheepdog:<vdiname>:<snapid>''
1895
1896``sheepdog:<vdiname>:<tag>''
1897
1898``sheepdog:<host>:<port>:<vdiname>''
1899
1900``sheepdog:<host>:<port>:<vdiname>:<snapid>''
1901
1902``sheepdog:<host>:<port>:<vdiname>:<tag>''
1903@end table
1904
1905Example
1906@example
1907qemu --drive file=sheepdog:192.0.2.1:30000:MyVirtualMachine
1908@end example
1909
1910See also @url{http://http://www.osrg.net/sheepdog/}.
1911
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +11001912@end table
1913ETEXI
1914
Matthew Booth7273a2d2009-10-30 13:41:12 +00001915DEFHEADING(Bluetooth(R) options:)
1916
blueswir15824d652009-03-28 06:44:27 +00001917DEF("bt", HAS_ARG, QEMU_OPTION_bt, \
blueswir15824d652009-03-28 06:44:27 +00001918 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \
1919 "-bt hci,host[:id]\n" \
1920 " use host's HCI with the given name\n" \
1921 "-bt hci[,vlan=n]\n" \
1922 " emulate a standard HCI in virtual scatternet 'n'\n" \
1923 "-bt vhci[,vlan=n]\n" \
1924 " add host computer to virtual scatternet 'n' using VHCI\n" \
1925 "-bt device:dev[,vlan=n]\n" \
Blue Swirlad960902010-03-29 19:23:52 +00001926 " emulate a bluetooth device 'dev' in scatternet 'n'\n",
1927 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001928STEXI
blueswir15824d652009-03-28 06:44:27 +00001929@table @option
1930
1931@item -bt hci[...]
Stefan Weil6616b2a2010-02-05 23:52:05 +01001932@findex -bt
blueswir15824d652009-03-28 06:44:27 +00001933Defines the function of the corresponding Bluetooth HCI. -bt options
1934are matched with the HCIs present in the chosen machine type. For
1935example when emulating a machine with only one HCI built into it, only
1936the first @code{-bt hci[...]} option is valid and defines the HCI's
1937logic. The Transport Layer is decided by the machine type. Currently
1938the machines @code{n800} and @code{n810} have one HCI and all other
1939machines have none.
1940
1941@anchor{bt-hcis}
1942The following three types are recognized:
1943
Kevin Wolfb3f046c2009-10-09 10:58:35 +02001944@table @option
blueswir15824d652009-03-28 06:44:27 +00001945@item -bt hci,null
1946(default) The corresponding Bluetooth HCI assumes no internal logic
1947and will not respond to any HCI commands or emit events.
1948
1949@item -bt hci,host[:@var{id}]
1950(@code{bluez} only) The corresponding HCI passes commands / events
1951to / from the physical HCI identified by the name @var{id} (default:
1952@code{hci0}) on the computer running QEMU. Only available on @code{bluez}
1953capable systems like Linux.
1954
1955@item -bt hci[,vlan=@var{n}]
1956Add a virtual, standard HCI that will participate in the Bluetooth
1957scatternet @var{n} (default @code{0}). Similarly to @option{-net}
1958VLANs, devices inside a bluetooth network @var{n} can only communicate
1959with other devices in the same network (scatternet).
1960@end table
1961
1962@item -bt vhci[,vlan=@var{n}]
1963(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
1964to the host bluetooth stack instead of to the emulated target. This
1965allows the host and target machines to participate in a common scatternet
1966and communicate. Requires the Linux @code{vhci} driver installed. Can
1967be used as following:
1968
1969@example
1970qemu [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
1971@end example
1972
1973@item -bt device:@var{dev}[,vlan=@var{n}]
1974Emulate a bluetooth device @var{dev} and place it in network @var{n}
1975(default @code{0}). QEMU can only emulate one type of bluetooth devices
1976currently:
1977
Kevin Wolfb3f046c2009-10-09 10:58:35 +02001978@table @option
blueswir15824d652009-03-28 06:44:27 +00001979@item keyboard
1980Virtual wireless keyboard implementing the HIDP bluetooth profile.
1981@end table
1982@end table
1983ETEXI
1984
1985DEFHEADING()
1986
Alexander Graf7677f052009-06-28 16:55:55 +02001987DEFHEADING(Linux/Multiboot boot specific:)
blueswir15824d652009-03-28 06:44:27 +00001988STEXI
Alexander Graf7677f052009-06-28 16:55:55 +02001989
1990When using these options, you can use a given Linux or Multiboot
1991kernel without installing it in the disk image. It can be useful
blueswir15824d652009-03-28 06:44:27 +00001992for easier testing of various kernels.
1993
1994@table @option
1995ETEXI
1996
1997DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \
Blue Swirlad960902010-03-29 19:23:52 +00001998 "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001999STEXI
2000@item -kernel @var{bzImage}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002001@findex -kernel
Alexander Graf7677f052009-06-28 16:55:55 +02002002Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel
2003or in multiboot format.
blueswir15824d652009-03-28 06:44:27 +00002004ETEXI
2005
2006DEF("append", HAS_ARG, QEMU_OPTION_append, \
Blue Swirlad960902010-03-29 19:23:52 +00002007 "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002008STEXI
2009@item -append @var{cmdline}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002010@findex -append
blueswir15824d652009-03-28 06:44:27 +00002011Use @var{cmdline} as kernel command line
2012ETEXI
2013
2014DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \
Blue Swirlad960902010-03-29 19:23:52 +00002015 "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002016STEXI
2017@item -initrd @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002018@findex -initrd
blueswir15824d652009-03-28 06:44:27 +00002019Use @var{file} as initial ram disk.
Alexander Graf7677f052009-06-28 16:55:55 +02002020
2021@item -initrd "@var{file1} arg=foo,@var{file2}"
2022
2023This syntax is only available with multiboot.
2024
2025Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the
2026first module.
blueswir15824d652009-03-28 06:44:27 +00002027ETEXI
2028
2029STEXI
2030@end table
2031ETEXI
2032
2033DEFHEADING()
2034
2035DEFHEADING(Debug/Expert options:)
2036
2037STEXI
2038@table @option
2039ETEXI
2040
2041DEF("serial", HAS_ARG, QEMU_OPTION_serial, \
Blue Swirlad960902010-03-29 19:23:52 +00002042 "-serial dev redirect the serial port to char device 'dev'\n",
2043 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002044STEXI
2045@item -serial @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002046@findex -serial
blueswir15824d652009-03-28 06:44:27 +00002047Redirect the virtual serial port to host character device
2048@var{dev}. The default device is @code{vc} in graphical mode and
2049@code{stdio} in non graphical mode.
2050
2051This option can be used several times to simulate up to 4 serial
2052ports.
2053
2054Use @code{-serial none} to disable all serial ports.
2055
2056Available character devices are:
Kevin Wolfb3f046c2009-10-09 10:58:35 +02002057@table @option
Kevin Wolf4e257e52009-10-09 10:58:36 +02002058@item vc[:@var{W}x@var{H}]
blueswir15824d652009-03-28 06:44:27 +00002059Virtual console. Optionally, a width and height can be given in pixel with
2060@example
2061vc:800x600
2062@end example
2063It is also possible to specify width or height in characters:
2064@example
2065vc:80Cx24C
2066@end example
2067@item pty
2068[Linux only] Pseudo TTY (a new PTY is automatically allocated)
2069@item none
2070No device is allocated.
2071@item null
2072void device
2073@item /dev/XXX
2074[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
2075parameters are set according to the emulated ones.
2076@item /dev/parport@var{N}
2077[Linux only, parallel port only] Use host parallel port
2078@var{N}. Currently SPP and EPP parallel port features can be used.
2079@item file:@var{filename}
2080Write output to @var{filename}. No character can be read.
2081@item stdio
2082[Unix only] standard input/output
2083@item pipe:@var{filename}
2084name pipe @var{filename}
2085@item COM@var{n}
2086[Windows only] Use host serial port @var{n}
2087@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
2088This implements UDP Net Console.
2089When @var{remote_host} or @var{src_ip} are not specified
2090they default to @code{0.0.0.0}.
2091When not using a specified @var{src_port} a random port is automatically chosen.
blueswir15824d652009-03-28 06:44:27 +00002092
2093If you just want a simple readonly console you can use @code{netcat} or
2094@code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
2095@code{nc -u -l -p 4555}. Any time qemu writes something to that port it
2096will appear in the netconsole session.
2097
2098If you plan to send characters back via netconsole or you want to stop
2099and start qemu a lot of times, you should have qemu use the same
2100source port each time by using something like @code{-serial
2101udp::4555@@:4556} to qemu. Another approach is to use a patched
2102version of netcat which can listen to a TCP port and send and receive
2103characters via udp. If you have a patched version of netcat which
2104activates telnet remote echo and single char transfer, then you can
2105use the following options to step up a netcat redirector to allow
2106telnet on port 5555 to access the qemu port.
2107@table @code
2108@item Qemu Options:
2109-serial udp::4555@@:4556
2110@item netcat options:
2111-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
2112@item telnet options:
2113localhost 5555
2114@end table
2115
2116@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay]
2117The TCP Net Console has two modes of operation. It can send the serial
2118I/O to a location or wait for a connection from a location. By default
2119the TCP Net Console is sent to @var{host} at the @var{port}. If you use
2120the @var{server} option QEMU will wait for a client socket application
2121to connect to the port before continuing, unless the @code{nowait}
2122option was specified. The @code{nodelay} option disables the Nagle buffering
2123algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only
2124one TCP connection at a time is accepted. You can use @code{telnet} to
2125connect to the corresponding character device.
2126@table @code
2127@item Example to send tcp console to 192.168.0.2 port 4444
2128-serial tcp:192.168.0.2:4444
2129@item Example to listen and wait on port 4444 for connection
2130-serial tcp::4444,server
2131@item Example to not wait and listen on ip 192.168.0.100 port 4444
2132-serial tcp:192.168.0.100:4444,server,nowait
2133@end table
2134
2135@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
2136The telnet protocol is used instead of raw tcp sockets. The options
2137work the same as if you had specified @code{-serial tcp}. The
2138difference is that the port acts like a telnet server or client using
2139telnet option negotiation. This will also allow you to send the
2140MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
2141sequence. Typically in unix telnet you do it with Control-] and then
2142type "send break" followed by pressing the enter key.
2143
2144@item unix:@var{path}[,server][,nowait]
2145A unix domain socket is used instead of a tcp socket. The option works the
2146same as if you had specified @code{-serial tcp} except the unix domain socket
2147@var{path} is used for connections.
2148
2149@item mon:@var{dev_string}
2150This is a special option to allow the monitor to be multiplexed onto
2151another serial port. The monitor is accessed with key sequence of
2152@key{Control-a} and then pressing @key{c}. See monitor access
2153@ref{pcsys_keys} in the -nographic section for more keys.
2154@var{dev_string} should be any one of the serial devices specified
2155above. An example to multiplex the monitor onto a telnet server
2156listening on port 4444 would be:
2157@table @code
2158@item -serial mon:telnet::4444,server,nowait
2159@end table
2160
2161@item braille
2162Braille device. This will use BrlAPI to display the braille output on a real
2163or fake device.
2164
Kevin Wolfbe8b28a2009-10-09 10:58:37 +02002165@item msmouse
2166Three button serial mouse. Configure the guest to use Microsoft protocol.
blueswir15824d652009-03-28 06:44:27 +00002167@end table
2168ETEXI
2169
2170DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \
Blue Swirlad960902010-03-29 19:23:52 +00002171 "-parallel dev redirect the parallel port to char device 'dev'\n",
2172 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002173STEXI
2174@item -parallel @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002175@findex -parallel
blueswir15824d652009-03-28 06:44:27 +00002176Redirect the virtual parallel port to host device @var{dev} (same
2177devices as the serial port). On Linux hosts, @file{/dev/parportN} can
2178be used to use hardware devices connected on the corresponding host
2179parallel port.
2180
2181This option can be used several times to simulate up to 3 parallel
2182ports.
2183
2184Use @code{-parallel none} to disable all parallel ports.
2185ETEXI
2186
2187DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \
Blue Swirlad960902010-03-29 19:23:52 +00002188 "-monitor dev redirect the monitor to char device 'dev'\n",
2189 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002190STEXI
Gerd Hoffmann4e307fc2009-12-08 13:11:37 +01002191@item -monitor @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002192@findex -monitor
blueswir15824d652009-03-28 06:44:27 +00002193Redirect the monitor to host device @var{dev} (same devices as the
2194serial port).
2195The default device is @code{vc} in graphical mode and @code{stdio} in
2196non graphical mode.
2197ETEXI
Gerd Hoffmann6ca55822009-12-08 13:11:52 +01002198DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \
Blue Swirlad960902010-03-29 19:23:52 +00002199 "-qmp dev like -monitor but opens in 'control' mode\n",
2200 QEMU_ARCH_ALL)
Stefan Weil95d5f082010-01-20 22:25:27 +01002201STEXI
2202@item -qmp @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002203@findex -qmp
Stefan Weil95d5f082010-01-20 22:25:27 +01002204Like -monitor but opens in 'control' mode.
2205ETEXI
blueswir15824d652009-03-28 06:44:27 +00002206
Gerd Hoffmann22a0e042009-12-08 13:11:51 +01002207DEF("mon", HAS_ARG, QEMU_OPTION_mon, \
Blue Swirlad960902010-03-29 19:23:52 +00002208 "-mon chardev=[name][,mode=readline|control][,default]\n", QEMU_ARCH_ALL)
Gerd Hoffmann22a0e042009-12-08 13:11:51 +01002209STEXI
2210@item -mon chardev=[name][,mode=readline|control][,default]
Stefan Weil6616b2a2010-02-05 23:52:05 +01002211@findex -mon
Gerd Hoffmann22a0e042009-12-08 13:11:51 +01002212Setup monitor on chardev @var{name}.
2213ETEXI
2214
H. Peter Anvinc9f398e2009-12-29 13:51:36 -08002215DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \
Blue Swirlad960902010-03-29 19:23:52 +00002216 "-debugcon dev redirect the debug console to char device 'dev'\n",
2217 QEMU_ARCH_ALL)
H. Peter Anvinc9f398e2009-12-29 13:51:36 -08002218STEXI
2219@item -debugcon @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002220@findex -debugcon
H. Peter Anvinc9f398e2009-12-29 13:51:36 -08002221Redirect the debug console to host device @var{dev} (same devices as the
2222serial port). The debug console is an I/O port which is typically port
22230xe9; writing to that I/O port sends output to this device.
2224The default device is @code{vc} in graphical mode and @code{stdio} in
2225non graphical mode.
2226ETEXI
2227
blueswir15824d652009-03-28 06:44:27 +00002228DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \
Blue Swirlad960902010-03-29 19:23:52 +00002229 "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002230STEXI
2231@item -pidfile @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002232@findex -pidfile
blueswir15824d652009-03-28 06:44:27 +00002233Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
2234from a script.
2235ETEXI
2236
aurel321b530a62009-04-05 20:08:59 +00002237DEF("singlestep", 0, QEMU_OPTION_singlestep, \
Blue Swirlad960902010-03-29 19:23:52 +00002238 "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL)
aurel321b530a62009-04-05 20:08:59 +00002239STEXI
2240@item -singlestep
Stefan Weil6616b2a2010-02-05 23:52:05 +01002241@findex -singlestep
aurel321b530a62009-04-05 20:08:59 +00002242Run the emulation in single step mode.
2243ETEXI
2244
blueswir15824d652009-03-28 06:44:27 +00002245DEF("S", 0, QEMU_OPTION_S, \
Blue Swirlad960902010-03-29 19:23:52 +00002246 "-S freeze CPU at startup (use 'c' to start execution)\n",
2247 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002248STEXI
2249@item -S
Stefan Weil6616b2a2010-02-05 23:52:05 +01002250@findex -S
blueswir15824d652009-03-28 06:44:27 +00002251Do not start CPU at startup (you must type 'c' in the monitor).
2252ETEXI
2253
aliguori59030a82009-04-05 18:43:41 +00002254DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \
Blue Swirlad960902010-03-29 19:23:52 +00002255 "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002256STEXI
aliguori59030a82009-04-05 18:43:41 +00002257@item -gdb @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002258@findex -gdb
aliguori59030a82009-04-05 18:43:41 +00002259Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical
2260connections will likely be TCP-based, but also UDP, pseudo TTY, or even
2261stdio are reasonable use case. The latter is allowing to start qemu from
2262within gdb and establish the connection via a pipe:
2263@example
2264(gdb) target remote | exec qemu -gdb stdio ...
2265@end example
blueswir15824d652009-03-28 06:44:27 +00002266ETEXI
2267
aliguori59030a82009-04-05 18:43:41 +00002268DEF("s", 0, QEMU_OPTION_s, \
Blue Swirlad960902010-03-29 19:23:52 +00002269 "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n",
2270 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002271STEXI
aliguori59030a82009-04-05 18:43:41 +00002272@item -s
Stefan Weil6616b2a2010-02-05 23:52:05 +01002273@findex -s
aliguori59030a82009-04-05 18:43:41 +00002274Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
2275(@pxref{gdb_usage}).
blueswir15824d652009-03-28 06:44:27 +00002276ETEXI
2277
2278DEF("d", HAS_ARG, QEMU_OPTION_d, \
Blue Swirlad960902010-03-29 19:23:52 +00002279 "-d item1,... output log to /tmp/qemu.log (use -d ? for a list of log items)\n",
2280 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002281STEXI
2282@item -d
Stefan Weil6616b2a2010-02-05 23:52:05 +01002283@findex -d
blueswir15824d652009-03-28 06:44:27 +00002284Output log in /tmp/qemu.log
2285ETEXI
2286
Matthew Fernandezc235d732011-06-07 16:32:40 +00002287DEF("D", HAS_ARG, QEMU_OPTION_D, \
2288 "-D logfile output log to logfile (instead of the default /tmp/qemu.log)\n",
2289 QEMU_ARCH_ALL)
2290STEXI
2291@item -D
2292@findex -D
2293Output log in logfile instead of /tmp/qemu.log
2294ETEXI
2295
blueswir15824d652009-03-28 06:44:27 +00002296DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \
2297 "-hdachs c,h,s[,t]\n" \
2298 " force hard disk 0 physical geometry and the optional BIOS\n" \
Blue Swirlad960902010-03-29 19:23:52 +00002299 " translation (t=none or lba) (usually qemu can guess them)\n",
2300 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002301STEXI
2302@item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
Stefan Weil6616b2a2010-02-05 23:52:05 +01002303@findex -hdachs
blueswir15824d652009-03-28 06:44:27 +00002304Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
2305@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
2306translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
2307all those parameters. This option is useful for old MS-DOS disk
2308images.
2309ETEXI
2310
2311DEF("L", HAS_ARG, QEMU_OPTION_L, \
Blue Swirlad960902010-03-29 19:23:52 +00002312 "-L path set the directory for the BIOS, VGA BIOS and keymaps\n",
2313 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002314STEXI
2315@item -L @var{path}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002316@findex -L
blueswir15824d652009-03-28 06:44:27 +00002317Set the directory for the BIOS, VGA BIOS and keymaps.
2318ETEXI
2319
2320DEF("bios", HAS_ARG, QEMU_OPTION_bios, \
Blue Swirlad960902010-03-29 19:23:52 +00002321 "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002322STEXI
2323@item -bios @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002324@findex -bios
blueswir15824d652009-03-28 06:44:27 +00002325Set the filename for the BIOS.
2326ETEXI
2327
blueswir15824d652009-03-28 06:44:27 +00002328DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \
Blue Swirlad960902010-03-29 19:23:52 +00002329 "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002330STEXI
2331@item -enable-kvm
Stefan Weil6616b2a2010-02-05 23:52:05 +01002332@findex -enable-kvm
blueswir15824d652009-03-28 06:44:27 +00002333Enable KVM full virtualization support. This option is only available
2334if KVM support is enabled when compiling.
2335ETEXI
2336
aliguorie37630c2009-04-22 15:19:10 +00002337DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid,
Blue Swirlad960902010-03-29 19:23:52 +00002338 "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL)
aliguorie37630c2009-04-22 15:19:10 +00002339DEF("xen-create", 0, QEMU_OPTION_xen_create,
2340 "-xen-create create domain using xen hypercalls, bypassing xend\n"
Blue Swirlad960902010-03-29 19:23:52 +00002341 " warning: should not be used when xend is in use\n",
2342 QEMU_ARCH_ALL)
aliguorie37630c2009-04-22 15:19:10 +00002343DEF("xen-attach", 0, QEMU_OPTION_xen_attach,
2344 "-xen-attach attach to existing xen domain\n"
Blue Swirlad960902010-03-29 19:23:52 +00002345 " xend will use this when starting qemu\n",
2346 QEMU_ARCH_ALL)
Stefan Weil95d5f082010-01-20 22:25:27 +01002347STEXI
2348@item -xen-domid @var{id}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002349@findex -xen-domid
Stefan Weil95d5f082010-01-20 22:25:27 +01002350Specify xen guest domain @var{id} (XEN only).
2351@item -xen-create
Stefan Weil6616b2a2010-02-05 23:52:05 +01002352@findex -xen-create
Stefan Weil95d5f082010-01-20 22:25:27 +01002353Create domain using xen hypercalls, bypassing xend.
2354Warning: should not be used when xend is in use (XEN only).
2355@item -xen-attach
Stefan Weil6616b2a2010-02-05 23:52:05 +01002356@findex -xen-attach
Stefan Weil95d5f082010-01-20 22:25:27 +01002357Attach to existing xen domain.
2358xend will use this when starting qemu (XEN only).
2359ETEXI
aliguorie37630c2009-04-22 15:19:10 +00002360
blueswir15824d652009-03-28 06:44:27 +00002361DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \
Blue Swirlad960902010-03-29 19:23:52 +00002362 "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002363STEXI
2364@item -no-reboot
Stefan Weil6616b2a2010-02-05 23:52:05 +01002365@findex -no-reboot
blueswir15824d652009-03-28 06:44:27 +00002366Exit instead of rebooting.
2367ETEXI
2368
2369DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \
Blue Swirlad960902010-03-29 19:23:52 +00002370 "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002371STEXI
2372@item -no-shutdown
Stefan Weil6616b2a2010-02-05 23:52:05 +01002373@findex -no-shutdown
blueswir15824d652009-03-28 06:44:27 +00002374Don't exit QEMU on guest shutdown, but instead only stop the emulation.
2375This allows for instance switching to monitor to commit changes to the
2376disk image.
2377ETEXI
2378
2379DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \
2380 "-loadvm [tag|id]\n" \
Blue Swirlad960902010-03-29 19:23:52 +00002381 " start right away with a saved state (loadvm in monitor)\n",
2382 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002383STEXI
2384@item -loadvm @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002385@findex -loadvm
blueswir15824d652009-03-28 06:44:27 +00002386Start right away with a saved state (@code{loadvm} in monitor)
2387ETEXI
2388
2389#ifndef _WIN32
2390DEF("daemonize", 0, QEMU_OPTION_daemonize, \
Blue Swirlad960902010-03-29 19:23:52 +00002391 "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002392#endif
2393STEXI
2394@item -daemonize
Stefan Weil6616b2a2010-02-05 23:52:05 +01002395@findex -daemonize
blueswir15824d652009-03-28 06:44:27 +00002396Daemonize the QEMU process after initialization. QEMU will not detach from
2397standard IO until it is ready to receive connections on any of its devices.
2398This option is a useful way for external programs to launch QEMU without having
2399to cope with initialization race conditions.
2400ETEXI
2401
2402DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \
Blue Swirlad960902010-03-29 19:23:52 +00002403 "-option-rom rom load a file, rom, into the option ROM space\n",
2404 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002405STEXI
2406@item -option-rom @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002407@findex -option-rom
blueswir15824d652009-03-28 06:44:27 +00002408Load the contents of @var{file} as an option ROM.
2409This option is useful to load things like EtherBoot.
2410ETEXI
2411
2412DEF("clock", HAS_ARG, QEMU_OPTION_clock, \
2413 "-clock force the use of the given methods for timer alarm.\n" \
Blue Swirlad960902010-03-29 19:23:52 +00002414 " To see what timers are available use -clock ?\n",
2415 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002416STEXI
2417@item -clock @var{method}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002418@findex -clock
blueswir15824d652009-03-28 06:44:27 +00002419Force the use of the given methods for timer alarm. To see what timers
2420are available use -clock ?.
2421ETEXI
2422
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02002423HXCOMM Options deprecated by -rtc
Blue Swirlad960902010-03-29 19:23:52 +00002424DEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL)
2425DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002426
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02002427DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \
Jan Kiszka68752042009-09-15 13:36:04 +02002428 "-rtc [base=utc|localtime|date][,clock=host|vm][,driftfix=none|slew]\n" \
Blue Swirlad960902010-03-29 19:23:52 +00002429 " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n",
2430 QEMU_ARCH_ALL)
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02002431
blueswir15824d652009-03-28 06:44:27 +00002432STEXI
2433
Jan Kiszka68752042009-09-15 13:36:04 +02002434@item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew]
Stefan Weil6616b2a2010-02-05 23:52:05 +01002435@findex -rtc
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02002436Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current
2437UTC or local time, respectively. @code{localtime} is required for correct date in
2438MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the
2439format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC.
2440
Jan Kiszka68752042009-09-15 13:36:04 +02002441By default the RTC is driven by the host system time. This allows to use the
2442RTC as accurate reference clock inside the guest, specifically if the host
2443time is smoothly following an accurate external reference clock, e.g. via NTP.
2444If you want to isolate the guest time from the host, even prevent it from
2445progressing during suspension, you can set @option{clock} to @code{vm} instead.
2446
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02002447Enable @option{driftfix} (i386 targets only) if you experience time drift problems,
2448specifically with Windows' ACPI HAL. This option will try to figure out how
2449many timer interrupts were not processed by the Windows guest and will
2450re-inject them.
blueswir15824d652009-03-28 06:44:27 +00002451ETEXI
2452
2453DEF("icount", HAS_ARG, QEMU_OPTION_icount, \
2454 "-icount [N|auto]\n" \
aliguoribc14ca22009-04-05 18:43:37 +00002455 " enable virtual instruction counter with 2^N clock ticks per\n" \
Blue Swirlad960902010-03-29 19:23:52 +00002456 " instruction\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002457STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +02002458@item -icount [@var{N}|auto]
Stefan Weil6616b2a2010-02-05 23:52:05 +01002459@findex -icount
blueswir15824d652009-03-28 06:44:27 +00002460Enable virtual instruction counter. The virtual cpu will execute one
Kevin Wolf4e257e52009-10-09 10:58:36 +02002461instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified
blueswir15824d652009-03-28 06:44:27 +00002462then the virtual cpu speed will be automatically adjusted to keep virtual
2463time within a few seconds of real time.
2464
2465Note that while this option can give deterministic behavior, it does not
2466provide cycle accurate emulation. Modern CPUs contain superscalar out of
2467order cores with complex cache hierarchies. The number of instructions
2468executed often has little or no correlation with actual performance.
2469ETEXI
2470
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01002471DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \
2472 "-watchdog i6300esb|ib700\n" \
Blue Swirlad960902010-03-29 19:23:52 +00002473 " enable virtual hardware watchdog [default=none]\n",
2474 QEMU_ARCH_ALL)
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01002475STEXI
2476@item -watchdog @var{model}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002477@findex -watchdog
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01002478Create a virtual hardware watchdog device. Once enabled (by a guest
2479action), the watchdog must be periodically polled by an agent inside
2480the guest or else the guest will be restarted.
2481
2482The @var{model} is the model of hardware watchdog to emulate. Choices
2483for model are: @code{ib700} (iBASE 700) which is a very simple ISA
2484watchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O
2485controller hub) which is a much more featureful PCI-based dual-timer
2486watchdog. Choose a model for which your guest has drivers.
2487
2488Use @code{-watchdog ?} to list available hardware models. Only one
2489watchdog can be enabled for a guest.
2490ETEXI
2491
2492DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \
2493 "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \
Blue Swirlad960902010-03-29 19:23:52 +00002494 " action when watchdog fires [default=reset]\n",
2495 QEMU_ARCH_ALL)
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01002496STEXI
2497@item -watchdog-action @var{action}
2498
2499The @var{action} controls what QEMU will do when the watchdog timer
2500expires.
2501The default is
2502@code{reset} (forcefully reset the guest).
2503Other possible actions are:
2504@code{shutdown} (attempt to gracefully shutdown the guest),
2505@code{poweroff} (forcefully poweroff the guest),
2506@code{pause} (pause the guest),
2507@code{debug} (print a debug message and continue), or
2508@code{none} (do nothing).
2509
2510Note that the @code{shutdown} action requires that the guest responds
2511to ACPI signals, which it may not be able to do in the sort of
2512situations where the watchdog would have expired, and thus
2513@code{-watchdog-action shutdown} is not recommended for production use.
2514
2515Examples:
2516
2517@table @code
2518@item -watchdog i6300esb -watchdog-action pause
2519@item -watchdog ib700
2520@end table
2521ETEXI
2522
blueswir15824d652009-03-28 06:44:27 +00002523DEF("echr", HAS_ARG, QEMU_OPTION_echr, \
Blue Swirlad960902010-03-29 19:23:52 +00002524 "-echr chr set terminal escape character instead of ctrl-a\n",
2525 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002526STEXI
2527
Kevin Wolf4e257e52009-10-09 10:58:36 +02002528@item -echr @var{numeric_ascii_value}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002529@findex -echr
blueswir15824d652009-03-28 06:44:27 +00002530Change the escape character used for switching to the monitor when using
2531monitor and serial sharing. The default is @code{0x01} when using the
2532@code{-nographic} option. @code{0x01} is equal to pressing
2533@code{Control-a}. You can select a different character from the ascii
2534control keys where 1 through 26 map to Control-a through Control-z. For
2535instance you could use the either of the following to change the escape
2536character to Control-t.
2537@table @code
2538@item -echr 0x14
2539@item -echr 20
2540@end table
2541ETEXI
2542
2543DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \
2544 "-virtioconsole c\n" \
Blue Swirlad960902010-03-29 19:23:52 +00002545 " set virtio console\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002546STEXI
2547@item -virtioconsole @var{c}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002548@findex -virtioconsole
blueswir15824d652009-03-28 06:44:27 +00002549Set virtio console.
Amit Shah98b19252010-01-20 00:36:52 +05302550
2551This option is maintained for backward compatibility.
2552
2553Please use @code{-device virtconsole} for the new way of invocation.
blueswir15824d652009-03-28 06:44:27 +00002554ETEXI
2555
2556DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \
Blue Swirlad960902010-03-29 19:23:52 +00002557 "-show-cursor show cursor\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002558STEXI
Stefan Weil95d5f082010-01-20 22:25:27 +01002559@item -show-cursor
Stefan Weil6616b2a2010-02-05 23:52:05 +01002560@findex -show-cursor
Stefan Weil95d5f082010-01-20 22:25:27 +01002561Show cursor.
blueswir15824d652009-03-28 06:44:27 +00002562ETEXI
2563
2564DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \
Blue Swirlad960902010-03-29 19:23:52 +00002565 "-tb-size n set TB size\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002566STEXI
Stefan Weil95d5f082010-01-20 22:25:27 +01002567@item -tb-size @var{n}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002568@findex -tb-size
Stefan Weil95d5f082010-01-20 22:25:27 +01002569Set TB size.
blueswir15824d652009-03-28 06:44:27 +00002570ETEXI
2571
2572DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \
Blue Swirlad960902010-03-29 19:23:52 +00002573 "-incoming p prepare for incoming migration, listen on port p\n",
2574 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002575STEXI
Stefan Weil95d5f082010-01-20 22:25:27 +01002576@item -incoming @var{port}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002577@findex -incoming
Stefan Weil95d5f082010-01-20 22:25:27 +01002578Prepare for incoming migration, listen on @var{port}.
blueswir15824d652009-03-28 06:44:27 +00002579ETEXI
2580
Gerd Hoffmannd8c208d2009-12-08 13:11:46 +01002581DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \
Blue Swirlad960902010-03-29 19:23:52 +00002582 "-nodefaults don't create default devices\n", QEMU_ARCH_ALL)
Gerd Hoffmannd8c208d2009-12-08 13:11:46 +01002583STEXI
Stefan Weil3dbf2c72010-01-16 18:19:44 +01002584@item -nodefaults
Stefan Weil6616b2a2010-02-05 23:52:05 +01002585@findex -nodefaults
Stefan Weil3dbf2c72010-01-16 18:19:44 +01002586Don't create default devices.
Gerd Hoffmannd8c208d2009-12-08 13:11:46 +01002587ETEXI
2588
blueswir15824d652009-03-28 06:44:27 +00002589#ifndef _WIN32
2590DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \
Blue Swirlad960902010-03-29 19:23:52 +00002591 "-chroot dir chroot to dir just before starting the VM\n",
2592 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002593#endif
2594STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +02002595@item -chroot @var{dir}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002596@findex -chroot
blueswir15824d652009-03-28 06:44:27 +00002597Immediately before starting guest execution, chroot to the specified
2598directory. Especially useful in combination with -runas.
2599ETEXI
2600
2601#ifndef _WIN32
2602DEF("runas", HAS_ARG, QEMU_OPTION_runas, \
Blue Swirlad960902010-03-29 19:23:52 +00002603 "-runas user change to user id user just before starting the VM\n",
2604 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002605#endif
2606STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +02002607@item -runas @var{user}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002608@findex -runas
blueswir15824d652009-03-28 06:44:27 +00002609Immediately before starting guest execution, drop root privileges, switching
2610to the specified user.
2611ETEXI
2612
blueswir15824d652009-03-28 06:44:27 +00002613DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env,
2614 "-prom-env variable=value\n"
Blue Swirlad960902010-03-29 19:23:52 +00002615 " set OpenBIOS nvram variables\n",
2616 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
Stefan Weil95d5f082010-01-20 22:25:27 +01002617STEXI
2618@item -prom-env @var{variable}=@var{value}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002619@findex -prom-env
Stefan Weil95d5f082010-01-20 22:25:27 +01002620Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only).
2621ETEXI
blueswir15824d652009-03-28 06:44:27 +00002622DEF("semihosting", 0, QEMU_OPTION_semihosting,
Max Filippov1ddeaa52011-09-06 03:55:47 +04002623 "-semihosting semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA)
Stefan Weil95d5f082010-01-20 22:25:27 +01002624STEXI
2625@item -semihosting
Stefan Weil6616b2a2010-02-05 23:52:05 +01002626@findex -semihosting
Max Filippov1ddeaa52011-09-06 03:55:47 +04002627Semihosting mode (ARM, M68K, Xtensa only).
Stefan Weil95d5f082010-01-20 22:25:27 +01002628ETEXI
blueswir15824d652009-03-28 06:44:27 +00002629DEF("old-param", 0, QEMU_OPTION_old_param,
Blue Swirlad960902010-03-29 19:23:52 +00002630 "-old-param old param mode\n", QEMU_ARCH_ARM)
Stefan Weil95d5f082010-01-20 22:25:27 +01002631STEXI
2632@item -old-param
Stefan Weil6616b2a2010-02-05 23:52:05 +01002633@findex -old-param (ARM)
Stefan Weil95d5f082010-01-20 22:25:27 +01002634Old param mode (ARM only).
2635ETEXI
2636
Gerd Hoffmann715a6642009-10-14 10:39:28 +02002637DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig,
Blue Swirlad960902010-03-29 19:23:52 +00002638 "-readconfig <file>\n", QEMU_ARCH_ALL)
Stefan Weil3dbf2c72010-01-16 18:19:44 +01002639STEXI
2640@item -readconfig @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002641@findex -readconfig
Stefan Weil3dbf2c72010-01-16 18:19:44 +01002642Read device configuration from @var{file}.
2643ETEXI
Gerd Hoffmann715a6642009-10-14 10:39:28 +02002644DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig,
2645 "-writeconfig <file>\n"
Blue Swirlad960902010-03-29 19:23:52 +00002646 " read/write config file\n", QEMU_ARCH_ALL)
Stefan Weil3dbf2c72010-01-16 18:19:44 +01002647STEXI
2648@item -writeconfig @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002649@findex -writeconfig
Stefan Weil3dbf2c72010-01-16 18:19:44 +01002650Write device configuration to @var{file}.
2651ETEXI
Anthony Liguori292444c2010-01-21 10:57:58 -06002652DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig,
2653 "-nodefconfig\n"
Blue Swirlad960902010-03-29 19:23:52 +00002654 " do not load default config files at startup\n",
2655 QEMU_ARCH_ALL)
Anthony Liguori292444c2010-01-21 10:57:58 -06002656STEXI
2657@item -nodefconfig
Stefan Weil6616b2a2010-02-05 23:52:05 +01002658@findex -nodefconfig
Anthony Liguori292444c2010-01-21 10:57:58 -06002659Normally QEMU loads a configuration file from @var{sysconfdir}/qemu.conf and
2660@var{sysconfdir}/target-@var{ARCH}.conf on startup. The @code{-nodefconfig}
2661option will prevent QEMU from loading these configuration files at startup.
2662ETEXI
Prerna Saxenaab6540d2010-08-09 11:48:32 +01002663DEF("trace", HAS_ARG, QEMU_OPTION_trace,
Lluís23d15e82011-08-31 20:31:31 +02002664 "-trace [events=<file>][,file=<file>]\n"
2665 " specify tracing options\n",
Prerna Saxenaab6540d2010-08-09 11:48:32 +01002666 QEMU_ARCH_ALL)
2667STEXI
Lluís23d15e82011-08-31 20:31:31 +02002668HXCOMM This line is not accurate, as some sub-options are backend-specific but
2669HXCOMM HX does not support conditional compilation of text.
2670@item -trace [events=@var{file}][,file=@var{file}]
Prerna Saxenaab6540d2010-08-09 11:48:32 +01002671@findex -trace
Lluíse4858972011-08-31 20:31:03 +02002672
Lluís23d15e82011-08-31 20:31:31 +02002673Specify tracing options.
2674
2675@table @option
2676@item events=@var{file}
2677Immediately enable events listed in @var{file}.
2678The file must contain one event name (as listed in the @var{trace-events} file)
2679per line.
Stefan Weilc1ba4e02011-09-05 18:13:03 +02002680This option is only available if QEMU has been compiled with
2681either @var{simple} or @var{stderr} tracing backend.
Lluís23d15e82011-08-31 20:31:31 +02002682@item file=@var{file}
2683Log output traces to @var{file}.
2684
Stefan Weilc1ba4e02011-09-05 18:13:03 +02002685This option is only available if QEMU has been compiled with
2686the @var{simple} tracing backend.
Lluís23d15e82011-08-31 20:31:31 +02002687@end table
Prerna Saxenaab6540d2010-08-09 11:48:32 +01002688ETEXI
Stefan Weil3dbf2c72010-01-16 18:19:44 +01002689
2690HXCOMM This is the last statement. Insert new options before this line!
2691STEXI
2692@end table
2693ETEXI