blob: efce775f667d3cd750eec5879fefcf9c7e792b2d [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"
Don Slutzd1048be2014-11-21 11:18:52 -050036 " vmport=on|off|auto controls emulation of vmport (default: auto)\n"
Jason Baronddb97f12012-08-02 15:44:16 -040037 " kvm_shadow_mem=size of KVM shadow MMU\n"
Luiz Capitulino8490fc72012-09-05 16:50:16 -030038 " dump-guest-core=on|off include guest memory in a core dump (default=on)\n"
Le Tana52a7fd2014-08-16 13:55:40 +080039 " mem-merge=on|off controls memory merge support (default: on)\n"
Tony Krowiak2eb1cd02015-03-12 13:53:51 +010040 " iommu=on|off controls emulated Intel IOMMU (VT-d) support (default=off)\n"
41 " aes-key-wrap=on|off controls support for AES key wrapping (default=on)\n"
Alexander Graf9850c602015-02-23 13:56:42 +010042 " dea-key-wrap=on|off controls support for DEA key wrapping (default=on)\n"
43 " suppress-vmdesc=on|off disables self-describing migration (default=off)\n",
Jan Kiszka80f52a62011-07-23 12:39:46 +020044 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +000045STEXI
Jan Kiszka80f52a62011-07-23 12:39:46 +020046@item -machine [type=]@var{name}[,prop=@var{value}[,...]]
47@findex -machine
Peter Maydell585f6032012-10-04 16:22:01 +010048Select the emulated machine by @var{name}. Use @code{-machine help} to list
Jan Kiszka80f52a62011-07-23 12:39:46 +020049available machines. Supported machine properties are:
50@table @option
51@item accel=@var{accels1}[:@var{accels2}[:...]]
52This is used to enable an accelerator. Depending on the target architecture,
53kvm, xen, or tcg can be available. By default, tcg is used. If there is more
54than one accelerator specified, the next one is used if the previous one fails
55to initialize.
Jan Kiszka6a48ffa2011-10-15 13:43:48 +020056@item kernel_irqchip=on|off
57Enables in-kernel irqchip support for the chosen accelerator when available.
Don Slutzd1048be2014-11-21 11:18:52 -050058@item vmport=on|off|auto
59Enables emulation of VMWare IO port, for vmmouse etc. auto says to select the
60value based on accel. For accel=xen the default is off otherwise the default
61is on.
Jan Kiszka39d69602012-01-25 18:14:15 +010062@item kvm_shadow_mem=size
63Defines the size of the KVM shadow MMU.
Jason Baronddb97f12012-08-02 15:44:16 -040064@item dump-guest-core=on|off
65Include guest memory in a core dump. The default is on.
Luiz Capitulino8490fc72012-09-05 16:50:16 -030066@item mem-merge=on|off
67Enables or disables memory merge support. This feature, when supported by
68the host, de-duplicates identical memory pages among VMs instances
69(enabled by default).
Le Tana52a7fd2014-08-16 13:55:40 +080070@item iommu=on|off
71Enables or disables emulated Intel IOMMU (VT-d) support. The default is off.
Tony Krowiak2eb1cd02015-03-12 13:53:51 +010072@item aes-key-wrap=on|off
73Enables or disables AES key wrapping support on s390-ccw hosts. This feature
74controls whether AES wrapping keys will be created to allow
75execution of AES cryptographic functions. The default is on.
76@item dea-key-wrap=on|off
77Enables or disables DEA key wrapping support on s390-ccw hosts. This feature
78controls whether DEA wrapping keys will be created to allow
79execution of DEA cryptographic functions. The default is on.
Jan Kiszka80f52a62011-07-23 12:39:46 +020080@end table
blueswir15824d652009-03-28 06:44:27 +000081ETEXI
82
Jan Kiszka80f52a62011-07-23 12:39:46 +020083HXCOMM Deprecated by -machine
84DEF("M", HAS_ARG, QEMU_OPTION_M, "", QEMU_ARCH_ALL)
85
blueswir15824d652009-03-28 06:44:27 +000086DEF("cpu", HAS_ARG, QEMU_OPTION_cpu,
Peter Maydell585f6032012-10-04 16:22:01 +010087 "-cpu cpu select CPU ('-cpu help' for list)\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +000088STEXI
89@item -cpu @var{model}
Stefan Weil6616b2a2010-02-05 23:52:05 +010090@findex -cpu
Peter Maydell585f6032012-10-04 16:22:01 +010091Select CPU model (@code{-cpu help} for list and additional feature selection)
blueswir15824d652009-03-28 06:44:27 +000092ETEXI
93
94DEF("smp", HAS_ARG, QEMU_OPTION_smp,
Michael Tokarev12b7f572013-06-24 15:06:52 +040095 "-smp [cpus=]n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n"
Jes Sorensen6be68d72009-07-23 17:03:42 +020096 " set the number of CPUs to 'n' [default=1]\n"
97 " maxcpus= maximum number of total cpus, including\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -070098 " offline CPUs for hotplug, etc\n"
Andre Przywara58a04db2009-08-28 10:49:57 +020099 " cores= number of CPU cores on one socket\n"
100 " threads= number of threads on one CPU core\n"
Blue Swirlad960902010-03-29 19:23:52 +0000101 " sockets= number of discrete sockets in the system\n",
102 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000103STEXI
Michael Tokarev12b7f572013-06-24 15:06:52 +0400104@item -smp [cpus=]@var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}]
Stefan Weil6616b2a2010-02-05 23:52:05 +0100105@findex -smp
blueswir15824d652009-03-28 06:44:27 +0000106Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
107CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs
108to 4.
Andre Przywara58a04db2009-08-28 10:49:57 +0200109For the PC target, the number of @var{cores} per socket, the number
110of @var{threads} per cores and the total number of @var{sockets} can be
111specified. Missing values will be computed. If any on the three values is
112given, the total number of CPUs @var{n} can be omitted. @var{maxcpus}
113specifies the maximum number of hotpluggable CPUs.
blueswir15824d652009-03-28 06:44:27 +0000114ETEXI
115
aliguori268a3622009-04-21 22:30:27 +0000116DEF("numa", HAS_ARG, QEMU_OPTION_numa,
Paolo Bonzini7febe362014-05-14 17:43:17 +0800117 "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n"
118 "-numa node[,memdev=id][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL)
aliguori268a3622009-04-21 22:30:27 +0000119STEXI
Luiz Capitulino4932b892014-05-14 17:43:10 +0800120@item -numa node[,mem=@var{size}][,cpus=@var{cpu[-cpu]}][,nodeid=@var{node}]
Markus Armbrusterf9cfd652015-06-15 14:35:59 +0200121@itemx -numa node[,memdev=@var{id}][,cpus=@var{cpu[-cpu]}][,nodeid=@var{node}]
Stefan Weil6616b2a2010-02-05 23:52:05 +0100122@findex -numa
Paolo Bonzini7febe362014-05-14 17:43:17 +0800123Simulate a multi node NUMA system. If @samp{mem}, @samp{memdev}
Luiz Capitulino4932b892014-05-14 17:43:10 +0800124and @samp{cpus} are omitted, resources are split equally. Also, note
125that the -@option{numa} option doesn't allocate any of the specified
126resources. That is, it just assigns existing resources to NUMA nodes. This
127means that one still has to use the @option{-m}, @option{-smp} options
Paolo Bonzini7febe362014-05-14 17:43:17 +0800128to allocate RAM and VCPUs respectively, and possibly @option{-object}
129to specify the memory backend for the @samp{memdev} suboption.
130
131@samp{mem} and @samp{memdev} are mutually exclusive. Furthermore, if one
132node uses @samp{memdev}, all of them have to use it.
aliguori268a3622009-04-21 22:30:27 +0000133ETEXI
134
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100135DEF("add-fd", HAS_ARG, QEMU_OPTION_add_fd,
136 "-add-fd fd=fd,set=set[,opaque=opaque]\n"
137 " Add 'fd' to fd 'set'\n", QEMU_ARCH_ALL)
138STEXI
139@item -add-fd fd=@var{fd},set=@var{set}[,opaque=@var{opaque}]
140@findex -add-fd
141
142Add a file descriptor to an fd set. Valid options are:
143
144@table @option
145@item fd=@var{fd}
146This option defines the file descriptor of which a duplicate is added to fd set.
147The file descriptor cannot be stdin, stdout, or stderr.
148@item set=@var{set}
149This option defines the ID of the fd set to add the file descriptor to.
150@item opaque=@var{opaque}
151This option defines a free-form string that can be used to describe @var{fd}.
152@end table
153
154You can open an image using pre-opened file descriptors from an fd set:
155@example
156qemu-system-i386
157-add-fd fd=3,set=2,opaque="rdwr:/path/to/file"
158-add-fd fd=4,set=2,opaque="rdonly:/path/to/file"
159-drive file=/dev/fdset/2,index=0,media=disk
160@end example
161ETEXI
162
163DEF("set", HAS_ARG, QEMU_OPTION_set,
164 "-set group.id.arg=value\n"
165 " set <arg> parameter for item <id> of type <group>\n"
166 " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL)
167STEXI
168@item -set @var{group}.@var{id}.@var{arg}=@var{value}
169@findex -set
170Set parameter @var{arg} for item @var{id} of type @var{group}\n"
171ETEXI
172
173DEF("global", HAS_ARG, QEMU_OPTION_global,
Paolo Bonzini3751d7c2015-04-09 14:16:19 +0200174 "-global driver.property=value\n"
175 "-global driver=driver,property=property,value=value\n"
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100176 " set a global default for a driver property\n",
177 QEMU_ARCH_ALL)
178STEXI
179@item -global @var{driver}.@var{prop}=@var{value}
Paolo Bonzini3751d7c2015-04-09 14:16:19 +0200180@itemx -global driver=@var{driver},property=@var{property},value=@var{value}
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100181@findex -global
182Set default value of @var{driver}'s property @var{prop} to @var{value}, e.g.:
183
184@example
185qemu-system-i386 -global ide-drive.physical_block_size=4096 -drive file=file,if=ide,index=0,media=disk
186@end example
187
188In particular, you can use this to set driver properties for devices which are
189created automatically by the machine model. To create a device which is not
190created automatically and set properties on it, use -@option{device}.
Paolo Bonzini3751d7c2015-04-09 14:16:19 +0200191
Markus Armbrusterae08fd52015-06-15 14:35:58 +0200192-global @var{driver}.@var{prop}=@var{value} is shorthand for -global
193driver=@var{driver},property=@var{prop},value=@var{value}. The
194longhand syntax works even when @var{driver} contains a dot.
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100195ETEXI
196
197DEF("boot", HAS_ARG, QEMU_OPTION_boot,
198 "-boot [order=drives][,once=drives][,menu=on|off]\n"
Amos Kongc8a6ae82013-03-19 14:23:27 +0800199 " [,splash=sp_name][,splash-time=sp_time][,reboot-timeout=rb_time][,strict=on|off]\n"
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100200 " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n"
201 " 'sp_name': the file's name that would be passed to bios as logo picture, if menu=on\n"
202 " 'sp_time': the period that splash picture last if menu=on, unit is ms\n"
203 " 'rb_timeout': the timeout before guest reboot when boot failed, unit is ms\n",
204 QEMU_ARCH_ALL)
205STEXI
Amos Kongc8a6ae82013-03-19 14:23:27 +0800206@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 +0100207@findex -boot
208Specify boot order @var{drives} as a string of drive letters. Valid
Gongleid274e072015-07-03 17:50:57 +0800209drive letters depend on the target architecture. The x86 PC uses: a, b
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100210(floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot
211from network adapter 1-4), hard disk boot is the default. To apply a
212particular boot order only on the first startup, specify it via
213@option{once}.
214
215Interactive boot menus/prompts can be enabled via @option{menu=on} as far
216as firmware/BIOS supports them. The default is non-interactive boot.
217
218A splash picture could be passed to bios, enabling user to show it as logo,
219when option splash=@var{sp_name} is given and menu=on, If firmware/BIOS
220supports them. Currently Seabios for X86 system support it.
221limitation: The splash file could be a jpeg file or a BMP file in 24 BPP
222format(true color). The resolution should be supported by the SVGA mode, so
223the recommended is 320x240, 640x480, 800x640.
224
225A timeout could be passed to bios, guest will pause for @var{rb_timeout} ms
226when boot failed, then reboot. If @var{rb_timeout} is '-1', guest will not
227reboot, qemu passes '-1' to bios by default. Currently Seabios for X86
228system support it.
229
Amos Kongc8a6ae82013-03-19 14:23:27 +0800230Do strict boot via @option{strict=on} as far as firmware/BIOS
231supports it. This only effects when boot priority is changed by
232bootindex options. The default is non-strict boot.
233
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100234@example
235# try to boot from network first, then from hard disk
236qemu-system-i386 -boot order=nc
237# boot from CD-ROM first, switch back to default order after reboot
238qemu-system-i386 -boot once=d
239# boot with a splash picture for 5 seconds.
240qemu-system-i386 -boot menu=on,splash=/root/boot.bmp,splash-time=5000
241@end example
242
243Note: The legacy format '-boot @var{drives}' is still supported but its
244use is discouraged as it may be removed from future versions.
245ETEXI
246
247DEF("m", HAS_ARG, QEMU_OPTION_m,
Igor Mammedovc270fb92014-06-02 15:25:02 +0200248 "-m[emory] [size=]megs[,slots=n,maxmem=size]\n"
Igor Mammedov6e1d3c12013-11-27 01:27:35 +0100249 " configure guest RAM\n"
Alexander Graf0daba1f2015-06-05 11:05:03 +0200250 " size: initial amount of guest memory\n"
Igor Mammedovc270fb92014-06-02 15:25:02 +0200251 " slots: number of hotplug slots (default: none)\n"
Matthew Rosatob6fe0122014-08-28 11:25:33 -0400252 " maxmem: maximum amount of guest memory (default: none)\n"
253 "NOTE: Some architectures might enforce a specific granularity\n",
Igor Mammedov6e1d3c12013-11-27 01:27:35 +0100254 QEMU_ARCH_ALL)
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100255STEXI
Luiz Capitulino9fcc0792015-02-26 14:35:45 -0500256@item -m [size=]@var{megs}[,slots=n,maxmem=size]
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100257@findex -m
Luiz Capitulino9fcc0792015-02-26 14:35:45 -0500258Sets guest startup RAM size to @var{megs} megabytes. Default is 128 MiB.
259Optionally, a suffix of ``M'' or ``G'' can be used to signify a value in
260megabytes or gigabytes respectively. Optional pair @var{slots}, @var{maxmem}
261could be used to set amount of hotpluggable memory slots and maximum amount of
262memory. Note that @var{maxmem} must be aligned to the page size.
263
264For example, the following command-line sets the guest startup RAM size to
2651GB, creates 3 slots to hotplug additional memory and sets the maximum
266memory the guest can reach to 4GB:
267
268@example
269qemu-system-x86_64 -m 1G,slots=3,maxmem=4G
270@end example
271
272If @var{slots} and @var{maxmem} are not specified, memory hotplug won't
273be enabled and the guest startup RAM will never increase.
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100274ETEXI
275
276DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath,
277 "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL)
278STEXI
279@item -mem-path @var{path}
280@findex -mem-path
281Allocate guest RAM from a temporarily created file in @var{path}.
282ETEXI
283
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100284DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc,
285 "-mem-prealloc preallocate guest memory (use with -mem-path)\n",
286 QEMU_ARCH_ALL)
287STEXI
288@item -mem-prealloc
289@findex -mem-prealloc
290Preallocate memory when using -mem-path.
291ETEXI
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100292
293DEF("k", HAS_ARG, QEMU_OPTION_k,
294 "-k language use keyboard layout (for example 'fr' for French)\n",
295 QEMU_ARCH_ALL)
296STEXI
297@item -k @var{language}
298@findex -k
299Use keyboard layout @var{language} (for example @code{fr} for
300French). This option is only needed where it is not easy to get raw PC
301keycodes (e.g. on Macs, with some X11 servers or with a VNC
302display). You don't normally need to use it on PC/Linux or PC/Windows
303hosts.
304
305The available layouts are:
306@example
307ar de-ch es fo fr-ca hu ja mk no pt-br sv
308da en-gb et fr fr-ch is lt nl pl ru th
309de en-us fi fr-be hr it lv nl-be pt sl tr
310@end example
311
312The default is @code{en-us}.
313ETEXI
314
315
316DEF("audio-help", 0, QEMU_OPTION_audio_help,
317 "-audio-help print list of audio drivers and their options\n",
318 QEMU_ARCH_ALL)
319STEXI
320@item -audio-help
321@findex -audio-help
322Will show the audio subsystem help: list of drivers, tunable
323parameters.
324ETEXI
325
326DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw,
327 "-soundhw c1,... enable audio support\n"
328 " and only specified sound cards (comma separated list)\n"
329 " use '-soundhw help' to get the list of supported cards\n"
330 " use '-soundhw all' to enable all of them\n", QEMU_ARCH_ALL)
331STEXI
332@item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
333@findex -soundhw
334Enable audio and selected sound hardware. Use 'help' to print all
335available sound hardware.
336
337@example
338qemu-system-i386 -soundhw sb16,adlib disk.img
339qemu-system-i386 -soundhw es1370 disk.img
340qemu-system-i386 -soundhw ac97 disk.img
341qemu-system-i386 -soundhw hda disk.img
342qemu-system-i386 -soundhw all disk.img
343qemu-system-i386 -soundhw help
344@end example
345
346Note that Linux's i810_audio OSS kernel (for AC97) module might
347require manually specifying clocking.
348
349@example
350modprobe i810_audio clocking=48000
351@end example
352ETEXI
353
354DEF("balloon", HAS_ARG, QEMU_OPTION_balloon,
355 "-balloon none disable balloon device\n"
356 "-balloon virtio[,addr=str]\n"
357 " enable virtio balloon device (default)\n", QEMU_ARCH_ALL)
358STEXI
359@item -balloon none
360@findex -balloon
361Disable balloon device.
362@item -balloon virtio[,addr=@var{addr}]
363Enable virtio balloon device (default), optionally with PCI address
364@var{addr}.
365ETEXI
366
367DEF("device", HAS_ARG, QEMU_OPTION_device,
368 "-device driver[,prop[=value][,...]]\n"
369 " add device (based on driver)\n"
370 " prop=value,... sets driver properties\n"
371 " use '-device help' to print all possible drivers\n"
372 " use '-device driver,help' to print all possible properties\n",
373 QEMU_ARCH_ALL)
374STEXI
375@item -device @var{driver}[,@var{prop}[=@var{value}][,...]]
376@findex -device
377Add device @var{driver}. @var{prop}=@var{value} sets driver
378properties. Valid properties depend on the driver. To get help on
379possible drivers and properties, use @code{-device help} and
380@code{-device @var{driver},help}.
381ETEXI
382
383DEF("name", HAS_ARG, QEMU_OPTION_name,
Dr. David Alan Gilbert8f480de2014-01-30 10:20:31 +0000384 "-name string1[,process=string2][,debug-threads=on|off]\n"
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100385 " set the name of the guest\n"
Dr. David Alan Gilbert8f480de2014-01-30 10:20:31 +0000386 " string1 sets the window title and string2 the process name (on Linux)\n"
387 " When debug-threads is enabled, individual threads are given a separate name (on Linux)\n"
388 " NOTE: The thread names are for debugging and not a stable API.\n",
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100389 QEMU_ARCH_ALL)
390STEXI
391@item -name @var{name}
392@findex -name
393Sets the @var{name} of the guest.
394This name will be displayed in the SDL window caption.
395The @var{name} will also be used for the VNC server.
396Also optionally set the top visible process name in Linux.
Dr. David Alan Gilbert8f480de2014-01-30 10:20:31 +0000397Naming of individual threads can also be enabled on Linux to aid debugging.
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100398ETEXI
399
400DEF("uuid", HAS_ARG, QEMU_OPTION_uuid,
401 "-uuid %08x-%04x-%04x-%04x-%012x\n"
402 " specify machine UUID\n", QEMU_ARCH_ALL)
403STEXI
404@item -uuid @var{uuid}
405@findex -uuid
406Set system UUID.
407ETEXI
408
409STEXI
410@end table
411ETEXI
412DEFHEADING()
413
414DEFHEADING(Block device options:)
415STEXI
416@table @option
417ETEXI
418
blueswir15824d652009-03-28 06:44:27 +0000419DEF("fda", HAS_ARG, QEMU_OPTION_fda,
Blue Swirlad960902010-03-29 19:23:52 +0000420 "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL)
421DEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000422STEXI
423@item -fda @var{file}
Markus Armbrusterf9cfd652015-06-15 14:35:59 +0200424@itemx -fdb @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100425@findex -fda
426@findex -fdb
Markus Armbruster92a539d2015-03-17 17:02:20 +0100427Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}).
blueswir15824d652009-03-28 06:44:27 +0000428ETEXI
429
430DEF("hda", HAS_ARG, QEMU_OPTION_hda,
Blue Swirlad960902010-03-29 19:23:52 +0000431 "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL)
432DEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000433DEF("hdc", HAS_ARG, QEMU_OPTION_hdc,
Blue Swirlad960902010-03-29 19:23:52 +0000434 "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL)
435DEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000436STEXI
437@item -hda @var{file}
Markus Armbrusterf9cfd652015-06-15 14:35:59 +0200438@itemx -hdb @var{file}
439@itemx -hdc @var{file}
440@itemx -hdd @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100441@findex -hda
442@findex -hdb
443@findex -hdc
444@findex -hdd
blueswir15824d652009-03-28 06:44:27 +0000445Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
446ETEXI
447
448DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom,
Blue Swirlad960902010-03-29 19:23:52 +0000449 "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n",
450 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000451STEXI
452@item -cdrom @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100453@findex -cdrom
blueswir15824d652009-03-28 06:44:27 +0000454Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and
455@option{-cdrom} at the same time). You can use the host CD-ROM by
456using @file{/dev/cdrom} as filename (@pxref{host_drives}).
457ETEXI
458
459DEF("drive", HAS_ARG, QEMU_OPTION_drive,
460 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n"
461 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n"
Stefan Hajnoczi92196b22011-08-04 12:26:52 +0100462 " [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n"
Stefan Hajnoczid1db7602014-04-23 13:55:37 +0200463 " [,serial=s][,addr=A][,rerror=ignore|stop|report]\n"
464 " [,werror=ignore|stop|report|enospc][,id=name][,aio=threads|native]\n"
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +0000465 " [,readonly=on|off][,copy-on-read=on|off]\n"
Peter Lieven2f7133b2014-07-28 21:53:02 +0200466 " [,discard=ignore|unmap][,detect-zeroes=on|off|unmap]\n"
Benoît Canet3e9fab62013-09-02 14:14:40 +0200467 " [[,bps=b]|[[,bps_rd=r][,bps_wr=w]]]\n"
468 " [[,iops=i]|[[,iops_rd=r][,iops_wr=w]]]\n"
469 " [[,bps_max=bm]|[[,bps_rd_max=rm][,bps_wr_max=wm]]]\n"
470 " [[,iops_max=im]|[[,iops_rd_max=irm][,iops_wr_max=iwm]]]\n"
Benoît Canet2024c1d2013-09-02 14:14:41 +0200471 " [[,iops_size=is]]\n"
Alberto Garcia76f4afb2015-06-08 18:17:44 +0200472 " [[,group=g]]\n"
Blue Swirlad960902010-03-29 19:23:52 +0000473 " use 'file' as a drive image\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000474STEXI
475@item -drive @var{option}[,@var{option}[,@var{option}[,...]]]
Stefan Weil6616b2a2010-02-05 23:52:05 +0100476@findex -drive
blueswir15824d652009-03-28 06:44:27 +0000477
478Define a new drive. Valid options are:
479
Kevin Wolfb3f046c2009-10-09 10:58:35 +0200480@table @option
blueswir15824d652009-03-28 06:44:27 +0000481@item file=@var{file}
482This option defines which disk image (@pxref{disk_images}) to use with
483this drive. If the filename contains comma, you must double it
484(for instance, "file=my,,file" to use file "my,file").
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +1100485
486Special files such as iSCSI devices can be specified using protocol
487specific URLs. See the section for "Device URL Syntax" for more information.
blueswir15824d652009-03-28 06:44:27 +0000488@item if=@var{interface}
489This option defines on which type on interface the drive is connected.
490Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio.
491@item bus=@var{bus},unit=@var{unit}
492These options define where is connected the drive by defining the bus number and
493the unit id.
494@item index=@var{index}
495This option defines where is connected the drive by using an index in the list
496of available connectors of a given interface type.
497@item media=@var{media}
498This option defines the type of the media: disk or cdrom.
499@item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}]
500These options have the same definition as they have in @option{-hdachs}.
501@item snapshot=@var{snapshot}
Michael Tokarev9d85d552014-04-07 13:34:58 +0400502@var{snapshot} is "on" or "off" and controls snapshot mode for the given drive
503(see @option{-snapshot}).
blueswir15824d652009-03-28 06:44:27 +0000504@item cache=@var{cache}
Stefan Hajnoczi92196b22011-08-04 12:26:52 +0100505@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 +0200506@item aio=@var{aio}
507@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 +0100508@item discard=@var{discard}
509@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 +0000510@item format=@var{format}
511Specify which disk @var{format} will be used rather than detecting
512the format. Can be used to specifiy format=raw to avoid interpreting
513an untrusted format header.
514@item serial=@var{serial}
515This option specifies the serial number to assign to the device.
Markus Armbrusterc2cc47a2009-06-18 15:14:10 +0200516@item addr=@var{addr}
517Specify the controller's PCI address (if=virtio only).
Luiz Capitulinoae73e592011-07-12 17:35:08 -0300518@item werror=@var{action},rerror=@var{action}
519Specify which @var{action} to take on write and read errors. Valid actions are:
520"ignore" (ignore the error and try to continue), "stop" (pause QEMU),
521"report" (report the error to the guest), "enospc" (pause QEMU only if the
522host disk is full; report the error to the guest otherwise).
523The default setting is @option{werror=enospc} and @option{rerror=report}.
524@item readonly
525Open drive @option{file} as read-only. Guest write attempts will fail.
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +0000526@item copy-on-read=@var{copy-on-read}
527@var{copy-on-read} is "on" or "off" and enables whether to copy read backing
528file sectors into the image file.
Peter Lieven465bee12014-05-18 00:58:19 +0200529@item detect-zeroes=@var{detect-zeroes}
530@var{detect-zeroes} is "off", "on" or "unmap" and enables the automatic
531conversion of plain zero writes by the OS to driver specific optimized
532zero write commands. You may even choose "unmap" if @var{discard} is set
533to "unmap" to allow a zero write to be converted to an UNMAP operation.
blueswir15824d652009-03-28 06:44:27 +0000534@end table
535
Kevin Wolfa13e5e02012-11-21 12:26:56 +0100536By default, the @option{cache=writeback} mode is used. It will report data
537writes as completed as soon as the data is present in the host page cache.
538This is safe as long as your guest OS makes sure to correctly flush disk caches
539where needed. If your guest OS does not handle volatile disk write caches
540correctly and your host crashes or loses power, then the guest may experience
541data corruption.
blueswir15824d652009-03-28 06:44:27 +0000542
Kevin Wolfa13e5e02012-11-21 12:26:56 +0100543For such guests, you should consider using @option{cache=writethrough}. This
544means that the host page cache will be used to read and write data, but write
545notification will be sent to the guest only after QEMU has made sure to flush
546each write to the disk. Be aware that this has a major impact on performance.
blueswir15824d652009-03-28 06:44:27 +0000547
Aurelien Jarnoc304d312009-05-03 23:29:14 +0200548The host page cache can be avoided entirely with @option{cache=none}. This will
Kevin Wolfa13e5e02012-11-21 12:26:56 +0100549attempt to do disk IO directly to the guest's memory. QEMU may still perform
550an internal copy of the data. Note that this is considered a writeback mode and
551the guest OS must handle the disk write cache correctly in order to avoid data
552corruption on host crashes.
blueswir15824d652009-03-28 06:44:27 +0000553
Stefan Hajnoczi92196b22011-08-04 12:26:52 +0100554The host page cache can be avoided while only sending write notifications to
Kevin Wolfa13e5e02012-11-21 12:26:56 +0100555the guest when the data has been flushed to the disk using
556@option{cache=directsync}.
blueswir15824d652009-03-28 06:44:27 +0000557
Alexander Graf016f5cf2010-05-26 17:51:49 +0200558In case you don't care about data integrity over host failures, use
Kevin Wolfa13e5e02012-11-21 12:26:56 +0100559@option{cache=unsafe}. This option tells QEMU that it never needs to write any
560data to the disk but can instead keep things in cache. If anything goes wrong,
Stefan Weile7d81002011-12-10 00:19:46 +0100561like your host losing power, the disk storage getting disconnected accidentally,
Kevin Wolfa13e5e02012-11-21 12:26:56 +0100562etc. your image will most probably be rendered unusable. When using
Alexander Grafc3177282010-05-26 21:04:32 +0200563the @option{-snapshot} option, unsafe caching is always used.
Alexander Graf016f5cf2010-05-26 17:51:49 +0200564
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +0000565Copy-on-read avoids accessing the same backing file sectors repeatedly and is
566useful when the backing file is over a slow network. By default copy-on-read
567is off.
568
blueswir15824d652009-03-28 06:44:27 +0000569Instead of @option{-cdrom} you can use:
570@example
Stefan Weil3804da92012-05-11 22:21:50 +0200571qemu-system-i386 -drive file=file,index=2,media=cdrom
blueswir15824d652009-03-28 06:44:27 +0000572@end example
573
574Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
575use:
576@example
Stefan Weil3804da92012-05-11 22:21:50 +0200577qemu-system-i386 -drive file=file,index=0,media=disk
578qemu-system-i386 -drive file=file,index=1,media=disk
579qemu-system-i386 -drive file=file,index=2,media=disk
580qemu-system-i386 -drive file=file,index=3,media=disk
blueswir15824d652009-03-28 06:44:27 +0000581@end example
582
Corey Bryant587ed6b2012-10-18 15:19:34 -0400583You can open an image using pre-opened file descriptors from an fd set:
584@example
585qemu-system-i386
586-add-fd fd=3,set=2,opaque="rdwr:/path/to/file"
587-add-fd fd=4,set=2,opaque="rdonly:/path/to/file"
588-drive file=/dev/fdset/2,index=0,media=disk
589@end example
590
blueswir15824d652009-03-28 06:44:27 +0000591You can connect a CDROM to the slave of ide0:
592@example
Stefan Weil3804da92012-05-11 22:21:50 +0200593qemu-system-i386 -drive file=file,if=ide,index=1,media=cdrom
blueswir15824d652009-03-28 06:44:27 +0000594@end example
595
596If you don't specify the "file=" argument, you define an empty drive:
597@example
Stefan Weil3804da92012-05-11 22:21:50 +0200598qemu-system-i386 -drive if=ide,index=1,media=cdrom
blueswir15824d652009-03-28 06:44:27 +0000599@end example
600
601You can connect a SCSI disk with unit ID 6 on the bus #0:
602@example
Stefan Weil3804da92012-05-11 22:21:50 +0200603qemu-system-i386 -drive file=file,if=scsi,bus=0,unit=6
blueswir15824d652009-03-28 06:44:27 +0000604@end example
605
606Instead of @option{-fda}, @option{-fdb}, you can use:
607@example
Stefan Weil3804da92012-05-11 22:21:50 +0200608qemu-system-i386 -drive file=file,index=0,if=floppy
609qemu-system-i386 -drive file=file,index=1,if=floppy
blueswir15824d652009-03-28 06:44:27 +0000610@end example
611
612By default, @var{interface} is "ide" and @var{index} is automatically
613incremented:
614@example
Stefan Weil3804da92012-05-11 22:21:50 +0200615qemu-system-i386 -drive file=a -drive file=b"
blueswir15824d652009-03-28 06:44:27 +0000616@end example
617is interpreted like:
618@example
Stefan Weil3804da92012-05-11 22:21:50 +0200619qemu-system-i386 -hda a -hdb b
blueswir15824d652009-03-28 06:44:27 +0000620@end example
621ETEXI
622
623DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock,
Blue Swirlad960902010-03-29 19:23:52 +0000624 "-mtdblock file use 'file' as on-board Flash memory image\n",
625 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000626STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +0200627@item -mtdblock @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100628@findex -mtdblock
Kevin Wolf4e257e52009-10-09 10:58:36 +0200629Use @var{file} as on-board Flash memory image.
blueswir15824d652009-03-28 06:44:27 +0000630ETEXI
631
632DEF("sd", HAS_ARG, QEMU_OPTION_sd,
Blue Swirlad960902010-03-29 19:23:52 +0000633 "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000634STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +0200635@item -sd @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100636@findex -sd
Kevin Wolf4e257e52009-10-09 10:58:36 +0200637Use @var{file} as SecureDigital card image.
blueswir15824d652009-03-28 06:44:27 +0000638ETEXI
639
640DEF("pflash", HAS_ARG, QEMU_OPTION_pflash,
Blue Swirlad960902010-03-29 19:23:52 +0000641 "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000642STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +0200643@item -pflash @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100644@findex -pflash
Kevin Wolf4e257e52009-10-09 10:58:36 +0200645Use @var{file} as a parallel flash image.
blueswir15824d652009-03-28 06:44:27 +0000646ETEXI
647
blueswir15824d652009-03-28 06:44:27 +0000648DEF("snapshot", 0, QEMU_OPTION_snapshot,
Blue Swirlad960902010-03-29 19:23:52 +0000649 "-snapshot write to temporary files instead of disk image files\n",
650 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000651STEXI
652@item -snapshot
Stefan Weil6616b2a2010-02-05 23:52:05 +0100653@findex -snapshot
blueswir15824d652009-03-28 06:44:27 +0000654Write to temporary files instead of disk image files. In this case,
655the raw disk image you use is not written back. You can however force
656the write back by pressing @key{C-a s} (@pxref{disk_images}).
657ETEXI
658
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100659DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \
660 "-hdachs c,h,s[,t]\n" \
661 " force hard disk 0 physical geometry and the optional BIOS\n" \
662 " translation (t=none or lba) (usually QEMU can guess them)\n",
Blue Swirlad960902010-03-29 19:23:52 +0000663 QEMU_ARCH_ALL)
Marcelo Tosattic9027602010-03-01 20:25:08 -0300664STEXI
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100665@item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
666@findex -hdachs
667Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
668@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
669translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
670all those parameters. This option is useful for old MS-DOS disk
671images.
Markus Armbrusterc70a01e2013-02-13 19:49:40 +0100672ETEXI
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530673
674DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev,
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530675 "-fsdev fsdriver,id=id[,path=path,][security_model={mapped-xattr|mapped-file|passthrough|none}]\n"
M. Mohan Kumar84a87cc2011-12-14 13:58:47 +0530676 " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n",
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530677 QEMU_ARCH_ALL)
678
679STEXI
680
M. Mohan Kumar84a87cc2011-12-14 13:58:47 +0530681@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 +0530682@findex -fsdev
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530683Define a new file system device. Valid options are:
684@table @option
685@item @var{fsdriver}
686This option specifies the fs driver backend to use.
M. Mohan Kumarf67e3ff2011-12-14 13:58:46 +0530687Currently "local", "handle" and "proxy" file system drivers are supported.
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530688@item id=@var{id}
689Specifies identifier for this device
690@item path=@var{path}
691Specifies the export path for the file system device. Files under
692this path will be available to the 9p client on the guest.
693@item security_model=@var{security_model}
694Specifies the security model to be used for this export path.
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530695Supported security models are "passthrough", "mapped-xattr", "mapped-file" and "none".
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530696In "passthrough" security model, files are stored using the same
Stefan Weilb65ee4f2012-05-11 22:25:50 +0200697credentials as they are created on the guest. This requires QEMU
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530698to run as root. In "mapped-xattr" security model, some of the file
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530699attributes like uid, gid, mode bits and link target are stored as
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530700file attributes. For "mapped-file" these attributes are stored in the
701hidden .virtfs_metadata directory. Directories exported by this security model cannot
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530702interact with other unix tools. "none" security model is same as
703passthrough except the sever won't report failures if it fails to
M. Mohan Kumard9b36a62011-10-14 12:59:37 +0530704set file attributes like ownership. Security model is mandatory
M. Mohan Kumarf67e3ff2011-12-14 13:58:46 +0530705only for local fsdriver. Other fsdrivers (like handle, proxy) don't take
M. Mohan Kumard9b36a62011-10-14 12:59:37 +0530706security model as a parameter.
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530707@item writeout=@var{writeout}
708This is an optional argument. The only supported value is "immediate".
709This means that host page cache will be used to read and write data but
710write notification will be sent to the guest only when the data has been
711reported as written by the storage subsystem.
M. Mohan Kumar2c74c2c2011-10-25 12:10:39 +0530712@item readonly
713Enables exporting 9p share as a readonly mount for guests. By default
714read-write access is given.
M. Mohan Kumar84a87cc2011-12-14 13:58:47 +0530715@item socket=@var{socket}
716Enables proxy filesystem driver to use passed socket file for communicating
717with virtfs-proxy-helper
M. Mohan Kumarf67e3ff2011-12-14 13:58:46 +0530718@item sock_fd=@var{sock_fd}
719Enables proxy filesystem driver to use passed socket descriptor for
720communicating with virtfs-proxy-helper. Usually a helper like libvirt
721will create socketpair and pass one of the fds as sock_fd
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530722@end table
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530723
724-fsdev option is used along with -device driver "virtio-9p-pci".
725@item -device virtio-9p-pci,fsdev=@var{id},mount_tag=@var{mount_tag}
726Options for virtio-9p-pci driver are:
727@table @option
728@item fsdev=@var{id}
729Specifies the id value specified along with -fsdev option
730@item mount_tag=@var{mount_tag}
731Specifies the tag name to be used by the guest to mount this export point
732@end table
733
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530734ETEXI
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530735
Gautham R Shenoy3d54abc2010-04-29 17:45:03 +0530736DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs,
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530737 "-virtfs local,path=path,mount_tag=tag,security_model=[mapped-xattr|mapped-file|passthrough|none]\n"
M. Mohan Kumar84a87cc2011-12-14 13:58:47 +0530738 " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n",
Gautham R Shenoy3d54abc2010-04-29 17:45:03 +0530739 QEMU_ARCH_ALL)
740
741STEXI
742
M. Mohan Kumar84a87cc2011-12-14 13:58:47 +0530743@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 +0530744@findex -virtfs
Gautham R Shenoy3d54abc2010-04-29 17:45:03 +0530745
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530746The general form of a Virtual File system pass-through options are:
747@table @option
748@item @var{fsdriver}
749This option specifies the fs driver backend to use.
M. Mohan Kumarf67e3ff2011-12-14 13:58:46 +0530750Currently "local", "handle" and "proxy" file system drivers are supported.
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530751@item id=@var{id}
752Specifies identifier for this device
753@item path=@var{path}
754Specifies the export path for the file system device. Files under
755this path will be available to the 9p client on the guest.
756@item security_model=@var{security_model}
757Specifies the security model to be used for this export path.
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530758Supported security models are "passthrough", "mapped-xattr", "mapped-file" and "none".
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530759In "passthrough" security model, files are stored using the same
Stefan Weilb65ee4f2012-05-11 22:25:50 +0200760credentials as they are created on the guest. This requires QEMU
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530761to run as root. In "mapped-xattr" security model, some of the file
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530762attributes like uid, gid, mode bits and link target are stored as
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530763file attributes. For "mapped-file" these attributes are stored in the
764hidden .virtfs_metadata directory. Directories exported by this security model cannot
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530765interact with other unix tools. "none" security model is same as
766passthrough except the sever won't report failures if it fails to
M. Mohan Kumard9b36a62011-10-14 12:59:37 +0530767set file attributes like ownership. Security model is mandatory only
M. Mohan Kumarf67e3ff2011-12-14 13:58:46 +0530768for local fsdriver. Other fsdrivers (like handle, proxy) don't take security
M. Mohan Kumard9b36a62011-10-14 12:59:37 +0530769model as a parameter.
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530770@item writeout=@var{writeout}
771This is an optional argument. The only supported value is "immediate".
772This means that host page cache will be used to read and write data but
773write notification will be sent to the guest only when the data has been
774reported as written by the storage subsystem.
M. Mohan Kumar2c74c2c2011-10-25 12:10:39 +0530775@item readonly
776Enables exporting 9p share as a readonly mount for guests. By default
777read-write access is given.
M. Mohan Kumar84a87cc2011-12-14 13:58:47 +0530778@item socket=@var{socket}
779Enables proxy filesystem driver to use passed socket file for
780communicating with virtfs-proxy-helper. Usually a helper like libvirt
781will create socketpair and pass one of the fds as sock_fd
M. Mohan Kumarf67e3ff2011-12-14 13:58:46 +0530782@item sock_fd
783Enables proxy filesystem driver to use passed 'sock_fd' as the socket
784descriptor for interfacing with virtfs-proxy-helper
Gautham R Shenoy3d54abc2010-04-29 17:45:03 +0530785@end table
786ETEXI
Gautham R Shenoy3d54abc2010-04-29 17:45:03 +0530787
Aneesh Kumar K.V9db221a2011-10-25 12:10:40 +0530788DEF("virtfs_synth", 0, QEMU_OPTION_virtfs_synth,
789 "-virtfs_synth Create synthetic file system image\n",
790 QEMU_ARCH_ALL)
791STEXI
792@item -virtfs_synth
793@findex -virtfs_synth
794Create synthetic file system image
795ETEXI
796
blueswir15824d652009-03-28 06:44:27 +0000797STEXI
798@end table
799ETEXI
blueswir15824d652009-03-28 06:44:27 +0000800DEFHEADING()
801
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100802DEFHEADING(USB options:)
803STEXI
804@table @option
805ETEXI
806
807DEF("usb", 0, QEMU_OPTION_usb,
808 "-usb enable the USB driver (will be the default soon)\n",
809 QEMU_ARCH_ALL)
810STEXI
811@item -usb
812@findex -usb
813Enable the USB driver (will be the default soon)
814ETEXI
815
816DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice,
817 "-usbdevice name add the host or guest USB device 'name'\n",
818 QEMU_ARCH_ALL)
819STEXI
820
821@item -usbdevice @var{devname}
822@findex -usbdevice
823Add the USB device @var{devname}. @xref{usb_devices}.
824
825@table @option
826
827@item mouse
828Virtual Mouse. This will override the PS/2 mouse emulation when activated.
829
830@item tablet
831Pointer device that uses absolute coordinates (like a touchscreen). This
832means QEMU is able to report the mouse position without having to grab the
833mouse. Also overrides the PS/2 mouse emulation when activated.
834
835@item disk:[format=@var{format}]:@var{file}
836Mass storage device based on file. The optional @var{format} argument
837will be used rather than detecting the format. Can be used to specifiy
838@code{format=raw} to avoid interpreting an untrusted format header.
839
840@item host:@var{bus}.@var{addr}
841Pass through the host device identified by @var{bus}.@var{addr} (Linux only).
842
843@item host:@var{vendor_id}:@var{product_id}
844Pass through the host device identified by @var{vendor_id}:@var{product_id}
845(Linux only).
846
847@item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
848Serial converter to host character device @var{dev}, see @code{-serial} for the
849available devices.
850
851@item braille
852Braille device. This will use BrlAPI to display the braille output on a real
853or fake device.
854
855@item net:@var{options}
856Network adapter that supports CDC ethernet and RNDIS protocols.
857
858@end table
859ETEXI
860
861STEXI
862@end table
863ETEXI
864DEFHEADING()
865
blueswir15824d652009-03-28 06:44:27 +0000866DEFHEADING(Display options:)
blueswir15824d652009-03-28 06:44:27 +0000867STEXI
868@table @option
869ETEXI
870
Jes Sorensen1472a952011-03-16 13:33:31 +0100871DEF("display", HAS_ARG, QEMU_OPTION_display,
872 "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n"
Jes Sorensen3264ff12011-03-16 13:33:33 +0100873 " [,window_close=on|off]|curses|none|\n"
Jan Kiszka881249c2014-03-12 08:33:50 +0100874 " gtk[,grab_on_hover=on|off]|\n"
Jes Sorensen3264ff12011-03-16 13:33:33 +0100875 " vnc=<display>[,<optargs>]\n"
Jes Sorensen1472a952011-03-16 13:33:31 +0100876 " select display type\n", QEMU_ARCH_ALL)
877STEXI
878@item -display @var{type}
879@findex -display
880Select type of display to use. This option is a replacement for the
881old style -sdl/-curses/... options. Valid values for @var{type} are
882@table @option
883@item sdl
884Display video output via SDL (usually in a separate graphics
885window; see the SDL documentation for other possibilities).
886@item curses
887Display video output via curses. For graphics device models which
888support a text mode, QEMU can display this output using a
889curses/ncurses interface. Nothing is displayed when the graphics
890device is in graphical mode or if the graphics device does not support
891a text mode. Generally only the VGA device models support text mode.
Jes Sorensen4171d322011-03-16 13:33:32 +0100892@item none
893Do not display video output. The guest will still see an emulated
894graphics card, but its output will not be displayed to the QEMU
895user. This option differs from the -nographic option in that it
896only affects what is done with video output; -nographic also changes
897the destination of the serial and parallel port data.
Jan Kiszka881249c2014-03-12 08:33:50 +0100898@item gtk
899Display video output in a GTK window. This interface provides drop-down
900menus and other UI elements to configure and control the VM during
901runtime.
Jes Sorensen3264ff12011-03-16 13:33:33 +0100902@item vnc
903Start a VNC server on display <arg>
Jes Sorensen1472a952011-03-16 13:33:31 +0100904@end table
905ETEXI
906
blueswir15824d652009-03-28 06:44:27 +0000907DEF("nographic", 0, QEMU_OPTION_nographic,
Blue Swirlad960902010-03-29 19:23:52 +0000908 "-nographic disable graphical output and redirect serial I/Os to console\n",
909 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000910STEXI
911@item -nographic
Stefan Weil6616b2a2010-02-05 23:52:05 +0100912@findex -nographic
blueswir15824d652009-03-28 06:44:27 +0000913Normally, QEMU uses SDL to display the VGA output. With this option,
914you can totally disable graphical output so that QEMU is a simple
915command line application. The emulated serial port is redirected on
Paolo Bonzini02c4bdf2013-07-03 20:29:45 +0400916the console and muxed with the monitor (unless redirected elsewhere
917explicitly). Therefore, you can still use QEMU to debug a Linux kernel
Ramkumar Ramachandrab031f412013-07-20 16:53:09 +0530918with a serial console. Use @key{C-a h} for help on switching between
919the console and monitor.
blueswir15824d652009-03-28 06:44:27 +0000920ETEXI
921
blueswir15824d652009-03-28 06:44:27 +0000922DEF("curses", 0, QEMU_OPTION_curses,
Blue Swirlad960902010-03-29 19:23:52 +0000923 "-curses use a curses/ncurses interface instead of SDL\n",
924 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000925STEXI
926@item -curses
Markus Armbrusterb8f490e2013-02-13 19:49:38 +0100927@findex -curses
blueswir15824d652009-03-28 06:44:27 +0000928Normally, QEMU uses SDL to display the VGA output. With this option,
929QEMU can display the VGA output when in text mode using a
930curses/ncurses interface. Nothing is displayed in graphical mode.
931ETEXI
932
blueswir15824d652009-03-28 06:44:27 +0000933DEF("no-frame", 0, QEMU_OPTION_no_frame,
Blue Swirlad960902010-03-29 19:23:52 +0000934 "-no-frame open SDL window without a frame and window decorations\n",
935 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000936STEXI
937@item -no-frame
Stefan Weil6616b2a2010-02-05 23:52:05 +0100938@findex -no-frame
blueswir15824d652009-03-28 06:44:27 +0000939Do not use decorations for SDL windows and start them using the whole
940available screen space. This makes the using QEMU in a dedicated desktop
941workspace more convenient.
942ETEXI
943
blueswir15824d652009-03-28 06:44:27 +0000944DEF("alt-grab", 0, QEMU_OPTION_alt_grab,
Blue Swirlad960902010-03-29 19:23:52 +0000945 "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n",
946 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000947STEXI
948@item -alt-grab
Stefan Weil6616b2a2010-02-05 23:52:05 +0100949@findex -alt-grab
Brad Hardsde1db2a2011-04-29 21:46:12 +1000950Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also
951affects the special keys (for fullscreen, monitor-mode switching, etc).
blueswir15824d652009-03-28 06:44:27 +0000952ETEXI
953
Dustin Kirkland0ca9f8a2009-09-17 15:48:04 -0500954DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab,
Blue Swirlad960902010-03-29 19:23:52 +0000955 "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n",
956 QEMU_ARCH_ALL)
Dustin Kirkland0ca9f8a2009-09-17 15:48:04 -0500957STEXI
958@item -ctrl-grab
Stefan Weil6616b2a2010-02-05 23:52:05 +0100959@findex -ctrl-grab
Brad Hardsde1db2a2011-04-29 21:46:12 +1000960Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also
961affects the special keys (for fullscreen, monitor-mode switching, etc).
Dustin Kirkland0ca9f8a2009-09-17 15:48:04 -0500962ETEXI
963
blueswir15824d652009-03-28 06:44:27 +0000964DEF("no-quit", 0, QEMU_OPTION_no_quit,
Blue Swirlad960902010-03-29 19:23:52 +0000965 "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000966STEXI
967@item -no-quit
Stefan Weil6616b2a2010-02-05 23:52:05 +0100968@findex -no-quit
blueswir15824d652009-03-28 06:44:27 +0000969Disable SDL window close capability.
970ETEXI
971
blueswir15824d652009-03-28 06:44:27 +0000972DEF("sdl", 0, QEMU_OPTION_sdl,
Blue Swirlad960902010-03-29 19:23:52 +0000973 "-sdl enable SDL\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000974STEXI
975@item -sdl
Stefan Weil6616b2a2010-02-05 23:52:05 +0100976@findex -sdl
blueswir15824d652009-03-28 06:44:27 +0000977Enable SDL.
978ETEXI
979
Gerd Hoffmann29b00402010-03-11 11:13:27 -0300980DEF("spice", HAS_ARG, QEMU_OPTION_spice,
Yonit Halperin27af7782012-08-21 13:54:20 +0300981 "-spice [port=port][,tls-port=secured-port][,x509-dir=<dir>]\n"
982 " [,x509-key-file=<file>][,x509-key-password=<file>]\n"
983 " [,x509-cert-file=<file>][,x509-cacert-file=<file>]\n"
Marc-André Lureaufe4831b2015-01-13 17:57:51 +0100984 " [,x509-dh-key-file=<file>][,addr=addr][,ipv4|ipv6|unix]\n"
Yonit Halperin27af7782012-08-21 13:54:20 +0300985 " [,tls-ciphers=<list>]\n"
986 " [,tls-channel=[main|display|cursor|inputs|record|playback]]\n"
987 " [,plaintext-channel=[main|display|cursor|inputs|record|playback]]\n"
988 " [,sasl][,password=<secret>][,disable-ticketing]\n"
989 " [,image-compression=[auto_glz|auto_lz|quic|glz|lz|off]]\n"
990 " [,jpeg-wan-compression=[auto|never|always]]\n"
991 " [,zlib-glz-wan-compression=[auto|never|always]]\n"
992 " [,streaming-video=[off|all|filter]][,disable-copy-paste]\n"
Hans de Goede5ad24e52013-06-08 15:37:27 +0200993 " [,disable-agent-file-xfer][,agent-mouse=[on|off]]\n"
994 " [,playback-compression=[on|off]][,seamless-migration=[on|off]]\n"
Yonit Halperin27af7782012-08-21 13:54:20 +0300995 " enable spice\n"
996 " at least one of {port, tls-port} is mandatory\n",
997 QEMU_ARCH_ALL)
Gerd Hoffmann29b00402010-03-11 11:13:27 -0300998STEXI
999@item -spice @var{option}[,@var{option}[,...]]
1000@findex -spice
1001Enable the spice remote desktop protocol. Valid options are
1002
1003@table @option
1004
1005@item port=<nr>
Gerd Hoffmannc448e852010-03-11 11:13:32 -03001006Set the TCP port spice is listening on for plaintext channels.
Gerd Hoffmann29b00402010-03-11 11:13:27 -03001007
Gerd Hoffmann333b0ee2010-08-27 14:29:16 +02001008@item addr=<addr>
1009Set the IP address spice is listening on. Default is any address.
1010
1011@item ipv4
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02001012@itemx ipv6
1013@itemx unix
Gerd Hoffmann333b0ee2010-08-27 14:29:16 +02001014Force using the specified IP version.
1015
Gerd Hoffmann29b00402010-03-11 11:13:27 -03001016@item password=<secret>
1017Set the password you need to authenticate.
1018
Marc-André Lureau48b3ed02011-05-17 10:40:33 +02001019@item sasl
1020Require that the client use SASL to authenticate with the spice.
1021The exact choice of authentication method used is controlled from the
1022system / user's SASL configuration file for the 'qemu' service. This
1023is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
1024unprivileged user, an environment variable SASL_CONF_PATH can be used
1025to make it search alternate locations for the service config.
1026While some SASL auth methods can also provide data encryption (eg GSSAPI),
1027it is recommended that SASL always be combined with the 'tls' and
1028'x509' settings to enable use of SSL and server certificates. This
1029ensures a data encryption preventing compromise of authentication
1030credentials.
1031
Gerd Hoffmann29b00402010-03-11 11:13:27 -03001032@item disable-ticketing
1033Allow client connects without authentication.
1034
Hans de Goeded4970b02011-03-27 16:43:54 +02001035@item disable-copy-paste
1036Disable copy paste between the client and the guest.
1037
Hans de Goede5ad24e52013-06-08 15:37:27 +02001038@item disable-agent-file-xfer
1039Disable spice-vdagent based file-xfer between the client and the guest.
1040
Gerd Hoffmannc448e852010-03-11 11:13:32 -03001041@item tls-port=<nr>
1042Set the TCP port spice is listening on for encrypted channels.
1043
1044@item x509-dir=<dir>
1045Set the x509 file directory. Expects same filenames as -vnc $display,x509=$dir
1046
1047@item x509-key-file=<file>
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02001048@itemx x509-key-password=<file>
1049@itemx x509-cert-file=<file>
1050@itemx x509-cacert-file=<file>
1051@itemx x509-dh-key-file=<file>
Gerd Hoffmannc448e852010-03-11 11:13:32 -03001052The x509 file names can also be configured individually.
1053
1054@item tls-ciphers=<list>
1055Specify which ciphers to use.
1056
Alon Levyd70d6b32011-12-20 13:05:18 +02001057@item tls-channel=[main|display|cursor|inputs|record|playback]
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02001058@itemx plaintext-channel=[main|display|cursor|inputs|record|playback]
Gerd Hoffmann17b6dea2010-08-27 14:09:56 +02001059Force specific channel to be used with or without TLS encryption. The
1060options can be specified multiple times to configure multiple
1061channels. The special name "default" can be used to set the default
1062mode. For channels which are not explicitly forced into one mode the
1063spice client is allowed to pick tls/plaintext as he pleases.
1064
Yonit Halperin9f04e092010-07-14 13:26:34 +03001065@item image-compression=[auto_glz|auto_lz|quic|glz|lz|off]
1066Configure image compression (lossless).
1067Default is auto_glz.
1068
1069@item jpeg-wan-compression=[auto|never|always]
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02001070@itemx zlib-glz-wan-compression=[auto|never|always]
Yonit Halperin9f04e092010-07-14 13:26:34 +03001071Configure wan image compression (lossy for slow links).
1072Default is auto.
1073
Gerd Hoffmann84a23f22010-08-30 16:36:53 +02001074@item streaming-video=[off|all|filter]
1075Configure video stream detection. Default is filter.
1076
1077@item agent-mouse=[on|off]
1078Enable/disable passing mouse events via vdagent. Default is on.
1079
1080@item playback-compression=[on|off]
1081Enable/disable audio stream compression (using celt 0.5.1). Default is on.
1082
Yonit Halperin8c957052012-08-21 11:51:59 +03001083@item seamless-migration=[on|off]
1084Enable/disable spice seamless migration. Default is off.
1085
Gerd Hoffmann29b00402010-03-11 11:13:27 -03001086@end table
1087ETEXI
1088
blueswir15824d652009-03-28 06:44:27 +00001089DEF("portrait", 0, QEMU_OPTION_portrait,
Blue Swirlad960902010-03-29 19:23:52 +00001090 "-portrait rotate graphical output 90 deg left (only PXA LCD)\n",
1091 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001092STEXI
1093@item -portrait
Stefan Weil6616b2a2010-02-05 23:52:05 +01001094@findex -portrait
blueswir15824d652009-03-28 06:44:27 +00001095Rotate graphical output 90 deg left (only PXA LCD).
1096ETEXI
1097
Vasily Khoruzhick93128052011-06-17 13:04:36 +03001098DEF("rotate", HAS_ARG, QEMU_OPTION_rotate,
1099 "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n",
1100 QEMU_ARCH_ALL)
1101STEXI
Markus Armbruster6265c432013-02-13 19:49:39 +01001102@item -rotate @var{deg}
Vasily Khoruzhick93128052011-06-17 13:04:36 +03001103@findex -rotate
1104Rotate graphical output some deg left (only PXA LCD).
1105ETEXI
1106
blueswir15824d652009-03-28 06:44:27 +00001107DEF("vga", HAS_ARG, QEMU_OPTION_vga,
Gerd Hoffmanna94f0c52014-09-10 14:28:48 +02001108 "-vga [std|cirrus|vmware|qxl|xenfb|tcx|cg3|virtio|none]\n"
Blue Swirlad960902010-03-29 19:23:52 +00001109 " select video card type\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001110STEXI
malce4558dc2012-08-27 18:33:21 +04001111@item -vga @var{type}
Stefan Weil6616b2a2010-02-05 23:52:05 +01001112@findex -vga
blueswir15824d652009-03-28 06:44:27 +00001113Select type of VGA card to emulate. Valid values for @var{type} are
Kevin Wolfb3f046c2009-10-09 10:58:35 +02001114@table @option
blueswir15824d652009-03-28 06:44:27 +00001115@item cirrus
1116Cirrus Logic GD5446 Video card. All Windows versions starting from
1117Windows 95 should recognize and use this graphic card. For optimal
1118performances, use 16 bit color depth in the guest and the host OS.
1119(This one is the default)
1120@item std
1121Standard VGA card with Bochs VBE extensions. If your guest OS
1122supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
1123to use high resolution modes (>= 1280x1024x16) then you should use
1124this option.
1125@item vmware
1126VMWare SVGA-II compatible adapter. Use it if you have sufficiently
1127recent XFree86/XOrg server or Windows guest with a driver for this
1128card.
Gerd Hoffmanna19cbfb2010-04-27 11:50:11 +02001129@item qxl
1130QXL paravirtual graphic card. It is VGA compatible (including VESA
11312.0 VBE support). Works best with qxl guest drivers installed though.
1132Recommended choice when using the spice protocol.
Mark Cave-Ayland33632782014-03-17 21:46:25 +00001133@item tcx
1134(sun4m only) Sun TCX framebuffer. This is the default framebuffer for
1135sun4m machines and offers both 8-bit and 24-bit colour depths at a
1136fixed resolution of 1024x768.
1137@item cg3
1138(sun4m only) Sun cgthree framebuffer. This is a simple 8-bit framebuffer
1139for sun4m machines available in both 1024x768 (OpenBIOS) and 1152x900 (OBP)
1140resolutions aimed at people wishing to run older Solaris versions.
Gerd Hoffmanna94f0c52014-09-10 14:28:48 +02001141@item virtio
1142Virtio VGA card.
blueswir15824d652009-03-28 06:44:27 +00001143@item none
1144Disable VGA card.
1145@end table
1146ETEXI
1147
1148DEF("full-screen", 0, QEMU_OPTION_full_screen,
Blue Swirlad960902010-03-29 19:23:52 +00001149 "-full-screen start in full screen\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001150STEXI
1151@item -full-screen
Stefan Weil6616b2a2010-02-05 23:52:05 +01001152@findex -full-screen
blueswir15824d652009-03-28 06:44:27 +00001153Start in full screen.
1154ETEXI
1155
blueswir15824d652009-03-28 06:44:27 +00001156DEF("g", 1, QEMU_OPTION_g ,
Blue Swirlad960902010-03-29 19:23:52 +00001157 "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n",
1158 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
blueswir15824d652009-03-28 06:44:27 +00001159STEXI
Stefan Weil95d5f082010-01-20 22:25:27 +01001160@item -g @var{width}x@var{height}[x@var{depth}]
Stefan Weil6616b2a2010-02-05 23:52:05 +01001161@findex -g
Stefan Weil95d5f082010-01-20 22:25:27 +01001162Set the initial graphical resolution and depth (PPC, SPARC only).
blueswir15824d652009-03-28 06:44:27 +00001163ETEXI
1164
1165DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
Blue Swirlad960902010-03-29 19:23:52 +00001166 "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001167STEXI
1168@item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
Stefan Weil6616b2a2010-02-05 23:52:05 +01001169@findex -vnc
blueswir15824d652009-03-28 06:44:27 +00001170Normally, QEMU uses SDL to display the VGA output. With this option,
1171you can have QEMU listen on VNC display @var{display} and redirect the VGA
1172display over the VNC session. It is very useful to enable the usb
1173tablet device when using this option (option @option{-usbdevice
1174tablet}). When using the VNC display, you must use the @option{-k}
1175parameter to set the keyboard layout if you are not using en-us. Valid
1176syntax for the @var{display} is
1177
Kevin Wolfb3f046c2009-10-09 10:58:35 +02001178@table @option
blueswir15824d652009-03-28 06:44:27 +00001179
1180@item @var{host}:@var{d}
1181
1182TCP connections will only be allowed from @var{host} on display @var{d}.
1183By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
1184be omitted in which case the server will accept connections from any host.
1185
Kevin Wolf4e257e52009-10-09 10:58:36 +02001186@item unix:@var{path}
blueswir15824d652009-03-28 06:44:27 +00001187
1188Connections will be allowed over UNIX domain sockets where @var{path} is the
1189location of a unix socket to listen for connections on.
1190
1191@item none
1192
1193VNC is initialized but not started. The monitor @code{change} command
1194can be used to later start the VNC server.
1195
1196@end table
1197
1198Following the @var{display} value there may be one or more @var{option} flags
1199separated by commas. Valid options are
1200
Kevin Wolfb3f046c2009-10-09 10:58:35 +02001201@table @option
blueswir15824d652009-03-28 06:44:27 +00001202
1203@item reverse
1204
1205Connect to a listening VNC client via a ``reverse'' connection. The
1206client is specified by the @var{display}. For reverse network
1207connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
1208is a TCP port number, not a display number.
1209
Tim Hardeck7536ee42013-01-21 11:04:44 +01001210@item websocket
1211
1212Opens an additional TCP listening port dedicated to VNC Websocket connections.
Peter Maydell085d8132013-03-18 17:20:07 +00001213By definition the Websocket port is 5700+@var{display}. If @var{host} is
Tim Hardeck7536ee42013-01-21 11:04:44 +01001214specified connections will only be allowed from this host.
1215As an alternative the Websocket port could be specified by using
1216@code{websocket}=@var{port}.
Tim Hardeck0057a0d2013-04-23 16:33:01 +02001217TLS encryption for the Websocket connection is supported if the required
1218certificates are specified with the VNC option @option{x509}.
Tim Hardeck7536ee42013-01-21 11:04:44 +01001219
blueswir15824d652009-03-28 06:44:27 +00001220@item password
1221
1222Require that password based authentication is used for client connections.
Michal Novotny86ee5bc2012-07-16 15:54:38 +02001223
1224The password must be set separately using the @code{set_password} command in
1225the @ref{pcsys_monitor}. The syntax to change your password is:
1226@code{set_password <protocol> <password>} where <protocol> could be either
1227"vnc" or "spice".
1228
1229If you would like to change <protocol> password expiration, you should use
1230@code{expire_password <protocol> <expiration-time>} where expiration time could
1231be one of the following options: now, never, +seconds or UNIX time of
1232expiration, e.g. +60 to make password expire in 60 seconds, or 1335196800
1233to make password expire on "Mon Apr 23 12:00:00 EDT 2012" (UNIX time for this
1234date and time).
1235
1236You can also use keywords "now" or "never" for the expiration time to
1237allow <protocol> password to expire immediately or never expire.
blueswir15824d652009-03-28 06:44:27 +00001238
1239@item tls
1240
1241Require that client use TLS when communicating with the VNC server. This
1242uses anonymous TLS credentials so is susceptible to a man-in-the-middle
1243attack. It is recommended that this option be combined with either the
Kevin Wolf4e257e52009-10-09 10:58:36 +02001244@option{x509} or @option{x509verify} options.
blueswir15824d652009-03-28 06:44:27 +00001245
1246@item x509=@var{/path/to/certificate/dir}
1247
1248Valid if @option{tls} is specified. Require that x509 credentials are used
1249for negotiating the TLS session. The server will send its x509 certificate
1250to the client. It is recommended that a password be set on the VNC server
1251to provide authentication of the client when this is used. The path following
1252this option specifies where the x509 certificates are to be loaded from.
1253See the @ref{vnc_security} section for details on generating certificates.
1254
1255@item x509verify=@var{/path/to/certificate/dir}
1256
1257Valid if @option{tls} is specified. Require that x509 credentials are used
1258for negotiating the TLS session. The server will send its x509 certificate
1259to the client, and request that the client send its own x509 certificate.
1260The server will validate the client's certificate against the CA certificate,
1261and reject clients when validation fails. If the certificate authority is
1262trusted, this is a sufficient authentication mechanism. You may still wish
1263to set a password on the VNC server as a second authentication layer. The
1264path following this option specifies where the x509 certificates are to
1265be loaded from. See the @ref{vnc_security} section for details on generating
1266certificates.
1267
1268@item sasl
1269
1270Require that the client use SASL to authenticate with the VNC server.
1271The exact choice of authentication method used is controlled from the
1272system / user's SASL configuration file for the 'qemu' service. This
1273is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
1274unprivileged user, an environment variable SASL_CONF_PATH can be used
1275to make it search alternate locations for the service config.
1276While some SASL auth methods can also provide data encryption (eg GSSAPI),
1277it is recommended that SASL always be combined with the 'tls' and
1278'x509' settings to enable use of SSL and server certificates. This
1279ensures a data encryption preventing compromise of authentication
1280credentials. See the @ref{vnc_security} section for details on using
1281SASL authentication.
1282
1283@item acl
1284
1285Turn on access control lists for checking of the x509 client certificate
1286and SASL party. For x509 certs, the ACL check is made against the
1287certificate's distinguished name. This is something that looks like
1288@code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
1289made against the username, which depending on the SASL plugin, may
1290include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
1291When the @option{acl} flag is set, the initial access list will be
1292empty, with a @code{deny} policy. Thus no one will be allowed to
1293use the VNC server until the ACLs have been loaded. This can be
1294achieved using the @code{acl} monitor command.
1295
Corentin Chary6f9c78c2010-07-07 20:57:51 +02001296@item lossy
1297
1298Enable lossy compression methods (gradient, JPEG, ...). If this
1299option is set, VNC client may receive lossy framebuffer updates
1300depending on its encoding settings. Enabling this option can save
1301a lot of bandwidth at the expense of quality.
1302
Corentin Chary80e0c8c2011-02-04 09:06:08 +01001303@item non-adaptive
1304
1305Disable adaptive encodings. Adaptive encodings are enabled by default.
1306An adaptive encoding will try to detect frequently updated screen regions,
1307and send updates in these regions using a lossy encoding (like JPEG).
Stefan Weil61cc8702011-04-13 22:45:22 +02001308This can be really helpful to save bandwidth when playing videos. Disabling
Michael Tokarev9d85d552014-04-07 13:34:58 +04001309adaptive encodings restores the original static behavior of encodings
Corentin Chary80e0c8c2011-02-04 09:06:08 +01001310like Tight.
1311
Gerd Hoffmann8cf36482011-11-24 18:10:49 +01001312@item share=[allow-exclusive|force-shared|ignore]
1313
1314Set display sharing policy. 'allow-exclusive' allows clients to ask
1315for exclusive access. As suggested by the rfb spec this is
1316implemented by dropping other connections. Connecting multiple
1317clients in parallel requires all clients asking for a shared session
1318(vncviewer: -shared switch). This is the default. 'force-shared'
1319disables exclusive client access. Useful for shared desktop sessions,
1320where you don't want someone forgetting specify -shared disconnect
1321everybody else. 'ignore' completely ignores the shared flag and
1322allows everybody connect unconditionally. Doesn't conform to the rfb
Stefan Weilb65ee4f2012-05-11 22:25:50 +02001323spec but is traditional QEMU behavior.
Gerd Hoffmann8cf36482011-11-24 18:10:49 +01001324
blueswir15824d652009-03-28 06:44:27 +00001325@end table
1326ETEXI
1327
1328STEXI
1329@end table
1330ETEXI
Michael Ellermana3adb7a2011-12-19 17:19:31 +11001331ARCHHEADING(, QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001332
Michael Ellermana3adb7a2011-12-19 17:19:31 +11001333ARCHHEADING(i386 target only:, QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001334STEXI
1335@table @option
1336ETEXI
1337
blueswir15824d652009-03-28 06:44:27 +00001338DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack,
Blue Swirlad960902010-03-29 19:23:52 +00001339 "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n",
1340 QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001341STEXI
1342@item -win2k-hack
Stefan Weil6616b2a2010-02-05 23:52:05 +01001343@findex -win2k-hack
blueswir15824d652009-03-28 06:44:27 +00001344Use it when installing Windows 2000 to avoid a disk full bug. After
1345Windows 2000 is installed, you no longer need this option (this option
1346slows down the IDE transfers).
1347ETEXI
1348
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02001349HXCOMM Deprecated by -rtc
Blue Swirlad960902010-03-29 19:23:52 +00001350DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001351
blueswir15824d652009-03-28 06:44:27 +00001352DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk,
Blue Swirlad960902010-03-29 19:23:52 +00001353 "-no-fd-bootchk disable boot signature checking for floppy disks\n",
1354 QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001355STEXI
1356@item -no-fd-bootchk
Stefan Weil6616b2a2010-02-05 23:52:05 +01001357@findex -no-fd-bootchk
Markus Armbruster4eda32f2013-06-14 13:15:06 +02001358Disable boot signature checking for floppy disks in BIOS. May
blueswir15824d652009-03-28 06:44:27 +00001359be needed to boot from old floppy disks.
1360ETEXI
1361
blueswir15824d652009-03-28 06:44:27 +00001362DEF("no-acpi", 0, QEMU_OPTION_no_acpi,
Shannon Zhaof5d8c8c2015-05-29 11:28:54 +01001363 "-no-acpi disable ACPI\n", QEMU_ARCH_I386 | QEMU_ARCH_ARM)
blueswir15824d652009-03-28 06:44:27 +00001364STEXI
1365@item -no-acpi
Stefan Weil6616b2a2010-02-05 23:52:05 +01001366@findex -no-acpi
blueswir15824d652009-03-28 06:44:27 +00001367Disable ACPI (Advanced Configuration and Power Interface) support. Use
1368it if your guest OS complains about ACPI problems (PC target machine
1369only).
1370ETEXI
1371
blueswir15824d652009-03-28 06:44:27 +00001372DEF("no-hpet", 0, QEMU_OPTION_no_hpet,
Blue Swirlad960902010-03-29 19:23:52 +00001373 "-no-hpet disable HPET\n", QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001374STEXI
1375@item -no-hpet
Stefan Weil6616b2a2010-02-05 23:52:05 +01001376@findex -no-hpet
blueswir15824d652009-03-28 06:44:27 +00001377Disable HPET support.
1378ETEXI
1379
blueswir15824d652009-03-28 06:44:27 +00001380DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable,
Michael Tokarev104bf022011-05-12 18:44:17 +04001381 "-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 +00001382 " ACPI table description\n", QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001383STEXI
1384@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 +01001385@findex -acpitable
blueswir15824d652009-03-28 06:44:27 +00001386Add ACPI table with specified header fields and context from specified files.
Michael Tokarev104bf022011-05-12 18:44:17 +04001387For file=, take whole ACPI table from the specified files, including all
1388ACPI headers (possible overridden by other options).
1389For data=, only data
1390portion of the table is used, all header information is specified in the
1391command line.
blueswir15824d652009-03-28 06:44:27 +00001392ETEXI
1393
aliguorib6f6e3d2009-04-17 18:59:56 +00001394DEF("smbios", HAS_ARG, QEMU_OPTION_smbios,
1395 "-smbios file=binary\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -07001396 " load SMBIOS entry from binary file\n"
Gabriel L. Somlob155eb12015-02-05 11:45:30 -05001397 "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n"
1398 " [,uefi=on|off]\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -07001399 " specify SMBIOS type 0 fields\n"
aliguorib6f6e3d2009-04-17 18:59:56 +00001400 "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n"
1401 " [,uuid=uuid][,sku=str][,family=str]\n"
Gabriel L. Somlob155eb12015-02-05 11:45:30 -05001402 " specify SMBIOS type 1 fields\n"
1403 "-smbios type=2[,manufacturer=str][,product=str][,version=str][,serial=str]\n"
1404 " [,asset=str][,location=str]\n"
1405 " specify SMBIOS type 2 fields\n"
1406 "-smbios type=3[,manufacturer=str][,version=str][,serial=str][,asset=str]\n"
1407 " [,sku=str]\n"
1408 " specify SMBIOS type 3 fields\n"
1409 "-smbios type=4[,sock_pfx=str][,manufacturer=str][,version=str][,serial=str]\n"
1410 " [,asset=str][,part=str]\n"
1411 " specify SMBIOS type 4 fields\n"
1412 "-smbios type=17[,loc_pfx=str][,bank=str][,manufacturer=str][,serial=str]\n"
Gabriel L. Somlo3ebd6cc2015-03-11 13:58:01 -04001413 " [,asset=str][,part=str][,speed=%d]\n"
Gabriel L. Somlob155eb12015-02-05 11:45:30 -05001414 " specify SMBIOS type 17 fields\n",
Wei Huangc30e1562015-09-07 10:39:29 +01001415 QEMU_ARCH_I386 | QEMU_ARCH_ARM)
aliguorib6f6e3d2009-04-17 18:59:56 +00001416STEXI
1417@item -smbios file=@var{binary}
Stefan Weil6616b2a2010-02-05 23:52:05 +01001418@findex -smbios
aliguorib6f6e3d2009-04-17 18:59:56 +00001419Load SMBIOS entry from binary file.
1420
Gabriel L. Somlo84351842014-05-19 10:09:54 -04001421@item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}][,uefi=on|off]
aliguorib6f6e3d2009-04-17 18:59:56 +00001422Specify SMBIOS type 0 fields
1423
Gabriel L. Somlob155eb12015-02-05 11:45:30 -05001424@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 +00001425Specify SMBIOS type 1 fields
Gabriel L. Somlob155eb12015-02-05 11:45:30 -05001426
1427@item -smbios type=2[,manufacturer=@var{str}][,product=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,location=@var{str}][,family=@var{str}]
1428Specify SMBIOS type 2 fields
1429
1430@item -smbios type=3[,manufacturer=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,sku=@var{str}]
1431Specify SMBIOS type 3 fields
1432
1433@item -smbios type=4[,sock_pfx=@var{str}][,manufacturer=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,part=@var{str}]
1434Specify SMBIOS type 4 fields
1435
Gabriel L. Somlo3ebd6cc2015-03-11 13:58:01 -04001436@item -smbios type=17[,loc_pfx=@var{str}][,bank=@var{str}][,manufacturer=@var{str}][,serial=@var{str}][,asset=@var{str}][,part=@var{str}][,speed=@var{%d}]
Gabriel L. Somlob155eb12015-02-05 11:45:30 -05001437Specify SMBIOS type 17 fields
aliguorib6f6e3d2009-04-17 18:59:56 +00001438ETEXI
1439
blueswir15824d652009-03-28 06:44:27 +00001440STEXI
1441@end table
1442ETEXI
Markus Armbrusterc70a01e2013-02-13 19:49:40 +01001443DEFHEADING()
blueswir15824d652009-03-28 06:44:27 +00001444
1445DEFHEADING(Network options:)
1446STEXI
1447@table @option
1448ETEXI
1449
Jan Kiszkaad196a92009-06-24 14:42:28 +02001450HXCOMM Legacy slirp options (now moved to -net user):
1451#ifdef CONFIG_SLIRP
Blue Swirlad960902010-03-29 19:23:52 +00001452DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL)
1453DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL)
1454DEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL)
Jan Kiszkaad196a92009-06-24 14:42:28 +02001455#ifndef _WIN32
Blue Swirlad960902010-03-29 19:23:52 +00001456DEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL)
Jan Kiszkaad196a92009-06-24 14:42:28 +02001457#endif
1458#endif
1459
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001460DEF("netdev", HAS_ARG, QEMU_OPTION_netdev,
blueswir15824d652009-03-28 06:44:27 +00001461#ifdef CONFIG_SLIRP
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001462 "-netdev user,id=str[,net=addr[/mask]][,host=addr][,restrict=on|off]\n"
Klaus Stengel63d29602012-10-27 19:53:39 +02001463 " [,hostname=host][,dhcpstart=addr][,dns=addr][,dnssearch=domain][,tftp=dir]\n"
1464 " [,bootfile=f][,hostfwd=rule][,guestfwd=rule]"
Jan Kiszkaad196a92009-06-24 14:42:28 +02001465#ifndef _WIN32
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001466 "[,smb=dir[,smbserver=addr]]\n"
Jan Kiszkaad196a92009-06-24 14:42:28 +02001467#endif
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001468 " configure a user mode network backend with ID 'str',\n"
1469 " its DHCP server and optional services\n"
blueswir15824d652009-03-28 06:44:27 +00001470#endif
1471#ifdef _WIN32
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001472 "-netdev tap,id=str,ifname=name\n"
1473 " configure a host TAP network backend with ID 'str'\n"
blueswir15824d652009-03-28 06:44:27 +00001474#else
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001475 "-netdev tap,id=str[,fd=h][,fds=x:y:...:z][,ifname=name][,script=file][,downscript=dfile]\n"
1476 " [,helper=helper][,sndbuf=nbytes][,vnet_hdr=on|off][,vhost=on|off]\n"
1477 " [,vhostfd=h][,vhostfds=x:y:...:z][,vhostforce=on|off][,queues=n]\n"
1478 " configure a host TAP network backend with ID 'str'\n"
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001479 " use network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n"
1480 " to configure it and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n"
1481 " to deconfigure it\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -07001482 " use '[down]script=no' to disable script execution\n"
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001483 " use network helper 'helper' (default=" DEFAULT_BRIDGE_HELPER ") to\n"
1484 " configure it\n"
blueswir15824d652009-03-28 06:44:27 +00001485 " use 'fd=h' to connect to an already opened TAP interface\n"
Jason Wang2ca81ba2013-02-20 18:04:01 +08001486 " use 'fds=x:y:...:z' to connect to already opened multiqueue capable TAP interfaces\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -07001487 " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n"
Michael S. Tsirkinf157ed22011-02-01 14:25:40 +02001488 " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -07001489 " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n"
1490 " 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 +02001491 " use vhost=on to enable experimental in kernel accelerator\n"
mst@redhat.com5430a282011-02-01 22:13:42 +02001492 " (only has effect for virtio guests which use MSIX)\n"
1493 " use vhostforce=on to force vhost on for non-MSIX virtio guests\n"
Michael S. Tsirkin82b0d802010-03-17 13:08:24 +02001494 " use 'vhostfd=h' to connect to an already opened vhost net device\n"
Jason Wang2ca81ba2013-02-20 18:04:01 +08001495 " use 'vhostfds=x:y:...:z to connect to multiple already opened vhost net devices\n"
Jason Wangec396012013-02-22 22:57:52 +08001496 " use 'queues=n' to specify the number of queues to be created for multiqueue TAP\n"
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001497 "-netdev bridge,id=str[,br=bridge][,helper=helper]\n"
1498 " configure a host TAP network backend with ID 'str' that is\n"
1499 " connected to a bridge (default=" DEFAULT_BRIDGE_INTERFACE ")\n"
1500 " using the program 'helper (default=" DEFAULT_BRIDGE_HELPER ")\n"
Mark McLoughlin0df0ff62009-06-18 18:21:34 +01001501#endif
Anton Ivanov3fb69aa2014-06-20 10:34:41 +01001502#ifdef __linux__
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001503 "-netdev l2tpv3,id=str,src=srcaddr,dst=dstaddr[,srcport=srcport][,dstport=dstport]\n"
1504 " [,rxsession=rxsession],txsession=txsession[,ipv6=on/off][,udp=on/off]\n"
1505 " [,cookie64=on/off][,counter][,pincounter][,txcookie=txcookie]\n"
1506 " [,rxcookie=rxcookie][,offset=offset]\n"
1507 " configure a network backend with ID 'str' connected to\n"
1508 " an Ethernet over L2TPv3 pseudowire.\n"
Anton Ivanov3fb69aa2014-06-20 10:34:41 +01001509 " Linux kernel 3.3+ as well as most routers can talk\n"
Michael Tokarev2f47b402014-07-24 20:10:17 +04001510 " L2TPv3. This transport allows connecting a VM to a VM,\n"
Anton Ivanov3fb69aa2014-06-20 10:34:41 +01001511 " VM to a router and even VM to Host. It is a nearly-universal\n"
1512 " standard (RFC3391). Note - this implementation uses static\n"
1513 " pre-configured tunnels (same as the Linux kernel).\n"
1514 " use 'src=' to specify source address\n"
1515 " use 'dst=' to specify destination address\n"
1516 " use 'udp=on' to specify udp encapsulation\n"
Gonglei39526512014-08-14 14:35:48 +08001517 " use 'srcport=' to specify source udp port\n"
Anton Ivanov3fb69aa2014-06-20 10:34:41 +01001518 " use 'dstport=' to specify destination udp port\n"
1519 " use 'ipv6=on' to force v6\n"
1520 " L2TPv3 uses cookies to prevent misconfiguration as\n"
1521 " well as a weak security measure\n"
1522 " use 'rxcookie=0x012345678' to specify a rxcookie\n"
1523 " use 'txcookie=0x012345678' to specify a txcookie\n"
1524 " use 'cookie64=on' to set cookie size to 64 bit, otherwise 32\n"
1525 " use 'counter=off' to force a 'cut-down' L2TPv3 with no counter\n"
1526 " use 'pincounter=on' to work around broken counter handling in peer\n"
1527 " use 'offset=X' to add an extra offset between header and data\n"
1528#endif
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001529 "-netdev socket,id=str[,fd=h][,listen=[host]:port][,connect=host:port]\n"
1530 " configure a network backend to connect to another network\n"
1531 " using a socket connection\n"
1532 "-netdev socket,id=str[,fd=h][,mcast=maddr:port[,localaddr=addr]]\n"
1533 " configure a network backend to connect to a multicast maddr and port\n"
Mike Ryan3a75e742010-12-01 11:16:47 -08001534 " use 'localaddr=addr' to specify the host address to send packets from\n"
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001535 "-netdev socket,id=str[,fd=h][,udp=host:port][,localaddr=host:port]\n"
1536 " configure a network backend to connect to another network\n"
1537 " using an UDP tunnel\n"
blueswir15824d652009-03-28 06:44:27 +00001538#ifdef CONFIG_VDE
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001539 "-netdev vde,id=str[,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n"
1540 " configure a network backend to connect to port 'n' of a vde switch\n"
1541 " running on host and listening for incoming connections on 'socketpath'.\n"
blueswir15824d652009-03-28 06:44:27 +00001542 " Use group 'groupname' and mode 'octalmode' to change default\n"
1543 " ownership and permissions for communication port.\n"
1544#endif
Vincenzo Maffione58952132013-11-06 11:44:06 +01001545#ifdef CONFIG_NETMAP
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001546 "-netdev netmap,id=str,ifname=name[,devname=nmname]\n"
Vincenzo Maffione58952132013-11-06 11:44:06 +01001547 " attach to the existing netmap-enabled network interface 'name', or to a\n"
1548 " VALE port (created on the fly) called 'name' ('nmname' is name of the \n"
1549 " netmap device, defaults to '/dev/netmap')\n"
1550#endif
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001551 "-netdev vhost-user,id=str,chardev=dev[,vhostforce=on|off]\n"
1552 " configure a vhost-user network, backed by a chardev 'dev'\n"
1553 "-netdev hubport,id=str,hubid=n\n"
1554 " configure a hub port on QEMU VLAN 'n'\n", QEMU_ARCH_ALL)
1555DEF("net", HAS_ARG, QEMU_OPTION_net,
1556 "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n"
1557 " old way to create a new NIC and connect it to VLAN 'n'\n"
1558 " (use the '-device devtype,netdev=str' option if possible instead)\n"
aliguoribb9ea792009-04-21 19:56:28 +00001559 "-net dump[,vlan=n][,file=f][,len=n]\n"
1560 " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -07001561 "-net none use it alone to have zero network devices. If no -net option\n"
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001562 " is provided, the default is '-net nic -net user'\n"
1563 "-net ["
Mark McLoughlina1ea4582009-10-08 19:58:26 +01001564#ifdef CONFIG_SLIRP
1565 "user|"
1566#endif
1567 "tap|"
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001568 "bridge|"
Mark McLoughlina1ea4582009-10-08 19:58:26 +01001569#ifdef CONFIG_VDE
1570 "vde|"
1571#endif
Vincenzo Maffione58952132013-11-06 11:44:06 +01001572#ifdef CONFIG_NETMAP
1573 "netmap|"
1574#endif
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001575 "socket][,vlan=n][,option][,option][,...]\n"
1576 " old way to initialize a host network interface\n"
1577 " (use the -netdev option if possible instead)\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001578STEXI
Blue Swirl609c1da2010-03-18 18:41:49 +00001579@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 +01001580@findex -net
blueswir15824d652009-03-28 06:44:27 +00001581Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
Anthony Liguori0d6b0b12009-08-14 11:20:47 -05001582= 0 is the default). The NIC is an e1000 by default on the PC
Markus Armbruster5607c382009-06-18 15:14:08 +02001583target. Optionally, the MAC address can be changed to @var{mac}, the
1584device address set to @var{addr} (PCI cards only),
Michael S. Tsirkinffe63702009-06-21 19:51:18 +03001585and a @var{name} can be assigned for use in monitor commands.
1586Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
1587that the card should have; this option currently only affects virtio cards; set
1588@var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
Stefan Weil071c9392012-04-07 09:23:36 +02001589NIC is created. QEMU can emulate several different models of network card.
blueswir15824d652009-03-28 06:44:27 +00001590Valid values for @var{type} are
Michael S. Tsirkinffe63702009-06-21 19:51:18 +03001591@code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er},
blueswir15824d652009-03-28 06:44:27 +00001592@code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
1593@code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
Peter Maydell585f6032012-10-04 16:22:01 +01001594Not all devices are supported on all targets. Use @code{-net nic,model=help}
blueswir15824d652009-03-28 06:44:27 +00001595for a list of available devices for your target.
1596
Stefan Hajnoczi08d12022012-08-14 14:14:27 +01001597@item -netdev user,id=@var{id}[,@var{option}][,@var{option}][,...]
Markus Armbrusterb8f490e2013-02-13 19:49:38 +01001598@findex -netdev
Jan Kiszkaad196a92009-06-24 14:42:28 +02001599@item -net user[,@var{option}][,@var{option}][,...]
blueswir15824d652009-03-28 06:44:27 +00001600Use the user mode network stack which requires no administrator
Jan Kiszkaad196a92009-06-24 14:42:28 +02001601privilege to run. Valid options are:
blueswir15824d652009-03-28 06:44:27 +00001602
Kevin Wolfb3f046c2009-10-09 10:58:35 +02001603@table @option
Jan Kiszkaad196a92009-06-24 14:42:28 +02001604@item vlan=@var{n}
1605Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default).
1606
Stefan Hajnoczi08d12022012-08-14 14:14:27 +01001607@item id=@var{id}
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02001608@itemx name=@var{name}
Jan Kiszkaad196a92009-06-24 14:42:28 +02001609Assign symbolic name for use in monitor commands.
1610
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001611@item net=@var{addr}[/@var{mask}]
1612Set IP network address the guest will see. Optionally specify the netmask,
1613either in the form a.b.c.d or as number of valid top-most bits. Default is
Brad Hardsb0b36e52011-04-24 17:19:56 +1000161410.0.2.0/24.
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001615
1616@item host=@var{addr}
1617Specify the guest-visible address of the host. Default is the 2nd IP in the
1618guest network, i.e. x.x.x.2.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001619
Jan Kiszkac54ed5b2011-07-20 12:20:14 +02001620@item restrict=on|off
Brad Hardscaef55e2011-06-09 07:50:43 +10001621If this option is enabled, the guest will be isolated, i.e. it will not be
Jan Kiszkaad196a92009-06-24 14:42:28 +02001622able to contact the host and no guest IP packets will be routed over the host
Brad Hardscaef55e2011-06-09 07:50:43 +10001623to the outside. This option does not affect any explicitly set forwarding rules.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001624
1625@item hostname=@var{name}
Klaus Stengel63d29602012-10-27 19:53:39 +02001626Specifies the client hostname reported by the built-in DHCP server.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001627
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001628@item dhcpstart=@var{addr}
1629Specify the first of the 16 IPs the built-in DHCP server can assign. Default
Brad Hardsb0b36e52011-04-24 17:19:56 +10001630is 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 +02001631
1632@item dns=@var{addr}
1633Specify the guest-visible address of the virtual nameserver. The address must
1634be different from the host address. Default is the 3rd IP in the guest network,
1635i.e. x.x.x.3.
1636
Klaus Stengel63d29602012-10-27 19:53:39 +02001637@item dnssearch=@var{domain}
1638Provides an entry for the domain-search list sent by the built-in
1639DHCP server. More than one domain suffix can be transmitted by specifying
1640this option multiple times. If supported, this will cause the guest to
1641automatically try to append the given domain suffix(es) in case a domain name
1642can not be resolved.
1643
1644Example:
1645@example
1646qemu -net user,dnssearch=mgmt.example.org,dnssearch=example.org [...]
1647@end example
1648
Jan Kiszkaad196a92009-06-24 14:42:28 +02001649@item tftp=@var{dir}
1650When using the user mode network stack, activate a built-in TFTP
1651server. The files in @var{dir} will be exposed as the root of a TFTP server.
1652The TFTP client on the guest must be configured in binary mode (use the command
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001653@code{bin} of the Unix TFTP client).
Jan Kiszkaad196a92009-06-24 14:42:28 +02001654
1655@item bootfile=@var{file}
1656When using the user mode network stack, broadcast @var{file} as the BOOTP
1657filename. In conjunction with @option{tftp}, this can be used to network boot
1658a guest from a local directory.
1659
1660Example (using pxelinux):
1661@example
Stefan Weil3804da92012-05-11 22:21:50 +02001662qemu-system-i386 -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
Jan Kiszkaad196a92009-06-24 14:42:28 +02001663@end example
1664
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001665@item smb=@var{dir}[,smbserver=@var{addr}]
Jan Kiszkaad196a92009-06-24 14:42:28 +02001666When using the user mode network stack, activate a built-in SMB
1667server so that Windows OSes can access to the host files in @file{@var{dir}}
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001668transparently. The IP address of the SMB server can be set to @var{addr}. By
1669default the 4th IP in the guest network is used, i.e. x.x.x.4.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001670
1671In the guest Windows OS, the line:
1672@example
167310.0.2.4 smbserver
1674@end example
1675must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
1676or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
1677
1678Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
1679
Brade2d88302011-09-02 16:53:28 -04001680Note that a SAMBA server must be installed on the host OS.
1681QEMU was tested successfully with smbd versions from Red Hat 9,
1682Fedora Core 3 and OpenSUSE 11.x.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001683
Jan Kiszka3c6a0582009-06-24 14:42:28 +02001684@item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001685Redirect incoming TCP or UDP connections to the host port @var{hostport} to
1686the guest IP address @var{guestaddr} on guest port @var{guestport}. If
1687@var{guestaddr} is not specified, its value is x.x.x.15 (default first address
Jan Kiszka3c6a0582009-06-24 14:42:28 +02001688given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
1689be bound to a specific host interface. If no connection type is set, TCP is
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001690used. This option can be given multiple times.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001691
1692For example, to redirect host X11 connection from screen 1 to guest
1693screen 0, use the following:
1694
1695@example
1696# on the host
Stefan Weil3804da92012-05-11 22:21:50 +02001697qemu-system-i386 -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...]
Jan Kiszkaad196a92009-06-24 14:42:28 +02001698# this host xterm should open in the guest X11 server
1699xterm -display :1
1700@end example
1701
1702To redirect telnet connections from host port 5555 to telnet port on
1703the guest, use the following:
1704
1705@example
1706# on the host
Stefan Weil3804da92012-05-11 22:21:50 +02001707qemu-system-i386 -net user,hostfwd=tcp::5555-:23 [...]
Jan Kiszkaad196a92009-06-24 14:42:28 +02001708telnet localhost 5555
1709@end example
1710
1711Then when you use on the host @code{telnet localhost 5555}, you
1712connect to the guest telnet server.
1713
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001714@item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02001715@itemx guestfwd=[tcp]:@var{server}:@var{port}-@var{cmd:command}
Jan Kiszka3c6a0582009-06-24 14:42:28 +02001716Forward guest TCP connections to the IP address @var{server} on port @var{port}
Alexander Grafb412eb62012-06-03 09:45:01 +02001717to the character device @var{dev} or to a program executed by @var{cmd:command}
1718which gets spawned for each connection. This option can be given multiple times.
1719
Stefan Weil43ffe612012-07-20 23:26:02 +02001720You can either use a chardev directly and have that one used throughout QEMU's
Alexander Grafb412eb62012-06-03 09:45:01 +02001721lifetime, like in the following example:
1722
1723@example
1724# open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it whenever
1725# the guest accesses it
1726qemu -net user,guestfwd=tcp:10.0.2.100:1234-tcp:10.10.1.1:4321 [...]
1727@end example
1728
1729Or you can execute a command on every TCP connection established by the guest,
Stefan Weil43ffe612012-07-20 23:26:02 +02001730so that QEMU behaves similar to an inetd process for that virtual server:
Alexander Grafb412eb62012-06-03 09:45:01 +02001731
1732@example
1733# call "netcat 10.10.1.1 4321" on every TCP connection to 10.0.2.100:1234
1734# and connect the TCP stream to its stdin/stdout
1735qemu -net 'user,guestfwd=tcp:10.0.2.100:1234-cmd:netcat 10.10.1.1 4321'
1736@end example
Jan Kiszkaad196a92009-06-24 14:42:28 +02001737
1738@end table
1739
1740Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still
1741processed and applied to -net user. Mixing them with the new configuration
1742syntax gives undefined results. Their use for new applications is discouraged
1743as they will be removed from future versions.
blueswir15824d652009-03-28 06:44:27 +00001744
Stefan Hajnoczi08d12022012-08-14 14:14:27 +01001745@item -netdev tap,id=@var{id}[,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}]
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02001746@itemx -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}]
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001747Connect the host TAP network interface @var{name} to VLAN @var{n}.
1748
1749Use the network script @var{file} to configure it and the network script
blueswir15824d652009-03-28 06:44:27 +00001750@var{dfile} to deconfigure it. If @var{name} is not provided, the OS
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001751automatically provides one. The default network configure script is
1752@file{/etc/qemu-ifup} and the default network deconfigure script is
1753@file{/etc/qemu-ifdown}. Use @option{script=no} or @option{downscript=no}
1754to disable script execution.
1755
1756If running QEMU as an unprivileged user, use the network helper
1757@var{helper} to configure the TAP interface. The default network
Amos Kong420508f2013-10-23 04:49:28 +08001758helper executable is @file{/path/to/qemu-bridge-helper}.
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001759
1760@option{fd}=@var{h} can be used to specify the handle of an already
1761opened host TAP interface.
1762
1763Examples:
blueswir15824d652009-03-28 06:44:27 +00001764
1765@example
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001766#launch a QEMU instance with the default network script
Stefan Weil3804da92012-05-11 22:21:50 +02001767qemu-system-i386 linux.img -net nic -net tap
blueswir15824d652009-03-28 06:44:27 +00001768@end example
1769
blueswir15824d652009-03-28 06:44:27 +00001770@example
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001771#launch a QEMU instance with two NICs, each one connected
1772#to a TAP device
Stefan Weil3804da92012-05-11 22:21:50 +02001773qemu-system-i386 linux.img \
1774 -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
1775 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
blueswir15824d652009-03-28 06:44:27 +00001776@end example
1777
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001778@example
1779#launch a QEMU instance with the default network helper to
1780#connect a TAP device to bridge br0
Stefan Weil3804da92012-05-11 22:21:50 +02001781qemu-system-i386 linux.img \
Amos Kong420508f2013-10-23 04:49:28 +08001782 -net nic -net tap,"helper=/path/to/qemu-bridge-helper"
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001783@end example
1784
Stefan Hajnoczi08d12022012-08-14 14:14:27 +01001785@item -netdev bridge,id=@var{id}[,br=@var{bridge}][,helper=@var{helper}]
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02001786@itemx -net bridge[,vlan=@var{n}][,name=@var{name}][,br=@var{bridge}][,helper=@var{helper}]
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001787Connect a host TAP network interface to a host bridge device.
1788
1789Use the network helper @var{helper} to configure the TAP interface and
1790attach it to the bridge. The default network helper executable is
Amos Kong420508f2013-10-23 04:49:28 +08001791@file{/path/to/qemu-bridge-helper} and the default bridge
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001792device is @file{br0}.
1793
1794Examples:
1795
1796@example
1797#launch a QEMU instance with the default network helper to
1798#connect a TAP device to bridge br0
Stefan Weil3804da92012-05-11 22:21:50 +02001799qemu-system-i386 linux.img -net bridge -net nic,model=virtio
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001800@end example
1801
1802@example
1803#launch a QEMU instance with the default network helper to
1804#connect a TAP device to bridge qemubr0
Stefan Weil3804da92012-05-11 22:21:50 +02001805qemu-system-i386 linux.img -net bridge,br=qemubr0 -net nic,model=virtio
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001806@end example
1807
Stefan Hajnoczi08d12022012-08-14 14:14:27 +01001808@item -netdev socket,id=@var{id}[,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02001809@itemx -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 +00001810
1811Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
1812machine using a TCP socket connection. If @option{listen} is
1813specified, QEMU waits for incoming connections on @var{port}
1814(@var{host} is optional). @option{connect} is used to connect to
1815another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
1816specifies an already opened TCP socket.
1817
1818Example:
1819@example
1820# launch a first QEMU instance
Stefan Weil3804da92012-05-11 22:21:50 +02001821qemu-system-i386 linux.img \
1822 -net nic,macaddr=52:54:00:12:34:56 \
1823 -net socket,listen=:1234
blueswir15824d652009-03-28 06:44:27 +00001824# connect the VLAN 0 of this instance to the VLAN 0
1825# of the first instance
Stefan Weil3804da92012-05-11 22:21:50 +02001826qemu-system-i386 linux.img \
1827 -net nic,macaddr=52:54:00:12:34:57 \
1828 -net socket,connect=127.0.0.1:1234
blueswir15824d652009-03-28 06:44:27 +00001829@end example
1830
Stefan Hajnoczi08d12022012-08-14 14:14:27 +01001831@item -netdev socket,id=@var{id}[,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]]
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02001832@itemx -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 +00001833
1834Create a VLAN @var{n} shared with another QEMU virtual
1835machines using a UDP multicast socket, effectively making a bus for
1836every QEMU with same multicast address @var{maddr} and @var{port}.
1837NOTES:
1838@enumerate
1839@item
1840Several QEMU can be running on different hosts and share same bus (assuming
1841correct multicast setup for these hosts).
1842@item
1843mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
1844@url{http://user-mode-linux.sf.net}.
1845@item
1846Use @option{fd=h} to specify an already opened UDP multicast socket.
1847@end enumerate
1848
1849Example:
1850@example
1851# launch one QEMU instance
Stefan Weil3804da92012-05-11 22:21:50 +02001852qemu-system-i386 linux.img \
1853 -net nic,macaddr=52:54:00:12:34:56 \
1854 -net socket,mcast=230.0.0.1:1234
blueswir15824d652009-03-28 06:44:27 +00001855# launch another QEMU instance on same "bus"
Stefan Weil3804da92012-05-11 22:21:50 +02001856qemu-system-i386 linux.img \
1857 -net nic,macaddr=52:54:00:12:34:57 \
1858 -net socket,mcast=230.0.0.1:1234
blueswir15824d652009-03-28 06:44:27 +00001859# launch yet another QEMU instance on same "bus"
Stefan Weil3804da92012-05-11 22:21:50 +02001860qemu-system-i386 linux.img \
1861 -net nic,macaddr=52:54:00:12:34:58 \
1862 -net socket,mcast=230.0.0.1:1234
blueswir15824d652009-03-28 06:44:27 +00001863@end example
1864
1865Example (User Mode Linux compat.):
1866@example
1867# launch QEMU instance (note mcast address selected
1868# is UML's default)
Stefan Weil3804da92012-05-11 22:21:50 +02001869qemu-system-i386 linux.img \
1870 -net nic,macaddr=52:54:00:12:34:56 \
1871 -net socket,mcast=239.192.168.1:1102
blueswir15824d652009-03-28 06:44:27 +00001872# launch UML
1873/path/to/linux ubd0=/path/to/root_fs eth0=mcast
1874@end example
1875
Mike Ryan3a75e742010-12-01 11:16:47 -08001876Example (send packets from host's 1.2.3.4):
1877@example
Stefan Weil3804da92012-05-11 22:21:50 +02001878qemu-system-i386 linux.img \
1879 -net nic,macaddr=52:54:00:12:34:56 \
1880 -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4
Mike Ryan3a75e742010-12-01 11:16:47 -08001881@end example
1882
Anton Ivanov3fb69aa2014-06-20 10:34:41 +01001883@item -netdev l2tpv3,id=@var{id},src=@var{srcaddr},dst=@var{dstaddr}[,srcport=@var{srcport}][,dstport=@var{dstport}],txsession=@var{txsession}[,rxsession=@var{rxsession}][,ipv6][,udp][,cookie64][,counter][,pincounter][,txcookie=@var{txcookie}][,rxcookie=@var{rxcookie}][,offset=@var{offset}]
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02001884@itemx -net l2tpv3[,vlan=@var{n}][,name=@var{name}],src=@var{srcaddr},dst=@var{dstaddr}[,srcport=@var{srcport}][,dstport=@var{dstport}],txsession=@var{txsession}[,rxsession=@var{rxsession}][,ipv6][,udp][,cookie64][,counter][,pincounter][,txcookie=@var{txcookie}][,rxcookie=@var{rxcookie}][,offset=@var{offset}]
Anton Ivanov3fb69aa2014-06-20 10:34:41 +01001885Connect VLAN @var{n} to L2TPv3 pseudowire. L2TPv3 (RFC3391) is a popular
1886protocol to transport Ethernet (and other Layer 2) data frames between
1887two systems. It is present in routers, firewalls and the Linux kernel
1888(from version 3.3 onwards).
1889
1890This transport allows a VM to communicate to another VM, router or firewall directly.
1891
1892@item src=@var{srcaddr}
1893 source address (mandatory)
1894@item dst=@var{dstaddr}
1895 destination address (mandatory)
1896@item udp
1897 select udp encapsulation (default is ip).
1898@item srcport=@var{srcport}
1899 source udp port.
1900@item dstport=@var{dstport}
1901 destination udp port.
1902@item ipv6
1903 force v6, otherwise defaults to v4.
1904@item rxcookie=@var{rxcookie}
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02001905@itemx txcookie=@var{txcookie}
Anton Ivanov3fb69aa2014-06-20 10:34:41 +01001906 Cookies are a weak form of security in the l2tpv3 specification.
1907Their function is mostly to prevent misconfiguration. By default they are 32
1908bit.
1909@item cookie64
1910 Set cookie size to 64 bit instead of the default 32
1911@item counter=off
1912 Force a 'cut-down' L2TPv3 with no counter as in
1913draft-mkonstan-l2tpext-keyed-ipv6-tunnel-00
1914@item pincounter=on
1915 Work around broken counter handling in peer. This may also help on
1916networks which have packet reorder.
1917@item offset=@var{offset}
1918 Add an extra offset between header and data
1919
1920For example, to attach a VM running on host 4.3.2.1 via L2TPv3 to the bridge br-lan
1921on the remote Linux host 1.2.3.4:
1922@example
1923# Setup tunnel on linux host using raw ip as encapsulation
1924# on 1.2.3.4
1925ip l2tp add tunnel remote 4.3.2.1 local 1.2.3.4 tunnel_id 1 peer_tunnel_id 1 \
1926 encap udp udp_sport 16384 udp_dport 16384
1927ip l2tp add session tunnel_id 1 name vmtunnel0 session_id \
1928 0xFFFFFFFF peer_session_id 0xFFFFFFFF
1929ifconfig vmtunnel0 mtu 1500
1930ifconfig vmtunnel0 up
1931brctl addif br-lan vmtunnel0
1932
1933
1934# on 4.3.2.1
1935# launch QEMU instance - if your network has reorder or is very lossy add ,pincounter
1936
1937qemu-system-i386 linux.img -net nic -net l2tpv3,src=4.2.3.1,dst=1.2.3.4,udp,srcport=16384,dstport=16384,rxsession=0xffffffff,txsession=0xffffffff,counter
1938
1939
1940@end example
1941
Stefan Hajnoczi08d12022012-08-14 14:14:27 +01001942@item -netdev vde,id=@var{id}[,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02001943@itemx -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 +00001944Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
1945listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
1946and MODE @var{octalmode} to change default ownership and permissions for
Stefan Weilc1ba4e02011-09-05 18:13:03 +02001947communication port. This option is only available if QEMU has been compiled
blueswir15824d652009-03-28 06:44:27 +00001948with vde support enabled.
1949
1950Example:
1951@example
1952# launch vde switch
1953vde_switch -F -sock /tmp/myswitch
1954# launch QEMU instance
Stefan Weil3804da92012-05-11 22:21:50 +02001955qemu-system-i386 linux.img -net nic -net vde,sock=/tmp/myswitch
blueswir15824d652009-03-28 06:44:27 +00001956@end example
1957
Stefan Hajnoczi40e8c262013-02-26 11:07:16 +01001958@item -netdev hubport,id=@var{id},hubid=@var{hubid}
1959
1960Create a hub port on QEMU "vlan" @var{hubid}.
1961
1962The hubport netdev lets you connect a NIC to a QEMU "vlan" instead of a single
1963netdev. @code{-net} and @code{-device} with parameter @option{vlan} create the
1964required hub automatically.
1965
Michael S. Tsirkind345ed22015-07-15 13:47:31 +03001966@item -netdev vhost-user,chardev=@var{id}[,vhostforce=on|off]
Nikolay Nikolaev03ce5742014-06-10 13:02:16 +03001967
1968Establish a vhost-user netdev, backed by a chardev @var{id}. The chardev should
1969be a unix domain socket backed one. The vhost-user uses a specifically defined
1970protocol to pass vhost ioctl replacement messages to an application on the other
1971end of the socket. On non-MSIX guests, the feature can be forced with
Michael S. Tsirkind345ed22015-07-15 13:47:31 +03001972@var{vhostforce}.
Nikolay Nikolaev03ce5742014-06-10 13:02:16 +03001973
1974Example:
1975@example
1976qemu -m 512 -object memory-backend-file,id=mem,size=512M,mem-path=/hugetlbfs,share=on \
1977 -numa node,memdev=mem \
1978 -chardev socket,path=/path/to/socket \
1979 -netdev type=vhost-user,id=net0,chardev=chr0 \
1980 -device virtio-net-pci,netdev=net0
1981@end example
1982
aliguoribb9ea792009-04-21 19:56:28 +00001983@item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
1984Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
1985At most @var{len} bytes (64k by default) per packet are stored. The file format is
1986libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
1987
blueswir15824d652009-03-28 06:44:27 +00001988@item -net none
1989Indicate that no network devices should be configured. It is used to
1990override the default configuration (@option{-net nic -net user}) which
1991is activated if no @option{-net} options are provided.
blueswir15824d652009-03-28 06:44:27 +00001992ETEXI
1993
Markus Armbrusterc70a01e2013-02-13 19:49:40 +01001994STEXI
1995@end table
1996ETEXI
Matthew Booth7273a2d2009-10-30 13:41:12 +00001997DEFHEADING()
1998
1999DEFHEADING(Character device options:)
Markus Armbrusterc70a01e2013-02-13 19:49:40 +01002000STEXI
2001
2002The general form of a character device option is:
2003@table @option
2004ETEXI
Matthew Booth7273a2d2009-10-30 13:41:12 +00002005
2006DEF("chardev", HAS_ARG, QEMU_OPTION_chardev,
Jan Kiszka97331282010-04-06 16:55:54 +02002007 "-chardev null,id=id[,mux=on|off]\n"
Corey Minyard5dd1f022014-10-02 11:17:37 -05002008 "-chardev socket,id=id[,host=host],port=port[,to=to][,ipv4][,ipv6][,nodelay][,reconnect=seconds]\n"
2009 " [,server][,nowait][,telnet][,reconnect=seconds][,mux=on|off] (tcp)\n"
2010 "-chardev socket,id=id,path=path[,server][,nowait][,telnet][,reconnect=seconds][,mux=on|off] (unix)\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00002011 "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n"
Jan Kiszka97331282010-04-06 16:55:54 +02002012 " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n"
2013 "-chardev msmouse,id=id[,mux=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00002014 "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n"
Jan Kiszka97331282010-04-06 16:55:54 +02002015 " [,mux=on|off]\n"
Markus Armbruster4f573782013-07-26 16:44:32 +02002016 "-chardev ringbuf,id=id[,size=size]\n"
Jan Kiszka97331282010-04-06 16:55:54 +02002017 "-chardev file,id=id,path=path[,mux=on|off]\n"
2018 "-chardev pipe,id=id,path=path[,mux=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00002019#ifdef _WIN32
Jan Kiszka97331282010-04-06 16:55:54 +02002020 "-chardev console,id=id[,mux=on|off]\n"
2021 "-chardev serial,id=id,path=path[,mux=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00002022#else
Jan Kiszka97331282010-04-06 16:55:54 +02002023 "-chardev pty,id=id[,mux=on|off]\n"
Aurelien Jarnob7fdb3a2010-07-13 21:13:12 +02002024 "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00002025#endif
2026#ifdef CONFIG_BRLAPI
Jan Kiszka97331282010-04-06 16:55:54 +02002027 "-chardev braille,id=id[,mux=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00002028#endif
2029#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
2030 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
Gerd Hoffmannd59044e2012-12-19 13:50:29 +01002031 "-chardev serial,id=id,path=path[,mux=on|off]\n"
Jan Kiszka97331282010-04-06 16:55:54 +02002032 "-chardev tty,id=id,path=path[,mux=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00002033#endif
2034#if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__)
Gerd Hoffmann88a946d2013-01-10 14:20:58 +01002035 "-chardev parallel,id=id,path=path[,mux=on|off]\n"
Jan Kiszka97331282010-04-06 16:55:54 +02002036 "-chardev parport,id=id,path=path[,mux=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00002037#endif
Alon Levycbcc6332011-01-19 10:49:50 +02002038#if defined(CONFIG_SPICE)
2039 "-chardev spicevmc,id=id,name=name[,debug=debug]\n"
Marc-André Lureau5a49d3e2012-12-05 16:15:34 +01002040 "-chardev spiceport,id=id,name=name[,debug=debug]\n"
Alon Levycbcc6332011-01-19 10:49:50 +02002041#endif
Blue Swirlad960902010-03-29 19:23:52 +00002042 , QEMU_ARCH_ALL
Matthew Booth7273a2d2009-10-30 13:41:12 +00002043)
2044
2045STEXI
Jan Kiszka97331282010-04-06 16:55:54 +02002046@item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}]
Stefan Weil6616b2a2010-02-05 23:52:05 +01002047@findex -chardev
Matthew Booth7273a2d2009-10-30 13:41:12 +00002048Backend is one of:
2049@option{null},
2050@option{socket},
2051@option{udp},
2052@option{msmouse},
2053@option{vc},
Markus Armbruster4f573782013-07-26 16:44:32 +02002054@option{ringbuf},
Matthew Booth7273a2d2009-10-30 13:41:12 +00002055@option{file},
2056@option{pipe},
2057@option{console},
2058@option{serial},
2059@option{pty},
2060@option{stdio},
2061@option{braille},
2062@option{tty},
Gerd Hoffmann88a946d2013-01-10 14:20:58 +01002063@option{parallel},
Alon Levycbcc6332011-01-19 10:49:50 +02002064@option{parport},
2065@option{spicevmc}.
Marc-André Lureau5a49d3e2012-12-05 16:15:34 +01002066@option{spiceport}.
Matthew Booth7273a2d2009-10-30 13:41:12 +00002067The specific backend will determine the applicable options.
2068
2069All devices must have an id, which can be any string up to 127 characters long.
2070It is used to uniquely identify this device in other command line directives.
2071
Jan Kiszka97331282010-04-06 16:55:54 +02002072A character device may be used in multiplexing mode by multiple front-ends.
2073The key sequence of @key{Control-a} and @key{c} will rotate the input focus
2074between attached front-ends. Specify @option{mux=on} to enable this mode.
2075
Matthew Booth7273a2d2009-10-30 13:41:12 +00002076Options to each backend are described below.
2077
2078@item -chardev null ,id=@var{id}
2079A void device. This device will not emit any data, and will drop any data it
2080receives. The null backend does not take any options.
2081
Corey Minyard5dd1f022014-10-02 11:17:37 -05002082@item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet] [,reconnect=@var{seconds}]
Matthew Booth7273a2d2009-10-30 13:41:12 +00002083
2084Create a two-way stream socket, which can be either a TCP or a unix socket. A
2085unix socket will be created if @option{path} is specified. Behaviour is
2086undefined if TCP options are specified for a unix socket.
2087
2088@option{server} specifies that the socket shall be a listening socket.
2089
2090@option{nowait} specifies that QEMU should not block waiting for a client to
2091connect to a listening socket.
2092
2093@option{telnet} specifies that traffic on the socket should interpret telnet
2094escape sequences.
2095
Corey Minyard5dd1f022014-10-02 11:17:37 -05002096@option{reconnect} sets the timeout for reconnecting on non-server sockets when
2097the remote end goes away. qemu will delay this many seconds and then attempt
2098to reconnect. Zero disables reconnecting, and is the default.
2099
Matthew Booth7273a2d2009-10-30 13:41:12 +00002100TCP and unix socket options are given below:
2101
2102@table @option
2103
Aurelien Jarno8d533562010-03-27 11:52:05 +01002104@item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay]
Matthew Booth7273a2d2009-10-30 13:41:12 +00002105
2106@option{host} for a listening socket specifies the local address to be bound.
2107For a connecting socket species the remote host to connect to. @option{host} is
2108optional for listening sockets. If not specified it defaults to @code{0.0.0.0}.
2109
2110@option{port} for a listening socket specifies the local port to be bound. For a
2111connecting socket specifies the port on the remote host to connect to.
2112@option{port} can be given as either a port number or a service name.
2113@option{port} is required.
2114
2115@option{to} is only relevant to listening sockets. If it is specified, and
2116@option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up
2117to and including @option{to} until it succeeds. @option{to} must be specified
2118as a port number.
2119
2120@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
2121If neither is specified the socket may use either protocol.
2122
2123@option{nodelay} disables the Nagle algorithm.
2124
2125@item unix options: path=@var{path}
2126
2127@option{path} specifies the local path of the unix socket. @option{path} is
2128required.
2129
2130@end table
2131
2132@item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6]
2133
2134Sends all traffic from the guest to a remote host over UDP.
2135
2136@option{host} specifies the remote host to connect to. If not specified it
2137defaults to @code{localhost}.
2138
2139@option{port} specifies the port on the remote host to connect to. @option{port}
2140is required.
2141
2142@option{localaddr} specifies the local address to bind to. If not specified it
2143defaults to @code{0.0.0.0}.
2144
2145@option{localport} specifies the local port to bind to. If not specified any
2146available local port will be used.
2147
2148@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
2149If neither is specified the device may use either protocol.
2150
2151@item -chardev msmouse ,id=@var{id}
2152
2153Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not
2154take any options.
2155
2156@item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]]
2157
2158Connect to a QEMU text console. @option{vc} may optionally be given a specific
2159size.
2160
2161@option{width} and @option{height} specify the width and height respectively of
2162the console, in pixels.
2163
2164@option{cols} and @option{rows} specify that the console be sized to fit a text
2165console with the given dimensions.
2166
Markus Armbruster4f573782013-07-26 16:44:32 +02002167@item -chardev ringbuf ,id=@var{id} [,size=@var{size}]
Lei Li51767e72013-01-25 00:03:19 +08002168
Markus Armbruster3949e592013-02-06 21:27:24 +01002169Create a ring buffer with fixed size @option{size}.
2170@var{size} must be a power of two, and defaults to @code{64K}).
Lei Li51767e72013-01-25 00:03:19 +08002171
Matthew Booth7273a2d2009-10-30 13:41:12 +00002172@item -chardev file ,id=@var{id} ,path=@var{path}
2173
2174Log all traffic received from the guest to a file.
2175
2176@option{path} specifies the path of the file to be opened. This file will be
2177created if it does not already exist, and overwritten if it does. @option{path}
2178is required.
2179
2180@item -chardev pipe ,id=@var{id} ,path=@var{path}
2181
2182Create a two-way connection to the guest. The behaviour differs slightly between
2183Windows hosts and other hosts:
2184
2185On Windows, a single duplex pipe will be created at
2186@file{\\.pipe\@option{path}}.
2187
2188On other hosts, 2 pipes will be created called @file{@option{path}.in} and
2189@file{@option{path}.out}. Data written to @file{@option{path}.in} will be
2190received by the guest. Data written by the guest can be read from
2191@file{@option{path}.out}. QEMU will not create these fifos, and requires them to
2192be present.
2193
2194@option{path} forms part of the pipe path as described above. @option{path} is
2195required.
2196
2197@item -chardev console ,id=@var{id}
2198
2199Send traffic from the guest to QEMU's standard output. @option{console} does not
2200take any options.
2201
2202@option{console} is only available on Windows hosts.
2203
2204@item -chardev serial ,id=@var{id} ,path=@option{path}
2205
2206Send traffic from the guest to a serial device on the host.
2207
Gerd Hoffmannd59044e2012-12-19 13:50:29 +01002208On Unix hosts serial will actually accept any tty device,
2209not only serial lines.
Matthew Booth7273a2d2009-10-30 13:41:12 +00002210
2211@option{path} specifies the name of the serial device to open.
2212
2213@item -chardev pty ,id=@var{id}
2214
2215Create a new pseudo-terminal on the host and connect to it. @option{pty} does
2216not take any options.
2217
2218@option{pty} is not available on Windows hosts.
2219
Aurelien Jarnob7fdb3a2010-07-13 21:13:12 +02002220@item -chardev stdio ,id=@var{id} [,signal=on|off]
Stefan Weilb65ee4f2012-05-11 22:25:50 +02002221Connect to standard input and standard output of the QEMU process.
Aurelien Jarnob7fdb3a2010-07-13 21:13:12 +02002222
2223@option{signal} controls if signals are enabled on the terminal, that includes
2224exiting QEMU with the key sequence @key{Control-c}. This option is enabled by
2225default, use @option{signal=off} to disable it.
2226
2227@option{stdio} is not available on Windows hosts.
Matthew Booth7273a2d2009-10-30 13:41:12 +00002228
2229@item -chardev braille ,id=@var{id}
2230
2231Connect to a local BrlAPI server. @option{braille} does not take any options.
2232
2233@item -chardev tty ,id=@var{id} ,path=@var{path}
2234
Matthew Booth7273a2d2009-10-30 13:41:12 +00002235@option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and
Markus Armbrusterd037d6b2013-02-13 15:54:15 +01002236DragonFlyBSD hosts. It is an alias for @option{serial}.
Matthew Booth7273a2d2009-10-30 13:41:12 +00002237
2238@option{path} specifies the path to the tty. @option{path} is required.
2239
Gerd Hoffmann88a946d2013-01-10 14:20:58 +01002240@item -chardev parallel ,id=@var{id} ,path=@var{path}
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02002241@itemx -chardev parport ,id=@var{id} ,path=@var{path}
Matthew Booth7273a2d2009-10-30 13:41:12 +00002242
Gerd Hoffmann88a946d2013-01-10 14:20:58 +01002243@option{parallel} is only available on Linux, FreeBSD and DragonFlyBSD hosts.
Matthew Booth7273a2d2009-10-30 13:41:12 +00002244
2245Connect to a local parallel port.
2246
2247@option{path} specifies the path to the parallel port device. @option{path} is
2248required.
2249
Alon Levycbcc6332011-01-19 10:49:50 +02002250@item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name}
2251
Stefan Hajnoczi3a846902011-10-06 11:24:12 +01002252@option{spicevmc} is only available when spice support is built in.
2253
Alon Levycbcc6332011-01-19 10:49:50 +02002254@option{debug} debug level for spicevmc
2255
2256@option{name} name of spice channel to connect to
2257
2258Connect to a spice virtual machine channel, such as vdiport.
Alon Levycbcc6332011-01-19 10:49:50 +02002259
Marc-André Lureau5a49d3e2012-12-05 16:15:34 +01002260@item -chardev spiceport ,id=@var{id} ,debug=@var{debug}, name=@var{name}
2261
2262@option{spiceport} is only available when spice support is built in.
2263
2264@option{debug} debug level for spicevmc
2265
2266@option{name} name of spice port to connect to
2267
2268Connect to a spice port, allowing a Spice client to handle the traffic
2269identified by a name (preferably a fqdn).
Matthew Booth7273a2d2009-10-30 13:41:12 +00002270ETEXI
2271
Markus Armbrusterc70a01e2013-02-13 19:49:40 +01002272STEXI
2273@end table
2274ETEXI
Matthew Booth7273a2d2009-10-30 13:41:12 +00002275DEFHEADING()
2276
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +11002277DEFHEADING(Device URL Syntax:)
Markus Armbrusterc70a01e2013-02-13 19:49:40 +01002278STEXI
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +11002279
2280In addition to using normal file images for the emulated storage devices,
2281QEMU can also use networked resources such as iSCSI devices. These are
2282specified using a special URL syntax.
2283
2284@table @option
2285@item iSCSI
2286iSCSI support allows QEMU to access iSCSI resources directly and use as
2287images for the guest storage. Both disk and cdrom images are supported.
2288
2289Syntax for specifying iSCSI LUNs is
2290``iscsi://<target-ip>[:<port>]/<target-iqn>/<lun>''
2291
Ronnie Sahlberg31459f42012-08-06 18:24:55 +10002292By default qemu will use the iSCSI initiator-name
2293'iqn.2008-11.org.linux-kvm[:<name>]' but this can also be set from the command
2294line or a configuration file.
2295
Peter Lieven5dd7a532015-06-16 13:45:07 +02002296Since version Qemu 2.4 it is possible to specify a iSCSI request timeout to detect
2297stalled requests and force a reestablishment of the session. The timeout
Peter Lieven90497362015-06-26 12:18:01 +02002298is specified in seconds. The default is 0 which means no timeout. Libiscsi
22991.15.0 or greater is required for this feature.
Ronnie Sahlberg31459f42012-08-06 18:24:55 +10002300
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +11002301Example (without authentication):
2302@example
Stefan Weil3804da92012-05-11 22:21:50 +02002303qemu-system-i386 -iscsi initiator-name=iqn.2001-04.com.example:my-initiator \
2304 -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \
2305 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +11002306@end example
2307
2308Example (CHAP username/password via URL):
2309@example
Stefan Weil3804da92012-05-11 22:21:50 +02002310qemu-system-i386 -drive file=iscsi://user%password@@192.0.2.1/iqn.2001-04.com.example/1
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +11002311@end example
2312
2313Example (CHAP username/password via environment variables):
2314@example
2315LIBISCSI_CHAP_USERNAME="user" \
2316LIBISCSI_CHAP_PASSWORD="password" \
Stefan Weil3804da92012-05-11 22:21:50 +02002317qemu-system-i386 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +11002318@end example
2319
2320iSCSI support is an optional feature of QEMU and only available when
2321compiled and linked against libiscsi.
Ronnie Sahlbergf9dadc92012-01-26 09:39:02 +11002322ETEXI
2323DEF("iscsi", HAS_ARG, QEMU_OPTION_iscsi,
2324 "-iscsi [user=user][,password=password]\n"
2325 " [,header-digest=CRC32C|CR32C-NONE|NONE-CRC32C|NONE\n"
Paolo Bonzini2fe37982013-12-06 16:08:05 +01002326 " [,initiator-name=initiator-iqn][,id=target-iqn]\n"
Peter Lieven5dd7a532015-06-16 13:45:07 +02002327 " [,timeout=timeout]\n"
Ronnie Sahlbergf9dadc92012-01-26 09:39:02 +11002328 " iSCSI session parameters\n", QEMU_ARCH_ALL)
2329STEXI
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +11002330
Ronnie Sahlberg31459f42012-08-06 18:24:55 +10002331iSCSI parameters such as username and password can also be specified via
2332a configuration file. See qemu-doc for more information and examples.
2333
Ronnie Sahlberg08ae3302011-10-27 20:33:21 +11002334@item NBD
2335QEMU supports NBD (Network Block Devices) both using TCP protocol as well
2336as Unix Domain Sockets.
2337
2338Syntax for specifying a NBD device using TCP
2339``nbd:<server-ip>:<port>[:exportname=<export>]''
2340
2341Syntax for specifying a NBD device using Unix Domain Sockets
2342``nbd:unix:<domain-socket>[:exportname=<export>]''
2343
2344
2345Example for TCP
2346@example
Stefan Weil3804da92012-05-11 22:21:50 +02002347qemu-system-i386 --drive file=nbd:192.0.2.1:30000
Ronnie Sahlberg08ae3302011-10-27 20:33:21 +11002348@end example
2349
2350Example for Unix Domain Sockets
2351@example
Stefan Weil3804da92012-05-11 22:21:50 +02002352qemu-system-i386 --drive file=nbd:unix:/tmp/nbd-socket
Ronnie Sahlberg08ae3302011-10-27 20:33:21 +11002353@end example
2354
Richard W.M. Jones0a12ec82013-04-09 15:30:53 +01002355@item SSH
2356QEMU supports SSH (Secure Shell) access to remote disks.
2357
2358Examples:
2359@example
2360qemu-system-i386 -drive file=ssh://user@@host/path/to/disk.img
2361qemu-system-i386 -drive file.driver=ssh,file.user=user,file.host=host,file.port=22,file.path=/path/to/disk.img
2362@end example
2363
2364Currently authentication must be done using ssh-agent. Other
2365authentication methods may be supported in future.
2366
Ronnie Sahlbergd9990222011-10-28 20:13:39 +11002367@item Sheepdog
2368Sheepdog is a distributed storage system for QEMU.
2369QEMU supports using either local sheepdog devices or remote networked
2370devices.
2371
2372Syntax for specifying a sheepdog device
MORITA Kazutaka5d6768e2013-02-22 12:39:51 +09002373@example
MORITA Kazutaka1b8bbb42013-02-22 12:39:53 +09002374sheepdog[+tcp|+unix]://[host:port]/vdiname[?socket=path][#snapid|#tag]
MORITA Kazutaka5d6768e2013-02-22 12:39:51 +09002375@end example
Ronnie Sahlbergd9990222011-10-28 20:13:39 +11002376
2377Example
2378@example
MORITA Kazutaka5d6768e2013-02-22 12:39:51 +09002379qemu-system-i386 --drive file=sheepdog://192.0.2.1:30000/MyVirtualMachine
Ronnie Sahlbergd9990222011-10-28 20:13:39 +11002380@end example
2381
2382See also @url{http://http://www.osrg.net/sheepdog/}.
2383
Bharata B Rao8809e282012-10-24 17:17:53 +05302384@item GlusterFS
2385GlusterFS is an user space distributed file system.
2386QEMU supports the use of GlusterFS volumes for hosting VM disk images using
2387TCP, Unix Domain Sockets and RDMA transport protocols.
2388
2389Syntax for specifying a VM disk image on GlusterFS volume is
2390@example
2391gluster[+transport]://[server[:port]]/volname/image[?socket=...]
2392@end example
2393
2394
2395Example
2396@example
Lei Lidb2d5eb2013-03-07 15:50:26 +08002397qemu-system-x86_64 --drive file=gluster://192.0.2.1/testvol/a.img
Bharata B Rao8809e282012-10-24 17:17:53 +05302398@end example
2399
2400See also @url{http://www.gluster.org}.
Matthew Booth0a86cb72014-05-14 19:28:43 -04002401
2402@item HTTP/HTTPS/FTP/FTPS/TFTP
2403QEMU supports read-only access to files accessed over http(s), ftp(s) and tftp.
2404
2405Syntax using a single filename:
2406@example
2407<protocol>://[<username>[:<password>]@@]<host>/<path>
2408@end example
2409
2410where:
2411@table @option
2412@item protocol
2413'http', 'https', 'ftp', 'ftps', or 'tftp'.
2414
2415@item username
2416Optional username for authentication to the remote server.
2417
2418@item password
2419Optional password for authentication to the remote server.
2420
2421@item host
2422Address of the remote server.
2423
2424@item path
2425Path on the remote server, including any query string.
2426@end table
2427
2428The following options are also supported:
2429@table @option
2430@item url
2431The full URL when passing options to the driver explicitly.
2432
2433@item readahead
2434The amount of data to read ahead with each range request to the remote server.
2435This value may optionally have the suffix 'T', 'G', 'M', 'K', 'k' or 'b'. If it
2436does not have a suffix, it will be assumed to be in bytes. The value must be a
2437multiple of 512 bytes. It defaults to 256k.
2438
2439@item sslverify
2440Whether to verify the remote server's certificate when connecting over SSL. It
2441can have the value 'on' or 'off'. It defaults to 'on'.
Daniel Henrique Barboza212aefa2014-08-13 12:44:27 -03002442
Richard W.M. Jonesa94f83d2014-08-29 16:03:12 +01002443@item cookie
2444Send this cookie (it can also be a list of cookies separated by ';') with
2445each outgoing request. Only supported when using protocols such as HTTP
2446which support cookies, otherwise ignored.
2447
Daniel Henrique Barboza212aefa2014-08-13 12:44:27 -03002448@item timeout
2449Set the timeout in seconds of the CURL connection. This timeout is the time
2450that CURL waits for a response from the remote server to get the size of the
2451image to be downloaded. If not set, the default timeout of 5 seconds is used.
Matthew Booth0a86cb72014-05-14 19:28:43 -04002452@end table
2453
2454Note that when passing options to qemu explicitly, @option{driver} is the value
2455of <protocol>.
2456
2457Example: boot from a remote Fedora 20 live ISO image
2458@example
2459qemu-system-x86_64 --drive media=cdrom,file=http://dl.fedoraproject.org/pub/fedora/linux/releases/20/Live/x86_64/Fedora-Live-Desktop-x86_64-20-1.iso,readonly
2460
2461qemu-system-x86_64 --drive media=cdrom,file.driver=http,file.url=http://dl.fedoraproject.org/pub/fedora/linux/releases/20/Live/x86_64/Fedora-Live-Desktop-x86_64-20-1.iso,readonly
2462@end example
2463
2464Example: boot from a remote Fedora 20 cloud image using a local overlay for
2465writes, copy-on-read, and a readahead of 64k
2466@example
2467qemu-img create -f qcow2 -o backing_file='json:@{"file.driver":"http",, "file.url":"https://dl.fedoraproject.org/pub/fedora/linux/releases/20/Images/x86_64/Fedora-x86_64-20-20131211.1-sda.qcow2",, "file.readahead":"64k"@}' /tmp/Fedora-x86_64-20-20131211.1-sda.qcow2
2468
2469qemu-system-x86_64 -drive file=/tmp/Fedora-x86_64-20-20131211.1-sda.qcow2,copy-on-read=on
2470@end example
2471
2472Example: boot from an image stored on a VMware vSphere server with a self-signed
Daniel Henrique Barboza212aefa2014-08-13 12:44:27 -03002473certificate using a local overlay for writes, a readahead of 64k and a timeout
2474of 10 seconds.
Matthew Booth0a86cb72014-05-14 19:28:43 -04002475@example
Daniel Henrique Barboza212aefa2014-08-13 12:44:27 -03002476qemu-img create -f qcow2 -o backing_file='json:@{"file.driver":"https",, "file.url":"https://user:password@@vsphere.example.com/folder/test/test-flat.vmdk?dcPath=Datacenter&dsName=datastore1",, "file.sslverify":"off",, "file.readahead":"64k",, "file.timeout":10@}' /tmp/test.qcow2
Matthew Booth0a86cb72014-05-14 19:28:43 -04002477
2478qemu-system-x86_64 -drive file=/tmp/test.qcow2
2479@end example
Markus Armbrusterc70a01e2013-02-13 19:49:40 +01002480ETEXI
2481
2482STEXI
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +11002483@end table
2484ETEXI
2485
Matthew Booth7273a2d2009-10-30 13:41:12 +00002486DEFHEADING(Bluetooth(R) options:)
Markus Armbrusterc70a01e2013-02-13 19:49:40 +01002487STEXI
2488@table @option
2489ETEXI
Matthew Booth7273a2d2009-10-30 13:41:12 +00002490
blueswir15824d652009-03-28 06:44:27 +00002491DEF("bt", HAS_ARG, QEMU_OPTION_bt, \
blueswir15824d652009-03-28 06:44:27 +00002492 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \
2493 "-bt hci,host[:id]\n" \
2494 " use host's HCI with the given name\n" \
2495 "-bt hci[,vlan=n]\n" \
2496 " emulate a standard HCI in virtual scatternet 'n'\n" \
2497 "-bt vhci[,vlan=n]\n" \
2498 " add host computer to virtual scatternet 'n' using VHCI\n" \
2499 "-bt device:dev[,vlan=n]\n" \
Blue Swirlad960902010-03-29 19:23:52 +00002500 " emulate a bluetooth device 'dev' in scatternet 'n'\n",
2501 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002502STEXI
blueswir15824d652009-03-28 06:44:27 +00002503@item -bt hci[...]
Stefan Weil6616b2a2010-02-05 23:52:05 +01002504@findex -bt
blueswir15824d652009-03-28 06:44:27 +00002505Defines the function of the corresponding Bluetooth HCI. -bt options
2506are matched with the HCIs present in the chosen machine type. For
2507example when emulating a machine with only one HCI built into it, only
2508the first @code{-bt hci[...]} option is valid and defines the HCI's
2509logic. The Transport Layer is decided by the machine type. Currently
2510the machines @code{n800} and @code{n810} have one HCI and all other
2511machines have none.
2512
2513@anchor{bt-hcis}
2514The following three types are recognized:
2515
Kevin Wolfb3f046c2009-10-09 10:58:35 +02002516@table @option
blueswir15824d652009-03-28 06:44:27 +00002517@item -bt hci,null
2518(default) The corresponding Bluetooth HCI assumes no internal logic
2519and will not respond to any HCI commands or emit events.
2520
2521@item -bt hci,host[:@var{id}]
2522(@code{bluez} only) The corresponding HCI passes commands / events
2523to / from the physical HCI identified by the name @var{id} (default:
2524@code{hci0}) on the computer running QEMU. Only available on @code{bluez}
2525capable systems like Linux.
2526
2527@item -bt hci[,vlan=@var{n}]
2528Add a virtual, standard HCI that will participate in the Bluetooth
2529scatternet @var{n} (default @code{0}). Similarly to @option{-net}
2530VLANs, devices inside a bluetooth network @var{n} can only communicate
2531with other devices in the same network (scatternet).
2532@end table
2533
2534@item -bt vhci[,vlan=@var{n}]
2535(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
2536to the host bluetooth stack instead of to the emulated target. This
2537allows the host and target machines to participate in a common scatternet
2538and communicate. Requires the Linux @code{vhci} driver installed. Can
2539be used as following:
2540
2541@example
Stefan Weil3804da92012-05-11 22:21:50 +02002542qemu-system-i386 [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
blueswir15824d652009-03-28 06:44:27 +00002543@end example
2544
2545@item -bt device:@var{dev}[,vlan=@var{n}]
2546Emulate a bluetooth device @var{dev} and place it in network @var{n}
2547(default @code{0}). QEMU can only emulate one type of bluetooth devices
2548currently:
2549
Kevin Wolfb3f046c2009-10-09 10:58:35 +02002550@table @option
blueswir15824d652009-03-28 06:44:27 +00002551@item keyboard
2552Virtual wireless keyboard implementing the HIDP bluetooth profile.
2553@end table
blueswir15824d652009-03-28 06:44:27 +00002554ETEXI
2555
Markus Armbrusterc70a01e2013-02-13 19:49:40 +01002556STEXI
2557@end table
2558ETEXI
blueswir15824d652009-03-28 06:44:27 +00002559DEFHEADING()
2560
Stefan Bergerd1a0cf72013-02-27 12:47:49 -05002561#ifdef CONFIG_TPM
2562DEFHEADING(TPM device options:)
2563
2564DEF("tpmdev", HAS_ARG, QEMU_OPTION_tpmdev, \
Stefan Berger92dcc232013-02-27 12:47:54 -05002565 "-tpmdev passthrough,id=id[,path=path][,cancel-path=path]\n"
2566 " use path to provide path to a character device; default is /dev/tpm0\n"
2567 " use cancel-path to provide path to TPM's cancel sysfs entry; if\n"
2568 " not provided it will be searched for in /sys/class/misc/tpm?/device\n",
Stefan Bergerd1a0cf72013-02-27 12:47:49 -05002569 QEMU_ARCH_ALL)
2570STEXI
2571
2572The general form of a TPM device option is:
2573@table @option
2574
2575@item -tpmdev @var{backend} ,id=@var{id} [,@var{options}]
2576@findex -tpmdev
2577Backend type must be:
Stefan Berger4549a8b2013-02-27 12:47:53 -05002578@option{passthrough}.
Stefan Bergerd1a0cf72013-02-27 12:47:49 -05002579
2580The specific backend type will determine the applicable options.
Corey Bryant28c4fa32013-03-20 12:34:49 -04002581The @code{-tpmdev} option creates the TPM backend and requires a
2582@code{-device} option that specifies the TPM frontend interface model.
Stefan Bergerd1a0cf72013-02-27 12:47:49 -05002583
2584Options to each backend are described below.
2585
2586Use 'help' to print all available TPM backend types.
2587@example
2588qemu -tpmdev help
2589@end example
2590
Stefan Berger92dcc232013-02-27 12:47:54 -05002591@item -tpmdev passthrough, id=@var{id}, path=@var{path}, cancel-path=@var{cancel-path}
Stefan Berger4549a8b2013-02-27 12:47:53 -05002592
2593(Linux-host only) Enable access to the host's TPM using the passthrough
2594driver.
2595
2596@option{path} specifies the path to the host's TPM device, i.e., on
2597a Linux host this would be @code{/dev/tpm0}.
2598@option{path} is optional and by default @code{/dev/tpm0} is used.
2599
Stefan Berger92dcc232013-02-27 12:47:54 -05002600@option{cancel-path} specifies the path to the host TPM device's sysfs
2601entry allowing for cancellation of an ongoing TPM command.
2602@option{cancel-path} is optional and by default QEMU will search for the
2603sysfs entry to use.
2604
Stefan Berger4549a8b2013-02-27 12:47:53 -05002605Some notes about using the host's TPM with the passthrough driver:
2606
2607The TPM device accessed by the passthrough driver must not be
2608used by any other application on the host.
2609
2610Since the host's firmware (BIOS/UEFI) has already initialized the TPM,
2611the VM's firmware (BIOS/UEFI) will not be able to initialize the
2612TPM again and may therefore not show a TPM-specific menu that would
2613otherwise allow the user to configure the TPM, e.g., allow the user to
2614enable/disable or activate/deactivate the TPM.
2615Further, if TPM ownership is released from within a VM then the host's TPM
2616will get disabled and deactivated. To enable and activate the
2617TPM again afterwards, the host has to be rebooted and the user is
2618required to enter the firmware's menu to enable and activate the TPM.
2619If the TPM is left disabled and/or deactivated most TPM commands will fail.
2620
2621To create a passthrough TPM use the following two options:
2622@example
2623-tpmdev passthrough,id=tpm0 -device tpm-tis,tpmdev=tpm0
2624@end example
2625Note that the @code{-tpmdev} id is @code{tpm0} and is referenced by
2626@code{tpmdev=tpm0} in the device option.
2627
Stefan Bergerd1a0cf72013-02-27 12:47:49 -05002628@end table
2629
2630ETEXI
2631
2632DEFHEADING()
2633
2634#endif
2635
Alexander Graf7677f052009-06-28 16:55:55 +02002636DEFHEADING(Linux/Multiboot boot specific:)
blueswir15824d652009-03-28 06:44:27 +00002637STEXI
Alexander Graf7677f052009-06-28 16:55:55 +02002638
2639When using these options, you can use a given Linux or Multiboot
2640kernel without installing it in the disk image. It can be useful
blueswir15824d652009-03-28 06:44:27 +00002641for easier testing of various kernels.
2642
2643@table @option
2644ETEXI
2645
2646DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \
Blue Swirlad960902010-03-29 19:23:52 +00002647 "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002648STEXI
2649@item -kernel @var{bzImage}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002650@findex -kernel
Alexander Graf7677f052009-06-28 16:55:55 +02002651Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel
2652or in multiboot format.
blueswir15824d652009-03-28 06:44:27 +00002653ETEXI
2654
2655DEF("append", HAS_ARG, QEMU_OPTION_append, \
Blue Swirlad960902010-03-29 19:23:52 +00002656 "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002657STEXI
2658@item -append @var{cmdline}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002659@findex -append
blueswir15824d652009-03-28 06:44:27 +00002660Use @var{cmdline} as kernel command line
2661ETEXI
2662
2663DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \
Blue Swirlad960902010-03-29 19:23:52 +00002664 "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002665STEXI
2666@item -initrd @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002667@findex -initrd
blueswir15824d652009-03-28 06:44:27 +00002668Use @var{file} as initial ram disk.
Alexander Graf7677f052009-06-28 16:55:55 +02002669
2670@item -initrd "@var{file1} arg=foo,@var{file2}"
2671
2672This syntax is only available with multiboot.
2673
2674Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the
2675first module.
blueswir15824d652009-03-28 06:44:27 +00002676ETEXI
2677
Grant Likely412beee2012-03-02 11:56:38 +00002678DEF("dtb", HAS_ARG, QEMU_OPTION_dtb, \
Peter A. G. Crosthwaite379b5c72012-03-04 21:03:54 +10002679 "-dtb file use 'file' as device tree image\n", QEMU_ARCH_ALL)
Grant Likely412beee2012-03-02 11:56:38 +00002680STEXI
2681@item -dtb @var{file}
2682@findex -dtb
2683Use @var{file} as a device tree binary (dtb) image and pass it to the kernel
2684on boot.
2685ETEXI
2686
blueswir15824d652009-03-28 06:44:27 +00002687STEXI
2688@end table
2689ETEXI
blueswir15824d652009-03-28 06:44:27 +00002690DEFHEADING()
2691
2692DEFHEADING(Debug/Expert options:)
blueswir15824d652009-03-28 06:44:27 +00002693STEXI
2694@table @option
2695ETEXI
2696
Gabriel L. Somlo81b2b812015-04-29 11:21:53 -04002697DEF("fw_cfg", HAS_ARG, QEMU_OPTION_fwcfg,
2698 "-fw_cfg [name=]<name>,file=<file>\n"
2699 " add named fw_cfg entry from file\n",
2700 QEMU_ARCH_ALL)
2701STEXI
2702@item -fw_cfg [name=]@var{name},file=@var{file}
2703@findex -fw_cfg
2704Add named fw_cfg entry from file. @var{name} determines the name of
2705the entry in the fw_cfg file directory exposed to the guest.
2706ETEXI
2707
blueswir15824d652009-03-28 06:44:27 +00002708DEF("serial", HAS_ARG, QEMU_OPTION_serial, \
Blue Swirlad960902010-03-29 19:23:52 +00002709 "-serial dev redirect the serial port to char device 'dev'\n",
2710 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002711STEXI
2712@item -serial @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002713@findex -serial
blueswir15824d652009-03-28 06:44:27 +00002714Redirect the virtual serial port to host character device
2715@var{dev}. The default device is @code{vc} in graphical mode and
2716@code{stdio} in non graphical mode.
2717
2718This option can be used several times to simulate up to 4 serial
2719ports.
2720
2721Use @code{-serial none} to disable all serial ports.
2722
2723Available character devices are:
Kevin Wolfb3f046c2009-10-09 10:58:35 +02002724@table @option
Kevin Wolf4e257e52009-10-09 10:58:36 +02002725@item vc[:@var{W}x@var{H}]
blueswir15824d652009-03-28 06:44:27 +00002726Virtual console. Optionally, a width and height can be given in pixel with
2727@example
2728vc:800x600
2729@end example
2730It is also possible to specify width or height in characters:
2731@example
2732vc:80Cx24C
2733@end example
2734@item pty
2735[Linux only] Pseudo TTY (a new PTY is automatically allocated)
2736@item none
2737No device is allocated.
2738@item null
2739void device
Ingo van Lil88e020e2013-12-20 14:44:53 +01002740@item chardev:@var{id}
2741Use a named character device defined with the @code{-chardev} option.
blueswir15824d652009-03-28 06:44:27 +00002742@item /dev/XXX
2743[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
2744parameters are set according to the emulated ones.
2745@item /dev/parport@var{N}
2746[Linux only, parallel port only] Use host parallel port
2747@var{N}. Currently SPP and EPP parallel port features can be used.
2748@item file:@var{filename}
2749Write output to @var{filename}. No character can be read.
2750@item stdio
2751[Unix only] standard input/output
2752@item pipe:@var{filename}
2753name pipe @var{filename}
2754@item COM@var{n}
2755[Windows only] Use host serial port @var{n}
2756@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
2757This implements UDP Net Console.
2758When @var{remote_host} or @var{src_ip} are not specified
2759they default to @code{0.0.0.0}.
2760When not using a specified @var{src_port} a random port is automatically chosen.
blueswir15824d652009-03-28 06:44:27 +00002761
2762If you just want a simple readonly console you can use @code{netcat} or
Stefan Weilb65ee4f2012-05-11 22:25:50 +02002763@code{nc}, by starting QEMU with: @code{-serial udp::4555} and nc as:
2764@code{nc -u -l -p 4555}. Any time QEMU writes something to that port it
blueswir15824d652009-03-28 06:44:27 +00002765will appear in the netconsole session.
2766
2767If you plan to send characters back via netconsole or you want to stop
Stefan Weilb65ee4f2012-05-11 22:25:50 +02002768and start QEMU a lot of times, you should have QEMU use the same
blueswir15824d652009-03-28 06:44:27 +00002769source port each time by using something like @code{-serial
Stefan Weilb65ee4f2012-05-11 22:25:50 +02002770udp::4555@@:4556} to QEMU. Another approach is to use a patched
blueswir15824d652009-03-28 06:44:27 +00002771version of netcat which can listen to a TCP port and send and receive
2772characters via udp. If you have a patched version of netcat which
2773activates telnet remote echo and single char transfer, then you can
2774use the following options to step up a netcat redirector to allow
Stefan Weilb65ee4f2012-05-11 22:25:50 +02002775telnet on port 5555 to access the QEMU port.
blueswir15824d652009-03-28 06:44:27 +00002776@table @code
Stefan Weil071c9392012-04-07 09:23:36 +02002777@item QEMU Options:
blueswir15824d652009-03-28 06:44:27 +00002778-serial udp::4555@@:4556
2779@item netcat options:
2780-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
2781@item telnet options:
2782localhost 5555
2783@end table
2784
Corey Minyard5dd1f022014-10-02 11:17:37 -05002785@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay][,reconnect=@var{seconds}]
blueswir15824d652009-03-28 06:44:27 +00002786The TCP Net Console has two modes of operation. It can send the serial
2787I/O to a location or wait for a connection from a location. By default
2788the TCP Net Console is sent to @var{host} at the @var{port}. If you use
2789the @var{server} option QEMU will wait for a client socket application
2790to connect to the port before continuing, unless the @code{nowait}
2791option was specified. The @code{nodelay} option disables the Nagle buffering
Corey Minyard5dd1f022014-10-02 11:17:37 -05002792algorithm. The @code{reconnect} option only applies if @var{noserver} is
2793set, if the connection goes down it will attempt to reconnect at the
2794given interval. If @var{host} is omitted, 0.0.0.0 is assumed. Only
blueswir15824d652009-03-28 06:44:27 +00002795one TCP connection at a time is accepted. You can use @code{telnet} to
2796connect to the corresponding character device.
2797@table @code
2798@item Example to send tcp console to 192.168.0.2 port 4444
2799-serial tcp:192.168.0.2:4444
2800@item Example to listen and wait on port 4444 for connection
2801-serial tcp::4444,server
2802@item Example to not wait and listen on ip 192.168.0.100 port 4444
2803-serial tcp:192.168.0.100:4444,server,nowait
2804@end table
2805
2806@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
2807The telnet protocol is used instead of raw tcp sockets. The options
2808work the same as if you had specified @code{-serial tcp}. The
2809difference is that the port acts like a telnet server or client using
2810telnet option negotiation. This will also allow you to send the
2811MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
2812sequence. Typically in unix telnet you do it with Control-] and then
2813type "send break" followed by pressing the enter key.
2814
Corey Minyard5dd1f022014-10-02 11:17:37 -05002815@item unix:@var{path}[,server][,nowait][,reconnect=@var{seconds}]
blueswir15824d652009-03-28 06:44:27 +00002816A unix domain socket is used instead of a tcp socket. The option works the
2817same as if you had specified @code{-serial tcp} except the unix domain socket
2818@var{path} is used for connections.
2819
2820@item mon:@var{dev_string}
2821This is a special option to allow the monitor to be multiplexed onto
2822another serial port. The monitor is accessed with key sequence of
Paolo Bonzini02c4bdf2013-07-03 20:29:45 +04002823@key{Control-a} and then pressing @key{c}.
blueswir15824d652009-03-28 06:44:27 +00002824@var{dev_string} should be any one of the serial devices specified
2825above. An example to multiplex the monitor onto a telnet server
2826listening on port 4444 would be:
2827@table @code
2828@item -serial mon:telnet::4444,server,nowait
2829@end table
Michael Tokarevbe022d62013-07-11 12:55:50 +04002830When the monitor is multiplexed to stdio in this way, Ctrl+C will not terminate
2831QEMU any more but will be passed to the guest instead.
blueswir15824d652009-03-28 06:44:27 +00002832
2833@item braille
2834Braille device. This will use BrlAPI to display the braille output on a real
2835or fake device.
2836
Kevin Wolfbe8b28a2009-10-09 10:58:37 +02002837@item msmouse
2838Three button serial mouse. Configure the guest to use Microsoft protocol.
blueswir15824d652009-03-28 06:44:27 +00002839@end table
2840ETEXI
2841
2842DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \
Blue Swirlad960902010-03-29 19:23:52 +00002843 "-parallel dev redirect the parallel port to char device 'dev'\n",
2844 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002845STEXI
2846@item -parallel @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002847@findex -parallel
blueswir15824d652009-03-28 06:44:27 +00002848Redirect the virtual parallel port to host device @var{dev} (same
2849devices as the serial port). On Linux hosts, @file{/dev/parportN} can
2850be used to use hardware devices connected on the corresponding host
2851parallel port.
2852
2853This option can be used several times to simulate up to 3 parallel
2854ports.
2855
2856Use @code{-parallel none} to disable all parallel ports.
2857ETEXI
2858
2859DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \
Blue Swirlad960902010-03-29 19:23:52 +00002860 "-monitor dev redirect the monitor to char device 'dev'\n",
2861 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002862STEXI
Gerd Hoffmann4e307fc2009-12-08 13:11:37 +01002863@item -monitor @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002864@findex -monitor
blueswir15824d652009-03-28 06:44:27 +00002865Redirect the monitor to host device @var{dev} (same devices as the
2866serial port).
2867The default device is @code{vc} in graphical mode and @code{stdio} in
2868non graphical mode.
Luiz Capitulino70e098a2013-05-16 12:02:55 -04002869Use @code{-monitor none} to disable the default monitor.
blueswir15824d652009-03-28 06:44:27 +00002870ETEXI
Gerd Hoffmann6ca55822009-12-08 13:11:52 +01002871DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \
Blue Swirlad960902010-03-29 19:23:52 +00002872 "-qmp dev like -monitor but opens in 'control' mode\n",
2873 QEMU_ARCH_ALL)
Stefan Weil95d5f082010-01-20 22:25:27 +01002874STEXI
2875@item -qmp @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002876@findex -qmp
Stefan Weil95d5f082010-01-20 22:25:27 +01002877Like -monitor but opens in 'control' mode.
2878ETEXI
Max Reitz4821cd42014-11-17 13:31:04 +01002879DEF("qmp-pretty", HAS_ARG, QEMU_OPTION_qmp_pretty, \
2880 "-qmp-pretty dev like -qmp but uses pretty JSON formatting\n",
2881 QEMU_ARCH_ALL)
2882STEXI
2883@item -qmp-pretty @var{dev}
2884@findex -qmp-pretty
2885Like -qmp but uses pretty JSON formatting.
2886ETEXI
blueswir15824d652009-03-28 06:44:27 +00002887
Gerd Hoffmann22a0e042009-12-08 13:11:51 +01002888DEF("mon", HAS_ARG, QEMU_OPTION_mon, \
Michael Tokarevf17e4ea2013-06-15 13:47:32 +04002889 "-mon [chardev=]name[,mode=readline|control][,default]\n", QEMU_ARCH_ALL)
Gerd Hoffmann22a0e042009-12-08 13:11:51 +01002890STEXI
Michael Tokarevf17e4ea2013-06-15 13:47:32 +04002891@item -mon [chardev=]name[,mode=readline|control][,default]
Stefan Weil6616b2a2010-02-05 23:52:05 +01002892@findex -mon
Gerd Hoffmann22a0e042009-12-08 13:11:51 +01002893Setup monitor on chardev @var{name}.
2894ETEXI
2895
H. Peter Anvinc9f398e2009-12-29 13:51:36 -08002896DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \
Blue Swirlad960902010-03-29 19:23:52 +00002897 "-debugcon dev redirect the debug console to char device 'dev'\n",
2898 QEMU_ARCH_ALL)
H. Peter Anvinc9f398e2009-12-29 13:51:36 -08002899STEXI
2900@item -debugcon @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002901@findex -debugcon
H. Peter Anvinc9f398e2009-12-29 13:51:36 -08002902Redirect the debug console to host device @var{dev} (same devices as the
2903serial port). The debug console is an I/O port which is typically port
29040xe9; writing to that I/O port sends output to this device.
2905The default device is @code{vc} in graphical mode and @code{stdio} in
2906non graphical mode.
2907ETEXI
2908
blueswir15824d652009-03-28 06:44:27 +00002909DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \
Blue Swirlad960902010-03-29 19:23:52 +00002910 "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002911STEXI
2912@item -pidfile @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002913@findex -pidfile
blueswir15824d652009-03-28 06:44:27 +00002914Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
2915from a script.
2916ETEXI
2917
aurel321b530a62009-04-05 20:08:59 +00002918DEF("singlestep", 0, QEMU_OPTION_singlestep, \
Blue Swirlad960902010-03-29 19:23:52 +00002919 "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL)
aurel321b530a62009-04-05 20:08:59 +00002920STEXI
2921@item -singlestep
Stefan Weil6616b2a2010-02-05 23:52:05 +01002922@findex -singlestep
aurel321b530a62009-04-05 20:08:59 +00002923Run the emulation in single step mode.
2924ETEXI
2925
blueswir15824d652009-03-28 06:44:27 +00002926DEF("S", 0, QEMU_OPTION_S, \
Blue Swirlad960902010-03-29 19:23:52 +00002927 "-S freeze CPU at startup (use 'c' to start execution)\n",
2928 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002929STEXI
2930@item -S
Stefan Weil6616b2a2010-02-05 23:52:05 +01002931@findex -S
blueswir15824d652009-03-28 06:44:27 +00002932Do not start CPU at startup (you must type 'c' in the monitor).
2933ETEXI
2934
Satoru Moriya888a6bc2013-04-19 16:42:06 +02002935DEF("realtime", HAS_ARG, QEMU_OPTION_realtime,
2936 "-realtime [mlock=on|off]\n"
2937 " run qemu with realtime features\n"
2938 " mlock=on|off controls mlock support (default: on)\n",
2939 QEMU_ARCH_ALL)
2940STEXI
2941@item -realtime mlock=on|off
2942@findex -realtime
2943Run qemu with realtime features.
2944mlocking qemu and guest memory can be enabled via @option{mlock=on}
2945(enabled by default).
2946ETEXI
2947
aliguori59030a82009-04-05 18:43:41 +00002948DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \
Blue Swirlad960902010-03-29 19:23:52 +00002949 "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002950STEXI
aliguori59030a82009-04-05 18:43:41 +00002951@item -gdb @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002952@findex -gdb
aliguori59030a82009-04-05 18:43:41 +00002953Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical
2954connections will likely be TCP-based, but also UDP, pseudo TTY, or even
Stefan Weilb65ee4f2012-05-11 22:25:50 +02002955stdio are reasonable use case. The latter is allowing to start QEMU from
aliguori59030a82009-04-05 18:43:41 +00002956within gdb and establish the connection via a pipe:
2957@example
Stefan Weil3804da92012-05-11 22:21:50 +02002958(gdb) target remote | exec qemu-system-i386 -gdb stdio ...
aliguori59030a82009-04-05 18:43:41 +00002959@end example
blueswir15824d652009-03-28 06:44:27 +00002960ETEXI
2961
aliguori59030a82009-04-05 18:43:41 +00002962DEF("s", 0, QEMU_OPTION_s, \
Blue Swirlad960902010-03-29 19:23:52 +00002963 "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n",
2964 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002965STEXI
aliguori59030a82009-04-05 18:43:41 +00002966@item -s
Stefan Weil6616b2a2010-02-05 23:52:05 +01002967@findex -s
aliguori59030a82009-04-05 18:43:41 +00002968Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
2969(@pxref{gdb_usage}).
blueswir15824d652009-03-28 06:44:27 +00002970ETEXI
2971
2972DEF("d", HAS_ARG, QEMU_OPTION_d, \
Peter Maydell989b6972013-02-26 17:52:40 +00002973 "-d item1,... enable logging of specified items (use '-d help' for a list of log items)\n",
Blue Swirlad960902010-03-29 19:23:52 +00002974 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002975STEXI
Peter Maydell989b6972013-02-26 17:52:40 +00002976@item -d @var{item1}[,...]
Stefan Weil6616b2a2010-02-05 23:52:05 +01002977@findex -d
Peter Maydell989b6972013-02-26 17:52:40 +00002978Enable logging of specified items. Use '-d help' for a list of log items.
blueswir15824d652009-03-28 06:44:27 +00002979ETEXI
2980
Matthew Fernandezc235d732011-06-07 16:32:40 +00002981DEF("D", HAS_ARG, QEMU_OPTION_D, \
Peter Maydell989b6972013-02-26 17:52:40 +00002982 "-D logfile output log to logfile (default stderr)\n",
Matthew Fernandezc235d732011-06-07 16:32:40 +00002983 QEMU_ARCH_ALL)
2984STEXI
Stefan Weil8bd383b2012-05-11 22:40:50 +02002985@item -D @var{logfile}
Matthew Fernandezc235d732011-06-07 16:32:40 +00002986@findex -D
Peter Maydell989b6972013-02-26 17:52:40 +00002987Output log in @var{logfile} instead of to stderr
Matthew Fernandezc235d732011-06-07 16:32:40 +00002988ETEXI
2989
blueswir15824d652009-03-28 06:44:27 +00002990DEF("L", HAS_ARG, QEMU_OPTION_L, \
Blue Swirlad960902010-03-29 19:23:52 +00002991 "-L path set the directory for the BIOS, VGA BIOS and keymaps\n",
2992 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002993STEXI
2994@item -L @var{path}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002995@findex -L
blueswir15824d652009-03-28 06:44:27 +00002996Set the directory for the BIOS, VGA BIOS and keymaps.
2997ETEXI
2998
2999DEF("bios", HAS_ARG, QEMU_OPTION_bios, \
Blue Swirlad960902010-03-29 19:23:52 +00003000 "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003001STEXI
3002@item -bios @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003003@findex -bios
blueswir15824d652009-03-28 06:44:27 +00003004Set the filename for the BIOS.
3005ETEXI
3006
blueswir15824d652009-03-28 06:44:27 +00003007DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \
Blue Swirlad960902010-03-29 19:23:52 +00003008 "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003009STEXI
3010@item -enable-kvm
Stefan Weil6616b2a2010-02-05 23:52:05 +01003011@findex -enable-kvm
blueswir15824d652009-03-28 06:44:27 +00003012Enable KVM full virtualization support. This option is only available
3013if KVM support is enabled when compiling.
3014ETEXI
3015
aliguorie37630c2009-04-22 15:19:10 +00003016DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid,
Blue Swirlad960902010-03-29 19:23:52 +00003017 "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL)
aliguorie37630c2009-04-22 15:19:10 +00003018DEF("xen-create", 0, QEMU_OPTION_xen_create,
3019 "-xen-create create domain using xen hypercalls, bypassing xend\n"
Blue Swirlad960902010-03-29 19:23:52 +00003020 " warning: should not be used when xend is in use\n",
3021 QEMU_ARCH_ALL)
aliguorie37630c2009-04-22 15:19:10 +00003022DEF("xen-attach", 0, QEMU_OPTION_xen_attach,
3023 "-xen-attach attach to existing xen domain\n"
Stefan Weilb65ee4f2012-05-11 22:25:50 +02003024 " xend will use this when starting QEMU\n",
Blue Swirlad960902010-03-29 19:23:52 +00003025 QEMU_ARCH_ALL)
Stefan Weil95d5f082010-01-20 22:25:27 +01003026STEXI
3027@item -xen-domid @var{id}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003028@findex -xen-domid
Stefan Weil95d5f082010-01-20 22:25:27 +01003029Specify xen guest domain @var{id} (XEN only).
3030@item -xen-create
Stefan Weil6616b2a2010-02-05 23:52:05 +01003031@findex -xen-create
Stefan Weil95d5f082010-01-20 22:25:27 +01003032Create domain using xen hypercalls, bypassing xend.
3033Warning: should not be used when xend is in use (XEN only).
3034@item -xen-attach
Stefan Weil6616b2a2010-02-05 23:52:05 +01003035@findex -xen-attach
Stefan Weil95d5f082010-01-20 22:25:27 +01003036Attach to existing xen domain.
Stefan Weilb65ee4f2012-05-11 22:25:50 +02003037xend will use this when starting QEMU (XEN only).
Stefan Weil95d5f082010-01-20 22:25:27 +01003038ETEXI
aliguorie37630c2009-04-22 15:19:10 +00003039
blueswir15824d652009-03-28 06:44:27 +00003040DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \
Blue Swirlad960902010-03-29 19:23:52 +00003041 "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003042STEXI
3043@item -no-reboot
Stefan Weil6616b2a2010-02-05 23:52:05 +01003044@findex -no-reboot
blueswir15824d652009-03-28 06:44:27 +00003045Exit instead of rebooting.
3046ETEXI
3047
3048DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \
Blue Swirlad960902010-03-29 19:23:52 +00003049 "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003050STEXI
3051@item -no-shutdown
Stefan Weil6616b2a2010-02-05 23:52:05 +01003052@findex -no-shutdown
blueswir15824d652009-03-28 06:44:27 +00003053Don't exit QEMU on guest shutdown, but instead only stop the emulation.
3054This allows for instance switching to monitor to commit changes to the
3055disk image.
3056ETEXI
3057
3058DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \
3059 "-loadvm [tag|id]\n" \
Blue Swirlad960902010-03-29 19:23:52 +00003060 " start right away with a saved state (loadvm in monitor)\n",
3061 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003062STEXI
3063@item -loadvm @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003064@findex -loadvm
blueswir15824d652009-03-28 06:44:27 +00003065Start right away with a saved state (@code{loadvm} in monitor)
3066ETEXI
3067
3068#ifndef _WIN32
3069DEF("daemonize", 0, QEMU_OPTION_daemonize, \
Blue Swirlad960902010-03-29 19:23:52 +00003070 "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003071#endif
3072STEXI
3073@item -daemonize
Stefan Weil6616b2a2010-02-05 23:52:05 +01003074@findex -daemonize
blueswir15824d652009-03-28 06:44:27 +00003075Daemonize the QEMU process after initialization. QEMU will not detach from
3076standard IO until it is ready to receive connections on any of its devices.
3077This option is a useful way for external programs to launch QEMU without having
3078to cope with initialization race conditions.
3079ETEXI
3080
3081DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \
Blue Swirlad960902010-03-29 19:23:52 +00003082 "-option-rom rom load a file, rom, into the option ROM space\n",
3083 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003084STEXI
3085@item -option-rom @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003086@findex -option-rom
blueswir15824d652009-03-28 06:44:27 +00003087Load the contents of @var{file} as an option ROM.
3088This option is useful to load things like EtherBoot.
3089ETEXI
3090
Markus Armbrustere2180522014-10-06 16:19:07 +02003091HXCOMM Silently ignored for compatibility
3092DEF("clock", HAS_ARG, QEMU_OPTION_clock, "", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003093
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02003094HXCOMM Options deprecated by -rtc
Blue Swirlad960902010-03-29 19:23:52 +00003095DEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL)
3096DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003097
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02003098DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \
Paolo Bonzini78808142012-03-30 10:31:21 +00003099 "-rtc [base=utc|localtime|date][,clock=host|rt|vm][,driftfix=none|slew]\n" \
Blue Swirlad960902010-03-29 19:23:52 +00003100 " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n",
3101 QEMU_ARCH_ALL)
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02003102
blueswir15824d652009-03-28 06:44:27 +00003103STEXI
3104
Jan Kiszka68752042009-09-15 13:36:04 +02003105@item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew]
Stefan Weil6616b2a2010-02-05 23:52:05 +01003106@findex -rtc
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02003107Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current
3108UTC or local time, respectively. @code{localtime} is required for correct date in
3109MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the
3110format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC.
3111
Michael Tokarev9d85d552014-04-07 13:34:58 +04003112By default the RTC is driven by the host system time. This allows using of the
Jan Kiszka68752042009-09-15 13:36:04 +02003113RTC as accurate reference clock inside the guest, specifically if the host
3114time is smoothly following an accurate external reference clock, e.g. via NTP.
Paolo Bonzini78808142012-03-30 10:31:21 +00003115If you want to isolate the guest time from the host, you can set @option{clock}
3116to @code{rt} instead. To even prevent it from progressing during suspension,
3117you can set it to @code{vm}.
Jan Kiszka68752042009-09-15 13:36:04 +02003118
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02003119Enable @option{driftfix} (i386 targets only) if you experience time drift problems,
3120specifically with Windows' ACPI HAL. This option will try to figure out how
3121many timer interrupts were not processed by the Windows guest and will
3122re-inject them.
blueswir15824d652009-03-28 06:44:27 +00003123ETEXI
3124
3125DEF("icount", HAS_ARG, QEMU_OPTION_icount, \
Victor CLEMENTf1f4b572015-05-29 17:14:05 +02003126 "-icount [shift=N|auto][,align=on|off][,sleep=no]\n" \
aliguoribc14ca22009-04-05 18:43:37 +00003127 " enable virtual instruction counter with 2^N clock ticks per\n" \
Victor CLEMENTf1f4b572015-05-29 17:14:05 +02003128 " instruction, enable aligning the host and virtual clocks\n" \
3129 " or disable real time cpu sleeping\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003130STEXI
Sebastian Tanase1ad95802014-07-25 11:56:28 +02003131@item -icount [shift=@var{N}|auto]
Stefan Weil6616b2a2010-02-05 23:52:05 +01003132@findex -icount
blueswir15824d652009-03-28 06:44:27 +00003133Enable virtual instruction counter. The virtual cpu will execute one
Kevin Wolf4e257e52009-10-09 10:58:36 +02003134instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified
blueswir15824d652009-03-28 06:44:27 +00003135then the virtual cpu speed will be automatically adjusted to keep virtual
3136time within a few seconds of real time.
3137
Victor CLEMENTf1f4b572015-05-29 17:14:05 +02003138When the virtual cpu is sleeping, the virtual time will advance at default
3139speed unless @option{sleep=no} is specified.
3140With @option{sleep=no}, the virtual time will jump to the next timer deadline
3141instantly whenever the virtual cpu goes to sleep mode and will not advance
3142if no timer is enabled. This behavior give deterministic execution times from
3143the guest point of view.
3144
blueswir15824d652009-03-28 06:44:27 +00003145Note that while this option can give deterministic behavior, it does not
3146provide cycle accurate emulation. Modern CPUs contain superscalar out of
3147order cores with complex cache hierarchies. The number of instructions
3148executed often has little or no correlation with actual performance.
Sebastian Tanasea8bfac32014-07-25 11:56:29 +02003149
3150@option{align=on} will activate the delay algorithm which will try to
3151to synchronise the host clock and the virtual clock. The goal is to
3152have a guest running at the real frequency imposed by the shift option.
3153Whenever the guest clock is behind the host clock and if
Michael Tokarev82597612015-04-27 11:12:49 +03003154@option{align=on} is specified then we print a message to the user
Sebastian Tanasea8bfac32014-07-25 11:56:29 +02003155to inform about the delay.
3156Currently this option does not work when @option{shift} is @code{auto}.
3157Note: The sync algorithm will work for those shift values for which
3158the guest clock runs ahead of the host clock. Typically this happens
3159when the shift value is high (how high depends on the host machine).
blueswir15824d652009-03-28 06:44:27 +00003160ETEXI
3161
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01003162DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \
Xu Wangd7933ef2015-06-11 17:32:05 +02003163 "-watchdog model\n" \
Blue Swirlad960902010-03-29 19:23:52 +00003164 " enable virtual hardware watchdog [default=none]\n",
3165 QEMU_ARCH_ALL)
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01003166STEXI
3167@item -watchdog @var{model}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003168@findex -watchdog
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01003169Create a virtual hardware watchdog device. Once enabled (by a guest
3170action), the watchdog must be periodically polled by an agent inside
Xu Wangd7933ef2015-06-11 17:32:05 +02003171the guest or else the guest will be restarted. Choose a model for
3172which your guest has drivers.
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01003173
Xu Wangd7933ef2015-06-11 17:32:05 +02003174The @var{model} is the model of hardware watchdog to emulate. Use
3175@code{-watchdog help} to list available hardware models. Only one
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01003176watchdog can be enabled for a guest.
Xu Wangd7933ef2015-06-11 17:32:05 +02003177
3178The following models may be available:
3179@table @option
3180@item ib700
3181iBASE 700 is a very simple ISA watchdog with a single timer.
3182@item i6300esb
3183Intel 6300ESB I/O controller hub is a much more featureful PCI-based
3184dual-timer watchdog.
Xu Wang188f24c2015-02-05 18:28:32 +08003185@item diag288
3186A virtual watchdog for s390x backed by the diagnose 288 hypercall
3187(currently KVM only).
Xu Wangd7933ef2015-06-11 17:32:05 +02003188@end table
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01003189ETEXI
3190
3191DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \
3192 "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \
Blue Swirlad960902010-03-29 19:23:52 +00003193 " action when watchdog fires [default=reset]\n",
3194 QEMU_ARCH_ALL)
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01003195STEXI
3196@item -watchdog-action @var{action}
Markus Armbrusterb8f490e2013-02-13 19:49:38 +01003197@findex -watchdog-action
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01003198
3199The @var{action} controls what QEMU will do when the watchdog timer
3200expires.
3201The default is
3202@code{reset} (forcefully reset the guest).
3203Other possible actions are:
3204@code{shutdown} (attempt to gracefully shutdown the guest),
3205@code{poweroff} (forcefully poweroff the guest),
3206@code{pause} (pause the guest),
3207@code{debug} (print a debug message and continue), or
3208@code{none} (do nothing).
3209
3210Note that the @code{shutdown} action requires that the guest responds
3211to ACPI signals, which it may not be able to do in the sort of
3212situations where the watchdog would have expired, and thus
3213@code{-watchdog-action shutdown} is not recommended for production use.
3214
3215Examples:
3216
3217@table @code
3218@item -watchdog i6300esb -watchdog-action pause
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02003219@itemx -watchdog ib700
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01003220@end table
3221ETEXI
3222
blueswir15824d652009-03-28 06:44:27 +00003223DEF("echr", HAS_ARG, QEMU_OPTION_echr, \
Blue Swirlad960902010-03-29 19:23:52 +00003224 "-echr chr set terminal escape character instead of ctrl-a\n",
3225 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003226STEXI
3227
Kevin Wolf4e257e52009-10-09 10:58:36 +02003228@item -echr @var{numeric_ascii_value}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003229@findex -echr
blueswir15824d652009-03-28 06:44:27 +00003230Change the escape character used for switching to the monitor when using
3231monitor and serial sharing. The default is @code{0x01} when using the
3232@code{-nographic} option. @code{0x01} is equal to pressing
3233@code{Control-a}. You can select a different character from the ascii
3234control keys where 1 through 26 map to Control-a through Control-z. For
3235instance you could use the either of the following to change the escape
3236character to Control-t.
3237@table @code
3238@item -echr 0x14
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02003239@itemx -echr 20
blueswir15824d652009-03-28 06:44:27 +00003240@end table
3241ETEXI
3242
3243DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \
3244 "-virtioconsole c\n" \
Blue Swirlad960902010-03-29 19:23:52 +00003245 " set virtio console\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003246STEXI
3247@item -virtioconsole @var{c}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003248@findex -virtioconsole
blueswir15824d652009-03-28 06:44:27 +00003249Set virtio console.
Amit Shah98b19252010-01-20 00:36:52 +05303250
3251This option is maintained for backward compatibility.
3252
3253Please use @code{-device virtconsole} for the new way of invocation.
blueswir15824d652009-03-28 06:44:27 +00003254ETEXI
3255
3256DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \
Blue Swirlad960902010-03-29 19:23:52 +00003257 "-show-cursor show cursor\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003258STEXI
Stefan Weil95d5f082010-01-20 22:25:27 +01003259@item -show-cursor
Stefan Weil6616b2a2010-02-05 23:52:05 +01003260@findex -show-cursor
Stefan Weil95d5f082010-01-20 22:25:27 +01003261Show cursor.
blueswir15824d652009-03-28 06:44:27 +00003262ETEXI
3263
3264DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \
Blue Swirlad960902010-03-29 19:23:52 +00003265 "-tb-size n set TB size\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003266STEXI
Stefan Weil95d5f082010-01-20 22:25:27 +01003267@item -tb-size @var{n}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003268@findex -tb-size
Stefan Weil95d5f082010-01-20 22:25:27 +01003269Set TB size.
blueswir15824d652009-03-28 06:44:27 +00003270ETEXI
3271
3272DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \
Michael Tokarev7c601802015-02-10 22:40:47 +03003273 "-incoming tcp:[host]:port[,to=maxport][,ipv4][,ipv6]\n" \
3274 "-incoming rdma:host:port[,ipv4][,ipv6]\n" \
3275 "-incoming unix:socketpath\n" \
3276 " prepare for incoming migration, listen on\n" \
3277 " specified protocol and socket address\n" \
3278 "-incoming fd:fd\n" \
3279 "-incoming exec:cmdline\n" \
3280 " accept incoming migration on given file descriptor\n" \
Dr. David Alan Gilbert15970512015-05-29 19:52:52 +01003281 " or from given external command\n" \
3282 "-incoming defer\n" \
3283 " wait for the URI to be specified via migrate_incoming\n",
Blue Swirlad960902010-03-29 19:23:52 +00003284 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003285STEXI
Michael Tokarev7c601802015-02-10 22:40:47 +03003286@item -incoming tcp:[@var{host}]:@var{port}[,to=@var{maxport}][,ipv4][,ipv6]
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02003287@itemx -incoming rdma:@var{host}:@var{port}[,ipv4][,ipv6]
Stefan Weil6616b2a2010-02-05 23:52:05 +01003288@findex -incoming
Michael Tokarev7c601802015-02-10 22:40:47 +03003289Prepare for incoming migration, listen on a given tcp port.
3290
3291@item -incoming unix:@var{socketpath}
3292Prepare for incoming migration, listen on a given unix socket.
3293
3294@item -incoming fd:@var{fd}
3295Accept incoming migration from a given filedescriptor.
3296
3297@item -incoming exec:@var{cmdline}
3298Accept incoming migration as an output from specified external command.
Dr. David Alan Gilbert15970512015-05-29 19:52:52 +01003299
3300@item -incoming defer
3301Wait for the URI to be specified via migrate_incoming. The monitor can
3302be used to change settings (such as migration parameters) prior to issuing
3303the migrate_incoming to allow the migration to begin.
blueswir15824d652009-03-28 06:44:27 +00003304ETEXI
3305
Gerd Hoffmannd8c208d2009-12-08 13:11:46 +01003306DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \
Blue Swirlad960902010-03-29 19:23:52 +00003307 "-nodefaults don't create default devices\n", QEMU_ARCH_ALL)
Gerd Hoffmannd8c208d2009-12-08 13:11:46 +01003308STEXI
Stefan Weil3dbf2c72010-01-16 18:19:44 +01003309@item -nodefaults
Stefan Weil6616b2a2010-02-05 23:52:05 +01003310@findex -nodefaults
Michal Novotny66c19bf2012-07-16 14:35:10 +02003311Don't create default devices. Normally, QEMU sets the default devices like serial
3312port, parallel port, virtual console, monitor device, VGA adapter, floppy and
3313CD-ROM drive and others. The @code{-nodefaults} option will disable all those
3314default devices.
Gerd Hoffmannd8c208d2009-12-08 13:11:46 +01003315ETEXI
3316
blueswir15824d652009-03-28 06:44:27 +00003317#ifndef _WIN32
3318DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \
Blue Swirlad960902010-03-29 19:23:52 +00003319 "-chroot dir chroot to dir just before starting the VM\n",
3320 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003321#endif
3322STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +02003323@item -chroot @var{dir}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003324@findex -chroot
blueswir15824d652009-03-28 06:44:27 +00003325Immediately before starting guest execution, chroot to the specified
3326directory. Especially useful in combination with -runas.
3327ETEXI
3328
3329#ifndef _WIN32
3330DEF("runas", HAS_ARG, QEMU_OPTION_runas, \
Blue Swirlad960902010-03-29 19:23:52 +00003331 "-runas user change to user id user just before starting the VM\n",
3332 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003333#endif
3334STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +02003335@item -runas @var{user}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003336@findex -runas
blueswir15824d652009-03-28 06:44:27 +00003337Immediately before starting guest execution, drop root privileges, switching
3338to the specified user.
3339ETEXI
3340
blueswir15824d652009-03-28 06:44:27 +00003341DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env,
3342 "-prom-env variable=value\n"
Blue Swirlad960902010-03-29 19:23:52 +00003343 " set OpenBIOS nvram variables\n",
3344 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
Stefan Weil95d5f082010-01-20 22:25:27 +01003345STEXI
3346@item -prom-env @var{variable}=@var{value}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003347@findex -prom-env
Stefan Weil95d5f082010-01-20 22:25:27 +01003348Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only).
3349ETEXI
blueswir15824d652009-03-28 06:44:27 +00003350DEF("semihosting", 0, QEMU_OPTION_semihosting,
Michael Wallef7bbcfb2014-04-22 20:18:42 +02003351 "-semihosting semihosting mode\n",
Leon Alrae3b3c1692015-06-19 11:08:43 +01003352 QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32 |
3353 QEMU_ARCH_MIPS)
Stefan Weil95d5f082010-01-20 22:25:27 +01003354STEXI
3355@item -semihosting
Stefan Weil6616b2a2010-02-05 23:52:05 +01003356@findex -semihosting
Leon Alrae3b3c1692015-06-19 11:08:43 +01003357Enable semihosting mode (ARM, M68K, Xtensa, MIPS only).
Liviu Ionescua38bb072014-12-11 12:07:48 +00003358ETEXI
3359DEF("semihosting-config", HAS_ARG, QEMU_OPTION_semihosting_config,
Leon Alraea59d31a2015-06-19 14:17:45 +01003360 "-semihosting-config [enable=on|off][,target=native|gdb|auto][,arg=str[,...]]\n" \
3361 " semihosting configuration\n",
Leon Alrae3b3c1692015-06-19 11:08:43 +01003362QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32 |
3363QEMU_ARCH_MIPS)
Liviu Ionescua38bb072014-12-11 12:07:48 +00003364STEXI
Leon Alraea59d31a2015-06-19 14:17:45 +01003365@item -semihosting-config [enable=on|off][,target=native|gdb|auto][,arg=str[,...]]
Liviu Ionescua38bb072014-12-11 12:07:48 +00003366@findex -semihosting-config
Leon Alrae3b3c1692015-06-19 11:08:43 +01003367Enable and configure semihosting (ARM, M68K, Xtensa, MIPS only).
Leon Alraea59d31a2015-06-19 14:17:45 +01003368@table @option
3369@item target=@code{native|gdb|auto}
3370Defines where the semihosting calls will be addressed, to QEMU (@code{native})
3371or to GDB (@code{gdb}). The default is @code{auto}, which means @code{gdb}
3372during debug sessions and @code{native} otherwise.
3373@item arg=@var{str1},arg=@var{str2},...
3374Allows the user to pass input arguments, and can be used multiple times to build
3375up a list. The old-style @code{-kernel}/@code{-append} method of passing a
3376command line is still supported for backward compatibility. If both the
3377@code{--semihosting-config arg} and the @code{-kernel}/@code{-append} are
3378specified, the former is passed to semihosting as it always takes precedence.
3379@end table
Stefan Weil95d5f082010-01-20 22:25:27 +01003380ETEXI
blueswir15824d652009-03-28 06:44:27 +00003381DEF("old-param", 0, QEMU_OPTION_old_param,
Blue Swirlad960902010-03-29 19:23:52 +00003382 "-old-param old param mode\n", QEMU_ARCH_ARM)
Stefan Weil95d5f082010-01-20 22:25:27 +01003383STEXI
3384@item -old-param
Stefan Weil6616b2a2010-02-05 23:52:05 +01003385@findex -old-param (ARM)
Stefan Weil95d5f082010-01-20 22:25:27 +01003386Old param mode (ARM only).
3387ETEXI
3388
Eduardo Otubo7d76ad42012-08-14 18:44:08 -03003389DEF("sandbox", HAS_ARG, QEMU_OPTION_sandbox, \
3390 "-sandbox <arg> Enable seccomp mode 2 system call filter (default 'off').\n",
3391 QEMU_ARCH_ALL)
3392STEXI
Markus Armbruster6265c432013-02-13 19:49:39 +01003393@item -sandbox @var{arg}
Eduardo Otubo7d76ad42012-08-14 18:44:08 -03003394@findex -sandbox
3395Enable Seccomp mode 2 system call filter. 'on' will enable syscall filtering and 'off' will
3396disable it. The default is 'off'.
3397ETEXI
3398
Gerd Hoffmann715a6642009-10-14 10:39:28 +02003399DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig,
Blue Swirlad960902010-03-29 19:23:52 +00003400 "-readconfig <file>\n", QEMU_ARCH_ALL)
Stefan Weil3dbf2c72010-01-16 18:19:44 +01003401STEXI
3402@item -readconfig @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003403@findex -readconfig
Michal Novotnyed24cfa2012-07-16 14:28:32 +02003404Read device configuration from @var{file}. This approach is useful when you want to spawn
3405QEMU process with many command line options but you don't want to exceed the command line
3406character limit.
Stefan Weil3dbf2c72010-01-16 18:19:44 +01003407ETEXI
Gerd Hoffmann715a6642009-10-14 10:39:28 +02003408DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig,
3409 "-writeconfig <file>\n"
Blue Swirlad960902010-03-29 19:23:52 +00003410 " read/write config file\n", QEMU_ARCH_ALL)
Stefan Weil3dbf2c72010-01-16 18:19:44 +01003411STEXI
3412@item -writeconfig @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003413@findex -writeconfig
Michal Novotnyed24cfa2012-07-16 14:28:32 +02003414Write device configuration to @var{file}. The @var{file} can be either filename to save
3415command line and device configuration into file or dash @code{-}) character to print the
3416output to stdout. This can be later used as input file for @code{-readconfig} option.
Stefan Weil3dbf2c72010-01-16 18:19:44 +01003417ETEXI
Anthony Liguori292444c2010-01-21 10:57:58 -06003418DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig,
3419 "-nodefconfig\n"
Blue Swirlad960902010-03-29 19:23:52 +00003420 " do not load default config files at startup\n",
3421 QEMU_ARCH_ALL)
Anthony Liguori292444c2010-01-21 10:57:58 -06003422STEXI
3423@item -nodefconfig
Stefan Weil6616b2a2010-02-05 23:52:05 +01003424@findex -nodefconfig
Eduardo Habkostf29a5612012-05-02 13:07:29 -03003425Normally QEMU loads configuration files from @var{sysconfdir} and @var{datadir} at startup.
3426The @code{-nodefconfig} option will prevent QEMU from loading any of those config files.
3427ETEXI
3428DEF("no-user-config", 0, QEMU_OPTION_nouserconfig,
3429 "-no-user-config\n"
3430 " do not load user-provided config files at startup\n",
3431 QEMU_ARCH_ALL)
3432STEXI
3433@item -no-user-config
3434@findex -no-user-config
3435The @code{-no-user-config} option makes QEMU not load any of the user-provided
3436config files on @var{sysconfdir}, but won't make it skip the QEMU-provided config
3437files from @var{datadir}.
Anthony Liguori292444c2010-01-21 10:57:58 -06003438ETEXI
Prerna Saxenaab6540d2010-08-09 11:48:32 +01003439DEF("trace", HAS_ARG, QEMU_OPTION_trace,
Lluís23d15e82011-08-31 20:31:31 +02003440 "-trace [events=<file>][,file=<file>]\n"
3441 " specify tracing options\n",
Prerna Saxenaab6540d2010-08-09 11:48:32 +01003442 QEMU_ARCH_ALL)
3443STEXI
Lluís23d15e82011-08-31 20:31:31 +02003444HXCOMM This line is not accurate, as some sub-options are backend-specific but
3445HXCOMM HX does not support conditional compilation of text.
3446@item -trace [events=@var{file}][,file=@var{file}]
Prerna Saxenaab6540d2010-08-09 11:48:32 +01003447@findex -trace
Lluíse4858972011-08-31 20:31:03 +02003448
Lluís23d15e82011-08-31 20:31:31 +02003449Specify tracing options.
3450
3451@table @option
3452@item events=@var{file}
3453Immediately enable events listed in @var{file}.
3454The file must contain one event name (as listed in the @var{trace-events} file)
3455per line.
Stefan Weilc1ba4e02011-09-05 18:13:03 +02003456This option is only available if QEMU has been compiled with
3457either @var{simple} or @var{stderr} tracing backend.
Lluís23d15e82011-08-31 20:31:31 +02003458@item file=@var{file}
3459Log output traces to @var{file}.
3460
Stefan Weilc1ba4e02011-09-05 18:13:03 +02003461This option is only available if QEMU has been compiled with
3462the @var{simple} tracing backend.
Lluís23d15e82011-08-31 20:31:31 +02003463@end table
Prerna Saxenaab6540d2010-08-09 11:48:32 +01003464ETEXI
Stefan Weil3dbf2c72010-01-16 18:19:44 +01003465
Markus Armbruster31e70d62013-02-13 19:49:37 +01003466HXCOMM Internal use
3467DEF("qtest", HAS_ARG, QEMU_OPTION_qtest, "", QEMU_ARCH_ALL)
3468DEF("qtest-log", HAS_ARG, QEMU_OPTION_qtest_log, "", QEMU_ARCH_ALL)
Anthony Liguoric7f0f3b2012-03-28 15:42:02 +02003469
Paul Moore0f669982012-08-03 14:39:21 -04003470#ifdef __linux__
3471DEF("enable-fips", 0, QEMU_OPTION_enablefips,
3472 "-enable-fips enable FIPS 140-2 compliance\n",
3473 QEMU_ARCH_ALL)
3474#endif
3475STEXI
3476@item -enable-fips
3477@findex -enable-fips
3478Enable FIPS 140-2 compliance mode.
3479ETEXI
3480
Jan Kiszkaa0dac022012-10-05 14:51:45 -03003481HXCOMM Deprecated by -machine accel=tcg property
Bruce Rogersc6e88b32012-11-20 07:11:21 -07003482DEF("no-kvm", 0, QEMU_OPTION_no_kvm, "", QEMU_ARCH_I386)
Jan Kiszkaa0dac022012-10-05 14:51:45 -03003483
Jan Kiszkac21fb4f2012-10-05 14:51:42 -03003484HXCOMM Deprecated by kvm-pit driver properties
Bruce Rogersc6e88b32012-11-20 07:11:21 -07003485DEF("no-kvm-pit-reinjection", 0, QEMU_OPTION_no_kvm_pit_reinjection,
Jan Kiszkac21fb4f2012-10-05 14:51:42 -03003486 "", QEMU_ARCH_I386)
3487
Jan Kiszka4086bde2012-10-05 14:51:41 -03003488HXCOMM Deprecated (ignored)
Bruce Rogersc6e88b32012-11-20 07:11:21 -07003489DEF("no-kvm-pit", 0, QEMU_OPTION_no_kvm_pit, "", QEMU_ARCH_I386)
Jan Kiszka4086bde2012-10-05 14:51:41 -03003490
Jan Kiszkae43d5942012-10-05 14:51:40 -03003491HXCOMM Deprecated by -machine kernel_irqchip=on|off property
Bruce Rogersc6e88b32012-11-20 07:11:21 -07003492DEF("no-kvm-irqchip", 0, QEMU_OPTION_no_kvm_irqchip, "", QEMU_ARCH_I386)
Jan Kiszkae43d5942012-10-05 14:51:40 -03003493
Jan Kiszka88eed342012-10-05 14:51:44 -03003494HXCOMM Deprecated (ignored)
3495DEF("tdf", 0, QEMU_OPTION_tdf,"", QEMU_ARCH_ALL)
3496
Seiji Aguchi5e2ac512013-07-03 23:02:46 -04003497DEF("msg", HAS_ARG, QEMU_OPTION_msg,
3498 "-msg timestamp[=on|off]\n"
3499 " change the format of messages\n"
3500 " on|off controls leading timestamps (default:on)\n",
3501 QEMU_ARCH_ALL)
3502STEXI
3503@item -msg timestamp[=on|off]
3504@findex -msg
3505prepend a timestamp to each log message.(default:on)
3506ETEXI
3507
Amit Shahabfd9ce2014-06-20 18:56:08 +05303508DEF("dump-vmstate", HAS_ARG, QEMU_OPTION_dump_vmstate,
3509 "-dump-vmstate <file>\n"
3510 " Output vmstate information in JSON format to file.\n"
3511 " Use the scripts/vmstate-static-checker.py file to\n"
3512 " check for possible regressions in migration code\n"
3513 " by comparing two such vmstate dumps.",
3514 QEMU_ARCH_ALL)
3515STEXI
3516@item -dump-vmstate @var{file}
3517@findex -dump-vmstate
3518Dump json-encoded vmstate information for current machine type to file
3519in @var{file}
3520ETEXI
3521
Daniel P. Berrangeb9174d42015-05-13 17:14:03 +01003522DEFHEADING(Generic object creation)
3523
3524DEF("object", HAS_ARG, QEMU_OPTION_object,
3525 "-object TYPENAME[,PROP1=VALUE1,...]\n"
3526 " create a new object of type TYPENAME setting properties\n"
3527 " in the order they are specified. Note that the 'id'\n"
3528 " property must be set. These objects are placed in the\n"
3529 " '/objects' path.\n",
3530 QEMU_ARCH_ALL)
3531STEXI
3532@item -object @var{typename}[,@var{prop1}=@var{value1},...]
3533@findex -object
3534Create a new object of type @var{typename} setting properties
3535in the order they are specified. Note that the 'id'
3536property must be set. These objects are placed in the
3537'/objects' path.
3538
3539@table @option
3540
3541@item -object memory-backend-file,id=@var{id},size=@var{size},mem-path=@var{dir},share=@var{on|off}
3542
3543Creates a memory file backend object, which can be used to back
3544the guest RAM with huge pages. The @option{id} parameter is a
3545unique ID that will be used to reference this memory region
3546when configuring the @option{-numa} argument. The @option{size}
3547option provides the size of the memory region, and accepts
3548common suffixes, eg @option{500M}. The @option{mem-path} provides
3549the path to either a shared memory or huge page filesystem mount.
3550The @option{share} boolean option determines whether the memory
3551region is marked as private to QEMU, or shared. The latter allows
3552a co-operating external process to access the QEMU memory region.
3553
3554@item -object rng-random,id=@var{id},filename=@var{/dev/random}
3555
3556Creates a random number generator backend which obtains entropy from
3557a device on the host. The @option{id} parameter is a unique ID that
3558will be used to reference this entropy backend from the @option{virtio-rng}
3559device. The @option{filename} parameter specifies which file to obtain
3560entropy from and if omitted defaults to @option{/dev/random}.
3561
3562@item -object rng-egd,id=@var{id},chardev=@var{chardevid}
3563
3564Creates a random number generator backend which obtains entropy from
3565an external daemon running on the host. The @option{id} parameter is
3566a unique ID that will be used to reference this entropy backend from
3567the @option{virtio-rng} device. The @option{chardev} parameter is
3568the unique ID of a character device backend that provides the connection
3569to the RNG daemon.
3570
3571@end table
3572
3573ETEXI
3574
3575
Stefan Weil3dbf2c72010-01-16 18:19:44 +01003576HXCOMM This is the last statement. Insert new options before this line!
3577STEXI
3578@end table
3579ETEXI