blob: c55080c0418b2f45ce095d1047b553e14295b993 [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"
34 " supported accelerators are kvm, xen, tcg (default: tcg)\n",
35 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +000036STEXI
Jan Kiszka80f52a62011-07-23 12:39:46 +020037@item -machine [type=]@var{name}[,prop=@var{value}[,...]]
38@findex -machine
39Select the emulated machine by @var{name}. Use @code{-machine ?} to list
40available machines. Supported machine properties are:
41@table @option
42@item accel=@var{accels1}[:@var{accels2}[:...]]
43This is used to enable an accelerator. Depending on the target architecture,
44kvm, xen, or tcg can be available. By default, tcg is used. If there is more
45than one accelerator specified, the next one is used if the previous one fails
46to initialize.
47@end table
blueswir15824d652009-03-28 06:44:27 +000048ETEXI
49
Jan Kiszka80f52a62011-07-23 12:39:46 +020050HXCOMM Deprecated by -machine
51DEF("M", HAS_ARG, QEMU_OPTION_M, "", QEMU_ARCH_ALL)
52
blueswir15824d652009-03-28 06:44:27 +000053DEF("cpu", HAS_ARG, QEMU_OPTION_cpu,
Blue Swirlad960902010-03-29 19:23:52 +000054 "-cpu cpu select CPU (-cpu ? for list)\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +000055STEXI
56@item -cpu @var{model}
Stefan Weil6616b2a2010-02-05 23:52:05 +010057@findex -cpu
blueswir15824d652009-03-28 06:44:27 +000058Select CPU model (-cpu ? for list and additional feature selection)
59ETEXI
60
61DEF("smp", HAS_ARG, QEMU_OPTION_smp,
Andre Przywara58a04db2009-08-28 10:49:57 +020062 "-smp n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n"
Jes Sorensen6be68d72009-07-23 17:03:42 +020063 " set the number of CPUs to 'n' [default=1]\n"
64 " maxcpus= maximum number of total cpus, including\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -070065 " offline CPUs for hotplug, etc\n"
Andre Przywara58a04db2009-08-28 10:49:57 +020066 " cores= number of CPU cores on one socket\n"
67 " threads= number of threads on one CPU core\n"
Blue Swirlad960902010-03-29 19:23:52 +000068 " sockets= number of discrete sockets in the system\n",
69 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +000070STEXI
Andre Przywara58a04db2009-08-28 10:49:57 +020071@item -smp @var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}]
Stefan Weil6616b2a2010-02-05 23:52:05 +010072@findex -smp
blueswir15824d652009-03-28 06:44:27 +000073Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
74CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs
75to 4.
Andre Przywara58a04db2009-08-28 10:49:57 +020076For the PC target, the number of @var{cores} per socket, the number
77of @var{threads} per cores and the total number of @var{sockets} can be
78specified. Missing values will be computed. If any on the three values is
79given, the total number of CPUs @var{n} can be omitted. @var{maxcpus}
80specifies the maximum number of hotpluggable CPUs.
blueswir15824d652009-03-28 06:44:27 +000081ETEXI
82
aliguori268a3622009-04-21 22:30:27 +000083DEF("numa", HAS_ARG, QEMU_OPTION_numa,
Blue Swirlad960902010-03-29 19:23:52 +000084 "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL)
aliguori268a3622009-04-21 22:30:27 +000085STEXI
86@item -numa @var{opts}
Stefan Weil6616b2a2010-02-05 23:52:05 +010087@findex -numa
aliguori268a3622009-04-21 22:30:27 +000088Simulate a multi node NUMA system. If mem and cpus are omitted, resources
89are split equally.
90ETEXI
91
blueswir15824d652009-03-28 06:44:27 +000092DEF("fda", HAS_ARG, QEMU_OPTION_fda,
Blue Swirlad960902010-03-29 19:23:52 +000093 "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL)
94DEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +000095STEXI
96@item -fda @var{file}
97@item -fdb @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +010098@findex -fda
99@findex -fdb
blueswir15824d652009-03-28 06:44:27 +0000100Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can
101use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}).
102ETEXI
103
104DEF("hda", HAS_ARG, QEMU_OPTION_hda,
Blue Swirlad960902010-03-29 19:23:52 +0000105 "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL)
106DEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000107DEF("hdc", HAS_ARG, QEMU_OPTION_hdc,
Blue Swirlad960902010-03-29 19:23:52 +0000108 "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL)
109DEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000110STEXI
111@item -hda @var{file}
112@item -hdb @var{file}
113@item -hdc @var{file}
114@item -hdd @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100115@findex -hda
116@findex -hdb
117@findex -hdc
118@findex -hdd
blueswir15824d652009-03-28 06:44:27 +0000119Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
120ETEXI
121
122DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom,
Blue Swirlad960902010-03-29 19:23:52 +0000123 "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n",
124 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000125STEXI
126@item -cdrom @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100127@findex -cdrom
blueswir15824d652009-03-28 06:44:27 +0000128Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and
129@option{-cdrom} at the same time). You can use the host CD-ROM by
130using @file{/dev/cdrom} as filename (@pxref{host_drives}).
131ETEXI
132
133DEF("drive", HAS_ARG, QEMU_OPTION_drive,
134 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n"
135 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n"
Stefan Hajnoczi92196b22011-08-04 12:26:52 +0100136 " [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n"
Alexander Graf016f5cf2010-05-26 17:51:49 +0200137 " [,serial=s][,addr=A][,id=name][,aio=threads|native]\n"
138 " [,readonly=on|off]\n"
Blue Swirlad960902010-03-29 19:23:52 +0000139 " use 'file' as a drive image\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000140STEXI
141@item -drive @var{option}[,@var{option}[,@var{option}[,...]]]
Stefan Weil6616b2a2010-02-05 23:52:05 +0100142@findex -drive
blueswir15824d652009-03-28 06:44:27 +0000143
144Define a new drive. Valid options are:
145
Kevin Wolfb3f046c2009-10-09 10:58:35 +0200146@table @option
blueswir15824d652009-03-28 06:44:27 +0000147@item file=@var{file}
148This option defines which disk image (@pxref{disk_images}) to use with
149this drive. If the filename contains comma, you must double it
150(for instance, "file=my,,file" to use file "my,file").
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +1100151
152Special files such as iSCSI devices can be specified using protocol
153specific URLs. See the section for "Device URL Syntax" for more information.
blueswir15824d652009-03-28 06:44:27 +0000154@item if=@var{interface}
155This option defines on which type on interface the drive is connected.
156Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio.
157@item bus=@var{bus},unit=@var{unit}
158These options define where is connected the drive by defining the bus number and
159the unit id.
160@item index=@var{index}
161This option defines where is connected the drive by using an index in the list
162of available connectors of a given interface type.
163@item media=@var{media}
164This option defines the type of the media: disk or cdrom.
165@item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}]
166These options have the same definition as they have in @option{-hdachs}.
167@item snapshot=@var{snapshot}
168@var{snapshot} is "on" or "off" and allows to enable snapshot for given drive (see @option{-snapshot}).
169@item cache=@var{cache}
Stefan Hajnoczi92196b22011-08-04 12:26:52 +0100170@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 +0200171@item aio=@var{aio}
172@var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO.
blueswir15824d652009-03-28 06:44:27 +0000173@item format=@var{format}
174Specify which disk @var{format} will be used rather than detecting
175the format. Can be used to specifiy format=raw to avoid interpreting
176an untrusted format header.
177@item serial=@var{serial}
178This option specifies the serial number to assign to the device.
Markus Armbrusterc2cc47a2009-06-18 15:14:10 +0200179@item addr=@var{addr}
180Specify the controller's PCI address (if=virtio only).
Luiz Capitulinoae73e592011-07-12 17:35:08 -0300181@item werror=@var{action},rerror=@var{action}
182Specify which @var{action} to take on write and read errors. Valid actions are:
183"ignore" (ignore the error and try to continue), "stop" (pause QEMU),
184"report" (report the error to the guest), "enospc" (pause QEMU only if the
185host disk is full; report the error to the guest otherwise).
186The default setting is @option{werror=enospc} and @option{rerror=report}.
187@item readonly
188Open drive @option{file} as read-only. Guest write attempts will fail.
blueswir15824d652009-03-28 06:44:27 +0000189@end table
190
191By default, writethrough caching is used for all block device. This means that
192the host page cache will be used to read and write data but write notification
193will be sent to the guest only when the data has been reported as written by
194the storage subsystem.
195
196Writeback caching will report data writes as completed as soon as the data is
197present in the host page cache. This is safe as long as you trust your host.
198If your host crashes or loses power, then the guest may experience data
Alexander Grafc3177282010-05-26 21:04:32 +0200199corruption.
blueswir15824d652009-03-28 06:44:27 +0000200
Aurelien Jarnoc304d312009-05-03 23:29:14 +0200201The host page cache can be avoided entirely with @option{cache=none}. This will
blueswir15824d652009-03-28 06:44:27 +0000202attempt to do disk IO directly to the guests memory. QEMU may still perform
203an internal copy of the data.
204
Stefan Hajnoczi92196b22011-08-04 12:26:52 +0100205The host page cache can be avoided while only sending write notifications to
206the guest when the data has been reported as written by the storage subsystem
207using @option{cache=directsync}.
208
blueswir15824d652009-03-28 06:44:27 +0000209Some block drivers perform badly with @option{cache=writethrough}, most notably,
210qcow2. If performance is more important than correctness,
Kevin Wolf0aa217e2009-06-30 13:06:04 +0200211@option{cache=writeback} should be used with qcow2.
blueswir15824d652009-03-28 06:44:27 +0000212
Alexander Graf016f5cf2010-05-26 17:51:49 +0200213In case you don't care about data integrity over host failures, use
214cache=unsafe. This option tells qemu that it never needs to write any data
215to the disk but can instead keeps things in cache. If anything goes wrong,
216like your host losing power, the disk storage getting disconnected accidently,
Alexander Grafc3177282010-05-26 21:04:32 +0200217etc. you're image will most probably be rendered unusable. When using
218the @option{-snapshot} option, unsafe caching is always used.
Alexander Graf016f5cf2010-05-26 17:51:49 +0200219
blueswir15824d652009-03-28 06:44:27 +0000220Instead of @option{-cdrom} you can use:
221@example
222qemu -drive file=file,index=2,media=cdrom
223@end example
224
225Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
226use:
227@example
228qemu -drive file=file,index=0,media=disk
229qemu -drive file=file,index=1,media=disk
230qemu -drive file=file,index=2,media=disk
231qemu -drive file=file,index=3,media=disk
232@end example
233
234You can connect a CDROM to the slave of ide0:
235@example
236qemu -drive file=file,if=ide,index=1,media=cdrom
237@end example
238
239If you don't specify the "file=" argument, you define an empty drive:
240@example
241qemu -drive if=ide,index=1,media=cdrom
242@end example
243
244You can connect a SCSI disk with unit ID 6 on the bus #0:
245@example
246qemu -drive file=file,if=scsi,bus=0,unit=6
247@end example
248
249Instead of @option{-fda}, @option{-fdb}, you can use:
250@example
251qemu -drive file=file,index=0,if=floppy
252qemu -drive file=file,index=1,if=floppy
253@end example
254
255By default, @var{interface} is "ide" and @var{index} is automatically
256incremented:
257@example
258qemu -drive file=a -drive file=b"
259@end example
260is interpreted like:
261@example
262qemu -hda a -hdb b
263@end example
264ETEXI
265
Stefan Weil6616b2a2010-02-05 23:52:05 +0100266DEF("set", HAS_ARG, QEMU_OPTION_set,
267 "-set group.id.arg=value\n"
268 " set <arg> parameter for item <id> of type <group>\n"
Blue Swirlad960902010-03-29 19:23:52 +0000269 " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL)
Stefan Weil6616b2a2010-02-05 23:52:05 +0100270STEXI
271@item -set
272@findex -set
273TODO
274ETEXI
275
276DEF("global", HAS_ARG, QEMU_OPTION_global,
277 "-global driver.property=value\n"
Blue Swirlad960902010-03-29 19:23:52 +0000278 " set a global default for a driver property\n",
279 QEMU_ARCH_ALL)
Stefan Weil6616b2a2010-02-05 23:52:05 +0100280STEXI
281@item -global
282@findex -global
283TODO
284ETEXI
285
blueswir15824d652009-03-28 06:44:27 +0000286DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock,
Blue Swirlad960902010-03-29 19:23:52 +0000287 "-mtdblock file use 'file' as on-board Flash memory image\n",
288 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000289STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +0200290@item -mtdblock @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100291@findex -mtdblock
Kevin Wolf4e257e52009-10-09 10:58:36 +0200292Use @var{file} as on-board Flash memory image.
blueswir15824d652009-03-28 06:44:27 +0000293ETEXI
294
295DEF("sd", HAS_ARG, QEMU_OPTION_sd,
Blue Swirlad960902010-03-29 19:23:52 +0000296 "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000297STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +0200298@item -sd @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100299@findex -sd
Kevin Wolf4e257e52009-10-09 10:58:36 +0200300Use @var{file} as SecureDigital card image.
blueswir15824d652009-03-28 06:44:27 +0000301ETEXI
302
303DEF("pflash", HAS_ARG, QEMU_OPTION_pflash,
Blue Swirlad960902010-03-29 19:23:52 +0000304 "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000305STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +0200306@item -pflash @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100307@findex -pflash
Kevin Wolf4e257e52009-10-09 10:58:36 +0200308Use @var{file} as a parallel flash image.
blueswir15824d652009-03-28 06:44:27 +0000309ETEXI
310
311DEF("boot", HAS_ARG, QEMU_OPTION_boot,
Jan Kiszka2221dde2009-07-02 00:19:02 +0200312 "-boot [order=drives][,once=drives][,menu=on|off]\n"
wayne3d3b8302011-07-27 18:04:55 +0800313 " [,splash=sp_name][,splash-time=sp_time]\n"
314 " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n"
315 " 'sp_name': the file's name that would be passed to bios as logo picture, if menu=on\n"
316 " 'sp_time': the period that splash picture last if menu=on, unit is ms\n",
Blue Swirlad960902010-03-29 19:23:52 +0000317 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000318STEXI
wayne3d3b8302011-07-27 18:04:55 +0800319@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 +0100320@findex -boot
Jan Kiszka2221dde2009-07-02 00:19:02 +0200321Specify boot order @var{drives} as a string of drive letters. Valid
322drive letters depend on the target achitecture. The x86 PC uses: a, b
323(floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot
324from network adapter 1-4), hard disk boot is the default. To apply a
325particular boot order only on the first startup, specify it via
326@option{once}.
327
328Interactive boot menus/prompts can be enabled via @option{menu=on} as far
329as firmware/BIOS supports them. The default is non-interactive boot.
330
wayne3d3b8302011-07-27 18:04:55 +0800331A splash picture could be passed to bios, enabling user to show it as logo,
332when option splash=@var{sp_name} is given and menu=on, If firmware/BIOS
333supports them. Currently Seabios for X86 system support it.
334limitation: The splash file could be a jpeg file or a BMP file in 24 BPP
335format(true color). The resolution should be supported by the SVGA mode, so
336the recommended is 320x240, 640x480, 800x640.
337
Jan Kiszka2221dde2009-07-02 00:19:02 +0200338@example
339# try to boot from network first, then from hard disk
340qemu -boot order=nc
341# boot from CD-ROM first, switch back to default order after reboot
342qemu -boot once=d
wayne3d3b8302011-07-27 18:04:55 +0800343# boot with a splash picture for 5 seconds.
344qemu -boot menu=on,splash=/root/boot.bmp,splash-time=5000
Jan Kiszka2221dde2009-07-02 00:19:02 +0200345@end example
346
347Note: The legacy format '-boot @var{drives}' is still supported but its
348use is discouraged as it may be removed from future versions.
blueswir15824d652009-03-28 06:44:27 +0000349ETEXI
350
351DEF("snapshot", 0, QEMU_OPTION_snapshot,
Blue Swirlad960902010-03-29 19:23:52 +0000352 "-snapshot write to temporary files instead of disk image files\n",
353 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000354STEXI
355@item -snapshot
Stefan Weil6616b2a2010-02-05 23:52:05 +0100356@findex -snapshot
blueswir15824d652009-03-28 06:44:27 +0000357Write to temporary files instead of disk image files. In this case,
358the raw disk image you use is not written back. You can however force
359the write back by pressing @key{C-a s} (@pxref{disk_images}).
360ETEXI
361
362DEF("m", HAS_ARG, QEMU_OPTION_m,
Paolo Bonzinibec7c2d2010-02-04 16:49:58 +0100363 "-m megs set virtual RAM size to megs MB [default="
Blue Swirlad960902010-03-29 19:23:52 +0000364 stringify(DEFAULT_RAM_SIZE) "]\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000365STEXI
366@item -m @var{megs}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100367@findex -m
blueswir15824d652009-03-28 06:44:27 +0000368Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally,
369a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
370gigabytes respectively.
371ETEXI
372
Marcelo Tosattic9027602010-03-01 20:25:08 -0300373DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath,
Blue Swirlad960902010-03-29 19:23:52 +0000374 "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL)
Marcelo Tosattic9027602010-03-01 20:25:08 -0300375STEXI
376@item -mem-path @var{path}
377Allocate guest RAM from a temporarily created file in @var{path}.
378ETEXI
379
380#ifdef MAP_POPULATE
381DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc,
Blue Swirlad960902010-03-29 19:23:52 +0000382 "-mem-prealloc preallocate guest memory (use with -mem-path)\n",
383 QEMU_ARCH_ALL)
Marcelo Tosattic9027602010-03-01 20:25:08 -0300384STEXI
385@item -mem-prealloc
386Preallocate memory when using -mem-path.
387ETEXI
388#endif
389
blueswir15824d652009-03-28 06:44:27 +0000390DEF("k", HAS_ARG, QEMU_OPTION_k,
Blue Swirlad960902010-03-29 19:23:52 +0000391 "-k language use keyboard layout (for example 'fr' for French)\n",
392 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000393STEXI
394@item -k @var{language}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100395@findex -k
blueswir15824d652009-03-28 06:44:27 +0000396Use keyboard layout @var{language} (for example @code{fr} for
397French). This option is only needed where it is not easy to get raw PC
398keycodes (e.g. on Macs, with some X11 servers or with a VNC
399display). You don't normally need to use it on PC/Linux or PC/Windows
400hosts.
401
402The available layouts are:
403@example
404ar de-ch es fo fr-ca hu ja mk no pt-br sv
405da en-gb et fr fr-ch is lt nl pl ru th
406de en-us fi fr-be hr it lv nl-be pt sl tr
407@end example
408
409The default is @code{en-us}.
410ETEXI
411
412
blueswir15824d652009-03-28 06:44:27 +0000413DEF("audio-help", 0, QEMU_OPTION_audio_help,
Blue Swirlad960902010-03-29 19:23:52 +0000414 "-audio-help print list of audio drivers and their options\n",
415 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000416STEXI
417@item -audio-help
Stefan Weil6616b2a2010-02-05 23:52:05 +0100418@findex -audio-help
blueswir15824d652009-03-28 06:44:27 +0000419Will show the audio subsystem help: list of drivers, tunable
420parameters.
421ETEXI
422
blueswir15824d652009-03-28 06:44:27 +0000423DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw,
424 "-soundhw c1,... enable audio support\n"
425 " and only specified sound cards (comma separated list)\n"
426 " use -soundhw ? to get the list of supported cards\n"
Blue Swirlad960902010-03-29 19:23:52 +0000427 " use -soundhw all to enable all of them\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000428STEXI
429@item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
Stefan Weil6616b2a2010-02-05 23:52:05 +0100430@findex -soundhw
blueswir15824d652009-03-28 06:44:27 +0000431Enable audio and selected sound hardware. Use ? to print all
432available sound hardware.
433
434@example
435qemu -soundhw sb16,adlib disk.img
436qemu -soundhw es1370 disk.img
437qemu -soundhw ac97 disk.img
Gerd Hoffmann7d72e762010-11-01 16:57:48 +0100438qemu -soundhw hda disk.img
blueswir15824d652009-03-28 06:44:27 +0000439qemu -soundhw all disk.img
440qemu -soundhw ?
441@end example
442
443Note that Linux's i810_audio OSS kernel (for AC97) module might
444require manually specifying clocking.
445
446@example
447modprobe i810_audio clocking=48000
448@end example
449ETEXI
450
451STEXI
452@end table
453ETEXI
454
455DEF("usb", 0, QEMU_OPTION_usb,
Blue Swirlad960902010-03-29 19:23:52 +0000456 "-usb enable the USB driver (will be the default soon)\n",
457 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000458STEXI
459USB options:
460@table @option
461
462@item -usb
Stefan Weil6616b2a2010-02-05 23:52:05 +0100463@findex -usb
blueswir15824d652009-03-28 06:44:27 +0000464Enable the USB driver (will be the default soon)
465ETEXI
466
467DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice,
Blue Swirlad960902010-03-29 19:23:52 +0000468 "-usbdevice name add the host or guest USB device 'name'\n",
469 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000470STEXI
471
472@item -usbdevice @var{devname}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100473@findex -usbdevice
blueswir15824d652009-03-28 06:44:27 +0000474Add the USB device @var{devname}. @xref{usb_devices}.
475
Kevin Wolfb3f046c2009-10-09 10:58:35 +0200476@table @option
blueswir15824d652009-03-28 06:44:27 +0000477
478@item mouse
479Virtual Mouse. This will override the PS/2 mouse emulation when activated.
480
481@item tablet
482Pointer device that uses absolute coordinates (like a touchscreen). This
483means qemu is able to report the mouse position without having to grab the
484mouse. Also overrides the PS/2 mouse emulation when activated.
485
Kevin Wolf4e257e52009-10-09 10:58:36 +0200486@item disk:[format=@var{format}]:@var{file}
blueswir15824d652009-03-28 06:44:27 +0000487Mass storage device based on file. The optional @var{format} argument
488will be used rather than detecting the format. Can be used to specifiy
Kevin Wolf4e257e52009-10-09 10:58:36 +0200489@code{format=raw} to avoid interpreting an untrusted format header.
blueswir15824d652009-03-28 06:44:27 +0000490
Kevin Wolf4e257e52009-10-09 10:58:36 +0200491@item host:@var{bus}.@var{addr}
492Pass through the host device identified by @var{bus}.@var{addr} (Linux only).
blueswir15824d652009-03-28 06:44:27 +0000493
Kevin Wolf4e257e52009-10-09 10:58:36 +0200494@item host:@var{vendor_id}:@var{product_id}
495Pass through the host device identified by @var{vendor_id}:@var{product_id}
496(Linux only).
blueswir15824d652009-03-28 06:44:27 +0000497
498@item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
499Serial converter to host character device @var{dev}, see @code{-serial} for the
500available devices.
501
502@item braille
503Braille device. This will use BrlAPI to display the braille output on a real
504or fake device.
505
Kevin Wolf4e257e52009-10-09 10:58:36 +0200506@item net:@var{options}
blueswir15824d652009-03-28 06:44:27 +0000507Network adapter that supports CDC ethernet and RNDIS protocols.
508
509@end table
510ETEXI
511
Gerd Hoffmannbd3c9482009-07-15 13:59:26 +0200512DEF("device", HAS_ARG, QEMU_OPTION_device,
Markus Armbruster40ea2852010-01-29 19:49:01 +0100513 "-device driver[,prop[=value][,...]]\n"
514 " add device (based on driver)\n"
515 " prop=value,... sets driver properties\n"
Stefan Weil69a319d2010-01-20 22:58:35 +0100516 " use -device ? to print all possible drivers\n"
Markus Armbruster9848bbf2010-05-11 14:02:31 +0200517 " use -device driver,? to print all possible properties\n",
Blue Swirlad960902010-03-29 19:23:52 +0000518 QEMU_ARCH_ALL)
Stefan Weil3dbf2c72010-01-16 18:19:44 +0100519STEXI
Markus Armbruster9848bbf2010-05-11 14:02:31 +0200520@item -device @var{driver}[,@var{prop}[=@var{value}][,...]]
Stefan Weil6616b2a2010-02-05 23:52:05 +0100521@findex -device
Markus Armbruster9848bbf2010-05-11 14:02:31 +0200522Add device @var{driver}. @var{prop}=@var{value} sets driver
523properties. Valid properties depend on the driver. To get help on
524possible drivers and properties, use @code{-device ?} and
525@code{-device @var{driver},?}.
Stefan Weil3dbf2c72010-01-16 18:19:44 +0100526ETEXI
527
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530528DEFHEADING()
529
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530530DEFHEADING(File system options:)
531
532DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev,
M. Mohan Kumard9b36a62011-10-14 12:59:37 +0530533 "-fsdev fsdriver,id=id,path=path,[security_model={mapped|passthrough|none}]\n"
Aneesh Kumar K.Vd3ab98e2011-10-12 19:11:23 +0530534 " [,writeout=immediate]\n",
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530535 QEMU_ARCH_ALL)
536
537STEXI
538
M. Mohan Kumard9b36a62011-10-14 12:59:37 +0530539@item -fsdev @var{fsdriver},id=@var{id},path=@var{path},[security_model=@var{security_model}][,writeout=@var{writeout}]
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530540@findex -fsdev
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530541Define a new file system device. Valid options are:
542@table @option
543@item @var{fsdriver}
544This option specifies the fs driver backend to use.
545Currently "local" and "handle" file system drivers are supported.
546@item id=@var{id}
547Specifies identifier for this device
548@item path=@var{path}
549Specifies the export path for the file system device. Files under
550this path will be available to the 9p client on the guest.
551@item security_model=@var{security_model}
552Specifies the security model to be used for this export path.
553Supported security models are "passthrough", "mapped" and "none".
554In "passthrough" security model, files are stored using the same
555credentials as they are created on the guest. This requires qemu
556to run as root. In "mapped" security model, some of the file
557attributes like uid, gid, mode bits and link target are stored as
558file attributes. Directories exported by this security model cannot
559interact with other unix tools. "none" security model is same as
560passthrough except the sever won't report failures if it fails to
M. Mohan Kumard9b36a62011-10-14 12:59:37 +0530561set file attributes like ownership. Security model is mandatory
562only for local fsdriver. Other fsdrivers (like handle) don't take
563security model as a parameter.
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530564@item writeout=@var{writeout}
565This is an optional argument. The only supported value is "immediate".
566This means that host page cache will be used to read and write data but
567write notification will be sent to the guest only when the data has been
568reported as written by the storage subsystem.
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530569@end table
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530570
571-fsdev option is used along with -device driver "virtio-9p-pci".
572@item -device virtio-9p-pci,fsdev=@var{id},mount_tag=@var{mount_tag}
573Options for virtio-9p-pci driver are:
574@table @option
575@item fsdev=@var{id}
576Specifies the id value specified along with -fsdev option
577@item mount_tag=@var{mount_tag}
578Specifies the tag name to be used by the guest to mount this export point
579@end table
580
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530581ETEXI
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530582
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530583DEFHEADING()
584
Gautham R Shenoy3d54abc2010-04-29 17:45:03 +0530585DEFHEADING(Virtual File system pass-through options:)
586
587DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs,
Aneesh Kumar K.Vd3ab98e2011-10-12 19:11:23 +0530588 "-virtfs local,path=path,mount_tag=tag,security_model=[mapped|passthrough|none]\n"
589 " [,writeout=immediate]\n",
Gautham R Shenoy3d54abc2010-04-29 17:45:03 +0530590 QEMU_ARCH_ALL)
591
592STEXI
593
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530594@item -virtfs @var{fsdriver},path=@var{path},mount_tag=@var{mount_tag},security_model=@var{security_model}[,writeout=@var{writeout}]
Gautham R Shenoy3d54abc2010-04-29 17:45:03 +0530595@findex -virtfs
Gautham R Shenoy3d54abc2010-04-29 17:45:03 +0530596
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530597The general form of a Virtual File system pass-through options are:
598@table @option
599@item @var{fsdriver}
600This option specifies the fs driver backend to use.
601Currently "local" and "handle" file system drivers are supported.
602@item id=@var{id}
603Specifies identifier for this device
604@item path=@var{path}
605Specifies the export path for the file system device. Files under
606this path will be available to the 9p client on the guest.
607@item security_model=@var{security_model}
608Specifies the security model to be used for this export path.
609Supported security models are "passthrough", "mapped" and "none".
610In "passthrough" security model, files are stored using the same
611credentials as they are created on the guest. This requires qemu
612to run as root. In "mapped" security model, some of the file
613attributes like uid, gid, mode bits and link target are stored as
614file attributes. Directories exported by this security model cannot
615interact with other unix tools. "none" security model is same as
616passthrough except the sever won't report failures if it fails to
M. Mohan Kumard9b36a62011-10-14 12:59:37 +0530617set file attributes like ownership. Security model is mandatory only
618for local fsdriver. Other fsdrivers (like handle) don't take security
619model as a parameter.
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530620@item writeout=@var{writeout}
621This is an optional argument. The only supported value is "immediate".
622This means that host page cache will be used to read and write data but
623write notification will be sent to the guest only when the data has been
624reported as written by the storage subsystem.
Gautham R Shenoy3d54abc2010-04-29 17:45:03 +0530625@end table
626ETEXI
Gautham R Shenoy3d54abc2010-04-29 17:45:03 +0530627
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530628DEFHEADING()
629
blueswir15824d652009-03-28 06:44:27 +0000630DEF("name", HAS_ARG, QEMU_OPTION_name,
Bruce Rogersca1a8a02010-01-06 12:33:57 -0700631 "-name string1[,process=string2]\n"
632 " set the name of the guest\n"
Blue Swirlad960902010-03-29 19:23:52 +0000633 " string1 sets the window title and string2 the process name (on Linux)\n",
634 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000635STEXI
636@item -name @var{name}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100637@findex -name
blueswir15824d652009-03-28 06:44:27 +0000638Sets the @var{name} of the guest.
639This name will be displayed in the SDL window caption.
640The @var{name} will also be used for the VNC server.
Andi Kleen18894652009-07-02 09:34:17 +0200641Also optionally set the top visible process name in Linux.
blueswir15824d652009-03-28 06:44:27 +0000642ETEXI
643
644DEF("uuid", HAS_ARG, QEMU_OPTION_uuid,
Paolo Bonzinie8105eb2010-02-04 16:49:59 +0100645 "-uuid %08x-%04x-%04x-%04x-%012x\n"
Blue Swirlad960902010-03-29 19:23:52 +0000646 " specify machine UUID\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000647STEXI
648@item -uuid @var{uuid}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100649@findex -uuid
blueswir15824d652009-03-28 06:44:27 +0000650Set system UUID.
651ETEXI
652
653STEXI
654@end table
655ETEXI
656
657DEFHEADING()
658
659DEFHEADING(Display options:)
660
661STEXI
662@table @option
663ETEXI
664
Jes Sorensen1472a952011-03-16 13:33:31 +0100665DEF("display", HAS_ARG, QEMU_OPTION_display,
666 "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n"
Jes Sorensen3264ff12011-03-16 13:33:33 +0100667 " [,window_close=on|off]|curses|none|\n"
668 " vnc=<display>[,<optargs>]\n"
Jes Sorensen1472a952011-03-16 13:33:31 +0100669 " select display type\n", QEMU_ARCH_ALL)
670STEXI
671@item -display @var{type}
672@findex -display
673Select type of display to use. This option is a replacement for the
674old style -sdl/-curses/... options. Valid values for @var{type} are
675@table @option
676@item sdl
677Display video output via SDL (usually in a separate graphics
678window; see the SDL documentation for other possibilities).
679@item curses
680Display video output via curses. For graphics device models which
681support a text mode, QEMU can display this output using a
682curses/ncurses interface. Nothing is displayed when the graphics
683device is in graphical mode or if the graphics device does not support
684a text mode. Generally only the VGA device models support text mode.
Jes Sorensen4171d322011-03-16 13:33:32 +0100685@item none
686Do not display video output. The guest will still see an emulated
687graphics card, but its output will not be displayed to the QEMU
688user. This option differs from the -nographic option in that it
689only affects what is done with video output; -nographic also changes
690the destination of the serial and parallel port data.
Jes Sorensen3264ff12011-03-16 13:33:33 +0100691@item vnc
692Start a VNC server on display <arg>
Jes Sorensen1472a952011-03-16 13:33:31 +0100693@end table
694ETEXI
695
blueswir15824d652009-03-28 06:44:27 +0000696DEF("nographic", 0, QEMU_OPTION_nographic,
Blue Swirlad960902010-03-29 19:23:52 +0000697 "-nographic disable graphical output and redirect serial I/Os to console\n",
698 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000699STEXI
700@item -nographic
Stefan Weil6616b2a2010-02-05 23:52:05 +0100701@findex -nographic
blueswir15824d652009-03-28 06:44:27 +0000702Normally, QEMU uses SDL to display the VGA output. With this option,
703you can totally disable graphical output so that QEMU is a simple
704command line application. The emulated serial port is redirected on
705the console. Therefore, you can still use QEMU to debug a Linux kernel
706with a serial console.
707ETEXI
708
blueswir15824d652009-03-28 06:44:27 +0000709DEF("curses", 0, QEMU_OPTION_curses,
Blue Swirlad960902010-03-29 19:23:52 +0000710 "-curses use a curses/ncurses interface instead of SDL\n",
711 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000712STEXI
713@item -curses
Stefan Weil6616b2a2010-02-05 23:52:05 +0100714@findex curses
blueswir15824d652009-03-28 06:44:27 +0000715Normally, QEMU uses SDL to display the VGA output. With this option,
716QEMU can display the VGA output when in text mode using a
717curses/ncurses interface. Nothing is displayed in graphical mode.
718ETEXI
719
blueswir15824d652009-03-28 06:44:27 +0000720DEF("no-frame", 0, QEMU_OPTION_no_frame,
Blue Swirlad960902010-03-29 19:23:52 +0000721 "-no-frame open SDL window without a frame and window decorations\n",
722 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000723STEXI
724@item -no-frame
Stefan Weil6616b2a2010-02-05 23:52:05 +0100725@findex -no-frame
blueswir15824d652009-03-28 06:44:27 +0000726Do not use decorations for SDL windows and start them using the whole
727available screen space. This makes the using QEMU in a dedicated desktop
728workspace more convenient.
729ETEXI
730
blueswir15824d652009-03-28 06:44:27 +0000731DEF("alt-grab", 0, QEMU_OPTION_alt_grab,
Blue Swirlad960902010-03-29 19:23:52 +0000732 "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n",
733 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000734STEXI
735@item -alt-grab
Stefan Weil6616b2a2010-02-05 23:52:05 +0100736@findex -alt-grab
Brad Hardsde1db2a2011-04-29 21:46:12 +1000737Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also
738affects the special keys (for fullscreen, monitor-mode switching, etc).
blueswir15824d652009-03-28 06:44:27 +0000739ETEXI
740
Dustin Kirkland0ca9f8a2009-09-17 15:48:04 -0500741DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab,
Blue Swirlad960902010-03-29 19:23:52 +0000742 "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n",
743 QEMU_ARCH_ALL)
Dustin Kirkland0ca9f8a2009-09-17 15:48:04 -0500744STEXI
745@item -ctrl-grab
Stefan Weil6616b2a2010-02-05 23:52:05 +0100746@findex -ctrl-grab
Brad Hardsde1db2a2011-04-29 21:46:12 +1000747Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also
748affects the special keys (for fullscreen, monitor-mode switching, etc).
Dustin Kirkland0ca9f8a2009-09-17 15:48:04 -0500749ETEXI
750
blueswir15824d652009-03-28 06:44:27 +0000751DEF("no-quit", 0, QEMU_OPTION_no_quit,
Blue Swirlad960902010-03-29 19:23:52 +0000752 "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000753STEXI
754@item -no-quit
Stefan Weil6616b2a2010-02-05 23:52:05 +0100755@findex -no-quit
blueswir15824d652009-03-28 06:44:27 +0000756Disable SDL window close capability.
757ETEXI
758
blueswir15824d652009-03-28 06:44:27 +0000759DEF("sdl", 0, QEMU_OPTION_sdl,
Blue Swirlad960902010-03-29 19:23:52 +0000760 "-sdl enable SDL\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000761STEXI
762@item -sdl
Stefan Weil6616b2a2010-02-05 23:52:05 +0100763@findex -sdl
blueswir15824d652009-03-28 06:44:27 +0000764Enable SDL.
765ETEXI
766
Gerd Hoffmann29b00402010-03-11 11:13:27 -0300767DEF("spice", HAS_ARG, QEMU_OPTION_spice,
768 "-spice <args> enable spice\n", QEMU_ARCH_ALL)
769STEXI
770@item -spice @var{option}[,@var{option}[,...]]
771@findex -spice
772Enable the spice remote desktop protocol. Valid options are
773
774@table @option
775
776@item port=<nr>
Gerd Hoffmannc448e852010-03-11 11:13:32 -0300777Set the TCP port spice is listening on for plaintext channels.
Gerd Hoffmann29b00402010-03-11 11:13:27 -0300778
Gerd Hoffmann333b0ee2010-08-27 14:29:16 +0200779@item addr=<addr>
780Set the IP address spice is listening on. Default is any address.
781
782@item ipv4
783@item ipv6
784Force using the specified IP version.
785
Gerd Hoffmann29b00402010-03-11 11:13:27 -0300786@item password=<secret>
787Set the password you need to authenticate.
788
Marc-André Lureau48b3ed02011-05-17 10:40:33 +0200789@item sasl
790Require that the client use SASL to authenticate with the spice.
791The exact choice of authentication method used is controlled from the
792system / user's SASL configuration file for the 'qemu' service. This
793is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
794unprivileged user, an environment variable SASL_CONF_PATH can be used
795to make it search alternate locations for the service config.
796While some SASL auth methods can also provide data encryption (eg GSSAPI),
797it is recommended that SASL always be combined with the 'tls' and
798'x509' settings to enable use of SSL and server certificates. This
799ensures a data encryption preventing compromise of authentication
800credentials.
801
Gerd Hoffmann29b00402010-03-11 11:13:27 -0300802@item disable-ticketing
803Allow client connects without authentication.
804
Hans de Goeded4970b02011-03-27 16:43:54 +0200805@item disable-copy-paste
806Disable copy paste between the client and the guest.
807
Gerd Hoffmannc448e852010-03-11 11:13:32 -0300808@item tls-port=<nr>
809Set the TCP port spice is listening on for encrypted channels.
810
811@item x509-dir=<dir>
812Set the x509 file directory. Expects same filenames as -vnc $display,x509=$dir
813
814@item x509-key-file=<file>
815@item x509-key-password=<file>
816@item x509-cert-file=<file>
817@item x509-cacert-file=<file>
818@item x509-dh-key-file=<file>
819The x509 file names can also be configured individually.
820
821@item tls-ciphers=<list>
822Specify which ciphers to use.
823
Gerd Hoffmann17b6dea2010-08-27 14:09:56 +0200824@item tls-channel=[main|display|inputs|record|playback|tunnel]
825@item plaintext-channel=[main|display|inputs|record|playback|tunnel]
826Force specific channel to be used with or without TLS encryption. The
827options can be specified multiple times to configure multiple
828channels. The special name "default" can be used to set the default
829mode. For channels which are not explicitly forced into one mode the
830spice client is allowed to pick tls/plaintext as he pleases.
831
Yonit Halperin9f04e092010-07-14 13:26:34 +0300832@item image-compression=[auto_glz|auto_lz|quic|glz|lz|off]
833Configure image compression (lossless).
834Default is auto_glz.
835
836@item jpeg-wan-compression=[auto|never|always]
837@item zlib-glz-wan-compression=[auto|never|always]
838Configure wan image compression (lossy for slow links).
839Default is auto.
840
Gerd Hoffmann84a23f22010-08-30 16:36:53 +0200841@item streaming-video=[off|all|filter]
842Configure video stream detection. Default is filter.
843
844@item agent-mouse=[on|off]
845Enable/disable passing mouse events via vdagent. Default is on.
846
847@item playback-compression=[on|off]
848Enable/disable audio stream compression (using celt 0.5.1). Default is on.
849
Gerd Hoffmann29b00402010-03-11 11:13:27 -0300850@end table
851ETEXI
852
blueswir15824d652009-03-28 06:44:27 +0000853DEF("portrait", 0, QEMU_OPTION_portrait,
Blue Swirlad960902010-03-29 19:23:52 +0000854 "-portrait rotate graphical output 90 deg left (only PXA LCD)\n",
855 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000856STEXI
857@item -portrait
Stefan Weil6616b2a2010-02-05 23:52:05 +0100858@findex -portrait
blueswir15824d652009-03-28 06:44:27 +0000859Rotate graphical output 90 deg left (only PXA LCD).
860ETEXI
861
Vasily Khoruzhick93128052011-06-17 13:04:36 +0300862DEF("rotate", HAS_ARG, QEMU_OPTION_rotate,
863 "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n",
864 QEMU_ARCH_ALL)
865STEXI
866@item -rotate
867@findex -rotate
868Rotate graphical output some deg left (only PXA LCD).
869ETEXI
870
blueswir15824d652009-03-28 06:44:27 +0000871DEF("vga", HAS_ARG, QEMU_OPTION_vga,
Gerd Hoffmanna19cbfb2010-04-27 11:50:11 +0200872 "-vga [std|cirrus|vmware|qxl|xenfb|none]\n"
Blue Swirlad960902010-03-29 19:23:52 +0000873 " select video card type\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000874STEXI
875@item -vga @var{type}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100876@findex -vga
blueswir15824d652009-03-28 06:44:27 +0000877Select type of VGA card to emulate. Valid values for @var{type} are
Kevin Wolfb3f046c2009-10-09 10:58:35 +0200878@table @option
blueswir15824d652009-03-28 06:44:27 +0000879@item cirrus
880Cirrus Logic GD5446 Video card. All Windows versions starting from
881Windows 95 should recognize and use this graphic card. For optimal
882performances, use 16 bit color depth in the guest and the host OS.
883(This one is the default)
884@item std
885Standard VGA card with Bochs VBE extensions. If your guest OS
886supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
887to use high resolution modes (>= 1280x1024x16) then you should use
888this option.
889@item vmware
890VMWare SVGA-II compatible adapter. Use it if you have sufficiently
891recent XFree86/XOrg server or Windows guest with a driver for this
892card.
Gerd Hoffmanna19cbfb2010-04-27 11:50:11 +0200893@item qxl
894QXL paravirtual graphic card. It is VGA compatible (including VESA
8952.0 VBE support). Works best with qxl guest drivers installed though.
896Recommended choice when using the spice protocol.
blueswir15824d652009-03-28 06:44:27 +0000897@item none
898Disable VGA card.
899@end table
900ETEXI
901
902DEF("full-screen", 0, QEMU_OPTION_full_screen,
Blue Swirlad960902010-03-29 19:23:52 +0000903 "-full-screen start in full screen\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000904STEXI
905@item -full-screen
Stefan Weil6616b2a2010-02-05 23:52:05 +0100906@findex -full-screen
blueswir15824d652009-03-28 06:44:27 +0000907Start in full screen.
908ETEXI
909
blueswir15824d652009-03-28 06:44:27 +0000910DEF("g", 1, QEMU_OPTION_g ,
Blue Swirlad960902010-03-29 19:23:52 +0000911 "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n",
912 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
blueswir15824d652009-03-28 06:44:27 +0000913STEXI
Stefan Weil95d5f082010-01-20 22:25:27 +0100914@item -g @var{width}x@var{height}[x@var{depth}]
Stefan Weil6616b2a2010-02-05 23:52:05 +0100915@findex -g
Stefan Weil95d5f082010-01-20 22:25:27 +0100916Set the initial graphical resolution and depth (PPC, SPARC only).
blueswir15824d652009-03-28 06:44:27 +0000917ETEXI
918
919DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
Blue Swirlad960902010-03-29 19:23:52 +0000920 "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000921STEXI
922@item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
Stefan Weil6616b2a2010-02-05 23:52:05 +0100923@findex -vnc
blueswir15824d652009-03-28 06:44:27 +0000924Normally, QEMU uses SDL to display the VGA output. With this option,
925you can have QEMU listen on VNC display @var{display} and redirect the VGA
926display over the VNC session. It is very useful to enable the usb
927tablet device when using this option (option @option{-usbdevice
928tablet}). When using the VNC display, you must use the @option{-k}
929parameter to set the keyboard layout if you are not using en-us. Valid
930syntax for the @var{display} is
931
Kevin Wolfb3f046c2009-10-09 10:58:35 +0200932@table @option
blueswir15824d652009-03-28 06:44:27 +0000933
934@item @var{host}:@var{d}
935
936TCP connections will only be allowed from @var{host} on display @var{d}.
937By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
938be omitted in which case the server will accept connections from any host.
939
Kevin Wolf4e257e52009-10-09 10:58:36 +0200940@item unix:@var{path}
blueswir15824d652009-03-28 06:44:27 +0000941
942Connections will be allowed over UNIX domain sockets where @var{path} is the
943location of a unix socket to listen for connections on.
944
945@item none
946
947VNC is initialized but not started. The monitor @code{change} command
948can be used to later start the VNC server.
949
950@end table
951
952Following the @var{display} value there may be one or more @var{option} flags
953separated by commas. Valid options are
954
Kevin Wolfb3f046c2009-10-09 10:58:35 +0200955@table @option
blueswir15824d652009-03-28 06:44:27 +0000956
957@item reverse
958
959Connect to a listening VNC client via a ``reverse'' connection. The
960client is specified by the @var{display}. For reverse network
961connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
962is a TCP port number, not a display number.
963
964@item password
965
966Require that password based authentication is used for client connections.
967The password must be set separately using the @code{change} command in the
968@ref{pcsys_monitor}
969
970@item tls
971
972Require that client use TLS when communicating with the VNC server. This
973uses anonymous TLS credentials so is susceptible to a man-in-the-middle
974attack. It is recommended that this option be combined with either the
Kevin Wolf4e257e52009-10-09 10:58:36 +0200975@option{x509} or @option{x509verify} options.
blueswir15824d652009-03-28 06:44:27 +0000976
977@item x509=@var{/path/to/certificate/dir}
978
979Valid if @option{tls} is specified. Require that x509 credentials are used
980for negotiating the TLS session. The server will send its x509 certificate
981to the client. It is recommended that a password be set on the VNC server
982to provide authentication of the client when this is used. The path following
983this option specifies where the x509 certificates are to be loaded from.
984See the @ref{vnc_security} section for details on generating certificates.
985
986@item x509verify=@var{/path/to/certificate/dir}
987
988Valid if @option{tls} is specified. Require that x509 credentials are used
989for negotiating the TLS session. The server will send its x509 certificate
990to the client, and request that the client send its own x509 certificate.
991The server will validate the client's certificate against the CA certificate,
992and reject clients when validation fails. If the certificate authority is
993trusted, this is a sufficient authentication mechanism. You may still wish
994to set a password on the VNC server as a second authentication layer. The
995path following this option specifies where the x509 certificates are to
996be loaded from. See the @ref{vnc_security} section for details on generating
997certificates.
998
999@item sasl
1000
1001Require that the client use SASL to authenticate with the VNC server.
1002The exact choice of authentication method used is controlled from the
1003system / user's SASL configuration file for the 'qemu' service. This
1004is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
1005unprivileged user, an environment variable SASL_CONF_PATH can be used
1006to make it search alternate locations for the service config.
1007While some SASL auth methods can also provide data encryption (eg GSSAPI),
1008it is recommended that SASL always be combined with the 'tls' and
1009'x509' settings to enable use of SSL and server certificates. This
1010ensures a data encryption preventing compromise of authentication
1011credentials. See the @ref{vnc_security} section for details on using
1012SASL authentication.
1013
1014@item acl
1015
1016Turn on access control lists for checking of the x509 client certificate
1017and SASL party. For x509 certs, the ACL check is made against the
1018certificate's distinguished name. This is something that looks like
1019@code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
1020made against the username, which depending on the SASL plugin, may
1021include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
1022When the @option{acl} flag is set, the initial access list will be
1023empty, with a @code{deny} policy. Thus no one will be allowed to
1024use the VNC server until the ACLs have been loaded. This can be
1025achieved using the @code{acl} monitor command.
1026
Corentin Chary6f9c78c2010-07-07 20:57:51 +02001027@item lossy
1028
1029Enable lossy compression methods (gradient, JPEG, ...). If this
1030option is set, VNC client may receive lossy framebuffer updates
1031depending on its encoding settings. Enabling this option can save
1032a lot of bandwidth at the expense of quality.
1033
Corentin Chary80e0c8c2011-02-04 09:06:08 +01001034@item non-adaptive
1035
1036Disable adaptive encodings. Adaptive encodings are enabled by default.
1037An adaptive encoding will try to detect frequently updated screen regions,
1038and send updates in these regions using a lossy encoding (like JPEG).
Stefan Weil61cc8702011-04-13 22:45:22 +02001039This can be really helpful to save bandwidth when playing videos. Disabling
1040adaptive encodings allows to restore the original static behavior of encodings
Corentin Chary80e0c8c2011-02-04 09:06:08 +01001041like Tight.
1042
blueswir15824d652009-03-28 06:44:27 +00001043@end table
1044ETEXI
1045
1046STEXI
1047@end table
1048ETEXI
1049
1050DEFHEADING()
1051
blueswir15824d652009-03-28 06:44:27 +00001052DEFHEADING(i386 target only:)
blueswir15824d652009-03-28 06:44:27 +00001053STEXI
1054@table @option
1055ETEXI
1056
blueswir15824d652009-03-28 06:44:27 +00001057DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack,
Blue Swirlad960902010-03-29 19:23:52 +00001058 "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n",
1059 QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001060STEXI
1061@item -win2k-hack
Stefan Weil6616b2a2010-02-05 23:52:05 +01001062@findex -win2k-hack
blueswir15824d652009-03-28 06:44:27 +00001063Use it when installing Windows 2000 to avoid a disk full bug. After
1064Windows 2000 is installed, you no longer need this option (this option
1065slows down the IDE transfers).
1066ETEXI
1067
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02001068HXCOMM Deprecated by -rtc
Blue Swirlad960902010-03-29 19:23:52 +00001069DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001070
blueswir15824d652009-03-28 06:44:27 +00001071DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk,
Blue Swirlad960902010-03-29 19:23:52 +00001072 "-no-fd-bootchk disable boot signature checking for floppy disks\n",
1073 QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001074STEXI
1075@item -no-fd-bootchk
Stefan Weil6616b2a2010-02-05 23:52:05 +01001076@findex -no-fd-bootchk
blueswir15824d652009-03-28 06:44:27 +00001077Disable boot signature checking for floppy disks in Bochs BIOS. It may
1078be needed to boot from old floppy disks.
Stefan Weil6616b2a2010-02-05 23:52:05 +01001079TODO: check reference to Bochs BIOS.
blueswir15824d652009-03-28 06:44:27 +00001080ETEXI
1081
blueswir15824d652009-03-28 06:44:27 +00001082DEF("no-acpi", 0, QEMU_OPTION_no_acpi,
Blue Swirlad960902010-03-29 19:23:52 +00001083 "-no-acpi disable ACPI\n", QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001084STEXI
1085@item -no-acpi
Stefan Weil6616b2a2010-02-05 23:52:05 +01001086@findex -no-acpi
blueswir15824d652009-03-28 06:44:27 +00001087Disable ACPI (Advanced Configuration and Power Interface) support. Use
1088it if your guest OS complains about ACPI problems (PC target machine
1089only).
1090ETEXI
1091
blueswir15824d652009-03-28 06:44:27 +00001092DEF("no-hpet", 0, QEMU_OPTION_no_hpet,
Blue Swirlad960902010-03-29 19:23:52 +00001093 "-no-hpet disable HPET\n", QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001094STEXI
1095@item -no-hpet
Stefan Weil6616b2a2010-02-05 23:52:05 +01001096@findex -no-hpet
blueswir15824d652009-03-28 06:44:27 +00001097Disable HPET support.
1098ETEXI
1099
Markus Armbruster7d4c3d52009-06-26 19:15:14 +02001100DEF("balloon", HAS_ARG, QEMU_OPTION_balloon,
1101 "-balloon none disable balloon device\n"
1102 "-balloon virtio[,addr=str]\n"
Blue Swirlad960902010-03-29 19:23:52 +00001103 " enable virtio balloon device (default)\n", QEMU_ARCH_ALL)
Eduardo Habkostdf97b922009-06-10 16:34:08 -03001104STEXI
Markus Armbruster7d4c3d52009-06-26 19:15:14 +02001105@item -balloon none
Stefan Weil6616b2a2010-02-05 23:52:05 +01001106@findex -balloon
Markus Armbruster7d4c3d52009-06-26 19:15:14 +02001107Disable balloon device.
1108@item -balloon virtio[,addr=@var{addr}]
1109Enable virtio balloon device (default), optionally with PCI address
1110@var{addr}.
Eduardo Habkostdf97b922009-06-10 16:34:08 -03001111ETEXI
1112
blueswir15824d652009-03-28 06:44:27 +00001113DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable,
Michael Tokarev104bf022011-05-12 18:44:17 +04001114 "-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 +00001115 " ACPI table description\n", QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001116STEXI
1117@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 +01001118@findex -acpitable
blueswir15824d652009-03-28 06:44:27 +00001119Add ACPI table with specified header fields and context from specified files.
Michael Tokarev104bf022011-05-12 18:44:17 +04001120For file=, take whole ACPI table from the specified files, including all
1121ACPI headers (possible overridden by other options).
1122For data=, only data
1123portion of the table is used, all header information is specified in the
1124command line.
blueswir15824d652009-03-28 06:44:27 +00001125ETEXI
1126
aliguorib6f6e3d2009-04-17 18:59:56 +00001127DEF("smbios", HAS_ARG, QEMU_OPTION_smbios,
1128 "-smbios file=binary\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -07001129 " load SMBIOS entry from binary file\n"
Paolo Bonzinie8105eb2010-02-04 16:49:59 +01001130 "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -07001131 " specify SMBIOS type 0 fields\n"
aliguorib6f6e3d2009-04-17 18:59:56 +00001132 "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n"
1133 " [,uuid=uuid][,sku=str][,family=str]\n"
Blue Swirlad960902010-03-29 19:23:52 +00001134 " specify SMBIOS type 1 fields\n", QEMU_ARCH_I386)
aliguorib6f6e3d2009-04-17 18:59:56 +00001135STEXI
1136@item -smbios file=@var{binary}
Stefan Weil6616b2a2010-02-05 23:52:05 +01001137@findex -smbios
aliguorib6f6e3d2009-04-17 18:59:56 +00001138Load SMBIOS entry from binary file.
1139
1140@item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}]
Stefan Weil6616b2a2010-02-05 23:52:05 +01001141@findex -smbios
aliguorib6f6e3d2009-04-17 18:59:56 +00001142Specify SMBIOS type 0 fields
1143
Blue Swirl609c1da2010-03-18 18:41:49 +00001144@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 +00001145Specify SMBIOS type 1 fields
1146ETEXI
1147
blueswir15824d652009-03-28 06:44:27 +00001148DEFHEADING()
blueswir15824d652009-03-28 06:44:27 +00001149STEXI
1150@end table
1151ETEXI
1152
1153DEFHEADING(Network options:)
1154STEXI
1155@table @option
1156ETEXI
1157
Jan Kiszkaad196a92009-06-24 14:42:28 +02001158HXCOMM Legacy slirp options (now moved to -net user):
1159#ifdef CONFIG_SLIRP
Blue Swirlad960902010-03-29 19:23:52 +00001160DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL)
1161DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL)
1162DEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL)
Jan Kiszkaad196a92009-06-24 14:42:28 +02001163#ifndef _WIN32
Blue Swirlad960902010-03-29 19:23:52 +00001164DEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL)
Jan Kiszkaad196a92009-06-24 14:42:28 +02001165#endif
1166#endif
1167
Blue Swirlbab79442009-06-09 21:50:02 +03001168DEF("net", HAS_ARG, QEMU_OPTION_net,
Michael S. Tsirkinffe63702009-06-21 19:51:18 +03001169 "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n"
blueswir15824d652009-03-28 06:44:27 +00001170 " create a new Network Interface Card and connect it to VLAN 'n'\n"
1171#ifdef CONFIG_SLIRP
Jan Kiszkac54ed5b2011-07-20 12:20:14 +02001172 "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=on|off]\n"
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001173 " [,hostname=host][,dhcpstart=addr][,dns=addr][,tftp=dir][,bootfile=f]\n"
1174 " [,hostfwd=rule][,guestfwd=rule]"
Jan Kiszkaad196a92009-06-24 14:42:28 +02001175#ifndef _WIN32
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001176 "[,smb=dir[,smbserver=addr]]\n"
Jan Kiszkaad196a92009-06-24 14:42:28 +02001177#endif
1178 " connect the user mode network stack to VLAN 'n', configure its\n"
1179 " DHCP server and enabled optional services\n"
blueswir15824d652009-03-28 06:44:27 +00001180#endif
1181#ifdef _WIN32
1182 "-net tap[,vlan=n][,name=str],ifname=name\n"
1183 " connect the host TAP network interface to VLAN 'n'\n"
1184#else
mst@redhat.com5430a282011-02-01 22:13:42 +02001185 "-net tap[,vlan=n][,name=str][,fd=h][,ifname=name][,script=file][,downscript=dfile][,sndbuf=nbytes][,vnet_hdr=on|off][,vhost=on|off][,vhostfd=h][,vhostforce=on|off]\n"
blueswir15824d652009-03-28 06:44:27 +00001186 " connect the host TAP network interface to VLAN 'n' and use the\n"
Paolo Bonzinibec7c2d2010-02-04 16:49:58 +01001187 " network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n"
1188 " and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -07001189 " use '[down]script=no' to disable script execution\n"
blueswir15824d652009-03-28 06:44:27 +00001190 " use 'fd=h' to connect to an already opened TAP interface\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -07001191 " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n"
Michael S. Tsirkinf157ed22011-02-01 14:25:40 +02001192 " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -07001193 " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n"
1194 " 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 +02001195 " use vhost=on to enable experimental in kernel accelerator\n"
mst@redhat.com5430a282011-02-01 22:13:42 +02001196 " (only has effect for virtio guests which use MSIX)\n"
1197 " use vhostforce=on to force vhost on for non-MSIX virtio guests\n"
Michael S. Tsirkin82b0d802010-03-17 13:08:24 +02001198 " use 'vhostfd=h' to connect to an already opened vhost net device\n"
Mark McLoughlin0df0ff62009-06-18 18:21:34 +01001199#endif
blueswir15824d652009-03-28 06:44:27 +00001200 "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n"
1201 " connect the vlan 'n' to another VLAN using a socket connection\n"
Mike Ryan3a75e742010-12-01 11:16:47 -08001202 "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port[,localaddr=addr]]\n"
blueswir15824d652009-03-28 06:44:27 +00001203 " connect the vlan 'n' to multicast maddr and port\n"
Mike Ryan3a75e742010-12-01 11:16:47 -08001204 " use 'localaddr=addr' to specify the host address to send packets from\n"
blueswir15824d652009-03-28 06:44:27 +00001205#ifdef CONFIG_VDE
1206 "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n"
1207 " connect the vlan 'n' to port 'n' of a vde switch running\n"
1208 " on host and listening for incoming connections on 'socketpath'.\n"
1209 " Use group 'groupname' and mode 'octalmode' to change default\n"
1210 " ownership and permissions for communication port.\n"
1211#endif
aliguoribb9ea792009-04-21 19:56:28 +00001212 "-net dump[,vlan=n][,file=f][,len=n]\n"
1213 " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -07001214 "-net none use it alone to have zero network devices. If no -net option\n"
Blue Swirlad960902010-03-29 19:23:52 +00001215 " is provided, the default is '-net nic -net user'\n", QEMU_ARCH_ALL)
Mark McLoughlina1ea4582009-10-08 19:58:26 +01001216DEF("netdev", HAS_ARG, QEMU_OPTION_netdev,
1217 "-netdev ["
1218#ifdef CONFIG_SLIRP
1219 "user|"
1220#endif
1221 "tap|"
1222#ifdef CONFIG_VDE
1223 "vde|"
1224#endif
Blue Swirlad960902010-03-29 19:23:52 +00001225 "socket],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001226STEXI
Blue Swirl609c1da2010-03-18 18:41:49 +00001227@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 +01001228@findex -net
blueswir15824d652009-03-28 06:44:27 +00001229Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
Anthony Liguori0d6b0b12009-08-14 11:20:47 -05001230= 0 is the default). The NIC is an e1000 by default on the PC
Markus Armbruster5607c382009-06-18 15:14:08 +02001231target. Optionally, the MAC address can be changed to @var{mac}, the
1232device address set to @var{addr} (PCI cards only),
Michael S. Tsirkinffe63702009-06-21 19:51:18 +03001233and a @var{name} can be assigned for use in monitor commands.
1234Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
1235that the card should have; this option currently only affects virtio cards; set
1236@var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
1237NIC is created. Qemu can emulate several different models of network card.
blueswir15824d652009-03-28 06:44:27 +00001238Valid values for @var{type} are
Michael S. Tsirkinffe63702009-06-21 19:51:18 +03001239@code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er},
blueswir15824d652009-03-28 06:44:27 +00001240@code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
1241@code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
1242Not all devices are supported on all targets. Use -net nic,model=?
1243for a list of available devices for your target.
1244
Jan Kiszkaad196a92009-06-24 14:42:28 +02001245@item -net user[,@var{option}][,@var{option}][,...]
blueswir15824d652009-03-28 06:44:27 +00001246Use the user mode network stack which requires no administrator
Jan Kiszkaad196a92009-06-24 14:42:28 +02001247privilege to run. Valid options are:
blueswir15824d652009-03-28 06:44:27 +00001248
Kevin Wolfb3f046c2009-10-09 10:58:35 +02001249@table @option
Jan Kiszkaad196a92009-06-24 14:42:28 +02001250@item vlan=@var{n}
1251Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default).
1252
1253@item name=@var{name}
1254Assign symbolic name for use in monitor commands.
1255
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001256@item net=@var{addr}[/@var{mask}]
1257Set IP network address the guest will see. Optionally specify the netmask,
1258either in the form a.b.c.d or as number of valid top-most bits. Default is
Brad Hardsb0b36e52011-04-24 17:19:56 +1000125910.0.2.0/24.
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001260
1261@item host=@var{addr}
1262Specify the guest-visible address of the host. Default is the 2nd IP in the
1263guest network, i.e. x.x.x.2.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001264
Jan Kiszkac54ed5b2011-07-20 12:20:14 +02001265@item restrict=on|off
Brad Hardscaef55e2011-06-09 07:50:43 +10001266If this option is enabled, the guest will be isolated, i.e. it will not be
Jan Kiszkaad196a92009-06-24 14:42:28 +02001267able to contact the host and no guest IP packets will be routed over the host
Brad Hardscaef55e2011-06-09 07:50:43 +10001268to the outside. This option does not affect any explicitly set forwarding rules.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001269
1270@item hostname=@var{name}
1271Specifies the client hostname reported by the builtin DHCP server.
1272
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001273@item dhcpstart=@var{addr}
1274Specify the first of the 16 IPs the built-in DHCP server can assign. Default
Brad Hardsb0b36e52011-04-24 17:19:56 +10001275is 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 +02001276
1277@item dns=@var{addr}
1278Specify the guest-visible address of the virtual nameserver. The address must
1279be different from the host address. Default is the 3rd IP in the guest network,
1280i.e. x.x.x.3.
1281
Jan Kiszkaad196a92009-06-24 14:42:28 +02001282@item tftp=@var{dir}
1283When using the user mode network stack, activate a built-in TFTP
1284server. The files in @var{dir} will be exposed as the root of a TFTP server.
1285The TFTP client on the guest must be configured in binary mode (use the command
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001286@code{bin} of the Unix TFTP client).
Jan Kiszkaad196a92009-06-24 14:42:28 +02001287
1288@item bootfile=@var{file}
1289When using the user mode network stack, broadcast @var{file} as the BOOTP
1290filename. In conjunction with @option{tftp}, this can be used to network boot
1291a guest from a local directory.
1292
1293Example (using pxelinux):
1294@example
1295qemu -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
1296@end example
1297
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001298@item smb=@var{dir}[,smbserver=@var{addr}]
Jan Kiszkaad196a92009-06-24 14:42:28 +02001299When using the user mode network stack, activate a built-in SMB
1300server so that Windows OSes can access to the host files in @file{@var{dir}}
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001301transparently. The IP address of the SMB server can be set to @var{addr}. By
1302default the 4th IP in the guest network is used, i.e. x.x.x.4.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001303
1304In the guest Windows OS, the line:
1305@example
130610.0.2.4 smbserver
1307@end example
1308must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
1309or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
1310
1311Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
1312
Brade2d88302011-09-02 16:53:28 -04001313Note that a SAMBA server must be installed on the host OS.
1314QEMU was tested successfully with smbd versions from Red Hat 9,
1315Fedora Core 3 and OpenSUSE 11.x.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001316
Jan Kiszka3c6a0582009-06-24 14:42:28 +02001317@item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001318Redirect incoming TCP or UDP connections to the host port @var{hostport} to
1319the guest IP address @var{guestaddr} on guest port @var{guestport}. If
1320@var{guestaddr} is not specified, its value is x.x.x.15 (default first address
Jan Kiszka3c6a0582009-06-24 14:42:28 +02001321given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
1322be bound to a specific host interface. If no connection type is set, TCP is
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001323used. This option can be given multiple times.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001324
1325For example, to redirect host X11 connection from screen 1 to guest
1326screen 0, use the following:
1327
1328@example
1329# on the host
Jan Kiszka3c6a0582009-06-24 14:42:28 +02001330qemu -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...]
Jan Kiszkaad196a92009-06-24 14:42:28 +02001331# this host xterm should open in the guest X11 server
1332xterm -display :1
1333@end example
1334
1335To redirect telnet connections from host port 5555 to telnet port on
1336the guest, use the following:
1337
1338@example
1339# on the host
Aurelien Jarnoaa375202010-02-27 10:50:32 +01001340qemu -net user,hostfwd=tcp::5555-:23 [...]
Jan Kiszkaad196a92009-06-24 14:42:28 +02001341telnet localhost 5555
1342@end example
1343
1344Then when you use on the host @code{telnet localhost 5555}, you
1345connect to the guest telnet server.
1346
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001347@item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
Jan Kiszka3c6a0582009-06-24 14:42:28 +02001348Forward guest TCP connections to the IP address @var{server} on port @var{port}
1349to the character device @var{dev}. This option can be given multiple times.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001350
1351@end table
1352
1353Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still
1354processed and applied to -net user. Mixing them with the new configuration
1355syntax gives undefined results. Their use for new applications is discouraged
1356as they will be removed from future versions.
blueswir15824d652009-03-28 06:44:27 +00001357
Blue Swirl609c1da2010-03-18 18:41:49 +00001358@item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}] [,script=@var{file}][,downscript=@var{dfile}]
blueswir15824d652009-03-28 06:44:27 +00001359Connect the host TAP network interface @var{name} to VLAN @var{n}, use
1360the network script @var{file} to configure it and the network script
1361@var{dfile} to deconfigure it. If @var{name} is not provided, the OS
1362automatically provides one. @option{fd}=@var{h} can be used to specify
1363the handle of an already opened host TAP interface. The default network
1364configure script is @file{/etc/qemu-ifup} and the default network
1365deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no}
1366or @option{downscript=no} to disable script execution. Example:
1367
1368@example
1369qemu linux.img -net nic -net tap
1370@end example
1371
1372More complicated example (two NICs, each one connected to a TAP device)
1373@example
1374qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
1375 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
1376@end example
1377
Blue Swirl609c1da2010-03-18 18:41:49 +00001378@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 +00001379
1380Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
1381machine using a TCP socket connection. If @option{listen} is
1382specified, QEMU waits for incoming connections on @var{port}
1383(@var{host} is optional). @option{connect} is used to connect to
1384another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
1385specifies an already opened TCP socket.
1386
1387Example:
1388@example
1389# launch a first QEMU instance
1390qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1391 -net socket,listen=:1234
1392# connect the VLAN 0 of this instance to the VLAN 0
1393# of the first instance
1394qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1395 -net socket,connect=127.0.0.1:1234
1396@end example
1397
Mike Ryan3a75e742010-12-01 11:16:47 -08001398@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 +00001399
1400Create a VLAN @var{n} shared with another QEMU virtual
1401machines using a UDP multicast socket, effectively making a bus for
1402every QEMU with same multicast address @var{maddr} and @var{port}.
1403NOTES:
1404@enumerate
1405@item
1406Several QEMU can be running on different hosts and share same bus (assuming
1407correct multicast setup for these hosts).
1408@item
1409mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
1410@url{http://user-mode-linux.sf.net}.
1411@item
1412Use @option{fd=h} to specify an already opened UDP multicast socket.
1413@end enumerate
1414
1415Example:
1416@example
1417# launch one QEMU instance
1418qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1419 -net socket,mcast=230.0.0.1:1234
1420# launch another QEMU instance on same "bus"
1421qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1422 -net socket,mcast=230.0.0.1:1234
1423# launch yet another QEMU instance on same "bus"
1424qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
1425 -net socket,mcast=230.0.0.1:1234
1426@end example
1427
1428Example (User Mode Linux compat.):
1429@example
1430# launch QEMU instance (note mcast address selected
1431# is UML's default)
1432qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1433 -net socket,mcast=239.192.168.1:1102
1434# launch UML
1435/path/to/linux ubd0=/path/to/root_fs eth0=mcast
1436@end example
1437
Mike Ryan3a75e742010-12-01 11:16:47 -08001438Example (send packets from host's 1.2.3.4):
1439@example
1440qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1441 -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4
1442@end example
1443
Blue Swirl609c1da2010-03-18 18:41:49 +00001444@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 +00001445Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
1446listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
1447and MODE @var{octalmode} to change default ownership and permissions for
Stefan Weilc1ba4e02011-09-05 18:13:03 +02001448communication port. This option is only available if QEMU has been compiled
blueswir15824d652009-03-28 06:44:27 +00001449with vde support enabled.
1450
1451Example:
1452@example
1453# launch vde switch
1454vde_switch -F -sock /tmp/myswitch
1455# launch QEMU instance
1456qemu linux.img -net nic -net vde,sock=/tmp/myswitch
1457@end example
1458
aliguoribb9ea792009-04-21 19:56:28 +00001459@item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
1460Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
1461At most @var{len} bytes (64k by default) per packet are stored. The file format is
1462libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
1463
blueswir15824d652009-03-28 06:44:27 +00001464@item -net none
1465Indicate that no network devices should be configured. It is used to
1466override the default configuration (@option{-net nic -net user}) which
1467is activated if no @option{-net} options are provided.
blueswir15824d652009-03-28 06:44:27 +00001468
1469@end table
1470ETEXI
1471
Matthew Booth7273a2d2009-10-30 13:41:12 +00001472DEFHEADING()
1473
1474DEFHEADING(Character device options:)
1475
1476DEF("chardev", HAS_ARG, QEMU_OPTION_chardev,
Jan Kiszka97331282010-04-06 16:55:54 +02001477 "-chardev null,id=id[,mux=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00001478 "-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n"
Jan Kiszka97331282010-04-06 16:55:54 +02001479 " [,server][,nowait][,telnet][,mux=on|off] (tcp)\n"
1480 "-chardev socket,id=id,path=path[,server][,nowait][,telnet],[mux=on|off] (unix)\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00001481 "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n"
Jan Kiszka97331282010-04-06 16:55:54 +02001482 " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n"
1483 "-chardev msmouse,id=id[,mux=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00001484 "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n"
Jan Kiszka97331282010-04-06 16:55:54 +02001485 " [,mux=on|off]\n"
1486 "-chardev file,id=id,path=path[,mux=on|off]\n"
1487 "-chardev pipe,id=id,path=path[,mux=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00001488#ifdef _WIN32
Jan Kiszka97331282010-04-06 16:55:54 +02001489 "-chardev console,id=id[,mux=on|off]\n"
1490 "-chardev serial,id=id,path=path[,mux=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00001491#else
Jan Kiszka97331282010-04-06 16:55:54 +02001492 "-chardev pty,id=id[,mux=on|off]\n"
Aurelien Jarnob7fdb3a2010-07-13 21:13:12 +02001493 "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00001494#endif
1495#ifdef CONFIG_BRLAPI
Jan Kiszka97331282010-04-06 16:55:54 +02001496 "-chardev braille,id=id[,mux=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00001497#endif
1498#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
1499 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
Jan Kiszka97331282010-04-06 16:55:54 +02001500 "-chardev tty,id=id,path=path[,mux=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00001501#endif
1502#if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__)
Jan Kiszka97331282010-04-06 16:55:54 +02001503 "-chardev parport,id=id,path=path[,mux=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00001504#endif
Alon Levycbcc6332011-01-19 10:49:50 +02001505#if defined(CONFIG_SPICE)
1506 "-chardev spicevmc,id=id,name=name[,debug=debug]\n"
1507#endif
Blue Swirlad960902010-03-29 19:23:52 +00001508 , QEMU_ARCH_ALL
Matthew Booth7273a2d2009-10-30 13:41:12 +00001509)
1510
1511STEXI
1512
1513The general form of a character device option is:
1514@table @option
1515
Jan Kiszka97331282010-04-06 16:55:54 +02001516@item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}]
Stefan Weil6616b2a2010-02-05 23:52:05 +01001517@findex -chardev
Matthew Booth7273a2d2009-10-30 13:41:12 +00001518Backend is one of:
1519@option{null},
1520@option{socket},
1521@option{udp},
1522@option{msmouse},
1523@option{vc},
1524@option{file},
1525@option{pipe},
1526@option{console},
1527@option{serial},
1528@option{pty},
1529@option{stdio},
1530@option{braille},
1531@option{tty},
Alon Levycbcc6332011-01-19 10:49:50 +02001532@option{parport},
1533@option{spicevmc}.
Matthew Booth7273a2d2009-10-30 13:41:12 +00001534The specific backend will determine the applicable options.
1535
1536All devices must have an id, which can be any string up to 127 characters long.
1537It is used to uniquely identify this device in other command line directives.
1538
Jan Kiszka97331282010-04-06 16:55:54 +02001539A character device may be used in multiplexing mode by multiple front-ends.
1540The key sequence of @key{Control-a} and @key{c} will rotate the input focus
1541between attached front-ends. Specify @option{mux=on} to enable this mode.
1542
Matthew Booth7273a2d2009-10-30 13:41:12 +00001543Options to each backend are described below.
1544
1545@item -chardev null ,id=@var{id}
1546A void device. This device will not emit any data, and will drop any data it
1547receives. The null backend does not take any options.
1548
1549@item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet]
1550
1551Create a two-way stream socket, which can be either a TCP or a unix socket. A
1552unix socket will be created if @option{path} is specified. Behaviour is
1553undefined if TCP options are specified for a unix socket.
1554
1555@option{server} specifies that the socket shall be a listening socket.
1556
1557@option{nowait} specifies that QEMU should not block waiting for a client to
1558connect to a listening socket.
1559
1560@option{telnet} specifies that traffic on the socket should interpret telnet
1561escape sequences.
1562
1563TCP and unix socket options are given below:
1564
1565@table @option
1566
Aurelien Jarno8d533562010-03-27 11:52:05 +01001567@item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay]
Matthew Booth7273a2d2009-10-30 13:41:12 +00001568
1569@option{host} for a listening socket specifies the local address to be bound.
1570For a connecting socket species the remote host to connect to. @option{host} is
1571optional for listening sockets. If not specified it defaults to @code{0.0.0.0}.
1572
1573@option{port} for a listening socket specifies the local port to be bound. For a
1574connecting socket specifies the port on the remote host to connect to.
1575@option{port} can be given as either a port number or a service name.
1576@option{port} is required.
1577
1578@option{to} is only relevant to listening sockets. If it is specified, and
1579@option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up
1580to and including @option{to} until it succeeds. @option{to} must be specified
1581as a port number.
1582
1583@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1584If neither is specified the socket may use either protocol.
1585
1586@option{nodelay} disables the Nagle algorithm.
1587
1588@item unix options: path=@var{path}
1589
1590@option{path} specifies the local path of the unix socket. @option{path} is
1591required.
1592
1593@end table
1594
1595@item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6]
1596
1597Sends all traffic from the guest to a remote host over UDP.
1598
1599@option{host} specifies the remote host to connect to. If not specified it
1600defaults to @code{localhost}.
1601
1602@option{port} specifies the port on the remote host to connect to. @option{port}
1603is required.
1604
1605@option{localaddr} specifies the local address to bind to. If not specified it
1606defaults to @code{0.0.0.0}.
1607
1608@option{localport} specifies the local port to bind to. If not specified any
1609available local port will be used.
1610
1611@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1612If neither is specified the device may use either protocol.
1613
1614@item -chardev msmouse ,id=@var{id}
1615
1616Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not
1617take any options.
1618
1619@item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]]
1620
1621Connect to a QEMU text console. @option{vc} may optionally be given a specific
1622size.
1623
1624@option{width} and @option{height} specify the width and height respectively of
1625the console, in pixels.
1626
1627@option{cols} and @option{rows} specify that the console be sized to fit a text
1628console with the given dimensions.
1629
1630@item -chardev file ,id=@var{id} ,path=@var{path}
1631
1632Log all traffic received from the guest to a file.
1633
1634@option{path} specifies the path of the file to be opened. This file will be
1635created if it does not already exist, and overwritten if it does. @option{path}
1636is required.
1637
1638@item -chardev pipe ,id=@var{id} ,path=@var{path}
1639
1640Create a two-way connection to the guest. The behaviour differs slightly between
1641Windows hosts and other hosts:
1642
1643On Windows, a single duplex pipe will be created at
1644@file{\\.pipe\@option{path}}.
1645
1646On other hosts, 2 pipes will be created called @file{@option{path}.in} and
1647@file{@option{path}.out}. Data written to @file{@option{path}.in} will be
1648received by the guest. Data written by the guest can be read from
1649@file{@option{path}.out}. QEMU will not create these fifos, and requires them to
1650be present.
1651
1652@option{path} forms part of the pipe path as described above. @option{path} is
1653required.
1654
1655@item -chardev console ,id=@var{id}
1656
1657Send traffic from the guest to QEMU's standard output. @option{console} does not
1658take any options.
1659
1660@option{console} is only available on Windows hosts.
1661
1662@item -chardev serial ,id=@var{id} ,path=@option{path}
1663
1664Send traffic from the guest to a serial device on the host.
1665
1666@option{serial} is
1667only available on Windows hosts.
1668
1669@option{path} specifies the name of the serial device to open.
1670
1671@item -chardev pty ,id=@var{id}
1672
1673Create a new pseudo-terminal on the host and connect to it. @option{pty} does
1674not take any options.
1675
1676@option{pty} is not available on Windows hosts.
1677
Aurelien Jarnob7fdb3a2010-07-13 21:13:12 +02001678@item -chardev stdio ,id=@var{id} [,signal=on|off]
Matthew Booth7273a2d2009-10-30 13:41:12 +00001679Connect to standard input and standard output of the qemu process.
Aurelien Jarnob7fdb3a2010-07-13 21:13:12 +02001680
1681@option{signal} controls if signals are enabled on the terminal, that includes
1682exiting QEMU with the key sequence @key{Control-c}. This option is enabled by
1683default, use @option{signal=off} to disable it.
1684
1685@option{stdio} is not available on Windows hosts.
Matthew Booth7273a2d2009-10-30 13:41:12 +00001686
1687@item -chardev braille ,id=@var{id}
1688
1689Connect to a local BrlAPI server. @option{braille} does not take any options.
1690
1691@item -chardev tty ,id=@var{id} ,path=@var{path}
1692
1693Connect to a local tty device.
1694
1695@option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and
1696DragonFlyBSD hosts.
1697
1698@option{path} specifies the path to the tty. @option{path} is required.
1699
1700@item -chardev parport ,id=@var{id} ,path=@var{path}
1701
1702@option{parport} is only available on Linux, FreeBSD and DragonFlyBSD hosts.
1703
1704Connect to a local parallel port.
1705
1706@option{path} specifies the path to the parallel port device. @option{path} is
1707required.
1708
Alon Levycbcc6332011-01-19 10:49:50 +02001709@item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name}
1710
Stefan Hajnoczi3a846902011-10-06 11:24:12 +01001711@option{spicevmc} is only available when spice support is built in.
1712
Alon Levycbcc6332011-01-19 10:49:50 +02001713@option{debug} debug level for spicevmc
1714
1715@option{name} name of spice channel to connect to
1716
1717Connect to a spice virtual machine channel, such as vdiport.
Alon Levycbcc6332011-01-19 10:49:50 +02001718
Matthew Booth7273a2d2009-10-30 13:41:12 +00001719@end table
1720ETEXI
1721
1722DEFHEADING()
1723
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +11001724STEXI
1725DEFHEADING(Device URL Syntax:)
1726
1727In addition to using normal file images for the emulated storage devices,
1728QEMU can also use networked resources such as iSCSI devices. These are
1729specified using a special URL syntax.
1730
1731@table @option
1732@item iSCSI
1733iSCSI support allows QEMU to access iSCSI resources directly and use as
1734images for the guest storage. Both disk and cdrom images are supported.
1735
1736Syntax for specifying iSCSI LUNs is
1737``iscsi://<target-ip>[:<port>]/<target-iqn>/<lun>''
1738
1739Example (without authentication):
1740@example
1741qemu -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \
1742--drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1
1743@end example
1744
1745Example (CHAP username/password via URL):
1746@example
1747qemu --drive file=iscsi://user%password@@192.0.2.1/iqn.2001-04.com.example/1
1748@end example
1749
1750Example (CHAP username/password via environment variables):
1751@example
1752LIBISCSI_CHAP_USERNAME="user" \
1753LIBISCSI_CHAP_PASSWORD="password" \
1754qemu --drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1
1755@end example
1756
1757iSCSI support is an optional feature of QEMU and only available when
1758compiled and linked against libiscsi.
1759
Ronnie Sahlberg08ae3302011-10-27 20:33:21 +11001760@item NBD
1761QEMU supports NBD (Network Block Devices) both using TCP protocol as well
1762as Unix Domain Sockets.
1763
1764Syntax for specifying a NBD device using TCP
1765``nbd:<server-ip>:<port>[:exportname=<export>]''
1766
1767Syntax for specifying a NBD device using Unix Domain Sockets
1768``nbd:unix:<domain-socket>[:exportname=<export>]''
1769
1770
1771Example for TCP
1772@example
1773qemu --drive file=nbd:192.0.2.1:30000
1774@end example
1775
1776Example for Unix Domain Sockets
1777@example
1778qemu --drive file=nbd:unix:/tmp/nbd-socket
1779@end example
1780
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +11001781@end table
1782ETEXI
1783
Matthew Booth7273a2d2009-10-30 13:41:12 +00001784DEFHEADING(Bluetooth(R) options:)
1785
blueswir15824d652009-03-28 06:44:27 +00001786DEF("bt", HAS_ARG, QEMU_OPTION_bt, \
blueswir15824d652009-03-28 06:44:27 +00001787 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \
1788 "-bt hci,host[:id]\n" \
1789 " use host's HCI with the given name\n" \
1790 "-bt hci[,vlan=n]\n" \
1791 " emulate a standard HCI in virtual scatternet 'n'\n" \
1792 "-bt vhci[,vlan=n]\n" \
1793 " add host computer to virtual scatternet 'n' using VHCI\n" \
1794 "-bt device:dev[,vlan=n]\n" \
Blue Swirlad960902010-03-29 19:23:52 +00001795 " emulate a bluetooth device 'dev' in scatternet 'n'\n",
1796 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001797STEXI
blueswir15824d652009-03-28 06:44:27 +00001798@table @option
1799
1800@item -bt hci[...]
Stefan Weil6616b2a2010-02-05 23:52:05 +01001801@findex -bt
blueswir15824d652009-03-28 06:44:27 +00001802Defines the function of the corresponding Bluetooth HCI. -bt options
1803are matched with the HCIs present in the chosen machine type. For
1804example when emulating a machine with only one HCI built into it, only
1805the first @code{-bt hci[...]} option is valid and defines the HCI's
1806logic. The Transport Layer is decided by the machine type. Currently
1807the machines @code{n800} and @code{n810} have one HCI and all other
1808machines have none.
1809
1810@anchor{bt-hcis}
1811The following three types are recognized:
1812
Kevin Wolfb3f046c2009-10-09 10:58:35 +02001813@table @option
blueswir15824d652009-03-28 06:44:27 +00001814@item -bt hci,null
1815(default) The corresponding Bluetooth HCI assumes no internal logic
1816and will not respond to any HCI commands or emit events.
1817
1818@item -bt hci,host[:@var{id}]
1819(@code{bluez} only) The corresponding HCI passes commands / events
1820to / from the physical HCI identified by the name @var{id} (default:
1821@code{hci0}) on the computer running QEMU. Only available on @code{bluez}
1822capable systems like Linux.
1823
1824@item -bt hci[,vlan=@var{n}]
1825Add a virtual, standard HCI that will participate in the Bluetooth
1826scatternet @var{n} (default @code{0}). Similarly to @option{-net}
1827VLANs, devices inside a bluetooth network @var{n} can only communicate
1828with other devices in the same network (scatternet).
1829@end table
1830
1831@item -bt vhci[,vlan=@var{n}]
1832(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
1833to the host bluetooth stack instead of to the emulated target. This
1834allows the host and target machines to participate in a common scatternet
1835and communicate. Requires the Linux @code{vhci} driver installed. Can
1836be used as following:
1837
1838@example
1839qemu [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
1840@end example
1841
1842@item -bt device:@var{dev}[,vlan=@var{n}]
1843Emulate a bluetooth device @var{dev} and place it in network @var{n}
1844(default @code{0}). QEMU can only emulate one type of bluetooth devices
1845currently:
1846
Kevin Wolfb3f046c2009-10-09 10:58:35 +02001847@table @option
blueswir15824d652009-03-28 06:44:27 +00001848@item keyboard
1849Virtual wireless keyboard implementing the HIDP bluetooth profile.
1850@end table
1851@end table
1852ETEXI
1853
1854DEFHEADING()
1855
Alexander Graf7677f052009-06-28 16:55:55 +02001856DEFHEADING(Linux/Multiboot boot specific:)
blueswir15824d652009-03-28 06:44:27 +00001857STEXI
Alexander Graf7677f052009-06-28 16:55:55 +02001858
1859When using these options, you can use a given Linux or Multiboot
1860kernel without installing it in the disk image. It can be useful
blueswir15824d652009-03-28 06:44:27 +00001861for easier testing of various kernels.
1862
1863@table @option
1864ETEXI
1865
1866DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \
Blue Swirlad960902010-03-29 19:23:52 +00001867 "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001868STEXI
1869@item -kernel @var{bzImage}
Stefan Weil6616b2a2010-02-05 23:52:05 +01001870@findex -kernel
Alexander Graf7677f052009-06-28 16:55:55 +02001871Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel
1872or in multiboot format.
blueswir15824d652009-03-28 06:44:27 +00001873ETEXI
1874
1875DEF("append", HAS_ARG, QEMU_OPTION_append, \
Blue Swirlad960902010-03-29 19:23:52 +00001876 "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001877STEXI
1878@item -append @var{cmdline}
Stefan Weil6616b2a2010-02-05 23:52:05 +01001879@findex -append
blueswir15824d652009-03-28 06:44:27 +00001880Use @var{cmdline} as kernel command line
1881ETEXI
1882
1883DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \
Blue Swirlad960902010-03-29 19:23:52 +00001884 "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001885STEXI
1886@item -initrd @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01001887@findex -initrd
blueswir15824d652009-03-28 06:44:27 +00001888Use @var{file} as initial ram disk.
Alexander Graf7677f052009-06-28 16:55:55 +02001889
1890@item -initrd "@var{file1} arg=foo,@var{file2}"
1891
1892This syntax is only available with multiboot.
1893
1894Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the
1895first module.
blueswir15824d652009-03-28 06:44:27 +00001896ETEXI
1897
1898STEXI
1899@end table
1900ETEXI
1901
1902DEFHEADING()
1903
1904DEFHEADING(Debug/Expert options:)
1905
1906STEXI
1907@table @option
1908ETEXI
1909
1910DEF("serial", HAS_ARG, QEMU_OPTION_serial, \
Blue Swirlad960902010-03-29 19:23:52 +00001911 "-serial dev redirect the serial port to char device 'dev'\n",
1912 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001913STEXI
1914@item -serial @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01001915@findex -serial
blueswir15824d652009-03-28 06:44:27 +00001916Redirect the virtual serial port to host character device
1917@var{dev}. The default device is @code{vc} in graphical mode and
1918@code{stdio} in non graphical mode.
1919
1920This option can be used several times to simulate up to 4 serial
1921ports.
1922
1923Use @code{-serial none} to disable all serial ports.
1924
1925Available character devices are:
Kevin Wolfb3f046c2009-10-09 10:58:35 +02001926@table @option
Kevin Wolf4e257e52009-10-09 10:58:36 +02001927@item vc[:@var{W}x@var{H}]
blueswir15824d652009-03-28 06:44:27 +00001928Virtual console. Optionally, a width and height can be given in pixel with
1929@example
1930vc:800x600
1931@end example
1932It is also possible to specify width or height in characters:
1933@example
1934vc:80Cx24C
1935@end example
1936@item pty
1937[Linux only] Pseudo TTY (a new PTY is automatically allocated)
1938@item none
1939No device is allocated.
1940@item null
1941void device
1942@item /dev/XXX
1943[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
1944parameters are set according to the emulated ones.
1945@item /dev/parport@var{N}
1946[Linux only, parallel port only] Use host parallel port
1947@var{N}. Currently SPP and EPP parallel port features can be used.
1948@item file:@var{filename}
1949Write output to @var{filename}. No character can be read.
1950@item stdio
1951[Unix only] standard input/output
1952@item pipe:@var{filename}
1953name pipe @var{filename}
1954@item COM@var{n}
1955[Windows only] Use host serial port @var{n}
1956@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
1957This implements UDP Net Console.
1958When @var{remote_host} or @var{src_ip} are not specified
1959they default to @code{0.0.0.0}.
1960When not using a specified @var{src_port} a random port is automatically chosen.
blueswir15824d652009-03-28 06:44:27 +00001961
1962If you just want a simple readonly console you can use @code{netcat} or
1963@code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
1964@code{nc -u -l -p 4555}. Any time qemu writes something to that port it
1965will appear in the netconsole session.
1966
1967If you plan to send characters back via netconsole or you want to stop
1968and start qemu a lot of times, you should have qemu use the same
1969source port each time by using something like @code{-serial
1970udp::4555@@:4556} to qemu. Another approach is to use a patched
1971version of netcat which can listen to a TCP port and send and receive
1972characters via udp. If you have a patched version of netcat which
1973activates telnet remote echo and single char transfer, then you can
1974use the following options to step up a netcat redirector to allow
1975telnet on port 5555 to access the qemu port.
1976@table @code
1977@item Qemu Options:
1978-serial udp::4555@@:4556
1979@item netcat options:
1980-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
1981@item telnet options:
1982localhost 5555
1983@end table
1984
1985@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay]
1986The TCP Net Console has two modes of operation. It can send the serial
1987I/O to a location or wait for a connection from a location. By default
1988the TCP Net Console is sent to @var{host} at the @var{port}. If you use
1989the @var{server} option QEMU will wait for a client socket application
1990to connect to the port before continuing, unless the @code{nowait}
1991option was specified. The @code{nodelay} option disables the Nagle buffering
1992algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only
1993one TCP connection at a time is accepted. You can use @code{telnet} to
1994connect to the corresponding character device.
1995@table @code
1996@item Example to send tcp console to 192.168.0.2 port 4444
1997-serial tcp:192.168.0.2:4444
1998@item Example to listen and wait on port 4444 for connection
1999-serial tcp::4444,server
2000@item Example to not wait and listen on ip 192.168.0.100 port 4444
2001-serial tcp:192.168.0.100:4444,server,nowait
2002@end table
2003
2004@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
2005The telnet protocol is used instead of raw tcp sockets. The options
2006work the same as if you had specified @code{-serial tcp}. The
2007difference is that the port acts like a telnet server or client using
2008telnet option negotiation. This will also allow you to send the
2009MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
2010sequence. Typically in unix telnet you do it with Control-] and then
2011type "send break" followed by pressing the enter key.
2012
2013@item unix:@var{path}[,server][,nowait]
2014A unix domain socket is used instead of a tcp socket. The option works the
2015same as if you had specified @code{-serial tcp} except the unix domain socket
2016@var{path} is used for connections.
2017
2018@item mon:@var{dev_string}
2019This is a special option to allow the monitor to be multiplexed onto
2020another serial port. The monitor is accessed with key sequence of
2021@key{Control-a} and then pressing @key{c}. See monitor access
2022@ref{pcsys_keys} in the -nographic section for more keys.
2023@var{dev_string} should be any one of the serial devices specified
2024above. An example to multiplex the monitor onto a telnet server
2025listening on port 4444 would be:
2026@table @code
2027@item -serial mon:telnet::4444,server,nowait
2028@end table
2029
2030@item braille
2031Braille device. This will use BrlAPI to display the braille output on a real
2032or fake device.
2033
Kevin Wolfbe8b28a2009-10-09 10:58:37 +02002034@item msmouse
2035Three button serial mouse. Configure the guest to use Microsoft protocol.
blueswir15824d652009-03-28 06:44:27 +00002036@end table
2037ETEXI
2038
2039DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \
Blue Swirlad960902010-03-29 19:23:52 +00002040 "-parallel dev redirect the parallel port to char device 'dev'\n",
2041 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002042STEXI
2043@item -parallel @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002044@findex -parallel
blueswir15824d652009-03-28 06:44:27 +00002045Redirect the virtual parallel port to host device @var{dev} (same
2046devices as the serial port). On Linux hosts, @file{/dev/parportN} can
2047be used to use hardware devices connected on the corresponding host
2048parallel port.
2049
2050This option can be used several times to simulate up to 3 parallel
2051ports.
2052
2053Use @code{-parallel none} to disable all parallel ports.
2054ETEXI
2055
2056DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \
Blue Swirlad960902010-03-29 19:23:52 +00002057 "-monitor dev redirect the monitor to char device 'dev'\n",
2058 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002059STEXI
Gerd Hoffmann4e307fc2009-12-08 13:11:37 +01002060@item -monitor @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002061@findex -monitor
blueswir15824d652009-03-28 06:44:27 +00002062Redirect the monitor to host device @var{dev} (same devices as the
2063serial port).
2064The default device is @code{vc} in graphical mode and @code{stdio} in
2065non graphical mode.
2066ETEXI
Gerd Hoffmann6ca55822009-12-08 13:11:52 +01002067DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \
Blue Swirlad960902010-03-29 19:23:52 +00002068 "-qmp dev like -monitor but opens in 'control' mode\n",
2069 QEMU_ARCH_ALL)
Stefan Weil95d5f082010-01-20 22:25:27 +01002070STEXI
2071@item -qmp @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002072@findex -qmp
Stefan Weil95d5f082010-01-20 22:25:27 +01002073Like -monitor but opens in 'control' mode.
2074ETEXI
blueswir15824d652009-03-28 06:44:27 +00002075
Gerd Hoffmann22a0e042009-12-08 13:11:51 +01002076DEF("mon", HAS_ARG, QEMU_OPTION_mon, \
Blue Swirlad960902010-03-29 19:23:52 +00002077 "-mon chardev=[name][,mode=readline|control][,default]\n", QEMU_ARCH_ALL)
Gerd Hoffmann22a0e042009-12-08 13:11:51 +01002078STEXI
2079@item -mon chardev=[name][,mode=readline|control][,default]
Stefan Weil6616b2a2010-02-05 23:52:05 +01002080@findex -mon
Gerd Hoffmann22a0e042009-12-08 13:11:51 +01002081Setup monitor on chardev @var{name}.
2082ETEXI
2083
H. Peter Anvinc9f398e2009-12-29 13:51:36 -08002084DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \
Blue Swirlad960902010-03-29 19:23:52 +00002085 "-debugcon dev redirect the debug console to char device 'dev'\n",
2086 QEMU_ARCH_ALL)
H. Peter Anvinc9f398e2009-12-29 13:51:36 -08002087STEXI
2088@item -debugcon @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002089@findex -debugcon
H. Peter Anvinc9f398e2009-12-29 13:51:36 -08002090Redirect the debug console to host device @var{dev} (same devices as the
2091serial port). The debug console is an I/O port which is typically port
20920xe9; writing to that I/O port sends output to this device.
2093The default device is @code{vc} in graphical mode and @code{stdio} in
2094non graphical mode.
2095ETEXI
2096
blueswir15824d652009-03-28 06:44:27 +00002097DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \
Blue Swirlad960902010-03-29 19:23:52 +00002098 "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002099STEXI
2100@item -pidfile @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002101@findex -pidfile
blueswir15824d652009-03-28 06:44:27 +00002102Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
2103from a script.
2104ETEXI
2105
aurel321b530a62009-04-05 20:08:59 +00002106DEF("singlestep", 0, QEMU_OPTION_singlestep, \
Blue Swirlad960902010-03-29 19:23:52 +00002107 "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL)
aurel321b530a62009-04-05 20:08:59 +00002108STEXI
2109@item -singlestep
Stefan Weil6616b2a2010-02-05 23:52:05 +01002110@findex -singlestep
aurel321b530a62009-04-05 20:08:59 +00002111Run the emulation in single step mode.
2112ETEXI
2113
blueswir15824d652009-03-28 06:44:27 +00002114DEF("S", 0, QEMU_OPTION_S, \
Blue Swirlad960902010-03-29 19:23:52 +00002115 "-S freeze CPU at startup (use 'c' to start execution)\n",
2116 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002117STEXI
2118@item -S
Stefan Weil6616b2a2010-02-05 23:52:05 +01002119@findex -S
blueswir15824d652009-03-28 06:44:27 +00002120Do not start CPU at startup (you must type 'c' in the monitor).
2121ETEXI
2122
aliguori59030a82009-04-05 18:43:41 +00002123DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \
Blue Swirlad960902010-03-29 19:23:52 +00002124 "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002125STEXI
aliguori59030a82009-04-05 18:43:41 +00002126@item -gdb @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002127@findex -gdb
aliguori59030a82009-04-05 18:43:41 +00002128Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical
2129connections will likely be TCP-based, but also UDP, pseudo TTY, or even
2130stdio are reasonable use case. The latter is allowing to start qemu from
2131within gdb and establish the connection via a pipe:
2132@example
2133(gdb) target remote | exec qemu -gdb stdio ...
2134@end example
blueswir15824d652009-03-28 06:44:27 +00002135ETEXI
2136
aliguori59030a82009-04-05 18:43:41 +00002137DEF("s", 0, QEMU_OPTION_s, \
Blue Swirlad960902010-03-29 19:23:52 +00002138 "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n",
2139 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002140STEXI
aliguori59030a82009-04-05 18:43:41 +00002141@item -s
Stefan Weil6616b2a2010-02-05 23:52:05 +01002142@findex -s
aliguori59030a82009-04-05 18:43:41 +00002143Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
2144(@pxref{gdb_usage}).
blueswir15824d652009-03-28 06:44:27 +00002145ETEXI
2146
2147DEF("d", HAS_ARG, QEMU_OPTION_d, \
Blue Swirlad960902010-03-29 19:23:52 +00002148 "-d item1,... output log to /tmp/qemu.log (use -d ? for a list of log items)\n",
2149 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002150STEXI
2151@item -d
Stefan Weil6616b2a2010-02-05 23:52:05 +01002152@findex -d
blueswir15824d652009-03-28 06:44:27 +00002153Output log in /tmp/qemu.log
2154ETEXI
2155
Matthew Fernandezc235d732011-06-07 16:32:40 +00002156DEF("D", HAS_ARG, QEMU_OPTION_D, \
2157 "-D logfile output log to logfile (instead of the default /tmp/qemu.log)\n",
2158 QEMU_ARCH_ALL)
2159STEXI
2160@item -D
2161@findex -D
2162Output log in logfile instead of /tmp/qemu.log
2163ETEXI
2164
blueswir15824d652009-03-28 06:44:27 +00002165DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \
2166 "-hdachs c,h,s[,t]\n" \
2167 " force hard disk 0 physical geometry and the optional BIOS\n" \
Blue Swirlad960902010-03-29 19:23:52 +00002168 " translation (t=none or lba) (usually qemu can guess them)\n",
2169 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002170STEXI
2171@item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
Stefan Weil6616b2a2010-02-05 23:52:05 +01002172@findex -hdachs
blueswir15824d652009-03-28 06:44:27 +00002173Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
2174@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
2175translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
2176all those parameters. This option is useful for old MS-DOS disk
2177images.
2178ETEXI
2179
2180DEF("L", HAS_ARG, QEMU_OPTION_L, \
Blue Swirlad960902010-03-29 19:23:52 +00002181 "-L path set the directory for the BIOS, VGA BIOS and keymaps\n",
2182 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002183STEXI
2184@item -L @var{path}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002185@findex -L
blueswir15824d652009-03-28 06:44:27 +00002186Set the directory for the BIOS, VGA BIOS and keymaps.
2187ETEXI
2188
2189DEF("bios", HAS_ARG, QEMU_OPTION_bios, \
Blue Swirlad960902010-03-29 19:23:52 +00002190 "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002191STEXI
2192@item -bios @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002193@findex -bios
blueswir15824d652009-03-28 06:44:27 +00002194Set the filename for the BIOS.
2195ETEXI
2196
blueswir15824d652009-03-28 06:44:27 +00002197DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \
Blue Swirlad960902010-03-29 19:23:52 +00002198 "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002199STEXI
2200@item -enable-kvm
Stefan Weil6616b2a2010-02-05 23:52:05 +01002201@findex -enable-kvm
blueswir15824d652009-03-28 06:44:27 +00002202Enable KVM full virtualization support. This option is only available
2203if KVM support is enabled when compiling.
2204ETEXI
2205
aliguorie37630c2009-04-22 15:19:10 +00002206DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid,
Blue Swirlad960902010-03-29 19:23:52 +00002207 "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL)
aliguorie37630c2009-04-22 15:19:10 +00002208DEF("xen-create", 0, QEMU_OPTION_xen_create,
2209 "-xen-create create domain using xen hypercalls, bypassing xend\n"
Blue Swirlad960902010-03-29 19:23:52 +00002210 " warning: should not be used when xend is in use\n",
2211 QEMU_ARCH_ALL)
aliguorie37630c2009-04-22 15:19:10 +00002212DEF("xen-attach", 0, QEMU_OPTION_xen_attach,
2213 "-xen-attach attach to existing xen domain\n"
Blue Swirlad960902010-03-29 19:23:52 +00002214 " xend will use this when starting qemu\n",
2215 QEMU_ARCH_ALL)
Stefan Weil95d5f082010-01-20 22:25:27 +01002216STEXI
2217@item -xen-domid @var{id}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002218@findex -xen-domid
Stefan Weil95d5f082010-01-20 22:25:27 +01002219Specify xen guest domain @var{id} (XEN only).
2220@item -xen-create
Stefan Weil6616b2a2010-02-05 23:52:05 +01002221@findex -xen-create
Stefan Weil95d5f082010-01-20 22:25:27 +01002222Create domain using xen hypercalls, bypassing xend.
2223Warning: should not be used when xend is in use (XEN only).
2224@item -xen-attach
Stefan Weil6616b2a2010-02-05 23:52:05 +01002225@findex -xen-attach
Stefan Weil95d5f082010-01-20 22:25:27 +01002226Attach to existing xen domain.
2227xend will use this when starting qemu (XEN only).
2228ETEXI
aliguorie37630c2009-04-22 15:19:10 +00002229
blueswir15824d652009-03-28 06:44:27 +00002230DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \
Blue Swirlad960902010-03-29 19:23:52 +00002231 "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002232STEXI
2233@item -no-reboot
Stefan Weil6616b2a2010-02-05 23:52:05 +01002234@findex -no-reboot
blueswir15824d652009-03-28 06:44:27 +00002235Exit instead of rebooting.
2236ETEXI
2237
2238DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \
Blue Swirlad960902010-03-29 19:23:52 +00002239 "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002240STEXI
2241@item -no-shutdown
Stefan Weil6616b2a2010-02-05 23:52:05 +01002242@findex -no-shutdown
blueswir15824d652009-03-28 06:44:27 +00002243Don't exit QEMU on guest shutdown, but instead only stop the emulation.
2244This allows for instance switching to monitor to commit changes to the
2245disk image.
2246ETEXI
2247
2248DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \
2249 "-loadvm [tag|id]\n" \
Blue Swirlad960902010-03-29 19:23:52 +00002250 " start right away with a saved state (loadvm in monitor)\n",
2251 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002252STEXI
2253@item -loadvm @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002254@findex -loadvm
blueswir15824d652009-03-28 06:44:27 +00002255Start right away with a saved state (@code{loadvm} in monitor)
2256ETEXI
2257
2258#ifndef _WIN32
2259DEF("daemonize", 0, QEMU_OPTION_daemonize, \
Blue Swirlad960902010-03-29 19:23:52 +00002260 "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002261#endif
2262STEXI
2263@item -daemonize
Stefan Weil6616b2a2010-02-05 23:52:05 +01002264@findex -daemonize
blueswir15824d652009-03-28 06:44:27 +00002265Daemonize the QEMU process after initialization. QEMU will not detach from
2266standard IO until it is ready to receive connections on any of its devices.
2267This option is a useful way for external programs to launch QEMU without having
2268to cope with initialization race conditions.
2269ETEXI
2270
2271DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \
Blue Swirlad960902010-03-29 19:23:52 +00002272 "-option-rom rom load a file, rom, into the option ROM space\n",
2273 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002274STEXI
2275@item -option-rom @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002276@findex -option-rom
blueswir15824d652009-03-28 06:44:27 +00002277Load the contents of @var{file} as an option ROM.
2278This option is useful to load things like EtherBoot.
2279ETEXI
2280
2281DEF("clock", HAS_ARG, QEMU_OPTION_clock, \
2282 "-clock force the use of the given methods for timer alarm.\n" \
Blue Swirlad960902010-03-29 19:23:52 +00002283 " To see what timers are available use -clock ?\n",
2284 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002285STEXI
2286@item -clock @var{method}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002287@findex -clock
blueswir15824d652009-03-28 06:44:27 +00002288Force the use of the given methods for timer alarm. To see what timers
2289are available use -clock ?.
2290ETEXI
2291
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02002292HXCOMM Options deprecated by -rtc
Blue Swirlad960902010-03-29 19:23:52 +00002293DEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL)
2294DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002295
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02002296DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \
Jan Kiszka68752042009-09-15 13:36:04 +02002297 "-rtc [base=utc|localtime|date][,clock=host|vm][,driftfix=none|slew]\n" \
Blue Swirlad960902010-03-29 19:23:52 +00002298 " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n",
2299 QEMU_ARCH_ALL)
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02002300
blueswir15824d652009-03-28 06:44:27 +00002301STEXI
2302
Jan Kiszka68752042009-09-15 13:36:04 +02002303@item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew]
Stefan Weil6616b2a2010-02-05 23:52:05 +01002304@findex -rtc
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02002305Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current
2306UTC or local time, respectively. @code{localtime} is required for correct date in
2307MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the
2308format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC.
2309
Jan Kiszka68752042009-09-15 13:36:04 +02002310By default the RTC is driven by the host system time. This allows to use the
2311RTC as accurate reference clock inside the guest, specifically if the host
2312time is smoothly following an accurate external reference clock, e.g. via NTP.
2313If you want to isolate the guest time from the host, even prevent it from
2314progressing during suspension, you can set @option{clock} to @code{vm} instead.
2315
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02002316Enable @option{driftfix} (i386 targets only) if you experience time drift problems,
2317specifically with Windows' ACPI HAL. This option will try to figure out how
2318many timer interrupts were not processed by the Windows guest and will
2319re-inject them.
blueswir15824d652009-03-28 06:44:27 +00002320ETEXI
2321
2322DEF("icount", HAS_ARG, QEMU_OPTION_icount, \
2323 "-icount [N|auto]\n" \
aliguoribc14ca22009-04-05 18:43:37 +00002324 " enable virtual instruction counter with 2^N clock ticks per\n" \
Blue Swirlad960902010-03-29 19:23:52 +00002325 " instruction\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002326STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +02002327@item -icount [@var{N}|auto]
Stefan Weil6616b2a2010-02-05 23:52:05 +01002328@findex -icount
blueswir15824d652009-03-28 06:44:27 +00002329Enable virtual instruction counter. The virtual cpu will execute one
Kevin Wolf4e257e52009-10-09 10:58:36 +02002330instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified
blueswir15824d652009-03-28 06:44:27 +00002331then the virtual cpu speed will be automatically adjusted to keep virtual
2332time within a few seconds of real time.
2333
2334Note that while this option can give deterministic behavior, it does not
2335provide cycle accurate emulation. Modern CPUs contain superscalar out of
2336order cores with complex cache hierarchies. The number of instructions
2337executed often has little or no correlation with actual performance.
2338ETEXI
2339
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01002340DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \
2341 "-watchdog i6300esb|ib700\n" \
Blue Swirlad960902010-03-29 19:23:52 +00002342 " enable virtual hardware watchdog [default=none]\n",
2343 QEMU_ARCH_ALL)
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01002344STEXI
2345@item -watchdog @var{model}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002346@findex -watchdog
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01002347Create a virtual hardware watchdog device. Once enabled (by a guest
2348action), the watchdog must be periodically polled by an agent inside
2349the guest or else the guest will be restarted.
2350
2351The @var{model} is the model of hardware watchdog to emulate. Choices
2352for model are: @code{ib700} (iBASE 700) which is a very simple ISA
2353watchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O
2354controller hub) which is a much more featureful PCI-based dual-timer
2355watchdog. Choose a model for which your guest has drivers.
2356
2357Use @code{-watchdog ?} to list available hardware models. Only one
2358watchdog can be enabled for a guest.
2359ETEXI
2360
2361DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \
2362 "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \
Blue Swirlad960902010-03-29 19:23:52 +00002363 " action when watchdog fires [default=reset]\n",
2364 QEMU_ARCH_ALL)
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01002365STEXI
2366@item -watchdog-action @var{action}
2367
2368The @var{action} controls what QEMU will do when the watchdog timer
2369expires.
2370The default is
2371@code{reset} (forcefully reset the guest).
2372Other possible actions are:
2373@code{shutdown} (attempt to gracefully shutdown the guest),
2374@code{poweroff} (forcefully poweroff the guest),
2375@code{pause} (pause the guest),
2376@code{debug} (print a debug message and continue), or
2377@code{none} (do nothing).
2378
2379Note that the @code{shutdown} action requires that the guest responds
2380to ACPI signals, which it may not be able to do in the sort of
2381situations where the watchdog would have expired, and thus
2382@code{-watchdog-action shutdown} is not recommended for production use.
2383
2384Examples:
2385
2386@table @code
2387@item -watchdog i6300esb -watchdog-action pause
2388@item -watchdog ib700
2389@end table
2390ETEXI
2391
blueswir15824d652009-03-28 06:44:27 +00002392DEF("echr", HAS_ARG, QEMU_OPTION_echr, \
Blue Swirlad960902010-03-29 19:23:52 +00002393 "-echr chr set terminal escape character instead of ctrl-a\n",
2394 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002395STEXI
2396
Kevin Wolf4e257e52009-10-09 10:58:36 +02002397@item -echr @var{numeric_ascii_value}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002398@findex -echr
blueswir15824d652009-03-28 06:44:27 +00002399Change the escape character used for switching to the monitor when using
2400monitor and serial sharing. The default is @code{0x01} when using the
2401@code{-nographic} option. @code{0x01} is equal to pressing
2402@code{Control-a}. You can select a different character from the ascii
2403control keys where 1 through 26 map to Control-a through Control-z. For
2404instance you could use the either of the following to change the escape
2405character to Control-t.
2406@table @code
2407@item -echr 0x14
2408@item -echr 20
2409@end table
2410ETEXI
2411
2412DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \
2413 "-virtioconsole c\n" \
Blue Swirlad960902010-03-29 19:23:52 +00002414 " set virtio console\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002415STEXI
2416@item -virtioconsole @var{c}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002417@findex -virtioconsole
blueswir15824d652009-03-28 06:44:27 +00002418Set virtio console.
Amit Shah98b19252010-01-20 00:36:52 +05302419
2420This option is maintained for backward compatibility.
2421
2422Please use @code{-device virtconsole} for the new way of invocation.
blueswir15824d652009-03-28 06:44:27 +00002423ETEXI
2424
2425DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \
Blue Swirlad960902010-03-29 19:23:52 +00002426 "-show-cursor show cursor\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002427STEXI
Stefan Weil95d5f082010-01-20 22:25:27 +01002428@item -show-cursor
Stefan Weil6616b2a2010-02-05 23:52:05 +01002429@findex -show-cursor
Stefan Weil95d5f082010-01-20 22:25:27 +01002430Show cursor.
blueswir15824d652009-03-28 06:44:27 +00002431ETEXI
2432
2433DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \
Blue Swirlad960902010-03-29 19:23:52 +00002434 "-tb-size n set TB size\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002435STEXI
Stefan Weil95d5f082010-01-20 22:25:27 +01002436@item -tb-size @var{n}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002437@findex -tb-size
Stefan Weil95d5f082010-01-20 22:25:27 +01002438Set TB size.
blueswir15824d652009-03-28 06:44:27 +00002439ETEXI
2440
2441DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \
Blue Swirlad960902010-03-29 19:23:52 +00002442 "-incoming p prepare for incoming migration, listen on port p\n",
2443 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002444STEXI
Stefan Weil95d5f082010-01-20 22:25:27 +01002445@item -incoming @var{port}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002446@findex -incoming
Stefan Weil95d5f082010-01-20 22:25:27 +01002447Prepare for incoming migration, listen on @var{port}.
blueswir15824d652009-03-28 06:44:27 +00002448ETEXI
2449
Gerd Hoffmannd8c208d2009-12-08 13:11:46 +01002450DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \
Blue Swirlad960902010-03-29 19:23:52 +00002451 "-nodefaults don't create default devices\n", QEMU_ARCH_ALL)
Gerd Hoffmannd8c208d2009-12-08 13:11:46 +01002452STEXI
Stefan Weil3dbf2c72010-01-16 18:19:44 +01002453@item -nodefaults
Stefan Weil6616b2a2010-02-05 23:52:05 +01002454@findex -nodefaults
Stefan Weil3dbf2c72010-01-16 18:19:44 +01002455Don't create default devices.
Gerd Hoffmannd8c208d2009-12-08 13:11:46 +01002456ETEXI
2457
blueswir15824d652009-03-28 06:44:27 +00002458#ifndef _WIN32
2459DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \
Blue Swirlad960902010-03-29 19:23:52 +00002460 "-chroot dir chroot to dir just before starting the VM\n",
2461 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002462#endif
2463STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +02002464@item -chroot @var{dir}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002465@findex -chroot
blueswir15824d652009-03-28 06:44:27 +00002466Immediately before starting guest execution, chroot to the specified
2467directory. Especially useful in combination with -runas.
2468ETEXI
2469
2470#ifndef _WIN32
2471DEF("runas", HAS_ARG, QEMU_OPTION_runas, \
Blue Swirlad960902010-03-29 19:23:52 +00002472 "-runas user change to user id user just before starting the VM\n",
2473 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002474#endif
2475STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +02002476@item -runas @var{user}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002477@findex -runas
blueswir15824d652009-03-28 06:44:27 +00002478Immediately before starting guest execution, drop root privileges, switching
2479to the specified user.
2480ETEXI
2481
blueswir15824d652009-03-28 06:44:27 +00002482DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env,
2483 "-prom-env variable=value\n"
Blue Swirlad960902010-03-29 19:23:52 +00002484 " set OpenBIOS nvram variables\n",
2485 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
Stefan Weil95d5f082010-01-20 22:25:27 +01002486STEXI
2487@item -prom-env @var{variable}=@var{value}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002488@findex -prom-env
Stefan Weil95d5f082010-01-20 22:25:27 +01002489Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only).
2490ETEXI
blueswir15824d652009-03-28 06:44:27 +00002491DEF("semihosting", 0, QEMU_OPTION_semihosting,
Max Filippov1ddeaa52011-09-06 03:55:47 +04002492 "-semihosting semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA)
Stefan Weil95d5f082010-01-20 22:25:27 +01002493STEXI
2494@item -semihosting
Stefan Weil6616b2a2010-02-05 23:52:05 +01002495@findex -semihosting
Max Filippov1ddeaa52011-09-06 03:55:47 +04002496Semihosting mode (ARM, M68K, Xtensa only).
Stefan Weil95d5f082010-01-20 22:25:27 +01002497ETEXI
blueswir15824d652009-03-28 06:44:27 +00002498DEF("old-param", 0, QEMU_OPTION_old_param,
Blue Swirlad960902010-03-29 19:23:52 +00002499 "-old-param old param mode\n", QEMU_ARCH_ARM)
Stefan Weil95d5f082010-01-20 22:25:27 +01002500STEXI
2501@item -old-param
Stefan Weil6616b2a2010-02-05 23:52:05 +01002502@findex -old-param (ARM)
Stefan Weil95d5f082010-01-20 22:25:27 +01002503Old param mode (ARM only).
2504ETEXI
2505
Gerd Hoffmann715a6642009-10-14 10:39:28 +02002506DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig,
Blue Swirlad960902010-03-29 19:23:52 +00002507 "-readconfig <file>\n", QEMU_ARCH_ALL)
Stefan Weil3dbf2c72010-01-16 18:19:44 +01002508STEXI
2509@item -readconfig @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002510@findex -readconfig
Stefan Weil3dbf2c72010-01-16 18:19:44 +01002511Read device configuration from @var{file}.
2512ETEXI
Gerd Hoffmann715a6642009-10-14 10:39:28 +02002513DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig,
2514 "-writeconfig <file>\n"
Blue Swirlad960902010-03-29 19:23:52 +00002515 " read/write config file\n", QEMU_ARCH_ALL)
Stefan Weil3dbf2c72010-01-16 18:19:44 +01002516STEXI
2517@item -writeconfig @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002518@findex -writeconfig
Stefan Weil3dbf2c72010-01-16 18:19:44 +01002519Write device configuration to @var{file}.
2520ETEXI
Anthony Liguori292444c2010-01-21 10:57:58 -06002521DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig,
2522 "-nodefconfig\n"
Blue Swirlad960902010-03-29 19:23:52 +00002523 " do not load default config files at startup\n",
2524 QEMU_ARCH_ALL)
Anthony Liguori292444c2010-01-21 10:57:58 -06002525STEXI
2526@item -nodefconfig
Stefan Weil6616b2a2010-02-05 23:52:05 +01002527@findex -nodefconfig
Anthony Liguori292444c2010-01-21 10:57:58 -06002528Normally QEMU loads a configuration file from @var{sysconfdir}/qemu.conf and
2529@var{sysconfdir}/target-@var{ARCH}.conf on startup. The @code{-nodefconfig}
2530option will prevent QEMU from loading these configuration files at startup.
2531ETEXI
Prerna Saxenaab6540d2010-08-09 11:48:32 +01002532DEF("trace", HAS_ARG, QEMU_OPTION_trace,
Lluís23d15e82011-08-31 20:31:31 +02002533 "-trace [events=<file>][,file=<file>]\n"
2534 " specify tracing options\n",
Prerna Saxenaab6540d2010-08-09 11:48:32 +01002535 QEMU_ARCH_ALL)
2536STEXI
Lluís23d15e82011-08-31 20:31:31 +02002537HXCOMM This line is not accurate, as some sub-options are backend-specific but
2538HXCOMM HX does not support conditional compilation of text.
2539@item -trace [events=@var{file}][,file=@var{file}]
Prerna Saxenaab6540d2010-08-09 11:48:32 +01002540@findex -trace
Lluíse4858972011-08-31 20:31:03 +02002541
Lluís23d15e82011-08-31 20:31:31 +02002542Specify tracing options.
2543
2544@table @option
2545@item events=@var{file}
2546Immediately enable events listed in @var{file}.
2547The file must contain one event name (as listed in the @var{trace-events} file)
2548per line.
Stefan Weilc1ba4e02011-09-05 18:13:03 +02002549This option is only available if QEMU has been compiled with
2550either @var{simple} or @var{stderr} tracing backend.
Lluís23d15e82011-08-31 20:31:31 +02002551@item file=@var{file}
2552Log output traces to @var{file}.
2553
Stefan Weilc1ba4e02011-09-05 18:13:03 +02002554This option is only available if QEMU has been compiled with
2555the @var{simple} tracing backend.
Lluís23d15e82011-08-31 20:31:31 +02002556@end table
Prerna Saxenaab6540d2010-08-09 11:48:32 +01002557ETEXI
Stefan Weil3dbf2c72010-01-16 18:19:44 +01002558
2559HXCOMM This is the last statement. Insert new options before this line!
2560STEXI
2561@end table
2562ETEXI