]>
Commit | Line | Data |
---|---|---|
5824d651 BS |
1 | HXCOMM Use DEFHEADING() to define headings in both help text and texi |
2 | HXCOMM Text between STEXI and ETEXI are copied to texi version and | |
3 | HXCOMM discarded from C version | |
ad96090a BS |
4 | HXCOMM DEF(option, HAS_ARG/0, opt_enum, opt_help, arch_mask) is used to |
5 | HXCOMM construct option structures, enums and help message for specified | |
6 | HXCOMM architectures. | |
5824d651 BS |
7 | HXCOMM HXCOMM can be used for comments, discarded from both texi and C |
8 | ||
9 | DEFHEADING(Standard options:) | |
10 | STEXI | |
11 | @table @option | |
12 | ETEXI | |
13 | ||
14 | DEF("help", 0, QEMU_OPTION_h, | |
ad96090a | 15 | "-h or -help display this help and exit\n", QEMU_ARCH_ALL) |
5824d651 BS |
16 | STEXI |
17 | @item -h | |
6616b2ad | 18 | @findex -h |
5824d651 BS |
19 | Display help and exit |
20 | ETEXI | |
21 | ||
9bd7e6d9 | 22 | DEF("version", 0, QEMU_OPTION_version, |
ad96090a | 23 | "-version display version information and exit\n", QEMU_ARCH_ALL) |
9bd7e6d9 PB |
24 | STEXI |
25 | @item -version | |
6616b2ad | 26 | @findex -version |
9bd7e6d9 PB |
27 | Display version information and exit |
28 | ETEXI | |
29 | ||
80f52a66 JK |
30 | DEF("machine", HAS_ARG, QEMU_OPTION_machine, \ |
31 | "-machine [type=]name[,prop[=value][,...]]\n" | |
585f6036 | 32 | " selects emulated machine ('-machine help' for list)\n" |
80f52a66 | 33 | " property accel=accel1[:accel2[:...]] selects accelerator\n" |
6a48ffaa | 34 | " supported accelerators are kvm, xen, tcg (default: tcg)\n" |
39d6960a | 35 | " kernel_irqchip=on|off controls accelerated irqchip support\n" |
d1048bef | 36 | " vmport=on|off|auto controls emulation of vmport (default: auto)\n" |
ddb97f1d | 37 | " kvm_shadow_mem=size of KVM shadow MMU\n" |
8490fc78 | 38 | " dump-guest-core=on|off include guest memory in a core dump (default=on)\n" |
a52a7fdf | 39 | " mem-merge=on|off controls memory merge support (default: on)\n" |
2eb1cd07 TK |
40 | " 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" | |
9850c604 AG |
42 | " 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", | |
80f52a66 | 44 | QEMU_ARCH_ALL) |
5824d651 | 45 | STEXI |
80f52a66 JK |
46 | @item -machine [type=]@var{name}[,prop=@var{value}[,...]] |
47 | @findex -machine | |
585f6036 | 48 | Select the emulated machine by @var{name}. Use @code{-machine help} to list |
80f52a66 JK |
49 | available machines. Supported machine properties are: |
50 | @table @option | |
51 | @item accel=@var{accels1}[:@var{accels2}[:...]] | |
52 | This is used to enable an accelerator. Depending on the target architecture, | |
53 | kvm, xen, or tcg can be available. By default, tcg is used. If there is more | |
54 | than one accelerator specified, the next one is used if the previous one fails | |
55 | to initialize. | |
6a48ffaa JK |
56 | @item kernel_irqchip=on|off |
57 | Enables in-kernel irqchip support for the chosen accelerator when available. | |
d1048bef DS |
58 | @item vmport=on|off|auto |
59 | Enables emulation of VMWare IO port, for vmmouse etc. auto says to select the | |
60 | value based on accel. For accel=xen the default is off otherwise the default | |
61 | is on. | |
39d6960a JK |
62 | @item kvm_shadow_mem=size |
63 | Defines the size of the KVM shadow MMU. | |
ddb97f1d JB |
64 | @item dump-guest-core=on|off |
65 | Include guest memory in a core dump. The default is on. | |
8490fc78 LC |
66 | @item mem-merge=on|off |
67 | Enables or disables memory merge support. This feature, when supported by | |
68 | the host, de-duplicates identical memory pages among VMs instances | |
69 | (enabled by default). | |
a52a7fdf LT |
70 | @item iommu=on|off |
71 | Enables or disables emulated Intel IOMMU (VT-d) support. The default is off. | |
2eb1cd07 TK |
72 | @item aes-key-wrap=on|off |
73 | Enables or disables AES key wrapping support on s390-ccw hosts. This feature | |
74 | controls whether AES wrapping keys will be created to allow | |
75 | execution of AES cryptographic functions. The default is on. | |
76 | @item dea-key-wrap=on|off | |
77 | Enables or disables DEA key wrapping support on s390-ccw hosts. This feature | |
78 | controls whether DEA wrapping keys will be created to allow | |
79 | execution of DEA cryptographic functions. The default is on. | |
80f52a66 | 80 | @end table |
5824d651 BS |
81 | ETEXI |
82 | ||
80f52a66 JK |
83 | HXCOMM Deprecated by -machine |
84 | DEF("M", HAS_ARG, QEMU_OPTION_M, "", QEMU_ARCH_ALL) | |
85 | ||
5824d651 | 86 | DEF("cpu", HAS_ARG, QEMU_OPTION_cpu, |
585f6036 | 87 | "-cpu cpu select CPU ('-cpu help' for list)\n", QEMU_ARCH_ALL) |
5824d651 BS |
88 | STEXI |
89 | @item -cpu @var{model} | |
6616b2ad | 90 | @findex -cpu |
585f6036 | 91 | Select CPU model (@code{-cpu help} for list and additional feature selection) |
5824d651 BS |
92 | ETEXI |
93 | ||
94 | DEF("smp", HAS_ARG, QEMU_OPTION_smp, | |
12b7f57e | 95 | "-smp [cpus=]n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n" |
6be68d7e JS |
96 | " set the number of CPUs to 'n' [default=1]\n" |
97 | " maxcpus= maximum number of total cpus, including\n" | |
ca1a8a06 | 98 | " offline CPUs for hotplug, etc\n" |
58a04db1 AP |
99 | " cores= number of CPU cores on one socket\n" |
100 | " threads= number of threads on one CPU core\n" | |
ad96090a BS |
101 | " sockets= number of discrete sockets in the system\n", |
102 | QEMU_ARCH_ALL) | |
5824d651 | 103 | STEXI |
12b7f57e | 104 | @item -smp [cpus=]@var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}] |
6616b2ad | 105 | @findex -smp |
5824d651 BS |
106 | Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255 |
107 | CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs | |
108 | to 4. | |
58a04db1 AP |
109 | For the PC target, the number of @var{cores} per socket, the number |
110 | of @var{threads} per cores and the total number of @var{sockets} can be | |
111 | specified. Missing values will be computed. If any on the three values is | |
112 | given, the total number of CPUs @var{n} can be omitted. @var{maxcpus} | |
113 | specifies the maximum number of hotpluggable CPUs. | |
5824d651 BS |
114 | ETEXI |
115 | ||
268a362c | 116 | DEF("numa", HAS_ARG, QEMU_OPTION_numa, |
7febe36f PB |
117 | "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n" |
118 | "-numa node[,memdev=id][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL) | |
268a362c | 119 | STEXI |
4932b897 | 120 | @item -numa node[,mem=@var{size}][,cpus=@var{cpu[-cpu]}][,nodeid=@var{node}] |
7febe36f | 121 | @item -numa node[,memdev=@var{id}][,cpus=@var{cpu[-cpu]}][,nodeid=@var{node}] |
6616b2ad | 122 | @findex -numa |
7febe36f | 123 | Simulate a multi node NUMA system. If @samp{mem}, @samp{memdev} |
4932b897 LC |
124 | and @samp{cpus} are omitted, resources are split equally. Also, note |
125 | that the -@option{numa} option doesn't allocate any of the specified | |
126 | resources. That is, it just assigns existing resources to NUMA nodes. This | |
127 | means that one still has to use the @option{-m}, @option{-smp} options | |
7febe36f PB |
128 | to allocate RAM and VCPUs respectively, and possibly @option{-object} |
129 | to specify the memory backend for the @samp{memdev} suboption. | |
130 | ||
131 | @samp{mem} and @samp{memdev} are mutually exclusive. Furthermore, if one | |
132 | node uses @samp{memdev}, all of them have to use it. | |
268a362c AL |
133 | ETEXI |
134 | ||
587ed6be CB |
135 | DEF("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) | |
138 | STEXI | |
139 | @item -add-fd fd=@var{fd},set=@var{set}[,opaque=@var{opaque}] | |
140 | @findex -add-fd | |
141 | ||
142 | Add a file descriptor to an fd set. Valid options are: | |
143 | ||
144 | @table @option | |
145 | @item fd=@var{fd} | |
146 | This option defines the file descriptor of which a duplicate is added to fd set. | |
147 | The file descriptor cannot be stdin, stdout, or stderr. | |
148 | @item set=@var{set} | |
149 | This option defines the ID of the fd set to add the file descriptor to. | |
150 | @item opaque=@var{opaque} | |
151 | This option defines a free-form string that can be used to describe @var{fd}. | |
152 | @end table | |
153 | ||
154 | You can open an image using pre-opened file descriptors from an fd set: | |
155 | @example | |
156 | qemu-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 | |
161 | ETEXI | |
162 | ||
6616b2ad SW |
163 | DEF("set", HAS_ARG, QEMU_OPTION_set, |
164 | "-set group.id.arg=value\n" | |
165 | " set <arg> parameter for item <id> of type <group>\n" | |
ad96090a | 166 | " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL) |
6616b2ad | 167 | STEXI |
6265c43b | 168 | @item -set @var{group}.@var{id}.@var{arg}=@var{value} |
6616b2ad | 169 | @findex -set |
6265c43b | 170 | Set parameter @var{arg} for item @var{id} of type @var{group}\n" |
6616b2ad SW |
171 | ETEXI |
172 | ||
173 | DEF("global", HAS_ARG, QEMU_OPTION_global, | |
3751d7c4 PB |
174 | "-global driver.property=value\n" |
175 | "-global driver=driver,property=property,value=value\n" | |
ad96090a BS |
176 | " set a global default for a driver property\n", |
177 | QEMU_ARCH_ALL) | |
6616b2ad | 178 | STEXI |
3017b72c | 179 | @item -global @var{driver}.@var{prop}=@var{value} |
3751d7c4 | 180 | @itemx -global driver=@var{driver},property=@var{property},value=@var{value} |
6616b2ad | 181 | @findex -global |
3017b72c MR |
182 | Set default value of @var{driver}'s property @var{prop} to @var{value}, e.g.: |
183 | ||
184 | @example | |
3804da9d | 185 | qemu-system-i386 -global ide-drive.physical_block_size=4096 -drive file=file,if=ide,index=0,media=disk |
3017b72c MR |
186 | @end example |
187 | ||
188 | In particular, you can use this to set driver properties for devices which are | |
189 | created automatically by the machine model. To create a device which is not | |
190 | created automatically and set properties on it, use -@option{device}. | |
3751d7c4 PB |
191 | |
192 | The two syntaxes are equivalent. The longer one works for drivers whose name | |
193 | contains a dot. | |
6616b2ad SW |
194 | ETEXI |
195 | ||
5824d651 | 196 | DEF("boot", HAS_ARG, QEMU_OPTION_boot, |
2221dde5 | 197 | "-boot [order=drives][,once=drives][,menu=on|off]\n" |
c8a6ae8b | 198 | " [,splash=sp_name][,splash-time=sp_time][,reboot-timeout=rb_time][,strict=on|off]\n" |
3d3b8303 WX |
199 | " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n" |
200 | " 'sp_name': the file's name that would be passed to bios as logo picture, if menu=on\n" | |
ac05f349 AK |
201 | " 'sp_time': the period that splash picture last if menu=on, unit is ms\n" |
202 | " 'rb_timeout': the timeout before guest reboot when boot failed, unit is ms\n", | |
ad96090a | 203 | QEMU_ARCH_ALL) |
5824d651 | 204 | STEXI |
c8a6ae8b | 205 | @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] |
6616b2ad | 206 | @findex -boot |
2221dde5 JK |
207 | Specify boot order @var{drives} as a string of drive letters. Valid |
208 | drive letters depend on the target achitecture. The x86 PC uses: a, b | |
209 | (floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot | |
210 | from network adapter 1-4), hard disk boot is the default. To apply a | |
211 | particular boot order only on the first startup, specify it via | |
212 | @option{once}. | |
213 | ||
214 | Interactive boot menus/prompts can be enabled via @option{menu=on} as far | |
215 | as firmware/BIOS supports them. The default is non-interactive boot. | |
216 | ||
3d3b8303 WX |
217 | A splash picture could be passed to bios, enabling user to show it as logo, |
218 | when option splash=@var{sp_name} is given and menu=on, If firmware/BIOS | |
219 | supports them. Currently Seabios for X86 system support it. | |
220 | limitation: The splash file could be a jpeg file or a BMP file in 24 BPP | |
221 | format(true color). The resolution should be supported by the SVGA mode, so | |
222 | the recommended is 320x240, 640x480, 800x640. | |
223 | ||
ac05f349 AK |
224 | A timeout could be passed to bios, guest will pause for @var{rb_timeout} ms |
225 | when boot failed, then reboot. If @var{rb_timeout} is '-1', guest will not | |
226 | reboot, qemu passes '-1' to bios by default. Currently Seabios for X86 | |
227 | system support it. | |
228 | ||
c8a6ae8b AK |
229 | Do strict boot via @option{strict=on} as far as firmware/BIOS |
230 | supports it. This only effects when boot priority is changed by | |
231 | bootindex options. The default is non-strict boot. | |
232 | ||
2221dde5 JK |
233 | @example |
234 | # try to boot from network first, then from hard disk | |
3804da9d | 235 | qemu-system-i386 -boot order=nc |
2221dde5 | 236 | # boot from CD-ROM first, switch back to default order after reboot |
3804da9d | 237 | qemu-system-i386 -boot once=d |
3d3b8303 | 238 | # boot with a splash picture for 5 seconds. |
3804da9d | 239 | qemu-system-i386 -boot menu=on,splash=/root/boot.bmp,splash-time=5000 |
2221dde5 JK |
240 | @end example |
241 | ||
242 | Note: The legacy format '-boot @var{drives}' is still supported but its | |
243 | use is discouraged as it may be removed from future versions. | |
5824d651 BS |
244 | ETEXI |
245 | ||
5824d651 | 246 | DEF("m", HAS_ARG, QEMU_OPTION_m, |
c270fb9e | 247 | "-m[emory] [size=]megs[,slots=n,maxmem=size]\n" |
6e1d3c1c | 248 | " configure guest RAM\n" |
0daba1f0 | 249 | " size: initial amount of guest memory\n" |
c270fb9e | 250 | " slots: number of hotplug slots (default: none)\n" |
b6fe0124 MR |
251 | " maxmem: maximum amount of guest memory (default: none)\n" |
252 | "NOTE: Some architectures might enforce a specific granularity\n", | |
6e1d3c1c | 253 | QEMU_ARCH_ALL) |
5824d651 | 254 | STEXI |
9fcc0794 | 255 | @item -m [size=]@var{megs}[,slots=n,maxmem=size] |
6616b2ad | 256 | @findex -m |
9fcc0794 LC |
257 | Sets guest startup RAM size to @var{megs} megabytes. Default is 128 MiB. |
258 | Optionally, a suffix of ``M'' or ``G'' can be used to signify a value in | |
259 | megabytes or gigabytes respectively. Optional pair @var{slots}, @var{maxmem} | |
260 | could be used to set amount of hotpluggable memory slots and maximum amount of | |
261 | memory. Note that @var{maxmem} must be aligned to the page size. | |
262 | ||
263 | For example, the following command-line sets the guest startup RAM size to | |
264 | 1GB, creates 3 slots to hotplug additional memory and sets the maximum | |
265 | memory the guest can reach to 4GB: | |
266 | ||
267 | @example | |
268 | qemu-system-x86_64 -m 1G,slots=3,maxmem=4G | |
269 | @end example | |
270 | ||
271 | If @var{slots} and @var{maxmem} are not specified, memory hotplug won't | |
272 | be enabled and the guest startup RAM will never increase. | |
5824d651 BS |
273 | ETEXI |
274 | ||
c902760f | 275 | DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath, |
ad96090a | 276 | "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL) |
c902760f MT |
277 | STEXI |
278 | @item -mem-path @var{path} | |
b8f490eb | 279 | @findex -mem-path |
c902760f MT |
280 | Allocate guest RAM from a temporarily created file in @var{path}. |
281 | ETEXI | |
282 | ||
c902760f | 283 | DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc, |
ad96090a BS |
284 | "-mem-prealloc preallocate guest memory (use with -mem-path)\n", |
285 | QEMU_ARCH_ALL) | |
c902760f MT |
286 | STEXI |
287 | @item -mem-prealloc | |
b8f490eb | 288 | @findex -mem-prealloc |
c902760f MT |
289 | Preallocate memory when using -mem-path. |
290 | ETEXI | |
c902760f | 291 | |
5824d651 | 292 | DEF("k", HAS_ARG, QEMU_OPTION_k, |
ad96090a BS |
293 | "-k language use keyboard layout (for example 'fr' for French)\n", |
294 | QEMU_ARCH_ALL) | |
5824d651 BS |
295 | STEXI |
296 | @item -k @var{language} | |
6616b2ad | 297 | @findex -k |
5824d651 BS |
298 | Use keyboard layout @var{language} (for example @code{fr} for |
299 | French). This option is only needed where it is not easy to get raw PC | |
300 | keycodes (e.g. on Macs, with some X11 servers or with a VNC | |
301 | display). You don't normally need to use it on PC/Linux or PC/Windows | |
302 | hosts. | |
303 | ||
304 | The available layouts are: | |
305 | @example | |
306 | ar de-ch es fo fr-ca hu ja mk no pt-br sv | |
307 | da en-gb et fr fr-ch is lt nl pl ru th | |
308 | de en-us fi fr-be hr it lv nl-be pt sl tr | |
309 | @end example | |
310 | ||
311 | The default is @code{en-us}. | |
312 | ETEXI | |
313 | ||
314 | ||
5824d651 | 315 | DEF("audio-help", 0, QEMU_OPTION_audio_help, |
ad96090a BS |
316 | "-audio-help print list of audio drivers and their options\n", |
317 | QEMU_ARCH_ALL) | |
5824d651 BS |
318 | STEXI |
319 | @item -audio-help | |
6616b2ad | 320 | @findex -audio-help |
5824d651 BS |
321 | Will show the audio subsystem help: list of drivers, tunable |
322 | parameters. | |
323 | ETEXI | |
324 | ||
5824d651 BS |
325 | DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw, |
326 | "-soundhw c1,... enable audio support\n" | |
327 | " and only specified sound cards (comma separated list)\n" | |
585f6036 PM |
328 | " use '-soundhw help' to get the list of supported cards\n" |
329 | " use '-soundhw all' to enable all of them\n", QEMU_ARCH_ALL) | |
5824d651 BS |
330 | STEXI |
331 | @item -soundhw @var{card1}[,@var{card2},...] or -soundhw all | |
6616b2ad | 332 | @findex -soundhw |
585f6036 | 333 | Enable audio and selected sound hardware. Use 'help' to print all |
5824d651 BS |
334 | available sound hardware. |
335 | ||
336 | @example | |
10adb8be MA |
337 | qemu-system-i386 -soundhw sb16,adlib disk.img |
338 | qemu-system-i386 -soundhw es1370 disk.img | |
339 | qemu-system-i386 -soundhw ac97 disk.img | |
340 | qemu-system-i386 -soundhw hda disk.img | |
341 | qemu-system-i386 -soundhw all disk.img | |
342 | qemu-system-i386 -soundhw help | |
343 | @end example | |
344 | ||
345 | Note that Linux's i810_audio OSS kernel (for AC97) module might | |
346 | require manually specifying clocking. | |
347 | ||
348 | @example | |
349 | modprobe i810_audio clocking=48000 | |
350 | @end example | |
351 | ETEXI | |
352 | ||
353 | DEF("balloon", HAS_ARG, QEMU_OPTION_balloon, | |
354 | "-balloon none disable balloon device\n" | |
355 | "-balloon virtio[,addr=str]\n" | |
356 | " enable virtio balloon device (default)\n", QEMU_ARCH_ALL) | |
357 | STEXI | |
358 | @item -balloon none | |
359 | @findex -balloon | |
360 | Disable balloon device. | |
361 | @item -balloon virtio[,addr=@var{addr}] | |
362 | Enable virtio balloon device (default), optionally with PCI address | |
363 | @var{addr}. | |
364 | ETEXI | |
365 | ||
366 | DEF("device", HAS_ARG, QEMU_OPTION_device, | |
367 | "-device driver[,prop[=value][,...]]\n" | |
368 | " add device (based on driver)\n" | |
369 | " prop=value,... sets driver properties\n" | |
370 | " use '-device help' to print all possible drivers\n" | |
371 | " use '-device driver,help' to print all possible properties\n", | |
372 | QEMU_ARCH_ALL) | |
373 | STEXI | |
374 | @item -device @var{driver}[,@var{prop}[=@var{value}][,...]] | |
375 | @findex -device | |
376 | Add device @var{driver}. @var{prop}=@var{value} sets driver | |
377 | properties. Valid properties depend on the driver. To get help on | |
378 | possible drivers and properties, use @code{-device help} and | |
379 | @code{-device @var{driver},help}. | |
380 | ETEXI | |
381 | ||
382 | DEF("name", HAS_ARG, QEMU_OPTION_name, | |
8f480de0 | 383 | "-name string1[,process=string2][,debug-threads=on|off]\n" |
10adb8be | 384 | " set the name of the guest\n" |
8f480de0 DDAG |
385 | " string1 sets the window title and string2 the process name (on Linux)\n" |
386 | " When debug-threads is enabled, individual threads are given a separate name (on Linux)\n" | |
387 | " NOTE: The thread names are for debugging and not a stable API.\n", | |
10adb8be MA |
388 | QEMU_ARCH_ALL) |
389 | STEXI | |
390 | @item -name @var{name} | |
391 | @findex -name | |
392 | Sets the @var{name} of the guest. | |
393 | This name will be displayed in the SDL window caption. | |
394 | The @var{name} will also be used for the VNC server. | |
395 | Also optionally set the top visible process name in Linux. | |
8f480de0 | 396 | Naming of individual threads can also be enabled on Linux to aid debugging. |
10adb8be MA |
397 | ETEXI |
398 | ||
399 | DEF("uuid", HAS_ARG, QEMU_OPTION_uuid, | |
400 | "-uuid %08x-%04x-%04x-%04x-%012x\n" | |
401 | " specify machine UUID\n", QEMU_ARCH_ALL) | |
402 | STEXI | |
403 | @item -uuid @var{uuid} | |
404 | @findex -uuid | |
405 | Set system UUID. | |
406 | ETEXI | |
407 | ||
408 | STEXI | |
409 | @end table | |
410 | ETEXI | |
411 | DEFHEADING() | |
412 | ||
413 | DEFHEADING(Block device options:) | |
414 | STEXI | |
415 | @table @option | |
416 | ETEXI | |
417 | ||
418 | DEF("fda", HAS_ARG, QEMU_OPTION_fda, | |
419 | "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL) | |
420 | DEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL) | |
421 | STEXI | |
422 | @item -fda @var{file} | |
423 | @item -fdb @var{file} | |
424 | @findex -fda | |
425 | @findex -fdb | |
92a539d2 | 426 | Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). |
10adb8be MA |
427 | ETEXI |
428 | ||
429 | DEF("hda", HAS_ARG, QEMU_OPTION_hda, | |
430 | "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL) | |
431 | DEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL) | |
432 | DEF("hdc", HAS_ARG, QEMU_OPTION_hdc, | |
433 | "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL) | |
434 | DEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL) | |
435 | STEXI | |
436 | @item -hda @var{file} | |
437 | @item -hdb @var{file} | |
438 | @item -hdc @var{file} | |
439 | @item -hdd @var{file} | |
440 | @findex -hda | |
441 | @findex -hdb | |
442 | @findex -hdc | |
443 | @findex -hdd | |
444 | Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}). | |
445 | ETEXI | |
446 | ||
447 | DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom, | |
448 | "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n", | |
449 | QEMU_ARCH_ALL) | |
450 | STEXI | |
451 | @item -cdrom @var{file} | |
452 | @findex -cdrom | |
453 | Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and | |
454 | @option{-cdrom} at the same time). You can use the host CD-ROM by | |
455 | using @file{/dev/cdrom} as filename (@pxref{host_drives}). | |
456 | ETEXI | |
457 | ||
458 | DEF("drive", HAS_ARG, QEMU_OPTION_drive, | |
459 | "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n" | |
460 | " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n" | |
461 | " [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n" | |
d1db760d SH |
462 | " [,serial=s][,addr=A][,rerror=ignore|stop|report]\n" |
463 | " [,werror=ignore|stop|report|enospc][,id=name][,aio=threads|native]\n" | |
10adb8be | 464 | " [,readonly=on|off][,copy-on-read=on|off]\n" |
2f7133b2 | 465 | " [,discard=ignore|unmap][,detect-zeroes=on|off|unmap]\n" |
3e9fab69 BC |
466 | " [[,bps=b]|[[,bps_rd=r][,bps_wr=w]]]\n" |
467 | " [[,iops=i]|[[,iops_rd=r][,iops_wr=w]]]\n" | |
468 | " [[,bps_max=bm]|[[,bps_rd_max=rm][,bps_wr_max=wm]]]\n" | |
469 | " [[,iops_max=im]|[[,iops_rd_max=irm][,iops_wr_max=iwm]]]\n" | |
2024c1df | 470 | " [[,iops_size=is]]\n" |
10adb8be MA |
471 | " use 'file' as a drive image\n", QEMU_ARCH_ALL) |
472 | STEXI | |
473 | @item -drive @var{option}[,@var{option}[,@var{option}[,...]]] | |
474 | @findex -drive | |
475 | ||
476 | Define a new drive. Valid options are: | |
477 | ||
478 | @table @option | |
479 | @item file=@var{file} | |
480 | This option defines which disk image (@pxref{disk_images}) to use with | |
481 | this drive. If the filename contains comma, you must double it | |
482 | (for instance, "file=my,,file" to use file "my,file"). | |
483 | ||
484 | Special files such as iSCSI devices can be specified using protocol | |
485 | specific URLs. See the section for "Device URL Syntax" for more information. | |
486 | @item if=@var{interface} | |
487 | This option defines on which type on interface the drive is connected. | |
488 | Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio. | |
489 | @item bus=@var{bus},unit=@var{unit} | |
490 | These options define where is connected the drive by defining the bus number and | |
491 | the unit id. | |
492 | @item index=@var{index} | |
493 | This option defines where is connected the drive by using an index in the list | |
494 | of available connectors of a given interface type. | |
495 | @item media=@var{media} | |
496 | This option defines the type of the media: disk or cdrom. | |
497 | @item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}] | |
498 | These options have the same definition as they have in @option{-hdachs}. | |
499 | @item snapshot=@var{snapshot} | |
9d85d557 MT |
500 | @var{snapshot} is "on" or "off" and controls snapshot mode for the given drive |
501 | (see @option{-snapshot}). | |
10adb8be MA |
502 | @item cache=@var{cache} |
503 | @var{cache} is "none", "writeback", "unsafe", "directsync" or "writethrough" and controls how the host cache is used to access block data. | |
504 | @item aio=@var{aio} | |
505 | @var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO. | |
a9384aff PB |
506 | @item discard=@var{discard} |
507 | @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. | |
10adb8be MA |
508 | @item format=@var{format} |
509 | Specify which disk @var{format} will be used rather than detecting | |
510 | the format. Can be used to specifiy format=raw to avoid interpreting | |
511 | an untrusted format header. | |
512 | @item serial=@var{serial} | |
513 | This option specifies the serial number to assign to the device. | |
514 | @item addr=@var{addr} | |
515 | Specify the controller's PCI address (if=virtio only). | |
516 | @item werror=@var{action},rerror=@var{action} | |
517 | Specify which @var{action} to take on write and read errors. Valid actions are: | |
518 | "ignore" (ignore the error and try to continue), "stop" (pause QEMU), | |
519 | "report" (report the error to the guest), "enospc" (pause QEMU only if the | |
520 | host disk is full; report the error to the guest otherwise). | |
521 | The default setting is @option{werror=enospc} and @option{rerror=report}. | |
522 | @item readonly | |
523 | Open drive @option{file} as read-only. Guest write attempts will fail. | |
524 | @item copy-on-read=@var{copy-on-read} | |
525 | @var{copy-on-read} is "on" or "off" and enables whether to copy read backing | |
526 | file sectors into the image file. | |
465bee1d PL |
527 | @item detect-zeroes=@var{detect-zeroes} |
528 | @var{detect-zeroes} is "off", "on" or "unmap" and enables the automatic | |
529 | conversion of plain zero writes by the OS to driver specific optimized | |
530 | zero write commands. You may even choose "unmap" if @var{discard} is set | |
531 | to "unmap" to allow a zero write to be converted to an UNMAP operation. | |
10adb8be MA |
532 | @end table |
533 | ||
534 | By default, the @option{cache=writeback} mode is used. It will report data | |
535 | writes as completed as soon as the data is present in the host page cache. | |
536 | This is safe as long as your guest OS makes sure to correctly flush disk caches | |
537 | where needed. If your guest OS does not handle volatile disk write caches | |
538 | correctly and your host crashes or loses power, then the guest may experience | |
539 | data corruption. | |
540 | ||
541 | For such guests, you should consider using @option{cache=writethrough}. This | |
542 | means that the host page cache will be used to read and write data, but write | |
543 | notification will be sent to the guest only after QEMU has made sure to flush | |
544 | each write to the disk. Be aware that this has a major impact on performance. | |
545 | ||
546 | The host page cache can be avoided entirely with @option{cache=none}. This will | |
547 | attempt to do disk IO directly to the guest's memory. QEMU may still perform | |
548 | an internal copy of the data. Note that this is considered a writeback mode and | |
549 | the guest OS must handle the disk write cache correctly in order to avoid data | |
550 | corruption on host crashes. | |
551 | ||
552 | The host page cache can be avoided while only sending write notifications to | |
553 | the guest when the data has been flushed to the disk using | |
554 | @option{cache=directsync}. | |
555 | ||
556 | In case you don't care about data integrity over host failures, use | |
557 | @option{cache=unsafe}. This option tells QEMU that it never needs to write any | |
558 | data to the disk but can instead keep things in cache. If anything goes wrong, | |
559 | like your host losing power, the disk storage getting disconnected accidentally, | |
560 | etc. your image will most probably be rendered unusable. When using | |
561 | the @option{-snapshot} option, unsafe caching is always used. | |
562 | ||
563 | Copy-on-read avoids accessing the same backing file sectors repeatedly and is | |
564 | useful when the backing file is over a slow network. By default copy-on-read | |
565 | is off. | |
566 | ||
567 | Instead of @option{-cdrom} you can use: | |
568 | @example | |
569 | qemu-system-i386 -drive file=file,index=2,media=cdrom | |
570 | @end example | |
571 | ||
572 | Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can | |
573 | use: | |
574 | @example | |
575 | qemu-system-i386 -drive file=file,index=0,media=disk | |
576 | qemu-system-i386 -drive file=file,index=1,media=disk | |
577 | qemu-system-i386 -drive file=file,index=2,media=disk | |
578 | qemu-system-i386 -drive file=file,index=3,media=disk | |
579 | @end example | |
580 | ||
581 | You can open an image using pre-opened file descriptors from an fd set: | |
582 | @example | |
583 | qemu-system-i386 | |
584 | -add-fd fd=3,set=2,opaque="rdwr:/path/to/file" | |
585 | -add-fd fd=4,set=2,opaque="rdonly:/path/to/file" | |
586 | -drive file=/dev/fdset/2,index=0,media=disk | |
587 | @end example | |
588 | ||
589 | You can connect a CDROM to the slave of ide0: | |
590 | @example | |
591 | qemu-system-i386 -drive file=file,if=ide,index=1,media=cdrom | |
5824d651 BS |
592 | @end example |
593 | ||
10adb8be MA |
594 | If you don't specify the "file=" argument, you define an empty drive: |
595 | @example | |
596 | qemu-system-i386 -drive if=ide,index=1,media=cdrom | |
597 | @end example | |
5824d651 | 598 | |
10adb8be | 599 | You can connect a SCSI disk with unit ID 6 on the bus #0: |
5824d651 | 600 | @example |
10adb8be | 601 | qemu-system-i386 -drive file=file,if=scsi,bus=0,unit=6 |
5824d651 | 602 | @end example |
5824d651 | 603 | |
10adb8be MA |
604 | Instead of @option{-fda}, @option{-fdb}, you can use: |
605 | @example | |
606 | qemu-system-i386 -drive file=file,index=0,if=floppy | |
607 | qemu-system-i386 -drive file=file,index=1,if=floppy | |
608 | @end example | |
b1746ddd | 609 | |
10adb8be MA |
610 | By default, @var{interface} is "ide" and @var{index} is automatically |
611 | incremented: | |
612 | @example | |
613 | qemu-system-i386 -drive file=a -drive file=b" | |
614 | @end example | |
615 | is interpreted like: | |
616 | @example | |
617 | qemu-system-i386 -hda a -hdb b | |
618 | @end example | |
84644c45 MA |
619 | ETEXI |
620 | ||
10adb8be MA |
621 | DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock, |
622 | "-mtdblock file use 'file' as on-board Flash memory image\n", | |
84644c45 MA |
623 | QEMU_ARCH_ALL) |
624 | STEXI | |
10adb8be MA |
625 | @item -mtdblock @var{file} |
626 | @findex -mtdblock | |
627 | Use @var{file} as on-board Flash memory image. | |
84644c45 MA |
628 | ETEXI |
629 | ||
10adb8be MA |
630 | DEF("sd", HAS_ARG, QEMU_OPTION_sd, |
631 | "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL) | |
5824d651 | 632 | STEXI |
10adb8be MA |
633 | @item -sd @var{file} |
634 | @findex -sd | |
635 | Use @var{file} as SecureDigital card image. | |
5824d651 BS |
636 | ETEXI |
637 | ||
10adb8be MA |
638 | DEF("pflash", HAS_ARG, QEMU_OPTION_pflash, |
639 | "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL) | |
5824d651 | 640 | STEXI |
10adb8be MA |
641 | @item -pflash @var{file} |
642 | @findex -pflash | |
643 | Use @var{file} as a parallel flash image. | |
c70a01e4 | 644 | ETEXI |
5824d651 | 645 | |
10adb8be MA |
646 | DEF("snapshot", 0, QEMU_OPTION_snapshot, |
647 | "-snapshot write to temporary files instead of disk image files\n", | |
c70a01e4 MA |
648 | QEMU_ARCH_ALL) |
649 | STEXI | |
10adb8be MA |
650 | @item -snapshot |
651 | @findex -snapshot | |
652 | Write to temporary files instead of disk image files. In this case, | |
653 | the raw disk image you use is not written back. You can however force | |
654 | the write back by pressing @key{C-a s} (@pxref{disk_images}). | |
5824d651 BS |
655 | ETEXI |
656 | ||
10adb8be MA |
657 | DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \ |
658 | "-hdachs c,h,s[,t]\n" \ | |
659 | " force hard disk 0 physical geometry and the optional BIOS\n" \ | |
660 | " translation (t=none or lba) (usually QEMU can guess them)\n", | |
ad96090a | 661 | QEMU_ARCH_ALL) |
5824d651 | 662 | STEXI |
10adb8be MA |
663 | @item -hdachs @var{c},@var{h},@var{s},[,@var{t}] |
664 | @findex -hdachs | |
665 | Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <= | |
666 | @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS | |
667 | translation mode (@var{t}=none, lba or auto). Usually QEMU can guess | |
668 | all those parameters. This option is useful for old MS-DOS disk | |
669 | images. | |
c70a01e4 | 670 | ETEXI |
74db920c GS |
671 | |
672 | DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev, | |
2c30dd74 | 673 | "-fsdev fsdriver,id=id[,path=path,][security_model={mapped-xattr|mapped-file|passthrough|none}]\n" |
84a87cc4 | 674 | " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n", |
74db920c GS |
675 | QEMU_ARCH_ALL) |
676 | ||
677 | STEXI | |
678 | ||
84a87cc4 | 679 | @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}] |
74db920c | 680 | @findex -fsdev |
7c92a3d2 AK |
681 | Define a new file system device. Valid options are: |
682 | @table @option | |
683 | @item @var{fsdriver} | |
684 | This option specifies the fs driver backend to use. | |
f67e3ffd | 685 | Currently "local", "handle" and "proxy" file system drivers are supported. |
7c92a3d2 AK |
686 | @item id=@var{id} |
687 | Specifies identifier for this device | |
688 | @item path=@var{path} | |
689 | Specifies the export path for the file system device. Files under | |
690 | this path will be available to the 9p client on the guest. | |
691 | @item security_model=@var{security_model} | |
692 | Specifies the security model to be used for this export path. | |
2c30dd74 | 693 | Supported security models are "passthrough", "mapped-xattr", "mapped-file" and "none". |
7c92a3d2 | 694 | In "passthrough" security model, files are stored using the same |
b65ee4fa | 695 | credentials as they are created on the guest. This requires QEMU |
2c30dd74 | 696 | to run as root. In "mapped-xattr" security model, some of the file |
7c92a3d2 | 697 | attributes like uid, gid, mode bits and link target are stored as |
2c30dd74 AK |
698 | file attributes. For "mapped-file" these attributes are stored in the |
699 | hidden .virtfs_metadata directory. Directories exported by this security model cannot | |
7c92a3d2 AK |
700 | interact with other unix tools. "none" security model is same as |
701 | passthrough except the sever won't report failures if it fails to | |
d9b36a6e | 702 | set file attributes like ownership. Security model is mandatory |
f67e3ffd | 703 | only for local fsdriver. Other fsdrivers (like handle, proxy) don't take |
d9b36a6e | 704 | security model as a parameter. |
7c92a3d2 AK |
705 | @item writeout=@var{writeout} |
706 | This is an optional argument. The only supported value is "immediate". | |
707 | This means that host page cache will be used to read and write data but | |
708 | write notification will be sent to the guest only when the data has been | |
709 | reported as written by the storage subsystem. | |
2c74c2cb MK |
710 | @item readonly |
711 | Enables exporting 9p share as a readonly mount for guests. By default | |
712 | read-write access is given. | |
84a87cc4 MK |
713 | @item socket=@var{socket} |
714 | Enables proxy filesystem driver to use passed socket file for communicating | |
715 | with virtfs-proxy-helper | |
f67e3ffd MK |
716 | @item sock_fd=@var{sock_fd} |
717 | Enables proxy filesystem driver to use passed socket descriptor for | |
718 | communicating with virtfs-proxy-helper. Usually a helper like libvirt | |
719 | will create socketpair and pass one of the fds as sock_fd | |
7c92a3d2 | 720 | @end table |
9ce56db6 | 721 | |
7c92a3d2 AK |
722 | -fsdev option is used along with -device driver "virtio-9p-pci". |
723 | @item -device virtio-9p-pci,fsdev=@var{id},mount_tag=@var{mount_tag} | |
724 | Options for virtio-9p-pci driver are: | |
725 | @table @option | |
726 | @item fsdev=@var{id} | |
727 | Specifies the id value specified along with -fsdev option | |
728 | @item mount_tag=@var{mount_tag} | |
729 | Specifies the tag name to be used by the guest to mount this export point | |
74db920c | 730 | @end table |
7c92a3d2 | 731 | |
74db920c | 732 | ETEXI |
74db920c | 733 | |
3d54abc7 | 734 | DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs, |
2c30dd74 | 735 | "-virtfs local,path=path,mount_tag=tag,security_model=[mapped-xattr|mapped-file|passthrough|none]\n" |
84a87cc4 | 736 | " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n", |
3d54abc7 GS |
737 | QEMU_ARCH_ALL) |
738 | ||
739 | STEXI | |
740 | ||
84a87cc4 | 741 | @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}] |
3d54abc7 | 742 | @findex -virtfs |
3d54abc7 | 743 | |
7c92a3d2 AK |
744 | The general form of a Virtual File system pass-through options are: |
745 | @table @option | |
746 | @item @var{fsdriver} | |
747 | This option specifies the fs driver backend to use. | |
f67e3ffd | 748 | Currently "local", "handle" and "proxy" file system drivers are supported. |
7c92a3d2 AK |
749 | @item id=@var{id} |
750 | Specifies identifier for this device | |
751 | @item path=@var{path} | |
752 | Specifies the export path for the file system device. Files under | |
753 | this path will be available to the 9p client on the guest. | |
754 | @item security_model=@var{security_model} | |
755 | Specifies the security model to be used for this export path. | |
2c30dd74 | 756 | Supported security models are "passthrough", "mapped-xattr", "mapped-file" and "none". |
7c92a3d2 | 757 | In "passthrough" security model, files are stored using the same |
b65ee4fa | 758 | credentials as they are created on the guest. This requires QEMU |
2c30dd74 | 759 | to run as root. In "mapped-xattr" security model, some of the file |
7c92a3d2 | 760 | attributes like uid, gid, mode bits and link target are stored as |
2c30dd74 AK |
761 | file attributes. For "mapped-file" these attributes are stored in the |
762 | hidden .virtfs_metadata directory. Directories exported by this security model cannot | |
7c92a3d2 AK |
763 | interact with other unix tools. "none" security model is same as |
764 | passthrough except the sever won't report failures if it fails to | |
d9b36a6e | 765 | set file attributes like ownership. Security model is mandatory only |
f67e3ffd | 766 | for local fsdriver. Other fsdrivers (like handle, proxy) don't take security |
d9b36a6e | 767 | model as a parameter. |
7c92a3d2 AK |
768 | @item writeout=@var{writeout} |
769 | This is an optional argument. The only supported value is "immediate". | |
770 | This means that host page cache will be used to read and write data but | |
771 | write notification will be sent to the guest only when the data has been | |
772 | reported as written by the storage subsystem. | |
2c74c2cb MK |
773 | @item readonly |
774 | Enables exporting 9p share as a readonly mount for guests. By default | |
775 | read-write access is given. | |
84a87cc4 MK |
776 | @item socket=@var{socket} |
777 | Enables proxy filesystem driver to use passed socket file for | |
778 | communicating with virtfs-proxy-helper. Usually a helper like libvirt | |
779 | will create socketpair and pass one of the fds as sock_fd | |
f67e3ffd MK |
780 | @item sock_fd |
781 | Enables proxy filesystem driver to use passed 'sock_fd' as the socket | |
782 | descriptor for interfacing with virtfs-proxy-helper | |
3d54abc7 GS |
783 | @end table |
784 | ETEXI | |
3d54abc7 | 785 | |
9db221ae AK |
786 | DEF("virtfs_synth", 0, QEMU_OPTION_virtfs_synth, |
787 | "-virtfs_synth Create synthetic file system image\n", | |
788 | QEMU_ARCH_ALL) | |
789 | STEXI | |
790 | @item -virtfs_synth | |
791 | @findex -virtfs_synth | |
792 | Create synthetic file system image | |
793 | ETEXI | |
794 | ||
5824d651 BS |
795 | STEXI |
796 | @end table | |
797 | ETEXI | |
5824d651 BS |
798 | DEFHEADING() |
799 | ||
10adb8be MA |
800 | DEFHEADING(USB options:) |
801 | STEXI | |
802 | @table @option | |
803 | ETEXI | |
804 | ||
805 | DEF("usb", 0, QEMU_OPTION_usb, | |
806 | "-usb enable the USB driver (will be the default soon)\n", | |
807 | QEMU_ARCH_ALL) | |
808 | STEXI | |
809 | @item -usb | |
810 | @findex -usb | |
811 | Enable the USB driver (will be the default soon) | |
812 | ETEXI | |
813 | ||
814 | DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice, | |
815 | "-usbdevice name add the host or guest USB device 'name'\n", | |
816 | QEMU_ARCH_ALL) | |
817 | STEXI | |
818 | ||
819 | @item -usbdevice @var{devname} | |
820 | @findex -usbdevice | |
821 | Add the USB device @var{devname}. @xref{usb_devices}. | |
822 | ||
823 | @table @option | |
824 | ||
825 | @item mouse | |
826 | Virtual Mouse. This will override the PS/2 mouse emulation when activated. | |
827 | ||
828 | @item tablet | |
829 | Pointer device that uses absolute coordinates (like a touchscreen). This | |
830 | means QEMU is able to report the mouse position without having to grab the | |
831 | mouse. Also overrides the PS/2 mouse emulation when activated. | |
832 | ||
833 | @item disk:[format=@var{format}]:@var{file} | |
834 | Mass storage device based on file. The optional @var{format} argument | |
835 | will be used rather than detecting the format. Can be used to specifiy | |
836 | @code{format=raw} to avoid interpreting an untrusted format header. | |
837 | ||
838 | @item host:@var{bus}.@var{addr} | |
839 | Pass through the host device identified by @var{bus}.@var{addr} (Linux only). | |
840 | ||
841 | @item host:@var{vendor_id}:@var{product_id} | |
842 | Pass through the host device identified by @var{vendor_id}:@var{product_id} | |
843 | (Linux only). | |
844 | ||
845 | @item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev} | |
846 | Serial converter to host character device @var{dev}, see @code{-serial} for the | |
847 | available devices. | |
848 | ||
849 | @item braille | |
850 | Braille device. This will use BrlAPI to display the braille output on a real | |
851 | or fake device. | |
852 | ||
853 | @item net:@var{options} | |
854 | Network adapter that supports CDC ethernet and RNDIS protocols. | |
855 | ||
856 | @end table | |
857 | ETEXI | |
858 | ||
859 | STEXI | |
860 | @end table | |
861 | ETEXI | |
862 | DEFHEADING() | |
863 | ||
5824d651 | 864 | DEFHEADING(Display options:) |
5824d651 BS |
865 | STEXI |
866 | @table @option | |
867 | ETEXI | |
868 | ||
1472a95b JS |
869 | DEF("display", HAS_ARG, QEMU_OPTION_display, |
870 | "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n" | |
3264ff12 | 871 | " [,window_close=on|off]|curses|none|\n" |
881249c7 | 872 | " gtk[,grab_on_hover=on|off]|\n" |
3264ff12 | 873 | " vnc=<display>[,<optargs>]\n" |
1472a95b JS |
874 | " select display type\n", QEMU_ARCH_ALL) |
875 | STEXI | |
876 | @item -display @var{type} | |
877 | @findex -display | |
878 | Select type of display to use. This option is a replacement for the | |
879 | old style -sdl/-curses/... options. Valid values for @var{type} are | |
880 | @table @option | |
881 | @item sdl | |
882 | Display video output via SDL (usually in a separate graphics | |
883 | window; see the SDL documentation for other possibilities). | |
884 | @item curses | |
885 | Display video output via curses. For graphics device models which | |
886 | support a text mode, QEMU can display this output using a | |
887 | curses/ncurses interface. Nothing is displayed when the graphics | |
888 | device is in graphical mode or if the graphics device does not support | |
889 | a text mode. Generally only the VGA device models support text mode. | |
4171d32e JS |
890 | @item none |
891 | Do not display video output. The guest will still see an emulated | |
892 | graphics card, but its output will not be displayed to the QEMU | |
893 | user. This option differs from the -nographic option in that it | |
894 | only affects what is done with video output; -nographic also changes | |
895 | the destination of the serial and parallel port data. | |
881249c7 JK |
896 | @item gtk |
897 | Display video output in a GTK window. This interface provides drop-down | |
898 | menus and other UI elements to configure and control the VM during | |
899 | runtime. | |
3264ff12 JS |
900 | @item vnc |
901 | Start a VNC server on display <arg> | |
1472a95b JS |
902 | @end table |
903 | ETEXI | |
904 | ||
5824d651 | 905 | DEF("nographic", 0, QEMU_OPTION_nographic, |
ad96090a BS |
906 | "-nographic disable graphical output and redirect serial I/Os to console\n", |
907 | QEMU_ARCH_ALL) | |
5824d651 BS |
908 | STEXI |
909 | @item -nographic | |
6616b2ad | 910 | @findex -nographic |
5824d651 BS |
911 | Normally, QEMU uses SDL to display the VGA output. With this option, |
912 | you can totally disable graphical output so that QEMU is a simple | |
913 | command line application. The emulated serial port is redirected on | |
02c4bdf1 PB |
914 | the console and muxed with the monitor (unless redirected elsewhere |
915 | explicitly). Therefore, you can still use QEMU to debug a Linux kernel | |
b031f413 RR |
916 | with a serial console. Use @key{C-a h} for help on switching between |
917 | the console and monitor. | |
5824d651 BS |
918 | ETEXI |
919 | ||
5824d651 | 920 | DEF("curses", 0, QEMU_OPTION_curses, |
ad96090a BS |
921 | "-curses use a curses/ncurses interface instead of SDL\n", |
922 | QEMU_ARCH_ALL) | |
5824d651 BS |
923 | STEXI |
924 | @item -curses | |
b8f490eb | 925 | @findex -curses |
5824d651 BS |
926 | Normally, QEMU uses SDL to display the VGA output. With this option, |
927 | QEMU can display the VGA output when in text mode using a | |
928 | curses/ncurses interface. Nothing is displayed in graphical mode. | |
929 | ETEXI | |
930 | ||
5824d651 | 931 | DEF("no-frame", 0, QEMU_OPTION_no_frame, |
ad96090a BS |
932 | "-no-frame open SDL window without a frame and window decorations\n", |
933 | QEMU_ARCH_ALL) | |
5824d651 BS |
934 | STEXI |
935 | @item -no-frame | |
6616b2ad | 936 | @findex -no-frame |
5824d651 BS |
937 | Do not use decorations for SDL windows and start them using the whole |
938 | available screen space. This makes the using QEMU in a dedicated desktop | |
939 | workspace more convenient. | |
940 | ETEXI | |
941 | ||
5824d651 | 942 | DEF("alt-grab", 0, QEMU_OPTION_alt_grab, |
ad96090a BS |
943 | "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n", |
944 | QEMU_ARCH_ALL) | |
5824d651 BS |
945 | STEXI |
946 | @item -alt-grab | |
6616b2ad | 947 | @findex -alt-grab |
de1db2a1 BH |
948 | Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also |
949 | affects the special keys (for fullscreen, monitor-mode switching, etc). | |
5824d651 BS |
950 | ETEXI |
951 | ||
0ca9f8a4 | 952 | DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab, |
ad96090a BS |
953 | "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n", |
954 | QEMU_ARCH_ALL) | |
0ca9f8a4 DK |
955 | STEXI |
956 | @item -ctrl-grab | |
6616b2ad | 957 | @findex -ctrl-grab |
de1db2a1 BH |
958 | Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also |
959 | affects the special keys (for fullscreen, monitor-mode switching, etc). | |
0ca9f8a4 DK |
960 | ETEXI |
961 | ||
5824d651 | 962 | DEF("no-quit", 0, QEMU_OPTION_no_quit, |
ad96090a | 963 | "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL) |
5824d651 BS |
964 | STEXI |
965 | @item -no-quit | |
6616b2ad | 966 | @findex -no-quit |
5824d651 BS |
967 | Disable SDL window close capability. |
968 | ETEXI | |
969 | ||
5824d651 | 970 | DEF("sdl", 0, QEMU_OPTION_sdl, |
ad96090a | 971 | "-sdl enable SDL\n", QEMU_ARCH_ALL) |
5824d651 BS |
972 | STEXI |
973 | @item -sdl | |
6616b2ad | 974 | @findex -sdl |
5824d651 BS |
975 | Enable SDL. |
976 | ETEXI | |
977 | ||
29b0040b | 978 | DEF("spice", HAS_ARG, QEMU_OPTION_spice, |
27af7788 YH |
979 | "-spice [port=port][,tls-port=secured-port][,x509-dir=<dir>]\n" |
980 | " [,x509-key-file=<file>][,x509-key-password=<file>]\n" | |
981 | " [,x509-cert-file=<file>][,x509-cacert-file=<file>]\n" | |
fe4831b1 | 982 | " [,x509-dh-key-file=<file>][,addr=addr][,ipv4|ipv6|unix]\n" |
27af7788 YH |
983 | " [,tls-ciphers=<list>]\n" |
984 | " [,tls-channel=[main|display|cursor|inputs|record|playback]]\n" | |
985 | " [,plaintext-channel=[main|display|cursor|inputs|record|playback]]\n" | |
986 | " [,sasl][,password=<secret>][,disable-ticketing]\n" | |
987 | " [,image-compression=[auto_glz|auto_lz|quic|glz|lz|off]]\n" | |
988 | " [,jpeg-wan-compression=[auto|never|always]]\n" | |
989 | " [,zlib-glz-wan-compression=[auto|never|always]]\n" | |
990 | " [,streaming-video=[off|all|filter]][,disable-copy-paste]\n" | |
5ad24e5f HG |
991 | " [,disable-agent-file-xfer][,agent-mouse=[on|off]]\n" |
992 | " [,playback-compression=[on|off]][,seamless-migration=[on|off]]\n" | |
27af7788 YH |
993 | " enable spice\n" |
994 | " at least one of {port, tls-port} is mandatory\n", | |
995 | QEMU_ARCH_ALL) | |
29b0040b GH |
996 | STEXI |
997 | @item -spice @var{option}[,@var{option}[,...]] | |
998 | @findex -spice | |
999 | Enable the spice remote desktop protocol. Valid options are | |
1000 | ||
1001 | @table @option | |
1002 | ||
1003 | @item port=<nr> | |
c448e855 | 1004 | Set the TCP port spice is listening on for plaintext channels. |
29b0040b | 1005 | |
333b0eeb GH |
1006 | @item addr=<addr> |
1007 | Set the IP address spice is listening on. Default is any address. | |
1008 | ||
1009 | @item ipv4 | |
1010 | @item ipv6 | |
fe4831b1 | 1011 | @item unix |
333b0eeb GH |
1012 | Force using the specified IP version. |
1013 | ||
29b0040b GH |
1014 | @item password=<secret> |
1015 | Set the password you need to authenticate. | |
1016 | ||
48b3ed0a MAL |
1017 | @item sasl |
1018 | Require that the client use SASL to authenticate with the spice. | |
1019 | The exact choice of authentication method used is controlled from the | |
1020 | system / user's SASL configuration file for the 'qemu' service. This | |
1021 | is typically found in /etc/sasl2/qemu.conf. If running QEMU as an | |
1022 | unprivileged user, an environment variable SASL_CONF_PATH can be used | |
1023 | to make it search alternate locations for the service config. | |
1024 | While some SASL auth methods can also provide data encryption (eg GSSAPI), | |
1025 | it is recommended that SASL always be combined with the 'tls' and | |
1026 | 'x509' settings to enable use of SSL and server certificates. This | |
1027 | ensures a data encryption preventing compromise of authentication | |
1028 | credentials. | |
1029 | ||
29b0040b GH |
1030 | @item disable-ticketing |
1031 | Allow client connects without authentication. | |
1032 | ||
d4970b07 HG |
1033 | @item disable-copy-paste |
1034 | Disable copy paste between the client and the guest. | |
1035 | ||
5ad24e5f HG |
1036 | @item disable-agent-file-xfer |
1037 | Disable spice-vdagent based file-xfer between the client and the guest. | |
1038 | ||
c448e855 GH |
1039 | @item tls-port=<nr> |
1040 | Set the TCP port spice is listening on for encrypted channels. | |
1041 | ||
1042 | @item x509-dir=<dir> | |
1043 | Set the x509 file directory. Expects same filenames as -vnc $display,x509=$dir | |
1044 | ||
1045 | @item x509-key-file=<file> | |
1046 | @item x509-key-password=<file> | |
1047 | @item x509-cert-file=<file> | |
1048 | @item x509-cacert-file=<file> | |
1049 | @item x509-dh-key-file=<file> | |
1050 | The x509 file names can also be configured individually. | |
1051 | ||
1052 | @item tls-ciphers=<list> | |
1053 | Specify which ciphers to use. | |
1054 | ||
d70d6b31 AL |
1055 | @item tls-channel=[main|display|cursor|inputs|record|playback] |
1056 | @item plaintext-channel=[main|display|cursor|inputs|record|playback] | |
17b6dea0 GH |
1057 | Force specific channel to be used with or without TLS encryption. The |
1058 | options can be specified multiple times to configure multiple | |
1059 | channels. The special name "default" can be used to set the default | |
1060 | mode. For channels which are not explicitly forced into one mode the | |
1061 | spice client is allowed to pick tls/plaintext as he pleases. | |
1062 | ||
9f04e09e YH |
1063 | @item image-compression=[auto_glz|auto_lz|quic|glz|lz|off] |
1064 | Configure image compression (lossless). | |
1065 | Default is auto_glz. | |
1066 | ||
1067 | @item jpeg-wan-compression=[auto|never|always] | |
1068 | @item zlib-glz-wan-compression=[auto|never|always] | |
1069 | Configure wan image compression (lossy for slow links). | |
1070 | Default is auto. | |
1071 | ||
84a23f25 GH |
1072 | @item streaming-video=[off|all|filter] |
1073 | Configure video stream detection. Default is filter. | |
1074 | ||
1075 | @item agent-mouse=[on|off] | |
1076 | Enable/disable passing mouse events via vdagent. Default is on. | |
1077 | ||
1078 | @item playback-compression=[on|off] | |
1079 | Enable/disable audio stream compression (using celt 0.5.1). Default is on. | |
1080 | ||
8c957053 YH |
1081 | @item seamless-migration=[on|off] |
1082 | Enable/disable spice seamless migration. Default is off. | |
1083 | ||
29b0040b GH |
1084 | @end table |
1085 | ETEXI | |
1086 | ||
5824d651 | 1087 | DEF("portrait", 0, QEMU_OPTION_portrait, |
ad96090a BS |
1088 | "-portrait rotate graphical output 90 deg left (only PXA LCD)\n", |
1089 | QEMU_ARCH_ALL) | |
5824d651 BS |
1090 | STEXI |
1091 | @item -portrait | |
6616b2ad | 1092 | @findex -portrait |
5824d651 BS |
1093 | Rotate graphical output 90 deg left (only PXA LCD). |
1094 | ETEXI | |
1095 | ||
9312805d VK |
1096 | DEF("rotate", HAS_ARG, QEMU_OPTION_rotate, |
1097 | "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n", | |
1098 | QEMU_ARCH_ALL) | |
1099 | STEXI | |
6265c43b | 1100 | @item -rotate @var{deg} |
9312805d VK |
1101 | @findex -rotate |
1102 | Rotate graphical output some deg left (only PXA LCD). | |
1103 | ETEXI | |
1104 | ||
5824d651 | 1105 | DEF("vga", HAS_ARG, QEMU_OPTION_vga, |
33632788 | 1106 | "-vga [std|cirrus|vmware|qxl|xenfb|tcx|cg3|none]\n" |
ad96090a | 1107 | " select video card type\n", QEMU_ARCH_ALL) |
5824d651 | 1108 | STEXI |
e4558dca | 1109 | @item -vga @var{type} |
6616b2ad | 1110 | @findex -vga |
5824d651 | 1111 | Select type of VGA card to emulate. Valid values for @var{type} are |
b3f046c2 | 1112 | @table @option |
5824d651 BS |
1113 | @item cirrus |
1114 | Cirrus Logic GD5446 Video card. All Windows versions starting from | |
1115 | Windows 95 should recognize and use this graphic card. For optimal | |
1116 | performances, use 16 bit color depth in the guest and the host OS. | |
1117 | (This one is the default) | |
1118 | @item std | |
1119 | Standard VGA card with Bochs VBE extensions. If your guest OS | |
1120 | supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want | |
1121 | to use high resolution modes (>= 1280x1024x16) then you should use | |
1122 | this option. | |
1123 | @item vmware | |
1124 | VMWare SVGA-II compatible adapter. Use it if you have sufficiently | |
1125 | recent XFree86/XOrg server or Windows guest with a driver for this | |
1126 | card. | |
a19cbfb3 GH |
1127 | @item qxl |
1128 | QXL paravirtual graphic card. It is VGA compatible (including VESA | |
1129 | 2.0 VBE support). Works best with qxl guest drivers installed though. | |
1130 | Recommended choice when using the spice protocol. | |
33632788 MCA |
1131 | @item tcx |
1132 | (sun4m only) Sun TCX framebuffer. This is the default framebuffer for | |
1133 | sun4m machines and offers both 8-bit and 24-bit colour depths at a | |
1134 | fixed resolution of 1024x768. | |
1135 | @item cg3 | |
1136 | (sun4m only) Sun cgthree framebuffer. This is a simple 8-bit framebuffer | |
1137 | for sun4m machines available in both 1024x768 (OpenBIOS) and 1152x900 (OBP) | |
1138 | resolutions aimed at people wishing to run older Solaris versions. | |
5824d651 BS |
1139 | @item none |
1140 | Disable VGA card. | |
1141 | @end table | |
1142 | ETEXI | |
1143 | ||
1144 | DEF("full-screen", 0, QEMU_OPTION_full_screen, | |
ad96090a | 1145 | "-full-screen start in full screen\n", QEMU_ARCH_ALL) |
5824d651 BS |
1146 | STEXI |
1147 | @item -full-screen | |
6616b2ad | 1148 | @findex -full-screen |
5824d651 BS |
1149 | Start in full screen. |
1150 | ETEXI | |
1151 | ||
5824d651 | 1152 | DEF("g", 1, QEMU_OPTION_g , |
ad96090a BS |
1153 | "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n", |
1154 | QEMU_ARCH_PPC | QEMU_ARCH_SPARC) | |
5824d651 | 1155 | STEXI |
95d5f08b | 1156 | @item -g @var{width}x@var{height}[x@var{depth}] |
6616b2ad | 1157 | @findex -g |
95d5f08b | 1158 | Set the initial graphical resolution and depth (PPC, SPARC only). |
5824d651 BS |
1159 | ETEXI |
1160 | ||
1161 | DEF("vnc", HAS_ARG, QEMU_OPTION_vnc , | |
ad96090a | 1162 | "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL) |
5824d651 BS |
1163 | STEXI |
1164 | @item -vnc @var{display}[,@var{option}[,@var{option}[,...]]] | |
6616b2ad | 1165 | @findex -vnc |
5824d651 BS |
1166 | Normally, QEMU uses SDL to display the VGA output. With this option, |
1167 | you can have QEMU listen on VNC display @var{display} and redirect the VGA | |
1168 | display over the VNC session. It is very useful to enable the usb | |
1169 | tablet device when using this option (option @option{-usbdevice | |
1170 | tablet}). When using the VNC display, you must use the @option{-k} | |
1171 | parameter to set the keyboard layout if you are not using en-us. Valid | |
1172 | syntax for the @var{display} is | |
1173 | ||
b3f046c2 | 1174 | @table @option |
5824d651 BS |
1175 | |
1176 | @item @var{host}:@var{d} | |
1177 | ||
1178 | TCP connections will only be allowed from @var{host} on display @var{d}. | |
1179 | By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can | |
1180 | be omitted in which case the server will accept connections from any host. | |
1181 | ||
4e257e5e | 1182 | @item unix:@var{path} |
5824d651 BS |
1183 | |
1184 | Connections will be allowed over UNIX domain sockets where @var{path} is the | |
1185 | location of a unix socket to listen for connections on. | |
1186 | ||
1187 | @item none | |
1188 | ||
1189 | VNC is initialized but not started. The monitor @code{change} command | |
1190 | can be used to later start the VNC server. | |
1191 | ||
1192 | @end table | |
1193 | ||
1194 | Following the @var{display} value there may be one or more @var{option} flags | |
1195 | separated by commas. Valid options are | |
1196 | ||
b3f046c2 | 1197 | @table @option |
5824d651 BS |
1198 | |
1199 | @item reverse | |
1200 | ||
1201 | Connect to a listening VNC client via a ``reverse'' connection. The | |
1202 | client is specified by the @var{display}. For reverse network | |
1203 | connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument | |
1204 | is a TCP port number, not a display number. | |
1205 | ||
7536ee4b TH |
1206 | @item websocket |
1207 | ||
1208 | Opens an additional TCP listening port dedicated to VNC Websocket connections. | |
085d8134 | 1209 | By definition the Websocket port is 5700+@var{display}. If @var{host} is |
7536ee4b TH |
1210 | specified connections will only be allowed from this host. |
1211 | As an alternative the Websocket port could be specified by using | |
1212 | @code{websocket}=@var{port}. | |
0057a0d5 TH |
1213 | TLS encryption for the Websocket connection is supported if the required |
1214 | certificates are specified with the VNC option @option{x509}. | |
7536ee4b | 1215 | |
5824d651 BS |
1216 | @item password |
1217 | ||
1218 | Require that password based authentication is used for client connections. | |
86ee5bc3 MN |
1219 | |
1220 | The password must be set separately using the @code{set_password} command in | |
1221 | the @ref{pcsys_monitor}. The syntax to change your password is: | |
1222 | @code{set_password <protocol> <password>} where <protocol> could be either | |
1223 | "vnc" or "spice". | |
1224 | ||
1225 | If you would like to change <protocol> password expiration, you should use | |
1226 | @code{expire_password <protocol> <expiration-time>} where expiration time could | |
1227 | be one of the following options: now, never, +seconds or UNIX time of | |
1228 | expiration, e.g. +60 to make password expire in 60 seconds, or 1335196800 | |
1229 | to make password expire on "Mon Apr 23 12:00:00 EDT 2012" (UNIX time for this | |
1230 | date and time). | |
1231 | ||
1232 | You can also use keywords "now" or "never" for the expiration time to | |
1233 | allow <protocol> password to expire immediately or never expire. | |
5824d651 BS |
1234 | |
1235 | @item tls | |
1236 | ||
1237 | Require that client use TLS when communicating with the VNC server. This | |
1238 | uses anonymous TLS credentials so is susceptible to a man-in-the-middle | |
1239 | attack. It is recommended that this option be combined with either the | |
4e257e5e | 1240 | @option{x509} or @option{x509verify} options. |
5824d651 BS |
1241 | |
1242 | @item x509=@var{/path/to/certificate/dir} | |
1243 | ||
1244 | Valid if @option{tls} is specified. Require that x509 credentials are used | |
1245 | for negotiating the TLS session. The server will send its x509 certificate | |
1246 | to the client. It is recommended that a password be set on the VNC server | |
1247 | to provide authentication of the client when this is used. The path following | |
1248 | this option specifies where the x509 certificates are to be loaded from. | |
1249 | See the @ref{vnc_security} section for details on generating certificates. | |
1250 | ||
1251 | @item x509verify=@var{/path/to/certificate/dir} | |
1252 | ||
1253 | Valid if @option{tls} is specified. Require that x509 credentials are used | |
1254 | for negotiating the TLS session. The server will send its x509 certificate | |
1255 | to the client, and request that the client send its own x509 certificate. | |
1256 | The server will validate the client's certificate against the CA certificate, | |
1257 | and reject clients when validation fails. If the certificate authority is | |
1258 | trusted, this is a sufficient authentication mechanism. You may still wish | |
1259 | to set a password on the VNC server as a second authentication layer. The | |
1260 | path following this option specifies where the x509 certificates are to | |
1261 | be loaded from. See the @ref{vnc_security} section for details on generating | |
1262 | certificates. | |
1263 | ||
1264 | @item sasl | |
1265 | ||
1266 | Require that the client use SASL to authenticate with the VNC server. | |
1267 | The exact choice of authentication method used is controlled from the | |
1268 | system / user's SASL configuration file for the 'qemu' service. This | |
1269 | is typically found in /etc/sasl2/qemu.conf. If running QEMU as an | |
1270 | unprivileged user, an environment variable SASL_CONF_PATH can be used | |
1271 | to make it search alternate locations for the service config. | |
1272 | While some SASL auth methods can also provide data encryption (eg GSSAPI), | |
1273 | it is recommended that SASL always be combined with the 'tls' and | |
1274 | 'x509' settings to enable use of SSL and server certificates. This | |
1275 | ensures a data encryption preventing compromise of authentication | |
1276 | credentials. See the @ref{vnc_security} section for details on using | |
1277 | SASL authentication. | |
1278 | ||
1279 | @item acl | |
1280 | ||
1281 | Turn on access control lists for checking of the x509 client certificate | |
1282 | and SASL party. For x509 certs, the ACL check is made against the | |
1283 | certificate's distinguished name. This is something that looks like | |
1284 | @code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is | |
1285 | made against the username, which depending on the SASL plugin, may | |
1286 | include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}. | |
1287 | When the @option{acl} flag is set, the initial access list will be | |
1288 | empty, with a @code{deny} policy. Thus no one will be allowed to | |
1289 | use the VNC server until the ACLs have been loaded. This can be | |
1290 | achieved using the @code{acl} monitor command. | |
1291 | ||
6f9c78c1 CC |
1292 | @item lossy |
1293 | ||
1294 | Enable lossy compression methods (gradient, JPEG, ...). If this | |
1295 | option is set, VNC client may receive lossy framebuffer updates | |
1296 | depending on its encoding settings. Enabling this option can save | |
1297 | a lot of bandwidth at the expense of quality. | |
1298 | ||
80e0c8c3 CC |
1299 | @item non-adaptive |
1300 | ||
1301 | Disable adaptive encodings. Adaptive encodings are enabled by default. | |
1302 | An adaptive encoding will try to detect frequently updated screen regions, | |
1303 | and send updates in these regions using a lossy encoding (like JPEG). | |
61cc8701 | 1304 | This can be really helpful to save bandwidth when playing videos. Disabling |
9d85d557 | 1305 | adaptive encodings restores the original static behavior of encodings |
80e0c8c3 CC |
1306 | like Tight. |
1307 | ||
8cf36489 GH |
1308 | @item share=[allow-exclusive|force-shared|ignore] |
1309 | ||
1310 | Set display sharing policy. 'allow-exclusive' allows clients to ask | |
1311 | for exclusive access. As suggested by the rfb spec this is | |
1312 | implemented by dropping other connections. Connecting multiple | |
1313 | clients in parallel requires all clients asking for a shared session | |
1314 | (vncviewer: -shared switch). This is the default. 'force-shared' | |
1315 | disables exclusive client access. Useful for shared desktop sessions, | |
1316 | where you don't want someone forgetting specify -shared disconnect | |
1317 | everybody else. 'ignore' completely ignores the shared flag and | |
1318 | allows everybody connect unconditionally. Doesn't conform to the rfb | |
b65ee4fa | 1319 | spec but is traditional QEMU behavior. |
8cf36489 | 1320 | |
5824d651 BS |
1321 | @end table |
1322 | ETEXI | |
1323 | ||
1324 | STEXI | |
1325 | @end table | |
1326 | ETEXI | |
a3adb7ad | 1327 | ARCHHEADING(, QEMU_ARCH_I386) |
5824d651 | 1328 | |
a3adb7ad | 1329 | ARCHHEADING(i386 target only:, QEMU_ARCH_I386) |
5824d651 BS |
1330 | STEXI |
1331 | @table @option | |
1332 | ETEXI | |
1333 | ||
5824d651 | 1334 | DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack, |
ad96090a BS |
1335 | "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n", |
1336 | QEMU_ARCH_I386) | |
5824d651 BS |
1337 | STEXI |
1338 | @item -win2k-hack | |
6616b2ad | 1339 | @findex -win2k-hack |
5824d651 BS |
1340 | Use it when installing Windows 2000 to avoid a disk full bug. After |
1341 | Windows 2000 is installed, you no longer need this option (this option | |
1342 | slows down the IDE transfers). | |
1343 | ETEXI | |
1344 | ||
1ed2fc1f | 1345 | HXCOMM Deprecated by -rtc |
ad96090a | 1346 | DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386) |
5824d651 | 1347 | |
5824d651 | 1348 | DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk, |
ad96090a BS |
1349 | "-no-fd-bootchk disable boot signature checking for floppy disks\n", |
1350 | QEMU_ARCH_I386) | |
5824d651 BS |
1351 | STEXI |
1352 | @item -no-fd-bootchk | |
6616b2ad | 1353 | @findex -no-fd-bootchk |
4eda32f5 | 1354 | Disable boot signature checking for floppy disks in BIOS. May |
5824d651 BS |
1355 | be needed to boot from old floppy disks. |
1356 | ETEXI | |
1357 | ||
5824d651 | 1358 | DEF("no-acpi", 0, QEMU_OPTION_no_acpi, |
f5d8c8cd | 1359 | "-no-acpi disable ACPI\n", QEMU_ARCH_I386 | QEMU_ARCH_ARM) |
5824d651 BS |
1360 | STEXI |
1361 | @item -no-acpi | |
6616b2ad | 1362 | @findex -no-acpi |
5824d651 BS |
1363 | Disable ACPI (Advanced Configuration and Power Interface) support. Use |
1364 | it if your guest OS complains about ACPI problems (PC target machine | |
1365 | only). | |
1366 | ETEXI | |
1367 | ||
5824d651 | 1368 | DEF("no-hpet", 0, QEMU_OPTION_no_hpet, |
ad96090a | 1369 | "-no-hpet disable HPET\n", QEMU_ARCH_I386) |
5824d651 BS |
1370 | STEXI |
1371 | @item -no-hpet | |
6616b2ad | 1372 | @findex -no-hpet |
5824d651 BS |
1373 | Disable HPET support. |
1374 | ETEXI | |
1375 | ||
5824d651 | 1376 | DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable, |
104bf02e | 1377 | "-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" |
ad96090a | 1378 | " ACPI table description\n", QEMU_ARCH_I386) |
5824d651 BS |
1379 | STEXI |
1380 | @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}]...] | |
6616b2ad | 1381 | @findex -acpitable |
5824d651 | 1382 | Add ACPI table with specified header fields and context from specified files. |
104bf02e MT |
1383 | For file=, take whole ACPI table from the specified files, including all |
1384 | ACPI headers (possible overridden by other options). | |
1385 | For data=, only data | |
1386 | portion of the table is used, all header information is specified in the | |
1387 | command line. | |
5824d651 BS |
1388 | ETEXI |
1389 | ||
b6f6e3d3 AL |
1390 | DEF("smbios", HAS_ARG, QEMU_OPTION_smbios, |
1391 | "-smbios file=binary\n" | |
ca1a8a06 | 1392 | " load SMBIOS entry from binary file\n" |
b155eb1d GS |
1393 | "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n" |
1394 | " [,uefi=on|off]\n" | |
ca1a8a06 | 1395 | " specify SMBIOS type 0 fields\n" |
b6f6e3d3 AL |
1396 | "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n" |
1397 | " [,uuid=uuid][,sku=str][,family=str]\n" | |
b155eb1d GS |
1398 | " specify SMBIOS type 1 fields\n" |
1399 | "-smbios type=2[,manufacturer=str][,product=str][,version=str][,serial=str]\n" | |
1400 | " [,asset=str][,location=str]\n" | |
1401 | " specify SMBIOS type 2 fields\n" | |
1402 | "-smbios type=3[,manufacturer=str][,version=str][,serial=str][,asset=str]\n" | |
1403 | " [,sku=str]\n" | |
1404 | " specify SMBIOS type 3 fields\n" | |
1405 | "-smbios type=4[,sock_pfx=str][,manufacturer=str][,version=str][,serial=str]\n" | |
1406 | " [,asset=str][,part=str]\n" | |
1407 | " specify SMBIOS type 4 fields\n" | |
1408 | "-smbios type=17[,loc_pfx=str][,bank=str][,manufacturer=str][,serial=str]\n" | |
3ebd6cc8 | 1409 | " [,asset=str][,part=str][,speed=%d]\n" |
b155eb1d GS |
1410 | " specify SMBIOS type 17 fields\n", |
1411 | QEMU_ARCH_I386) | |
b6f6e3d3 AL |
1412 | STEXI |
1413 | @item -smbios file=@var{binary} | |
6616b2ad | 1414 | @findex -smbios |
b6f6e3d3 AL |
1415 | Load SMBIOS entry from binary file. |
1416 | ||
84351843 | 1417 | @item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}][,uefi=on|off] |
b6f6e3d3 AL |
1418 | Specify SMBIOS type 0 fields |
1419 | ||
b155eb1d | 1420 | @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}] |
b6f6e3d3 | 1421 | Specify SMBIOS type 1 fields |
b155eb1d GS |
1422 | |
1423 | @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}] | |
1424 | Specify SMBIOS type 2 fields | |
1425 | ||
1426 | @item -smbios type=3[,manufacturer=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,sku=@var{str}] | |
1427 | Specify SMBIOS type 3 fields | |
1428 | ||
1429 | @item -smbios type=4[,sock_pfx=@var{str}][,manufacturer=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,part=@var{str}] | |
1430 | Specify SMBIOS type 4 fields | |
1431 | ||
3ebd6cc8 | 1432 | @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}] |
b155eb1d | 1433 | Specify SMBIOS type 17 fields |
b6f6e3d3 AL |
1434 | ETEXI |
1435 | ||
5824d651 BS |
1436 | STEXI |
1437 | @end table | |
1438 | ETEXI | |
c70a01e4 | 1439 | DEFHEADING() |
5824d651 BS |
1440 | |
1441 | DEFHEADING(Network options:) | |
1442 | STEXI | |
1443 | @table @option | |
1444 | ETEXI | |
1445 | ||
ad196a9d JK |
1446 | HXCOMM Legacy slirp options (now moved to -net user): |
1447 | #ifdef CONFIG_SLIRP | |
ad96090a BS |
1448 | DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL) |
1449 | DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL) | |
1450 | DEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL) | |
ad196a9d | 1451 | #ifndef _WIN32 |
ad96090a | 1452 | DEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL) |
ad196a9d JK |
1453 | #endif |
1454 | #endif | |
1455 | ||
6a8b4a5b | 1456 | DEF("netdev", HAS_ARG, QEMU_OPTION_netdev, |
5824d651 | 1457 | #ifdef CONFIG_SLIRP |
6a8b4a5b | 1458 | "-netdev user,id=str[,net=addr[/mask]][,host=addr][,restrict=on|off]\n" |
63d2960b KS |
1459 | " [,hostname=host][,dhcpstart=addr][,dns=addr][,dnssearch=domain][,tftp=dir]\n" |
1460 | " [,bootfile=f][,hostfwd=rule][,guestfwd=rule]" | |
ad196a9d | 1461 | #ifndef _WIN32 |
c92ef6a2 | 1462 | "[,smb=dir[,smbserver=addr]]\n" |
ad196a9d | 1463 | #endif |
6a8b4a5b TH |
1464 | " configure a user mode network backend with ID 'str',\n" |
1465 | " its DHCP server and optional services\n" | |
5824d651 BS |
1466 | #endif |
1467 | #ifdef _WIN32 | |
6a8b4a5b TH |
1468 | "-netdev tap,id=str,ifname=name\n" |
1469 | " configure a host TAP network backend with ID 'str'\n" | |
5824d651 | 1470 | #else |
6a8b4a5b TH |
1471 | "-netdev tap,id=str[,fd=h][,fds=x:y:...:z][,ifname=name][,script=file][,downscript=dfile]\n" |
1472 | " [,helper=helper][,sndbuf=nbytes][,vnet_hdr=on|off][,vhost=on|off]\n" | |
1473 | " [,vhostfd=h][,vhostfds=x:y:...:z][,vhostforce=on|off][,queues=n]\n" | |
1474 | " configure a host TAP network backend with ID 'str'\n" | |
a7c36ee4 CB |
1475 | " use network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n" |
1476 | " to configure it and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n" | |
1477 | " to deconfigure it\n" | |
ca1a8a06 | 1478 | " use '[down]script=no' to disable script execution\n" |
a7c36ee4 CB |
1479 | " use network helper 'helper' (default=" DEFAULT_BRIDGE_HELPER ") to\n" |
1480 | " configure it\n" | |
5824d651 | 1481 | " use 'fd=h' to connect to an already opened TAP interface\n" |
2ca81baa | 1482 | " use 'fds=x:y:...:z' to connect to already opened multiqueue capable TAP interfaces\n" |
ca1a8a06 | 1483 | " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n" |
f157ed20 | 1484 | " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n" |
ca1a8a06 BR |
1485 | " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n" |
1486 | " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n" | |
82b0d80e | 1487 | " use vhost=on to enable experimental in kernel accelerator\n" |
5430a28f MT |
1488 | " (only has effect for virtio guests which use MSIX)\n" |
1489 | " use vhostforce=on to force vhost on for non-MSIX virtio guests\n" | |
82b0d80e | 1490 | " use 'vhostfd=h' to connect to an already opened vhost net device\n" |
2ca81baa | 1491 | " use 'vhostfds=x:y:...:z to connect to multiple already opened vhost net devices\n" |
ec396014 | 1492 | " use 'queues=n' to specify the number of queues to be created for multiqueue TAP\n" |
6a8b4a5b TH |
1493 | "-netdev bridge,id=str[,br=bridge][,helper=helper]\n" |
1494 | " configure a host TAP network backend with ID 'str' that is\n" | |
1495 | " connected to a bridge (default=" DEFAULT_BRIDGE_INTERFACE ")\n" | |
1496 | " using the program 'helper (default=" DEFAULT_BRIDGE_HELPER ")\n" | |
3fb69aa1 AI |
1497 | #endif |
1498 | #ifdef __linux__ | |
6a8b4a5b TH |
1499 | "-netdev l2tpv3,id=str,src=srcaddr,dst=dstaddr[,srcport=srcport][,dstport=dstport]\n" |
1500 | " [,rxsession=rxsession],txsession=txsession[,ipv6=on/off][,udp=on/off]\n" | |
1501 | " [,cookie64=on/off][,counter][,pincounter][,txcookie=txcookie]\n" | |
1502 | " [,rxcookie=rxcookie][,offset=offset]\n" | |
1503 | " configure a network backend with ID 'str' connected to\n" | |
1504 | " an Ethernet over L2TPv3 pseudowire.\n" | |
3fb69aa1 | 1505 | " Linux kernel 3.3+ as well as most routers can talk\n" |
2f47b403 | 1506 | " L2TPv3. This transport allows connecting a VM to a VM,\n" |
3fb69aa1 AI |
1507 | " VM to a router and even VM to Host. It is a nearly-universal\n" |
1508 | " standard (RFC3391). Note - this implementation uses static\n" | |
1509 | " pre-configured tunnels (same as the Linux kernel).\n" | |
1510 | " use 'src=' to specify source address\n" | |
1511 | " use 'dst=' to specify destination address\n" | |
1512 | " use 'udp=on' to specify udp encapsulation\n" | |
3952651a | 1513 | " use 'srcport=' to specify source udp port\n" |
3fb69aa1 AI |
1514 | " use 'dstport=' to specify destination udp port\n" |
1515 | " use 'ipv6=on' to force v6\n" | |
1516 | " L2TPv3 uses cookies to prevent misconfiguration as\n" | |
1517 | " well as a weak security measure\n" | |
1518 | " use 'rxcookie=0x012345678' to specify a rxcookie\n" | |
1519 | " use 'txcookie=0x012345678' to specify a txcookie\n" | |
1520 | " use 'cookie64=on' to set cookie size to 64 bit, otherwise 32\n" | |
1521 | " use 'counter=off' to force a 'cut-down' L2TPv3 with no counter\n" | |
1522 | " use 'pincounter=on' to work around broken counter handling in peer\n" | |
1523 | " use 'offset=X' to add an extra offset between header and data\n" | |
5824d651 | 1524 | #endif |
6a8b4a5b TH |
1525 | "-netdev socket,id=str[,fd=h][,listen=[host]:port][,connect=host:port]\n" |
1526 | " configure a network backend to connect to another network\n" | |
1527 | " using a socket connection\n" | |
1528 | "-netdev socket,id=str[,fd=h][,mcast=maddr:port[,localaddr=addr]]\n" | |
1529 | " configure a network backend to connect to a multicast maddr and port\n" | |
3a75e74c | 1530 | " use 'localaddr=addr' to specify the host address to send packets from\n" |
6a8b4a5b TH |
1531 | "-netdev socket,id=str[,fd=h][,udp=host:port][,localaddr=host:port]\n" |
1532 | " configure a network backend to connect to another network\n" | |
1533 | " using an UDP tunnel\n" | |
5824d651 | 1534 | #ifdef CONFIG_VDE |
6a8b4a5b TH |
1535 | "-netdev vde,id=str[,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n" |
1536 | " configure a network backend to connect to port 'n' of a vde switch\n" | |
1537 | " running on host and listening for incoming connections on 'socketpath'.\n" | |
5824d651 BS |
1538 | " Use group 'groupname' and mode 'octalmode' to change default\n" |
1539 | " ownership and permissions for communication port.\n" | |
58952137 VM |
1540 | #endif |
1541 | #ifdef CONFIG_NETMAP | |
6a8b4a5b | 1542 | "-netdev netmap,id=str,ifname=name[,devname=nmname]\n" |
58952137 VM |
1543 | " attach to the existing netmap-enabled network interface 'name', or to a\n" |
1544 | " VALE port (created on the fly) called 'name' ('nmname' is name of the \n" | |
1545 | " netmap device, defaults to '/dev/netmap')\n" | |
5824d651 | 1546 | #endif |
6a8b4a5b TH |
1547 | "-netdev vhost-user,id=str,chardev=dev[,vhostforce=on|off]\n" |
1548 | " configure a vhost-user network, backed by a chardev 'dev'\n" | |
1549 | "-netdev hubport,id=str,hubid=n\n" | |
1550 | " configure a hub port on QEMU VLAN 'n'\n", QEMU_ARCH_ALL) | |
1551 | DEF("net", HAS_ARG, QEMU_OPTION_net, | |
1552 | "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" | |
1553 | " old way to create a new NIC and connect it to VLAN 'n'\n" | |
1554 | " (use the '-device devtype,netdev=str' option if possible instead)\n" | |
bb9ea79e AL |
1555 | "-net dump[,vlan=n][,file=f][,len=n]\n" |
1556 | " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n" | |
ca1a8a06 | 1557 | "-net none use it alone to have zero network devices. If no -net option\n" |
6a8b4a5b TH |
1558 | " is provided, the default is '-net nic -net user'\n" |
1559 | "-net [" | |
a1ea458f MM |
1560 | #ifdef CONFIG_SLIRP |
1561 | "user|" | |
1562 | #endif | |
1563 | "tap|" | |
a7c36ee4 | 1564 | "bridge|" |
a1ea458f MM |
1565 | #ifdef CONFIG_VDE |
1566 | "vde|" | |
58952137 VM |
1567 | #endif |
1568 | #ifdef CONFIG_NETMAP | |
1569 | "netmap|" | |
a1ea458f | 1570 | #endif |
6a8b4a5b TH |
1571 | "socket][,vlan=n][,option][,option][,...]\n" |
1572 | " old way to initialize a host network interface\n" | |
1573 | " (use the -netdev option if possible instead)\n", QEMU_ARCH_ALL) | |
5824d651 | 1574 | STEXI |
609c1dac | 1575 | @item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}] |
6616b2ad | 1576 | @findex -net |
5824d651 | 1577 | Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n} |
0d6b0b1d | 1578 | = 0 is the default). The NIC is an e1000 by default on the PC |
5607c388 MA |
1579 | target. Optionally, the MAC address can be changed to @var{mac}, the |
1580 | device address set to @var{addr} (PCI cards only), | |
ffe6370c MT |
1581 | and a @var{name} can be assigned for use in monitor commands. |
1582 | Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors | |
1583 | that the card should have; this option currently only affects virtio cards; set | |
1584 | @var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single | |
071c9394 | 1585 | NIC is created. QEMU can emulate several different models of network card. |
5824d651 | 1586 | Valid values for @var{type} are |
ffe6370c | 1587 | @code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er}, |
5824d651 BS |
1588 | @code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139}, |
1589 | @code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}. | |
585f6036 | 1590 | Not all devices are supported on all targets. Use @code{-net nic,model=help} |
5824d651 BS |
1591 | for a list of available devices for your target. |
1592 | ||
08d12022 | 1593 | @item -netdev user,id=@var{id}[,@var{option}][,@var{option}][,...] |
b8f490eb | 1594 | @findex -netdev |
ad196a9d | 1595 | @item -net user[,@var{option}][,@var{option}][,...] |
5824d651 | 1596 | Use the user mode network stack which requires no administrator |
ad196a9d JK |
1597 | privilege to run. Valid options are: |
1598 | ||
b3f046c2 | 1599 | @table @option |
ad196a9d JK |
1600 | @item vlan=@var{n} |
1601 | Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default). | |
1602 | ||
08d12022 | 1603 | @item id=@var{id} |
ad196a9d JK |
1604 | @item name=@var{name} |
1605 | Assign symbolic name for use in monitor commands. | |
1606 | ||
c92ef6a2 JK |
1607 | @item net=@var{addr}[/@var{mask}] |
1608 | Set IP network address the guest will see. Optionally specify the netmask, | |
1609 | either in the form a.b.c.d or as number of valid top-most bits. Default is | |
b0b36e5d | 1610 | 10.0.2.0/24. |
c92ef6a2 JK |
1611 | |
1612 | @item host=@var{addr} | |
1613 | Specify the guest-visible address of the host. Default is the 2nd IP in the | |
1614 | guest network, i.e. x.x.x.2. | |
ad196a9d | 1615 | |
c54ed5bc | 1616 | @item restrict=on|off |
caef55ed | 1617 | If this option is enabled, the guest will be isolated, i.e. it will not be |
ad196a9d | 1618 | able to contact the host and no guest IP packets will be routed over the host |
caef55ed | 1619 | to the outside. This option does not affect any explicitly set forwarding rules. |
ad196a9d JK |
1620 | |
1621 | @item hostname=@var{name} | |
63d2960b | 1622 | Specifies the client hostname reported by the built-in DHCP server. |
ad196a9d | 1623 | |
c92ef6a2 JK |
1624 | @item dhcpstart=@var{addr} |
1625 | Specify the first of the 16 IPs the built-in DHCP server can assign. Default | |
b0b36e5d | 1626 | is the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31. |
c92ef6a2 JK |
1627 | |
1628 | @item dns=@var{addr} | |
1629 | Specify the guest-visible address of the virtual nameserver. The address must | |
1630 | be different from the host address. Default is the 3rd IP in the guest network, | |
1631 | i.e. x.x.x.3. | |
1632 | ||
63d2960b KS |
1633 | @item dnssearch=@var{domain} |
1634 | Provides an entry for the domain-search list sent by the built-in | |
1635 | DHCP server. More than one domain suffix can be transmitted by specifying | |
1636 | this option multiple times. If supported, this will cause the guest to | |
1637 | automatically try to append the given domain suffix(es) in case a domain name | |
1638 | can not be resolved. | |
1639 | ||
1640 | Example: | |
1641 | @example | |
1642 | qemu -net user,dnssearch=mgmt.example.org,dnssearch=example.org [...] | |
1643 | @end example | |
1644 | ||
ad196a9d JK |
1645 | @item tftp=@var{dir} |
1646 | When using the user mode network stack, activate a built-in TFTP | |
1647 | server. The files in @var{dir} will be exposed as the root of a TFTP server. | |
1648 | The TFTP client on the guest must be configured in binary mode (use the command | |
c92ef6a2 | 1649 | @code{bin} of the Unix TFTP client). |
ad196a9d JK |
1650 | |
1651 | @item bootfile=@var{file} | |
1652 | When using the user mode network stack, broadcast @var{file} as the BOOTP | |
1653 | filename. In conjunction with @option{tftp}, this can be used to network boot | |
1654 | a guest from a local directory. | |
1655 | ||
1656 | Example (using pxelinux): | |
1657 | @example | |
3804da9d | 1658 | qemu-system-i386 -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0 |
ad196a9d JK |
1659 | @end example |
1660 | ||
c92ef6a2 | 1661 | @item smb=@var{dir}[,smbserver=@var{addr}] |
ad196a9d JK |
1662 | When using the user mode network stack, activate a built-in SMB |
1663 | server so that Windows OSes can access to the host files in @file{@var{dir}} | |
c92ef6a2 JK |
1664 | transparently. The IP address of the SMB server can be set to @var{addr}. By |
1665 | default the 4th IP in the guest network is used, i.e. x.x.x.4. | |
ad196a9d JK |
1666 | |
1667 | In the guest Windows OS, the line: | |
1668 | @example | |
1669 | 10.0.2.4 smbserver | |
1670 | @end example | |
1671 | must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me) | |
1672 | or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000). | |
1673 | ||
1674 | Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}. | |
1675 | ||
e2d8830e BS |
1676 | Note that a SAMBA server must be installed on the host OS. |
1677 | QEMU was tested successfully with smbd versions from Red Hat 9, | |
1678 | Fedora Core 3 and OpenSUSE 11.x. | |
ad196a9d | 1679 | |
3c6a0580 | 1680 | @item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport} |
c92ef6a2 JK |
1681 | Redirect incoming TCP or UDP connections to the host port @var{hostport} to |
1682 | the guest IP address @var{guestaddr} on guest port @var{guestport}. If | |
1683 | @var{guestaddr} is not specified, its value is x.x.x.15 (default first address | |
3c6a0580 JK |
1684 | given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can |
1685 | be bound to a specific host interface. If no connection type is set, TCP is | |
c92ef6a2 | 1686 | used. This option can be given multiple times. |
ad196a9d JK |
1687 | |
1688 | For example, to redirect host X11 connection from screen 1 to guest | |
1689 | screen 0, use the following: | |
1690 | ||
1691 | @example | |
1692 | # on the host | |
3804da9d | 1693 | qemu-system-i386 -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...] |
ad196a9d JK |
1694 | # this host xterm should open in the guest X11 server |
1695 | xterm -display :1 | |
1696 | @end example | |
1697 | ||
1698 | To redirect telnet connections from host port 5555 to telnet port on | |
1699 | the guest, use the following: | |
1700 | ||
1701 | @example | |
1702 | # on the host | |
3804da9d | 1703 | qemu-system-i386 -net user,hostfwd=tcp::5555-:23 [...] |
ad196a9d JK |
1704 | telnet localhost 5555 |
1705 | @end example | |
1706 | ||
1707 | Then when you use on the host @code{telnet localhost 5555}, you | |
1708 | connect to the guest telnet server. | |
5824d651 | 1709 | |
c92ef6a2 | 1710 | @item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev} |
b412eb61 | 1711 | @item guestfwd=[tcp]:@var{server}:@var{port}-@var{cmd:command} |
3c6a0580 | 1712 | Forward guest TCP connections to the IP address @var{server} on port @var{port} |
b412eb61 AG |
1713 | to the character device @var{dev} or to a program executed by @var{cmd:command} |
1714 | which gets spawned for each connection. This option can be given multiple times. | |
1715 | ||
43ffe61f | 1716 | You can either use a chardev directly and have that one used throughout QEMU's |
b412eb61 AG |
1717 | lifetime, like in the following example: |
1718 | ||
1719 | @example | |
1720 | # open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it whenever | |
1721 | # the guest accesses it | |
1722 | qemu -net user,guestfwd=tcp:10.0.2.100:1234-tcp:10.10.1.1:4321 [...] | |
1723 | @end example | |
1724 | ||
1725 | Or you can execute a command on every TCP connection established by the guest, | |
43ffe61f | 1726 | so that QEMU behaves similar to an inetd process for that virtual server: |
b412eb61 AG |
1727 | |
1728 | @example | |
1729 | # call "netcat 10.10.1.1 4321" on every TCP connection to 10.0.2.100:1234 | |
1730 | # and connect the TCP stream to its stdin/stdout | |
1731 | qemu -net 'user,guestfwd=tcp:10.0.2.100:1234-cmd:netcat 10.10.1.1 4321' | |
1732 | @end example | |
ad196a9d JK |
1733 | |
1734 | @end table | |
1735 | ||
1736 | Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still | |
1737 | processed and applied to -net user. Mixing them with the new configuration | |
1738 | syntax gives undefined results. Their use for new applications is discouraged | |
1739 | as they will be removed from future versions. | |
5824d651 | 1740 | |
08d12022 | 1741 | @item -netdev tap,id=@var{id}[,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}] |
a7c36ee4 CB |
1742 | @item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}] |
1743 | Connect the host TAP network interface @var{name} to VLAN @var{n}. | |
1744 | ||
1745 | Use the network script @var{file} to configure it and the network script | |
5824d651 | 1746 | @var{dfile} to deconfigure it. If @var{name} is not provided, the OS |
a7c36ee4 CB |
1747 | automatically provides one. The default network configure script is |
1748 | @file{/etc/qemu-ifup} and the default network deconfigure script is | |
1749 | @file{/etc/qemu-ifdown}. Use @option{script=no} or @option{downscript=no} | |
1750 | to disable script execution. | |
1751 | ||
1752 | If running QEMU as an unprivileged user, use the network helper | |
1753 | @var{helper} to configure the TAP interface. The default network | |
420508fb | 1754 | helper executable is @file{/path/to/qemu-bridge-helper}. |
a7c36ee4 CB |
1755 | |
1756 | @option{fd}=@var{h} can be used to specify the handle of an already | |
1757 | opened host TAP interface. | |
1758 | ||
1759 | Examples: | |
5824d651 BS |
1760 | |
1761 | @example | |
a7c36ee4 | 1762 | #launch a QEMU instance with the default network script |
3804da9d | 1763 | qemu-system-i386 linux.img -net nic -net tap |
5824d651 BS |
1764 | @end example |
1765 | ||
5824d651 | 1766 | @example |
a7c36ee4 CB |
1767 | #launch a QEMU instance with two NICs, each one connected |
1768 | #to a TAP device | |
3804da9d SW |
1769 | qemu-system-i386 linux.img \ |
1770 | -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \ | |
1771 | -net nic,vlan=1 -net tap,vlan=1,ifname=tap1 | |
5824d651 BS |
1772 | @end example |
1773 | ||
a7c36ee4 CB |
1774 | @example |
1775 | #launch a QEMU instance with the default network helper to | |
1776 | #connect a TAP device to bridge br0 | |
3804da9d | 1777 | qemu-system-i386 linux.img \ |
420508fb | 1778 | -net nic -net tap,"helper=/path/to/qemu-bridge-helper" |
a7c36ee4 CB |
1779 | @end example |
1780 | ||
08d12022 | 1781 | @item -netdev bridge,id=@var{id}[,br=@var{bridge}][,helper=@var{helper}] |
a7c36ee4 CB |
1782 | @item -net bridge[,vlan=@var{n}][,name=@var{name}][,br=@var{bridge}][,helper=@var{helper}] |
1783 | Connect a host TAP network interface to a host bridge device. | |
1784 | ||
1785 | Use the network helper @var{helper} to configure the TAP interface and | |
1786 | attach it to the bridge. The default network helper executable is | |
420508fb | 1787 | @file{/path/to/qemu-bridge-helper} and the default bridge |
a7c36ee4 CB |
1788 | device is @file{br0}. |
1789 | ||
1790 | Examples: | |
1791 | ||
1792 | @example | |
1793 | #launch a QEMU instance with the default network helper to | |
1794 | #connect a TAP device to bridge br0 | |
3804da9d | 1795 | qemu-system-i386 linux.img -net bridge -net nic,model=virtio |
a7c36ee4 CB |
1796 | @end example |
1797 | ||
1798 | @example | |
1799 | #launch a QEMU instance with the default network helper to | |
1800 | #connect a TAP device to bridge qemubr0 | |
3804da9d | 1801 | qemu-system-i386 linux.img -net bridge,br=qemubr0 -net nic,model=virtio |
a7c36ee4 CB |
1802 | @end example |
1803 | ||
08d12022 | 1804 | @item -netdev socket,id=@var{id}[,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] |
609c1dac | 1805 | @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] |
5824d651 BS |
1806 | |
1807 | Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual | |
1808 | machine using a TCP socket connection. If @option{listen} is | |
1809 | specified, QEMU waits for incoming connections on @var{port} | |
1810 | (@var{host} is optional). @option{connect} is used to connect to | |
1811 | another QEMU instance using the @option{listen} option. @option{fd}=@var{h} | |
1812 | specifies an already opened TCP socket. | |
1813 | ||
1814 | Example: | |
1815 | @example | |
1816 | # launch a first QEMU instance | |
3804da9d SW |
1817 | qemu-system-i386 linux.img \ |
1818 | -net nic,macaddr=52:54:00:12:34:56 \ | |
1819 | -net socket,listen=:1234 | |
5824d651 BS |
1820 | # connect the VLAN 0 of this instance to the VLAN 0 |
1821 | # of the first instance | |
3804da9d SW |
1822 | qemu-system-i386 linux.img \ |
1823 | -net nic,macaddr=52:54:00:12:34:57 \ | |
1824 | -net socket,connect=127.0.0.1:1234 | |
5824d651 BS |
1825 | @end example |
1826 | ||
08d12022 | 1827 | @item -netdev socket,id=@var{id}[,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] |
3a75e74c | 1828 | @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] |
5824d651 BS |
1829 | |
1830 | Create a VLAN @var{n} shared with another QEMU virtual | |
1831 | machines using a UDP multicast socket, effectively making a bus for | |
1832 | every QEMU with same multicast address @var{maddr} and @var{port}. | |
1833 | NOTES: | |
1834 | @enumerate | |
1835 | @item | |
1836 | Several QEMU can be running on different hosts and share same bus (assuming | |
1837 | correct multicast setup for these hosts). | |
1838 | @item | |
1839 | mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see | |
1840 | @url{http://user-mode-linux.sf.net}. | |
1841 | @item | |
1842 | Use @option{fd=h} to specify an already opened UDP multicast socket. | |
1843 | @end enumerate | |
1844 | ||
1845 | Example: | |
1846 | @example | |
1847 | # launch one QEMU instance | |
3804da9d SW |
1848 | qemu-system-i386 linux.img \ |
1849 | -net nic,macaddr=52:54:00:12:34:56 \ | |
1850 | -net socket,mcast=230.0.0.1:1234 | |
5824d651 | 1851 | # launch another QEMU instance on same "bus" |
3804da9d SW |
1852 | qemu-system-i386 linux.img \ |
1853 | -net nic,macaddr=52:54:00:12:34:57 \ | |
1854 | -net socket,mcast=230.0.0.1:1234 | |
5824d651 | 1855 | # launch yet another QEMU instance on same "bus" |
3804da9d SW |
1856 | qemu-system-i386 linux.img \ |
1857 | -net nic,macaddr=52:54:00:12:34:58 \ | |
1858 | -net socket,mcast=230.0.0.1:1234 | |
5824d651 BS |
1859 | @end example |
1860 | ||
1861 | Example (User Mode Linux compat.): | |
1862 | @example | |
1863 | # launch QEMU instance (note mcast address selected | |
1864 | # is UML's default) | |
3804da9d SW |
1865 | qemu-system-i386 linux.img \ |
1866 | -net nic,macaddr=52:54:00:12:34:56 \ | |
1867 | -net socket,mcast=239.192.168.1:1102 | |
5824d651 BS |
1868 | # launch UML |
1869 | /path/to/linux ubd0=/path/to/root_fs eth0=mcast | |
1870 | @end example | |
1871 | ||
3a75e74c MR |
1872 | Example (send packets from host's 1.2.3.4): |
1873 | @example | |
3804da9d SW |
1874 | qemu-system-i386 linux.img \ |
1875 | -net nic,macaddr=52:54:00:12:34:56 \ | |
1876 | -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4 | |
3a75e74c MR |
1877 | @end example |
1878 | ||
3fb69aa1 AI |
1879 | @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}] |
1880 | @item -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}] | |
1881 | Connect VLAN @var{n} to L2TPv3 pseudowire. L2TPv3 (RFC3391) is a popular | |
1882 | protocol to transport Ethernet (and other Layer 2) data frames between | |
1883 | two systems. It is present in routers, firewalls and the Linux kernel | |
1884 | (from version 3.3 onwards). | |
1885 | ||
1886 | This transport allows a VM to communicate to another VM, router or firewall directly. | |
1887 | ||
1888 | @item src=@var{srcaddr} | |
1889 | source address (mandatory) | |
1890 | @item dst=@var{dstaddr} | |
1891 | destination address (mandatory) | |
1892 | @item udp | |
1893 | select udp encapsulation (default is ip). | |
1894 | @item srcport=@var{srcport} | |
1895 | source udp port. | |
1896 | @item dstport=@var{dstport} | |
1897 | destination udp port. | |
1898 | @item ipv6 | |
1899 | force v6, otherwise defaults to v4. | |
1900 | @item rxcookie=@var{rxcookie} | |
1901 | @item txcookie=@var{txcookie} | |
1902 | Cookies are a weak form of security in the l2tpv3 specification. | |
1903 | Their function is mostly to prevent misconfiguration. By default they are 32 | |
1904 | bit. | |
1905 | @item cookie64 | |
1906 | Set cookie size to 64 bit instead of the default 32 | |
1907 | @item counter=off | |
1908 | Force a 'cut-down' L2TPv3 with no counter as in | |
1909 | draft-mkonstan-l2tpext-keyed-ipv6-tunnel-00 | |
1910 | @item pincounter=on | |
1911 | Work around broken counter handling in peer. This may also help on | |
1912 | networks which have packet reorder. | |
1913 | @item offset=@var{offset} | |
1914 | Add an extra offset between header and data | |
1915 | ||
1916 | For example, to attach a VM running on host 4.3.2.1 via L2TPv3 to the bridge br-lan | |
1917 | on the remote Linux host 1.2.3.4: | |
1918 | @example | |
1919 | # Setup tunnel on linux host using raw ip as encapsulation | |
1920 | # on 1.2.3.4 | |
1921 | ip l2tp add tunnel remote 4.3.2.1 local 1.2.3.4 tunnel_id 1 peer_tunnel_id 1 \ | |
1922 | encap udp udp_sport 16384 udp_dport 16384 | |
1923 | ip l2tp add session tunnel_id 1 name vmtunnel0 session_id \ | |
1924 | 0xFFFFFFFF peer_session_id 0xFFFFFFFF | |
1925 | ifconfig vmtunnel0 mtu 1500 | |
1926 | ifconfig vmtunnel0 up | |
1927 | brctl addif br-lan vmtunnel0 | |
1928 | ||
1929 | ||
1930 | # on 4.3.2.1 | |
1931 | # launch QEMU instance - if your network has reorder or is very lossy add ,pincounter | |
1932 | ||
1933 | qemu-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 | |
1934 | ||
1935 | ||
1936 | @end example | |
1937 | ||
08d12022 | 1938 | @item -netdev vde,id=@var{id}[,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] |
609c1dac | 1939 | @item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] |
5824d651 BS |
1940 | Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and |
1941 | listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname} | |
1942 | and MODE @var{octalmode} to change default ownership and permissions for | |
c1ba4e0b | 1943 | communication port. This option is only available if QEMU has been compiled |
5824d651 BS |
1944 | with vde support enabled. |
1945 | ||
1946 | Example: | |
1947 | @example | |
1948 | # launch vde switch | |
1949 | vde_switch -F -sock /tmp/myswitch | |
1950 | # launch QEMU instance | |
3804da9d | 1951 | qemu-system-i386 linux.img -net nic -net vde,sock=/tmp/myswitch |
5824d651 BS |
1952 | @end example |
1953 | ||
40e8c26d SH |
1954 | @item -netdev hubport,id=@var{id},hubid=@var{hubid} |
1955 | ||
1956 | Create a hub port on QEMU "vlan" @var{hubid}. | |
1957 | ||
1958 | The hubport netdev lets you connect a NIC to a QEMU "vlan" instead of a single | |
1959 | netdev. @code{-net} and @code{-device} with parameter @option{vlan} create the | |
1960 | required hub automatically. | |
1961 | ||
830d70db | 1962 | @item -netdev vhost-user,chardev=@var{id}[,vhostforce=on|off][,queues=n] |
03ce5744 NN |
1963 | |
1964 | Establish a vhost-user netdev, backed by a chardev @var{id}. The chardev should | |
1965 | be a unix domain socket backed one. The vhost-user uses a specifically defined | |
1966 | protocol to pass vhost ioctl replacement messages to an application on the other | |
1967 | end of the socket. On non-MSIX guests, the feature can be forced with | |
830d70db OC |
1968 | @var{vhostforce}. Use 'queues=@var{n}' to specify the number of queues to |
1969 | be created for multiqueue vhost-user. | |
03ce5744 NN |
1970 | |
1971 | Example: | |
1972 | @example | |
1973 | qemu -m 512 -object memory-backend-file,id=mem,size=512M,mem-path=/hugetlbfs,share=on \ | |
1974 | -numa node,memdev=mem \ | |
1975 | -chardev socket,path=/path/to/socket \ | |
1976 | -netdev type=vhost-user,id=net0,chardev=chr0 \ | |
1977 | -device virtio-net-pci,netdev=net0 | |
1978 | @end example | |
1979 | ||
bb9ea79e AL |
1980 | @item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}] |
1981 | Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default). | |
1982 | At most @var{len} bytes (64k by default) per packet are stored. The file format is | |
1983 | libpcap, so it can be analyzed with tools such as tcpdump or Wireshark. | |
1984 | ||
5824d651 BS |
1985 | @item -net none |
1986 | Indicate that no network devices should be configured. It is used to | |
1987 | override the default configuration (@option{-net nic -net user}) which | |
1988 | is activated if no @option{-net} options are provided. | |
c70a01e4 | 1989 | ETEXI |
5824d651 | 1990 | |
c70a01e4 | 1991 | STEXI |
5824d651 BS |
1992 | @end table |
1993 | ETEXI | |
7273a2db MB |
1994 | DEFHEADING() |
1995 | ||
1996 | DEFHEADING(Character device options:) | |
c70a01e4 MA |
1997 | STEXI |
1998 | ||
1999 | The general form of a character device option is: | |
2000 | @table @option | |
2001 | ETEXI | |
7273a2db MB |
2002 | |
2003 | DEF("chardev", HAS_ARG, QEMU_OPTION_chardev, | |
97331287 | 2004 | "-chardev null,id=id[,mux=on|off]\n" |
5dd1f02b CM |
2005 | "-chardev socket,id=id[,host=host],port=port[,to=to][,ipv4][,ipv6][,nodelay][,reconnect=seconds]\n" |
2006 | " [,server][,nowait][,telnet][,reconnect=seconds][,mux=on|off] (tcp)\n" | |
2007 | "-chardev socket,id=id,path=path[,server][,nowait][,telnet][,reconnect=seconds][,mux=on|off] (unix)\n" | |
7273a2db | 2008 | "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n" |
97331287 JK |
2009 | " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n" |
2010 | "-chardev msmouse,id=id[,mux=on|off]\n" | |
7273a2db | 2011 | "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n" |
97331287 | 2012 | " [,mux=on|off]\n" |
4f57378f | 2013 | "-chardev ringbuf,id=id[,size=size]\n" |
97331287 JK |
2014 | "-chardev file,id=id,path=path[,mux=on|off]\n" |
2015 | "-chardev pipe,id=id,path=path[,mux=on|off]\n" | |
7273a2db | 2016 | #ifdef _WIN32 |
97331287 JK |
2017 | "-chardev console,id=id[,mux=on|off]\n" |
2018 | "-chardev serial,id=id,path=path[,mux=on|off]\n" | |
7273a2db | 2019 | #else |
97331287 | 2020 | "-chardev pty,id=id[,mux=on|off]\n" |
b7fdb3ab | 2021 | "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n" |
7273a2db MB |
2022 | #endif |
2023 | #ifdef CONFIG_BRLAPI | |
97331287 | 2024 | "-chardev braille,id=id[,mux=on|off]\n" |
7273a2db MB |
2025 | #endif |
2026 | #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \ | |
2027 | || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) | |
d59044ef | 2028 | "-chardev serial,id=id,path=path[,mux=on|off]\n" |
97331287 | 2029 | "-chardev tty,id=id,path=path[,mux=on|off]\n" |
7273a2db MB |
2030 | #endif |
2031 | #if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__) | |
88a946d3 | 2032 | "-chardev parallel,id=id,path=path[,mux=on|off]\n" |
97331287 | 2033 | "-chardev parport,id=id,path=path[,mux=on|off]\n" |
cbcc6336 AL |
2034 | #endif |
2035 | #if defined(CONFIG_SPICE) | |
2036 | "-chardev spicevmc,id=id,name=name[,debug=debug]\n" | |
5a49d3e9 | 2037 | "-chardev spiceport,id=id,name=name[,debug=debug]\n" |
7273a2db | 2038 | #endif |
ad96090a | 2039 | , QEMU_ARCH_ALL |
7273a2db MB |
2040 | ) |
2041 | ||
2042 | STEXI | |
97331287 | 2043 | @item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}] |
6616b2ad | 2044 | @findex -chardev |
7273a2db MB |
2045 | Backend is one of: |
2046 | @option{null}, | |
2047 | @option{socket}, | |
2048 | @option{udp}, | |
2049 | @option{msmouse}, | |
2050 | @option{vc}, | |
4f57378f | 2051 | @option{ringbuf}, |
7273a2db MB |
2052 | @option{file}, |
2053 | @option{pipe}, | |
2054 | @option{console}, | |
2055 | @option{serial}, | |
2056 | @option{pty}, | |
2057 | @option{stdio}, | |
2058 | @option{braille}, | |
2059 | @option{tty}, | |
88a946d3 | 2060 | @option{parallel}, |
cbcc6336 AL |
2061 | @option{parport}, |
2062 | @option{spicevmc}. | |
5a49d3e9 | 2063 | @option{spiceport}. |
7273a2db MB |
2064 | The specific backend will determine the applicable options. |
2065 | ||
2066 | All devices must have an id, which can be any string up to 127 characters long. | |
2067 | It is used to uniquely identify this device in other command line directives. | |
2068 | ||
97331287 JK |
2069 | A character device may be used in multiplexing mode by multiple front-ends. |
2070 | The key sequence of @key{Control-a} and @key{c} will rotate the input focus | |
2071 | between attached front-ends. Specify @option{mux=on} to enable this mode. | |
2072 | ||
7273a2db MB |
2073 | Options to each backend are described below. |
2074 | ||
2075 | @item -chardev null ,id=@var{id} | |
2076 | A void device. This device will not emit any data, and will drop any data it | |
2077 | receives. The null backend does not take any options. | |
2078 | ||
5dd1f02b | 2079 | @item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet] [,reconnect=@var{seconds}] |
7273a2db MB |
2080 | |
2081 | Create a two-way stream socket, which can be either a TCP or a unix socket. A | |
2082 | unix socket will be created if @option{path} is specified. Behaviour is | |
2083 | undefined if TCP options are specified for a unix socket. | |
2084 | ||
2085 | @option{server} specifies that the socket shall be a listening socket. | |
2086 | ||
2087 | @option{nowait} specifies that QEMU should not block waiting for a client to | |
2088 | connect to a listening socket. | |
2089 | ||
2090 | @option{telnet} specifies that traffic on the socket should interpret telnet | |
2091 | escape sequences. | |
2092 | ||
5dd1f02b CM |
2093 | @option{reconnect} sets the timeout for reconnecting on non-server sockets when |
2094 | the remote end goes away. qemu will delay this many seconds and then attempt | |
2095 | to reconnect. Zero disables reconnecting, and is the default. | |
2096 | ||
7273a2db MB |
2097 | TCP and unix socket options are given below: |
2098 | ||
2099 | @table @option | |
2100 | ||
8d533561 | 2101 | @item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay] |
7273a2db MB |
2102 | |
2103 | @option{host} for a listening socket specifies the local address to be bound. | |
2104 | For a connecting socket species the remote host to connect to. @option{host} is | |
2105 | optional for listening sockets. If not specified it defaults to @code{0.0.0.0}. | |
2106 | ||
2107 | @option{port} for a listening socket specifies the local port to be bound. For a | |
2108 | connecting socket specifies the port on the remote host to connect to. | |
2109 | @option{port} can be given as either a port number or a service name. | |
2110 | @option{port} is required. | |
2111 | ||
2112 | @option{to} is only relevant to listening sockets. If it is specified, and | |
2113 | @option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up | |
2114 | to and including @option{to} until it succeeds. @option{to} must be specified | |
2115 | as a port number. | |
2116 | ||
2117 | @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. | |
2118 | If neither is specified the socket may use either protocol. | |
2119 | ||
2120 | @option{nodelay} disables the Nagle algorithm. | |
2121 | ||
2122 | @item unix options: path=@var{path} | |
2123 | ||
2124 | @option{path} specifies the local path of the unix socket. @option{path} is | |
2125 | required. | |
2126 | ||
2127 | @end table | |
2128 | ||
2129 | @item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6] | |
2130 | ||
2131 | Sends all traffic from the guest to a remote host over UDP. | |
2132 | ||
2133 | @option{host} specifies the remote host to connect to. If not specified it | |
2134 | defaults to @code{localhost}. | |
2135 | ||
2136 | @option{port} specifies the port on the remote host to connect to. @option{port} | |
2137 | is required. | |
2138 | ||
2139 | @option{localaddr} specifies the local address to bind to. If not specified it | |
2140 | defaults to @code{0.0.0.0}. | |
2141 | ||
2142 | @option{localport} specifies the local port to bind to. If not specified any | |
2143 | available local port will be used. | |
2144 | ||
2145 | @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. | |
2146 | If neither is specified the device may use either protocol. | |
2147 | ||
2148 | @item -chardev msmouse ,id=@var{id} | |
2149 | ||
2150 | Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not | |
2151 | take any options. | |
2152 | ||
2153 | @item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]] | |
2154 | ||
2155 | Connect to a QEMU text console. @option{vc} may optionally be given a specific | |
2156 | size. | |
2157 | ||
2158 | @option{width} and @option{height} specify the width and height respectively of | |
2159 | the console, in pixels. | |
2160 | ||
2161 | @option{cols} and @option{rows} specify that the console be sized to fit a text | |
2162 | console with the given dimensions. | |
2163 | ||
4f57378f | 2164 | @item -chardev ringbuf ,id=@var{id} [,size=@var{size}] |
51767e7c | 2165 | |
3949e594 MA |
2166 | Create a ring buffer with fixed size @option{size}. |
2167 | @var{size} must be a power of two, and defaults to @code{64K}). | |
51767e7c | 2168 | |
7273a2db MB |
2169 | @item -chardev file ,id=@var{id} ,path=@var{path} |
2170 | ||
2171 | Log all traffic received from the guest to a file. | |
2172 | ||
2173 | @option{path} specifies the path of the file to be opened. This file will be | |
2174 | created if it does not already exist, and overwritten if it does. @option{path} | |
2175 | is required. | |
2176 | ||
2177 | @item -chardev pipe ,id=@var{id} ,path=@var{path} | |
2178 | ||
2179 | Create a two-way connection to the guest. The behaviour differs slightly between | |
2180 | Windows hosts and other hosts: | |
2181 | ||
2182 | On Windows, a single duplex pipe will be created at | |
2183 | @file{\\.pipe\@option{path}}. | |
2184 | ||
2185 | On other hosts, 2 pipes will be created called @file{@option{path}.in} and | |
2186 | @file{@option{path}.out}. Data written to @file{@option{path}.in} will be | |
2187 | received by the guest. Data written by the guest can be read from | |
2188 | @file{@option{path}.out}. QEMU will not create these fifos, and requires them to | |
2189 | be present. | |
2190 | ||
2191 | @option{path} forms part of the pipe path as described above. @option{path} is | |
2192 | required. | |
2193 | ||
2194 | @item -chardev console ,id=@var{id} | |
2195 | ||
2196 | Send traffic from the guest to QEMU's standard output. @option{console} does not | |
2197 | take any options. | |
2198 | ||
2199 | @option{console} is only available on Windows hosts. | |
2200 | ||
2201 | @item -chardev serial ,id=@var{id} ,path=@option{path} | |
2202 | ||
2203 | Send traffic from the guest to a serial device on the host. | |
2204 | ||
d59044ef GH |
2205 | On Unix hosts serial will actually accept any tty device, |
2206 | not only serial lines. | |
7273a2db MB |
2207 | |
2208 | @option{path} specifies the name of the serial device to open. | |
2209 | ||
2210 | @item -chardev pty ,id=@var{id} | |
2211 | ||
2212 | Create a new pseudo-terminal on the host and connect to it. @option{pty} does | |
2213 | not take any options. | |
2214 | ||
2215 | @option{pty} is not available on Windows hosts. | |
2216 | ||
b7fdb3ab | 2217 | @item -chardev stdio ,id=@var{id} [,signal=on|off] |
b65ee4fa | 2218 | Connect to standard input and standard output of the QEMU process. |
b7fdb3ab AJ |
2219 | |
2220 | @option{signal} controls if signals are enabled on the terminal, that includes | |
2221 | exiting QEMU with the key sequence @key{Control-c}. This option is enabled by | |
2222 | default, use @option{signal=off} to disable it. | |
2223 | ||
2224 | @option{stdio} is not available on Windows hosts. | |
7273a2db MB |
2225 | |
2226 | @item -chardev braille ,id=@var{id} | |
2227 | ||
2228 | Connect to a local BrlAPI server. @option{braille} does not take any options. | |
2229 | ||
2230 | @item -chardev tty ,id=@var{id} ,path=@var{path} | |
2231 | ||
7273a2db | 2232 | @option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and |
d037d6bb | 2233 | DragonFlyBSD hosts. It is an alias for @option{serial}. |
7273a2db MB |
2234 | |
2235 | @option{path} specifies the path to the tty. @option{path} is required. | |
2236 | ||
88a946d3 | 2237 | @item -chardev parallel ,id=@var{id} ,path=@var{path} |
7273a2db MB |
2238 | @item -chardev parport ,id=@var{id} ,path=@var{path} |
2239 | ||
88a946d3 | 2240 | @option{parallel} is only available on Linux, FreeBSD and DragonFlyBSD hosts. |
7273a2db MB |
2241 | |
2242 | Connect to a local parallel port. | |
2243 | ||
2244 | @option{path} specifies the path to the parallel port device. @option{path} is | |
2245 | required. | |
2246 | ||
cbcc6336 AL |
2247 | @item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name} |
2248 | ||
3a846906 SH |
2249 | @option{spicevmc} is only available when spice support is built in. |
2250 | ||
cbcc6336 AL |
2251 | @option{debug} debug level for spicevmc |
2252 | ||
2253 | @option{name} name of spice channel to connect to | |
2254 | ||
2255 | Connect to a spice virtual machine channel, such as vdiport. | |
cbcc6336 | 2256 | |
5a49d3e9 MAL |
2257 | @item -chardev spiceport ,id=@var{id} ,debug=@var{debug}, name=@var{name} |
2258 | ||
2259 | @option{spiceport} is only available when spice support is built in. | |
2260 | ||
2261 | @option{debug} debug level for spicevmc | |
2262 | ||
2263 | @option{name} name of spice port to connect to | |
2264 | ||
2265 | Connect to a spice port, allowing a Spice client to handle the traffic | |
2266 | identified by a name (preferably a fqdn). | |
c70a01e4 | 2267 | ETEXI |
5a49d3e9 | 2268 | |
c70a01e4 | 2269 | STEXI |
7273a2db MB |
2270 | @end table |
2271 | ETEXI | |
7273a2db MB |
2272 | DEFHEADING() |
2273 | ||
0f5314a2 | 2274 | DEFHEADING(Device URL Syntax:) |
c70a01e4 | 2275 | STEXI |
0f5314a2 RS |
2276 | |
2277 | In addition to using normal file images for the emulated storage devices, | |
2278 | QEMU can also use networked resources such as iSCSI devices. These are | |
2279 | specified using a special URL syntax. | |
2280 | ||
2281 | @table @option | |
2282 | @item iSCSI | |
2283 | iSCSI support allows QEMU to access iSCSI resources directly and use as | |
2284 | images for the guest storage. Both disk and cdrom images are supported. | |
2285 | ||
2286 | Syntax for specifying iSCSI LUNs is | |
2287 | ``iscsi://<target-ip>[:<port>]/<target-iqn>/<lun>'' | |
2288 | ||
31459f46 RS |
2289 | By default qemu will use the iSCSI initiator-name |
2290 | 'iqn.2008-11.org.linux-kvm[:<name>]' but this can also be set from the command | |
2291 | line or a configuration file. | |
2292 | ||
2293 | ||
0f5314a2 RS |
2294 | Example (without authentication): |
2295 | @example | |
3804da9d SW |
2296 | qemu-system-i386 -iscsi initiator-name=iqn.2001-04.com.example:my-initiator \ |
2297 | -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \ | |
2298 | -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 | |
0f5314a2 RS |
2299 | @end example |
2300 | ||
2301 | Example (CHAP username/password via URL): | |
2302 | @example | |
3804da9d | 2303 | qemu-system-i386 -drive file=iscsi://user%password@@192.0.2.1/iqn.2001-04.com.example/1 |
0f5314a2 RS |
2304 | @end example |
2305 | ||
2306 | Example (CHAP username/password via environment variables): | |
2307 | @example | |
2308 | LIBISCSI_CHAP_USERNAME="user" \ | |
2309 | LIBISCSI_CHAP_PASSWORD="password" \ | |
3804da9d | 2310 | qemu-system-i386 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 |
0f5314a2 RS |
2311 | @end example |
2312 | ||
2313 | iSCSI support is an optional feature of QEMU and only available when | |
2314 | compiled and linked against libiscsi. | |
f9dadc98 RS |
2315 | ETEXI |
2316 | DEF("iscsi", HAS_ARG, QEMU_OPTION_iscsi, | |
2317 | "-iscsi [user=user][,password=password]\n" | |
2318 | " [,header-digest=CRC32C|CR32C-NONE|NONE-CRC32C|NONE\n" | |
2fe3798c | 2319 | " [,initiator-name=initiator-iqn][,id=target-iqn]\n" |
f9dadc98 RS |
2320 | " iSCSI session parameters\n", QEMU_ARCH_ALL) |
2321 | STEXI | |
0f5314a2 | 2322 | |
31459f46 RS |
2323 | iSCSI parameters such as username and password can also be specified via |
2324 | a configuration file. See qemu-doc for more information and examples. | |
2325 | ||
08ae330e RS |
2326 | @item NBD |
2327 | QEMU supports NBD (Network Block Devices) both using TCP protocol as well | |
2328 | as Unix Domain Sockets. | |
2329 | ||
2330 | Syntax for specifying a NBD device using TCP | |
2331 | ``nbd:<server-ip>:<port>[:exportname=<export>]'' | |
2332 | ||
2333 | Syntax for specifying a NBD device using Unix Domain Sockets | |
2334 | ``nbd:unix:<domain-socket>[:exportname=<export>]'' | |
2335 | ||
2336 | ||
2337 | Example for TCP | |
2338 | @example | |
3804da9d | 2339 | qemu-system-i386 --drive file=nbd:192.0.2.1:30000 |
08ae330e RS |
2340 | @end example |
2341 | ||
2342 | Example for Unix Domain Sockets | |
2343 | @example | |
3804da9d | 2344 | qemu-system-i386 --drive file=nbd:unix:/tmp/nbd-socket |
08ae330e RS |
2345 | @end example |
2346 | ||
0a12ec87 RJ |
2347 | @item SSH |
2348 | QEMU supports SSH (Secure Shell) access to remote disks. | |
2349 | ||
2350 | Examples: | |
2351 | @example | |
2352 | qemu-system-i386 -drive file=ssh://user@@host/path/to/disk.img | |
2353 | qemu-system-i386 -drive file.driver=ssh,file.user=user,file.host=host,file.port=22,file.path=/path/to/disk.img | |
2354 | @end example | |
2355 | ||
2356 | Currently authentication must be done using ssh-agent. Other | |
2357 | authentication methods may be supported in future. | |
2358 | ||
d9990228 RS |
2359 | @item Sheepdog |
2360 | Sheepdog is a distributed storage system for QEMU. | |
2361 | QEMU supports using either local sheepdog devices or remote networked | |
2362 | devices. | |
2363 | ||
2364 | Syntax for specifying a sheepdog device | |
5d6768e3 | 2365 | @example |
1b8bbb46 | 2366 | sheepdog[+tcp|+unix]://[host:port]/vdiname[?socket=path][#snapid|#tag] |
5d6768e3 | 2367 | @end example |
d9990228 RS |
2368 | |
2369 | Example | |
2370 | @example | |
5d6768e3 | 2371 | qemu-system-i386 --drive file=sheepdog://192.0.2.1:30000/MyVirtualMachine |
d9990228 RS |
2372 | @end example |
2373 | ||
2374 | See also @url{http://http://www.osrg.net/sheepdog/}. | |
2375 | ||
8809e289 BR |
2376 | @item GlusterFS |
2377 | GlusterFS is an user space distributed file system. | |
2378 | QEMU supports the use of GlusterFS volumes for hosting VM disk images using | |
2379 | TCP, Unix Domain Sockets and RDMA transport protocols. | |
2380 | ||
2381 | Syntax for specifying a VM disk image on GlusterFS volume is | |
2382 | @example | |
2383 | gluster[+transport]://[server[:port]]/volname/image[?socket=...] | |
2384 | @end example | |
2385 | ||
2386 | ||
2387 | Example | |
2388 | @example | |
db2d5eba | 2389 | qemu-system-x86_64 --drive file=gluster://192.0.2.1/testvol/a.img |
8809e289 BR |
2390 | @end example |
2391 | ||
2392 | See also @url{http://www.gluster.org}. | |
0a86cb73 MB |
2393 | |
2394 | @item HTTP/HTTPS/FTP/FTPS/TFTP | |
2395 | QEMU supports read-only access to files accessed over http(s), ftp(s) and tftp. | |
2396 | ||
2397 | Syntax using a single filename: | |
2398 | @example | |
2399 | <protocol>://[<username>[:<password>]@@]<host>/<path> | |
2400 | @end example | |
2401 | ||
2402 | where: | |
2403 | @table @option | |
2404 | @item protocol | |
2405 | 'http', 'https', 'ftp', 'ftps', or 'tftp'. | |
2406 | ||
2407 | @item username | |
2408 | Optional username for authentication to the remote server. | |
2409 | ||
2410 | @item password | |
2411 | Optional password for authentication to the remote server. | |
2412 | ||
2413 | @item host | |
2414 | Address of the remote server. | |
2415 | ||
2416 | @item path | |
2417 | Path on the remote server, including any query string. | |
2418 | @end table | |
2419 | ||
2420 | The following options are also supported: | |
2421 | @table @option | |
2422 | @item url | |
2423 | The full URL when passing options to the driver explicitly. | |
2424 | ||
2425 | @item readahead | |
2426 | The amount of data to read ahead with each range request to the remote server. | |
2427 | This value may optionally have the suffix 'T', 'G', 'M', 'K', 'k' or 'b'. If it | |
2428 | does not have a suffix, it will be assumed to be in bytes. The value must be a | |
2429 | multiple of 512 bytes. It defaults to 256k. | |
2430 | ||
2431 | @item sslverify | |
2432 | Whether to verify the remote server's certificate when connecting over SSL. It | |
2433 | can have the value 'on' or 'off'. It defaults to 'on'. | |
212aefaa | 2434 | |
a94f83d9 RJ |
2435 | @item cookie |
2436 | Send this cookie (it can also be a list of cookies separated by ';') with | |
2437 | each outgoing request. Only supported when using protocols such as HTTP | |
2438 | which support cookies, otherwise ignored. | |
2439 | ||
212aefaa DHB |
2440 | @item timeout |
2441 | Set the timeout in seconds of the CURL connection. This timeout is the time | |
2442 | that CURL waits for a response from the remote server to get the size of the | |
2443 | image to be downloaded. If not set, the default timeout of 5 seconds is used. | |
0a86cb73 MB |
2444 | @end table |
2445 | ||
2446 | Note that when passing options to qemu explicitly, @option{driver} is the value | |
2447 | of <protocol>. | |
2448 | ||
2449 | Example: boot from a remote Fedora 20 live ISO image | |
2450 | @example | |
2451 | qemu-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 | |
2452 | ||
2453 | qemu-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 | |
2454 | @end example | |
2455 | ||
2456 | Example: boot from a remote Fedora 20 cloud image using a local overlay for | |
2457 | writes, copy-on-read, and a readahead of 64k | |
2458 | @example | |
2459 | qemu-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 | |
2460 | ||
2461 | qemu-system-x86_64 -drive file=/tmp/Fedora-x86_64-20-20131211.1-sda.qcow2,copy-on-read=on | |
2462 | @end example | |
2463 | ||
2464 | Example: boot from an image stored on a VMware vSphere server with a self-signed | |
212aefaa DHB |
2465 | certificate using a local overlay for writes, a readahead of 64k and a timeout |
2466 | of 10 seconds. | |
0a86cb73 | 2467 | @example |
212aefaa | 2468 | qemu-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 |
0a86cb73 MB |
2469 | |
2470 | qemu-system-x86_64 -drive file=/tmp/test.qcow2 | |
2471 | @end example | |
c70a01e4 MA |
2472 | ETEXI |
2473 | ||
2474 | STEXI | |
0f5314a2 RS |
2475 | @end table |
2476 | ETEXI | |
2477 | ||
7273a2db | 2478 | DEFHEADING(Bluetooth(R) options:) |
c70a01e4 MA |
2479 | STEXI |
2480 | @table @option | |
2481 | ETEXI | |
7273a2db | 2482 | |
5824d651 | 2483 | DEF("bt", HAS_ARG, QEMU_OPTION_bt, \ |
5824d651 BS |
2484 | "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \ |
2485 | "-bt hci,host[:id]\n" \ | |
2486 | " use host's HCI with the given name\n" \ | |
2487 | "-bt hci[,vlan=n]\n" \ | |
2488 | " emulate a standard HCI in virtual scatternet 'n'\n" \ | |
2489 | "-bt vhci[,vlan=n]\n" \ | |
2490 | " add host computer to virtual scatternet 'n' using VHCI\n" \ | |
2491 | "-bt device:dev[,vlan=n]\n" \ | |
ad96090a BS |
2492 | " emulate a bluetooth device 'dev' in scatternet 'n'\n", |
2493 | QEMU_ARCH_ALL) | |
5824d651 | 2494 | STEXI |
5824d651 | 2495 | @item -bt hci[...] |
6616b2ad | 2496 | @findex -bt |
5824d651 BS |
2497 | Defines the function of the corresponding Bluetooth HCI. -bt options |
2498 | are matched with the HCIs present in the chosen machine type. For | |
2499 | example when emulating a machine with only one HCI built into it, only | |
2500 | the first @code{-bt hci[...]} option is valid and defines the HCI's | |
2501 | logic. The Transport Layer is decided by the machine type. Currently | |
2502 | the machines @code{n800} and @code{n810} have one HCI and all other | |
2503 | machines have none. | |
2504 | ||
2505 | @anchor{bt-hcis} | |
2506 | The following three types are recognized: | |
2507 | ||
b3f046c2 | 2508 | @table @option |
5824d651 BS |
2509 | @item -bt hci,null |
2510 | (default) The corresponding Bluetooth HCI assumes no internal logic | |
2511 | and will not respond to any HCI commands or emit events. | |
2512 | ||
2513 | @item -bt hci,host[:@var{id}] | |
2514 | (@code{bluez} only) The corresponding HCI passes commands / events | |
2515 | to / from the physical HCI identified by the name @var{id} (default: | |
2516 | @code{hci0}) on the computer running QEMU. Only available on @code{bluez} | |
2517 | capable systems like Linux. | |
2518 | ||
2519 | @item -bt hci[,vlan=@var{n}] | |
2520 | Add a virtual, standard HCI that will participate in the Bluetooth | |
2521 | scatternet @var{n} (default @code{0}). Similarly to @option{-net} | |
2522 | VLANs, devices inside a bluetooth network @var{n} can only communicate | |
2523 | with other devices in the same network (scatternet). | |
2524 | @end table | |
2525 | ||
2526 | @item -bt vhci[,vlan=@var{n}] | |
2527 | (Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached | |
2528 | to the host bluetooth stack instead of to the emulated target. This | |
2529 | allows the host and target machines to participate in a common scatternet | |
2530 | and communicate. Requires the Linux @code{vhci} driver installed. Can | |
2531 | be used as following: | |
2532 | ||
2533 | @example | |
3804da9d | 2534 | qemu-system-i386 [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5 |
5824d651 BS |
2535 | @end example |
2536 | ||
2537 | @item -bt device:@var{dev}[,vlan=@var{n}] | |
2538 | Emulate a bluetooth device @var{dev} and place it in network @var{n} | |
2539 | (default @code{0}). QEMU can only emulate one type of bluetooth devices | |
2540 | currently: | |
2541 | ||
b3f046c2 | 2542 | @table @option |
5824d651 BS |
2543 | @item keyboard |
2544 | Virtual wireless keyboard implementing the HIDP bluetooth profile. | |
2545 | @end table | |
5824d651 BS |
2546 | ETEXI |
2547 | ||
c70a01e4 MA |
2548 | STEXI |
2549 | @end table | |
2550 | ETEXI | |
5824d651 BS |
2551 | DEFHEADING() |
2552 | ||
d1a0cf73 SB |
2553 | #ifdef CONFIG_TPM |
2554 | DEFHEADING(TPM device options:) | |
2555 | ||
2556 | DEF("tpmdev", HAS_ARG, QEMU_OPTION_tpmdev, \ | |
92dcc234 SB |
2557 | "-tpmdev passthrough,id=id[,path=path][,cancel-path=path]\n" |
2558 | " use path to provide path to a character device; default is /dev/tpm0\n" | |
2559 | " use cancel-path to provide path to TPM's cancel sysfs entry; if\n" | |
2560 | " not provided it will be searched for in /sys/class/misc/tpm?/device\n", | |
d1a0cf73 SB |
2561 | QEMU_ARCH_ALL) |
2562 | STEXI | |
2563 | ||
2564 | The general form of a TPM device option is: | |
2565 | @table @option | |
2566 | ||
2567 | @item -tpmdev @var{backend} ,id=@var{id} [,@var{options}] | |
2568 | @findex -tpmdev | |
2569 | Backend type must be: | |
4549a8b7 | 2570 | @option{passthrough}. |
d1a0cf73 SB |
2571 | |
2572 | The specific backend type will determine the applicable options. | |
28c4fa32 CB |
2573 | The @code{-tpmdev} option creates the TPM backend and requires a |
2574 | @code{-device} option that specifies the TPM frontend interface model. | |
d1a0cf73 SB |
2575 | |
2576 | Options to each backend are described below. | |
2577 | ||
2578 | Use 'help' to print all available TPM backend types. | |
2579 | @example | |
2580 | qemu -tpmdev help | |
2581 | @end example | |
2582 | ||
92dcc234 | 2583 | @item -tpmdev passthrough, id=@var{id}, path=@var{path}, cancel-path=@var{cancel-path} |
4549a8b7 SB |
2584 | |
2585 | (Linux-host only) Enable access to the host's TPM using the passthrough | |
2586 | driver. | |
2587 | ||
2588 | @option{path} specifies the path to the host's TPM device, i.e., on | |
2589 | a Linux host this would be @code{/dev/tpm0}. | |
2590 | @option{path} is optional and by default @code{/dev/tpm0} is used. | |
2591 | ||
92dcc234 SB |
2592 | @option{cancel-path} specifies the path to the host TPM device's sysfs |
2593 | entry allowing for cancellation of an ongoing TPM command. | |
2594 | @option{cancel-path} is optional and by default QEMU will search for the | |
2595 | sysfs entry to use. | |
2596 | ||
4549a8b7 SB |
2597 | Some notes about using the host's TPM with the passthrough driver: |
2598 | ||
2599 | The TPM device accessed by the passthrough driver must not be | |
2600 | used by any other application on the host. | |
2601 | ||
2602 | Since the host's firmware (BIOS/UEFI) has already initialized the TPM, | |
2603 | the VM's firmware (BIOS/UEFI) will not be able to initialize the | |
2604 | TPM again and may therefore not show a TPM-specific menu that would | |
2605 | otherwise allow the user to configure the TPM, e.g., allow the user to | |
2606 | enable/disable or activate/deactivate the TPM. | |
2607 | Further, if TPM ownership is released from within a VM then the host's TPM | |
2608 | will get disabled and deactivated. To enable and activate the | |
2609 | TPM again afterwards, the host has to be rebooted and the user is | |
2610 | required to enter the firmware's menu to enable and activate the TPM. | |
2611 | If the TPM is left disabled and/or deactivated most TPM commands will fail. | |
2612 | ||
2613 | To create a passthrough TPM use the following two options: | |
2614 | @example | |
2615 | -tpmdev passthrough,id=tpm0 -device tpm-tis,tpmdev=tpm0 | |
2616 | @end example | |
2617 | Note that the @code{-tpmdev} id is @code{tpm0} and is referenced by | |
2618 | @code{tpmdev=tpm0} in the device option. | |
2619 | ||
d1a0cf73 SB |
2620 | @end table |
2621 | ||
2622 | ETEXI | |
2623 | ||
2624 | DEFHEADING() | |
2625 | ||
2626 | #endif | |
2627 | ||
7677f05d | 2628 | DEFHEADING(Linux/Multiboot boot specific:) |
5824d651 | 2629 | STEXI |
7677f05d AG |
2630 | |
2631 | When using these options, you can use a given Linux or Multiboot | |
2632 | kernel without installing it in the disk image. It can be useful | |
5824d651 BS |
2633 | for easier testing of various kernels. |
2634 | ||
2635 | @table @option | |
2636 | ETEXI | |
2637 | ||
2638 | DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \ | |
ad96090a | 2639 | "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL) |
5824d651 BS |
2640 | STEXI |
2641 | @item -kernel @var{bzImage} | |
6616b2ad | 2642 | @findex -kernel |
7677f05d AG |
2643 | Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel |
2644 | or in multiboot format. | |
5824d651 BS |
2645 | ETEXI |
2646 | ||
2647 | DEF("append", HAS_ARG, QEMU_OPTION_append, \ | |
ad96090a | 2648 | "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL) |
5824d651 BS |
2649 | STEXI |
2650 | @item -append @var{cmdline} | |
6616b2ad | 2651 | @findex -append |
5824d651 BS |
2652 | Use @var{cmdline} as kernel command line |
2653 | ETEXI | |
2654 | ||
2655 | DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \ | |
ad96090a | 2656 | "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL) |
5824d651 BS |
2657 | STEXI |
2658 | @item -initrd @var{file} | |
6616b2ad | 2659 | @findex -initrd |
5824d651 | 2660 | Use @var{file} as initial ram disk. |
7677f05d AG |
2661 | |
2662 | @item -initrd "@var{file1} arg=foo,@var{file2}" | |
2663 | ||
2664 | This syntax is only available with multiboot. | |
2665 | ||
2666 | Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the | |
2667 | first module. | |
5824d651 BS |
2668 | ETEXI |
2669 | ||
412beee6 | 2670 | DEF("dtb", HAS_ARG, QEMU_OPTION_dtb, \ |
379b5c7c | 2671 | "-dtb file use 'file' as device tree image\n", QEMU_ARCH_ALL) |
412beee6 GL |
2672 | STEXI |
2673 | @item -dtb @var{file} | |
2674 | @findex -dtb | |
2675 | Use @var{file} as a device tree binary (dtb) image and pass it to the kernel | |
2676 | on boot. | |
2677 | ETEXI | |
2678 | ||
5824d651 BS |
2679 | STEXI |
2680 | @end table | |
2681 | ETEXI | |
5824d651 BS |
2682 | DEFHEADING() |
2683 | ||
2684 | DEFHEADING(Debug/Expert options:) | |
5824d651 BS |
2685 | STEXI |
2686 | @table @option | |
2687 | ETEXI | |
2688 | ||
2689 | DEF("serial", HAS_ARG, QEMU_OPTION_serial, \ | |
ad96090a BS |
2690 | "-serial dev redirect the serial port to char device 'dev'\n", |
2691 | QEMU_ARCH_ALL) | |
5824d651 BS |
2692 | STEXI |
2693 | @item -serial @var{dev} | |
6616b2ad | 2694 | @findex -serial |
5824d651 BS |
2695 | Redirect the virtual serial port to host character device |
2696 | @var{dev}. The default device is @code{vc} in graphical mode and | |
2697 | @code{stdio} in non graphical mode. | |
2698 | ||
2699 | This option can be used several times to simulate up to 4 serial | |
2700 | ports. | |
2701 | ||
2702 | Use @code{-serial none} to disable all serial ports. | |
2703 | ||
2704 | Available character devices are: | |
b3f046c2 | 2705 | @table @option |
4e257e5e | 2706 | @item vc[:@var{W}x@var{H}] |
5824d651 BS |
2707 | Virtual console. Optionally, a width and height can be given in pixel with |
2708 | @example | |
2709 | vc:800x600 | |
2710 | @end example | |
2711 | It is also possible to specify width or height in characters: | |
2712 | @example | |
2713 | vc:80Cx24C | |
2714 | @end example | |
2715 | @item pty | |
2716 | [Linux only] Pseudo TTY (a new PTY is automatically allocated) | |
2717 | @item none | |
2718 | No device is allocated. | |
2719 | @item null | |
2720 | void device | |
88e020e5 IL |
2721 | @item chardev:@var{id} |
2722 | Use a named character device defined with the @code{-chardev} option. | |
5824d651 BS |
2723 | @item /dev/XXX |
2724 | [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port | |
2725 | parameters are set according to the emulated ones. | |
2726 | @item /dev/parport@var{N} | |
2727 | [Linux only, parallel port only] Use host parallel port | |
2728 | @var{N}. Currently SPP and EPP parallel port features can be used. | |
2729 | @item file:@var{filename} | |
2730 | Write output to @var{filename}. No character can be read. | |
2731 | @item stdio | |
2732 | [Unix only] standard input/output | |
2733 | @item pipe:@var{filename} | |
2734 | name pipe @var{filename} | |
2735 | @item COM@var{n} | |
2736 | [Windows only] Use host serial port @var{n} | |
2737 | @item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}] | |
2738 | This implements UDP Net Console. | |
2739 | When @var{remote_host} or @var{src_ip} are not specified | |
2740 | they default to @code{0.0.0.0}. | |
2741 | When not using a specified @var{src_port} a random port is automatically chosen. | |
5824d651 BS |
2742 | |
2743 | If you just want a simple readonly console you can use @code{netcat} or | |
b65ee4fa SW |
2744 | @code{nc}, by starting QEMU with: @code{-serial udp::4555} and nc as: |
2745 | @code{nc -u -l -p 4555}. Any time QEMU writes something to that port it | |
5824d651 BS |
2746 | will appear in the netconsole session. |
2747 | ||
2748 | If you plan to send characters back via netconsole or you want to stop | |
b65ee4fa | 2749 | and start QEMU a lot of times, you should have QEMU use the same |
5824d651 | 2750 | source port each time by using something like @code{-serial |
b65ee4fa | 2751 | udp::4555@@:4556} to QEMU. Another approach is to use a patched |
5824d651 BS |
2752 | version of netcat which can listen to a TCP port and send and receive |
2753 | characters via udp. If you have a patched version of netcat which | |
2754 | activates telnet remote echo and single char transfer, then you can | |
2755 | use the following options to step up a netcat redirector to allow | |
b65ee4fa | 2756 | telnet on port 5555 to access the QEMU port. |
5824d651 | 2757 | @table @code |
071c9394 | 2758 | @item QEMU Options: |
5824d651 BS |
2759 | -serial udp::4555@@:4556 |
2760 | @item netcat options: | |
2761 | -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T | |
2762 | @item telnet options: | |
2763 | localhost 5555 | |
2764 | @end table | |
2765 | ||
5dd1f02b | 2766 | @item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay][,reconnect=@var{seconds}] |
5824d651 BS |
2767 | The TCP Net Console has two modes of operation. It can send the serial |
2768 | I/O to a location or wait for a connection from a location. By default | |
2769 | the TCP Net Console is sent to @var{host} at the @var{port}. If you use | |
2770 | the @var{server} option QEMU will wait for a client socket application | |
2771 | to connect to the port before continuing, unless the @code{nowait} | |
2772 | option was specified. The @code{nodelay} option disables the Nagle buffering | |
5dd1f02b CM |
2773 | algorithm. The @code{reconnect} option only applies if @var{noserver} is |
2774 | set, if the connection goes down it will attempt to reconnect at the | |
2775 | given interval. If @var{host} is omitted, 0.0.0.0 is assumed. Only | |
5824d651 BS |
2776 | one TCP connection at a time is accepted. You can use @code{telnet} to |
2777 | connect to the corresponding character device. | |
2778 | @table @code | |
2779 | @item Example to send tcp console to 192.168.0.2 port 4444 | |
2780 | -serial tcp:192.168.0.2:4444 | |
2781 | @item Example to listen and wait on port 4444 for connection | |
2782 | -serial tcp::4444,server | |
2783 | @item Example to not wait and listen on ip 192.168.0.100 port 4444 | |
2784 | -serial tcp:192.168.0.100:4444,server,nowait | |
2785 | @end table | |
2786 | ||
2787 | @item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay] | |
2788 | The telnet protocol is used instead of raw tcp sockets. The options | |
2789 | work the same as if you had specified @code{-serial tcp}. The | |
2790 | difference is that the port acts like a telnet server or client using | |
2791 | telnet option negotiation. This will also allow you to send the | |
2792 | MAGIC_SYSRQ sequence if you use a telnet that supports sending the break | |
2793 | sequence. Typically in unix telnet you do it with Control-] and then | |
2794 | type "send break" followed by pressing the enter key. | |
2795 | ||
5dd1f02b | 2796 | @item unix:@var{path}[,server][,nowait][,reconnect=@var{seconds}] |
5824d651 BS |
2797 | A unix domain socket is used instead of a tcp socket. The option works the |
2798 | same as if you had specified @code{-serial tcp} except the unix domain socket | |
2799 | @var{path} is used for connections. | |
2800 | ||
2801 | @item mon:@var{dev_string} | |
2802 | This is a special option to allow the monitor to be multiplexed onto | |
2803 | another serial port. The monitor is accessed with key sequence of | |
02c4bdf1 | 2804 | @key{Control-a} and then pressing @key{c}. |
5824d651 BS |
2805 | @var{dev_string} should be any one of the serial devices specified |
2806 | above. An example to multiplex the monitor onto a telnet server | |
2807 | listening on port 4444 would be: | |
2808 | @table @code | |
2809 | @item -serial mon:telnet::4444,server,nowait | |
2810 | @end table | |
be022d61 MT |
2811 | When the monitor is multiplexed to stdio in this way, Ctrl+C will not terminate |
2812 | QEMU any more but will be passed to the guest instead. | |
5824d651 BS |
2813 | |
2814 | @item braille | |
2815 | Braille device. This will use BrlAPI to display the braille output on a real | |
2816 | or fake device. | |
2817 | ||
be8b28a9 KW |
2818 | @item msmouse |
2819 | Three button serial mouse. Configure the guest to use Microsoft protocol. | |
5824d651 BS |
2820 | @end table |
2821 | ETEXI | |
2822 | ||
2823 | DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \ | |
ad96090a BS |
2824 | "-parallel dev redirect the parallel port to char device 'dev'\n", |
2825 | QEMU_ARCH_ALL) | |
5824d651 BS |
2826 | STEXI |
2827 | @item -parallel @var{dev} | |
6616b2ad | 2828 | @findex -parallel |
5824d651 BS |
2829 | Redirect the virtual parallel port to host device @var{dev} (same |
2830 | devices as the serial port). On Linux hosts, @file{/dev/parportN} can | |
2831 | be used to use hardware devices connected on the corresponding host | |
2832 | parallel port. | |
2833 | ||
2834 | This option can be used several times to simulate up to 3 parallel | |
2835 | ports. | |
2836 | ||
2837 | Use @code{-parallel none} to disable all parallel ports. | |
2838 | ETEXI | |
2839 | ||
2840 | DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \ | |
ad96090a BS |
2841 | "-monitor dev redirect the monitor to char device 'dev'\n", |
2842 | QEMU_ARCH_ALL) | |
5824d651 | 2843 | STEXI |
4e307fc8 | 2844 | @item -monitor @var{dev} |
6616b2ad | 2845 | @findex -monitor |
5824d651 BS |
2846 | Redirect the monitor to host device @var{dev} (same devices as the |
2847 | serial port). | |
2848 | The default device is @code{vc} in graphical mode and @code{stdio} in | |
2849 | non graphical mode. | |
70e098af | 2850 | Use @code{-monitor none} to disable the default monitor. |
5824d651 | 2851 | ETEXI |
6ca5582d | 2852 | DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \ |
ad96090a BS |
2853 | "-qmp dev like -monitor but opens in 'control' mode\n", |
2854 | QEMU_ARCH_ALL) | |
95d5f08b SW |
2855 | STEXI |
2856 | @item -qmp @var{dev} | |
6616b2ad | 2857 | @findex -qmp |
95d5f08b SW |
2858 | Like -monitor but opens in 'control' mode. |
2859 | ETEXI | |
4821cd4c HR |
2860 | DEF("qmp-pretty", HAS_ARG, QEMU_OPTION_qmp_pretty, \ |
2861 | "-qmp-pretty dev like -qmp but uses pretty JSON formatting\n", | |
2862 | QEMU_ARCH_ALL) | |
2863 | STEXI | |
2864 | @item -qmp-pretty @var{dev} | |
2865 | @findex -qmp-pretty | |
2866 | Like -qmp but uses pretty JSON formatting. | |
2867 | ETEXI | |
5824d651 | 2868 | |
22a0e04b | 2869 | DEF("mon", HAS_ARG, QEMU_OPTION_mon, \ |
f17e4eaa | 2870 | "-mon [chardev=]name[,mode=readline|control][,default]\n", QEMU_ARCH_ALL) |
22a0e04b | 2871 | STEXI |
f17e4eaa | 2872 | @item -mon [chardev=]name[,mode=readline|control][,default] |
6616b2ad | 2873 | @findex -mon |
22a0e04b GH |
2874 | Setup monitor on chardev @var{name}. |
2875 | ETEXI | |
2876 | ||
c9f398e5 | 2877 | DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \ |
ad96090a BS |
2878 | "-debugcon dev redirect the debug console to char device 'dev'\n", |
2879 | QEMU_ARCH_ALL) | |
c9f398e5 PA |
2880 | STEXI |
2881 | @item -debugcon @var{dev} | |
6616b2ad | 2882 | @findex -debugcon |
c9f398e5 PA |
2883 | Redirect the debug console to host device @var{dev} (same devices as the |
2884 | serial port). The debug console is an I/O port which is typically port | |
2885 | 0xe9; writing to that I/O port sends output to this device. | |
2886 | The default device is @code{vc} in graphical mode and @code{stdio} in | |
2887 | non graphical mode. | |
2888 | ETEXI | |
2889 | ||
5824d651 | 2890 | DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \ |
ad96090a | 2891 | "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL) |
5824d651 BS |
2892 | STEXI |
2893 | @item -pidfile @var{file} | |
6616b2ad | 2894 | @findex -pidfile |
5824d651 BS |
2895 | Store the QEMU process PID in @var{file}. It is useful if you launch QEMU |
2896 | from a script. | |
2897 | ETEXI | |
2898 | ||
1b530a6d | 2899 | DEF("singlestep", 0, QEMU_OPTION_singlestep, \ |
ad96090a | 2900 | "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL) |
1b530a6d AJ |
2901 | STEXI |
2902 | @item -singlestep | |
6616b2ad | 2903 | @findex -singlestep |
1b530a6d AJ |
2904 | Run the emulation in single step mode. |
2905 | ETEXI | |
2906 | ||
5824d651 | 2907 | DEF("S", 0, QEMU_OPTION_S, \ |
ad96090a BS |
2908 | "-S freeze CPU at startup (use 'c' to start execution)\n", |
2909 | QEMU_ARCH_ALL) | |
5824d651 BS |
2910 | STEXI |
2911 | @item -S | |
6616b2ad | 2912 | @findex -S |
5824d651 BS |
2913 | Do not start CPU at startup (you must type 'c' in the monitor). |
2914 | ETEXI | |
2915 | ||
888a6bc6 SM |
2916 | DEF("realtime", HAS_ARG, QEMU_OPTION_realtime, |
2917 | "-realtime [mlock=on|off]\n" | |
2918 | " run qemu with realtime features\n" | |
2919 | " mlock=on|off controls mlock support (default: on)\n", | |
2920 | QEMU_ARCH_ALL) | |
2921 | STEXI | |
2922 | @item -realtime mlock=on|off | |
2923 | @findex -realtime | |
2924 | Run qemu with realtime features. | |
2925 | mlocking qemu and guest memory can be enabled via @option{mlock=on} | |
2926 | (enabled by default). | |
2927 | ETEXI | |
2928 | ||
59030a8c | 2929 | DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \ |
ad96090a | 2930 | "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL) |
59030a8c AL |
2931 | STEXI |
2932 | @item -gdb @var{dev} | |
6616b2ad | 2933 | @findex -gdb |
59030a8c AL |
2934 | Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical |
2935 | connections will likely be TCP-based, but also UDP, pseudo TTY, or even | |
b65ee4fa | 2936 | stdio are reasonable use case. The latter is allowing to start QEMU from |
59030a8c AL |
2937 | within gdb and establish the connection via a pipe: |
2938 | @example | |
3804da9d | 2939 | (gdb) target remote | exec qemu-system-i386 -gdb stdio ... |
59030a8c | 2940 | @end example |
5824d651 BS |
2941 | ETEXI |
2942 | ||
59030a8c | 2943 | DEF("s", 0, QEMU_OPTION_s, \ |
ad96090a BS |
2944 | "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n", |
2945 | QEMU_ARCH_ALL) | |
5824d651 | 2946 | STEXI |
59030a8c | 2947 | @item -s |
6616b2ad | 2948 | @findex -s |
59030a8c AL |
2949 | Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234 |
2950 | (@pxref{gdb_usage}). | |
5824d651 BS |
2951 | ETEXI |
2952 | ||
2953 | DEF("d", HAS_ARG, QEMU_OPTION_d, \ | |
989b697d | 2954 | "-d item1,... enable logging of specified items (use '-d help' for a list of log items)\n", |
ad96090a | 2955 | QEMU_ARCH_ALL) |
5824d651 | 2956 | STEXI |
989b697d | 2957 | @item -d @var{item1}[,...] |
6616b2ad | 2958 | @findex -d |
989b697d | 2959 | Enable logging of specified items. Use '-d help' for a list of log items. |
5824d651 BS |
2960 | ETEXI |
2961 | ||
c235d738 | 2962 | DEF("D", HAS_ARG, QEMU_OPTION_D, \ |
989b697d | 2963 | "-D logfile output log to logfile (default stderr)\n", |
c235d738 MF |
2964 | QEMU_ARCH_ALL) |
2965 | STEXI | |
8bd383b4 | 2966 | @item -D @var{logfile} |
c235d738 | 2967 | @findex -D |
989b697d | 2968 | Output log in @var{logfile} instead of to stderr |
c235d738 MF |
2969 | ETEXI |
2970 | ||
5824d651 | 2971 | DEF("L", HAS_ARG, QEMU_OPTION_L, \ |
ad96090a BS |
2972 | "-L path set the directory for the BIOS, VGA BIOS and keymaps\n", |
2973 | QEMU_ARCH_ALL) | |
5824d651 BS |
2974 | STEXI |
2975 | @item -L @var{path} | |
6616b2ad | 2976 | @findex -L |
5824d651 BS |
2977 | Set the directory for the BIOS, VGA BIOS and keymaps. |
2978 | ETEXI | |
2979 | ||
2980 | DEF("bios", HAS_ARG, QEMU_OPTION_bios, \ | |
ad96090a | 2981 | "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL) |
5824d651 BS |
2982 | STEXI |
2983 | @item -bios @var{file} | |
6616b2ad | 2984 | @findex -bios |
5824d651 BS |
2985 | Set the filename for the BIOS. |
2986 | ETEXI | |
2987 | ||
5824d651 | 2988 | DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \ |
ad96090a | 2989 | "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL) |
5824d651 BS |
2990 | STEXI |
2991 | @item -enable-kvm | |
6616b2ad | 2992 | @findex -enable-kvm |
5824d651 BS |
2993 | Enable KVM full virtualization support. This option is only available |
2994 | if KVM support is enabled when compiling. | |
2995 | ETEXI | |
2996 | ||
e37630ca | 2997 | DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid, |
ad96090a | 2998 | "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL) |
e37630ca AL |
2999 | DEF("xen-create", 0, QEMU_OPTION_xen_create, |
3000 | "-xen-create create domain using xen hypercalls, bypassing xend\n" | |
ad96090a BS |
3001 | " warning: should not be used when xend is in use\n", |
3002 | QEMU_ARCH_ALL) | |
e37630ca AL |
3003 | DEF("xen-attach", 0, QEMU_OPTION_xen_attach, |
3004 | "-xen-attach attach to existing xen domain\n" | |
b65ee4fa | 3005 | " xend will use this when starting QEMU\n", |
ad96090a | 3006 | QEMU_ARCH_ALL) |
95d5f08b SW |
3007 | STEXI |
3008 | @item -xen-domid @var{id} | |
6616b2ad | 3009 | @findex -xen-domid |
95d5f08b SW |
3010 | Specify xen guest domain @var{id} (XEN only). |
3011 | @item -xen-create | |
6616b2ad | 3012 | @findex -xen-create |
95d5f08b SW |
3013 | Create domain using xen hypercalls, bypassing xend. |
3014 | Warning: should not be used when xend is in use (XEN only). | |
3015 | @item -xen-attach | |
6616b2ad | 3016 | @findex -xen-attach |
95d5f08b | 3017 | Attach to existing xen domain. |
b65ee4fa | 3018 | xend will use this when starting QEMU (XEN only). |
95d5f08b | 3019 | ETEXI |
e37630ca | 3020 | |
5824d651 | 3021 | DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \ |
ad96090a | 3022 | "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL) |
5824d651 BS |
3023 | STEXI |
3024 | @item -no-reboot | |
6616b2ad | 3025 | @findex -no-reboot |
5824d651 BS |
3026 | Exit instead of rebooting. |
3027 | ETEXI | |
3028 | ||
3029 | DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \ | |
ad96090a | 3030 | "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL) |
5824d651 BS |
3031 | STEXI |
3032 | @item -no-shutdown | |
6616b2ad | 3033 | @findex -no-shutdown |
5824d651 BS |
3034 | Don't exit QEMU on guest shutdown, but instead only stop the emulation. |
3035 | This allows for instance switching to monitor to commit changes to the | |
3036 | disk image. | |
3037 | ETEXI | |
3038 | ||
3039 | DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \ | |
3040 | "-loadvm [tag|id]\n" \ | |
ad96090a BS |
3041 | " start right away with a saved state (loadvm in monitor)\n", |
3042 | QEMU_ARCH_ALL) | |
5824d651 BS |
3043 | STEXI |
3044 | @item -loadvm @var{file} | |
6616b2ad | 3045 | @findex -loadvm |
5824d651 BS |
3046 | Start right away with a saved state (@code{loadvm} in monitor) |
3047 | ETEXI | |
3048 | ||
3049 | #ifndef _WIN32 | |
3050 | DEF("daemonize", 0, QEMU_OPTION_daemonize, \ | |
ad96090a | 3051 | "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL) |
5824d651 BS |
3052 | #endif |
3053 | STEXI | |
3054 | @item -daemonize | |
6616b2ad | 3055 | @findex -daemonize |
5824d651 BS |
3056 | Daemonize the QEMU process after initialization. QEMU will not detach from |
3057 | standard IO until it is ready to receive connections on any of its devices. | |
3058 | This option is a useful way for external programs to launch QEMU without having | |
3059 | to cope with initialization race conditions. | |
3060 | ETEXI | |
3061 | ||
3062 | DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \ | |
ad96090a BS |
3063 | "-option-rom rom load a file, rom, into the option ROM space\n", |
3064 | QEMU_ARCH_ALL) | |
5824d651 BS |
3065 | STEXI |
3066 | @item -option-rom @var{file} | |
6616b2ad | 3067 | @findex -option-rom |
5824d651 BS |
3068 | Load the contents of @var{file} as an option ROM. |
3069 | This option is useful to load things like EtherBoot. | |
3070 | ETEXI | |
3071 | ||
e218052f MA |
3072 | HXCOMM Silently ignored for compatibility |
3073 | DEF("clock", HAS_ARG, QEMU_OPTION_clock, "", QEMU_ARCH_ALL) | |
5824d651 | 3074 | |
1ed2fc1f | 3075 | HXCOMM Options deprecated by -rtc |
ad96090a BS |
3076 | DEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL) |
3077 | DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL) | |
1ed2fc1f | 3078 | |
1ed2fc1f | 3079 | DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \ |
78808141 | 3080 | "-rtc [base=utc|localtime|date][,clock=host|rt|vm][,driftfix=none|slew]\n" \ |
ad96090a BS |
3081 | " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n", |
3082 | QEMU_ARCH_ALL) | |
5824d651 | 3083 | |
5824d651 BS |
3084 | STEXI |
3085 | ||
6875204c | 3086 | @item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew] |
6616b2ad | 3087 | @findex -rtc |
1ed2fc1f JK |
3088 | Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current |
3089 | UTC or local time, respectively. @code{localtime} is required for correct date in | |
3090 | MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the | |
3091 | format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC. | |
3092 | ||
9d85d557 | 3093 | By default the RTC is driven by the host system time. This allows using of the |
6875204c JK |
3094 | RTC as accurate reference clock inside the guest, specifically if the host |
3095 | time is smoothly following an accurate external reference clock, e.g. via NTP. | |
78808141 PB |
3096 | If you want to isolate the guest time from the host, you can set @option{clock} |
3097 | to @code{rt} instead. To even prevent it from progressing during suspension, | |
3098 | you can set it to @code{vm}. | |
6875204c | 3099 | |
1ed2fc1f JK |
3100 | Enable @option{driftfix} (i386 targets only) if you experience time drift problems, |
3101 | specifically with Windows' ACPI HAL. This option will try to figure out how | |
3102 | many timer interrupts were not processed by the Windows guest and will | |
3103 | re-inject them. | |
5824d651 BS |
3104 | ETEXI |
3105 | ||
3106 | DEF("icount", HAS_ARG, QEMU_OPTION_icount, \ | |
f1f4b57e | 3107 | "-icount [shift=N|auto][,align=on|off][,sleep=no]\n" \ |
bc14ca24 | 3108 | " enable virtual instruction counter with 2^N clock ticks per\n" \ |
f1f4b57e VC |
3109 | " instruction, enable aligning the host and virtual clocks\n" \ |
3110 | " or disable real time cpu sleeping\n", QEMU_ARCH_ALL) | |
5824d651 | 3111 | STEXI |
1ad9580b | 3112 | @item -icount [shift=@var{N}|auto] |
6616b2ad | 3113 | @findex -icount |
5824d651 | 3114 | Enable virtual instruction counter. The virtual cpu will execute one |
4e257e5e | 3115 | instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified |
5824d651 BS |
3116 | then the virtual cpu speed will be automatically adjusted to keep virtual |
3117 | time within a few seconds of real time. | |
3118 | ||
f1f4b57e VC |
3119 | When the virtual cpu is sleeping, the virtual time will advance at default |
3120 | speed unless @option{sleep=no} is specified. | |
3121 | With @option{sleep=no}, the virtual time will jump to the next timer deadline | |
3122 | instantly whenever the virtual cpu goes to sleep mode and will not advance | |
3123 | if no timer is enabled. This behavior give deterministic execution times from | |
3124 | the guest point of view. | |
3125 | ||
5824d651 BS |
3126 | Note that while this option can give deterministic behavior, it does not |
3127 | provide cycle accurate emulation. Modern CPUs contain superscalar out of | |
3128 | order cores with complex cache hierarchies. The number of instructions | |
3129 | executed often has little or no correlation with actual performance. | |
a8bfac37 ST |
3130 | |
3131 | @option{align=on} will activate the delay algorithm which will try to | |
3132 | to synchronise the host clock and the virtual clock. The goal is to | |
3133 | have a guest running at the real frequency imposed by the shift option. | |
3134 | Whenever the guest clock is behind the host clock and if | |
82597615 | 3135 | @option{align=on} is specified then we print a message to the user |
a8bfac37 ST |
3136 | to inform about the delay. |
3137 | Currently this option does not work when @option{shift} is @code{auto}. | |
3138 | Note: The sync algorithm will work for those shift values for which | |
3139 | the guest clock runs ahead of the host clock. Typically this happens | |
3140 | when the shift value is high (how high depends on the host machine). | |
5824d651 BS |
3141 | ETEXI |
3142 | ||
9dd986cc RJ |
3143 | DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \ |
3144 | "-watchdog i6300esb|ib700\n" \ | |
ad96090a BS |
3145 | " enable virtual hardware watchdog [default=none]\n", |
3146 | QEMU_ARCH_ALL) | |
9dd986cc RJ |
3147 | STEXI |
3148 | @item -watchdog @var{model} | |
6616b2ad | 3149 | @findex -watchdog |
9dd986cc RJ |
3150 | Create a virtual hardware watchdog device. Once enabled (by a guest |
3151 | action), the watchdog must be periodically polled by an agent inside | |
3152 | the guest or else the guest will be restarted. | |
3153 | ||
3154 | The @var{model} is the model of hardware watchdog to emulate. Choices | |
3155 | for model are: @code{ib700} (iBASE 700) which is a very simple ISA | |
3156 | watchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O | |
3157 | controller hub) which is a much more featureful PCI-based dual-timer | |
3158 | watchdog. Choose a model for which your guest has drivers. | |
3159 | ||
585f6036 | 3160 | Use @code{-watchdog help} to list available hardware models. Only one |
9dd986cc RJ |
3161 | watchdog can be enabled for a guest. |
3162 | ETEXI | |
3163 | ||
3164 | DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \ | |
3165 | "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \ | |
ad96090a BS |
3166 | " action when watchdog fires [default=reset]\n", |
3167 | QEMU_ARCH_ALL) | |
9dd986cc RJ |
3168 | STEXI |
3169 | @item -watchdog-action @var{action} | |
b8f490eb | 3170 | @findex -watchdog-action |
9dd986cc RJ |
3171 | |
3172 | The @var{action} controls what QEMU will do when the watchdog timer | |
3173 | expires. | |
3174 | The default is | |
3175 | @code{reset} (forcefully reset the guest). | |
3176 | Other possible actions are: | |
3177 | @code{shutdown} (attempt to gracefully shutdown the guest), | |
3178 | @code{poweroff} (forcefully poweroff the guest), | |
3179 | @code{pause} (pause the guest), | |
3180 | @code{debug} (print a debug message and continue), or | |
3181 | @code{none} (do nothing). | |
3182 | ||
3183 | Note that the @code{shutdown} action requires that the guest responds | |
3184 | to ACPI signals, which it may not be able to do in the sort of | |
3185 | situations where the watchdog would have expired, and thus | |
3186 | @code{-watchdog-action shutdown} is not recommended for production use. | |
3187 | ||
3188 | Examples: | |
3189 | ||
3190 | @table @code | |
3191 | @item -watchdog i6300esb -watchdog-action pause | |
3192 | @item -watchdog ib700 | |
3193 | @end table | |
3194 | ETEXI | |
3195 | ||
5824d651 | 3196 | DEF("echr", HAS_ARG, QEMU_OPTION_echr, \ |
ad96090a BS |
3197 | "-echr chr set terminal escape character instead of ctrl-a\n", |
3198 | QEMU_ARCH_ALL) | |
5824d651 BS |
3199 | STEXI |
3200 | ||
4e257e5e | 3201 | @item -echr @var{numeric_ascii_value} |
6616b2ad | 3202 | @findex -echr |
5824d651 BS |
3203 | Change the escape character used for switching to the monitor when using |
3204 | monitor and serial sharing. The default is @code{0x01} when using the | |
3205 | @code{-nographic} option. @code{0x01} is equal to pressing | |
3206 | @code{Control-a}. You can select a different character from the ascii | |
3207 | control keys where 1 through 26 map to Control-a through Control-z. For | |
3208 | instance you could use the either of the following to change the escape | |
3209 | character to Control-t. | |
3210 | @table @code | |
3211 | @item -echr 0x14 | |
3212 | @item -echr 20 | |
3213 | @end table | |
3214 | ETEXI | |
3215 | ||
3216 | DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \ | |
3217 | "-virtioconsole c\n" \ | |
ad96090a | 3218 | " set virtio console\n", QEMU_ARCH_ALL) |
5824d651 BS |
3219 | STEXI |
3220 | @item -virtioconsole @var{c} | |
6616b2ad | 3221 | @findex -virtioconsole |
5824d651 | 3222 | Set virtio console. |
98b19252 AS |
3223 | |
3224 | This option is maintained for backward compatibility. | |
3225 | ||
3226 | Please use @code{-device virtconsole} for the new way of invocation. | |
5824d651 BS |
3227 | ETEXI |
3228 | ||
3229 | DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \ | |
ad96090a | 3230 | "-show-cursor show cursor\n", QEMU_ARCH_ALL) |
5824d651 | 3231 | STEXI |
95d5f08b | 3232 | @item -show-cursor |
6616b2ad | 3233 | @findex -show-cursor |
95d5f08b | 3234 | Show cursor. |
5824d651 BS |
3235 | ETEXI |
3236 | ||
3237 | DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \ | |
ad96090a | 3238 | "-tb-size n set TB size\n", QEMU_ARCH_ALL) |
5824d651 | 3239 | STEXI |
95d5f08b | 3240 | @item -tb-size @var{n} |
6616b2ad | 3241 | @findex -tb-size |
95d5f08b | 3242 | Set TB size. |
5824d651 BS |
3243 | ETEXI |
3244 | ||
3245 | DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ | |
7c601803 MT |
3246 | "-incoming tcp:[host]:port[,to=maxport][,ipv4][,ipv6]\n" \ |
3247 | "-incoming rdma:host:port[,ipv4][,ipv6]\n" \ | |
3248 | "-incoming unix:socketpath\n" \ | |
3249 | " prepare for incoming migration, listen on\n" \ | |
3250 | " specified protocol and socket address\n" \ | |
3251 | "-incoming fd:fd\n" \ | |
3252 | "-incoming exec:cmdline\n" \ | |
3253 | " accept incoming migration on given file descriptor\n" \ | |
1597051b DDAG |
3254 | " or from given external command\n" \ |
3255 | "-incoming defer\n" \ | |
3256 | " wait for the URI to be specified via migrate_incoming\n", | |
ad96090a | 3257 | QEMU_ARCH_ALL) |
5824d651 | 3258 | STEXI |
7c601803 MT |
3259 | @item -incoming tcp:[@var{host}]:@var{port}[,to=@var{maxport}][,ipv4][,ipv6] |
3260 | @item -incoming rdma:@var{host}:@var{port}[,ipv4][,ipv6] | |
6616b2ad | 3261 | @findex -incoming |
7c601803 MT |
3262 | Prepare for incoming migration, listen on a given tcp port. |
3263 | ||
3264 | @item -incoming unix:@var{socketpath} | |
3265 | Prepare for incoming migration, listen on a given unix socket. | |
3266 | ||
3267 | @item -incoming fd:@var{fd} | |
3268 | Accept incoming migration from a given filedescriptor. | |
3269 | ||
3270 | @item -incoming exec:@var{cmdline} | |
3271 | Accept incoming migration as an output from specified external command. | |
1597051b DDAG |
3272 | |
3273 | @item -incoming defer | |
3274 | Wait for the URI to be specified via migrate_incoming. The monitor can | |
3275 | be used to change settings (such as migration parameters) prior to issuing | |
3276 | the migrate_incoming to allow the migration to begin. | |
5824d651 BS |
3277 | ETEXI |
3278 | ||
d8c208dd | 3279 | DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \ |
ad96090a | 3280 | "-nodefaults don't create default devices\n", QEMU_ARCH_ALL) |
d8c208dd | 3281 | STEXI |
3dbf2c7f | 3282 | @item -nodefaults |
6616b2ad | 3283 | @findex -nodefaults |
66c19bf1 MN |
3284 | Don't create default devices. Normally, QEMU sets the default devices like serial |
3285 | port, parallel port, virtual console, monitor device, VGA adapter, floppy and | |
3286 | CD-ROM drive and others. The @code{-nodefaults} option will disable all those | |
3287 | default devices. | |
d8c208dd GH |
3288 | ETEXI |
3289 | ||
5824d651 BS |
3290 | #ifndef _WIN32 |
3291 | DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \ | |
ad96090a BS |
3292 | "-chroot dir chroot to dir just before starting the VM\n", |
3293 | QEMU_ARCH_ALL) | |
5824d651 BS |
3294 | #endif |
3295 | STEXI | |
4e257e5e | 3296 | @item -chroot @var{dir} |
6616b2ad | 3297 | @findex -chroot |
5824d651 BS |
3298 | Immediately before starting guest execution, chroot to the specified |
3299 | directory. Especially useful in combination with -runas. | |
3300 | ETEXI | |
3301 | ||
3302 | #ifndef _WIN32 | |
3303 | DEF("runas", HAS_ARG, QEMU_OPTION_runas, \ | |
ad96090a BS |
3304 | "-runas user change to user id user just before starting the VM\n", |
3305 | QEMU_ARCH_ALL) | |
5824d651 BS |
3306 | #endif |
3307 | STEXI | |
4e257e5e | 3308 | @item -runas @var{user} |
6616b2ad | 3309 | @findex -runas |
5824d651 BS |
3310 | Immediately before starting guest execution, drop root privileges, switching |
3311 | to the specified user. | |
3312 | ETEXI | |
3313 | ||
5824d651 BS |
3314 | DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env, |
3315 | "-prom-env variable=value\n" | |
ad96090a BS |
3316 | " set OpenBIOS nvram variables\n", |
3317 | QEMU_ARCH_PPC | QEMU_ARCH_SPARC) | |
95d5f08b SW |
3318 | STEXI |
3319 | @item -prom-env @var{variable}=@var{value} | |
6616b2ad | 3320 | @findex -prom-env |
95d5f08b SW |
3321 | Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only). |
3322 | ETEXI | |
5824d651 | 3323 | DEF("semihosting", 0, QEMU_OPTION_semihosting, |
f7bbcfb5 MW |
3324 | "-semihosting semihosting mode\n", |
3325 | QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32) | |
95d5f08b SW |
3326 | STEXI |
3327 | @item -semihosting | |
6616b2ad | 3328 | @findex -semihosting |
a38bb079 LI |
3329 | Enable semihosting mode (ARM, M68K, Xtensa only). |
3330 | ETEXI | |
3331 | DEF("semihosting-config", HAS_ARG, QEMU_OPTION_semihosting_config, | |
3332 | "-semihosting-config [enable=on|off,]target=native|gdb|auto semihosting configuration\n", | |
3333 | QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32) | |
3334 | STEXI | |
3335 | @item -semihosting-config [enable=on|off,]target=native|gdb|auto | |
3336 | @findex -semihosting-config | |
3337 | Enable semihosting and define where the semihosting calls will be addressed, | |
3338 | to QEMU (@code{native}) or to GDB (@code{gdb}). The default is @code{auto}, which means | |
3339 | @code{gdb} during debug sessions and @code{native} otherwise (ARM, M68K, Xtensa only). | |
95d5f08b | 3340 | ETEXI |
5824d651 | 3341 | DEF("old-param", 0, QEMU_OPTION_old_param, |
ad96090a | 3342 | "-old-param old param mode\n", QEMU_ARCH_ARM) |
95d5f08b SW |
3343 | STEXI |
3344 | @item -old-param | |
6616b2ad | 3345 | @findex -old-param (ARM) |
95d5f08b SW |
3346 | Old param mode (ARM only). |
3347 | ETEXI | |
3348 | ||
7d76ad4f EO |
3349 | DEF("sandbox", HAS_ARG, QEMU_OPTION_sandbox, \ |
3350 | "-sandbox <arg> Enable seccomp mode 2 system call filter (default 'off').\n", | |
3351 | QEMU_ARCH_ALL) | |
3352 | STEXI | |
6265c43b | 3353 | @item -sandbox @var{arg} |
7d76ad4f EO |
3354 | @findex -sandbox |
3355 | Enable Seccomp mode 2 system call filter. 'on' will enable syscall filtering and 'off' will | |
3356 | disable it. The default is 'off'. | |
3357 | ETEXI | |
3358 | ||
715a664a | 3359 | DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig, |
ad96090a | 3360 | "-readconfig <file>\n", QEMU_ARCH_ALL) |
3dbf2c7f SW |
3361 | STEXI |
3362 | @item -readconfig @var{file} | |
6616b2ad | 3363 | @findex -readconfig |
ed24cfac MN |
3364 | Read device configuration from @var{file}. This approach is useful when you want to spawn |
3365 | QEMU process with many command line options but you don't want to exceed the command line | |
3366 | character limit. | |
3dbf2c7f | 3367 | ETEXI |
715a664a GH |
3368 | DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig, |
3369 | "-writeconfig <file>\n" | |
ad96090a | 3370 | " read/write config file\n", QEMU_ARCH_ALL) |
3dbf2c7f SW |
3371 | STEXI |
3372 | @item -writeconfig @var{file} | |
6616b2ad | 3373 | @findex -writeconfig |
ed24cfac MN |
3374 | Write device configuration to @var{file}. The @var{file} can be either filename to save |
3375 | command line and device configuration into file or dash @code{-}) character to print the | |
3376 | output to stdout. This can be later used as input file for @code{-readconfig} option. | |
3dbf2c7f | 3377 | ETEXI |
292444cb AL |
3378 | DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig, |
3379 | "-nodefconfig\n" | |
ad96090a BS |
3380 | " do not load default config files at startup\n", |
3381 | QEMU_ARCH_ALL) | |
292444cb AL |
3382 | STEXI |
3383 | @item -nodefconfig | |
6616b2ad | 3384 | @findex -nodefconfig |
f29a5614 EH |
3385 | Normally QEMU loads configuration files from @var{sysconfdir} and @var{datadir} at startup. |
3386 | The @code{-nodefconfig} option will prevent QEMU from loading any of those config files. | |
3387 | ETEXI | |
3388 | DEF("no-user-config", 0, QEMU_OPTION_nouserconfig, | |
3389 | "-no-user-config\n" | |
3390 | " do not load user-provided config files at startup\n", | |
3391 | QEMU_ARCH_ALL) | |
3392 | STEXI | |
3393 | @item -no-user-config | |
3394 | @findex -no-user-config | |
3395 | The @code{-no-user-config} option makes QEMU not load any of the user-provided | |
3396 | config files on @var{sysconfdir}, but won't make it skip the QEMU-provided config | |
3397 | files from @var{datadir}. | |
292444cb | 3398 | ETEXI |
ab6540d5 | 3399 | DEF("trace", HAS_ARG, QEMU_OPTION_trace, |
23d15e86 LV |
3400 | "-trace [events=<file>][,file=<file>]\n" |
3401 | " specify tracing options\n", | |
ab6540d5 PS |
3402 | QEMU_ARCH_ALL) |
3403 | STEXI | |
23d15e86 LV |
3404 | HXCOMM This line is not accurate, as some sub-options are backend-specific but |
3405 | HXCOMM HX does not support conditional compilation of text. | |
3406 | @item -trace [events=@var{file}][,file=@var{file}] | |
ab6540d5 | 3407 | @findex -trace |
e4858974 | 3408 | |
23d15e86 LV |
3409 | Specify tracing options. |
3410 | ||
3411 | @table @option | |
3412 | @item events=@var{file} | |
3413 | Immediately enable events listed in @var{file}. | |
3414 | The file must contain one event name (as listed in the @var{trace-events} file) | |
3415 | per line. | |
c1ba4e0b SW |
3416 | This option is only available if QEMU has been compiled with |
3417 | either @var{simple} or @var{stderr} tracing backend. | |
23d15e86 LV |
3418 | @item file=@var{file} |
3419 | Log output traces to @var{file}. | |
3420 | ||
c1ba4e0b SW |
3421 | This option is only available if QEMU has been compiled with |
3422 | the @var{simple} tracing backend. | |
23d15e86 | 3423 | @end table |
ab6540d5 | 3424 | ETEXI |
3dbf2c7f | 3425 | |
31e70d6c MA |
3426 | HXCOMM Internal use |
3427 | DEF("qtest", HAS_ARG, QEMU_OPTION_qtest, "", QEMU_ARCH_ALL) | |
3428 | DEF("qtest-log", HAS_ARG, QEMU_OPTION_qtest_log, "", QEMU_ARCH_ALL) | |
c7f0f3b1 | 3429 | |
0f66998f PM |
3430 | #ifdef __linux__ |
3431 | DEF("enable-fips", 0, QEMU_OPTION_enablefips, | |
3432 | "-enable-fips enable FIPS 140-2 compliance\n", | |
3433 | QEMU_ARCH_ALL) | |
3434 | #endif | |
3435 | STEXI | |
3436 | @item -enable-fips | |
3437 | @findex -enable-fips | |
3438 | Enable FIPS 140-2 compliance mode. | |
3439 | ETEXI | |
3440 | ||
a0dac021 | 3441 | HXCOMM Deprecated by -machine accel=tcg property |
c6e88b3b | 3442 | DEF("no-kvm", 0, QEMU_OPTION_no_kvm, "", QEMU_ARCH_I386) |
a0dac021 | 3443 | |
c21fb4f8 | 3444 | HXCOMM Deprecated by kvm-pit driver properties |
c6e88b3b | 3445 | DEF("no-kvm-pit-reinjection", 0, QEMU_OPTION_no_kvm_pit_reinjection, |
c21fb4f8 JK |
3446 | "", QEMU_ARCH_I386) |
3447 | ||
4086bde8 | 3448 | HXCOMM Deprecated (ignored) |
c6e88b3b | 3449 | DEF("no-kvm-pit", 0, QEMU_OPTION_no_kvm_pit, "", QEMU_ARCH_I386) |
4086bde8 | 3450 | |
e43d594e | 3451 | HXCOMM Deprecated by -machine kernel_irqchip=on|off property |
c6e88b3b | 3452 | DEF("no-kvm-irqchip", 0, QEMU_OPTION_no_kvm_irqchip, "", QEMU_ARCH_I386) |
e43d594e | 3453 | |
88eed34a JK |
3454 | HXCOMM Deprecated (ignored) |
3455 | DEF("tdf", 0, QEMU_OPTION_tdf,"", QEMU_ARCH_ALL) | |
3456 | ||
68d98d3e AL |
3457 | DEF("object", HAS_ARG, QEMU_OPTION_object, |
3458 | "-object TYPENAME[,PROP1=VALUE1,...]\n" | |
3459 | " create an new object of type TYPENAME setting properties\n" | |
3460 | " in the order they are specified. Note that the 'id'\n" | |
3461 | " property must be set. These objects are placed in the\n" | |
3462 | " '/objects' path.\n", | |
3463 | QEMU_ARCH_ALL) | |
6265c43b MA |
3464 | STEXI |
3465 | @item -object @var{typename}[,@var{prop1}=@var{value1},...] | |
3466 | @findex -object | |
3467 | Create an new object of type @var{typename} setting properties | |
3468 | in the order they are specified. Note that the 'id' | |
3469 | property must be set. These objects are placed in the | |
3470 | '/objects' path. | |
3471 | ETEXI | |
68d98d3e | 3472 | |
5e2ac519 SA |
3473 | DEF("msg", HAS_ARG, QEMU_OPTION_msg, |
3474 | "-msg timestamp[=on|off]\n" | |
3475 | " change the format of messages\n" | |
3476 | " on|off controls leading timestamps (default:on)\n", | |
3477 | QEMU_ARCH_ALL) | |
3478 | STEXI | |
3479 | @item -msg timestamp[=on|off] | |
3480 | @findex -msg | |
3481 | prepend a timestamp to each log message.(default:on) | |
3482 | ETEXI | |
3483 | ||
abfd9ce3 AS |
3484 | DEF("dump-vmstate", HAS_ARG, QEMU_OPTION_dump_vmstate, |
3485 | "-dump-vmstate <file>\n" | |
3486 | " Output vmstate information in JSON format to file.\n" | |
3487 | " Use the scripts/vmstate-static-checker.py file to\n" | |
3488 | " check for possible regressions in migration code\n" | |
3489 | " by comparing two such vmstate dumps.", | |
3490 | QEMU_ARCH_ALL) | |
3491 | STEXI | |
3492 | @item -dump-vmstate @var{file} | |
3493 | @findex -dump-vmstate | |
3494 | Dump json-encoded vmstate information for current machine type to file | |
3495 | in @var{file} | |
3496 | ETEXI | |
3497 | ||
3dbf2c7f SW |
3498 | HXCOMM This is the last statement. Insert new options before this line! |
3499 | STEXI | |
3500 | @end table | |
3501 | ETEXI |