root / qemu-options.hx @ 9312805d
History | View | Annotate | Download (82.7 kB)
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 |
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. |
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, |
15 |
"-h or -help display this help and exit\n", QEMU_ARCH_ALL) |
16 |
STEXI |
17 |
@item -h |
18 |
@findex -h |
19 |
Display help and exit |
20 |
ETEXI |
21 |
|
22 |
DEF("version", 0, QEMU_OPTION_version, |
23 |
"-version display version information and exit\n", QEMU_ARCH_ALL) |
24 |
STEXI |
25 |
@item -version |
26 |
@findex -version |
27 |
Display version information and exit |
28 |
ETEXI |
29 |
|
30 |
DEF("M", HAS_ARG, QEMU_OPTION_M, |
31 |
"-M machine select emulated machine (-M ? for list)\n", QEMU_ARCH_ALL) |
32 |
STEXI |
33 |
@item -M @var{machine} |
34 |
@findex -M |
35 |
Select the emulated @var{machine} (@code{-M ?} for list) |
36 |
ETEXI |
37 |
|
38 |
DEF("cpu", HAS_ARG, QEMU_OPTION_cpu, |
39 |
"-cpu cpu select CPU (-cpu ? for list)\n", QEMU_ARCH_ALL) |
40 |
STEXI |
41 |
@item -cpu @var{model} |
42 |
@findex -cpu |
43 |
Select CPU model (-cpu ? for list and additional feature selection) |
44 |
ETEXI |
45 |
|
46 |
DEF("smp", HAS_ARG, QEMU_OPTION_smp, |
47 |
"-smp n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n" |
48 |
" set the number of CPUs to 'n' [default=1]\n" |
49 |
" maxcpus= maximum number of total cpus, including\n" |
50 |
" offline CPUs for hotplug, etc\n" |
51 |
" cores= number of CPU cores on one socket\n" |
52 |
" threads= number of threads on one CPU core\n" |
53 |
" sockets= number of discrete sockets in the system\n", |
54 |
QEMU_ARCH_ALL) |
55 |
STEXI |
56 |
@item -smp @var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}] |
57 |
@findex -smp |
58 |
Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255 |
59 |
CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs |
60 |
to 4. |
61 |
For the PC target, the number of @var{cores} per socket, the number |
62 |
of @var{threads} per cores and the total number of @var{sockets} can be |
63 |
specified. Missing values will be computed. If any on the three values is |
64 |
given, the total number of CPUs @var{n} can be omitted. @var{maxcpus} |
65 |
specifies the maximum number of hotpluggable CPUs. |
66 |
ETEXI |
67 |
|
68 |
DEF("numa", HAS_ARG, QEMU_OPTION_numa, |
69 |
"-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL) |
70 |
STEXI |
71 |
@item -numa @var{opts} |
72 |
@findex -numa |
73 |
Simulate a multi node NUMA system. If mem and cpus are omitted, resources |
74 |
are split equally. |
75 |
ETEXI |
76 |
|
77 |
DEF("fda", HAS_ARG, QEMU_OPTION_fda, |
78 |
"-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL) |
79 |
DEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL) |
80 |
STEXI |
81 |
@item -fda @var{file} |
82 |
@item -fdb @var{file} |
83 |
@findex -fda |
84 |
@findex -fdb |
85 |
Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can |
86 |
use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}). |
87 |
ETEXI |
88 |
|
89 |
DEF("hda", HAS_ARG, QEMU_OPTION_hda, |
90 |
"-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL) |
91 |
DEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL) |
92 |
DEF("hdc", HAS_ARG, QEMU_OPTION_hdc, |
93 |
"-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL) |
94 |
DEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL) |
95 |
STEXI |
96 |
@item -hda @var{file} |
97 |
@item -hdb @var{file} |
98 |
@item -hdc @var{file} |
99 |
@item -hdd @var{file} |
100 |
@findex -hda |
101 |
@findex -hdb |
102 |
@findex -hdc |
103 |
@findex -hdd |
104 |
Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}). |
105 |
ETEXI |
106 |
|
107 |
DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom, |
108 |
"-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n", |
109 |
QEMU_ARCH_ALL) |
110 |
STEXI |
111 |
@item -cdrom @var{file} |
112 |
@findex -cdrom |
113 |
Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and |
114 |
@option{-cdrom} at the same time). You can use the host CD-ROM by |
115 |
using @file{/dev/cdrom} as filename (@pxref{host_drives}). |
116 |
ETEXI |
117 |
|
118 |
DEF("drive", HAS_ARG, QEMU_OPTION_drive, |
119 |
"-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n" |
120 |
" [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n" |
121 |
" [,cache=writethrough|writeback|none|unsafe][,format=f]\n" |
122 |
" [,serial=s][,addr=A][,id=name][,aio=threads|native]\n" |
123 |
" [,readonly=on|off]\n" |
124 |
" use 'file' as a drive image\n", QEMU_ARCH_ALL) |
125 |
STEXI |
126 |
@item -drive @var{option}[,@var{option}[,@var{option}[,...]]] |
127 |
@findex -drive |
128 |
|
129 |
Define a new drive. Valid options are: |
130 |
|
131 |
@table @option |
132 |
@item file=@var{file} |
133 |
This option defines which disk image (@pxref{disk_images}) to use with |
134 |
this drive. If the filename contains comma, you must double it |
135 |
(for instance, "file=my,,file" to use file "my,file"). |
136 |
@item if=@var{interface} |
137 |
This option defines on which type on interface the drive is connected. |
138 |
Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio. |
139 |
@item bus=@var{bus},unit=@var{unit} |
140 |
These options define where is connected the drive by defining the bus number and |
141 |
the unit id. |
142 |
@item index=@var{index} |
143 |
This option defines where is connected the drive by using an index in the list |
144 |
of available connectors of a given interface type. |
145 |
@item media=@var{media} |
146 |
This option defines the type of the media: disk or cdrom. |
147 |
@item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}] |
148 |
These options have the same definition as they have in @option{-hdachs}. |
149 |
@item snapshot=@var{snapshot} |
150 |
@var{snapshot} is "on" or "off" and allows to enable snapshot for given drive (see @option{-snapshot}). |
151 |
@item cache=@var{cache} |
152 |
@var{cache} is "none", "writeback", "unsafe", or "writethrough" and controls how the host cache is used to access block data. |
153 |
@item aio=@var{aio} |
154 |
@var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO. |
155 |
@item format=@var{format} |
156 |
Specify which disk @var{format} will be used rather than detecting |
157 |
the format. Can be used to specifiy format=raw to avoid interpreting |
158 |
an untrusted format header. |
159 |
@item serial=@var{serial} |
160 |
This option specifies the serial number to assign to the device. |
161 |
@item addr=@var{addr} |
162 |
Specify the controller's PCI address (if=virtio only). |
163 |
@end table |
164 |
|
165 |
By default, writethrough caching is used for all block device. This means that |
166 |
the host page cache will be used to read and write data but write notification |
167 |
will be sent to the guest only when the data has been reported as written by |
168 |
the storage subsystem. |
169 |
|
170 |
Writeback caching will report data writes as completed as soon as the data is |
171 |
present in the host page cache. This is safe as long as you trust your host. |
172 |
If your host crashes or loses power, then the guest may experience data |
173 |
corruption. |
174 |
|
175 |
The host page cache can be avoided entirely with @option{cache=none}. This will |
176 |
attempt to do disk IO directly to the guests memory. QEMU may still perform |
177 |
an internal copy of the data. |
178 |
|
179 |
Some block drivers perform badly with @option{cache=writethrough}, most notably, |
180 |
qcow2. If performance is more important than correctness, |
181 |
@option{cache=writeback} should be used with qcow2. |
182 |
|
183 |
In case you don't care about data integrity over host failures, use |
184 |
cache=unsafe. This option tells qemu that it never needs to write any data |
185 |
to the disk but can instead keeps things in cache. If anything goes wrong, |
186 |
like your host losing power, the disk storage getting disconnected accidently, |
187 |
etc. you're image will most probably be rendered unusable. When using |
188 |
the @option{-snapshot} option, unsafe caching is always used. |
189 |
|
190 |
Instead of @option{-cdrom} you can use: |
191 |
@example |
192 |
qemu -drive file=file,index=2,media=cdrom |
193 |
@end example |
194 |
|
195 |
Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can |
196 |
use: |
197 |
@example |
198 |
qemu -drive file=file,index=0,media=disk |
199 |
qemu -drive file=file,index=1,media=disk |
200 |
qemu -drive file=file,index=2,media=disk |
201 |
qemu -drive file=file,index=3,media=disk |
202 |
@end example |
203 |
|
204 |
You can connect a CDROM to the slave of ide0: |
205 |
@example |
206 |
qemu -drive file=file,if=ide,index=1,media=cdrom |
207 |
@end example |
208 |
|
209 |
If you don't specify the "file=" argument, you define an empty drive: |
210 |
@example |
211 |
qemu -drive if=ide,index=1,media=cdrom |
212 |
@end example |
213 |
|
214 |
You can connect a SCSI disk with unit ID 6 on the bus #0: |
215 |
@example |
216 |
qemu -drive file=file,if=scsi,bus=0,unit=6 |
217 |
@end example |
218 |
|
219 |
Instead of @option{-fda}, @option{-fdb}, you can use: |
220 |
@example |
221 |
qemu -drive file=file,index=0,if=floppy |
222 |
qemu -drive file=file,index=1,if=floppy |
223 |
@end example |
224 |
|
225 |
By default, @var{interface} is "ide" and @var{index} is automatically |
226 |
incremented: |
227 |
@example |
228 |
qemu -drive file=a -drive file=b" |
229 |
@end example |
230 |
is interpreted like: |
231 |
@example |
232 |
qemu -hda a -hdb b |
233 |
@end example |
234 |
ETEXI |
235 |
|
236 |
DEF("set", HAS_ARG, QEMU_OPTION_set, |
237 |
"-set group.id.arg=value\n" |
238 |
" set <arg> parameter for item <id> of type <group>\n" |
239 |
" i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL) |
240 |
STEXI |
241 |
@item -set |
242 |
@findex -set |
243 |
TODO |
244 |
ETEXI |
245 |
|
246 |
DEF("global", HAS_ARG, QEMU_OPTION_global, |
247 |
"-global driver.property=value\n" |
248 |
" set a global default for a driver property\n", |
249 |
QEMU_ARCH_ALL) |
250 |
STEXI |
251 |
@item -global |
252 |
@findex -global |
253 |
TODO |
254 |
ETEXI |
255 |
|
256 |
DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock, |
257 |
"-mtdblock file use 'file' as on-board Flash memory image\n", |
258 |
QEMU_ARCH_ALL) |
259 |
STEXI |
260 |
@item -mtdblock @var{file} |
261 |
@findex -mtdblock |
262 |
Use @var{file} as on-board Flash memory image. |
263 |
ETEXI |
264 |
|
265 |
DEF("sd", HAS_ARG, QEMU_OPTION_sd, |
266 |
"-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL) |
267 |
STEXI |
268 |
@item -sd @var{file} |
269 |
@findex -sd |
270 |
Use @var{file} as SecureDigital card image. |
271 |
ETEXI |
272 |
|
273 |
DEF("pflash", HAS_ARG, QEMU_OPTION_pflash, |
274 |
"-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL) |
275 |
STEXI |
276 |
@item -pflash @var{file} |
277 |
@findex -pflash |
278 |
Use @var{file} as a parallel flash image. |
279 |
ETEXI |
280 |
|
281 |
DEF("boot", HAS_ARG, QEMU_OPTION_boot, |
282 |
"-boot [order=drives][,once=drives][,menu=on|off]\n" |
283 |
" 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n", |
284 |
QEMU_ARCH_ALL) |
285 |
STEXI |
286 |
@item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off] |
287 |
@findex -boot |
288 |
Specify boot order @var{drives} as a string of drive letters. Valid |
289 |
drive letters depend on the target achitecture. The x86 PC uses: a, b |
290 |
(floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot |
291 |
from network adapter 1-4), hard disk boot is the default. To apply a |
292 |
particular boot order only on the first startup, specify it via |
293 |
@option{once}. |
294 |
|
295 |
Interactive boot menus/prompts can be enabled via @option{menu=on} as far |
296 |
as firmware/BIOS supports them. The default is non-interactive boot. |
297 |
|
298 |
@example |
299 |
# try to boot from network first, then from hard disk |
300 |
qemu -boot order=nc |
301 |
# boot from CD-ROM first, switch back to default order after reboot |
302 |
qemu -boot once=d |
303 |
@end example |
304 |
|
305 |
Note: The legacy format '-boot @var{drives}' is still supported but its |
306 |
use is discouraged as it may be removed from future versions. |
307 |
ETEXI |
308 |
|
309 |
DEF("snapshot", 0, QEMU_OPTION_snapshot, |
310 |
"-snapshot write to temporary files instead of disk image files\n", |
311 |
QEMU_ARCH_ALL) |
312 |
STEXI |
313 |
@item -snapshot |
314 |
@findex -snapshot |
315 |
Write to temporary files instead of disk image files. In this case, |
316 |
the raw disk image you use is not written back. You can however force |
317 |
the write back by pressing @key{C-a s} (@pxref{disk_images}). |
318 |
ETEXI |
319 |
|
320 |
DEF("m", HAS_ARG, QEMU_OPTION_m, |
321 |
"-m megs set virtual RAM size to megs MB [default=" |
322 |
stringify(DEFAULT_RAM_SIZE) "]\n", QEMU_ARCH_ALL) |
323 |
STEXI |
324 |
@item -m @var{megs} |
325 |
@findex -m |
326 |
Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally, |
327 |
a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or |
328 |
gigabytes respectively. |
329 |
ETEXI |
330 |
|
331 |
DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath, |
332 |
"-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL) |
333 |
STEXI |
334 |
@item -mem-path @var{path} |
335 |
Allocate guest RAM from a temporarily created file in @var{path}. |
336 |
ETEXI |
337 |
|
338 |
#ifdef MAP_POPULATE |
339 |
DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc, |
340 |
"-mem-prealloc preallocate guest memory (use with -mem-path)\n", |
341 |
QEMU_ARCH_ALL) |
342 |
STEXI |
343 |
@item -mem-prealloc |
344 |
Preallocate memory when using -mem-path. |
345 |
ETEXI |
346 |
#endif |
347 |
|
348 |
DEF("k", HAS_ARG, QEMU_OPTION_k, |
349 |
"-k language use keyboard layout (for example 'fr' for French)\n", |
350 |
QEMU_ARCH_ALL) |
351 |
STEXI |
352 |
@item -k @var{language} |
353 |
@findex -k |
354 |
Use keyboard layout @var{language} (for example @code{fr} for |
355 |
French). This option is only needed where it is not easy to get raw PC |
356 |
keycodes (e.g. on Macs, with some X11 servers or with a VNC |
357 |
display). You don't normally need to use it on PC/Linux or PC/Windows |
358 |
hosts. |
359 |
|
360 |
The available layouts are: |
361 |
@example |
362 |
ar de-ch es fo fr-ca hu ja mk no pt-br sv |
363 |
da en-gb et fr fr-ch is lt nl pl ru th |
364 |
de en-us fi fr-be hr it lv nl-be pt sl tr |
365 |
@end example |
366 |
|
367 |
The default is @code{en-us}. |
368 |
ETEXI |
369 |
|
370 |
|
371 |
DEF("audio-help", 0, QEMU_OPTION_audio_help, |
372 |
"-audio-help print list of audio drivers and their options\n", |
373 |
QEMU_ARCH_ALL) |
374 |
STEXI |
375 |
@item -audio-help |
376 |
@findex -audio-help |
377 |
Will show the audio subsystem help: list of drivers, tunable |
378 |
parameters. |
379 |
ETEXI |
380 |
|
381 |
DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw, |
382 |
"-soundhw c1,... enable audio support\n" |
383 |
" and only specified sound cards (comma separated list)\n" |
384 |
" use -soundhw ? to get the list of supported cards\n" |
385 |
" use -soundhw all to enable all of them\n", QEMU_ARCH_ALL) |
386 |
STEXI |
387 |
@item -soundhw @var{card1}[,@var{card2},...] or -soundhw all |
388 |
@findex -soundhw |
389 |
Enable audio and selected sound hardware. Use ? to print all |
390 |
available sound hardware. |
391 |
|
392 |
@example |
393 |
qemu -soundhw sb16,adlib disk.img |
394 |
qemu -soundhw es1370 disk.img |
395 |
qemu -soundhw ac97 disk.img |
396 |
qemu -soundhw hda disk.img |
397 |
qemu -soundhw all disk.img |
398 |
qemu -soundhw ? |
399 |
@end example |
400 |
|
401 |
Note that Linux's i810_audio OSS kernel (for AC97) module might |
402 |
require manually specifying clocking. |
403 |
|
404 |
@example |
405 |
modprobe i810_audio clocking=48000 |
406 |
@end example |
407 |
ETEXI |
408 |
|
409 |
STEXI |
410 |
@end table |
411 |
ETEXI |
412 |
|
413 |
DEF("usb", 0, QEMU_OPTION_usb, |
414 |
"-usb enable the USB driver (will be the default soon)\n", |
415 |
QEMU_ARCH_ALL) |
416 |
STEXI |
417 |
USB options: |
418 |
@table @option |
419 |
|
420 |
@item -usb |
421 |
@findex -usb |
422 |
Enable the USB driver (will be the default soon) |
423 |
ETEXI |
424 |
|
425 |
DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice, |
426 |
"-usbdevice name add the host or guest USB device 'name'\n", |
427 |
QEMU_ARCH_ALL) |
428 |
STEXI |
429 |
|
430 |
@item -usbdevice @var{devname} |
431 |
@findex -usbdevice |
432 |
Add the USB device @var{devname}. @xref{usb_devices}. |
433 |
|
434 |
@table @option |
435 |
|
436 |
@item mouse |
437 |
Virtual Mouse. This will override the PS/2 mouse emulation when activated. |
438 |
|
439 |
@item tablet |
440 |
Pointer device that uses absolute coordinates (like a touchscreen). This |
441 |
means qemu is able to report the mouse position without having to grab the |
442 |
mouse. Also overrides the PS/2 mouse emulation when activated. |
443 |
|
444 |
@item disk:[format=@var{format}]:@var{file} |
445 |
Mass storage device based on file. The optional @var{format} argument |
446 |
will be used rather than detecting the format. Can be used to specifiy |
447 |
@code{format=raw} to avoid interpreting an untrusted format header. |
448 |
|
449 |
@item host:@var{bus}.@var{addr} |
450 |
Pass through the host device identified by @var{bus}.@var{addr} (Linux only). |
451 |
|
452 |
@item host:@var{vendor_id}:@var{product_id} |
453 |
Pass through the host device identified by @var{vendor_id}:@var{product_id} |
454 |
(Linux only). |
455 |
|
456 |
@item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev} |
457 |
Serial converter to host character device @var{dev}, see @code{-serial} for the |
458 |
available devices. |
459 |
|
460 |
@item braille |
461 |
Braille device. This will use BrlAPI to display the braille output on a real |
462 |
or fake device. |
463 |
|
464 |
@item net:@var{options} |
465 |
Network adapter that supports CDC ethernet and RNDIS protocols. |
466 |
|
467 |
@end table |
468 |
ETEXI |
469 |
|
470 |
DEF("device", HAS_ARG, QEMU_OPTION_device, |
471 |
"-device driver[,prop[=value][,...]]\n" |
472 |
" add device (based on driver)\n" |
473 |
" prop=value,... sets driver properties\n" |
474 |
" use -device ? to print all possible drivers\n" |
475 |
" use -device driver,? to print all possible properties\n", |
476 |
QEMU_ARCH_ALL) |
477 |
STEXI |
478 |
@item -device @var{driver}[,@var{prop}[=@var{value}][,...]] |
479 |
@findex -device |
480 |
Add device @var{driver}. @var{prop}=@var{value} sets driver |
481 |
properties. Valid properties depend on the driver. To get help on |
482 |
possible drivers and properties, use @code{-device ?} and |
483 |
@code{-device @var{driver},?}. |
484 |
ETEXI |
485 |
|
486 |
DEFHEADING(File system options:) |
487 |
|
488 |
DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev, |
489 |
"-fsdev local,id=id,path=path,security_model=[mapped|passthrough|none]\n", |
490 |
QEMU_ARCH_ALL) |
491 |
|
492 |
STEXI |
493 |
|
494 |
The general form of a File system device option is: |
495 |
@table @option |
496 |
|
497 |
@item -fsdev @var{fstype} ,id=@var{id} [,@var{options}] |
498 |
@findex -fsdev |
499 |
Fstype is one of: |
500 |
@option{local}, |
501 |
The specific Fstype will determine the applicable options. |
502 |
|
503 |
Options to each backend are described below. |
504 |
|
505 |
@item -fsdev local ,id=@var{id} ,path=@var{path} ,security_model=@var{security_model} |
506 |
|
507 |
Create a file-system-"device" for local-filesystem. |
508 |
|
509 |
@option{local} is only available on Linux. |
510 |
|
511 |
@option{path} specifies the path to be exported. @option{path} is required. |
512 |
|
513 |
@option{security_model} specifies the security model to be followed. |
514 |
@option{security_model} is required. |
515 |
|
516 |
@end table |
517 |
ETEXI |
518 |
|
519 |
DEFHEADING(Virtual File system pass-through options:) |
520 |
|
521 |
DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs, |
522 |
"-virtfs local,path=path,mount_tag=tag,security_model=[mapped|passthrough|none]\n", |
523 |
QEMU_ARCH_ALL) |
524 |
|
525 |
STEXI |
526 |
|
527 |
The general form of a Virtual File system pass-through option is: |
528 |
@table @option |
529 |
|
530 |
@item -virtfs @var{fstype} [,@var{options}] |
531 |
@findex -virtfs |
532 |
Fstype is one of: |
533 |
@option{local}, |
534 |
The specific Fstype will determine the applicable options. |
535 |
|
536 |
Options to each backend are described below. |
537 |
|
538 |
@item -virtfs local ,path=@var{path} ,mount_tag=@var{mount_tag} ,security_model=@var{security_model} |
539 |
|
540 |
Create a Virtual file-system-pass through for local-filesystem. |
541 |
|
542 |
@option{local} is only available on Linux. |
543 |
|
544 |
@option{path} specifies the path to be exported. @option{path} is required. |
545 |
|
546 |
@option{security_model} specifies the security model to be followed. |
547 |
@option{security_model} is required. |
548 |
|
549 |
|
550 |
@option{mount_tag} specifies the tag with which the exported file is mounted. |
551 |
@option{mount_tag} is required. |
552 |
|
553 |
@end table |
554 |
ETEXI |
555 |
|
556 |
DEFHEADING() |
557 |
|
558 |
DEF("name", HAS_ARG, QEMU_OPTION_name, |
559 |
"-name string1[,process=string2]\n" |
560 |
" set the name of the guest\n" |
561 |
" string1 sets the window title and string2 the process name (on Linux)\n", |
562 |
QEMU_ARCH_ALL) |
563 |
STEXI |
564 |
@item -name @var{name} |
565 |
@findex -name |
566 |
Sets the @var{name} of the guest. |
567 |
This name will be displayed in the SDL window caption. |
568 |
The @var{name} will also be used for the VNC server. |
569 |
Also optionally set the top visible process name in Linux. |
570 |
ETEXI |
571 |
|
572 |
DEF("uuid", HAS_ARG, QEMU_OPTION_uuid, |
573 |
"-uuid %08x-%04x-%04x-%04x-%012x\n" |
574 |
" specify machine UUID\n", QEMU_ARCH_ALL) |
575 |
STEXI |
576 |
@item -uuid @var{uuid} |
577 |
@findex -uuid |
578 |
Set system UUID. |
579 |
ETEXI |
580 |
|
581 |
STEXI |
582 |
@end table |
583 |
ETEXI |
584 |
|
585 |
DEFHEADING() |
586 |
|
587 |
DEFHEADING(Display options:) |
588 |
|
589 |
STEXI |
590 |
@table @option |
591 |
ETEXI |
592 |
|
593 |
DEF("display", HAS_ARG, QEMU_OPTION_display, |
594 |
"-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n" |
595 |
" [,window_close=on|off]|curses|none|\n" |
596 |
" vnc=<display>[,<optargs>]\n" |
597 |
" select display type\n", QEMU_ARCH_ALL) |
598 |
STEXI |
599 |
@item -display @var{type} |
600 |
@findex -display |
601 |
Select type of display to use. This option is a replacement for the |
602 |
old style -sdl/-curses/... options. Valid values for @var{type} are |
603 |
@table @option |
604 |
@item sdl |
605 |
Display video output via SDL (usually in a separate graphics |
606 |
window; see the SDL documentation for other possibilities). |
607 |
@item curses |
608 |
Display video output via curses. For graphics device models which |
609 |
support a text mode, QEMU can display this output using a |
610 |
curses/ncurses interface. Nothing is displayed when the graphics |
611 |
device is in graphical mode or if the graphics device does not support |
612 |
a text mode. Generally only the VGA device models support text mode. |
613 |
@item none |
614 |
Do not display video output. The guest will still see an emulated |
615 |
graphics card, but its output will not be displayed to the QEMU |
616 |
user. This option differs from the -nographic option in that it |
617 |
only affects what is done with video output; -nographic also changes |
618 |
the destination of the serial and parallel port data. |
619 |
@item vnc |
620 |
Start a VNC server on display <arg> |
621 |
@end table |
622 |
ETEXI |
623 |
|
624 |
DEF("nographic", 0, QEMU_OPTION_nographic, |
625 |
"-nographic disable graphical output and redirect serial I/Os to console\n", |
626 |
QEMU_ARCH_ALL) |
627 |
STEXI |
628 |
@item -nographic |
629 |
@findex -nographic |
630 |
Normally, QEMU uses SDL to display the VGA output. With this option, |
631 |
you can totally disable graphical output so that QEMU is a simple |
632 |
command line application. The emulated serial port is redirected on |
633 |
the console. Therefore, you can still use QEMU to debug a Linux kernel |
634 |
with a serial console. |
635 |
ETEXI |
636 |
|
637 |
DEF("curses", 0, QEMU_OPTION_curses, |
638 |
"-curses use a curses/ncurses interface instead of SDL\n", |
639 |
QEMU_ARCH_ALL) |
640 |
STEXI |
641 |
@item -curses |
642 |
@findex curses |
643 |
Normally, QEMU uses SDL to display the VGA output. With this option, |
644 |
QEMU can display the VGA output when in text mode using a |
645 |
curses/ncurses interface. Nothing is displayed in graphical mode. |
646 |
ETEXI |
647 |
|
648 |
DEF("no-frame", 0, QEMU_OPTION_no_frame, |
649 |
"-no-frame open SDL window without a frame and window decorations\n", |
650 |
QEMU_ARCH_ALL) |
651 |
STEXI |
652 |
@item -no-frame |
653 |
@findex -no-frame |
654 |
Do not use decorations for SDL windows and start them using the whole |
655 |
available screen space. This makes the using QEMU in a dedicated desktop |
656 |
workspace more convenient. |
657 |
ETEXI |
658 |
|
659 |
DEF("alt-grab", 0, QEMU_OPTION_alt_grab, |
660 |
"-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n", |
661 |
QEMU_ARCH_ALL) |
662 |
STEXI |
663 |
@item -alt-grab |
664 |
@findex -alt-grab |
665 |
Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also |
666 |
affects the special keys (for fullscreen, monitor-mode switching, etc). |
667 |
ETEXI |
668 |
|
669 |
DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab, |
670 |
"-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n", |
671 |
QEMU_ARCH_ALL) |
672 |
STEXI |
673 |
@item -ctrl-grab |
674 |
@findex -ctrl-grab |
675 |
Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also |
676 |
affects the special keys (for fullscreen, monitor-mode switching, etc). |
677 |
ETEXI |
678 |
|
679 |
DEF("no-quit", 0, QEMU_OPTION_no_quit, |
680 |
"-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL) |
681 |
STEXI |
682 |
@item -no-quit |
683 |
@findex -no-quit |
684 |
Disable SDL window close capability. |
685 |
ETEXI |
686 |
|
687 |
DEF("sdl", 0, QEMU_OPTION_sdl, |
688 |
"-sdl enable SDL\n", QEMU_ARCH_ALL) |
689 |
STEXI |
690 |
@item -sdl |
691 |
@findex -sdl |
692 |
Enable SDL. |
693 |
ETEXI |
694 |
|
695 |
DEF("spice", HAS_ARG, QEMU_OPTION_spice, |
696 |
"-spice <args> enable spice\n", QEMU_ARCH_ALL) |
697 |
STEXI |
698 |
@item -spice @var{option}[,@var{option}[,...]] |
699 |
@findex -spice |
700 |
Enable the spice remote desktop protocol. Valid options are |
701 |
|
702 |
@table @option |
703 |
|
704 |
@item port=<nr> |
705 |
Set the TCP port spice is listening on for plaintext channels. |
706 |
|
707 |
@item addr=<addr> |
708 |
Set the IP address spice is listening on. Default is any address. |
709 |
|
710 |
@item ipv4 |
711 |
@item ipv6 |
712 |
Force using the specified IP version. |
713 |
|
714 |
@item password=<secret> |
715 |
Set the password you need to authenticate. |
716 |
|
717 |
@item sasl |
718 |
Require that the client use SASL to authenticate with the spice. |
719 |
The exact choice of authentication method used is controlled from the |
720 |
system / user's SASL configuration file for the 'qemu' service. This |
721 |
is typically found in /etc/sasl2/qemu.conf. If running QEMU as an |
722 |
unprivileged user, an environment variable SASL_CONF_PATH can be used |
723 |
to make it search alternate locations for the service config. |
724 |
While some SASL auth methods can also provide data encryption (eg GSSAPI), |
725 |
it is recommended that SASL always be combined with the 'tls' and |
726 |
'x509' settings to enable use of SSL and server certificates. This |
727 |
ensures a data encryption preventing compromise of authentication |
728 |
credentials. |
729 |
|
730 |
@item disable-ticketing |
731 |
Allow client connects without authentication. |
732 |
|
733 |
@item disable-copy-paste |
734 |
Disable copy paste between the client and the guest. |
735 |
|
736 |
@item tls-port=<nr> |
737 |
Set the TCP port spice is listening on for encrypted channels. |
738 |
|
739 |
@item x509-dir=<dir> |
740 |
Set the x509 file directory. Expects same filenames as -vnc $display,x509=$dir |
741 |
|
742 |
@item x509-key-file=<file> |
743 |
@item x509-key-password=<file> |
744 |
@item x509-cert-file=<file> |
745 |
@item x509-cacert-file=<file> |
746 |
@item x509-dh-key-file=<file> |
747 |
The x509 file names can also be configured individually. |
748 |
|
749 |
@item tls-ciphers=<list> |
750 |
Specify which ciphers to use. |
751 |
|
752 |
@item tls-channel=[main|display|inputs|record|playback|tunnel] |
753 |
@item plaintext-channel=[main|display|inputs|record|playback|tunnel] |
754 |
Force specific channel to be used with or without TLS encryption. The |
755 |
options can be specified multiple times to configure multiple |
756 |
channels. The special name "default" can be used to set the default |
757 |
mode. For channels which are not explicitly forced into one mode the |
758 |
spice client is allowed to pick tls/plaintext as he pleases. |
759 |
|
760 |
@item image-compression=[auto_glz|auto_lz|quic|glz|lz|off] |
761 |
Configure image compression (lossless). |
762 |
Default is auto_glz. |
763 |
|
764 |
@item jpeg-wan-compression=[auto|never|always] |
765 |
@item zlib-glz-wan-compression=[auto|never|always] |
766 |
Configure wan image compression (lossy for slow links). |
767 |
Default is auto. |
768 |
|
769 |
@item streaming-video=[off|all|filter] |
770 |
Configure video stream detection. Default is filter. |
771 |
|
772 |
@item agent-mouse=[on|off] |
773 |
Enable/disable passing mouse events via vdagent. Default is on. |
774 |
|
775 |
@item playback-compression=[on|off] |
776 |
Enable/disable audio stream compression (using celt 0.5.1). Default is on. |
777 |
|
778 |
@end table |
779 |
ETEXI |
780 |
|
781 |
DEF("portrait", 0, QEMU_OPTION_portrait, |
782 |
"-portrait rotate graphical output 90 deg left (only PXA LCD)\n", |
783 |
QEMU_ARCH_ALL) |
784 |
STEXI |
785 |
@item -portrait |
786 |
@findex -portrait |
787 |
Rotate graphical output 90 deg left (only PXA LCD). |
788 |
ETEXI |
789 |
|
790 |
DEF("rotate", HAS_ARG, QEMU_OPTION_rotate, |
791 |
"-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n", |
792 |
QEMU_ARCH_ALL) |
793 |
STEXI |
794 |
@item -rotate |
795 |
@findex -rotate |
796 |
Rotate graphical output some deg left (only PXA LCD). |
797 |
ETEXI |
798 |
|
799 |
DEF("vga", HAS_ARG, QEMU_OPTION_vga, |
800 |
"-vga [std|cirrus|vmware|qxl|xenfb|none]\n" |
801 |
" select video card type\n", QEMU_ARCH_ALL) |
802 |
STEXI |
803 |
@item -vga @var{type} |
804 |
@findex -vga |
805 |
Select type of VGA card to emulate. Valid values for @var{type} are |
806 |
@table @option |
807 |
@item cirrus |
808 |
Cirrus Logic GD5446 Video card. All Windows versions starting from |
809 |
Windows 95 should recognize and use this graphic card. For optimal |
810 |
performances, use 16 bit color depth in the guest and the host OS. |
811 |
(This one is the default) |
812 |
@item std |
813 |
Standard VGA card with Bochs VBE extensions. If your guest OS |
814 |
supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want |
815 |
to use high resolution modes (>= 1280x1024x16) then you should use |
816 |
this option. |
817 |
@item vmware |
818 |
VMWare SVGA-II compatible adapter. Use it if you have sufficiently |
819 |
recent XFree86/XOrg server or Windows guest with a driver for this |
820 |
card. |
821 |
@item qxl |
822 |
QXL paravirtual graphic card. It is VGA compatible (including VESA |
823 |
2.0 VBE support). Works best with qxl guest drivers installed though. |
824 |
Recommended choice when using the spice protocol. |
825 |
@item none |
826 |
Disable VGA card. |
827 |
@end table |
828 |
ETEXI |
829 |
|
830 |
DEF("full-screen", 0, QEMU_OPTION_full_screen, |
831 |
"-full-screen start in full screen\n", QEMU_ARCH_ALL) |
832 |
STEXI |
833 |
@item -full-screen |
834 |
@findex -full-screen |
835 |
Start in full screen. |
836 |
ETEXI |
837 |
|
838 |
DEF("g", 1, QEMU_OPTION_g , |
839 |
"-g WxH[xDEPTH] Set the initial graphical resolution and depth\n", |
840 |
QEMU_ARCH_PPC | QEMU_ARCH_SPARC) |
841 |
STEXI |
842 |
@item -g @var{width}x@var{height}[x@var{depth}] |
843 |
@findex -g |
844 |
Set the initial graphical resolution and depth (PPC, SPARC only). |
845 |
ETEXI |
846 |
|
847 |
DEF("vnc", HAS_ARG, QEMU_OPTION_vnc , |
848 |
"-vnc display start a VNC server on display\n", QEMU_ARCH_ALL) |
849 |
STEXI |
850 |
@item -vnc @var{display}[,@var{option}[,@var{option}[,...]]] |
851 |
@findex -vnc |
852 |
Normally, QEMU uses SDL to display the VGA output. With this option, |
853 |
you can have QEMU listen on VNC display @var{display} and redirect the VGA |
854 |
display over the VNC session. It is very useful to enable the usb |
855 |
tablet device when using this option (option @option{-usbdevice |
856 |
tablet}). When using the VNC display, you must use the @option{-k} |
857 |
parameter to set the keyboard layout if you are not using en-us. Valid |
858 |
syntax for the @var{display} is |
859 |
|
860 |
@table @option |
861 |
|
862 |
@item @var{host}:@var{d} |
863 |
|
864 |
TCP connections will only be allowed from @var{host} on display @var{d}. |
865 |
By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can |
866 |
be omitted in which case the server will accept connections from any host. |
867 |
|
868 |
@item unix:@var{path} |
869 |
|
870 |
Connections will be allowed over UNIX domain sockets where @var{path} is the |
871 |
location of a unix socket to listen for connections on. |
872 |
|
873 |
@item none |
874 |
|
875 |
VNC is initialized but not started. The monitor @code{change} command |
876 |
can be used to later start the VNC server. |
877 |
|
878 |
@end table |
879 |
|
880 |
Following the @var{display} value there may be one or more @var{option} flags |
881 |
separated by commas. Valid options are |
882 |
|
883 |
@table @option |
884 |
|
885 |
@item reverse |
886 |
|
887 |
Connect to a listening VNC client via a ``reverse'' connection. The |
888 |
client is specified by the @var{display}. For reverse network |
889 |
connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument |
890 |
is a TCP port number, not a display number. |
891 |
|
892 |
@item password |
893 |
|
894 |
Require that password based authentication is used for client connections. |
895 |
The password must be set separately using the @code{change} command in the |
896 |
@ref{pcsys_monitor} |
897 |
|
898 |
@item tls |
899 |
|
900 |
Require that client use TLS when communicating with the VNC server. This |
901 |
uses anonymous TLS credentials so is susceptible to a man-in-the-middle |
902 |
attack. It is recommended that this option be combined with either the |
903 |
@option{x509} or @option{x509verify} options. |
904 |
|
905 |
@item x509=@var{/path/to/certificate/dir} |
906 |
|
907 |
Valid if @option{tls} is specified. Require that x509 credentials are used |
908 |
for negotiating the TLS session. The server will send its x509 certificate |
909 |
to the client. It is recommended that a password be set on the VNC server |
910 |
to provide authentication of the client when this is used. The path following |
911 |
this option specifies where the x509 certificates are to be loaded from. |
912 |
See the @ref{vnc_security} section for details on generating certificates. |
913 |
|
914 |
@item x509verify=@var{/path/to/certificate/dir} |
915 |
|
916 |
Valid if @option{tls} is specified. Require that x509 credentials are used |
917 |
for negotiating the TLS session. The server will send its x509 certificate |
918 |
to the client, and request that the client send its own x509 certificate. |
919 |
The server will validate the client's certificate against the CA certificate, |
920 |
and reject clients when validation fails. If the certificate authority is |
921 |
trusted, this is a sufficient authentication mechanism. You may still wish |
922 |
to set a password on the VNC server as a second authentication layer. The |
923 |
path following this option specifies where the x509 certificates are to |
924 |
be loaded from. See the @ref{vnc_security} section for details on generating |
925 |
certificates. |
926 |
|
927 |
@item sasl |
928 |
|
929 |
Require that the client use SASL to authenticate with the VNC server. |
930 |
The exact choice of authentication method used is controlled from the |
931 |
system / user's SASL configuration file for the 'qemu' service. This |
932 |
is typically found in /etc/sasl2/qemu.conf. If running QEMU as an |
933 |
unprivileged user, an environment variable SASL_CONF_PATH can be used |
934 |
to make it search alternate locations for the service config. |
935 |
While some SASL auth methods can also provide data encryption (eg GSSAPI), |
936 |
it is recommended that SASL always be combined with the 'tls' and |
937 |
'x509' settings to enable use of SSL and server certificates. This |
938 |
ensures a data encryption preventing compromise of authentication |
939 |
credentials. See the @ref{vnc_security} section for details on using |
940 |
SASL authentication. |
941 |
|
942 |
@item acl |
943 |
|
944 |
Turn on access control lists for checking of the x509 client certificate |
945 |
and SASL party. For x509 certs, the ACL check is made against the |
946 |
certificate's distinguished name. This is something that looks like |
947 |
@code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is |
948 |
made against the username, which depending on the SASL plugin, may |
949 |
include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}. |
950 |
When the @option{acl} flag is set, the initial access list will be |
951 |
empty, with a @code{deny} policy. Thus no one will be allowed to |
952 |
use the VNC server until the ACLs have been loaded. This can be |
953 |
achieved using the @code{acl} monitor command. |
954 |
|
955 |
@item lossy |
956 |
|
957 |
Enable lossy compression methods (gradient, JPEG, ...). If this |
958 |
option is set, VNC client may receive lossy framebuffer updates |
959 |
depending on its encoding settings. Enabling this option can save |
960 |
a lot of bandwidth at the expense of quality. |
961 |
|
962 |
@item non-adaptive |
963 |
|
964 |
Disable adaptive encodings. Adaptive encodings are enabled by default. |
965 |
An adaptive encoding will try to detect frequently updated screen regions, |
966 |
and send updates in these regions using a lossy encoding (like JPEG). |
967 |
This can be really helpful to save bandwidth when playing videos. Disabling |
968 |
adaptive encodings allows to restore the original static behavior of encodings |
969 |
like Tight. |
970 |
|
971 |
@end table |
972 |
ETEXI |
973 |
|
974 |
STEXI |
975 |
@end table |
976 |
ETEXI |
977 |
|
978 |
DEFHEADING() |
979 |
|
980 |
DEFHEADING(i386 target only:) |
981 |
STEXI |
982 |
@table @option |
983 |
ETEXI |
984 |
|
985 |
DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack, |
986 |
"-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n", |
987 |
QEMU_ARCH_I386) |
988 |
STEXI |
989 |
@item -win2k-hack |
990 |
@findex -win2k-hack |
991 |
Use it when installing Windows 2000 to avoid a disk full bug. After |
992 |
Windows 2000 is installed, you no longer need this option (this option |
993 |
slows down the IDE transfers). |
994 |
ETEXI |
995 |
|
996 |
HXCOMM Deprecated by -rtc |
997 |
DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386) |
998 |
|
999 |
DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk, |
1000 |
"-no-fd-bootchk disable boot signature checking for floppy disks\n", |
1001 |
QEMU_ARCH_I386) |
1002 |
STEXI |
1003 |
@item -no-fd-bootchk |
1004 |
@findex -no-fd-bootchk |
1005 |
Disable boot signature checking for floppy disks in Bochs BIOS. It may |
1006 |
be needed to boot from old floppy disks. |
1007 |
TODO: check reference to Bochs BIOS. |
1008 |
ETEXI |
1009 |
|
1010 |
DEF("no-acpi", 0, QEMU_OPTION_no_acpi, |
1011 |
"-no-acpi disable ACPI\n", QEMU_ARCH_I386) |
1012 |
STEXI |
1013 |
@item -no-acpi |
1014 |
@findex -no-acpi |
1015 |
Disable ACPI (Advanced Configuration and Power Interface) support. Use |
1016 |
it if your guest OS complains about ACPI problems (PC target machine |
1017 |
only). |
1018 |
ETEXI |
1019 |
|
1020 |
DEF("no-hpet", 0, QEMU_OPTION_no_hpet, |
1021 |
"-no-hpet disable HPET\n", QEMU_ARCH_I386) |
1022 |
STEXI |
1023 |
@item -no-hpet |
1024 |
@findex -no-hpet |
1025 |
Disable HPET support. |
1026 |
ETEXI |
1027 |
|
1028 |
DEF("balloon", HAS_ARG, QEMU_OPTION_balloon, |
1029 |
"-balloon none disable balloon device\n" |
1030 |
"-balloon virtio[,addr=str]\n" |
1031 |
" enable virtio balloon device (default)\n", QEMU_ARCH_ALL) |
1032 |
STEXI |
1033 |
@item -balloon none |
1034 |
@findex -balloon |
1035 |
Disable balloon device. |
1036 |
@item -balloon virtio[,addr=@var{addr}] |
1037 |
Enable virtio balloon device (default), optionally with PCI address |
1038 |
@var{addr}. |
1039 |
ETEXI |
1040 |
|
1041 |
DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable, |
1042 |
"-acpitable [sig=str][,rev=n][,oem_id=str][,oem_table_id=str][,oem_rev=n][,asl_compiler_id=str][,asl_compiler_rev=n][,data=file1[:file2]...]\n" |
1043 |
" ACPI table description\n", QEMU_ARCH_I386) |
1044 |
STEXI |
1045 |
@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}]...] |
1046 |
@findex -acpitable |
1047 |
Add ACPI table with specified header fields and context from specified files. |
1048 |
ETEXI |
1049 |
|
1050 |
DEF("smbios", HAS_ARG, QEMU_OPTION_smbios, |
1051 |
"-smbios file=binary\n" |
1052 |
" load SMBIOS entry from binary file\n" |
1053 |
"-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n" |
1054 |
" specify SMBIOS type 0 fields\n" |
1055 |
"-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n" |
1056 |
" [,uuid=uuid][,sku=str][,family=str]\n" |
1057 |
" specify SMBIOS type 1 fields\n", QEMU_ARCH_I386) |
1058 |
STEXI |
1059 |
@item -smbios file=@var{binary} |
1060 |
@findex -smbios |
1061 |
Load SMBIOS entry from binary file. |
1062 |
|
1063 |
@item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}] |
1064 |
@findex -smbios |
1065 |
Specify SMBIOS type 0 fields |
1066 |
|
1067 |
@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}] |
1068 |
Specify SMBIOS type 1 fields |
1069 |
ETEXI |
1070 |
|
1071 |
DEFHEADING() |
1072 |
STEXI |
1073 |
@end table |
1074 |
ETEXI |
1075 |
|
1076 |
DEFHEADING(Network options:) |
1077 |
STEXI |
1078 |
@table @option |
1079 |
ETEXI |
1080 |
|
1081 |
HXCOMM Legacy slirp options (now moved to -net user): |
1082 |
#ifdef CONFIG_SLIRP |
1083 |
DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL) |
1084 |
DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL) |
1085 |
DEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL) |
1086 |
#ifndef _WIN32 |
1087 |
DEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL) |
1088 |
#endif |
1089 |
#endif |
1090 |
|
1091 |
DEF("net", HAS_ARG, QEMU_OPTION_net, |
1092 |
"-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" |
1093 |
" create a new Network Interface Card and connect it to VLAN 'n'\n" |
1094 |
#ifdef CONFIG_SLIRP |
1095 |
"-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=y|n]\n" |
1096 |
" [,hostname=host][,dhcpstart=addr][,dns=addr][,tftp=dir][,bootfile=f]\n" |
1097 |
" [,hostfwd=rule][,guestfwd=rule]" |
1098 |
#ifndef _WIN32 |
1099 |
"[,smb=dir[,smbserver=addr]]\n" |
1100 |
#endif |
1101 |
" connect the user mode network stack to VLAN 'n', configure its\n" |
1102 |
" DHCP server and enabled optional services\n" |
1103 |
#endif |
1104 |
#ifdef _WIN32 |
1105 |
"-net tap[,vlan=n][,name=str],ifname=name\n" |
1106 |
" connect the host TAP network interface to VLAN 'n'\n" |
1107 |
#else |
1108 |
"-net tap[,vlan=n][,name=str][,fd=h][,ifname=name][,script=file][,downscript=dfile][,sndbuf=nbytes][,vnet_hdr=on|off][,vhost=on|off][,vhostfd=h][,vhostforce=on|off]\n" |
1109 |
" connect the host TAP network interface to VLAN 'n' and use the\n" |
1110 |
" network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n" |
1111 |
" and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n" |
1112 |
" use '[down]script=no' to disable script execution\n" |
1113 |
" use 'fd=h' to connect to an already opened TAP interface\n" |
1114 |
" use 'sndbuf=nbytes' to limit the size of the send buffer (the\n" |
1115 |
" default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n" |
1116 |
" use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n" |
1117 |
" use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n" |
1118 |
" use vhost=on to enable experimental in kernel accelerator\n" |
1119 |
" (only has effect for virtio guests which use MSIX)\n" |
1120 |
" use vhostforce=on to force vhost on for non-MSIX virtio guests\n" |
1121 |
" use 'vhostfd=h' to connect to an already opened vhost net device\n" |
1122 |
#endif |
1123 |
"-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n" |
1124 |
" connect the vlan 'n' to another VLAN using a socket connection\n" |
1125 |
"-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port[,localaddr=addr]]\n" |
1126 |
" connect the vlan 'n' to multicast maddr and port\n" |
1127 |
" use 'localaddr=addr' to specify the host address to send packets from\n" |
1128 |
#ifdef CONFIG_VDE |
1129 |
"-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n" |
1130 |
" connect the vlan 'n' to port 'n' of a vde switch running\n" |
1131 |
" on host and listening for incoming connections on 'socketpath'.\n" |
1132 |
" Use group 'groupname' and mode 'octalmode' to change default\n" |
1133 |
" ownership and permissions for communication port.\n" |
1134 |
#endif |
1135 |
"-net dump[,vlan=n][,file=f][,len=n]\n" |
1136 |
" dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n" |
1137 |
"-net none use it alone to have zero network devices. If no -net option\n" |
1138 |
" is provided, the default is '-net nic -net user'\n", QEMU_ARCH_ALL) |
1139 |
DEF("netdev", HAS_ARG, QEMU_OPTION_netdev, |
1140 |
"-netdev [" |
1141 |
#ifdef CONFIG_SLIRP |
1142 |
"user|" |
1143 |
#endif |
1144 |
"tap|" |
1145 |
#ifdef CONFIG_VDE |
1146 |
"vde|" |
1147 |
#endif |
1148 |
"socket],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL) |
1149 |
STEXI |
1150 |
@item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}] |
1151 |
@findex -net |
1152 |
Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n} |
1153 |
= 0 is the default). The NIC is an e1000 by default on the PC |
1154 |
target. Optionally, the MAC address can be changed to @var{mac}, the |
1155 |
device address set to @var{addr} (PCI cards only), |
1156 |
and a @var{name} can be assigned for use in monitor commands. |
1157 |
Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors |
1158 |
that the card should have; this option currently only affects virtio cards; set |
1159 |
@var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single |
1160 |
NIC is created. Qemu can emulate several different models of network card. |
1161 |
Valid values for @var{type} are |
1162 |
@code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er}, |
1163 |
@code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139}, |
1164 |
@code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}. |
1165 |
Not all devices are supported on all targets. Use -net nic,model=? |
1166 |
for a list of available devices for your target. |
1167 |
|
1168 |
@item -net user[,@var{option}][,@var{option}][,...] |
1169 |
Use the user mode network stack which requires no administrator |
1170 |
privilege to run. Valid options are: |
1171 |
|
1172 |
@table @option |
1173 |
@item vlan=@var{n} |
1174 |
Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default). |
1175 |
|
1176 |
@item name=@var{name} |
1177 |
Assign symbolic name for use in monitor commands. |
1178 |
|
1179 |
@item net=@var{addr}[/@var{mask}] |
1180 |
Set IP network address the guest will see. Optionally specify the netmask, |
1181 |
either in the form a.b.c.d or as number of valid top-most bits. Default is |
1182 |
10.0.2.0/24. |
1183 |
|
1184 |
@item host=@var{addr} |
1185 |
Specify the guest-visible address of the host. Default is the 2nd IP in the |
1186 |
guest network, i.e. x.x.x.2. |
1187 |
|
1188 |
@item restrict=y|yes|n|no |
1189 |
If this option is enabled, the guest will be isolated, i.e. it will not be |
1190 |
able to contact the host and no guest IP packets will be routed over the host |
1191 |
to the outside. This option does not affect any explicitly set forwarding rules. |
1192 |
|
1193 |
@item hostname=@var{name} |
1194 |
Specifies the client hostname reported by the builtin DHCP server. |
1195 |
|
1196 |
@item dhcpstart=@var{addr} |
1197 |
Specify the first of the 16 IPs the built-in DHCP server can assign. Default |
1198 |
is the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31. |
1199 |
|
1200 |
@item dns=@var{addr} |
1201 |
Specify the guest-visible address of the virtual nameserver. The address must |
1202 |
be different from the host address. Default is the 3rd IP in the guest network, |
1203 |
i.e. x.x.x.3. |
1204 |
|
1205 |
@item tftp=@var{dir} |
1206 |
When using the user mode network stack, activate a built-in TFTP |
1207 |
server. The files in @var{dir} will be exposed as the root of a TFTP server. |
1208 |
The TFTP client on the guest must be configured in binary mode (use the command |
1209 |
@code{bin} of the Unix TFTP client). |
1210 |
|
1211 |
@item bootfile=@var{file} |
1212 |
When using the user mode network stack, broadcast @var{file} as the BOOTP |
1213 |
filename. In conjunction with @option{tftp}, this can be used to network boot |
1214 |
a guest from a local directory. |
1215 |
|
1216 |
Example (using pxelinux): |
1217 |
@example |
1218 |
qemu -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0 |
1219 |
@end example |
1220 |
|
1221 |
@item smb=@var{dir}[,smbserver=@var{addr}] |
1222 |
When using the user mode network stack, activate a built-in SMB |
1223 |
server so that Windows OSes can access to the host files in @file{@var{dir}} |
1224 |
transparently. The IP address of the SMB server can be set to @var{addr}. By |
1225 |
default the 4th IP in the guest network is used, i.e. x.x.x.4. |
1226 |
|
1227 |
In the guest Windows OS, the line: |
1228 |
@example |
1229 |
10.0.2.4 smbserver |
1230 |
@end example |
1231 |
must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me) |
1232 |
or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000). |
1233 |
|
1234 |
Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}. |
1235 |
|
1236 |
Note that a SAMBA server must be installed on the host OS in |
1237 |
@file{/usr/sbin/smbd}. QEMU was tested successfully with smbd versions from |
1238 |
Red Hat 9, Fedora Core 3 and OpenSUSE 11.x. |
1239 |
|
1240 |
@item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport} |
1241 |
Redirect incoming TCP or UDP connections to the host port @var{hostport} to |
1242 |
the guest IP address @var{guestaddr} on guest port @var{guestport}. If |
1243 |
@var{guestaddr} is not specified, its value is x.x.x.15 (default first address |
1244 |
given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can |
1245 |
be bound to a specific host interface. If no connection type is set, TCP is |
1246 |
used. This option can be given multiple times. |
1247 |
|
1248 |
For example, to redirect host X11 connection from screen 1 to guest |
1249 |
screen 0, use the following: |
1250 |
|
1251 |
@example |
1252 |
# on the host |
1253 |
qemu -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...] |
1254 |
# this host xterm should open in the guest X11 server |
1255 |
xterm -display :1 |
1256 |
@end example |
1257 |
|
1258 |
To redirect telnet connections from host port 5555 to telnet port on |
1259 |
the guest, use the following: |
1260 |
|
1261 |
@example |
1262 |
# on the host |
1263 |
qemu -net user,hostfwd=tcp::5555-:23 [...] |
1264 |
telnet localhost 5555 |
1265 |
@end example |
1266 |
|
1267 |
Then when you use on the host @code{telnet localhost 5555}, you |
1268 |
connect to the guest telnet server. |
1269 |
|
1270 |
@item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev} |
1271 |
Forward guest TCP connections to the IP address @var{server} on port @var{port} |
1272 |
to the character device @var{dev}. This option can be given multiple times. |
1273 |
|
1274 |
@end table |
1275 |
|
1276 |
Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still |
1277 |
processed and applied to -net user. Mixing them with the new configuration |
1278 |
syntax gives undefined results. Their use for new applications is discouraged |
1279 |
as they will be removed from future versions. |
1280 |
|
1281 |
@item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}] [,script=@var{file}][,downscript=@var{dfile}] |
1282 |
Connect the host TAP network interface @var{name} to VLAN @var{n}, use |
1283 |
the network script @var{file} to configure it and the network script |
1284 |
@var{dfile} to deconfigure it. If @var{name} is not provided, the OS |
1285 |
automatically provides one. @option{fd}=@var{h} can be used to specify |
1286 |
the handle of an already opened host TAP interface. The default network |
1287 |
configure script is @file{/etc/qemu-ifup} and the default network |
1288 |
deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no} |
1289 |
or @option{downscript=no} to disable script execution. Example: |
1290 |
|
1291 |
@example |
1292 |
qemu linux.img -net nic -net tap |
1293 |
@end example |
1294 |
|
1295 |
More complicated example (two NICs, each one connected to a TAP device) |
1296 |
@example |
1297 |
qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \ |
1298 |
-net nic,vlan=1 -net tap,vlan=1,ifname=tap1 |
1299 |
@end example |
1300 |
|
1301 |
@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] |
1302 |
|
1303 |
Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual |
1304 |
machine using a TCP socket connection. If @option{listen} is |
1305 |
specified, QEMU waits for incoming connections on @var{port} |
1306 |
(@var{host} is optional). @option{connect} is used to connect to |
1307 |
another QEMU instance using the @option{listen} option. @option{fd}=@var{h} |
1308 |
specifies an already opened TCP socket. |
1309 |
|
1310 |
Example: |
1311 |
@example |
1312 |
# launch a first QEMU instance |
1313 |
qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \ |
1314 |
-net socket,listen=:1234 |
1315 |
# connect the VLAN 0 of this instance to the VLAN 0 |
1316 |
# of the first instance |
1317 |
qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \ |
1318 |
-net socket,connect=127.0.0.1:1234 |
1319 |
@end example |
1320 |
|
1321 |
@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] |
1322 |
|
1323 |
Create a VLAN @var{n} shared with another QEMU virtual |
1324 |
machines using a UDP multicast socket, effectively making a bus for |
1325 |
every QEMU with same multicast address @var{maddr} and @var{port}. |
1326 |
NOTES: |
1327 |
@enumerate |
1328 |
@item |
1329 |
Several QEMU can be running on different hosts and share same bus (assuming |
1330 |
correct multicast setup for these hosts). |
1331 |
@item |
1332 |
mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see |
1333 |
@url{http://user-mode-linux.sf.net}. |
1334 |
@item |
1335 |
Use @option{fd=h} to specify an already opened UDP multicast socket. |
1336 |
@end enumerate |
1337 |
|
1338 |
Example: |
1339 |
@example |
1340 |
# launch one QEMU instance |
1341 |
qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \ |
1342 |
-net socket,mcast=230.0.0.1:1234 |
1343 |
# launch another QEMU instance on same "bus" |
1344 |
qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \ |
1345 |
-net socket,mcast=230.0.0.1:1234 |
1346 |
# launch yet another QEMU instance on same "bus" |
1347 |
qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \ |
1348 |
-net socket,mcast=230.0.0.1:1234 |
1349 |
@end example |
1350 |
|
1351 |
Example (User Mode Linux compat.): |
1352 |
@example |
1353 |
# launch QEMU instance (note mcast address selected |
1354 |
# is UML's default) |
1355 |
qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \ |
1356 |
-net socket,mcast=239.192.168.1:1102 |
1357 |
# launch UML |
1358 |
/path/to/linux ubd0=/path/to/root_fs eth0=mcast |
1359 |
@end example |
1360 |
|
1361 |
Example (send packets from host's 1.2.3.4): |
1362 |
@example |
1363 |
qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \ |
1364 |
-net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4 |
1365 |
@end example |
1366 |
|
1367 |
@item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] |
1368 |
Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and |
1369 |
listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname} |
1370 |
and MODE @var{octalmode} to change default ownership and permissions for |
1371 |
communication port. This option is available only if QEMU has been compiled |
1372 |
with vde support enabled. |
1373 |
|
1374 |
Example: |
1375 |
@example |
1376 |
# launch vde switch |
1377 |
vde_switch -F -sock /tmp/myswitch |
1378 |
# launch QEMU instance |
1379 |
qemu linux.img -net nic -net vde,sock=/tmp/myswitch |
1380 |
@end example |
1381 |
|
1382 |
@item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}] |
1383 |
Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default). |
1384 |
At most @var{len} bytes (64k by default) per packet are stored. The file format is |
1385 |
libpcap, so it can be analyzed with tools such as tcpdump or Wireshark. |
1386 |
|
1387 |
@item -net none |
1388 |
Indicate that no network devices should be configured. It is used to |
1389 |
override the default configuration (@option{-net nic -net user}) which |
1390 |
is activated if no @option{-net} options are provided. |
1391 |
|
1392 |
@end table |
1393 |
ETEXI |
1394 |
|
1395 |
DEFHEADING() |
1396 |
|
1397 |
DEFHEADING(Character device options:) |
1398 |
|
1399 |
DEF("chardev", HAS_ARG, QEMU_OPTION_chardev, |
1400 |
"-chardev null,id=id[,mux=on|off]\n" |
1401 |
"-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n" |
1402 |
" [,server][,nowait][,telnet][,mux=on|off] (tcp)\n" |
1403 |
"-chardev socket,id=id,path=path[,server][,nowait][,telnet],[mux=on|off] (unix)\n" |
1404 |
"-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n" |
1405 |
" [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n" |
1406 |
"-chardev msmouse,id=id[,mux=on|off]\n" |
1407 |
"-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n" |
1408 |
" [,mux=on|off]\n" |
1409 |
"-chardev file,id=id,path=path[,mux=on|off]\n" |
1410 |
"-chardev pipe,id=id,path=path[,mux=on|off]\n" |
1411 |
#ifdef _WIN32 |
1412 |
"-chardev console,id=id[,mux=on|off]\n" |
1413 |
"-chardev serial,id=id,path=path[,mux=on|off]\n" |
1414 |
#else |
1415 |
"-chardev pty,id=id[,mux=on|off]\n" |
1416 |
"-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n" |
1417 |
#endif |
1418 |
#ifdef CONFIG_BRLAPI |
1419 |
"-chardev braille,id=id[,mux=on|off]\n" |
1420 |
#endif |
1421 |
#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \ |
1422 |
|| defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) |
1423 |
"-chardev tty,id=id,path=path[,mux=on|off]\n" |
1424 |
#endif |
1425 |
#if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__) |
1426 |
"-chardev parport,id=id,path=path[,mux=on|off]\n" |
1427 |
#endif |
1428 |
#if defined(CONFIG_SPICE) |
1429 |
"-chardev spicevmc,id=id,name=name[,debug=debug]\n" |
1430 |
#endif |
1431 |
, QEMU_ARCH_ALL |
1432 |
) |
1433 |
|
1434 |
STEXI |
1435 |
|
1436 |
The general form of a character device option is: |
1437 |
@table @option |
1438 |
|
1439 |
@item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}] |
1440 |
@findex -chardev |
1441 |
Backend is one of: |
1442 |
@option{null}, |
1443 |
@option{socket}, |
1444 |
@option{udp}, |
1445 |
@option{msmouse}, |
1446 |
@option{vc}, |
1447 |
@option{file}, |
1448 |
@option{pipe}, |
1449 |
@option{console}, |
1450 |
@option{serial}, |
1451 |
@option{pty}, |
1452 |
@option{stdio}, |
1453 |
@option{braille}, |
1454 |
@option{tty}, |
1455 |
@option{parport}, |
1456 |
@option{spicevmc}. |
1457 |
The specific backend will determine the applicable options. |
1458 |
|
1459 |
All devices must have an id, which can be any string up to 127 characters long. |
1460 |
It is used to uniquely identify this device in other command line directives. |
1461 |
|
1462 |
A character device may be used in multiplexing mode by multiple front-ends. |
1463 |
The key sequence of @key{Control-a} and @key{c} will rotate the input focus |
1464 |
between attached front-ends. Specify @option{mux=on} to enable this mode. |
1465 |
|
1466 |
Options to each backend are described below. |
1467 |
|
1468 |
@item -chardev null ,id=@var{id} |
1469 |
A void device. This device will not emit any data, and will drop any data it |
1470 |
receives. The null backend does not take any options. |
1471 |
|
1472 |
@item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet] |
1473 |
|
1474 |
Create a two-way stream socket, which can be either a TCP or a unix socket. A |
1475 |
unix socket will be created if @option{path} is specified. Behaviour is |
1476 |
undefined if TCP options are specified for a unix socket. |
1477 |
|
1478 |
@option{server} specifies that the socket shall be a listening socket. |
1479 |
|
1480 |
@option{nowait} specifies that QEMU should not block waiting for a client to |
1481 |
connect to a listening socket. |
1482 |
|
1483 |
@option{telnet} specifies that traffic on the socket should interpret telnet |
1484 |
escape sequences. |
1485 |
|
1486 |
TCP and unix socket options are given below: |
1487 |
|
1488 |
@table @option |
1489 |
|
1490 |
@item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay] |
1491 |
|
1492 |
@option{host} for a listening socket specifies the local address to be bound. |
1493 |
For a connecting socket species the remote host to connect to. @option{host} is |
1494 |
optional for listening sockets. If not specified it defaults to @code{0.0.0.0}. |
1495 |
|
1496 |
@option{port} for a listening socket specifies the local port to be bound. For a |
1497 |
connecting socket specifies the port on the remote host to connect to. |
1498 |
@option{port} can be given as either a port number or a service name. |
1499 |
@option{port} is required. |
1500 |
|
1501 |
@option{to} is only relevant to listening sockets. If it is specified, and |
1502 |
@option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up |
1503 |
to and including @option{to} until it succeeds. @option{to} must be specified |
1504 |
as a port number. |
1505 |
|
1506 |
@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. |
1507 |
If neither is specified the socket may use either protocol. |
1508 |
|
1509 |
@option{nodelay} disables the Nagle algorithm. |
1510 |
|
1511 |
@item unix options: path=@var{path} |
1512 |
|
1513 |
@option{path} specifies the local path of the unix socket. @option{path} is |
1514 |
required. |
1515 |
|
1516 |
@end table |
1517 |
|
1518 |
@item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6] |
1519 |
|
1520 |
Sends all traffic from the guest to a remote host over UDP. |
1521 |
|
1522 |
@option{host} specifies the remote host to connect to. If not specified it |
1523 |
defaults to @code{localhost}. |
1524 |
|
1525 |
@option{port} specifies the port on the remote host to connect to. @option{port} |
1526 |
is required. |
1527 |
|
1528 |
@option{localaddr} specifies the local address to bind to. If not specified it |
1529 |
defaults to @code{0.0.0.0}. |
1530 |
|
1531 |
@option{localport} specifies the local port to bind to. If not specified any |
1532 |
available local port will be used. |
1533 |
|
1534 |
@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. |
1535 |
If neither is specified the device may use either protocol. |
1536 |
|
1537 |
@item -chardev msmouse ,id=@var{id} |
1538 |
|
1539 |
Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not |
1540 |
take any options. |
1541 |
|
1542 |
@item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]] |
1543 |
|
1544 |
Connect to a QEMU text console. @option{vc} may optionally be given a specific |
1545 |
size. |
1546 |
|
1547 |
@option{width} and @option{height} specify the width and height respectively of |
1548 |
the console, in pixels. |
1549 |
|
1550 |
@option{cols} and @option{rows} specify that the console be sized to fit a text |
1551 |
console with the given dimensions. |
1552 |
|
1553 |
@item -chardev file ,id=@var{id} ,path=@var{path} |
1554 |
|
1555 |
Log all traffic received from the guest to a file. |
1556 |
|
1557 |
@option{path} specifies the path of the file to be opened. This file will be |
1558 |
created if it does not already exist, and overwritten if it does. @option{path} |
1559 |
is required. |
1560 |
|
1561 |
@item -chardev pipe ,id=@var{id} ,path=@var{path} |
1562 |
|
1563 |
Create a two-way connection to the guest. The behaviour differs slightly between |
1564 |
Windows hosts and other hosts: |
1565 |
|
1566 |
On Windows, a single duplex pipe will be created at |
1567 |
@file{\\.pipe\@option{path}}. |
1568 |
|
1569 |
On other hosts, 2 pipes will be created called @file{@option{path}.in} and |
1570 |
@file{@option{path}.out}. Data written to @file{@option{path}.in} will be |
1571 |
received by the guest. Data written by the guest can be read from |
1572 |
@file{@option{path}.out}. QEMU will not create these fifos, and requires them to |
1573 |
be present. |
1574 |
|
1575 |
@option{path} forms part of the pipe path as described above. @option{path} is |
1576 |
required. |
1577 |
|
1578 |
@item -chardev console ,id=@var{id} |
1579 |
|
1580 |
Send traffic from the guest to QEMU's standard output. @option{console} does not |
1581 |
take any options. |
1582 |
|
1583 |
@option{console} is only available on Windows hosts. |
1584 |
|
1585 |
@item -chardev serial ,id=@var{id} ,path=@option{path} |
1586 |
|
1587 |
Send traffic from the guest to a serial device on the host. |
1588 |
|
1589 |
@option{serial} is |
1590 |
only available on Windows hosts. |
1591 |
|
1592 |
@option{path} specifies the name of the serial device to open. |
1593 |
|
1594 |
@item -chardev pty ,id=@var{id} |
1595 |
|
1596 |
Create a new pseudo-terminal on the host and connect to it. @option{pty} does |
1597 |
not take any options. |
1598 |
|
1599 |
@option{pty} is not available on Windows hosts. |
1600 |
|
1601 |
@item -chardev stdio ,id=@var{id} [,signal=on|off] |
1602 |
Connect to standard input and standard output of the qemu process. |
1603 |
|
1604 |
@option{signal} controls if signals are enabled on the terminal, that includes |
1605 |
exiting QEMU with the key sequence @key{Control-c}. This option is enabled by |
1606 |
default, use @option{signal=off} to disable it. |
1607 |
|
1608 |
@option{stdio} is not available on Windows hosts. |
1609 |
|
1610 |
@item -chardev braille ,id=@var{id} |
1611 |
|
1612 |
Connect to a local BrlAPI server. @option{braille} does not take any options. |
1613 |
|
1614 |
@item -chardev tty ,id=@var{id} ,path=@var{path} |
1615 |
|
1616 |
Connect to a local tty device. |
1617 |
|
1618 |
@option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and |
1619 |
DragonFlyBSD hosts. |
1620 |
|
1621 |
@option{path} specifies the path to the tty. @option{path} is required. |
1622 |
|
1623 |
@item -chardev parport ,id=@var{id} ,path=@var{path} |
1624 |
|
1625 |
@option{parport} is only available on Linux, FreeBSD and DragonFlyBSD hosts. |
1626 |
|
1627 |
Connect to a local parallel port. |
1628 |
|
1629 |
@option{path} specifies the path to the parallel port device. @option{path} is |
1630 |
required. |
1631 |
|
1632 |
#if defined(CONFIG_SPICE) |
1633 |
@item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name} |
1634 |
|
1635 |
@option{debug} debug level for spicevmc |
1636 |
|
1637 |
@option{name} name of spice channel to connect to |
1638 |
|
1639 |
Connect to a spice virtual machine channel, such as vdiport. |
1640 |
#endif |
1641 |
|
1642 |
@end table |
1643 |
ETEXI |
1644 |
|
1645 |
DEFHEADING() |
1646 |
|
1647 |
DEFHEADING(Bluetooth(R) options:) |
1648 |
|
1649 |
DEF("bt", HAS_ARG, QEMU_OPTION_bt, \ |
1650 |
"-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \ |
1651 |
"-bt hci,host[:id]\n" \ |
1652 |
" use host's HCI with the given name\n" \ |
1653 |
"-bt hci[,vlan=n]\n" \ |
1654 |
" emulate a standard HCI in virtual scatternet 'n'\n" \ |
1655 |
"-bt vhci[,vlan=n]\n" \ |
1656 |
" add host computer to virtual scatternet 'n' using VHCI\n" \ |
1657 |
"-bt device:dev[,vlan=n]\n" \ |
1658 |
" emulate a bluetooth device 'dev' in scatternet 'n'\n", |
1659 |
QEMU_ARCH_ALL) |
1660 |
STEXI |
1661 |
@table @option |
1662 |
|
1663 |
@item -bt hci[...] |
1664 |
@findex -bt |
1665 |
Defines the function of the corresponding Bluetooth HCI. -bt options |
1666 |
are matched with the HCIs present in the chosen machine type. For |
1667 |
example when emulating a machine with only one HCI built into it, only |
1668 |
the first @code{-bt hci[...]} option is valid and defines the HCI's |
1669 |
logic. The Transport Layer is decided by the machine type. Currently |
1670 |
the machines @code{n800} and @code{n810} have one HCI and all other |
1671 |
machines have none. |
1672 |
|
1673 |
@anchor{bt-hcis} |
1674 |
The following three types are recognized: |
1675 |
|
1676 |
@table @option |
1677 |
@item -bt hci,null |
1678 |
(default) The corresponding Bluetooth HCI assumes no internal logic |
1679 |
and will not respond to any HCI commands or emit events. |
1680 |
|
1681 |
@item -bt hci,host[:@var{id}] |
1682 |
(@code{bluez} only) The corresponding HCI passes commands / events |
1683 |
to / from the physical HCI identified by the name @var{id} (default: |
1684 |
@code{hci0}) on the computer running QEMU. Only available on @code{bluez} |
1685 |
capable systems like Linux. |
1686 |
|
1687 |
@item -bt hci[,vlan=@var{n}] |
1688 |
Add a virtual, standard HCI that will participate in the Bluetooth |
1689 |
scatternet @var{n} (default @code{0}). Similarly to @option{-net} |
1690 |
VLANs, devices inside a bluetooth network @var{n} can only communicate |
1691 |
with other devices in the same network (scatternet). |
1692 |
@end table |
1693 |
|
1694 |
@item -bt vhci[,vlan=@var{n}] |
1695 |
(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached |
1696 |
to the host bluetooth stack instead of to the emulated target. This |
1697 |
allows the host and target machines to participate in a common scatternet |
1698 |
and communicate. Requires the Linux @code{vhci} driver installed. Can |
1699 |
be used as following: |
1700 |
|
1701 |
@example |
1702 |
qemu [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5 |
1703 |
@end example |
1704 |
|
1705 |
@item -bt device:@var{dev}[,vlan=@var{n}] |
1706 |
Emulate a bluetooth device @var{dev} and place it in network @var{n} |
1707 |
(default @code{0}). QEMU can only emulate one type of bluetooth devices |
1708 |
currently: |
1709 |
|
1710 |
@table @option |
1711 |
@item keyboard |
1712 |
Virtual wireless keyboard implementing the HIDP bluetooth profile. |
1713 |
@end table |
1714 |
@end table |
1715 |
ETEXI |
1716 |
|
1717 |
DEFHEADING() |
1718 |
|
1719 |
DEFHEADING(Linux/Multiboot boot specific:) |
1720 |
STEXI |
1721 |
|
1722 |
When using these options, you can use a given Linux or Multiboot |
1723 |
kernel without installing it in the disk image. It can be useful |
1724 |
for easier testing of various kernels. |
1725 |
|
1726 |
@table @option |
1727 |
ETEXI |
1728 |
|
1729 |
DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \ |
1730 |
"-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL) |
1731 |
STEXI |
1732 |
@item -kernel @var{bzImage} |
1733 |
@findex -kernel |
1734 |
Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel |
1735 |
or in multiboot format. |
1736 |
ETEXI |
1737 |
|
1738 |
DEF("append", HAS_ARG, QEMU_OPTION_append, \ |
1739 |
"-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL) |
1740 |
STEXI |
1741 |
@item -append @var{cmdline} |
1742 |
@findex -append |
1743 |
Use @var{cmdline} as kernel command line |
1744 |
ETEXI |
1745 |
|
1746 |
DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \ |
1747 |
"-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL) |
1748 |
STEXI |
1749 |
@item -initrd @var{file} |
1750 |
@findex -initrd |
1751 |
Use @var{file} as initial ram disk. |
1752 |
|
1753 |
@item -initrd "@var{file1} arg=foo,@var{file2}" |
1754 |
|
1755 |
This syntax is only available with multiboot. |
1756 |
|
1757 |
Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the |
1758 |
first module. |
1759 |
ETEXI |
1760 |
|
1761 |
STEXI |
1762 |
@end table |
1763 |
ETEXI |
1764 |
|
1765 |
DEFHEADING() |
1766 |
|
1767 |
DEFHEADING(Debug/Expert options:) |
1768 |
|
1769 |
STEXI |
1770 |
@table @option |
1771 |
ETEXI |
1772 |
|
1773 |
DEF("serial", HAS_ARG, QEMU_OPTION_serial, \ |
1774 |
"-serial dev redirect the serial port to char device 'dev'\n", |
1775 |
QEMU_ARCH_ALL) |
1776 |
STEXI |
1777 |
@item -serial @var{dev} |
1778 |
@findex -serial |
1779 |
Redirect the virtual serial port to host character device |
1780 |
@var{dev}. The default device is @code{vc} in graphical mode and |
1781 |
@code{stdio} in non graphical mode. |
1782 |
|
1783 |
This option can be used several times to simulate up to 4 serial |
1784 |
ports. |
1785 |
|
1786 |
Use @code{-serial none} to disable all serial ports. |
1787 |
|
1788 |
Available character devices are: |
1789 |
@table @option |
1790 |
@item vc[:@var{W}x@var{H}] |
1791 |
Virtual console. Optionally, a width and height can be given in pixel with |
1792 |
@example |
1793 |
vc:800x600 |
1794 |
@end example |
1795 |
It is also possible to specify width or height in characters: |
1796 |
@example |
1797 |
vc:80Cx24C |
1798 |
@end example |
1799 |
@item pty |
1800 |
[Linux only] Pseudo TTY (a new PTY is automatically allocated) |
1801 |
@item none |
1802 |
No device is allocated. |
1803 |
@item null |
1804 |
void device |
1805 |
@item /dev/XXX |
1806 |
[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port |
1807 |
parameters are set according to the emulated ones. |
1808 |
@item /dev/parport@var{N} |
1809 |
[Linux only, parallel port only] Use host parallel port |
1810 |
@var{N}. Currently SPP and EPP parallel port features can be used. |
1811 |
@item file:@var{filename} |
1812 |
Write output to @var{filename}. No character can be read. |
1813 |
@item stdio |
1814 |
[Unix only] standard input/output |
1815 |
@item pipe:@var{filename} |
1816 |
name pipe @var{filename} |
1817 |
@item COM@var{n} |
1818 |
[Windows only] Use host serial port @var{n} |
1819 |
@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}] |
1820 |
This implements UDP Net Console. |
1821 |
When @var{remote_host} or @var{src_ip} are not specified |
1822 |
they default to @code{0.0.0.0}. |
1823 |
When not using a specified @var{src_port} a random port is automatically chosen. |
1824 |
|
1825 |
If you just want a simple readonly console you can use @code{netcat} or |
1826 |
@code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as: |
1827 |
@code{nc -u -l -p 4555}. Any time qemu writes something to that port it |
1828 |
will appear in the netconsole session. |
1829 |
|
1830 |
If you plan to send characters back via netconsole or you want to stop |
1831 |
and start qemu a lot of times, you should have qemu use the same |
1832 |
source port each time by using something like @code{-serial |
1833 |
udp::4555@@:4556} to qemu. Another approach is to use a patched |
1834 |
version of netcat which can listen to a TCP port and send and receive |
1835 |
characters via udp. If you have a patched version of netcat which |
1836 |
activates telnet remote echo and single char transfer, then you can |
1837 |
use the following options to step up a netcat redirector to allow |
1838 |
telnet on port 5555 to access the qemu port. |
1839 |
@table @code |
1840 |
@item Qemu Options: |
1841 |
-serial udp::4555@@:4556 |
1842 |
@item netcat options: |
1843 |
-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T |
1844 |
@item telnet options: |
1845 |
localhost 5555 |
1846 |
@end table |
1847 |
|
1848 |
@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay] |
1849 |
The TCP Net Console has two modes of operation. It can send the serial |
1850 |
I/O to a location or wait for a connection from a location. By default |
1851 |
the TCP Net Console is sent to @var{host} at the @var{port}. If you use |
1852 |
the @var{server} option QEMU will wait for a client socket application |
1853 |
to connect to the port before continuing, unless the @code{nowait} |
1854 |
option was specified. The @code{nodelay} option disables the Nagle buffering |
1855 |
algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only |
1856 |
one TCP connection at a time is accepted. You can use @code{telnet} to |
1857 |
connect to the corresponding character device. |
1858 |
@table @code |
1859 |
@item Example to send tcp console to 192.168.0.2 port 4444 |
1860 |
-serial tcp:192.168.0.2:4444 |
1861 |
@item Example to listen and wait on port 4444 for connection |
1862 |
-serial tcp::4444,server |
1863 |
@item Example to not wait and listen on ip 192.168.0.100 port 4444 |
1864 |
-serial tcp:192.168.0.100:4444,server,nowait |
1865 |
@end table |
1866 |
|
1867 |
@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay] |
1868 |
The telnet protocol is used instead of raw tcp sockets. The options |
1869 |
work the same as if you had specified @code{-serial tcp}. The |
1870 |
difference is that the port acts like a telnet server or client using |
1871 |
telnet option negotiation. This will also allow you to send the |
1872 |
MAGIC_SYSRQ sequence if you use a telnet that supports sending the break |
1873 |
sequence. Typically in unix telnet you do it with Control-] and then |
1874 |
type "send break" followed by pressing the enter key. |
1875 |
|
1876 |
@item unix:@var{path}[,server][,nowait] |
1877 |
A unix domain socket is used instead of a tcp socket. The option works the |
1878 |
same as if you had specified @code{-serial tcp} except the unix domain socket |
1879 |
@var{path} is used for connections. |
1880 |
|
1881 |
@item mon:@var{dev_string} |
1882 |
This is a special option to allow the monitor to be multiplexed onto |
1883 |
another serial port. The monitor is accessed with key sequence of |
1884 |
@key{Control-a} and then pressing @key{c}. See monitor access |
1885 |
@ref{pcsys_keys} in the -nographic section for more keys. |
1886 |
@var{dev_string} should be any one of the serial devices specified |
1887 |
above. An example to multiplex the monitor onto a telnet server |
1888 |
listening on port 4444 would be: |
1889 |
@table @code |
1890 |
@item -serial mon:telnet::4444,server,nowait |
1891 |
@end table |
1892 |
|
1893 |
@item braille |
1894 |
Braille device. This will use BrlAPI to display the braille output on a real |
1895 |
or fake device. |
1896 |
|
1897 |
@item msmouse |
1898 |
Three button serial mouse. Configure the guest to use Microsoft protocol. |
1899 |
@end table |
1900 |
ETEXI |
1901 |
|
1902 |
DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \ |
1903 |
"-parallel dev redirect the parallel port to char device 'dev'\n", |
1904 |
QEMU_ARCH_ALL) |
1905 |
STEXI |
1906 |
@item -parallel @var{dev} |
1907 |
@findex -parallel |
1908 |
Redirect the virtual parallel port to host device @var{dev} (same |
1909 |
devices as the serial port). On Linux hosts, @file{/dev/parportN} can |
1910 |
be used to use hardware devices connected on the corresponding host |
1911 |
parallel port. |
1912 |
|
1913 |
This option can be used several times to simulate up to 3 parallel |
1914 |
ports. |
1915 |
|
1916 |
Use @code{-parallel none} to disable all parallel ports. |
1917 |
ETEXI |
1918 |
|
1919 |
DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \ |
1920 |
"-monitor dev redirect the monitor to char device 'dev'\n", |
1921 |
QEMU_ARCH_ALL) |
1922 |
STEXI |
1923 |
@item -monitor @var{dev} |
1924 |
@findex -monitor |
1925 |
Redirect the monitor to host device @var{dev} (same devices as the |
1926 |
serial port). |
1927 |
The default device is @code{vc} in graphical mode and @code{stdio} in |
1928 |
non graphical mode. |
1929 |
ETEXI |
1930 |
DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \ |
1931 |
"-qmp dev like -monitor but opens in 'control' mode\n", |
1932 |
QEMU_ARCH_ALL) |
1933 |
STEXI |
1934 |
@item -qmp @var{dev} |
1935 |
@findex -qmp |
1936 |
Like -monitor but opens in 'control' mode. |
1937 |
ETEXI |
1938 |
|
1939 |
DEF("mon", HAS_ARG, QEMU_OPTION_mon, \ |
1940 |
"-mon chardev=[name][,mode=readline|control][,default]\n", QEMU_ARCH_ALL) |
1941 |
STEXI |
1942 |
@item -mon chardev=[name][,mode=readline|control][,default] |
1943 |
@findex -mon |
1944 |
Setup monitor on chardev @var{name}. |
1945 |
ETEXI |
1946 |
|
1947 |
DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \ |
1948 |
"-debugcon dev redirect the debug console to char device 'dev'\n", |
1949 |
QEMU_ARCH_ALL) |
1950 |
STEXI |
1951 |
@item -debugcon @var{dev} |
1952 |
@findex -debugcon |
1953 |
Redirect the debug console to host device @var{dev} (same devices as the |
1954 |
serial port). The debug console is an I/O port which is typically port |
1955 |
0xe9; writing to that I/O port sends output to this device. |
1956 |
The default device is @code{vc} in graphical mode and @code{stdio} in |
1957 |
non graphical mode. |
1958 |
ETEXI |
1959 |
|
1960 |
DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \ |
1961 |
"-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL) |
1962 |
STEXI |
1963 |
@item -pidfile @var{file} |
1964 |
@findex -pidfile |
1965 |
Store the QEMU process PID in @var{file}. It is useful if you launch QEMU |
1966 |
from a script. |
1967 |
ETEXI |
1968 |
|
1969 |
DEF("singlestep", 0, QEMU_OPTION_singlestep, \ |
1970 |
"-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL) |
1971 |
STEXI |
1972 |
@item -singlestep |
1973 |
@findex -singlestep |
1974 |
Run the emulation in single step mode. |
1975 |
ETEXI |
1976 |
|
1977 |
DEF("S", 0, QEMU_OPTION_S, \ |
1978 |
"-S freeze CPU at startup (use 'c' to start execution)\n", |
1979 |
QEMU_ARCH_ALL) |
1980 |
STEXI |
1981 |
@item -S |
1982 |
@findex -S |
1983 |
Do not start CPU at startup (you must type 'c' in the monitor). |
1984 |
ETEXI |
1985 |
|
1986 |
DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \ |
1987 |
"-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL) |
1988 |
STEXI |
1989 |
@item -gdb @var{dev} |
1990 |
@findex -gdb |
1991 |
Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical |
1992 |
connections will likely be TCP-based, but also UDP, pseudo TTY, or even |
1993 |
stdio are reasonable use case. The latter is allowing to start qemu from |
1994 |
within gdb and establish the connection via a pipe: |
1995 |
@example |
1996 |
(gdb) target remote | exec qemu -gdb stdio ... |
1997 |
@end example |
1998 |
ETEXI |
1999 |
|
2000 |
DEF("s", 0, QEMU_OPTION_s, \ |
2001 |
"-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n", |
2002 |
QEMU_ARCH_ALL) |
2003 |
STEXI |
2004 |
@item -s |
2005 |
@findex -s |
2006 |
Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234 |
2007 |
(@pxref{gdb_usage}). |
2008 |
ETEXI |
2009 |
|
2010 |
DEF("d", HAS_ARG, QEMU_OPTION_d, \ |
2011 |
"-d item1,... output log to /tmp/qemu.log (use -d ? for a list of log items)\n", |
2012 |
QEMU_ARCH_ALL) |
2013 |
STEXI |
2014 |
@item -d |
2015 |
@findex -d |
2016 |
Output log in /tmp/qemu.log |
2017 |
ETEXI |
2018 |
|
2019 |
DEF("D", HAS_ARG, QEMU_OPTION_D, \ |
2020 |
"-D logfile output log to logfile (instead of the default /tmp/qemu.log)\n", |
2021 |
QEMU_ARCH_ALL) |
2022 |
STEXI |
2023 |
@item -D |
2024 |
@findex -D |
2025 |
Output log in logfile instead of /tmp/qemu.log |
2026 |
ETEXI |
2027 |
|
2028 |
DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \ |
2029 |
"-hdachs c,h,s[,t]\n" \ |
2030 |
" force hard disk 0 physical geometry and the optional BIOS\n" \ |
2031 |
" translation (t=none or lba) (usually qemu can guess them)\n", |
2032 |
QEMU_ARCH_ALL) |
2033 |
STEXI |
2034 |
@item -hdachs @var{c},@var{h},@var{s},[,@var{t}] |
2035 |
@findex -hdachs |
2036 |
Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <= |
2037 |
@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS |
2038 |
translation mode (@var{t}=none, lba or auto). Usually QEMU can guess |
2039 |
all those parameters. This option is useful for old MS-DOS disk |
2040 |
images. |
2041 |
ETEXI |
2042 |
|
2043 |
DEF("L", HAS_ARG, QEMU_OPTION_L, \ |
2044 |
"-L path set the directory for the BIOS, VGA BIOS and keymaps\n", |
2045 |
QEMU_ARCH_ALL) |
2046 |
STEXI |
2047 |
@item -L @var{path} |
2048 |
@findex -L |
2049 |
Set the directory for the BIOS, VGA BIOS and keymaps. |
2050 |
ETEXI |
2051 |
|
2052 |
DEF("bios", HAS_ARG, QEMU_OPTION_bios, \ |
2053 |
"-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL) |
2054 |
STEXI |
2055 |
@item -bios @var{file} |
2056 |
@findex -bios |
2057 |
Set the filename for the BIOS. |
2058 |
ETEXI |
2059 |
|
2060 |
DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \ |
2061 |
"-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL) |
2062 |
STEXI |
2063 |
@item -enable-kvm |
2064 |
@findex -enable-kvm |
2065 |
Enable KVM full virtualization support. This option is only available |
2066 |
if KVM support is enabled when compiling. |
2067 |
ETEXI |
2068 |
|
2069 |
DEF("machine", HAS_ARG, QEMU_OPTION_machine, \ |
2070 |
"-machine accel=accel1[:accel2] use an accelerator (kvm,xen,tcg), default is tcg\n", QEMU_ARCH_ALL) |
2071 |
STEXI |
2072 |
@item -machine accel=@var{accels} |
2073 |
@findex -machine |
2074 |
This is use to enable an accelerator, in kvm,xen,tcg. |
2075 |
By default, it use only tcg. If there a more than one accelerator |
2076 |
specified, the next one is used if the first don't work. |
2077 |
ETEXI |
2078 |
|
2079 |
DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid, |
2080 |
"-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL) |
2081 |
DEF("xen-create", 0, QEMU_OPTION_xen_create, |
2082 |
"-xen-create create domain using xen hypercalls, bypassing xend\n" |
2083 |
" warning: should not be used when xend is in use\n", |
2084 |
QEMU_ARCH_ALL) |
2085 |
DEF("xen-attach", 0, QEMU_OPTION_xen_attach, |
2086 |
"-xen-attach attach to existing xen domain\n" |
2087 |
" xend will use this when starting qemu\n", |
2088 |
QEMU_ARCH_ALL) |
2089 |
STEXI |
2090 |
@item -xen-domid @var{id} |
2091 |
@findex -xen-domid |
2092 |
Specify xen guest domain @var{id} (XEN only). |
2093 |
@item -xen-create |
2094 |
@findex -xen-create |
2095 |
Create domain using xen hypercalls, bypassing xend. |
2096 |
Warning: should not be used when xend is in use (XEN only). |
2097 |
@item -xen-attach |
2098 |
@findex -xen-attach |
2099 |
Attach to existing xen domain. |
2100 |
xend will use this when starting qemu (XEN only). |
2101 |
ETEXI |
2102 |
|
2103 |
DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \ |
2104 |
"-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL) |
2105 |
STEXI |
2106 |
@item -no-reboot |
2107 |
@findex -no-reboot |
2108 |
Exit instead of rebooting. |
2109 |
ETEXI |
2110 |
|
2111 |
DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \ |
2112 |
"-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL) |
2113 |
STEXI |
2114 |
@item -no-shutdown |
2115 |
@findex -no-shutdown |
2116 |
Don't exit QEMU on guest shutdown, but instead only stop the emulation. |
2117 |
This allows for instance switching to monitor to commit changes to the |
2118 |
disk image. |
2119 |
ETEXI |
2120 |
|
2121 |
DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \ |
2122 |
"-loadvm [tag|id]\n" \ |
2123 |
" start right away with a saved state (loadvm in monitor)\n", |
2124 |
QEMU_ARCH_ALL) |
2125 |
STEXI |
2126 |
@item -loadvm @var{file} |
2127 |
@findex -loadvm |
2128 |
Start right away with a saved state (@code{loadvm} in monitor) |
2129 |
ETEXI |
2130 |
|
2131 |
#ifndef _WIN32 |
2132 |
DEF("daemonize", 0, QEMU_OPTION_daemonize, \ |
2133 |
"-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL) |
2134 |
#endif |
2135 |
STEXI |
2136 |
@item -daemonize |
2137 |
@findex -daemonize |
2138 |
Daemonize the QEMU process after initialization. QEMU will not detach from |
2139 |
standard IO until it is ready to receive connections on any of its devices. |
2140 |
This option is a useful way for external programs to launch QEMU without having |
2141 |
to cope with initialization race conditions. |
2142 |
ETEXI |
2143 |
|
2144 |
DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \ |
2145 |
"-option-rom rom load a file, rom, into the option ROM space\n", |
2146 |
QEMU_ARCH_ALL) |
2147 |
STEXI |
2148 |
@item -option-rom @var{file} |
2149 |
@findex -option-rom |
2150 |
Load the contents of @var{file} as an option ROM. |
2151 |
This option is useful to load things like EtherBoot. |
2152 |
ETEXI |
2153 |
|
2154 |
DEF("clock", HAS_ARG, QEMU_OPTION_clock, \ |
2155 |
"-clock force the use of the given methods for timer alarm.\n" \ |
2156 |
" To see what timers are available use -clock ?\n", |
2157 |
QEMU_ARCH_ALL) |
2158 |
STEXI |
2159 |
@item -clock @var{method} |
2160 |
@findex -clock |
2161 |
Force the use of the given methods for timer alarm. To see what timers |
2162 |
are available use -clock ?. |
2163 |
ETEXI |
2164 |
|
2165 |
HXCOMM Options deprecated by -rtc |
2166 |
DEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL) |
2167 |
DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL) |
2168 |
|
2169 |
DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \ |
2170 |
"-rtc [base=utc|localtime|date][,clock=host|vm][,driftfix=none|slew]\n" \ |
2171 |
" set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n", |
2172 |
QEMU_ARCH_ALL) |
2173 |
|
2174 |
STEXI |
2175 |
|
2176 |
@item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew] |
2177 |
@findex -rtc |
2178 |
Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current |
2179 |
UTC or local time, respectively. @code{localtime} is required for correct date in |
2180 |
MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the |
2181 |
format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC. |
2182 |
|
2183 |
By default the RTC is driven by the host system time. This allows to use the |
2184 |
RTC as accurate reference clock inside the guest, specifically if the host |
2185 |
time is smoothly following an accurate external reference clock, e.g. via NTP. |
2186 |
If you want to isolate the guest time from the host, even prevent it from |
2187 |
progressing during suspension, you can set @option{clock} to @code{vm} instead. |
2188 |
|
2189 |
Enable @option{driftfix} (i386 targets only) if you experience time drift problems, |
2190 |
specifically with Windows' ACPI HAL. This option will try to figure out how |
2191 |
many timer interrupts were not processed by the Windows guest and will |
2192 |
re-inject them. |
2193 |
ETEXI |
2194 |
|
2195 |
DEF("icount", HAS_ARG, QEMU_OPTION_icount, \ |
2196 |
"-icount [N|auto]\n" \ |
2197 |
" enable virtual instruction counter with 2^N clock ticks per\n" \ |
2198 |
" instruction\n", QEMU_ARCH_ALL) |
2199 |
STEXI |
2200 |
@item -icount [@var{N}|auto] |
2201 |
@findex -icount |
2202 |
Enable virtual instruction counter. The virtual cpu will execute one |
2203 |
instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified |
2204 |
then the virtual cpu speed will be automatically adjusted to keep virtual |
2205 |
time within a few seconds of real time. |
2206 |
|
2207 |
Note that while this option can give deterministic behavior, it does not |
2208 |
provide cycle accurate emulation. Modern CPUs contain superscalar out of |
2209 |
order cores with complex cache hierarchies. The number of instructions |
2210 |
executed often has little or no correlation with actual performance. |
2211 |
ETEXI |
2212 |
|
2213 |
DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \ |
2214 |
"-watchdog i6300esb|ib700\n" \ |
2215 |
" enable virtual hardware watchdog [default=none]\n", |
2216 |
QEMU_ARCH_ALL) |
2217 |
STEXI |
2218 |
@item -watchdog @var{model} |
2219 |
@findex -watchdog |
2220 |
Create a virtual hardware watchdog device. Once enabled (by a guest |
2221 |
action), the watchdog must be periodically polled by an agent inside |
2222 |
the guest or else the guest will be restarted. |
2223 |
|
2224 |
The @var{model} is the model of hardware watchdog to emulate. Choices |
2225 |
for model are: @code{ib700} (iBASE 700) which is a very simple ISA |
2226 |
watchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O |
2227 |
controller hub) which is a much more featureful PCI-based dual-timer |
2228 |
watchdog. Choose a model for which your guest has drivers. |
2229 |
|
2230 |
Use @code{-watchdog ?} to list available hardware models. Only one |
2231 |
watchdog can be enabled for a guest. |
2232 |
ETEXI |
2233 |
|
2234 |
DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \ |
2235 |
"-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \ |
2236 |
" action when watchdog fires [default=reset]\n", |
2237 |
QEMU_ARCH_ALL) |
2238 |
STEXI |
2239 |
@item -watchdog-action @var{action} |
2240 |
|
2241 |
The @var{action} controls what QEMU will do when the watchdog timer |
2242 |
expires. |
2243 |
The default is |
2244 |
@code{reset} (forcefully reset the guest). |
2245 |
Other possible actions are: |
2246 |
@code{shutdown} (attempt to gracefully shutdown the guest), |
2247 |
@code{poweroff} (forcefully poweroff the guest), |
2248 |
@code{pause} (pause the guest), |
2249 |
@code{debug} (print a debug message and continue), or |
2250 |
@code{none} (do nothing). |
2251 |
|
2252 |
Note that the @code{shutdown} action requires that the guest responds |
2253 |
to ACPI signals, which it may not be able to do in the sort of |
2254 |
situations where the watchdog would have expired, and thus |
2255 |
@code{-watchdog-action shutdown} is not recommended for production use. |
2256 |
|
2257 |
Examples: |
2258 |
|
2259 |
@table @code |
2260 |
@item -watchdog i6300esb -watchdog-action pause |
2261 |
@item -watchdog ib700 |
2262 |
@end table |
2263 |
ETEXI |
2264 |
|
2265 |
DEF("echr", HAS_ARG, QEMU_OPTION_echr, \ |
2266 |
"-echr chr set terminal escape character instead of ctrl-a\n", |
2267 |
QEMU_ARCH_ALL) |
2268 |
STEXI |
2269 |
|
2270 |
@item -echr @var{numeric_ascii_value} |
2271 |
@findex -echr |
2272 |
Change the escape character used for switching to the monitor when using |
2273 |
monitor and serial sharing. The default is @code{0x01} when using the |
2274 |
@code{-nographic} option. @code{0x01} is equal to pressing |
2275 |
@code{Control-a}. You can select a different character from the ascii |
2276 |
control keys where 1 through 26 map to Control-a through Control-z. For |
2277 |
instance you could use the either of the following to change the escape |
2278 |
character to Control-t. |
2279 |
@table @code |
2280 |
@item -echr 0x14 |
2281 |
@item -echr 20 |
2282 |
@end table |
2283 |
ETEXI |
2284 |
|
2285 |
DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \ |
2286 |
"-virtioconsole c\n" \ |
2287 |
" set virtio console\n", QEMU_ARCH_ALL) |
2288 |
STEXI |
2289 |
@item -virtioconsole @var{c} |
2290 |
@findex -virtioconsole |
2291 |
Set virtio console. |
2292 |
|
2293 |
This option is maintained for backward compatibility. |
2294 |
|
2295 |
Please use @code{-device virtconsole} for the new way of invocation. |
2296 |
ETEXI |
2297 |
|
2298 |
DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \ |
2299 |
"-show-cursor show cursor\n", QEMU_ARCH_ALL) |
2300 |
STEXI |
2301 |
@item -show-cursor |
2302 |
@findex -show-cursor |
2303 |
Show cursor. |
2304 |
ETEXI |
2305 |
|
2306 |
DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \ |
2307 |
"-tb-size n set TB size\n", QEMU_ARCH_ALL) |
2308 |
STEXI |
2309 |
@item -tb-size @var{n} |
2310 |
@findex -tb-size |
2311 |
Set TB size. |
2312 |
ETEXI |
2313 |
|
2314 |
DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ |
2315 |
"-incoming p prepare for incoming migration, listen on port p\n", |
2316 |
QEMU_ARCH_ALL) |
2317 |
STEXI |
2318 |
@item -incoming @var{port} |
2319 |
@findex -incoming |
2320 |
Prepare for incoming migration, listen on @var{port}. |
2321 |
ETEXI |
2322 |
|
2323 |
DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \ |
2324 |
"-nodefaults don't create default devices\n", QEMU_ARCH_ALL) |
2325 |
STEXI |
2326 |
@item -nodefaults |
2327 |
@findex -nodefaults |
2328 |
Don't create default devices. |
2329 |
ETEXI |
2330 |
|
2331 |
#ifndef _WIN32 |
2332 |
DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \ |
2333 |
"-chroot dir chroot to dir just before starting the VM\n", |
2334 |
QEMU_ARCH_ALL) |
2335 |
#endif |
2336 |
STEXI |
2337 |
@item -chroot @var{dir} |
2338 |
@findex -chroot |
2339 |
Immediately before starting guest execution, chroot to the specified |
2340 |
directory. Especially useful in combination with -runas. |
2341 |
ETEXI |
2342 |
|
2343 |
#ifndef _WIN32 |
2344 |
DEF("runas", HAS_ARG, QEMU_OPTION_runas, \ |
2345 |
"-runas user change to user id user just before starting the VM\n", |
2346 |
QEMU_ARCH_ALL) |
2347 |
#endif |
2348 |
STEXI |
2349 |
@item -runas @var{user} |
2350 |
@findex -runas |
2351 |
Immediately before starting guest execution, drop root privileges, switching |
2352 |
to the specified user. |
2353 |
ETEXI |
2354 |
|
2355 |
DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env, |
2356 |
"-prom-env variable=value\n" |
2357 |
" set OpenBIOS nvram variables\n", |
2358 |
QEMU_ARCH_PPC | QEMU_ARCH_SPARC) |
2359 |
STEXI |
2360 |
@item -prom-env @var{variable}=@var{value} |
2361 |
@findex -prom-env |
2362 |
Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only). |
2363 |
ETEXI |
2364 |
DEF("semihosting", 0, QEMU_OPTION_semihosting, |
2365 |
"-semihosting semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K) |
2366 |
STEXI |
2367 |
@item -semihosting |
2368 |
@findex -semihosting |
2369 |
Semihosting mode (ARM, M68K only). |
2370 |
ETEXI |
2371 |
DEF("old-param", 0, QEMU_OPTION_old_param, |
2372 |
"-old-param old param mode\n", QEMU_ARCH_ARM) |
2373 |
STEXI |
2374 |
@item -old-param |
2375 |
@findex -old-param (ARM) |
2376 |
Old param mode (ARM only). |
2377 |
ETEXI |
2378 |
|
2379 |
DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig, |
2380 |
"-readconfig <file>\n", QEMU_ARCH_ALL) |
2381 |
STEXI |
2382 |
@item -readconfig @var{file} |
2383 |
@findex -readconfig |
2384 |
Read device configuration from @var{file}. |
2385 |
ETEXI |
2386 |
DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig, |
2387 |
"-writeconfig <file>\n" |
2388 |
" read/write config file\n", QEMU_ARCH_ALL) |
2389 |
STEXI |
2390 |
@item -writeconfig @var{file} |
2391 |
@findex -writeconfig |
2392 |
Write device configuration to @var{file}. |
2393 |
ETEXI |
2394 |
DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig, |
2395 |
"-nodefconfig\n" |
2396 |
" do not load default config files at startup\n", |
2397 |
QEMU_ARCH_ALL) |
2398 |
STEXI |
2399 |
@item -nodefconfig |
2400 |
@findex -nodefconfig |
2401 |
Normally QEMU loads a configuration file from @var{sysconfdir}/qemu.conf and |
2402 |
@var{sysconfdir}/target-@var{ARCH}.conf on startup. The @code{-nodefconfig} |
2403 |
option will prevent QEMU from loading these configuration files at startup. |
2404 |
ETEXI |
2405 |
#ifdef CONFIG_SIMPLE_TRACE |
2406 |
DEF("trace", HAS_ARG, QEMU_OPTION_trace, |
2407 |
"-trace\n" |
2408 |
" Specify a trace file to log traces to\n", |
2409 |
QEMU_ARCH_ALL) |
2410 |
STEXI |
2411 |
@item -trace |
2412 |
@findex -trace |
2413 |
Specify a trace file to log output traces to. |
2414 |
ETEXI |
2415 |
#endif |
2416 |
|
2417 |
HXCOMM This is the last statement. Insert new options before this line! |
2418 |
STEXI |
2419 |
@end table |
2420 |
ETEXI |