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