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