blob: 7cd6002d954700512a39bbc76e471188f908585f [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"
Peter Maydell585f6032012-10-04 16:22:01 +010032 " selects emulated machine ('-machine help' for list)\n"
Jan Kiszka80f52a62011-07-23 12:39:46 +020033 " property accel=accel1[:accel2[:...]] selects accelerator\n"
Jan Kiszka6a48ffa2011-10-15 13:43:48 +020034 " supported accelerators are kvm, xen, tcg (default: tcg)\n"
Jan Kiszka39d69602012-01-25 18:14:15 +010035 " kernel_irqchip=on|off controls accelerated irqchip support\n"
Jason Baronddb97f12012-08-02 15:44:16 -040036 " kvm_shadow_mem=size of KVM shadow MMU\n"
Luiz Capitulino8490fc72012-09-05 16:50:16 -030037 " dump-guest-core=on|off include guest memory in a core dump (default=on)\n"
38 " mem-merge=on|off controls memory merge support (default: on)\n",
Jan Kiszka80f52a62011-07-23 12:39:46 +020039 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +000040STEXI
Jan Kiszka80f52a62011-07-23 12:39:46 +020041@item -machine [type=]@var{name}[,prop=@var{value}[,...]]
42@findex -machine
Peter Maydell585f6032012-10-04 16:22:01 +010043Select the emulated machine by @var{name}. Use @code{-machine help} to list
Jan Kiszka80f52a62011-07-23 12:39:46 +020044available machines. Supported machine properties are:
45@table @option
46@item accel=@var{accels1}[:@var{accels2}[:...]]
47This is used to enable an accelerator. Depending on the target architecture,
48kvm, xen, or tcg can be available. By default, tcg is used. If there is more
49than one accelerator specified, the next one is used if the previous one fails
50to initialize.
Jan Kiszka6a48ffa2011-10-15 13:43:48 +020051@item kernel_irqchip=on|off
52Enables in-kernel irqchip support for the chosen accelerator when available.
Jan Kiszka39d69602012-01-25 18:14:15 +010053@item kvm_shadow_mem=size
54Defines the size of the KVM shadow MMU.
Jason Baronddb97f12012-08-02 15:44:16 -040055@item dump-guest-core=on|off
56Include guest memory in a core dump. The default is on.
Luiz Capitulino8490fc72012-09-05 16:50:16 -030057@item mem-merge=on|off
58Enables or disables memory merge support. This feature, when supported by
59the host, de-duplicates identical memory pages among VMs instances
60(enabled by default).
Jan Kiszka80f52a62011-07-23 12:39:46 +020061@end table
blueswir15824d652009-03-28 06:44:27 +000062ETEXI
63
Jan Kiszka80f52a62011-07-23 12:39:46 +020064HXCOMM Deprecated by -machine
65DEF("M", HAS_ARG, QEMU_OPTION_M, "", QEMU_ARCH_ALL)
66
blueswir15824d652009-03-28 06:44:27 +000067DEF("cpu", HAS_ARG, QEMU_OPTION_cpu,
Peter Maydell585f6032012-10-04 16:22:01 +010068 "-cpu cpu select CPU ('-cpu help' for list)\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +000069STEXI
70@item -cpu @var{model}
Stefan Weil6616b2a2010-02-05 23:52:05 +010071@findex -cpu
Peter Maydell585f6032012-10-04 16:22:01 +010072Select CPU model (@code{-cpu help} for list and additional feature selection)
blueswir15824d652009-03-28 06:44:27 +000073ETEXI
74
75DEF("smp", HAS_ARG, QEMU_OPTION_smp,
Andre Przywara58a04db2009-08-28 10:49:57 +020076 "-smp n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n"
Jes Sorensen6be68d72009-07-23 17:03:42 +020077 " set the number of CPUs to 'n' [default=1]\n"
78 " maxcpus= maximum number of total cpus, including\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -070079 " offline CPUs for hotplug, etc\n"
Andre Przywara58a04db2009-08-28 10:49:57 +020080 " cores= number of CPU cores on one socket\n"
81 " threads= number of threads on one CPU core\n"
Blue Swirlad960902010-03-29 19:23:52 +000082 " sockets= number of discrete sockets in the system\n",
83 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +000084STEXI
Andre Przywara58a04db2009-08-28 10:49:57 +020085@item -smp @var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}]
Stefan Weil6616b2a2010-02-05 23:52:05 +010086@findex -smp
blueswir15824d652009-03-28 06:44:27 +000087Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
88CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs
89to 4.
Andre Przywara58a04db2009-08-28 10:49:57 +020090For the PC target, the number of @var{cores} per socket, the number
91of @var{threads} per cores and the total number of @var{sockets} can be
92specified. Missing values will be computed. If any on the three values is
93given, the total number of CPUs @var{n} can be omitted. @var{maxcpus}
94specifies the maximum number of hotpluggable CPUs.
blueswir15824d652009-03-28 06:44:27 +000095ETEXI
96
aliguori268a3622009-04-21 22:30:27 +000097DEF("numa", HAS_ARG, QEMU_OPTION_numa,
Blue Swirlad960902010-03-29 19:23:52 +000098 "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL)
aliguori268a3622009-04-21 22:30:27 +000099STEXI
100@item -numa @var{opts}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100101@findex -numa
aliguori268a3622009-04-21 22:30:27 +0000102Simulate a multi node NUMA system. If mem and cpus are omitted, resources
103are split equally.
104ETEXI
105
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100106DEF("add-fd", HAS_ARG, QEMU_OPTION_add_fd,
107 "-add-fd fd=fd,set=set[,opaque=opaque]\n"
108 " Add 'fd' to fd 'set'\n", QEMU_ARCH_ALL)
109STEXI
110@item -add-fd fd=@var{fd},set=@var{set}[,opaque=@var{opaque}]
111@findex -add-fd
112
113Add a file descriptor to an fd set. Valid options are:
114
115@table @option
116@item fd=@var{fd}
117This option defines the file descriptor of which a duplicate is added to fd set.
118The file descriptor cannot be stdin, stdout, or stderr.
119@item set=@var{set}
120This option defines the ID of the fd set to add the file descriptor to.
121@item opaque=@var{opaque}
122This option defines a free-form string that can be used to describe @var{fd}.
123@end table
124
125You can open an image using pre-opened file descriptors from an fd set:
126@example
127qemu-system-i386
128-add-fd fd=3,set=2,opaque="rdwr:/path/to/file"
129-add-fd fd=4,set=2,opaque="rdonly:/path/to/file"
130-drive file=/dev/fdset/2,index=0,media=disk
131@end example
132ETEXI
133
134DEF("set", HAS_ARG, QEMU_OPTION_set,
135 "-set group.id.arg=value\n"
136 " set <arg> parameter for item <id> of type <group>\n"
137 " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL)
138STEXI
139@item -set @var{group}.@var{id}.@var{arg}=@var{value}
140@findex -set
141Set parameter @var{arg} for item @var{id} of type @var{group}\n"
142ETEXI
143
144DEF("global", HAS_ARG, QEMU_OPTION_global,
145 "-global driver.prop=value\n"
146 " set a global default for a driver property\n",
147 QEMU_ARCH_ALL)
148STEXI
149@item -global @var{driver}.@var{prop}=@var{value}
150@findex -global
151Set default value of @var{driver}'s property @var{prop} to @var{value}, e.g.:
152
153@example
154qemu-system-i386 -global ide-drive.physical_block_size=4096 -drive file=file,if=ide,index=0,media=disk
155@end example
156
157In particular, you can use this to set driver properties for devices which are
158created automatically by the machine model. To create a device which is not
159created automatically and set properties on it, use -@option{device}.
160ETEXI
161
162DEF("boot", HAS_ARG, QEMU_OPTION_boot,
163 "-boot [order=drives][,once=drives][,menu=on|off]\n"
Amos Kongc8a6ae82013-03-19 14:23:27 +0800164 " [,splash=sp_name][,splash-time=sp_time][,reboot-timeout=rb_time][,strict=on|off]\n"
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100165 " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n"
166 " 'sp_name': the file's name that would be passed to bios as logo picture, if menu=on\n"
167 " 'sp_time': the period that splash picture last if menu=on, unit is ms\n"
168 " 'rb_timeout': the timeout before guest reboot when boot failed, unit is ms\n",
169 QEMU_ARCH_ALL)
170STEXI
Amos Kongc8a6ae82013-03-19 14:23:27 +0800171@item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off][,splash=@var{sp_name}][,splash-time=@var{sp_time}][,reboot-timeout=@var{rb_timeout}][,strict=on|off]
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100172@findex -boot
173Specify boot order @var{drives} as a string of drive letters. Valid
174drive letters depend on the target achitecture. The x86 PC uses: a, b
175(floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot
176from network adapter 1-4), hard disk boot is the default. To apply a
177particular boot order only on the first startup, specify it via
178@option{once}.
179
180Interactive boot menus/prompts can be enabled via @option{menu=on} as far
181as firmware/BIOS supports them. The default is non-interactive boot.
182
183A splash picture could be passed to bios, enabling user to show it as logo,
184when option splash=@var{sp_name} is given and menu=on, If firmware/BIOS
185supports them. Currently Seabios for X86 system support it.
186limitation: The splash file could be a jpeg file or a BMP file in 24 BPP
187format(true color). The resolution should be supported by the SVGA mode, so
188the recommended is 320x240, 640x480, 800x640.
189
190A timeout could be passed to bios, guest will pause for @var{rb_timeout} ms
191when boot failed, then reboot. If @var{rb_timeout} is '-1', guest will not
192reboot, qemu passes '-1' to bios by default. Currently Seabios for X86
193system support it.
194
Amos Kongc8a6ae82013-03-19 14:23:27 +0800195Do strict boot via @option{strict=on} as far as firmware/BIOS
196supports it. This only effects when boot priority is changed by
197bootindex options. The default is non-strict boot.
198
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100199@example
200# try to boot from network first, then from hard disk
201qemu-system-i386 -boot order=nc
202# boot from CD-ROM first, switch back to default order after reboot
203qemu-system-i386 -boot once=d
204# boot with a splash picture for 5 seconds.
205qemu-system-i386 -boot menu=on,splash=/root/boot.bmp,splash-time=5000
206@end example
207
208Note: The legacy format '-boot @var{drives}' is still supported but its
209use is discouraged as it may be removed from future versions.
210ETEXI
211
212DEF("m", HAS_ARG, QEMU_OPTION_m,
213 "-m megs set virtual RAM size to megs MB [default="
214 stringify(DEFAULT_RAM_SIZE) "]\n", QEMU_ARCH_ALL)
215STEXI
216@item -m @var{megs}
217@findex -m
218Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally,
219a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
220gigabytes respectively.
221ETEXI
222
223DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath,
224 "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL)
225STEXI
226@item -mem-path @var{path}
227@findex -mem-path
228Allocate guest RAM from a temporarily created file in @var{path}.
229ETEXI
230
231#ifdef MAP_POPULATE
232DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc,
233 "-mem-prealloc preallocate guest memory (use with -mem-path)\n",
234 QEMU_ARCH_ALL)
235STEXI
236@item -mem-prealloc
237@findex -mem-prealloc
238Preallocate memory when using -mem-path.
239ETEXI
240#endif
241
242DEF("k", HAS_ARG, QEMU_OPTION_k,
243 "-k language use keyboard layout (for example 'fr' for French)\n",
244 QEMU_ARCH_ALL)
245STEXI
246@item -k @var{language}
247@findex -k
248Use keyboard layout @var{language} (for example @code{fr} for
249French). This option is only needed where it is not easy to get raw PC
250keycodes (e.g. on Macs, with some X11 servers or with a VNC
251display). You don't normally need to use it on PC/Linux or PC/Windows
252hosts.
253
254The available layouts are:
255@example
256ar de-ch es fo fr-ca hu ja mk no pt-br sv
257da en-gb et fr fr-ch is lt nl pl ru th
258de en-us fi fr-be hr it lv nl-be pt sl tr
259@end example
260
261The default is @code{en-us}.
262ETEXI
263
264
265DEF("audio-help", 0, QEMU_OPTION_audio_help,
266 "-audio-help print list of audio drivers and their options\n",
267 QEMU_ARCH_ALL)
268STEXI
269@item -audio-help
270@findex -audio-help
271Will show the audio subsystem help: list of drivers, tunable
272parameters.
273ETEXI
274
275DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw,
276 "-soundhw c1,... enable audio support\n"
277 " and only specified sound cards (comma separated list)\n"
278 " use '-soundhw help' to get the list of supported cards\n"
279 " use '-soundhw all' to enable all of them\n", QEMU_ARCH_ALL)
280STEXI
281@item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
282@findex -soundhw
283Enable audio and selected sound hardware. Use 'help' to print all
284available sound hardware.
285
286@example
287qemu-system-i386 -soundhw sb16,adlib disk.img
288qemu-system-i386 -soundhw es1370 disk.img
289qemu-system-i386 -soundhw ac97 disk.img
290qemu-system-i386 -soundhw hda disk.img
291qemu-system-i386 -soundhw all disk.img
292qemu-system-i386 -soundhw help
293@end example
294
295Note that Linux's i810_audio OSS kernel (for AC97) module might
296require manually specifying clocking.
297
298@example
299modprobe i810_audio clocking=48000
300@end example
301ETEXI
302
303DEF("balloon", HAS_ARG, QEMU_OPTION_balloon,
304 "-balloon none disable balloon device\n"
305 "-balloon virtio[,addr=str]\n"
306 " enable virtio balloon device (default)\n", QEMU_ARCH_ALL)
307STEXI
308@item -balloon none
309@findex -balloon
310Disable balloon device.
311@item -balloon virtio[,addr=@var{addr}]
312Enable virtio balloon device (default), optionally with PCI address
313@var{addr}.
314ETEXI
315
316DEF("device", HAS_ARG, QEMU_OPTION_device,
317 "-device driver[,prop[=value][,...]]\n"
318 " add device (based on driver)\n"
319 " prop=value,... sets driver properties\n"
320 " use '-device help' to print all possible drivers\n"
321 " use '-device driver,help' to print all possible properties\n",
322 QEMU_ARCH_ALL)
323STEXI
324@item -device @var{driver}[,@var{prop}[=@var{value}][,...]]
325@findex -device
326Add device @var{driver}. @var{prop}=@var{value} sets driver
327properties. Valid properties depend on the driver. To get help on
328possible drivers and properties, use @code{-device help} and
329@code{-device @var{driver},help}.
330ETEXI
331
332DEF("name", HAS_ARG, QEMU_OPTION_name,
333 "-name string1[,process=string2]\n"
334 " set the name of the guest\n"
335 " string1 sets the window title and string2 the process name (on Linux)\n",
336 QEMU_ARCH_ALL)
337STEXI
338@item -name @var{name}
339@findex -name
340Sets the @var{name} of the guest.
341This name will be displayed in the SDL window caption.
342The @var{name} will also be used for the VNC server.
343Also optionally set the top visible process name in Linux.
344ETEXI
345
346DEF("uuid", HAS_ARG, QEMU_OPTION_uuid,
347 "-uuid %08x-%04x-%04x-%04x-%012x\n"
348 " specify machine UUID\n", QEMU_ARCH_ALL)
349STEXI
350@item -uuid @var{uuid}
351@findex -uuid
352Set system UUID.
353ETEXI
354
355STEXI
356@end table
357ETEXI
358DEFHEADING()
359
360DEFHEADING(Block device options:)
361STEXI
362@table @option
363ETEXI
364
blueswir15824d652009-03-28 06:44:27 +0000365DEF("fda", HAS_ARG, QEMU_OPTION_fda,
Blue Swirlad960902010-03-29 19:23:52 +0000366 "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL)
367DEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000368STEXI
369@item -fda @var{file}
370@item -fdb @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100371@findex -fda
372@findex -fdb
blueswir15824d652009-03-28 06:44:27 +0000373Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can
374use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}).
375ETEXI
376
377DEF("hda", HAS_ARG, QEMU_OPTION_hda,
Blue Swirlad960902010-03-29 19:23:52 +0000378 "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL)
379DEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000380DEF("hdc", HAS_ARG, QEMU_OPTION_hdc,
Blue Swirlad960902010-03-29 19:23:52 +0000381 "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL)
382DEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000383STEXI
384@item -hda @var{file}
385@item -hdb @var{file}
386@item -hdc @var{file}
387@item -hdd @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100388@findex -hda
389@findex -hdb
390@findex -hdc
391@findex -hdd
blueswir15824d652009-03-28 06:44:27 +0000392Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
393ETEXI
394
395DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom,
Blue Swirlad960902010-03-29 19:23:52 +0000396 "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n",
397 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000398STEXI
399@item -cdrom @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100400@findex -cdrom
blueswir15824d652009-03-28 06:44:27 +0000401Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and
402@option{-cdrom} at the same time). You can use the host CD-ROM by
403using @file{/dev/cdrom} as filename (@pxref{host_drives}).
404ETEXI
405
406DEF("drive", HAS_ARG, QEMU_OPTION_drive,
407 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n"
408 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n"
Stefan Hajnoczi92196b22011-08-04 12:26:52 +0100409 " [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n"
Alexander Graf016f5cf2010-05-26 17:51:49 +0200410 " [,serial=s][,addr=A][,id=name][,aio=threads|native]\n"
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +0000411 " [,readonly=on|off][,copy-on-read=on|off]\n"
Zhi Yong Wu0563e192011-11-03 16:57:25 +0800412 " [[,bps=b]|[[,bps_rd=r][,bps_wr=w]]][[,iops=i]|[[,iops_rd=r][,iops_wr=w]]\n"
Blue Swirlad960902010-03-29 19:23:52 +0000413 " use 'file' as a drive image\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000414STEXI
415@item -drive @var{option}[,@var{option}[,@var{option}[,...]]]
Stefan Weil6616b2a2010-02-05 23:52:05 +0100416@findex -drive
blueswir15824d652009-03-28 06:44:27 +0000417
418Define a new drive. Valid options are:
419
Kevin Wolfb3f046c2009-10-09 10:58:35 +0200420@table @option
blueswir15824d652009-03-28 06:44:27 +0000421@item file=@var{file}
422This option defines which disk image (@pxref{disk_images}) to use with
423this drive. If the filename contains comma, you must double it
424(for instance, "file=my,,file" to use file "my,file").
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +1100425
426Special files such as iSCSI devices can be specified using protocol
427specific URLs. See the section for "Device URL Syntax" for more information.
blueswir15824d652009-03-28 06:44:27 +0000428@item if=@var{interface}
429This option defines on which type on interface the drive is connected.
430Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio.
431@item bus=@var{bus},unit=@var{unit}
432These options define where is connected the drive by defining the bus number and
433the unit id.
434@item index=@var{index}
435This option defines where is connected the drive by using an index in the list
436of available connectors of a given interface type.
437@item media=@var{media}
438This option defines the type of the media: disk or cdrom.
439@item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}]
440These options have the same definition as they have in @option{-hdachs}.
441@item snapshot=@var{snapshot}
442@var{snapshot} is "on" or "off" and allows to enable snapshot for given drive (see @option{-snapshot}).
443@item cache=@var{cache}
Stefan Hajnoczi92196b22011-08-04 12:26:52 +0100444@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 +0200445@item aio=@var{aio}
446@var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO.
Paolo Bonzinia9384af2013-02-08 14:06:12 +0100447@item discard=@var{discard}
448@var{discard} is one of "ignore" (or "off") or "unmap" (or "on") and controls whether @dfn{discard} (also known as @dfn{trim} or @dfn{unmap}) requests are ignored or passed to the filesystem. Some machine types may not support discard requests.
blueswir15824d652009-03-28 06:44:27 +0000449@item format=@var{format}
450Specify which disk @var{format} will be used rather than detecting
451the format. Can be used to specifiy format=raw to avoid interpreting
452an untrusted format header.
453@item serial=@var{serial}
454This option specifies the serial number to assign to the device.
Markus Armbrusterc2cc47a2009-06-18 15:14:10 +0200455@item addr=@var{addr}
456Specify the controller's PCI address (if=virtio only).
Luiz Capitulinoae73e592011-07-12 17:35:08 -0300457@item werror=@var{action},rerror=@var{action}
458Specify which @var{action} to take on write and read errors. Valid actions are:
459"ignore" (ignore the error and try to continue), "stop" (pause QEMU),
460"report" (report the error to the guest), "enospc" (pause QEMU only if the
461host disk is full; report the error to the guest otherwise).
462The default setting is @option{werror=enospc} and @option{rerror=report}.
463@item readonly
464Open drive @option{file} as read-only. Guest write attempts will fail.
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +0000465@item copy-on-read=@var{copy-on-read}
466@var{copy-on-read} is "on" or "off" and enables whether to copy read backing
467file sectors into the image file.
blueswir15824d652009-03-28 06:44:27 +0000468@end table
469
Kevin Wolfa13e5e02012-11-21 12:26:56 +0100470By default, the @option{cache=writeback} mode is used. It will report data
471writes as completed as soon as the data is present in the host page cache.
472This is safe as long as your guest OS makes sure to correctly flush disk caches
473where needed. If your guest OS does not handle volatile disk write caches
474correctly and your host crashes or loses power, then the guest may experience
475data corruption.
blueswir15824d652009-03-28 06:44:27 +0000476
Kevin Wolfa13e5e02012-11-21 12:26:56 +0100477For such guests, you should consider using @option{cache=writethrough}. This
478means that the host page cache will be used to read and write data, but write
479notification will be sent to the guest only after QEMU has made sure to flush
480each write to the disk. Be aware that this has a major impact on performance.
blueswir15824d652009-03-28 06:44:27 +0000481
Aurelien Jarnoc304d312009-05-03 23:29:14 +0200482The host page cache can be avoided entirely with @option{cache=none}. This will
Kevin Wolfa13e5e02012-11-21 12:26:56 +0100483attempt to do disk IO directly to the guest's memory. QEMU may still perform
484an internal copy of the data. Note that this is considered a writeback mode and
485the guest OS must handle the disk write cache correctly in order to avoid data
486corruption on host crashes.
blueswir15824d652009-03-28 06:44:27 +0000487
Stefan Hajnoczi92196b22011-08-04 12:26:52 +0100488The host page cache can be avoided while only sending write notifications to
Kevin Wolfa13e5e02012-11-21 12:26:56 +0100489the guest when the data has been flushed to the disk using
490@option{cache=directsync}.
blueswir15824d652009-03-28 06:44:27 +0000491
Alexander Graf016f5cf2010-05-26 17:51:49 +0200492In case you don't care about data integrity over host failures, use
Kevin Wolfa13e5e02012-11-21 12:26:56 +0100493@option{cache=unsafe}. This option tells QEMU that it never needs to write any
494data to the disk but can instead keep things in cache. If anything goes wrong,
Stefan Weile7d81002011-12-10 00:19:46 +0100495like your host losing power, the disk storage getting disconnected accidentally,
Kevin Wolfa13e5e02012-11-21 12:26:56 +0100496etc. your image will most probably be rendered unusable. When using
Alexander Grafc3177282010-05-26 21:04:32 +0200497the @option{-snapshot} option, unsafe caching is always used.
Alexander Graf016f5cf2010-05-26 17:51:49 +0200498
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +0000499Copy-on-read avoids accessing the same backing file sectors repeatedly and is
500useful when the backing file is over a slow network. By default copy-on-read
501is off.
502
blueswir15824d652009-03-28 06:44:27 +0000503Instead of @option{-cdrom} you can use:
504@example
Stefan Weil3804da92012-05-11 22:21:50 +0200505qemu-system-i386 -drive file=file,index=2,media=cdrom
blueswir15824d652009-03-28 06:44:27 +0000506@end example
507
508Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
509use:
510@example
Stefan Weil3804da92012-05-11 22:21:50 +0200511qemu-system-i386 -drive file=file,index=0,media=disk
512qemu-system-i386 -drive file=file,index=1,media=disk
513qemu-system-i386 -drive file=file,index=2,media=disk
514qemu-system-i386 -drive file=file,index=3,media=disk
blueswir15824d652009-03-28 06:44:27 +0000515@end example
516
Corey Bryant587ed6b2012-10-18 15:19:34 -0400517You can open an image using pre-opened file descriptors from an fd set:
518@example
519qemu-system-i386
520-add-fd fd=3,set=2,opaque="rdwr:/path/to/file"
521-add-fd fd=4,set=2,opaque="rdonly:/path/to/file"
522-drive file=/dev/fdset/2,index=0,media=disk
523@end example
524
blueswir15824d652009-03-28 06:44:27 +0000525You can connect a CDROM to the slave of ide0:
526@example
Stefan Weil3804da92012-05-11 22:21:50 +0200527qemu-system-i386 -drive file=file,if=ide,index=1,media=cdrom
blueswir15824d652009-03-28 06:44:27 +0000528@end example
529
530If you don't specify the "file=" argument, you define an empty drive:
531@example
Stefan Weil3804da92012-05-11 22:21:50 +0200532qemu-system-i386 -drive if=ide,index=1,media=cdrom
blueswir15824d652009-03-28 06:44:27 +0000533@end example
534
535You can connect a SCSI disk with unit ID 6 on the bus #0:
536@example
Stefan Weil3804da92012-05-11 22:21:50 +0200537qemu-system-i386 -drive file=file,if=scsi,bus=0,unit=6
blueswir15824d652009-03-28 06:44:27 +0000538@end example
539
540Instead of @option{-fda}, @option{-fdb}, you can use:
541@example
Stefan Weil3804da92012-05-11 22:21:50 +0200542qemu-system-i386 -drive file=file,index=0,if=floppy
543qemu-system-i386 -drive file=file,index=1,if=floppy
blueswir15824d652009-03-28 06:44:27 +0000544@end example
545
546By default, @var{interface} is "ide" and @var{index} is automatically
547incremented:
548@example
Stefan Weil3804da92012-05-11 22:21:50 +0200549qemu-system-i386 -drive file=a -drive file=b"
blueswir15824d652009-03-28 06:44:27 +0000550@end example
551is interpreted like:
552@example
Stefan Weil3804da92012-05-11 22:21:50 +0200553qemu-system-i386 -hda a -hdb b
blueswir15824d652009-03-28 06:44:27 +0000554@end example
555ETEXI
556
557DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock,
Blue Swirlad960902010-03-29 19:23:52 +0000558 "-mtdblock file use 'file' as on-board Flash memory image\n",
559 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000560STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +0200561@item -mtdblock @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100562@findex -mtdblock
Kevin Wolf4e257e52009-10-09 10:58:36 +0200563Use @var{file} as on-board Flash memory image.
blueswir15824d652009-03-28 06:44:27 +0000564ETEXI
565
566DEF("sd", HAS_ARG, QEMU_OPTION_sd,
Blue Swirlad960902010-03-29 19:23:52 +0000567 "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000568STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +0200569@item -sd @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100570@findex -sd
Kevin Wolf4e257e52009-10-09 10:58:36 +0200571Use @var{file} as SecureDigital card image.
blueswir15824d652009-03-28 06:44:27 +0000572ETEXI
573
574DEF("pflash", HAS_ARG, QEMU_OPTION_pflash,
Blue Swirlad960902010-03-29 19:23:52 +0000575 "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000576STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +0200577@item -pflash @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100578@findex -pflash
Kevin Wolf4e257e52009-10-09 10:58:36 +0200579Use @var{file} as a parallel flash image.
blueswir15824d652009-03-28 06:44:27 +0000580ETEXI
581
blueswir15824d652009-03-28 06:44:27 +0000582DEF("snapshot", 0, QEMU_OPTION_snapshot,
Blue Swirlad960902010-03-29 19:23:52 +0000583 "-snapshot write to temporary files instead of disk image files\n",
584 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000585STEXI
586@item -snapshot
Stefan Weil6616b2a2010-02-05 23:52:05 +0100587@findex -snapshot
blueswir15824d652009-03-28 06:44:27 +0000588Write to temporary files instead of disk image files. In this case,
589the raw disk image you use is not written back. You can however force
590the write back by pressing @key{C-a s} (@pxref{disk_images}).
591ETEXI
592
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100593DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \
594 "-hdachs c,h,s[,t]\n" \
595 " force hard disk 0 physical geometry and the optional BIOS\n" \
596 " translation (t=none or lba) (usually QEMU can guess them)\n",
Blue Swirlad960902010-03-29 19:23:52 +0000597 QEMU_ARCH_ALL)
Marcelo Tosattic9027602010-03-01 20:25:08 -0300598STEXI
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100599@item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
600@findex -hdachs
601Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
602@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
603translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
604all those parameters. This option is useful for old MS-DOS disk
605images.
Markus Armbrusterc70a01e2013-02-13 19:49:40 +0100606ETEXI
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530607
608DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev,
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530609 "-fsdev fsdriver,id=id[,path=path,][security_model={mapped-xattr|mapped-file|passthrough|none}]\n"
M. Mohan Kumar84a87cc2011-12-14 13:58:47 +0530610 " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n",
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530611 QEMU_ARCH_ALL)
612
613STEXI
614
M. Mohan Kumar84a87cc2011-12-14 13:58:47 +0530615@item -fsdev @var{fsdriver},id=@var{id},path=@var{path},[security_model=@var{security_model}][,writeout=@var{writeout}][,readonly][,socket=@var{socket}|sock_fd=@var{sock_fd}]
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530616@findex -fsdev
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530617Define a new file system device. Valid options are:
618@table @option
619@item @var{fsdriver}
620This option specifies the fs driver backend to use.
M. Mohan Kumarf67e3ff2011-12-14 13:58:46 +0530621Currently "local", "handle" and "proxy" file system drivers are supported.
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530622@item id=@var{id}
623Specifies identifier for this device
624@item path=@var{path}
625Specifies the export path for the file system device. Files under
626this path will be available to the 9p client on the guest.
627@item security_model=@var{security_model}
628Specifies the security model to be used for this export path.
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530629Supported security models are "passthrough", "mapped-xattr", "mapped-file" and "none".
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530630In "passthrough" security model, files are stored using the same
Stefan Weilb65ee4f2012-05-11 22:25:50 +0200631credentials as they are created on the guest. This requires QEMU
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530632to run as root. In "mapped-xattr" security model, some of the file
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530633attributes like uid, gid, mode bits and link target are stored as
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530634file attributes. For "mapped-file" these attributes are stored in the
635hidden .virtfs_metadata directory. Directories exported by this security model cannot
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530636interact with other unix tools. "none" security model is same as
637passthrough except the sever won't report failures if it fails to
M. Mohan Kumard9b36a62011-10-14 12:59:37 +0530638set file attributes like ownership. Security model is mandatory
M. Mohan Kumarf67e3ff2011-12-14 13:58:46 +0530639only for local fsdriver. Other fsdrivers (like handle, proxy) don't take
M. Mohan Kumard9b36a62011-10-14 12:59:37 +0530640security model as a parameter.
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530641@item writeout=@var{writeout}
642This is an optional argument. The only supported value is "immediate".
643This means that host page cache will be used to read and write data but
644write notification will be sent to the guest only when the data has been
645reported as written by the storage subsystem.
M. Mohan Kumar2c74c2c2011-10-25 12:10:39 +0530646@item readonly
647Enables exporting 9p share as a readonly mount for guests. By default
648read-write access is given.
M. Mohan Kumar84a87cc2011-12-14 13:58:47 +0530649@item socket=@var{socket}
650Enables proxy filesystem driver to use passed socket file for communicating
651with virtfs-proxy-helper
M. Mohan Kumarf67e3ff2011-12-14 13:58:46 +0530652@item sock_fd=@var{sock_fd}
653Enables proxy filesystem driver to use passed socket descriptor for
654communicating with virtfs-proxy-helper. Usually a helper like libvirt
655will create socketpair and pass one of the fds as sock_fd
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530656@end table
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530657
658-fsdev option is used along with -device driver "virtio-9p-pci".
659@item -device virtio-9p-pci,fsdev=@var{id},mount_tag=@var{mount_tag}
660Options for virtio-9p-pci driver are:
661@table @option
662@item fsdev=@var{id}
663Specifies the id value specified along with -fsdev option
664@item mount_tag=@var{mount_tag}
665Specifies the tag name to be used by the guest to mount this export point
666@end table
667
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530668ETEXI
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530669
Gautham R Shenoy3d54abc2010-04-29 17:45:03 +0530670DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs,
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530671 "-virtfs local,path=path,mount_tag=tag,security_model=[mapped-xattr|mapped-file|passthrough|none]\n"
M. Mohan Kumar84a87cc2011-12-14 13:58:47 +0530672 " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n",
Gautham R Shenoy3d54abc2010-04-29 17:45:03 +0530673 QEMU_ARCH_ALL)
674
675STEXI
676
M. Mohan Kumar84a87cc2011-12-14 13:58:47 +0530677@item -virtfs @var{fsdriver}[,path=@var{path}],mount_tag=@var{mount_tag}[,security_model=@var{security_model}][,writeout=@var{writeout}][,readonly][,socket=@var{socket}|sock_fd=@var{sock_fd}]
Gautham R Shenoy3d54abc2010-04-29 17:45:03 +0530678@findex -virtfs
Gautham R Shenoy3d54abc2010-04-29 17:45:03 +0530679
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530680The general form of a Virtual File system pass-through options are:
681@table @option
682@item @var{fsdriver}
683This option specifies the fs driver backend to use.
M. Mohan Kumarf67e3ff2011-12-14 13:58:46 +0530684Currently "local", "handle" and "proxy" file system drivers are supported.
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530685@item id=@var{id}
686Specifies identifier for this device
687@item path=@var{path}
688Specifies the export path for the file system device. Files under
689this path will be available to the 9p client on the guest.
690@item security_model=@var{security_model}
691Specifies the security model to be used for this export path.
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530692Supported security models are "passthrough", "mapped-xattr", "mapped-file" and "none".
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530693In "passthrough" security model, files are stored using the same
Stefan Weilb65ee4f2012-05-11 22:25:50 +0200694credentials as they are created on the guest. This requires QEMU
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530695to run as root. In "mapped-xattr" security model, some of the file
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530696attributes like uid, gid, mode bits and link target are stored as
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530697file attributes. For "mapped-file" these attributes are stored in the
698hidden .virtfs_metadata directory. Directories exported by this security model cannot
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530699interact with other unix tools. "none" security model is same as
700passthrough except the sever won't report failures if it fails to
M. Mohan Kumard9b36a62011-10-14 12:59:37 +0530701set file attributes like ownership. Security model is mandatory only
M. Mohan Kumarf67e3ff2011-12-14 13:58:46 +0530702for local fsdriver. Other fsdrivers (like handle, proxy) don't take security
M. Mohan Kumard9b36a62011-10-14 12:59:37 +0530703model as a parameter.
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530704@item writeout=@var{writeout}
705This is an optional argument. The only supported value is "immediate".
706This means that host page cache will be used to read and write data but
707write notification will be sent to the guest only when the data has been
708reported as written by the storage subsystem.
M. Mohan Kumar2c74c2c2011-10-25 12:10:39 +0530709@item readonly
710Enables exporting 9p share as a readonly mount for guests. By default
711read-write access is given.
M. Mohan Kumar84a87cc2011-12-14 13:58:47 +0530712@item socket=@var{socket}
713Enables proxy filesystem driver to use passed socket file for
714communicating with virtfs-proxy-helper. Usually a helper like libvirt
715will create socketpair and pass one of the fds as sock_fd
M. Mohan Kumarf67e3ff2011-12-14 13:58:46 +0530716@item sock_fd
717Enables proxy filesystem driver to use passed 'sock_fd' as the socket
718descriptor for interfacing with virtfs-proxy-helper
Gautham R Shenoy3d54abc2010-04-29 17:45:03 +0530719@end table
720ETEXI
Gautham R Shenoy3d54abc2010-04-29 17:45:03 +0530721
Aneesh Kumar K.V9db221a2011-10-25 12:10:40 +0530722DEF("virtfs_synth", 0, QEMU_OPTION_virtfs_synth,
723 "-virtfs_synth Create synthetic file system image\n",
724 QEMU_ARCH_ALL)
725STEXI
726@item -virtfs_synth
727@findex -virtfs_synth
728Create synthetic file system image
729ETEXI
730
blueswir15824d652009-03-28 06:44:27 +0000731STEXI
732@end table
733ETEXI
blueswir15824d652009-03-28 06:44:27 +0000734DEFHEADING()
735
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100736DEFHEADING(USB options:)
737STEXI
738@table @option
739ETEXI
740
741DEF("usb", 0, QEMU_OPTION_usb,
742 "-usb enable the USB driver (will be the default soon)\n",
743 QEMU_ARCH_ALL)
744STEXI
745@item -usb
746@findex -usb
747Enable the USB driver (will be the default soon)
748ETEXI
749
750DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice,
751 "-usbdevice name add the host or guest USB device 'name'\n",
752 QEMU_ARCH_ALL)
753STEXI
754
755@item -usbdevice @var{devname}
756@findex -usbdevice
757Add the USB device @var{devname}. @xref{usb_devices}.
758
759@table @option
760
761@item mouse
762Virtual Mouse. This will override the PS/2 mouse emulation when activated.
763
764@item tablet
765Pointer device that uses absolute coordinates (like a touchscreen). This
766means QEMU is able to report the mouse position without having to grab the
767mouse. Also overrides the PS/2 mouse emulation when activated.
768
769@item disk:[format=@var{format}]:@var{file}
770Mass storage device based on file. The optional @var{format} argument
771will be used rather than detecting the format. Can be used to specifiy
772@code{format=raw} to avoid interpreting an untrusted format header.
773
774@item host:@var{bus}.@var{addr}
775Pass through the host device identified by @var{bus}.@var{addr} (Linux only).
776
777@item host:@var{vendor_id}:@var{product_id}
778Pass through the host device identified by @var{vendor_id}:@var{product_id}
779(Linux only).
780
781@item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
782Serial converter to host character device @var{dev}, see @code{-serial} for the
783available devices.
784
785@item braille
786Braille device. This will use BrlAPI to display the braille output on a real
787or fake device.
788
789@item net:@var{options}
790Network adapter that supports CDC ethernet and RNDIS protocols.
791
792@end table
793ETEXI
794
795STEXI
796@end table
797ETEXI
798DEFHEADING()
799
blueswir15824d652009-03-28 06:44:27 +0000800DEFHEADING(Display options:)
blueswir15824d652009-03-28 06:44:27 +0000801STEXI
802@table @option
803ETEXI
804
Jes Sorensen1472a952011-03-16 13:33:31 +0100805DEF("display", HAS_ARG, QEMU_OPTION_display,
806 "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n"
Jes Sorensen3264ff12011-03-16 13:33:33 +0100807 " [,window_close=on|off]|curses|none|\n"
808 " vnc=<display>[,<optargs>]\n"
Jes Sorensen1472a952011-03-16 13:33:31 +0100809 " select display type\n", QEMU_ARCH_ALL)
810STEXI
811@item -display @var{type}
812@findex -display
813Select type of display to use. This option is a replacement for the
814old style -sdl/-curses/... options. Valid values for @var{type} are
815@table @option
816@item sdl
817Display video output via SDL (usually in a separate graphics
818window; see the SDL documentation for other possibilities).
819@item curses
820Display video output via curses. For graphics device models which
821support a text mode, QEMU can display this output using a
822curses/ncurses interface. Nothing is displayed when the graphics
823device is in graphical mode or if the graphics device does not support
824a text mode. Generally only the VGA device models support text mode.
Jes Sorensen4171d322011-03-16 13:33:32 +0100825@item none
826Do not display video output. The guest will still see an emulated
827graphics card, but its output will not be displayed to the QEMU
828user. This option differs from the -nographic option in that it
829only affects what is done with video output; -nographic also changes
830the destination of the serial and parallel port data.
Jes Sorensen3264ff12011-03-16 13:33:33 +0100831@item vnc
832Start a VNC server on display <arg>
Jes Sorensen1472a952011-03-16 13:33:31 +0100833@end table
834ETEXI
835
blueswir15824d652009-03-28 06:44:27 +0000836DEF("nographic", 0, QEMU_OPTION_nographic,
Blue Swirlad960902010-03-29 19:23:52 +0000837 "-nographic disable graphical output and redirect serial I/Os to console\n",
838 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000839STEXI
840@item -nographic
Stefan Weil6616b2a2010-02-05 23:52:05 +0100841@findex -nographic
blueswir15824d652009-03-28 06:44:27 +0000842Normally, QEMU uses SDL to display the VGA output. With this option,
843you can totally disable graphical output so that QEMU is a simple
844command line application. The emulated serial port is redirected on
845the console. Therefore, you can still use QEMU to debug a Linux kernel
846with a serial console.
847ETEXI
848
blueswir15824d652009-03-28 06:44:27 +0000849DEF("curses", 0, QEMU_OPTION_curses,
Blue Swirlad960902010-03-29 19:23:52 +0000850 "-curses use a curses/ncurses interface instead of SDL\n",
851 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000852STEXI
853@item -curses
Markus Armbrusterb8f490e2013-02-13 19:49:38 +0100854@findex -curses
blueswir15824d652009-03-28 06:44:27 +0000855Normally, QEMU uses SDL to display the VGA output. With this option,
856QEMU can display the VGA output when in text mode using a
857curses/ncurses interface. Nothing is displayed in graphical mode.
858ETEXI
859
blueswir15824d652009-03-28 06:44:27 +0000860DEF("no-frame", 0, QEMU_OPTION_no_frame,
Blue Swirlad960902010-03-29 19:23:52 +0000861 "-no-frame open SDL window without a frame and window decorations\n",
862 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000863STEXI
864@item -no-frame
Stefan Weil6616b2a2010-02-05 23:52:05 +0100865@findex -no-frame
blueswir15824d652009-03-28 06:44:27 +0000866Do not use decorations for SDL windows and start them using the whole
867available screen space. This makes the using QEMU in a dedicated desktop
868workspace more convenient.
869ETEXI
870
blueswir15824d652009-03-28 06:44:27 +0000871DEF("alt-grab", 0, QEMU_OPTION_alt_grab,
Blue Swirlad960902010-03-29 19:23:52 +0000872 "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n",
873 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000874STEXI
875@item -alt-grab
Stefan Weil6616b2a2010-02-05 23:52:05 +0100876@findex -alt-grab
Brad Hardsde1db2a2011-04-29 21:46:12 +1000877Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also
878affects the special keys (for fullscreen, monitor-mode switching, etc).
blueswir15824d652009-03-28 06:44:27 +0000879ETEXI
880
Dustin Kirkland0ca9f8a2009-09-17 15:48:04 -0500881DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab,
Blue Swirlad960902010-03-29 19:23:52 +0000882 "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n",
883 QEMU_ARCH_ALL)
Dustin Kirkland0ca9f8a2009-09-17 15:48:04 -0500884STEXI
885@item -ctrl-grab
Stefan Weil6616b2a2010-02-05 23:52:05 +0100886@findex -ctrl-grab
Brad Hardsde1db2a2011-04-29 21:46:12 +1000887Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also
888affects the special keys (for fullscreen, monitor-mode switching, etc).
Dustin Kirkland0ca9f8a2009-09-17 15:48:04 -0500889ETEXI
890
blueswir15824d652009-03-28 06:44:27 +0000891DEF("no-quit", 0, QEMU_OPTION_no_quit,
Blue Swirlad960902010-03-29 19:23:52 +0000892 "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000893STEXI
894@item -no-quit
Stefan Weil6616b2a2010-02-05 23:52:05 +0100895@findex -no-quit
blueswir15824d652009-03-28 06:44:27 +0000896Disable SDL window close capability.
897ETEXI
898
blueswir15824d652009-03-28 06:44:27 +0000899DEF("sdl", 0, QEMU_OPTION_sdl,
Blue Swirlad960902010-03-29 19:23:52 +0000900 "-sdl enable SDL\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000901STEXI
902@item -sdl
Stefan Weil6616b2a2010-02-05 23:52:05 +0100903@findex -sdl
blueswir15824d652009-03-28 06:44:27 +0000904Enable SDL.
905ETEXI
906
Gerd Hoffmann29b00402010-03-11 11:13:27 -0300907DEF("spice", HAS_ARG, QEMU_OPTION_spice,
Yonit Halperin27af7782012-08-21 13:54:20 +0300908 "-spice [port=port][,tls-port=secured-port][,x509-dir=<dir>]\n"
909 " [,x509-key-file=<file>][,x509-key-password=<file>]\n"
910 " [,x509-cert-file=<file>][,x509-cacert-file=<file>]\n"
911 " [,x509-dh-key-file=<file>][,addr=addr][,ipv4|ipv6]\n"
912 " [,tls-ciphers=<list>]\n"
913 " [,tls-channel=[main|display|cursor|inputs|record|playback]]\n"
914 " [,plaintext-channel=[main|display|cursor|inputs|record|playback]]\n"
915 " [,sasl][,password=<secret>][,disable-ticketing]\n"
916 " [,image-compression=[auto_glz|auto_lz|quic|glz|lz|off]]\n"
917 " [,jpeg-wan-compression=[auto|never|always]]\n"
918 " [,zlib-glz-wan-compression=[auto|never|always]]\n"
919 " [,streaming-video=[off|all|filter]][,disable-copy-paste]\n"
920 " [,agent-mouse=[on|off]][,playback-compression=[on|off]]\n"
921 " [,seamless-migration=[on|off]]\n"
922 " enable spice\n"
923 " at least one of {port, tls-port} is mandatory\n",
924 QEMU_ARCH_ALL)
Gerd Hoffmann29b00402010-03-11 11:13:27 -0300925STEXI
926@item -spice @var{option}[,@var{option}[,...]]
927@findex -spice
928Enable the spice remote desktop protocol. Valid options are
929
930@table @option
931
932@item port=<nr>
Gerd Hoffmannc448e852010-03-11 11:13:32 -0300933Set the TCP port spice is listening on for plaintext channels.
Gerd Hoffmann29b00402010-03-11 11:13:27 -0300934
Gerd Hoffmann333b0ee2010-08-27 14:29:16 +0200935@item addr=<addr>
936Set the IP address spice is listening on. Default is any address.
937
938@item ipv4
939@item ipv6
940Force using the specified IP version.
941
Gerd Hoffmann29b00402010-03-11 11:13:27 -0300942@item password=<secret>
943Set the password you need to authenticate.
944
Marc-André Lureau48b3ed02011-05-17 10:40:33 +0200945@item sasl
946Require that the client use SASL to authenticate with the spice.
947The exact choice of authentication method used is controlled from the
948system / user's SASL configuration file for the 'qemu' service. This
949is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
950unprivileged user, an environment variable SASL_CONF_PATH can be used
951to make it search alternate locations for the service config.
952While some SASL auth methods can also provide data encryption (eg GSSAPI),
953it is recommended that SASL always be combined with the 'tls' and
954'x509' settings to enable use of SSL and server certificates. This
955ensures a data encryption preventing compromise of authentication
956credentials.
957
Gerd Hoffmann29b00402010-03-11 11:13:27 -0300958@item disable-ticketing
959Allow client connects without authentication.
960
Hans de Goeded4970b02011-03-27 16:43:54 +0200961@item disable-copy-paste
962Disable copy paste between the client and the guest.
963
Gerd Hoffmannc448e852010-03-11 11:13:32 -0300964@item tls-port=<nr>
965Set the TCP port spice is listening on for encrypted channels.
966
967@item x509-dir=<dir>
968Set the x509 file directory. Expects same filenames as -vnc $display,x509=$dir
969
970@item x509-key-file=<file>
971@item x509-key-password=<file>
972@item x509-cert-file=<file>
973@item x509-cacert-file=<file>
974@item x509-dh-key-file=<file>
975The x509 file names can also be configured individually.
976
977@item tls-ciphers=<list>
978Specify which ciphers to use.
979
Alon Levyd70d6b32011-12-20 13:05:18 +0200980@item tls-channel=[main|display|cursor|inputs|record|playback]
981@item plaintext-channel=[main|display|cursor|inputs|record|playback]
Gerd Hoffmann17b6dea2010-08-27 14:09:56 +0200982Force specific channel to be used with or without TLS encryption. The
983options can be specified multiple times to configure multiple
984channels. The special name "default" can be used to set the default
985mode. For channels which are not explicitly forced into one mode the
986spice client is allowed to pick tls/plaintext as he pleases.
987
Yonit Halperin9f04e092010-07-14 13:26:34 +0300988@item image-compression=[auto_glz|auto_lz|quic|glz|lz|off]
989Configure image compression (lossless).
990Default is auto_glz.
991
992@item jpeg-wan-compression=[auto|never|always]
993@item zlib-glz-wan-compression=[auto|never|always]
994Configure wan image compression (lossy for slow links).
995Default is auto.
996
Gerd Hoffmann84a23f22010-08-30 16:36:53 +0200997@item streaming-video=[off|all|filter]
998Configure video stream detection. Default is filter.
999
1000@item agent-mouse=[on|off]
1001Enable/disable passing mouse events via vdagent. Default is on.
1002
1003@item playback-compression=[on|off]
1004Enable/disable audio stream compression (using celt 0.5.1). Default is on.
1005
Yonit Halperin8c957052012-08-21 11:51:59 +03001006@item seamless-migration=[on|off]
1007Enable/disable spice seamless migration. Default is off.
1008
Gerd Hoffmann29b00402010-03-11 11:13:27 -03001009@end table
1010ETEXI
1011
blueswir15824d652009-03-28 06:44:27 +00001012DEF("portrait", 0, QEMU_OPTION_portrait,
Blue Swirlad960902010-03-29 19:23:52 +00001013 "-portrait rotate graphical output 90 deg left (only PXA LCD)\n",
1014 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001015STEXI
1016@item -portrait
Stefan Weil6616b2a2010-02-05 23:52:05 +01001017@findex -portrait
blueswir15824d652009-03-28 06:44:27 +00001018Rotate graphical output 90 deg left (only PXA LCD).
1019ETEXI
1020
Vasily Khoruzhick93128052011-06-17 13:04:36 +03001021DEF("rotate", HAS_ARG, QEMU_OPTION_rotate,
1022 "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n",
1023 QEMU_ARCH_ALL)
1024STEXI
Markus Armbruster6265c432013-02-13 19:49:39 +01001025@item -rotate @var{deg}
Vasily Khoruzhick93128052011-06-17 13:04:36 +03001026@findex -rotate
1027Rotate graphical output some deg left (only PXA LCD).
1028ETEXI
1029
blueswir15824d652009-03-28 06:44:27 +00001030DEF("vga", HAS_ARG, QEMU_OPTION_vga,
Gerd Hoffmanna19cbfb2010-04-27 11:50:11 +02001031 "-vga [std|cirrus|vmware|qxl|xenfb|none]\n"
Blue Swirlad960902010-03-29 19:23:52 +00001032 " select video card type\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001033STEXI
malce4558dc2012-08-27 18:33:21 +04001034@item -vga @var{type}
Stefan Weil6616b2a2010-02-05 23:52:05 +01001035@findex -vga
blueswir15824d652009-03-28 06:44:27 +00001036Select type of VGA card to emulate. Valid values for @var{type} are
Kevin Wolfb3f046c2009-10-09 10:58:35 +02001037@table @option
blueswir15824d652009-03-28 06:44:27 +00001038@item cirrus
1039Cirrus Logic GD5446 Video card. All Windows versions starting from
1040Windows 95 should recognize and use this graphic card. For optimal
1041performances, use 16 bit color depth in the guest and the host OS.
1042(This one is the default)
1043@item std
1044Standard VGA card with Bochs VBE extensions. If your guest OS
1045supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
1046to use high resolution modes (>= 1280x1024x16) then you should use
1047this option.
1048@item vmware
1049VMWare SVGA-II compatible adapter. Use it if you have sufficiently
1050recent XFree86/XOrg server or Windows guest with a driver for this
1051card.
Gerd Hoffmanna19cbfb2010-04-27 11:50:11 +02001052@item qxl
1053QXL paravirtual graphic card. It is VGA compatible (including VESA
10542.0 VBE support). Works best with qxl guest drivers installed though.
1055Recommended choice when using the spice protocol.
blueswir15824d652009-03-28 06:44:27 +00001056@item none
1057Disable VGA card.
1058@end table
1059ETEXI
1060
1061DEF("full-screen", 0, QEMU_OPTION_full_screen,
Blue Swirlad960902010-03-29 19:23:52 +00001062 "-full-screen start in full screen\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001063STEXI
1064@item -full-screen
Stefan Weil6616b2a2010-02-05 23:52:05 +01001065@findex -full-screen
blueswir15824d652009-03-28 06:44:27 +00001066Start in full screen.
1067ETEXI
1068
blueswir15824d652009-03-28 06:44:27 +00001069DEF("g", 1, QEMU_OPTION_g ,
Blue Swirlad960902010-03-29 19:23:52 +00001070 "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n",
1071 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
blueswir15824d652009-03-28 06:44:27 +00001072STEXI
Stefan Weil95d5f082010-01-20 22:25:27 +01001073@item -g @var{width}x@var{height}[x@var{depth}]
Stefan Weil6616b2a2010-02-05 23:52:05 +01001074@findex -g
Stefan Weil95d5f082010-01-20 22:25:27 +01001075Set the initial graphical resolution and depth (PPC, SPARC only).
blueswir15824d652009-03-28 06:44:27 +00001076ETEXI
1077
1078DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
Blue Swirlad960902010-03-29 19:23:52 +00001079 "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001080STEXI
1081@item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
Stefan Weil6616b2a2010-02-05 23:52:05 +01001082@findex -vnc
blueswir15824d652009-03-28 06:44:27 +00001083Normally, QEMU uses SDL to display the VGA output. With this option,
1084you can have QEMU listen on VNC display @var{display} and redirect the VGA
1085display over the VNC session. It is very useful to enable the usb
1086tablet device when using this option (option @option{-usbdevice
1087tablet}). When using the VNC display, you must use the @option{-k}
1088parameter to set the keyboard layout if you are not using en-us. Valid
1089syntax for the @var{display} is
1090
Kevin Wolfb3f046c2009-10-09 10:58:35 +02001091@table @option
blueswir15824d652009-03-28 06:44:27 +00001092
1093@item @var{host}:@var{d}
1094
1095TCP connections will only be allowed from @var{host} on display @var{d}.
1096By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
1097be omitted in which case the server will accept connections from any host.
1098
Kevin Wolf4e257e52009-10-09 10:58:36 +02001099@item unix:@var{path}
blueswir15824d652009-03-28 06:44:27 +00001100
1101Connections will be allowed over UNIX domain sockets where @var{path} is the
1102location of a unix socket to listen for connections on.
1103
1104@item none
1105
1106VNC is initialized but not started. The monitor @code{change} command
1107can be used to later start the VNC server.
1108
1109@end table
1110
1111Following the @var{display} value there may be one or more @var{option} flags
1112separated by commas. Valid options are
1113
Kevin Wolfb3f046c2009-10-09 10:58:35 +02001114@table @option
blueswir15824d652009-03-28 06:44:27 +00001115
1116@item reverse
1117
1118Connect to a listening VNC client via a ``reverse'' connection. The
1119client is specified by the @var{display}. For reverse network
1120connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
1121is a TCP port number, not a display number.
1122
Tim Hardeck7536ee42013-01-21 11:04:44 +01001123@item websocket
1124
1125Opens an additional TCP listening port dedicated to VNC Websocket connections.
Peter Maydell085d8132013-03-18 17:20:07 +00001126By definition the Websocket port is 5700+@var{display}. If @var{host} is
Tim Hardeck7536ee42013-01-21 11:04:44 +01001127specified connections will only be allowed from this host.
1128As an alternative the Websocket port could be specified by using
1129@code{websocket}=@var{port}.
1130
blueswir15824d652009-03-28 06:44:27 +00001131@item password
1132
1133Require that password based authentication is used for client connections.
Michal Novotny86ee5bc2012-07-16 15:54:38 +02001134
1135The password must be set separately using the @code{set_password} command in
1136the @ref{pcsys_monitor}. The syntax to change your password is:
1137@code{set_password <protocol> <password>} where <protocol> could be either
1138"vnc" or "spice".
1139
1140If you would like to change <protocol> password expiration, you should use
1141@code{expire_password <protocol> <expiration-time>} where expiration time could
1142be one of the following options: now, never, +seconds or UNIX time of
1143expiration, e.g. +60 to make password expire in 60 seconds, or 1335196800
1144to make password expire on "Mon Apr 23 12:00:00 EDT 2012" (UNIX time for this
1145date and time).
1146
1147You can also use keywords "now" or "never" for the expiration time to
1148allow <protocol> password to expire immediately or never expire.
blueswir15824d652009-03-28 06:44:27 +00001149
1150@item tls
1151
1152Require that client use TLS when communicating with the VNC server. This
1153uses anonymous TLS credentials so is susceptible to a man-in-the-middle
1154attack. It is recommended that this option be combined with either the
Kevin Wolf4e257e52009-10-09 10:58:36 +02001155@option{x509} or @option{x509verify} options.
blueswir15824d652009-03-28 06:44:27 +00001156
1157@item x509=@var{/path/to/certificate/dir}
1158
1159Valid if @option{tls} is specified. Require that x509 credentials are used
1160for negotiating the TLS session. The server will send its x509 certificate
1161to the client. It is recommended that a password be set on the VNC server
1162to provide authentication of the client when this is used. The path following
1163this option specifies where the x509 certificates are to be loaded from.
1164See the @ref{vnc_security} section for details on generating certificates.
1165
1166@item x509verify=@var{/path/to/certificate/dir}
1167
1168Valid if @option{tls} is specified. Require that x509 credentials are used
1169for negotiating the TLS session. The server will send its x509 certificate
1170to the client, and request that the client send its own x509 certificate.
1171The server will validate the client's certificate against the CA certificate,
1172and reject clients when validation fails. If the certificate authority is
1173trusted, this is a sufficient authentication mechanism. You may still wish
1174to set a password on the VNC server as a second authentication layer. The
1175path following this option specifies where the x509 certificates are to
1176be loaded from. See the @ref{vnc_security} section for details on generating
1177certificates.
1178
1179@item sasl
1180
1181Require that the client use SASL to authenticate with the VNC server.
1182The exact choice of authentication method used is controlled from the
1183system / user's SASL configuration file for the 'qemu' service. This
1184is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
1185unprivileged user, an environment variable SASL_CONF_PATH can be used
1186to make it search alternate locations for the service config.
1187While some SASL auth methods can also provide data encryption (eg GSSAPI),
1188it is recommended that SASL always be combined with the 'tls' and
1189'x509' settings to enable use of SSL and server certificates. This
1190ensures a data encryption preventing compromise of authentication
1191credentials. See the @ref{vnc_security} section for details on using
1192SASL authentication.
1193
1194@item acl
1195
1196Turn on access control lists for checking of the x509 client certificate
1197and SASL party. For x509 certs, the ACL check is made against the
1198certificate's distinguished name. This is something that looks like
1199@code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
1200made against the username, which depending on the SASL plugin, may
1201include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
1202When the @option{acl} flag is set, the initial access list will be
1203empty, with a @code{deny} policy. Thus no one will be allowed to
1204use the VNC server until the ACLs have been loaded. This can be
1205achieved using the @code{acl} monitor command.
1206
Corentin Chary6f9c78c2010-07-07 20:57:51 +02001207@item lossy
1208
1209Enable lossy compression methods (gradient, JPEG, ...). If this
1210option is set, VNC client may receive lossy framebuffer updates
1211depending on its encoding settings. Enabling this option can save
1212a lot of bandwidth at the expense of quality.
1213
Corentin Chary80e0c8c2011-02-04 09:06:08 +01001214@item non-adaptive
1215
1216Disable adaptive encodings. Adaptive encodings are enabled by default.
1217An adaptive encoding will try to detect frequently updated screen regions,
1218and send updates in these regions using a lossy encoding (like JPEG).
Stefan Weil61cc8702011-04-13 22:45:22 +02001219This can be really helpful to save bandwidth when playing videos. Disabling
1220adaptive encodings allows to restore the original static behavior of encodings
Corentin Chary80e0c8c2011-02-04 09:06:08 +01001221like Tight.
1222
Gerd Hoffmann8cf36482011-11-24 18:10:49 +01001223@item share=[allow-exclusive|force-shared|ignore]
1224
1225Set display sharing policy. 'allow-exclusive' allows clients to ask
1226for exclusive access. As suggested by the rfb spec this is
1227implemented by dropping other connections. Connecting multiple
1228clients in parallel requires all clients asking for a shared session
1229(vncviewer: -shared switch). This is the default. 'force-shared'
1230disables exclusive client access. Useful for shared desktop sessions,
1231where you don't want someone forgetting specify -shared disconnect
1232everybody else. 'ignore' completely ignores the shared flag and
1233allows everybody connect unconditionally. Doesn't conform to the rfb
Stefan Weilb65ee4f2012-05-11 22:25:50 +02001234spec but is traditional QEMU behavior.
Gerd Hoffmann8cf36482011-11-24 18:10:49 +01001235
blueswir15824d652009-03-28 06:44:27 +00001236@end table
1237ETEXI
1238
1239STEXI
1240@end table
1241ETEXI
Michael Ellermana3adb7a2011-12-19 17:19:31 +11001242ARCHHEADING(, QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001243
Michael Ellermana3adb7a2011-12-19 17:19:31 +11001244ARCHHEADING(i386 target only:, QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001245STEXI
1246@table @option
1247ETEXI
1248
blueswir15824d652009-03-28 06:44:27 +00001249DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack,
Blue Swirlad960902010-03-29 19:23:52 +00001250 "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n",
1251 QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001252STEXI
1253@item -win2k-hack
Stefan Weil6616b2a2010-02-05 23:52:05 +01001254@findex -win2k-hack
blueswir15824d652009-03-28 06:44:27 +00001255Use it when installing Windows 2000 to avoid a disk full bug. After
1256Windows 2000 is installed, you no longer need this option (this option
1257slows down the IDE transfers).
1258ETEXI
1259
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02001260HXCOMM Deprecated by -rtc
Blue Swirlad960902010-03-29 19:23:52 +00001261DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001262
blueswir15824d652009-03-28 06:44:27 +00001263DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk,
Blue Swirlad960902010-03-29 19:23:52 +00001264 "-no-fd-bootchk disable boot signature checking for floppy disks\n",
1265 QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001266STEXI
1267@item -no-fd-bootchk
Stefan Weil6616b2a2010-02-05 23:52:05 +01001268@findex -no-fd-bootchk
blueswir15824d652009-03-28 06:44:27 +00001269Disable boot signature checking for floppy disks in Bochs BIOS. It may
1270be needed to boot from old floppy disks.
Stefan Weil6616b2a2010-02-05 23:52:05 +01001271TODO: check reference to Bochs BIOS.
blueswir15824d652009-03-28 06:44:27 +00001272ETEXI
1273
blueswir15824d652009-03-28 06:44:27 +00001274DEF("no-acpi", 0, QEMU_OPTION_no_acpi,
Blue Swirlad960902010-03-29 19:23:52 +00001275 "-no-acpi disable ACPI\n", QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001276STEXI
1277@item -no-acpi
Stefan Weil6616b2a2010-02-05 23:52:05 +01001278@findex -no-acpi
blueswir15824d652009-03-28 06:44:27 +00001279Disable ACPI (Advanced Configuration and Power Interface) support. Use
1280it if your guest OS complains about ACPI problems (PC target machine
1281only).
1282ETEXI
1283
blueswir15824d652009-03-28 06:44:27 +00001284DEF("no-hpet", 0, QEMU_OPTION_no_hpet,
Blue Swirlad960902010-03-29 19:23:52 +00001285 "-no-hpet disable HPET\n", QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001286STEXI
1287@item -no-hpet
Stefan Weil6616b2a2010-02-05 23:52:05 +01001288@findex -no-hpet
blueswir15824d652009-03-28 06:44:27 +00001289Disable HPET support.
1290ETEXI
1291
blueswir15824d652009-03-28 06:44:27 +00001292DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable,
Michael Tokarev104bf022011-05-12 18:44:17 +04001293 "-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 +00001294 " ACPI table description\n", QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001295STEXI
1296@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 +01001297@findex -acpitable
blueswir15824d652009-03-28 06:44:27 +00001298Add ACPI table with specified header fields and context from specified files.
Michael Tokarev104bf022011-05-12 18:44:17 +04001299For file=, take whole ACPI table from the specified files, including all
1300ACPI headers (possible overridden by other options).
1301For data=, only data
1302portion of the table is used, all header information is specified in the
1303command line.
blueswir15824d652009-03-28 06:44:27 +00001304ETEXI
1305
aliguorib6f6e3d2009-04-17 18:59:56 +00001306DEF("smbios", HAS_ARG, QEMU_OPTION_smbios,
1307 "-smbios file=binary\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -07001308 " load SMBIOS entry from binary file\n"
Paolo Bonzinie8105eb2010-02-04 16:49:59 +01001309 "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -07001310 " specify SMBIOS type 0 fields\n"
aliguorib6f6e3d2009-04-17 18:59:56 +00001311 "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n"
1312 " [,uuid=uuid][,sku=str][,family=str]\n"
Blue Swirlad960902010-03-29 19:23:52 +00001313 " specify SMBIOS type 1 fields\n", QEMU_ARCH_I386)
aliguorib6f6e3d2009-04-17 18:59:56 +00001314STEXI
1315@item -smbios file=@var{binary}
Stefan Weil6616b2a2010-02-05 23:52:05 +01001316@findex -smbios
aliguorib6f6e3d2009-04-17 18:59:56 +00001317Load SMBIOS entry from binary file.
1318
1319@item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}]
1320Specify SMBIOS type 0 fields
1321
Blue Swirl609c1da2010-03-18 18:41:49 +00001322@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 +00001323Specify SMBIOS type 1 fields
1324ETEXI
1325
blueswir15824d652009-03-28 06:44:27 +00001326STEXI
1327@end table
1328ETEXI
Markus Armbrusterc70a01e2013-02-13 19:49:40 +01001329DEFHEADING()
blueswir15824d652009-03-28 06:44:27 +00001330
1331DEFHEADING(Network options:)
1332STEXI
1333@table @option
1334ETEXI
1335
Jan Kiszkaad196a92009-06-24 14:42:28 +02001336HXCOMM Legacy slirp options (now moved to -net user):
1337#ifdef CONFIG_SLIRP
Blue Swirlad960902010-03-29 19:23:52 +00001338DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL)
1339DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL)
1340DEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL)
Jan Kiszkaad196a92009-06-24 14:42:28 +02001341#ifndef _WIN32
Blue Swirlad960902010-03-29 19:23:52 +00001342DEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL)
Jan Kiszkaad196a92009-06-24 14:42:28 +02001343#endif
1344#endif
1345
Blue Swirlbab79442009-06-09 21:50:02 +03001346DEF("net", HAS_ARG, QEMU_OPTION_net,
Michael S. Tsirkinffe63702009-06-21 19:51:18 +03001347 "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n"
blueswir15824d652009-03-28 06:44:27 +00001348 " create a new Network Interface Card and connect it to VLAN 'n'\n"
1349#ifdef CONFIG_SLIRP
Jan Kiszkac54ed5b2011-07-20 12:20:14 +02001350 "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=on|off]\n"
Klaus Stengel63d29602012-10-27 19:53:39 +02001351 " [,hostname=host][,dhcpstart=addr][,dns=addr][,dnssearch=domain][,tftp=dir]\n"
1352 " [,bootfile=f][,hostfwd=rule][,guestfwd=rule]"
Jan Kiszkaad196a92009-06-24 14:42:28 +02001353#ifndef _WIN32
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001354 "[,smb=dir[,smbserver=addr]]\n"
Jan Kiszkaad196a92009-06-24 14:42:28 +02001355#endif
1356 " connect the user mode network stack to VLAN 'n', configure its\n"
1357 " DHCP server and enabled optional services\n"
blueswir15824d652009-03-28 06:44:27 +00001358#endif
1359#ifdef _WIN32
1360 "-net tap[,vlan=n][,name=str],ifname=name\n"
1361 " connect the host TAP network interface to VLAN 'n'\n"
1362#else
Jason Wangec396012013-02-22 22:57:52 +08001363 "-net tap[,vlan=n][,name=str][,fd=h][,fds=x:y:...:z][,ifname=name][,script=file][,downscript=dfile][,helper=helper][,sndbuf=nbytes][,vnet_hdr=on|off][,vhost=on|off][,vhostfd=h][,vhostfds=x:y:...:z][,vhostforce=on|off][,queues=n]\n"
Michal Privoznik3528a3c2012-11-23 09:52:39 +01001364 " connect the host TAP network interface to VLAN 'n'\n"
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001365 " use network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n"
1366 " to configure it and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n"
1367 " to deconfigure it\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -07001368 " use '[down]script=no' to disable script execution\n"
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001369 " use network helper 'helper' (default=" DEFAULT_BRIDGE_HELPER ") to\n"
1370 " configure it\n"
blueswir15824d652009-03-28 06:44:27 +00001371 " use 'fd=h' to connect to an already opened TAP interface\n"
Jason Wang2ca81ba2013-02-20 18:04:01 +08001372 " use 'fds=x:y:...:z' to connect to already opened multiqueue capable TAP interfaces\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -07001373 " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n"
Michael S. Tsirkinf157ed22011-02-01 14:25:40 +02001374 " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -07001375 " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n"
1376 " 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 +02001377 " use vhost=on to enable experimental in kernel accelerator\n"
mst@redhat.com5430a282011-02-01 22:13:42 +02001378 " (only has effect for virtio guests which use MSIX)\n"
1379 " use vhostforce=on to force vhost on for non-MSIX virtio guests\n"
Michael S. Tsirkin82b0d802010-03-17 13:08:24 +02001380 " use 'vhostfd=h' to connect to an already opened vhost net device\n"
Jason Wang2ca81ba2013-02-20 18:04:01 +08001381 " use 'vhostfds=x:y:...:z to connect to multiple already opened vhost net devices\n"
Jason Wangec396012013-02-22 22:57:52 +08001382 " use 'queues=n' to specify the number of queues to be created for multiqueue TAP\n"
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001383 "-net bridge[,vlan=n][,name=str][,br=bridge][,helper=helper]\n"
1384 " connects a host TAP network interface to a host bridge device 'br'\n"
1385 " (default=" DEFAULT_BRIDGE_INTERFACE ") using the program 'helper'\n"
1386 " (default=" DEFAULT_BRIDGE_HELPER ")\n"
Mark McLoughlin0df0ff62009-06-18 18:21:34 +01001387#endif
blueswir15824d652009-03-28 06:44:27 +00001388 "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n"
1389 " connect the vlan 'n' to another VLAN using a socket connection\n"
Mike Ryan3a75e742010-12-01 11:16:47 -08001390 "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port[,localaddr=addr]]\n"
blueswir15824d652009-03-28 06:44:27 +00001391 " connect the vlan 'n' to multicast maddr and port\n"
Mike Ryan3a75e742010-12-01 11:16:47 -08001392 " use 'localaddr=addr' to specify the host address to send packets from\n"
Benjamin0e0e7fa2012-01-11 09:20:54 +09001393 "-net socket[,vlan=n][,name=str][,fd=h][,udp=host:port][,localaddr=host:port]\n"
1394 " connect the vlan 'n' to another VLAN using an UDP tunnel\n"
blueswir15824d652009-03-28 06:44:27 +00001395#ifdef CONFIG_VDE
1396 "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n"
1397 " connect the vlan 'n' to port 'n' of a vde switch running\n"
1398 " on host and listening for incoming connections on 'socketpath'.\n"
1399 " Use group 'groupname' and mode 'octalmode' to change default\n"
1400 " ownership and permissions for communication port.\n"
1401#endif
aliguoribb9ea792009-04-21 19:56:28 +00001402 "-net dump[,vlan=n][,file=f][,len=n]\n"
1403 " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -07001404 "-net none use it alone to have zero network devices. If no -net option\n"
Blue Swirlad960902010-03-29 19:23:52 +00001405 " is provided, the default is '-net nic -net user'\n", QEMU_ARCH_ALL)
Mark McLoughlina1ea4582009-10-08 19:58:26 +01001406DEF("netdev", HAS_ARG, QEMU_OPTION_netdev,
1407 "-netdev ["
1408#ifdef CONFIG_SLIRP
1409 "user|"
1410#endif
1411 "tap|"
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001412 "bridge|"
Mark McLoughlina1ea4582009-10-08 19:58:26 +01001413#ifdef CONFIG_VDE
1414 "vde|"
1415#endif
Stefan Hajnoczi40e8c262013-02-26 11:07:16 +01001416 "socket|"
1417 "hubport],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001418STEXI
Blue Swirl609c1da2010-03-18 18:41:49 +00001419@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 +01001420@findex -net
blueswir15824d652009-03-28 06:44:27 +00001421Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
Anthony Liguori0d6b0b12009-08-14 11:20:47 -05001422= 0 is the default). The NIC is an e1000 by default on the PC
Markus Armbruster5607c382009-06-18 15:14:08 +02001423target. Optionally, the MAC address can be changed to @var{mac}, the
1424device address set to @var{addr} (PCI cards only),
Michael S. Tsirkinffe63702009-06-21 19:51:18 +03001425and a @var{name} can be assigned for use in monitor commands.
1426Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
1427that the card should have; this option currently only affects virtio cards; set
1428@var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
Stefan Weil071c9392012-04-07 09:23:36 +02001429NIC is created. QEMU can emulate several different models of network card.
blueswir15824d652009-03-28 06:44:27 +00001430Valid values for @var{type} are
Michael S. Tsirkinffe63702009-06-21 19:51:18 +03001431@code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er},
blueswir15824d652009-03-28 06:44:27 +00001432@code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
1433@code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
Peter Maydell585f6032012-10-04 16:22:01 +01001434Not all devices are supported on all targets. Use @code{-net nic,model=help}
blueswir15824d652009-03-28 06:44:27 +00001435for a list of available devices for your target.
1436
Stefan Hajnoczi08d12022012-08-14 14:14:27 +01001437@item -netdev user,id=@var{id}[,@var{option}][,@var{option}][,...]
Markus Armbrusterb8f490e2013-02-13 19:49:38 +01001438@findex -netdev
Jan Kiszkaad196a92009-06-24 14:42:28 +02001439@item -net user[,@var{option}][,@var{option}][,...]
blueswir15824d652009-03-28 06:44:27 +00001440Use the user mode network stack which requires no administrator
Jan Kiszkaad196a92009-06-24 14:42:28 +02001441privilege to run. Valid options are:
blueswir15824d652009-03-28 06:44:27 +00001442
Kevin Wolfb3f046c2009-10-09 10:58:35 +02001443@table @option
Jan Kiszkaad196a92009-06-24 14:42:28 +02001444@item vlan=@var{n}
1445Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default).
1446
Stefan Hajnoczi08d12022012-08-14 14:14:27 +01001447@item id=@var{id}
Jan Kiszkaad196a92009-06-24 14:42:28 +02001448@item name=@var{name}
1449Assign symbolic name for use in monitor commands.
1450
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001451@item net=@var{addr}[/@var{mask}]
1452Set IP network address the guest will see. Optionally specify the netmask,
1453either in the form a.b.c.d or as number of valid top-most bits. Default is
Brad Hardsb0b36e52011-04-24 17:19:56 +1000145410.0.2.0/24.
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001455
1456@item host=@var{addr}
1457Specify the guest-visible address of the host. Default is the 2nd IP in the
1458guest network, i.e. x.x.x.2.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001459
Jan Kiszkac54ed5b2011-07-20 12:20:14 +02001460@item restrict=on|off
Brad Hardscaef55e2011-06-09 07:50:43 +10001461If this option is enabled, the guest will be isolated, i.e. it will not be
Jan Kiszkaad196a92009-06-24 14:42:28 +02001462able to contact the host and no guest IP packets will be routed over the host
Brad Hardscaef55e2011-06-09 07:50:43 +10001463to the outside. This option does not affect any explicitly set forwarding rules.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001464
1465@item hostname=@var{name}
Klaus Stengel63d29602012-10-27 19:53:39 +02001466Specifies the client hostname reported by the built-in DHCP server.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001467
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001468@item dhcpstart=@var{addr}
1469Specify the first of the 16 IPs the built-in DHCP server can assign. Default
Brad Hardsb0b36e52011-04-24 17:19:56 +10001470is 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 +02001471
1472@item dns=@var{addr}
1473Specify the guest-visible address of the virtual nameserver. The address must
1474be different from the host address. Default is the 3rd IP in the guest network,
1475i.e. x.x.x.3.
1476
Klaus Stengel63d29602012-10-27 19:53:39 +02001477@item dnssearch=@var{domain}
1478Provides an entry for the domain-search list sent by the built-in
1479DHCP server. More than one domain suffix can be transmitted by specifying
1480this option multiple times. If supported, this will cause the guest to
1481automatically try to append the given domain suffix(es) in case a domain name
1482can not be resolved.
1483
1484Example:
1485@example
1486qemu -net user,dnssearch=mgmt.example.org,dnssearch=example.org [...]
1487@end example
1488
Jan Kiszkaad196a92009-06-24 14:42:28 +02001489@item tftp=@var{dir}
1490When using the user mode network stack, activate a built-in TFTP
1491server. The files in @var{dir} will be exposed as the root of a TFTP server.
1492The TFTP client on the guest must be configured in binary mode (use the command
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001493@code{bin} of the Unix TFTP client).
Jan Kiszkaad196a92009-06-24 14:42:28 +02001494
1495@item bootfile=@var{file}
1496When using the user mode network stack, broadcast @var{file} as the BOOTP
1497filename. In conjunction with @option{tftp}, this can be used to network boot
1498a guest from a local directory.
1499
1500Example (using pxelinux):
1501@example
Stefan Weil3804da92012-05-11 22:21:50 +02001502qemu-system-i386 -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
Jan Kiszkaad196a92009-06-24 14:42:28 +02001503@end example
1504
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001505@item smb=@var{dir}[,smbserver=@var{addr}]
Jan Kiszkaad196a92009-06-24 14:42:28 +02001506When using the user mode network stack, activate a built-in SMB
1507server so that Windows OSes can access to the host files in @file{@var{dir}}
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001508transparently. The IP address of the SMB server can be set to @var{addr}. By
1509default the 4th IP in the guest network is used, i.e. x.x.x.4.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001510
1511In the guest Windows OS, the line:
1512@example
151310.0.2.4 smbserver
1514@end example
1515must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
1516or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
1517
1518Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
1519
Brade2d88302011-09-02 16:53:28 -04001520Note that a SAMBA server must be installed on the host OS.
1521QEMU was tested successfully with smbd versions from Red Hat 9,
1522Fedora Core 3 and OpenSUSE 11.x.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001523
Jan Kiszka3c6a0582009-06-24 14:42:28 +02001524@item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001525Redirect incoming TCP or UDP connections to the host port @var{hostport} to
1526the guest IP address @var{guestaddr} on guest port @var{guestport}. If
1527@var{guestaddr} is not specified, its value is x.x.x.15 (default first address
Jan Kiszka3c6a0582009-06-24 14:42:28 +02001528given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
1529be bound to a specific host interface. If no connection type is set, TCP is
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001530used. This option can be given multiple times.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001531
1532For example, to redirect host X11 connection from screen 1 to guest
1533screen 0, use the following:
1534
1535@example
1536# on the host
Stefan Weil3804da92012-05-11 22:21:50 +02001537qemu-system-i386 -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...]
Jan Kiszkaad196a92009-06-24 14:42:28 +02001538# this host xterm should open in the guest X11 server
1539xterm -display :1
1540@end example
1541
1542To redirect telnet connections from host port 5555 to telnet port on
1543the guest, use the following:
1544
1545@example
1546# on the host
Stefan Weil3804da92012-05-11 22:21:50 +02001547qemu-system-i386 -net user,hostfwd=tcp::5555-:23 [...]
Jan Kiszkaad196a92009-06-24 14:42:28 +02001548telnet localhost 5555
1549@end example
1550
1551Then when you use on the host @code{telnet localhost 5555}, you
1552connect to the guest telnet server.
1553
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001554@item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
Alexander Grafb412eb62012-06-03 09:45:01 +02001555@item guestfwd=[tcp]:@var{server}:@var{port}-@var{cmd:command}
Jan Kiszka3c6a0582009-06-24 14:42:28 +02001556Forward guest TCP connections to the IP address @var{server} on port @var{port}
Alexander Grafb412eb62012-06-03 09:45:01 +02001557to the character device @var{dev} or to a program executed by @var{cmd:command}
1558which gets spawned for each connection. This option can be given multiple times.
1559
Stefan Weil43ffe612012-07-20 23:26:02 +02001560You can either use a chardev directly and have that one used throughout QEMU's
Alexander Grafb412eb62012-06-03 09:45:01 +02001561lifetime, like in the following example:
1562
1563@example
1564# open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it whenever
1565# the guest accesses it
1566qemu -net user,guestfwd=tcp:10.0.2.100:1234-tcp:10.10.1.1:4321 [...]
1567@end example
1568
1569Or you can execute a command on every TCP connection established by the guest,
Stefan Weil43ffe612012-07-20 23:26:02 +02001570so that QEMU behaves similar to an inetd process for that virtual server:
Alexander Grafb412eb62012-06-03 09:45:01 +02001571
1572@example
1573# call "netcat 10.10.1.1 4321" on every TCP connection to 10.0.2.100:1234
1574# and connect the TCP stream to its stdin/stdout
1575qemu -net 'user,guestfwd=tcp:10.0.2.100:1234-cmd:netcat 10.10.1.1 4321'
1576@end example
Jan Kiszkaad196a92009-06-24 14:42:28 +02001577
1578@end table
1579
1580Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still
1581processed and applied to -net user. Mixing them with the new configuration
1582syntax gives undefined results. Their use for new applications is discouraged
1583as they will be removed from future versions.
blueswir15824d652009-03-28 06:44:27 +00001584
Stefan Hajnoczi08d12022012-08-14 14:14:27 +01001585@item -netdev tap,id=@var{id}[,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}]
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001586@item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}]
1587Connect the host TAP network interface @var{name} to VLAN @var{n}.
1588
1589Use the network script @var{file} to configure it and the network script
blueswir15824d652009-03-28 06:44:27 +00001590@var{dfile} to deconfigure it. If @var{name} is not provided, the OS
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001591automatically provides one. The default network configure script is
1592@file{/etc/qemu-ifup} and the default network deconfigure script is
1593@file{/etc/qemu-ifdown}. Use @option{script=no} or @option{downscript=no}
1594to disable script execution.
1595
1596If running QEMU as an unprivileged user, use the network helper
1597@var{helper} to configure the TAP interface. The default network
1598helper executable is @file{/usr/local/libexec/qemu-bridge-helper}.
1599
1600@option{fd}=@var{h} can be used to specify the handle of an already
1601opened host TAP interface.
1602
1603Examples:
blueswir15824d652009-03-28 06:44:27 +00001604
1605@example
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001606#launch a QEMU instance with the default network script
Stefan Weil3804da92012-05-11 22:21:50 +02001607qemu-system-i386 linux.img -net nic -net tap
blueswir15824d652009-03-28 06:44:27 +00001608@end example
1609
blueswir15824d652009-03-28 06:44:27 +00001610@example
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001611#launch a QEMU instance with two NICs, each one connected
1612#to a TAP device
Stefan Weil3804da92012-05-11 22:21:50 +02001613qemu-system-i386 linux.img \
1614 -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
1615 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
blueswir15824d652009-03-28 06:44:27 +00001616@end example
1617
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001618@example
1619#launch a QEMU instance with the default network helper to
1620#connect a TAP device to bridge br0
Stefan Weil3804da92012-05-11 22:21:50 +02001621qemu-system-i386 linux.img \
1622 -net nic -net tap,"helper=/usr/local/libexec/qemu-bridge-helper"
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001623@end example
1624
Stefan Hajnoczi08d12022012-08-14 14:14:27 +01001625@item -netdev bridge,id=@var{id}[,br=@var{bridge}][,helper=@var{helper}]
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001626@item -net bridge[,vlan=@var{n}][,name=@var{name}][,br=@var{bridge}][,helper=@var{helper}]
1627Connect a host TAP network interface to a host bridge device.
1628
1629Use the network helper @var{helper} to configure the TAP interface and
1630attach it to the bridge. The default network helper executable is
1631@file{/usr/local/libexec/qemu-bridge-helper} and the default bridge
1632device is @file{br0}.
1633
1634Examples:
1635
1636@example
1637#launch a QEMU instance with the default network helper to
1638#connect a TAP device to bridge br0
Stefan Weil3804da92012-05-11 22:21:50 +02001639qemu-system-i386 linux.img -net bridge -net nic,model=virtio
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001640@end example
1641
1642@example
1643#launch a QEMU instance with the default network helper to
1644#connect a TAP device to bridge qemubr0
Stefan Weil3804da92012-05-11 22:21:50 +02001645qemu-system-i386 linux.img -net bridge,br=qemubr0 -net nic,model=virtio
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001646@end example
1647
Stefan Hajnoczi08d12022012-08-14 14:14:27 +01001648@item -netdev socket,id=@var{id}[,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
Blue Swirl609c1da2010-03-18 18:41:49 +00001649@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 +00001650
1651Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
1652machine using a TCP socket connection. If @option{listen} is
1653specified, QEMU waits for incoming connections on @var{port}
1654(@var{host} is optional). @option{connect} is used to connect to
1655another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
1656specifies an already opened TCP socket.
1657
1658Example:
1659@example
1660# launch a first QEMU instance
Stefan Weil3804da92012-05-11 22:21:50 +02001661qemu-system-i386 linux.img \
1662 -net nic,macaddr=52:54:00:12:34:56 \
1663 -net socket,listen=:1234
blueswir15824d652009-03-28 06:44:27 +00001664# connect the VLAN 0 of this instance to the VLAN 0
1665# of the first instance
Stefan Weil3804da92012-05-11 22:21:50 +02001666qemu-system-i386 linux.img \
1667 -net nic,macaddr=52:54:00:12:34:57 \
1668 -net socket,connect=127.0.0.1:1234
blueswir15824d652009-03-28 06:44:27 +00001669@end example
1670
Stefan Hajnoczi08d12022012-08-14 14:14:27 +01001671@item -netdev socket,id=@var{id}[,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]]
Mike Ryan3a75e742010-12-01 11:16:47 -08001672@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 +00001673
1674Create a VLAN @var{n} shared with another QEMU virtual
1675machines using a UDP multicast socket, effectively making a bus for
1676every QEMU with same multicast address @var{maddr} and @var{port}.
1677NOTES:
1678@enumerate
1679@item
1680Several QEMU can be running on different hosts and share same bus (assuming
1681correct multicast setup for these hosts).
1682@item
1683mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
1684@url{http://user-mode-linux.sf.net}.
1685@item
1686Use @option{fd=h} to specify an already opened UDP multicast socket.
1687@end enumerate
1688
1689Example:
1690@example
1691# launch one QEMU instance
Stefan Weil3804da92012-05-11 22:21:50 +02001692qemu-system-i386 linux.img \
1693 -net nic,macaddr=52:54:00:12:34:56 \
1694 -net socket,mcast=230.0.0.1:1234
blueswir15824d652009-03-28 06:44:27 +00001695# launch another QEMU instance on same "bus"
Stefan Weil3804da92012-05-11 22:21:50 +02001696qemu-system-i386 linux.img \
1697 -net nic,macaddr=52:54:00:12:34:57 \
1698 -net socket,mcast=230.0.0.1:1234
blueswir15824d652009-03-28 06:44:27 +00001699# launch yet another QEMU instance on same "bus"
Stefan Weil3804da92012-05-11 22:21:50 +02001700qemu-system-i386 linux.img \
1701 -net nic,macaddr=52:54:00:12:34:58 \
1702 -net socket,mcast=230.0.0.1:1234
blueswir15824d652009-03-28 06:44:27 +00001703@end example
1704
1705Example (User Mode Linux compat.):
1706@example
1707# launch QEMU instance (note mcast address selected
1708# is UML's default)
Stefan Weil3804da92012-05-11 22:21:50 +02001709qemu-system-i386 linux.img \
1710 -net nic,macaddr=52:54:00:12:34:56 \
1711 -net socket,mcast=239.192.168.1:1102
blueswir15824d652009-03-28 06:44:27 +00001712# launch UML
1713/path/to/linux ubd0=/path/to/root_fs eth0=mcast
1714@end example
1715
Mike Ryan3a75e742010-12-01 11:16:47 -08001716Example (send packets from host's 1.2.3.4):
1717@example
Stefan Weil3804da92012-05-11 22:21:50 +02001718qemu-system-i386 linux.img \
1719 -net nic,macaddr=52:54:00:12:34:56 \
1720 -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4
Mike Ryan3a75e742010-12-01 11:16:47 -08001721@end example
1722
Stefan Hajnoczi08d12022012-08-14 14:14:27 +01001723@item -netdev vde,id=@var{id}[,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
Blue Swirl609c1da2010-03-18 18:41:49 +00001724@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 +00001725Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
1726listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
1727and MODE @var{octalmode} to change default ownership and permissions for
Stefan Weilc1ba4e02011-09-05 18:13:03 +02001728communication port. This option is only available if QEMU has been compiled
blueswir15824d652009-03-28 06:44:27 +00001729with vde support enabled.
1730
1731Example:
1732@example
1733# launch vde switch
1734vde_switch -F -sock /tmp/myswitch
1735# launch QEMU instance
Stefan Weil3804da92012-05-11 22:21:50 +02001736qemu-system-i386 linux.img -net nic -net vde,sock=/tmp/myswitch
blueswir15824d652009-03-28 06:44:27 +00001737@end example
1738
Stefan Hajnoczi40e8c262013-02-26 11:07:16 +01001739@item -netdev hubport,id=@var{id},hubid=@var{hubid}
1740
1741Create a hub port on QEMU "vlan" @var{hubid}.
1742
1743The hubport netdev lets you connect a NIC to a QEMU "vlan" instead of a single
1744netdev. @code{-net} and @code{-device} with parameter @option{vlan} create the
1745required hub automatically.
1746
aliguoribb9ea792009-04-21 19:56:28 +00001747@item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
1748Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
1749At most @var{len} bytes (64k by default) per packet are stored. The file format is
1750libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
1751
blueswir15824d652009-03-28 06:44:27 +00001752@item -net none
1753Indicate that no network devices should be configured. It is used to
1754override the default configuration (@option{-net nic -net user}) which
1755is activated if no @option{-net} options are provided.
blueswir15824d652009-03-28 06:44:27 +00001756ETEXI
1757
Markus Armbrusterc70a01e2013-02-13 19:49:40 +01001758STEXI
1759@end table
1760ETEXI
Matthew Booth7273a2d2009-10-30 13:41:12 +00001761DEFHEADING()
1762
1763DEFHEADING(Character device options:)
Markus Armbrusterc70a01e2013-02-13 19:49:40 +01001764STEXI
1765
1766The general form of a character device option is:
1767@table @option
1768ETEXI
Matthew Booth7273a2d2009-10-30 13:41:12 +00001769
1770DEF("chardev", HAS_ARG, QEMU_OPTION_chardev,
Jan Kiszka97331282010-04-06 16:55:54 +02001771 "-chardev null,id=id[,mux=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00001772 "-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n"
Jan Kiszka97331282010-04-06 16:55:54 +02001773 " [,server][,nowait][,telnet][,mux=on|off] (tcp)\n"
1774 "-chardev socket,id=id,path=path[,server][,nowait][,telnet],[mux=on|off] (unix)\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00001775 "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n"
Jan Kiszka97331282010-04-06 16:55:54 +02001776 " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n"
1777 "-chardev msmouse,id=id[,mux=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00001778 "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n"
Jan Kiszka97331282010-04-06 16:55:54 +02001779 " [,mux=on|off]\n"
Markus Armbruster3949e592013-02-06 21:27:24 +01001780 "-chardev ringbuf,id=id[,size=size]\n"
Jan Kiszka97331282010-04-06 16:55:54 +02001781 "-chardev file,id=id,path=path[,mux=on|off]\n"
1782 "-chardev pipe,id=id,path=path[,mux=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00001783#ifdef _WIN32
Jan Kiszka97331282010-04-06 16:55:54 +02001784 "-chardev console,id=id[,mux=on|off]\n"
1785 "-chardev serial,id=id,path=path[,mux=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00001786#else
Jan Kiszka97331282010-04-06 16:55:54 +02001787 "-chardev pty,id=id[,mux=on|off]\n"
Aurelien Jarnob7fdb3a2010-07-13 21:13:12 +02001788 "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00001789#endif
1790#ifdef CONFIG_BRLAPI
Jan Kiszka97331282010-04-06 16:55:54 +02001791 "-chardev braille,id=id[,mux=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00001792#endif
1793#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
1794 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
Gerd Hoffmannd59044e2012-12-19 13:50:29 +01001795 "-chardev serial,id=id,path=path[,mux=on|off]\n"
Jan Kiszka97331282010-04-06 16:55:54 +02001796 "-chardev tty,id=id,path=path[,mux=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00001797#endif
1798#if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__)
Gerd Hoffmann88a946d2013-01-10 14:20:58 +01001799 "-chardev parallel,id=id,path=path[,mux=on|off]\n"
Jan Kiszka97331282010-04-06 16:55:54 +02001800 "-chardev parport,id=id,path=path[,mux=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00001801#endif
Alon Levycbcc6332011-01-19 10:49:50 +02001802#if defined(CONFIG_SPICE)
1803 "-chardev spicevmc,id=id,name=name[,debug=debug]\n"
Marc-André Lureau5a49d3e2012-12-05 16:15:34 +01001804 "-chardev spiceport,id=id,name=name[,debug=debug]\n"
Alon Levycbcc6332011-01-19 10:49:50 +02001805#endif
Blue Swirlad960902010-03-29 19:23:52 +00001806 , QEMU_ARCH_ALL
Matthew Booth7273a2d2009-10-30 13:41:12 +00001807)
1808
1809STEXI
Jan Kiszka97331282010-04-06 16:55:54 +02001810@item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}]
Stefan Weil6616b2a2010-02-05 23:52:05 +01001811@findex -chardev
Matthew Booth7273a2d2009-10-30 13:41:12 +00001812Backend is one of:
1813@option{null},
1814@option{socket},
1815@option{udp},
1816@option{msmouse},
1817@option{vc},
Markus Armbruster3949e592013-02-06 21:27:24 +01001818@option{ringbuf},
Matthew Booth7273a2d2009-10-30 13:41:12 +00001819@option{file},
1820@option{pipe},
1821@option{console},
1822@option{serial},
1823@option{pty},
1824@option{stdio},
1825@option{braille},
1826@option{tty},
Gerd Hoffmann88a946d2013-01-10 14:20:58 +01001827@option{parallel},
Alon Levycbcc6332011-01-19 10:49:50 +02001828@option{parport},
1829@option{spicevmc}.
Marc-André Lureau5a49d3e2012-12-05 16:15:34 +01001830@option{spiceport}.
Matthew Booth7273a2d2009-10-30 13:41:12 +00001831The specific backend will determine the applicable options.
1832
1833All devices must have an id, which can be any string up to 127 characters long.
1834It is used to uniquely identify this device in other command line directives.
1835
Jan Kiszka97331282010-04-06 16:55:54 +02001836A character device may be used in multiplexing mode by multiple front-ends.
1837The key sequence of @key{Control-a} and @key{c} will rotate the input focus
1838between attached front-ends. Specify @option{mux=on} to enable this mode.
1839
Matthew Booth7273a2d2009-10-30 13:41:12 +00001840Options to each backend are described below.
1841
1842@item -chardev null ,id=@var{id}
1843A void device. This device will not emit any data, and will drop any data it
1844receives. The null backend does not take any options.
1845
1846@item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet]
1847
1848Create a two-way stream socket, which can be either a TCP or a unix socket. A
1849unix socket will be created if @option{path} is specified. Behaviour is
1850undefined if TCP options are specified for a unix socket.
1851
1852@option{server} specifies that the socket shall be a listening socket.
1853
1854@option{nowait} specifies that QEMU should not block waiting for a client to
1855connect to a listening socket.
1856
1857@option{telnet} specifies that traffic on the socket should interpret telnet
1858escape sequences.
1859
1860TCP and unix socket options are given below:
1861
1862@table @option
1863
Aurelien Jarno8d533562010-03-27 11:52:05 +01001864@item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay]
Matthew Booth7273a2d2009-10-30 13:41:12 +00001865
1866@option{host} for a listening socket specifies the local address to be bound.
1867For a connecting socket species the remote host to connect to. @option{host} is
1868optional for listening sockets. If not specified it defaults to @code{0.0.0.0}.
1869
1870@option{port} for a listening socket specifies the local port to be bound. For a
1871connecting socket specifies the port on the remote host to connect to.
1872@option{port} can be given as either a port number or a service name.
1873@option{port} is required.
1874
1875@option{to} is only relevant to listening sockets. If it is specified, and
1876@option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up
1877to and including @option{to} until it succeeds. @option{to} must be specified
1878as a port number.
1879
1880@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1881If neither is specified the socket may use either protocol.
1882
1883@option{nodelay} disables the Nagle algorithm.
1884
1885@item unix options: path=@var{path}
1886
1887@option{path} specifies the local path of the unix socket. @option{path} is
1888required.
1889
1890@end table
1891
1892@item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6]
1893
1894Sends all traffic from the guest to a remote host over UDP.
1895
1896@option{host} specifies the remote host to connect to. If not specified it
1897defaults to @code{localhost}.
1898
1899@option{port} specifies the port on the remote host to connect to. @option{port}
1900is required.
1901
1902@option{localaddr} specifies the local address to bind to. If not specified it
1903defaults to @code{0.0.0.0}.
1904
1905@option{localport} specifies the local port to bind to. If not specified any
1906available local port will be used.
1907
1908@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1909If neither is specified the device may use either protocol.
1910
1911@item -chardev msmouse ,id=@var{id}
1912
1913Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not
1914take any options.
1915
1916@item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]]
1917
1918Connect to a QEMU text console. @option{vc} may optionally be given a specific
1919size.
1920
1921@option{width} and @option{height} specify the width and height respectively of
1922the console, in pixels.
1923
1924@option{cols} and @option{rows} specify that the console be sized to fit a text
1925console with the given dimensions.
1926
Markus Armbruster3949e592013-02-06 21:27:24 +01001927@item -chardev ringbuf ,id=@var{id} [,size=@var{size}]
Lei Li51767e72013-01-25 00:03:19 +08001928
Markus Armbruster3949e592013-02-06 21:27:24 +01001929Create a ring buffer with fixed size @option{size}.
1930@var{size} must be a power of two, and defaults to @code{64K}).
Lei Li51767e72013-01-25 00:03:19 +08001931
Matthew Booth7273a2d2009-10-30 13:41:12 +00001932@item -chardev file ,id=@var{id} ,path=@var{path}
1933
1934Log all traffic received from the guest to a file.
1935
1936@option{path} specifies the path of the file to be opened. This file will be
1937created if it does not already exist, and overwritten if it does. @option{path}
1938is required.
1939
1940@item -chardev pipe ,id=@var{id} ,path=@var{path}
1941
1942Create a two-way connection to the guest. The behaviour differs slightly between
1943Windows hosts and other hosts:
1944
1945On Windows, a single duplex pipe will be created at
1946@file{\\.pipe\@option{path}}.
1947
1948On other hosts, 2 pipes will be created called @file{@option{path}.in} and
1949@file{@option{path}.out}. Data written to @file{@option{path}.in} will be
1950received by the guest. Data written by the guest can be read from
1951@file{@option{path}.out}. QEMU will not create these fifos, and requires them to
1952be present.
1953
1954@option{path} forms part of the pipe path as described above. @option{path} is
1955required.
1956
1957@item -chardev console ,id=@var{id}
1958
1959Send traffic from the guest to QEMU's standard output. @option{console} does not
1960take any options.
1961
1962@option{console} is only available on Windows hosts.
1963
1964@item -chardev serial ,id=@var{id} ,path=@option{path}
1965
1966Send traffic from the guest to a serial device on the host.
1967
Gerd Hoffmannd59044e2012-12-19 13:50:29 +01001968On Unix hosts serial will actually accept any tty device,
1969not only serial lines.
Matthew Booth7273a2d2009-10-30 13:41:12 +00001970
1971@option{path} specifies the name of the serial device to open.
1972
1973@item -chardev pty ,id=@var{id}
1974
1975Create a new pseudo-terminal on the host and connect to it. @option{pty} does
1976not take any options.
1977
1978@option{pty} is not available on Windows hosts.
1979
Aurelien Jarnob7fdb3a2010-07-13 21:13:12 +02001980@item -chardev stdio ,id=@var{id} [,signal=on|off]
Stefan Weilb65ee4f2012-05-11 22:25:50 +02001981Connect to standard input and standard output of the QEMU process.
Aurelien Jarnob7fdb3a2010-07-13 21:13:12 +02001982
1983@option{signal} controls if signals are enabled on the terminal, that includes
1984exiting QEMU with the key sequence @key{Control-c}. This option is enabled by
1985default, use @option{signal=off} to disable it.
1986
1987@option{stdio} is not available on Windows hosts.
Matthew Booth7273a2d2009-10-30 13:41:12 +00001988
1989@item -chardev braille ,id=@var{id}
1990
1991Connect to a local BrlAPI server. @option{braille} does not take any options.
1992
1993@item -chardev tty ,id=@var{id} ,path=@var{path}
1994
Matthew Booth7273a2d2009-10-30 13:41:12 +00001995@option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and
Markus Armbrusterd037d6b2013-02-13 15:54:15 +01001996DragonFlyBSD hosts. It is an alias for @option{serial}.
Matthew Booth7273a2d2009-10-30 13:41:12 +00001997
1998@option{path} specifies the path to the tty. @option{path} is required.
1999
Gerd Hoffmann88a946d2013-01-10 14:20:58 +01002000@item -chardev parallel ,id=@var{id} ,path=@var{path}
Matthew Booth7273a2d2009-10-30 13:41:12 +00002001@item -chardev parport ,id=@var{id} ,path=@var{path}
2002
Gerd Hoffmann88a946d2013-01-10 14:20:58 +01002003@option{parallel} is only available on Linux, FreeBSD and DragonFlyBSD hosts.
Matthew Booth7273a2d2009-10-30 13:41:12 +00002004
2005Connect to a local parallel port.
2006
2007@option{path} specifies the path to the parallel port device. @option{path} is
2008required.
2009
Alon Levycbcc6332011-01-19 10:49:50 +02002010@item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name}
2011
Stefan Hajnoczi3a846902011-10-06 11:24:12 +01002012@option{spicevmc} is only available when spice support is built in.
2013
Alon Levycbcc6332011-01-19 10:49:50 +02002014@option{debug} debug level for spicevmc
2015
2016@option{name} name of spice channel to connect to
2017
2018Connect to a spice virtual machine channel, such as vdiport.
Alon Levycbcc6332011-01-19 10:49:50 +02002019
Marc-André Lureau5a49d3e2012-12-05 16:15:34 +01002020@item -chardev spiceport ,id=@var{id} ,debug=@var{debug}, name=@var{name}
2021
2022@option{spiceport} is only available when spice support is built in.
2023
2024@option{debug} debug level for spicevmc
2025
2026@option{name} name of spice port to connect to
2027
2028Connect to a spice port, allowing a Spice client to handle the traffic
2029identified by a name (preferably a fqdn).
Matthew Booth7273a2d2009-10-30 13:41:12 +00002030ETEXI
2031
Markus Armbrusterc70a01e2013-02-13 19:49:40 +01002032STEXI
2033@end table
2034ETEXI
Matthew Booth7273a2d2009-10-30 13:41:12 +00002035DEFHEADING()
2036
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +11002037DEFHEADING(Device URL Syntax:)
Markus Armbrusterc70a01e2013-02-13 19:49:40 +01002038STEXI
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +11002039
2040In addition to using normal file images for the emulated storage devices,
2041QEMU can also use networked resources such as iSCSI devices. These are
2042specified using a special URL syntax.
2043
2044@table @option
2045@item iSCSI
2046iSCSI support allows QEMU to access iSCSI resources directly and use as
2047images for the guest storage. Both disk and cdrom images are supported.
2048
2049Syntax for specifying iSCSI LUNs is
2050``iscsi://<target-ip>[:<port>]/<target-iqn>/<lun>''
2051
Ronnie Sahlberg31459f42012-08-06 18:24:55 +10002052By default qemu will use the iSCSI initiator-name
2053'iqn.2008-11.org.linux-kvm[:<name>]' but this can also be set from the command
2054line or a configuration file.
2055
2056
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +11002057Example (without authentication):
2058@example
Stefan Weil3804da92012-05-11 22:21:50 +02002059qemu-system-i386 -iscsi initiator-name=iqn.2001-04.com.example:my-initiator \
2060 -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \
2061 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +11002062@end example
2063
2064Example (CHAP username/password via URL):
2065@example
Stefan Weil3804da92012-05-11 22:21:50 +02002066qemu-system-i386 -drive file=iscsi://user%password@@192.0.2.1/iqn.2001-04.com.example/1
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +11002067@end example
2068
2069Example (CHAP username/password via environment variables):
2070@example
2071LIBISCSI_CHAP_USERNAME="user" \
2072LIBISCSI_CHAP_PASSWORD="password" \
Stefan Weil3804da92012-05-11 22:21:50 +02002073qemu-system-i386 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +11002074@end example
2075
2076iSCSI support is an optional feature of QEMU and only available when
2077compiled and linked against libiscsi.
Ronnie Sahlbergf9dadc92012-01-26 09:39:02 +11002078ETEXI
2079DEF("iscsi", HAS_ARG, QEMU_OPTION_iscsi,
2080 "-iscsi [user=user][,password=password]\n"
2081 " [,header-digest=CRC32C|CR32C-NONE|NONE-CRC32C|NONE\n"
2082 " [,initiator-name=iqn]\n"
2083 " iSCSI session parameters\n", QEMU_ARCH_ALL)
2084STEXI
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +11002085
Ronnie Sahlberg31459f42012-08-06 18:24:55 +10002086iSCSI parameters such as username and password can also be specified via
2087a configuration file. See qemu-doc for more information and examples.
2088
Ronnie Sahlberg08ae3302011-10-27 20:33:21 +11002089@item NBD
2090QEMU supports NBD (Network Block Devices) both using TCP protocol as well
2091as Unix Domain Sockets.
2092
2093Syntax for specifying a NBD device using TCP
2094``nbd:<server-ip>:<port>[:exportname=<export>]''
2095
2096Syntax for specifying a NBD device using Unix Domain Sockets
2097``nbd:unix:<domain-socket>[:exportname=<export>]''
2098
2099
2100Example for TCP
2101@example
Stefan Weil3804da92012-05-11 22:21:50 +02002102qemu-system-i386 --drive file=nbd:192.0.2.1:30000
Ronnie Sahlberg08ae3302011-10-27 20:33:21 +11002103@end example
2104
2105Example for Unix Domain Sockets
2106@example
Stefan Weil3804da92012-05-11 22:21:50 +02002107qemu-system-i386 --drive file=nbd:unix:/tmp/nbd-socket
Ronnie Sahlberg08ae3302011-10-27 20:33:21 +11002108@end example
2109
Ronnie Sahlbergd9990222011-10-28 20:13:39 +11002110@item Sheepdog
2111Sheepdog is a distributed storage system for QEMU.
2112QEMU supports using either local sheepdog devices or remote networked
2113devices.
2114
2115Syntax for specifying a sheepdog device
MORITA Kazutaka5d6768e2013-02-22 12:39:51 +09002116@example
MORITA Kazutaka1b8bbb42013-02-22 12:39:53 +09002117sheepdog[+tcp|+unix]://[host:port]/vdiname[?socket=path][#snapid|#tag]
MORITA Kazutaka5d6768e2013-02-22 12:39:51 +09002118@end example
Ronnie Sahlbergd9990222011-10-28 20:13:39 +11002119
2120Example
2121@example
MORITA Kazutaka5d6768e2013-02-22 12:39:51 +09002122qemu-system-i386 --drive file=sheepdog://192.0.2.1:30000/MyVirtualMachine
Ronnie Sahlbergd9990222011-10-28 20:13:39 +11002123@end example
2124
2125See also @url{http://http://www.osrg.net/sheepdog/}.
2126
Bharata B Rao8809e282012-10-24 17:17:53 +05302127@item GlusterFS
2128GlusterFS is an user space distributed file system.
2129QEMU supports the use of GlusterFS volumes for hosting VM disk images using
2130TCP, Unix Domain Sockets and RDMA transport protocols.
2131
2132Syntax for specifying a VM disk image on GlusterFS volume is
2133@example
2134gluster[+transport]://[server[:port]]/volname/image[?socket=...]
2135@end example
2136
2137
2138Example
2139@example
Lei Lidb2d5eb2013-03-07 15:50:26 +08002140qemu-system-x86_64 --drive file=gluster://192.0.2.1/testvol/a.img
Bharata B Rao8809e282012-10-24 17:17:53 +05302141@end example
2142
2143See also @url{http://www.gluster.org}.
Markus Armbrusterc70a01e2013-02-13 19:49:40 +01002144ETEXI
2145
2146STEXI
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +11002147@end table
2148ETEXI
2149
Matthew Booth7273a2d2009-10-30 13:41:12 +00002150DEFHEADING(Bluetooth(R) options:)
Markus Armbrusterc70a01e2013-02-13 19:49:40 +01002151STEXI
2152@table @option
2153ETEXI
Matthew Booth7273a2d2009-10-30 13:41:12 +00002154
blueswir15824d652009-03-28 06:44:27 +00002155DEF("bt", HAS_ARG, QEMU_OPTION_bt, \
blueswir15824d652009-03-28 06:44:27 +00002156 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \
2157 "-bt hci,host[:id]\n" \
2158 " use host's HCI with the given name\n" \
2159 "-bt hci[,vlan=n]\n" \
2160 " emulate a standard HCI in virtual scatternet 'n'\n" \
2161 "-bt vhci[,vlan=n]\n" \
2162 " add host computer to virtual scatternet 'n' using VHCI\n" \
2163 "-bt device:dev[,vlan=n]\n" \
Blue Swirlad960902010-03-29 19:23:52 +00002164 " emulate a bluetooth device 'dev' in scatternet 'n'\n",
2165 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002166STEXI
blueswir15824d652009-03-28 06:44:27 +00002167@item -bt hci[...]
Stefan Weil6616b2a2010-02-05 23:52:05 +01002168@findex -bt
blueswir15824d652009-03-28 06:44:27 +00002169Defines the function of the corresponding Bluetooth HCI. -bt options
2170are matched with the HCIs present in the chosen machine type. For
2171example when emulating a machine with only one HCI built into it, only
2172the first @code{-bt hci[...]} option is valid and defines the HCI's
2173logic. The Transport Layer is decided by the machine type. Currently
2174the machines @code{n800} and @code{n810} have one HCI and all other
2175machines have none.
2176
2177@anchor{bt-hcis}
2178The following three types are recognized:
2179
Kevin Wolfb3f046c2009-10-09 10:58:35 +02002180@table @option
blueswir15824d652009-03-28 06:44:27 +00002181@item -bt hci,null
2182(default) The corresponding Bluetooth HCI assumes no internal logic
2183and will not respond to any HCI commands or emit events.
2184
2185@item -bt hci,host[:@var{id}]
2186(@code{bluez} only) The corresponding HCI passes commands / events
2187to / from the physical HCI identified by the name @var{id} (default:
2188@code{hci0}) on the computer running QEMU. Only available on @code{bluez}
2189capable systems like Linux.
2190
2191@item -bt hci[,vlan=@var{n}]
2192Add a virtual, standard HCI that will participate in the Bluetooth
2193scatternet @var{n} (default @code{0}). Similarly to @option{-net}
2194VLANs, devices inside a bluetooth network @var{n} can only communicate
2195with other devices in the same network (scatternet).
2196@end table
2197
2198@item -bt vhci[,vlan=@var{n}]
2199(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
2200to the host bluetooth stack instead of to the emulated target. This
2201allows the host and target machines to participate in a common scatternet
2202and communicate. Requires the Linux @code{vhci} driver installed. Can
2203be used as following:
2204
2205@example
Stefan Weil3804da92012-05-11 22:21:50 +02002206qemu-system-i386 [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
blueswir15824d652009-03-28 06:44:27 +00002207@end example
2208
2209@item -bt device:@var{dev}[,vlan=@var{n}]
2210Emulate a bluetooth device @var{dev} and place it in network @var{n}
2211(default @code{0}). QEMU can only emulate one type of bluetooth devices
2212currently:
2213
Kevin Wolfb3f046c2009-10-09 10:58:35 +02002214@table @option
blueswir15824d652009-03-28 06:44:27 +00002215@item keyboard
2216Virtual wireless keyboard implementing the HIDP bluetooth profile.
2217@end table
blueswir15824d652009-03-28 06:44:27 +00002218ETEXI
2219
Markus Armbrusterc70a01e2013-02-13 19:49:40 +01002220STEXI
2221@end table
2222ETEXI
blueswir15824d652009-03-28 06:44:27 +00002223DEFHEADING()
2224
Stefan Bergerd1a0cf72013-02-27 12:47:49 -05002225#ifdef CONFIG_TPM
2226DEFHEADING(TPM device options:)
2227
2228DEF("tpmdev", HAS_ARG, QEMU_OPTION_tpmdev, \
Stefan Berger92dcc232013-02-27 12:47:54 -05002229 "-tpmdev passthrough,id=id[,path=path][,cancel-path=path]\n"
2230 " use path to provide path to a character device; default is /dev/tpm0\n"
2231 " use cancel-path to provide path to TPM's cancel sysfs entry; if\n"
2232 " not provided it will be searched for in /sys/class/misc/tpm?/device\n",
Stefan Bergerd1a0cf72013-02-27 12:47:49 -05002233 QEMU_ARCH_ALL)
2234STEXI
2235
2236The general form of a TPM device option is:
2237@table @option
2238
2239@item -tpmdev @var{backend} ,id=@var{id} [,@var{options}]
2240@findex -tpmdev
2241Backend type must be:
Stefan Berger4549a8b2013-02-27 12:47:53 -05002242@option{passthrough}.
Stefan Bergerd1a0cf72013-02-27 12:47:49 -05002243
2244The specific backend type will determine the applicable options.
Corey Bryant28c4fa32013-03-20 12:34:49 -04002245The @code{-tpmdev} option creates the TPM backend and requires a
2246@code{-device} option that specifies the TPM frontend interface model.
Stefan Bergerd1a0cf72013-02-27 12:47:49 -05002247
2248Options to each backend are described below.
2249
2250Use 'help' to print all available TPM backend types.
2251@example
2252qemu -tpmdev help
2253@end example
2254
Stefan Berger92dcc232013-02-27 12:47:54 -05002255@item -tpmdev passthrough, id=@var{id}, path=@var{path}, cancel-path=@var{cancel-path}
Stefan Berger4549a8b2013-02-27 12:47:53 -05002256
2257(Linux-host only) Enable access to the host's TPM using the passthrough
2258driver.
2259
2260@option{path} specifies the path to the host's TPM device, i.e., on
2261a Linux host this would be @code{/dev/tpm0}.
2262@option{path} is optional and by default @code{/dev/tpm0} is used.
2263
Stefan Berger92dcc232013-02-27 12:47:54 -05002264@option{cancel-path} specifies the path to the host TPM device's sysfs
2265entry allowing for cancellation of an ongoing TPM command.
2266@option{cancel-path} is optional and by default QEMU will search for the
2267sysfs entry to use.
2268
Stefan Berger4549a8b2013-02-27 12:47:53 -05002269Some notes about using the host's TPM with the passthrough driver:
2270
2271The TPM device accessed by the passthrough driver must not be
2272used by any other application on the host.
2273
2274Since the host's firmware (BIOS/UEFI) has already initialized the TPM,
2275the VM's firmware (BIOS/UEFI) will not be able to initialize the
2276TPM again and may therefore not show a TPM-specific menu that would
2277otherwise allow the user to configure the TPM, e.g., allow the user to
2278enable/disable or activate/deactivate the TPM.
2279Further, if TPM ownership is released from within a VM then the host's TPM
2280will get disabled and deactivated. To enable and activate the
2281TPM again afterwards, the host has to be rebooted and the user is
2282required to enter the firmware's menu to enable and activate the TPM.
2283If the TPM is left disabled and/or deactivated most TPM commands will fail.
2284
2285To create a passthrough TPM use the following two options:
2286@example
2287-tpmdev passthrough,id=tpm0 -device tpm-tis,tpmdev=tpm0
2288@end example
2289Note that the @code{-tpmdev} id is @code{tpm0} and is referenced by
2290@code{tpmdev=tpm0} in the device option.
2291
Stefan Bergerd1a0cf72013-02-27 12:47:49 -05002292@end table
2293
2294ETEXI
2295
2296DEFHEADING()
2297
2298#endif
2299
Alexander Graf7677f052009-06-28 16:55:55 +02002300DEFHEADING(Linux/Multiboot boot specific:)
blueswir15824d652009-03-28 06:44:27 +00002301STEXI
Alexander Graf7677f052009-06-28 16:55:55 +02002302
2303When using these options, you can use a given Linux or Multiboot
2304kernel without installing it in the disk image. It can be useful
blueswir15824d652009-03-28 06:44:27 +00002305for easier testing of various kernels.
2306
2307@table @option
2308ETEXI
2309
2310DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \
Blue Swirlad960902010-03-29 19:23:52 +00002311 "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002312STEXI
2313@item -kernel @var{bzImage}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002314@findex -kernel
Alexander Graf7677f052009-06-28 16:55:55 +02002315Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel
2316or in multiboot format.
blueswir15824d652009-03-28 06:44:27 +00002317ETEXI
2318
2319DEF("append", HAS_ARG, QEMU_OPTION_append, \
Blue Swirlad960902010-03-29 19:23:52 +00002320 "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002321STEXI
2322@item -append @var{cmdline}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002323@findex -append
blueswir15824d652009-03-28 06:44:27 +00002324Use @var{cmdline} as kernel command line
2325ETEXI
2326
2327DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \
Blue Swirlad960902010-03-29 19:23:52 +00002328 "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002329STEXI
2330@item -initrd @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002331@findex -initrd
blueswir15824d652009-03-28 06:44:27 +00002332Use @var{file} as initial ram disk.
Alexander Graf7677f052009-06-28 16:55:55 +02002333
2334@item -initrd "@var{file1} arg=foo,@var{file2}"
2335
2336This syntax is only available with multiboot.
2337
2338Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the
2339first module.
blueswir15824d652009-03-28 06:44:27 +00002340ETEXI
2341
Grant Likely412beee2012-03-02 11:56:38 +00002342DEF("dtb", HAS_ARG, QEMU_OPTION_dtb, \
Peter A. G. Crosthwaite379b5c72012-03-04 21:03:54 +10002343 "-dtb file use 'file' as device tree image\n", QEMU_ARCH_ALL)
Grant Likely412beee2012-03-02 11:56:38 +00002344STEXI
2345@item -dtb @var{file}
2346@findex -dtb
2347Use @var{file} as a device tree binary (dtb) image and pass it to the kernel
2348on boot.
2349ETEXI
2350
blueswir15824d652009-03-28 06:44:27 +00002351STEXI
2352@end table
2353ETEXI
blueswir15824d652009-03-28 06:44:27 +00002354DEFHEADING()
2355
2356DEFHEADING(Debug/Expert options:)
blueswir15824d652009-03-28 06:44:27 +00002357STEXI
2358@table @option
2359ETEXI
2360
2361DEF("serial", HAS_ARG, QEMU_OPTION_serial, \
Blue Swirlad960902010-03-29 19:23:52 +00002362 "-serial dev redirect the serial port to char device 'dev'\n",
2363 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002364STEXI
2365@item -serial @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002366@findex -serial
blueswir15824d652009-03-28 06:44:27 +00002367Redirect the virtual serial port to host character device
2368@var{dev}. The default device is @code{vc} in graphical mode and
2369@code{stdio} in non graphical mode.
2370
2371This option can be used several times to simulate up to 4 serial
2372ports.
2373
2374Use @code{-serial none} to disable all serial ports.
2375
2376Available character devices are:
Kevin Wolfb3f046c2009-10-09 10:58:35 +02002377@table @option
Kevin Wolf4e257e52009-10-09 10:58:36 +02002378@item vc[:@var{W}x@var{H}]
blueswir15824d652009-03-28 06:44:27 +00002379Virtual console. Optionally, a width and height can be given in pixel with
2380@example
2381vc:800x600
2382@end example
2383It is also possible to specify width or height in characters:
2384@example
2385vc:80Cx24C
2386@end example
2387@item pty
2388[Linux only] Pseudo TTY (a new PTY is automatically allocated)
2389@item none
2390No device is allocated.
2391@item null
2392void device
2393@item /dev/XXX
2394[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
2395parameters are set according to the emulated ones.
2396@item /dev/parport@var{N}
2397[Linux only, parallel port only] Use host parallel port
2398@var{N}. Currently SPP and EPP parallel port features can be used.
2399@item file:@var{filename}
2400Write output to @var{filename}. No character can be read.
2401@item stdio
2402[Unix only] standard input/output
2403@item pipe:@var{filename}
2404name pipe @var{filename}
2405@item COM@var{n}
2406[Windows only] Use host serial port @var{n}
2407@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
2408This implements UDP Net Console.
2409When @var{remote_host} or @var{src_ip} are not specified
2410they default to @code{0.0.0.0}.
2411When not using a specified @var{src_port} a random port is automatically chosen.
blueswir15824d652009-03-28 06:44:27 +00002412
2413If you just want a simple readonly console you can use @code{netcat} or
Stefan Weilb65ee4f2012-05-11 22:25:50 +02002414@code{nc}, by starting QEMU with: @code{-serial udp::4555} and nc as:
2415@code{nc -u -l -p 4555}. Any time QEMU writes something to that port it
blueswir15824d652009-03-28 06:44:27 +00002416will appear in the netconsole session.
2417
2418If you plan to send characters back via netconsole or you want to stop
Stefan Weilb65ee4f2012-05-11 22:25:50 +02002419and start QEMU a lot of times, you should have QEMU use the same
blueswir15824d652009-03-28 06:44:27 +00002420source port each time by using something like @code{-serial
Stefan Weilb65ee4f2012-05-11 22:25:50 +02002421udp::4555@@:4556} to QEMU. Another approach is to use a patched
blueswir15824d652009-03-28 06:44:27 +00002422version of netcat which can listen to a TCP port and send and receive
2423characters via udp. If you have a patched version of netcat which
2424activates telnet remote echo and single char transfer, then you can
2425use the following options to step up a netcat redirector to allow
Stefan Weilb65ee4f2012-05-11 22:25:50 +02002426telnet on port 5555 to access the QEMU port.
blueswir15824d652009-03-28 06:44:27 +00002427@table @code
Stefan Weil071c9392012-04-07 09:23:36 +02002428@item QEMU Options:
blueswir15824d652009-03-28 06:44:27 +00002429-serial udp::4555@@:4556
2430@item netcat options:
2431-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
2432@item telnet options:
2433localhost 5555
2434@end table
2435
2436@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay]
2437The TCP Net Console has two modes of operation. It can send the serial
2438I/O to a location or wait for a connection from a location. By default
2439the TCP Net Console is sent to @var{host} at the @var{port}. If you use
2440the @var{server} option QEMU will wait for a client socket application
2441to connect to the port before continuing, unless the @code{nowait}
2442option was specified. The @code{nodelay} option disables the Nagle buffering
2443algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only
2444one TCP connection at a time is accepted. You can use @code{telnet} to
2445connect to the corresponding character device.
2446@table @code
2447@item Example to send tcp console to 192.168.0.2 port 4444
2448-serial tcp:192.168.0.2:4444
2449@item Example to listen and wait on port 4444 for connection
2450-serial tcp::4444,server
2451@item Example to not wait and listen on ip 192.168.0.100 port 4444
2452-serial tcp:192.168.0.100:4444,server,nowait
2453@end table
2454
2455@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
2456The telnet protocol is used instead of raw tcp sockets. The options
2457work the same as if you had specified @code{-serial tcp}. The
2458difference is that the port acts like a telnet server or client using
2459telnet option negotiation. This will also allow you to send the
2460MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
2461sequence. Typically in unix telnet you do it with Control-] and then
2462type "send break" followed by pressing the enter key.
2463
2464@item unix:@var{path}[,server][,nowait]
2465A unix domain socket is used instead of a tcp socket. The option works the
2466same as if you had specified @code{-serial tcp} except the unix domain socket
2467@var{path} is used for connections.
2468
2469@item mon:@var{dev_string}
2470This is a special option to allow the monitor to be multiplexed onto
2471another serial port. The monitor is accessed with key sequence of
2472@key{Control-a} and then pressing @key{c}. See monitor access
2473@ref{pcsys_keys} in the -nographic section for more keys.
2474@var{dev_string} should be any one of the serial devices specified
2475above. An example to multiplex the monitor onto a telnet server
2476listening on port 4444 would be:
2477@table @code
2478@item -serial mon:telnet::4444,server,nowait
2479@end table
2480
2481@item braille
2482Braille device. This will use BrlAPI to display the braille output on a real
2483or fake device.
2484
Kevin Wolfbe8b28a2009-10-09 10:58:37 +02002485@item msmouse
2486Three button serial mouse. Configure the guest to use Microsoft protocol.
blueswir15824d652009-03-28 06:44:27 +00002487@end table
2488ETEXI
2489
2490DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \
Blue Swirlad960902010-03-29 19:23:52 +00002491 "-parallel dev redirect the parallel port to char device 'dev'\n",
2492 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002493STEXI
2494@item -parallel @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002495@findex -parallel
blueswir15824d652009-03-28 06:44:27 +00002496Redirect the virtual parallel port to host device @var{dev} (same
2497devices as the serial port). On Linux hosts, @file{/dev/parportN} can
2498be used to use hardware devices connected on the corresponding host
2499parallel port.
2500
2501This option can be used several times to simulate up to 3 parallel
2502ports.
2503
2504Use @code{-parallel none} to disable all parallel ports.
2505ETEXI
2506
2507DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \
Blue Swirlad960902010-03-29 19:23:52 +00002508 "-monitor dev redirect the monitor to char device 'dev'\n",
2509 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002510STEXI
Gerd Hoffmann4e307fc2009-12-08 13:11:37 +01002511@item -monitor @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002512@findex -monitor
blueswir15824d652009-03-28 06:44:27 +00002513Redirect the monitor to host device @var{dev} (same devices as the
2514serial port).
2515The default device is @code{vc} in graphical mode and @code{stdio} in
2516non graphical mode.
2517ETEXI
Gerd Hoffmann6ca55822009-12-08 13:11:52 +01002518DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \
Blue Swirlad960902010-03-29 19:23:52 +00002519 "-qmp dev like -monitor but opens in 'control' mode\n",
2520 QEMU_ARCH_ALL)
Stefan Weil95d5f082010-01-20 22:25:27 +01002521STEXI
2522@item -qmp @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002523@findex -qmp
Stefan Weil95d5f082010-01-20 22:25:27 +01002524Like -monitor but opens in 'control' mode.
2525ETEXI
blueswir15824d652009-03-28 06:44:27 +00002526
Gerd Hoffmann22a0e042009-12-08 13:11:51 +01002527DEF("mon", HAS_ARG, QEMU_OPTION_mon, \
Blue Swirlad960902010-03-29 19:23:52 +00002528 "-mon chardev=[name][,mode=readline|control][,default]\n", QEMU_ARCH_ALL)
Gerd Hoffmann22a0e042009-12-08 13:11:51 +01002529STEXI
2530@item -mon chardev=[name][,mode=readline|control][,default]
Stefan Weil6616b2a2010-02-05 23:52:05 +01002531@findex -mon
Gerd Hoffmann22a0e042009-12-08 13:11:51 +01002532Setup monitor on chardev @var{name}.
2533ETEXI
2534
H. Peter Anvinc9f398e2009-12-29 13:51:36 -08002535DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \
Blue Swirlad960902010-03-29 19:23:52 +00002536 "-debugcon dev redirect the debug console to char device 'dev'\n",
2537 QEMU_ARCH_ALL)
H. Peter Anvinc9f398e2009-12-29 13:51:36 -08002538STEXI
2539@item -debugcon @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002540@findex -debugcon
H. Peter Anvinc9f398e2009-12-29 13:51:36 -08002541Redirect the debug console to host device @var{dev} (same devices as the
2542serial port). The debug console is an I/O port which is typically port
25430xe9; writing to that I/O port sends output to this device.
2544The default device is @code{vc} in graphical mode and @code{stdio} in
2545non graphical mode.
2546ETEXI
2547
blueswir15824d652009-03-28 06:44:27 +00002548DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \
Blue Swirlad960902010-03-29 19:23:52 +00002549 "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002550STEXI
2551@item -pidfile @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002552@findex -pidfile
blueswir15824d652009-03-28 06:44:27 +00002553Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
2554from a script.
2555ETEXI
2556
aurel321b530a62009-04-05 20:08:59 +00002557DEF("singlestep", 0, QEMU_OPTION_singlestep, \
Blue Swirlad960902010-03-29 19:23:52 +00002558 "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL)
aurel321b530a62009-04-05 20:08:59 +00002559STEXI
2560@item -singlestep
Stefan Weil6616b2a2010-02-05 23:52:05 +01002561@findex -singlestep
aurel321b530a62009-04-05 20:08:59 +00002562Run the emulation in single step mode.
2563ETEXI
2564
blueswir15824d652009-03-28 06:44:27 +00002565DEF("S", 0, QEMU_OPTION_S, \
Blue Swirlad960902010-03-29 19:23:52 +00002566 "-S freeze CPU at startup (use 'c' to start execution)\n",
2567 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002568STEXI
2569@item -S
Stefan Weil6616b2a2010-02-05 23:52:05 +01002570@findex -S
blueswir15824d652009-03-28 06:44:27 +00002571Do not start CPU at startup (you must type 'c' in the monitor).
2572ETEXI
2573
aliguori59030a82009-04-05 18:43:41 +00002574DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \
Blue Swirlad960902010-03-29 19:23:52 +00002575 "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002576STEXI
aliguori59030a82009-04-05 18:43:41 +00002577@item -gdb @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002578@findex -gdb
aliguori59030a82009-04-05 18:43:41 +00002579Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical
2580connections will likely be TCP-based, but also UDP, pseudo TTY, or even
Stefan Weilb65ee4f2012-05-11 22:25:50 +02002581stdio are reasonable use case. The latter is allowing to start QEMU from
aliguori59030a82009-04-05 18:43:41 +00002582within gdb and establish the connection via a pipe:
2583@example
Stefan Weil3804da92012-05-11 22:21:50 +02002584(gdb) target remote | exec qemu-system-i386 -gdb stdio ...
aliguori59030a82009-04-05 18:43:41 +00002585@end example
blueswir15824d652009-03-28 06:44:27 +00002586ETEXI
2587
aliguori59030a82009-04-05 18:43:41 +00002588DEF("s", 0, QEMU_OPTION_s, \
Blue Swirlad960902010-03-29 19:23:52 +00002589 "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n",
2590 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002591STEXI
aliguori59030a82009-04-05 18:43:41 +00002592@item -s
Stefan Weil6616b2a2010-02-05 23:52:05 +01002593@findex -s
aliguori59030a82009-04-05 18:43:41 +00002594Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
2595(@pxref{gdb_usage}).
blueswir15824d652009-03-28 06:44:27 +00002596ETEXI
2597
2598DEF("d", HAS_ARG, QEMU_OPTION_d, \
Peter Maydell989b6972013-02-26 17:52:40 +00002599 "-d item1,... enable logging of specified items (use '-d help' for a list of log items)\n",
Blue Swirlad960902010-03-29 19:23:52 +00002600 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002601STEXI
Peter Maydell989b6972013-02-26 17:52:40 +00002602@item -d @var{item1}[,...]
Stefan Weil6616b2a2010-02-05 23:52:05 +01002603@findex -d
Peter Maydell989b6972013-02-26 17:52:40 +00002604Enable logging of specified items. Use '-d help' for a list of log items.
blueswir15824d652009-03-28 06:44:27 +00002605ETEXI
2606
Matthew Fernandezc235d732011-06-07 16:32:40 +00002607DEF("D", HAS_ARG, QEMU_OPTION_D, \
Peter Maydell989b6972013-02-26 17:52:40 +00002608 "-D logfile output log to logfile (default stderr)\n",
Matthew Fernandezc235d732011-06-07 16:32:40 +00002609 QEMU_ARCH_ALL)
2610STEXI
Stefan Weil8bd383b2012-05-11 22:40:50 +02002611@item -D @var{logfile}
Matthew Fernandezc235d732011-06-07 16:32:40 +00002612@findex -D
Peter Maydell989b6972013-02-26 17:52:40 +00002613Output log in @var{logfile} instead of to stderr
Matthew Fernandezc235d732011-06-07 16:32:40 +00002614ETEXI
2615
blueswir15824d652009-03-28 06:44:27 +00002616DEF("L", HAS_ARG, QEMU_OPTION_L, \
Blue Swirlad960902010-03-29 19:23:52 +00002617 "-L path set the directory for the BIOS, VGA BIOS and keymaps\n",
2618 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002619STEXI
2620@item -L @var{path}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002621@findex -L
blueswir15824d652009-03-28 06:44:27 +00002622Set the directory for the BIOS, VGA BIOS and keymaps.
2623ETEXI
2624
2625DEF("bios", HAS_ARG, QEMU_OPTION_bios, \
Blue Swirlad960902010-03-29 19:23:52 +00002626 "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002627STEXI
2628@item -bios @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002629@findex -bios
blueswir15824d652009-03-28 06:44:27 +00002630Set the filename for the BIOS.
2631ETEXI
2632
blueswir15824d652009-03-28 06:44:27 +00002633DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \
Blue Swirlad960902010-03-29 19:23:52 +00002634 "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002635STEXI
2636@item -enable-kvm
Stefan Weil6616b2a2010-02-05 23:52:05 +01002637@findex -enable-kvm
blueswir15824d652009-03-28 06:44:27 +00002638Enable KVM full virtualization support. This option is only available
2639if KVM support is enabled when compiling.
2640ETEXI
2641
aliguorie37630c2009-04-22 15:19:10 +00002642DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid,
Blue Swirlad960902010-03-29 19:23:52 +00002643 "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL)
aliguorie37630c2009-04-22 15:19:10 +00002644DEF("xen-create", 0, QEMU_OPTION_xen_create,
2645 "-xen-create create domain using xen hypercalls, bypassing xend\n"
Blue Swirlad960902010-03-29 19:23:52 +00002646 " warning: should not be used when xend is in use\n",
2647 QEMU_ARCH_ALL)
aliguorie37630c2009-04-22 15:19:10 +00002648DEF("xen-attach", 0, QEMU_OPTION_xen_attach,
2649 "-xen-attach attach to existing xen domain\n"
Stefan Weilb65ee4f2012-05-11 22:25:50 +02002650 " xend will use this when starting QEMU\n",
Blue Swirlad960902010-03-29 19:23:52 +00002651 QEMU_ARCH_ALL)
Stefan Weil95d5f082010-01-20 22:25:27 +01002652STEXI
2653@item -xen-domid @var{id}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002654@findex -xen-domid
Stefan Weil95d5f082010-01-20 22:25:27 +01002655Specify xen guest domain @var{id} (XEN only).
2656@item -xen-create
Stefan Weil6616b2a2010-02-05 23:52:05 +01002657@findex -xen-create
Stefan Weil95d5f082010-01-20 22:25:27 +01002658Create domain using xen hypercalls, bypassing xend.
2659Warning: should not be used when xend is in use (XEN only).
2660@item -xen-attach
Stefan Weil6616b2a2010-02-05 23:52:05 +01002661@findex -xen-attach
Stefan Weil95d5f082010-01-20 22:25:27 +01002662Attach to existing xen domain.
Stefan Weilb65ee4f2012-05-11 22:25:50 +02002663xend will use this when starting QEMU (XEN only).
Stefan Weil95d5f082010-01-20 22:25:27 +01002664ETEXI
aliguorie37630c2009-04-22 15:19:10 +00002665
blueswir15824d652009-03-28 06:44:27 +00002666DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \
Blue Swirlad960902010-03-29 19:23:52 +00002667 "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002668STEXI
2669@item -no-reboot
Stefan Weil6616b2a2010-02-05 23:52:05 +01002670@findex -no-reboot
blueswir15824d652009-03-28 06:44:27 +00002671Exit instead of rebooting.
2672ETEXI
2673
2674DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \
Blue Swirlad960902010-03-29 19:23:52 +00002675 "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002676STEXI
2677@item -no-shutdown
Stefan Weil6616b2a2010-02-05 23:52:05 +01002678@findex -no-shutdown
blueswir15824d652009-03-28 06:44:27 +00002679Don't exit QEMU on guest shutdown, but instead only stop the emulation.
2680This allows for instance switching to monitor to commit changes to the
2681disk image.
2682ETEXI
2683
2684DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \
2685 "-loadvm [tag|id]\n" \
Blue Swirlad960902010-03-29 19:23:52 +00002686 " start right away with a saved state (loadvm in monitor)\n",
2687 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002688STEXI
2689@item -loadvm @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002690@findex -loadvm
blueswir15824d652009-03-28 06:44:27 +00002691Start right away with a saved state (@code{loadvm} in monitor)
2692ETEXI
2693
2694#ifndef _WIN32
2695DEF("daemonize", 0, QEMU_OPTION_daemonize, \
Blue Swirlad960902010-03-29 19:23:52 +00002696 "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002697#endif
2698STEXI
2699@item -daemonize
Stefan Weil6616b2a2010-02-05 23:52:05 +01002700@findex -daemonize
blueswir15824d652009-03-28 06:44:27 +00002701Daemonize the QEMU process after initialization. QEMU will not detach from
2702standard IO until it is ready to receive connections on any of its devices.
2703This option is a useful way for external programs to launch QEMU without having
2704to cope with initialization race conditions.
2705ETEXI
2706
2707DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \
Blue Swirlad960902010-03-29 19:23:52 +00002708 "-option-rom rom load a file, rom, into the option ROM space\n",
2709 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002710STEXI
2711@item -option-rom @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002712@findex -option-rom
blueswir15824d652009-03-28 06:44:27 +00002713Load the contents of @var{file} as an option ROM.
2714This option is useful to load things like EtherBoot.
2715ETEXI
2716
2717DEF("clock", HAS_ARG, QEMU_OPTION_clock, \
2718 "-clock force the use of the given methods for timer alarm.\n" \
Peter Maydell585f6032012-10-04 16:22:01 +01002719 " To see what timers are available use '-clock help'\n",
Blue Swirlad960902010-03-29 19:23:52 +00002720 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002721STEXI
2722@item -clock @var{method}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002723@findex -clock
blueswir15824d652009-03-28 06:44:27 +00002724Force the use of the given methods for timer alarm. To see what timers
Peter Maydell585f6032012-10-04 16:22:01 +01002725are available use @code{-clock help}.
blueswir15824d652009-03-28 06:44:27 +00002726ETEXI
2727
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02002728HXCOMM Options deprecated by -rtc
Blue Swirlad960902010-03-29 19:23:52 +00002729DEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL)
2730DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002731
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02002732DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \
Paolo Bonzini78808142012-03-30 10:31:21 +00002733 "-rtc [base=utc|localtime|date][,clock=host|rt|vm][,driftfix=none|slew]\n" \
Blue Swirlad960902010-03-29 19:23:52 +00002734 " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n",
2735 QEMU_ARCH_ALL)
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02002736
blueswir15824d652009-03-28 06:44:27 +00002737STEXI
2738
Jan Kiszka68752042009-09-15 13:36:04 +02002739@item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew]
Stefan Weil6616b2a2010-02-05 23:52:05 +01002740@findex -rtc
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02002741Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current
2742UTC or local time, respectively. @code{localtime} is required for correct date in
2743MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the
2744format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC.
2745
Jan Kiszka68752042009-09-15 13:36:04 +02002746By default the RTC is driven by the host system time. This allows to use the
2747RTC as accurate reference clock inside the guest, specifically if the host
2748time is smoothly following an accurate external reference clock, e.g. via NTP.
Paolo Bonzini78808142012-03-30 10:31:21 +00002749If you want to isolate the guest time from the host, you can set @option{clock}
2750to @code{rt} instead. To even prevent it from progressing during suspension,
2751you can set it to @code{vm}.
Jan Kiszka68752042009-09-15 13:36:04 +02002752
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02002753Enable @option{driftfix} (i386 targets only) if you experience time drift problems,
2754specifically with Windows' ACPI HAL. This option will try to figure out how
2755many timer interrupts were not processed by the Windows guest and will
2756re-inject them.
blueswir15824d652009-03-28 06:44:27 +00002757ETEXI
2758
2759DEF("icount", HAS_ARG, QEMU_OPTION_icount, \
2760 "-icount [N|auto]\n" \
aliguoribc14ca22009-04-05 18:43:37 +00002761 " enable virtual instruction counter with 2^N clock ticks per\n" \
Blue Swirlad960902010-03-29 19:23:52 +00002762 " instruction\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002763STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +02002764@item -icount [@var{N}|auto]
Stefan Weil6616b2a2010-02-05 23:52:05 +01002765@findex -icount
blueswir15824d652009-03-28 06:44:27 +00002766Enable virtual instruction counter. The virtual cpu will execute one
Kevin Wolf4e257e52009-10-09 10:58:36 +02002767instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified
blueswir15824d652009-03-28 06:44:27 +00002768then the virtual cpu speed will be automatically adjusted to keep virtual
2769time within a few seconds of real time.
2770
2771Note that while this option can give deterministic behavior, it does not
2772provide cycle accurate emulation. Modern CPUs contain superscalar out of
2773order cores with complex cache hierarchies. The number of instructions
2774executed often has little or no correlation with actual performance.
2775ETEXI
2776
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01002777DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \
2778 "-watchdog i6300esb|ib700\n" \
Blue Swirlad960902010-03-29 19:23:52 +00002779 " enable virtual hardware watchdog [default=none]\n",
2780 QEMU_ARCH_ALL)
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01002781STEXI
2782@item -watchdog @var{model}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002783@findex -watchdog
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01002784Create a virtual hardware watchdog device. Once enabled (by a guest
2785action), the watchdog must be periodically polled by an agent inside
2786the guest or else the guest will be restarted.
2787
2788The @var{model} is the model of hardware watchdog to emulate. Choices
2789for model are: @code{ib700} (iBASE 700) which is a very simple ISA
2790watchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O
2791controller hub) which is a much more featureful PCI-based dual-timer
2792watchdog. Choose a model for which your guest has drivers.
2793
Peter Maydell585f6032012-10-04 16:22:01 +01002794Use @code{-watchdog help} to list available hardware models. Only one
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01002795watchdog can be enabled for a guest.
2796ETEXI
2797
2798DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \
2799 "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \
Blue Swirlad960902010-03-29 19:23:52 +00002800 " action when watchdog fires [default=reset]\n",
2801 QEMU_ARCH_ALL)
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01002802STEXI
2803@item -watchdog-action @var{action}
Markus Armbrusterb8f490e2013-02-13 19:49:38 +01002804@findex -watchdog-action
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01002805
2806The @var{action} controls what QEMU will do when the watchdog timer
2807expires.
2808The default is
2809@code{reset} (forcefully reset the guest).
2810Other possible actions are:
2811@code{shutdown} (attempt to gracefully shutdown the guest),
2812@code{poweroff} (forcefully poweroff the guest),
2813@code{pause} (pause the guest),
2814@code{debug} (print a debug message and continue), or
2815@code{none} (do nothing).
2816
2817Note that the @code{shutdown} action requires that the guest responds
2818to ACPI signals, which it may not be able to do in the sort of
2819situations where the watchdog would have expired, and thus
2820@code{-watchdog-action shutdown} is not recommended for production use.
2821
2822Examples:
2823
2824@table @code
2825@item -watchdog i6300esb -watchdog-action pause
2826@item -watchdog ib700
2827@end table
2828ETEXI
2829
blueswir15824d652009-03-28 06:44:27 +00002830DEF("echr", HAS_ARG, QEMU_OPTION_echr, \
Blue Swirlad960902010-03-29 19:23:52 +00002831 "-echr chr set terminal escape character instead of ctrl-a\n",
2832 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002833STEXI
2834
Kevin Wolf4e257e52009-10-09 10:58:36 +02002835@item -echr @var{numeric_ascii_value}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002836@findex -echr
blueswir15824d652009-03-28 06:44:27 +00002837Change the escape character used for switching to the monitor when using
2838monitor and serial sharing. The default is @code{0x01} when using the
2839@code{-nographic} option. @code{0x01} is equal to pressing
2840@code{Control-a}. You can select a different character from the ascii
2841control keys where 1 through 26 map to Control-a through Control-z. For
2842instance you could use the either of the following to change the escape
2843character to Control-t.
2844@table @code
2845@item -echr 0x14
2846@item -echr 20
2847@end table
2848ETEXI
2849
2850DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \
2851 "-virtioconsole c\n" \
Blue Swirlad960902010-03-29 19:23:52 +00002852 " set virtio console\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002853STEXI
2854@item -virtioconsole @var{c}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002855@findex -virtioconsole
blueswir15824d652009-03-28 06:44:27 +00002856Set virtio console.
Amit Shah98b19252010-01-20 00:36:52 +05302857
2858This option is maintained for backward compatibility.
2859
2860Please use @code{-device virtconsole} for the new way of invocation.
blueswir15824d652009-03-28 06:44:27 +00002861ETEXI
2862
2863DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \
Blue Swirlad960902010-03-29 19:23:52 +00002864 "-show-cursor show cursor\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002865STEXI
Stefan Weil95d5f082010-01-20 22:25:27 +01002866@item -show-cursor
Stefan Weil6616b2a2010-02-05 23:52:05 +01002867@findex -show-cursor
Stefan Weil95d5f082010-01-20 22:25:27 +01002868Show cursor.
blueswir15824d652009-03-28 06:44:27 +00002869ETEXI
2870
2871DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \
Blue Swirlad960902010-03-29 19:23:52 +00002872 "-tb-size n set TB size\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002873STEXI
Stefan Weil95d5f082010-01-20 22:25:27 +01002874@item -tb-size @var{n}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002875@findex -tb-size
Stefan Weil95d5f082010-01-20 22:25:27 +01002876Set TB size.
blueswir15824d652009-03-28 06:44:27 +00002877ETEXI
2878
2879DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \
Blue Swirlad960902010-03-29 19:23:52 +00002880 "-incoming p prepare for incoming migration, listen on port p\n",
2881 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002882STEXI
Stefan Weil95d5f082010-01-20 22:25:27 +01002883@item -incoming @var{port}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002884@findex -incoming
Stefan Weil95d5f082010-01-20 22:25:27 +01002885Prepare for incoming migration, listen on @var{port}.
blueswir15824d652009-03-28 06:44:27 +00002886ETEXI
2887
Gerd Hoffmannd8c208d2009-12-08 13:11:46 +01002888DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \
Blue Swirlad960902010-03-29 19:23:52 +00002889 "-nodefaults don't create default devices\n", QEMU_ARCH_ALL)
Gerd Hoffmannd8c208d2009-12-08 13:11:46 +01002890STEXI
Stefan Weil3dbf2c72010-01-16 18:19:44 +01002891@item -nodefaults
Stefan Weil6616b2a2010-02-05 23:52:05 +01002892@findex -nodefaults
Michal Novotny66c19bf2012-07-16 14:35:10 +02002893Don't create default devices. Normally, QEMU sets the default devices like serial
2894port, parallel port, virtual console, monitor device, VGA adapter, floppy and
2895CD-ROM drive and others. The @code{-nodefaults} option will disable all those
2896default devices.
Gerd Hoffmannd8c208d2009-12-08 13:11:46 +01002897ETEXI
2898
blueswir15824d652009-03-28 06:44:27 +00002899#ifndef _WIN32
2900DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \
Blue Swirlad960902010-03-29 19:23:52 +00002901 "-chroot dir chroot to dir just before starting the VM\n",
2902 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002903#endif
2904STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +02002905@item -chroot @var{dir}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002906@findex -chroot
blueswir15824d652009-03-28 06:44:27 +00002907Immediately before starting guest execution, chroot to the specified
2908directory. Especially useful in combination with -runas.
2909ETEXI
2910
2911#ifndef _WIN32
2912DEF("runas", HAS_ARG, QEMU_OPTION_runas, \
Blue Swirlad960902010-03-29 19:23:52 +00002913 "-runas user change to user id user just before starting the VM\n",
2914 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002915#endif
2916STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +02002917@item -runas @var{user}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002918@findex -runas
blueswir15824d652009-03-28 06:44:27 +00002919Immediately before starting guest execution, drop root privileges, switching
2920to the specified user.
2921ETEXI
2922
blueswir15824d652009-03-28 06:44:27 +00002923DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env,
2924 "-prom-env variable=value\n"
Blue Swirlad960902010-03-29 19:23:52 +00002925 " set OpenBIOS nvram variables\n",
2926 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
Stefan Weil95d5f082010-01-20 22:25:27 +01002927STEXI
2928@item -prom-env @var{variable}=@var{value}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002929@findex -prom-env
Stefan Weil95d5f082010-01-20 22:25:27 +01002930Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only).
2931ETEXI
blueswir15824d652009-03-28 06:44:27 +00002932DEF("semihosting", 0, QEMU_OPTION_semihosting,
Max Filippov1ddeaa52011-09-06 03:55:47 +04002933 "-semihosting semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA)
Stefan Weil95d5f082010-01-20 22:25:27 +01002934STEXI
2935@item -semihosting
Stefan Weil6616b2a2010-02-05 23:52:05 +01002936@findex -semihosting
Max Filippov1ddeaa52011-09-06 03:55:47 +04002937Semihosting mode (ARM, M68K, Xtensa only).
Stefan Weil95d5f082010-01-20 22:25:27 +01002938ETEXI
blueswir15824d652009-03-28 06:44:27 +00002939DEF("old-param", 0, QEMU_OPTION_old_param,
Blue Swirlad960902010-03-29 19:23:52 +00002940 "-old-param old param mode\n", QEMU_ARCH_ARM)
Stefan Weil95d5f082010-01-20 22:25:27 +01002941STEXI
2942@item -old-param
Stefan Weil6616b2a2010-02-05 23:52:05 +01002943@findex -old-param (ARM)
Stefan Weil95d5f082010-01-20 22:25:27 +01002944Old param mode (ARM only).
2945ETEXI
2946
Eduardo Otubo7d76ad42012-08-14 18:44:08 -03002947DEF("sandbox", HAS_ARG, QEMU_OPTION_sandbox, \
2948 "-sandbox <arg> Enable seccomp mode 2 system call filter (default 'off').\n",
2949 QEMU_ARCH_ALL)
2950STEXI
Markus Armbruster6265c432013-02-13 19:49:39 +01002951@item -sandbox @var{arg}
Eduardo Otubo7d76ad42012-08-14 18:44:08 -03002952@findex -sandbox
2953Enable Seccomp mode 2 system call filter. 'on' will enable syscall filtering and 'off' will
2954disable it. The default is 'off'.
2955ETEXI
2956
Gerd Hoffmann715a6642009-10-14 10:39:28 +02002957DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig,
Blue Swirlad960902010-03-29 19:23:52 +00002958 "-readconfig <file>\n", QEMU_ARCH_ALL)
Stefan Weil3dbf2c72010-01-16 18:19:44 +01002959STEXI
2960@item -readconfig @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002961@findex -readconfig
Michal Novotnyed24cfa2012-07-16 14:28:32 +02002962Read device configuration from @var{file}. This approach is useful when you want to spawn
2963QEMU process with many command line options but you don't want to exceed the command line
2964character limit.
Stefan Weil3dbf2c72010-01-16 18:19:44 +01002965ETEXI
Gerd Hoffmann715a6642009-10-14 10:39:28 +02002966DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig,
2967 "-writeconfig <file>\n"
Blue Swirlad960902010-03-29 19:23:52 +00002968 " read/write config file\n", QEMU_ARCH_ALL)
Stefan Weil3dbf2c72010-01-16 18:19:44 +01002969STEXI
2970@item -writeconfig @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002971@findex -writeconfig
Michal Novotnyed24cfa2012-07-16 14:28:32 +02002972Write device configuration to @var{file}. The @var{file} can be either filename to save
2973command line and device configuration into file or dash @code{-}) character to print the
2974output to stdout. This can be later used as input file for @code{-readconfig} option.
Stefan Weil3dbf2c72010-01-16 18:19:44 +01002975ETEXI
Anthony Liguori292444c2010-01-21 10:57:58 -06002976DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig,
2977 "-nodefconfig\n"
Blue Swirlad960902010-03-29 19:23:52 +00002978 " do not load default config files at startup\n",
2979 QEMU_ARCH_ALL)
Anthony Liguori292444c2010-01-21 10:57:58 -06002980STEXI
2981@item -nodefconfig
Stefan Weil6616b2a2010-02-05 23:52:05 +01002982@findex -nodefconfig
Eduardo Habkostf29a5612012-05-02 13:07:29 -03002983Normally QEMU loads configuration files from @var{sysconfdir} and @var{datadir} at startup.
2984The @code{-nodefconfig} option will prevent QEMU from loading any of those config files.
2985ETEXI
2986DEF("no-user-config", 0, QEMU_OPTION_nouserconfig,
2987 "-no-user-config\n"
2988 " do not load user-provided config files at startup\n",
2989 QEMU_ARCH_ALL)
2990STEXI
2991@item -no-user-config
2992@findex -no-user-config
2993The @code{-no-user-config} option makes QEMU not load any of the user-provided
2994config files on @var{sysconfdir}, but won't make it skip the QEMU-provided config
2995files from @var{datadir}.
Anthony Liguori292444c2010-01-21 10:57:58 -06002996ETEXI
Prerna Saxenaab6540d2010-08-09 11:48:32 +01002997DEF("trace", HAS_ARG, QEMU_OPTION_trace,
Lluís23d15e82011-08-31 20:31:31 +02002998 "-trace [events=<file>][,file=<file>]\n"
2999 " specify tracing options\n",
Prerna Saxenaab6540d2010-08-09 11:48:32 +01003000 QEMU_ARCH_ALL)
3001STEXI
Lluís23d15e82011-08-31 20:31:31 +02003002HXCOMM This line is not accurate, as some sub-options are backend-specific but
3003HXCOMM HX does not support conditional compilation of text.
3004@item -trace [events=@var{file}][,file=@var{file}]
Prerna Saxenaab6540d2010-08-09 11:48:32 +01003005@findex -trace
Lluíse4858972011-08-31 20:31:03 +02003006
Lluís23d15e82011-08-31 20:31:31 +02003007Specify tracing options.
3008
3009@table @option
3010@item events=@var{file}
3011Immediately enable events listed in @var{file}.
3012The file must contain one event name (as listed in the @var{trace-events} file)
3013per line.
Stefan Weilc1ba4e02011-09-05 18:13:03 +02003014This option is only available if QEMU has been compiled with
3015either @var{simple} or @var{stderr} tracing backend.
Lluís23d15e82011-08-31 20:31:31 +02003016@item file=@var{file}
3017Log output traces to @var{file}.
3018
Stefan Weilc1ba4e02011-09-05 18:13:03 +02003019This option is only available if QEMU has been compiled with
3020the @var{simple} tracing backend.
Lluís23d15e82011-08-31 20:31:31 +02003021@end table
Prerna Saxenaab6540d2010-08-09 11:48:32 +01003022ETEXI
Stefan Weil3dbf2c72010-01-16 18:19:44 +01003023
Markus Armbruster31e70d62013-02-13 19:49:37 +01003024HXCOMM Internal use
3025DEF("qtest", HAS_ARG, QEMU_OPTION_qtest, "", QEMU_ARCH_ALL)
3026DEF("qtest-log", HAS_ARG, QEMU_OPTION_qtest_log, "", QEMU_ARCH_ALL)
Anthony Liguoric7f0f3b2012-03-28 15:42:02 +02003027
Paul Moore0f669982012-08-03 14:39:21 -04003028#ifdef __linux__
3029DEF("enable-fips", 0, QEMU_OPTION_enablefips,
3030 "-enable-fips enable FIPS 140-2 compliance\n",
3031 QEMU_ARCH_ALL)
3032#endif
3033STEXI
3034@item -enable-fips
3035@findex -enable-fips
3036Enable FIPS 140-2 compliance mode.
3037ETEXI
3038
Jan Kiszkaa0dac022012-10-05 14:51:45 -03003039HXCOMM Deprecated by -machine accel=tcg property
Bruce Rogersc6e88b32012-11-20 07:11:21 -07003040DEF("no-kvm", 0, QEMU_OPTION_no_kvm, "", QEMU_ARCH_I386)
Jan Kiszkaa0dac022012-10-05 14:51:45 -03003041
Jan Kiszkac21fb4f2012-10-05 14:51:42 -03003042HXCOMM Deprecated by kvm-pit driver properties
Bruce Rogersc6e88b32012-11-20 07:11:21 -07003043DEF("no-kvm-pit-reinjection", 0, QEMU_OPTION_no_kvm_pit_reinjection,
Jan Kiszkac21fb4f2012-10-05 14:51:42 -03003044 "", QEMU_ARCH_I386)
3045
Jan Kiszka4086bde2012-10-05 14:51:41 -03003046HXCOMM Deprecated (ignored)
Bruce Rogersc6e88b32012-11-20 07:11:21 -07003047DEF("no-kvm-pit", 0, QEMU_OPTION_no_kvm_pit, "", QEMU_ARCH_I386)
Jan Kiszka4086bde2012-10-05 14:51:41 -03003048
Jan Kiszkae43d5942012-10-05 14:51:40 -03003049HXCOMM Deprecated by -machine kernel_irqchip=on|off property
Bruce Rogersc6e88b32012-11-20 07:11:21 -07003050DEF("no-kvm-irqchip", 0, QEMU_OPTION_no_kvm_irqchip, "", QEMU_ARCH_I386)
Jan Kiszkae43d5942012-10-05 14:51:40 -03003051
Jan Kiszka88eed342012-10-05 14:51:44 -03003052HXCOMM Deprecated (ignored)
3053DEF("tdf", 0, QEMU_OPTION_tdf,"", QEMU_ARCH_ALL)
3054
Anthony Liguori68d98d32012-06-25 14:36:33 -05003055DEF("object", HAS_ARG, QEMU_OPTION_object,
3056 "-object TYPENAME[,PROP1=VALUE1,...]\n"
3057 " create an new object of type TYPENAME setting properties\n"
3058 " in the order they are specified. Note that the 'id'\n"
3059 " property must be set. These objects are placed in the\n"
3060 " '/objects' path.\n",
3061 QEMU_ARCH_ALL)
Markus Armbruster6265c432013-02-13 19:49:39 +01003062STEXI
3063@item -object @var{typename}[,@var{prop1}=@var{value1},...]
3064@findex -object
3065Create an new object of type @var{typename} setting properties
3066in the order they are specified. Note that the 'id'
3067property must be set. These objects are placed in the
3068'/objects' path.
3069ETEXI
Anthony Liguori68d98d32012-06-25 14:36:33 -05003070
Stefan Weil3dbf2c72010-01-16 18:19:44 +01003071HXCOMM This is the last statement. Insert new options before this line!
3072STEXI
3073@end table
3074ETEXI