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