qemu-options.hx 81.3 KB
Newer Older
1
2
3
HXCOMM Use DEFHEADING() to define headings in both help text and texi
HXCOMM Text between STEXI and ETEXI are copied to texi version and
HXCOMM discarded from C version
4
5
6
HXCOMM DEF(option, HAS_ARG/0, opt_enum, opt_help, arch_mask) is used to
HXCOMM construct option structures, enums and help message for specified
HXCOMM architectures.
7
8
9
10
11
12
13
14
HXCOMM HXCOMM can be used for comments, discarded from both texi and C

DEFHEADING(Standard options:)
STEXI
@table @option
ETEXI

DEF("help", 0, QEMU_OPTION_h,
15
    "-h or -help     display this help and exit\n", QEMU_ARCH_ALL)
16
17
STEXI
@item -h
18
@findex -h
19
20
21
Display help and exit
ETEXI

pbrook's avatar
pbrook committed
22
DEF("version", 0, QEMU_OPTION_version,
23
    "-version        display version information and exit\n", QEMU_ARCH_ALL)
pbrook's avatar
pbrook committed
24
25
STEXI
@item -version
26
@findex -version
pbrook's avatar
pbrook committed
27
28
29
Display version information and exit
ETEXI

30
DEF("M", HAS_ARG, QEMU_OPTION_M,
31
    "-M machine      select emulated machine (-M ? for list)\n", QEMU_ARCH_ALL)
32
33
STEXI
@item -M @var{machine}
34
@findex -M
35
36
37
38
Select the emulated @var{machine} (@code{-M ?} for list)
ETEXI

DEF("cpu", HAS_ARG, QEMU_OPTION_cpu,
39
    "-cpu cpu        select CPU (-cpu ? for list)\n", QEMU_ARCH_ALL)
40
41
STEXI
@item -cpu @var{model}
42
@findex -cpu
43
44
45
46
Select CPU model (-cpu ? for list and additional feature selection)
ETEXI

DEF("smp", HAS_ARG, QEMU_OPTION_smp,
47
    "-smp n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n"
48
49
    "                set the number of CPUs to 'n' [default=1]\n"
    "                maxcpus= maximum number of total cpus, including\n"
50
    "                offline CPUs for hotplug, etc\n"
51
52
    "                cores= number of CPU cores on one socket\n"
    "                threads= number of threads on one CPU core\n"
53
54
    "                sockets= number of discrete sockets in the system\n",
        QEMU_ARCH_ALL)
55
STEXI
56
@item -smp @var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}]
57
@findex -smp
58
59
60
Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs
to 4.
61
62
63
64
65
For the PC target, the number of @var{cores} per socket, the number
of @var{threads} per cores and the total number of @var{sockets} can be
specified. Missing values will be computed. If any on the three values is
given, the total number of CPUs @var{n} can be omitted. @var{maxcpus}
specifies the maximum number of hotpluggable CPUs.
66
67
ETEXI

68
DEF("numa", HAS_ARG, QEMU_OPTION_numa,
69
    "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL)
70
71
STEXI
@item -numa @var{opts}
72
@findex -numa
73
74
75
76
Simulate a multi node NUMA system. If mem and cpus are omitted, resources
are split equally.
ETEXI

77
DEF("fda", HAS_ARG, QEMU_OPTION_fda,
78
79
    "-fda/-fdb file  use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL)
DEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL)
80
81
82
STEXI
@item -fda @var{file}
@item -fdb @var{file}
83
84
@findex -fda
@findex -fdb
85
86
87
88
89
Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can
use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}).
ETEXI

DEF("hda", HAS_ARG, QEMU_OPTION_hda,
90
91
    "-hda/-hdb file  use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL)
DEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL)
92
DEF("hdc", HAS_ARG, QEMU_OPTION_hdc,
93
94
    "-hdc/-hdd file  use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL)
DEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL)
95
96
97
98
99
STEXI
@item -hda @var{file}
@item -hdb @var{file}
@item -hdc @var{file}
@item -hdd @var{file}
100
101
102
103
@findex -hda
@findex -hdb
@findex -hdc
@findex -hdd
104
105
106
107
Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
ETEXI

DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom,
108
109
    "-cdrom file     use 'file' as IDE cdrom image (cdrom is ide1 master)\n",
    QEMU_ARCH_ALL)
110
111
STEXI
@item -cdrom @var{file}
112
@findex -cdrom
113
114
115
116
117
118
119
120
Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and
@option{-cdrom} at the same time). You can use the host CD-ROM by
using @file{/dev/cdrom} as filename (@pxref{host_drives}).
ETEXI

DEF("drive", HAS_ARG, QEMU_OPTION_drive,
    "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n"
    "       [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n"
121
    "       [,cache=writethrough|writeback|none|unsafe][,format=f]\n"
122
123
    "       [,serial=s][,addr=A][,id=name][,aio=threads|native]\n"
    "       [,readonly=on|off]\n"
124
    "                use 'file' as a drive image\n", QEMU_ARCH_ALL)
125
126
STEXI
@item -drive @var{option}[,@var{option}[,@var{option}[,...]]]
127
@findex -drive
128
129
130

Define a new drive. Valid options are:

131
@table @option
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
@item file=@var{file}
This option defines which disk image (@pxref{disk_images}) to use with
this drive. If the filename contains comma, you must double it
(for instance, "file=my,,file" to use file "my,file").
@item if=@var{interface}
This option defines on which type on interface the drive is connected.
Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio.
@item bus=@var{bus},unit=@var{unit}
These options define where is connected the drive by defining the bus number and
the unit id.
@item index=@var{index}
This option defines where is connected the drive by using an index in the list
of available connectors of a given interface type.
@item media=@var{media}
This option defines the type of the media: disk or cdrom.
@item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}]
These options have the same definition as they have in @option{-hdachs}.
@item snapshot=@var{snapshot}
@var{snapshot} is "on" or "off" and allows to enable snapshot for given drive (see @option{-snapshot}).
@item cache=@var{cache}
152
@var{cache} is "none", "writeback", "unsafe", or "writethrough" and controls how the host cache is used to access block data.
153
154
@item aio=@var{aio}
@var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO.
155
156
157
158
159
160
@item format=@var{format}
Specify which disk @var{format} will be used rather than detecting
the format.  Can be used to specifiy format=raw to avoid interpreting
an untrusted format header.
@item serial=@var{serial}
This option specifies the serial number to assign to the device.
161
162
@item addr=@var{addr}
Specify the controller's PCI address (if=virtio only).
163
164
165
166
167
168
169
170
171
172
@end table

By default, writethrough caching is used for all block device.  This means that
the host page cache will be used to read and write data but write notification
will be sent to the guest only when the data has been reported as written by
the storage subsystem.

Writeback caching will report data writes as completed as soon as the data is
present in the host page cache.  This is safe as long as you trust your host.
If your host crashes or loses power, then the guest may experience data
173
corruption.
174

175
The host page cache can be avoided entirely with @option{cache=none}.  This will
176
177
178
179
180
attempt to do disk IO directly to the guests memory.  QEMU may still perform
an internal copy of the data.

Some block drivers perform badly with @option{cache=writethrough}, most notably,
qcow2.  If performance is more important than correctness,
181
@option{cache=writeback} should be used with qcow2.
182

183
184
185
186
In case you don't care about data integrity over host failures, use
cache=unsafe. This option tells qemu that it never needs to write any data
to the disk but can instead keeps things in cache. If anything goes wrong,
like your host losing power, the disk storage getting disconnected accidently,
187
188
etc. you're image will most probably be rendered unusable.   When using
the @option{-snapshot} option, unsafe caching is always used.
189

190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
Instead of @option{-cdrom} you can use:
@example
qemu -drive file=file,index=2,media=cdrom
@end example

Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
use:
@example
qemu -drive file=file,index=0,media=disk
qemu -drive file=file,index=1,media=disk
qemu -drive file=file,index=2,media=disk
qemu -drive file=file,index=3,media=disk
@end example

You can connect a CDROM to the slave of ide0:
@example
qemu -drive file=file,if=ide,index=1,media=cdrom
@end example

If you don't specify the "file=" argument, you define an empty drive:
@example
qemu -drive if=ide,index=1,media=cdrom
@end example

You can connect a SCSI disk with unit ID 6 on the bus #0:
@example
qemu -drive file=file,if=scsi,bus=0,unit=6
@end example

Instead of @option{-fda}, @option{-fdb}, you can use:
@example
qemu -drive file=file,index=0,if=floppy
qemu -drive file=file,index=1,if=floppy
@end example

By default, @var{interface} is "ide" and @var{index} is automatically
incremented:
@example
qemu -drive file=a -drive file=b"
@end example
is interpreted like:
@example
qemu -hda a -hdb b
@end example
ETEXI

236
237
238
DEF("set", HAS_ARG, QEMU_OPTION_set,
    "-set group.id.arg=value\n"
    "                set <arg> parameter for item <id> of type <group>\n"
239
    "                i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL)
240
241
242
243
244
245
246
247
STEXI
@item -set
@findex -set
TODO
ETEXI

DEF("global", HAS_ARG, QEMU_OPTION_global,
    "-global driver.property=value\n"
248
249
    "                set a global default for a driver property\n",
    QEMU_ARCH_ALL)
250
251
252
253
254
255
STEXI
@item -global
@findex -global
TODO
ETEXI

256
DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock,
257
258
    "-mtdblock file  use 'file' as on-board Flash memory image\n",
    QEMU_ARCH_ALL)
259
STEXI
260
@item -mtdblock @var{file}
261
@findex -mtdblock
262
Use @var{file} as on-board Flash memory image.
263
264
265
ETEXI

DEF("sd", HAS_ARG, QEMU_OPTION_sd,
266
    "-sd file        use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL)
267
STEXI
268
@item -sd @var{file}
269
@findex -sd
270
Use @var{file} as SecureDigital card image.
271
272
273
ETEXI

DEF("pflash", HAS_ARG, QEMU_OPTION_pflash,
274
    "-pflash file    use 'file' as a parallel flash image\n", QEMU_ARCH_ALL)
275
STEXI
276
@item -pflash @var{file}
277
@findex -pflash
278
Use @var{file} as a parallel flash image.
279
280
281
ETEXI

DEF("boot", HAS_ARG, QEMU_OPTION_boot,
Jan Kiszka's avatar
Jan Kiszka committed
282
    "-boot [order=drives][,once=drives][,menu=on|off]\n"
283
284
    "                'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n",
    QEMU_ARCH_ALL)
285
STEXI
Jan Kiszka's avatar
Jan Kiszka committed
286
@item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off]
287
@findex -boot
Jan Kiszka's avatar
Jan Kiszka committed
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
Specify boot order @var{drives} as a string of drive letters. Valid
drive letters depend on the target achitecture. The x86 PC uses: a, b
(floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot
from network adapter 1-4), hard disk boot is the default. To apply a
particular boot order only on the first startup, specify it via
@option{once}.

Interactive boot menus/prompts can be enabled via @option{menu=on} as far
as firmware/BIOS supports them. The default is non-interactive boot.

@example
# try to boot from network first, then from hard disk
qemu -boot order=nc
# boot from CD-ROM first, switch back to default order after reboot
qemu -boot once=d
@end example

Note: The legacy format '-boot @var{drives}' is still supported but its
use is discouraged as it may be removed from future versions.
307
308
309
ETEXI

DEF("snapshot", 0, QEMU_OPTION_snapshot,
310
311
    "-snapshot       write to temporary files instead of disk image files\n",
    QEMU_ARCH_ALL)
312
313
STEXI
@item -snapshot
314
@findex -snapshot
315
316
317
318
319
320
Write to temporary files instead of disk image files. In this case,
the raw disk image you use is not written back. You can however force
the write back by pressing @key{C-a s} (@pxref{disk_images}).
ETEXI

DEF("m", HAS_ARG, QEMU_OPTION_m,
321
    "-m megs         set virtual RAM size to megs MB [default="
322
    stringify(DEFAULT_RAM_SIZE) "]\n", QEMU_ARCH_ALL)
323
324
STEXI
@item -m @var{megs}
325
@findex -m
326
327
328
329
330
Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB.  Optionally,
a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
gigabytes respectively.
ETEXI

331
DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath,
332
    "-mem-path FILE  provide backing storage for guest RAM\n", QEMU_ARCH_ALL)
333
334
335
336
337
338
339
STEXI
@item -mem-path @var{path}
Allocate guest RAM from a temporarily created file in @var{path}.
ETEXI

#ifdef MAP_POPULATE
DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc,
340
341
    "-mem-prealloc   preallocate guest memory (use with -mem-path)\n",
    QEMU_ARCH_ALL)
342
343
344
345
346
347
STEXI
@item -mem-prealloc
Preallocate memory when using -mem-path.
ETEXI
#endif

348
DEF("k", HAS_ARG, QEMU_OPTION_k,
349
350
    "-k language     use keyboard layout (for example 'fr' for French)\n",
    QEMU_ARCH_ALL)
351
352
STEXI
@item -k @var{language}
353
@findex -k
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
Use keyboard layout @var{language} (for example @code{fr} for
French). This option is only needed where it is not easy to get raw PC
keycodes (e.g. on Macs, with some X11 servers or with a VNC
display). You don't normally need to use it on PC/Linux or PC/Windows
hosts.

The available layouts are:
@example
ar  de-ch  es  fo     fr-ca  hu  ja  mk     no  pt-br  sv
da  en-gb  et  fr     fr-ch  is  lt  nl     pl  ru     th
de  en-us  fi  fr-be  hr     it  lv  nl-be  pt  sl     tr
@end example

The default is @code{en-us}.
ETEXI


DEF("audio-help", 0, QEMU_OPTION_audio_help,
372
373
    "-audio-help     print list of audio drivers and their options\n",
    QEMU_ARCH_ALL)
374
375
STEXI
@item -audio-help
376
@findex -audio-help
377
378
379
380
381
382
383
384
Will show the audio subsystem help: list of drivers, tunable
parameters.
ETEXI

DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw,
    "-soundhw c1,... enable audio support\n"
    "                and only specified sound cards (comma separated list)\n"
    "                use -soundhw ? to get the list of supported cards\n"
385
    "                use -soundhw all to enable all of them\n", QEMU_ARCH_ALL)
386
387
STEXI
@item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
388
@findex -soundhw
389
390
391
392
393
394
395
Enable audio and selected sound hardware. Use ? to print all
available sound hardware.

@example
qemu -soundhw sb16,adlib disk.img
qemu -soundhw es1370 disk.img
qemu -soundhw ac97 disk.img
396
qemu -soundhw hda disk.img
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
qemu -soundhw all disk.img
qemu -soundhw ?
@end example

Note that Linux's i810_audio OSS kernel (for AC97) module might
require manually specifying clocking.

@example
modprobe i810_audio clocking=48000
@end example
ETEXI

STEXI
@end table
ETEXI

DEF("usb", 0, QEMU_OPTION_usb,
414
415
    "-usb            enable the USB driver (will be the default soon)\n",
    QEMU_ARCH_ALL)
416
417
418
419
420
STEXI
USB options:
@table @option

@item -usb
421
@findex -usb
422
423
424
425
Enable the USB driver (will be the default soon)
ETEXI

DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice,
426
427
    "-usbdevice name add the host or guest USB device 'name'\n",
    QEMU_ARCH_ALL)
428
429
430
STEXI

@item -usbdevice @var{devname}
431
@findex -usbdevice
432
433
Add the USB device @var{devname}. @xref{usb_devices}.

434
@table @option
435
436
437
438
439
440
441
442
443

@item mouse
Virtual Mouse. This will override the PS/2 mouse emulation when activated.

@item tablet
Pointer device that uses absolute coordinates (like a touchscreen). This
means qemu is able to report the mouse position without having to grab the
mouse. Also overrides the PS/2 mouse emulation when activated.

444
@item disk:[format=@var{format}]:@var{file}
445
446
Mass storage device based on file. The optional @var{format} argument
will be used rather than detecting the format. Can be used to specifiy
447
@code{format=raw} to avoid interpreting an untrusted format header.
448

449
450
@item host:@var{bus}.@var{addr}
Pass through the host device identified by @var{bus}.@var{addr} (Linux only).
451

452
453
454
@item host:@var{vendor_id}:@var{product_id}
Pass through the host device identified by @var{vendor_id}:@var{product_id}
(Linux only).
455
456
457
458
459
460
461
462
463

@item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
Serial converter to host character device @var{dev}, see @code{-serial} for the
available devices.

@item braille
Braille device.  This will use BrlAPI to display the braille output on a real
or fake device.

464
@item net:@var{options}
465
466
467
468
469
Network adapter that supports CDC ethernet and RNDIS protocols.

@end table
ETEXI

470
DEF("device", HAS_ARG, QEMU_OPTION_device,
471
472
473
    "-device driver[,prop[=value][,...]]\n"
    "                add device (based on driver)\n"
    "                prop=value,... sets driver properties\n"
474
    "                use -device ? to print all possible drivers\n"
475
    "                use -device driver,? to print all possible properties\n",
476
    QEMU_ARCH_ALL)
477
STEXI
478
@item -device @var{driver}[,@var{prop}[=@var{value}][,...]]
479
@findex -device
480
481
482
483
Add device @var{driver}.  @var{prop}=@var{value} sets driver
properties.  Valid properties depend on the driver.  To get help on
possible drivers and properties, use @code{-device ?} and
@code{-device @var{driver},?}.
484
485
ETEXI

486
487
488
DEFHEADING(File system options:)

DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev,
489
    "-fsdev local,id=id,path=path,security_model=[mapped|passthrough|none]\n",
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
    QEMU_ARCH_ALL)

STEXI

The general form of a File system device option is:
@table @option

@item -fsdev @var{fstype} ,id=@var{id} [,@var{options}]
@findex -fsdev
Fstype is one of:
@option{local},
The specific Fstype will determine the applicable options.

Options to each backend are described below.

505
@item -fsdev local ,id=@var{id} ,path=@var{path} ,security_model=@var{security_model}
506
507
508
509
510
511
512

Create a file-system-"device" for local-filesystem.

@option{local} is only available on Linux.

@option{path} specifies the path to be exported. @option{path} is required.

513
514
515
@option{security_model} specifies the security model to be followed.
@option{security_model} is required.

516
517
518
@end table
ETEXI

519
520
521
DEFHEADING(Virtual File system pass-through options:)

DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs,
522
    "-virtfs local,path=path,mount_tag=tag,security_model=[mapped|passthrough|none]\n",
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
    QEMU_ARCH_ALL)

STEXI

The general form of a Virtual File system pass-through option is:
@table @option

@item -virtfs @var{fstype} [,@var{options}]
@findex -virtfs
Fstype is one of:
@option{local},
The specific Fstype will determine the applicable options.

Options to each backend are described below.

538
@item -virtfs local ,path=@var{path} ,mount_tag=@var{mount_tag} ,security_model=@var{security_model}
539
540
541
542
543
544
545

Create a Virtual file-system-pass through for local-filesystem.

@option{local} is only available on Linux.

@option{path} specifies the path to be exported. @option{path} is required.

546
547
548
549
@option{security_model} specifies the security model to be followed.
@option{security_model} is required.


550
551
552
553
554
555
@option{mount_tag} specifies the tag with which the exported file is mounted.
@option{mount_tag} is required.

@end table
ETEXI

556
557
DEFHEADING()

558
DEF("name", HAS_ARG, QEMU_OPTION_name,
559
560
    "-name string1[,process=string2]\n"
    "                set the name of the guest\n"
561
562
    "                string1 sets the window title and string2 the process name (on Linux)\n",
    QEMU_ARCH_ALL)
563
564
STEXI
@item -name @var{name}
565
@findex -name
566
567
568
Sets the @var{name} of the guest.
This name will be displayed in the SDL window caption.
The @var{name} will also be used for the VNC server.
569
Also optionally set the top visible process name in Linux.
570
571
572
ETEXI

DEF("uuid", HAS_ARG, QEMU_OPTION_uuid,
573
    "-uuid %08x-%04x-%04x-%04x-%012x\n"
574
    "                specify machine UUID\n", QEMU_ARCH_ALL)
575
576
STEXI
@item -uuid @var{uuid}
577
@findex -uuid
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
Set system UUID.
ETEXI

STEXI
@end table
ETEXI

DEFHEADING()

DEFHEADING(Display options:)

STEXI
@table @option
ETEXI

Jes Sorensen's avatar
Jes Sorensen committed
593
594
DEF("display", HAS_ARG, QEMU_OPTION_display,
    "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n"
Jes Sorensen's avatar
Jes Sorensen committed
595
596
    "            [,window_close=on|off]|curses|none|\n"
    "            vnc=<display>[,<optargs>]\n"
Jes Sorensen's avatar
Jes Sorensen committed
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
    "                select display type\n", QEMU_ARCH_ALL)
STEXI
@item -display @var{type}
@findex -display
Select type of display to use. This option is a replacement for the
old style -sdl/-curses/... options. Valid values for @var{type} are
@table @option
@item sdl
Display video output via SDL (usually in a separate graphics
window; see the SDL documentation for other possibilities).
@item curses
Display video output via curses. For graphics device models which
support a text mode, QEMU can display this output using a
curses/ncurses interface. Nothing is displayed when the graphics
device is in graphical mode or if the graphics device does not support
a text mode. Generally only the VGA device models support text mode.
Jes Sorensen's avatar
Jes Sorensen committed
613
614
615
616
617
618
@item none
Do not display video output. The guest will still see an emulated
graphics card, but its output will not be displayed to the QEMU
user. This option differs from the -nographic option in that it
only affects what is done with video output; -nographic also changes
the destination of the serial and parallel port data.
Jes Sorensen's avatar
Jes Sorensen committed
619
620
@item vnc
Start a VNC server on display <arg>
Jes Sorensen's avatar
Jes Sorensen committed
621
622
623
@end table
ETEXI

624
DEF("nographic", 0, QEMU_OPTION_nographic,
625
626
    "-nographic      disable graphical output and redirect serial I/Os to console\n",
    QEMU_ARCH_ALL)
627
628
STEXI
@item -nographic
629
@findex -nographic
630
631
632
633
634
635
636
637
Normally, QEMU uses SDL to display the VGA output. With this option,
you can totally disable graphical output so that QEMU is a simple
command line application. The emulated serial port is redirected on
the console. Therefore, you can still use QEMU to debug a Linux kernel
with a serial console.
ETEXI

DEF("curses", 0, QEMU_OPTION_curses,
638
639
    "-curses         use a curses/ncurses interface instead of SDL\n",
    QEMU_ARCH_ALL)
640
641
STEXI
@item -curses
642
@findex curses
643
644
645
646
647
648
Normally, QEMU uses SDL to display the VGA output.  With this option,
QEMU can display the VGA output when in text mode using a
curses/ncurses interface.  Nothing is displayed in graphical mode.
ETEXI

DEF("no-frame", 0, QEMU_OPTION_no_frame,
649
650
    "-no-frame       open SDL window without a frame and window decorations\n",
    QEMU_ARCH_ALL)
651
652
STEXI
@item -no-frame
653
@findex -no-frame
654
655
656
657
658
659
Do not use decorations for SDL windows and start them using the whole
available screen space. This makes the using QEMU in a dedicated desktop
workspace more convenient.
ETEXI

DEF("alt-grab", 0, QEMU_OPTION_alt_grab,
660
661
    "-alt-grab       use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n",
    QEMU_ARCH_ALL)
662
663
STEXI
@item -alt-grab
664
@findex -alt-grab
665
666
667
Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt).
ETEXI

668
DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab,
669
670
    "-ctrl-grab      use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n",
    QEMU_ARCH_ALL)
671
672
STEXI
@item -ctrl-grab
673
@findex -ctrl-grab
674
675
676
Use Right-Ctrl to grab mouse (instead of Ctrl-Alt).
ETEXI

677
DEF("no-quit", 0, QEMU_OPTION_no_quit,
678
    "-no-quit        disable SDL window close capability\n", QEMU_ARCH_ALL)
679
680
STEXI
@item -no-quit
681
@findex -no-quit
682
683
684
685
Disable SDL window close capability.
ETEXI

DEF("sdl", 0, QEMU_OPTION_sdl,
686
    "-sdl            enable SDL\n", QEMU_ARCH_ALL)
687
688
STEXI
@item -sdl
689
@findex -sdl
690
691
692
Enable SDL.
ETEXI

Gerd Hoffmann's avatar
Gerd Hoffmann committed
693
694
695
696
697
698
699
700
701
702
DEF("spice", HAS_ARG, QEMU_OPTION_spice,
    "-spice <args>   enable spice\n", QEMU_ARCH_ALL)
STEXI
@item -spice @var{option}[,@var{option}[,...]]
@findex -spice
Enable the spice remote desktop protocol. Valid options are

@table @option

@item port=<nr>
Gerd Hoffmann's avatar
Gerd Hoffmann committed
703
Set the TCP port spice is listening on for plaintext channels.
Gerd Hoffmann's avatar
Gerd Hoffmann committed
704

705
706
707
708
709
710
711
@item addr=<addr>
Set the IP address spice is listening on.  Default is any address.

@item ipv4
@item ipv6
Force using the specified IP version.

Gerd Hoffmann's avatar
Gerd Hoffmann committed
712
713
714
715
716
717
@item password=<secret>
Set the password you need to authenticate.

@item disable-ticketing
Allow client connects without authentication.

Gerd Hoffmann's avatar
Gerd Hoffmann committed
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
@item tls-port=<nr>
Set the TCP port spice is listening on for encrypted channels.

@item x509-dir=<dir>
Set the x509 file directory. Expects same filenames as -vnc $display,x509=$dir

@item x509-key-file=<file>
@item x509-key-password=<file>
@item x509-cert-file=<file>
@item x509-cacert-file=<file>
@item x509-dh-key-file=<file>
The x509 file names can also be configured individually.

@item tls-ciphers=<list>
Specify which ciphers to use.

734
735
736
737
738
739
740
741
@item tls-channel=[main|display|inputs|record|playback|tunnel]
@item plaintext-channel=[main|display|inputs|record|playback|tunnel]
Force specific channel to be used with or without TLS encryption.  The
options can be specified multiple times to configure multiple
channels.  The special name "default" can be used to set the default
mode.  For channels which are not explicitly forced into one mode the
spice client is allowed to pick tls/plaintext as he pleases.

742
743
744
745
746
747
748
749
750
@item image-compression=[auto_glz|auto_lz|quic|glz|lz|off]
Configure image compression (lossless).
Default is auto_glz.

@item jpeg-wan-compression=[auto|never|always]
@item zlib-glz-wan-compression=[auto|never|always]
Configure wan image compression (lossy for slow links).
Default is auto.

Gerd Hoffmann's avatar
Gerd Hoffmann committed
751
752
753
754
755
756
757
758
759
@item streaming-video=[off|all|filter]
Configure video stream detection.  Default is filter.

@item agent-mouse=[on|off]
Enable/disable passing mouse events via vdagent.  Default is on.

@item playback-compression=[on|off]
Enable/disable audio stream compression (using celt 0.5.1).  Default is on.

Gerd Hoffmann's avatar
Gerd Hoffmann committed
760
761
762
@end table
ETEXI

763
DEF("portrait", 0, QEMU_OPTION_portrait,
764
765
    "-portrait       rotate graphical output 90 deg left (only PXA LCD)\n",
    QEMU_ARCH_ALL)
766
767
STEXI
@item -portrait
768
@findex -portrait
769
770
771
772
Rotate graphical output 90 deg left (only PXA LCD).
ETEXI

DEF("vga", HAS_ARG, QEMU_OPTION_vga,
Gerd Hoffmann's avatar
Gerd Hoffmann committed
773
    "-vga [std|cirrus|vmware|qxl|xenfb|none]\n"
774
    "                select video card type\n", QEMU_ARCH_ALL)
775
776
STEXI
@item -vga @var{type}
777
@findex -vga
778
Select type of VGA card to emulate. Valid values for @var{type} are
779
@table @option
780
781
782
783
784
785
786
787
788
789
790
791
792
793
@item cirrus
Cirrus Logic GD5446 Video card. All Windows versions starting from
Windows 95 should recognize and use this graphic card. For optimal
performances, use 16 bit color depth in the guest and the host OS.
(This one is the default)
@item std
Standard VGA card with Bochs VBE extensions.  If your guest OS
supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
to use high resolution modes (>= 1280x1024x16) then you should use
this option.
@item vmware
VMWare SVGA-II compatible adapter. Use it if you have sufficiently
recent XFree86/XOrg server or Windows guest with a driver for this
card.
Gerd Hoffmann's avatar
Gerd Hoffmann committed
794
795
796
797
@item qxl
QXL paravirtual graphic card.  It is VGA compatible (including VESA
2.0 VBE support).  Works best with qxl guest drivers installed though.
Recommended choice when using the spice protocol.
798
799
800
801
802
803
@item none
Disable VGA card.
@end table
ETEXI

DEF("full-screen", 0, QEMU_OPTION_full_screen,
804
    "-full-screen    start in full screen\n", QEMU_ARCH_ALL)
805
806
STEXI
@item -full-screen
807
@findex -full-screen
808
809
810
811
Start in full screen.
ETEXI

DEF("g", 1, QEMU_OPTION_g ,
812
813
    "-g WxH[xDEPTH]  Set the initial graphical resolution and depth\n",
    QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
814
STEXI
815
@item -g @var{width}x@var{height}[x@var{depth}]
816
@findex -g
817
Set the initial graphical resolution and depth (PPC, SPARC only).
818
819
820
ETEXI

DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
821
    "-vnc display    start a VNC server on display\n", QEMU_ARCH_ALL)
822
823
STEXI
@item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
824
@findex -vnc
825
826
827
828
829
830
831
832
Normally, QEMU uses SDL to display the VGA output.  With this option,
you can have QEMU listen on VNC display @var{display} and redirect the VGA
display over the VNC session.  It is very useful to enable the usb
tablet device when using this option (option @option{-usbdevice
tablet}). When using the VNC display, you must use the @option{-k}
parameter to set the keyboard layout if you are not using en-us. Valid
syntax for the @var{display} is

833
@table @option
834
835
836
837
838
839
840

@item @var{host}:@var{d}

TCP connections will only be allowed from @var{host} on display @var{d}.
By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
be omitted in which case the server will accept connections from any host.

841
@item unix:@var{path}
842
843
844
845
846
847
848
849
850
851
852
853
854
855

Connections will be allowed over UNIX domain sockets where @var{path} is the
location of a unix socket to listen for connections on.

@item none

VNC is initialized but not started. The monitor @code{change} command
can be used to later start the VNC server.

@end table

Following the @var{display} value there may be one or more @var{option} flags
separated by commas. Valid options are

856
@table @option
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875

@item reverse

Connect to a listening VNC client via a ``reverse'' connection. The
client is specified by the @var{display}. For reverse network
connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
is a TCP port number, not a display number.

@item password

Require that password based authentication is used for client connections.
The password must be set separately using the @code{change} command in the
@ref{pcsys_monitor}

@item tls

Require that client use TLS when communicating with the VNC server. This
uses anonymous TLS credentials so is susceptible to a man-in-the-middle
attack. It is recommended that this option be combined with either the
876
@option{x509} or @option{x509verify} options.
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927

@item x509=@var{/path/to/certificate/dir}

Valid if @option{tls} is specified. Require that x509 credentials are used
for negotiating the TLS session. The server will send its x509 certificate
to the client. It is recommended that a password be set on the VNC server
to provide authentication of the client when this is used. The path following
this option specifies where the x509 certificates are to be loaded from.
See the @ref{vnc_security} section for details on generating certificates.

@item x509verify=@var{/path/to/certificate/dir}

Valid if @option{tls} is specified. Require that x509 credentials are used
for negotiating the TLS session. The server will send its x509 certificate
to the client, and request that the client send its own x509 certificate.
The server will validate the client's certificate against the CA certificate,
and reject clients when validation fails. If the certificate authority is
trusted, this is a sufficient authentication mechanism. You may still wish
to set a password on the VNC server as a second authentication layer. The
path following this option specifies where the x509 certificates are to
be loaded from. See the @ref{vnc_security} section for details on generating
certificates.

@item sasl

Require that the client use SASL to authenticate with the VNC server.
The exact choice of authentication method used is controlled from the
system / user's SASL configuration file for the 'qemu' service. This
is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
unprivileged user, an environment variable SASL_CONF_PATH can be used
to make it search alternate locations for the service config.
While some SASL auth methods can also provide data encryption (eg GSSAPI),
it is recommended that SASL always be combined with the 'tls' and
'x509' settings to enable use of SSL and server certificates. This
ensures a data encryption preventing compromise of authentication
credentials. See the @ref{vnc_security} section for details on using
SASL authentication.

@item acl

Turn on access control lists for checking of the x509 client certificate
and SASL party. For x509 certs, the ACL check is made against the
certificate's distinguished name. This is something that looks like
@code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
made against the username, which depending on the SASL plugin, may
include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
When the @option{acl} flag is set, the initial access list will be
empty, with a @code{deny} policy. Thus no one will be allowed to
use the VNC server until the ACLs have been loaded. This can be
achieved using the @code{acl} monitor command.

Corentin Chary's avatar
Corentin Chary committed
928
929
930
931
932
933
934
@item lossy

Enable lossy compression methods (gradient, JPEG, ...). If this
option is set, VNC client may receive lossy framebuffer updates
depending on its encoding settings. Enabling this option can save
a lot of bandwidth at the expense of quality.

935
936
937
938
939
@item non-adaptive

Disable adaptive encodings. Adaptive encodings are enabled by default.
An adaptive encoding will try to detect frequently updated screen regions,
and send updates in these regions using a lossy encoding (like JPEG).
940
941
This can be really helpful to save bandwidth when playing videos. Disabling
adaptive encodings allows to restore the original static behavior of encodings
942
943
like Tight.

944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
@end table
ETEXI

STEXI
@end table
ETEXI

DEFHEADING()

DEFHEADING(i386 target only:)
STEXI
@table @option
ETEXI

DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack,
959
960
    "-win2k-hack     use it when installing Windows 2000 to avoid a disk full bug\n",
    QEMU_ARCH_I386)
961
962
STEXI
@item -win2k-hack
963
@findex -win2k-hack
964
965
966
967
968
Use it when installing Windows 2000 to avoid a disk full bug. After
Windows 2000 is installed, you no longer need this option (this option
slows down the IDE transfers).
ETEXI

969
HXCOMM Deprecated by -rtc
970
DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386)
971
972

DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk,
973
974
    "-no-fd-bootchk  disable boot signature checking for floppy disks\n",
    QEMU_ARCH_I386)
975
976
STEXI
@item -no-fd-bootchk
977
@findex -no-fd-bootchk
978
979
Disable boot signature checking for floppy disks in Bochs BIOS. It may
be needed to boot from old floppy disks.
980
TODO: check reference to Bochs BIOS.
981
982
983
ETEXI

DEF("no-acpi", 0, QEMU_OPTION_no_acpi,
984
           "-no-acpi        disable ACPI\n", QEMU_ARCH_I386)
985
986
STEXI
@item -no-acpi
987
@findex -no-acpi
988
989
990
991
992
993
Disable ACPI (Advanced Configuration and Power Interface) support. Use
it if your guest OS complains about ACPI problems (PC target machine
only).
ETEXI

DEF("no-hpet", 0, QEMU_OPTION_no_hpet,
994
    "-no-hpet        disable HPET\n", QEMU_ARCH_I386)
995
996
STEXI
@item -no-hpet
997
@findex -no-hpet
998
999
1000
Disable HPET support.
ETEXI

1001
1002
1003
DEF("balloon", HAS_ARG, QEMU_OPTION_balloon,
    "-balloon none   disable balloon device\n"
    "-balloon virtio[,addr=str]\n"
1004
    "                enable virtio balloon device (default)\n", QEMU_ARCH_ALL)
1005
STEXI
1006
@item -balloon none
1007
@findex -balloon
1008
1009
1010
1011
Disable balloon device.
@item -balloon virtio[,addr=@var{addr}]
Enable virtio balloon device (default), optionally with PCI address
@var{addr}.
1012
1013
ETEXI

1014
1015
DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable,
    "-acpitable [sig=str][,rev=n][,oem_id=str][,oem_table_id=str][,oem_rev=n][,asl_compiler_id=str][,asl_compiler_rev=n][,data=file1[:file2]...]\n"
1016
    "                ACPI table description\n", QEMU_ARCH_I386)
1017
1018
STEXI
@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}]...]
1019
@findex -acpitable
1020
1021
1022
Add ACPI table with specified header fields and context from specified files.
ETEXI

1023
1024
DEF("smbios", HAS_ARG, QEMU_OPTION_smbios,
    "-smbios file=binary\n"
1025
    "                load SMBIOS entry from binary file\n"
1026
    "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n"
1027
    "                specify SMBIOS type 0 fields\n"
1028
1029
    "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n"
    "              [,uuid=uuid][,sku=str][,family=str]\n"
1030
    "                specify SMBIOS type 1 fields\n", QEMU_ARCH_I386)
1031
1032
STEXI
@item -smbios file=@var{binary}
1033
@findex -smbios
1034
1035
1036
Load SMBIOS entry from binary file.

@item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}]
1037
@findex -smbios
1038
1039
Specify SMBIOS type 0 fields

Blue Swirl's avatar
Blue Swirl committed
1040
@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}]
1041
1042
1043
Specify SMBIOS type 1 fields
ETEXI

1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
DEFHEADING()
STEXI
@end table
ETEXI

DEFHEADING(Network options:)
STEXI
@table @option
ETEXI

1054
1055
HXCOMM Legacy slirp options (now moved to -net user):
#ifdef CONFIG_SLIRP
1056
1057
1058
DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL)
DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL)
DEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL)
1059
#ifndef _WIN32
1060
DEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL)
1061
1062
1063
#endif
#endif

Blue Swirl's avatar
Blue Swirl committed
1064
DEF("net", HAS_ARG, QEMU_OPTION_net,
1065
    "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n"
1066
1067
    "                create a new Network Interface Card and connect it to VLAN 'n'\n"
#ifdef CONFIG_SLIRP
1068
1069
1070
    "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=y|n]\n"
    "         [,hostname=host][,dhcpstart=addr][,dns=addr][,tftp=dir][,bootfile=f]\n"
    "         [,hostfwd=rule][,guestfwd=rule]"
1071
#ifndef _WIN32
1072
                                             "[,smb=dir[,smbserver=addr]]\n"
1073
1074
1075
#endif
    "                connect the user mode network stack to VLAN 'n', configure its\n"
    "                DHCP server and enabled optional services\n"
1076
1077
1078
1079
1080
#endif
#ifdef _WIN32
    "-net tap[,vlan=n][,name=str],ifname=name\n"
    "                connect the host TAP network interface to VLAN 'n'\n"
#else
1081
    "-net tap[,vlan=n][,name=str][,fd=h][,ifname=name][,script=file][,downscript=dfile][,sndbuf=nbytes][,vnet_hdr=on|off][,vhost=on|off][,vhostfd=h][,vhostforce=on|off]\n"
1082
    "                connect the host TAP network interface to VLAN 'n' and use the\n"
1083
1084
    "                network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n"
    "                and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n"
1085
    "                use '[down]script=no' to disable script execution\n"
1086
    "                use 'fd=h' to connect to an already opened TAP interface\n"
1087
    "                use 'sndbuf=nbytes' to limit the size of the send buffer (the\n"
Michael S. Tsirkin's avatar
Michael S. Tsirkin committed
1088
    "                default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n"
1089
1090
    "                use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n"
    "                use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n"
1091
    "                use vhost=on to enable experimental in kernel accelerator\n"
1092
1093
    "                    (only has effect for virtio guests which use MSIX)\n"
    "                use vhostforce=on to force vhost on for non-MSIX virtio guests\n"
1094
    "                use 'vhostfd=h' to connect to an already opened vhost net device\n"
1095
1096
1097
#endif
    "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n"
    "                connect the vlan 'n' to another VLAN using a socket connection\n"
1098
    "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port[,localaddr=addr]]\n"
1099
    "                connect the vlan 'n' to multicast maddr and port\n"
1100
    "                use 'localaddr=addr' to specify the host address to send packets from\n"
1101
1102
1103
1104
1105
1106
1107
#ifdef CONFIG_VDE
    "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n"
    "                connect the vlan 'n' to port 'n' of a vde switch running\n"
    "                on host and listening for incoming connections on 'socketpath'.\n"
    "                Use group 'groupname' and mode 'octalmode' to change default\n"
    "                ownership and permissions for communication port.\n"
#endif
1108
1109
    "-net dump[,vlan=n][,file=f][,len=n]\n"
    "                dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n"
1110
    "-net none       use it alone to have zero network devices. If no -net option\n"
1111
    "                is provided, the default is '-net nic -net user'\n", QEMU_ARCH_ALL)
Mark McLoughlin's avatar
Mark McLoughlin committed
1112
1113
1114
1115
1116
1117
1118
1119
1120
DEF("netdev", HAS_ARG, QEMU_OPTION_netdev,
    "-netdev ["
#ifdef CONFIG_SLIRP
    "user|"
#endif
    "tap|"
#ifdef CONFIG_VDE
    "vde|"
#endif
1121
    "socket],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL)
1122
STEXI
Blue Swirl's avatar
Blue Swirl committed
1123
@item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}]
1124
@findex -net
1125
Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
1126
= 0 is the default). The NIC is an e1000 by default on the PC
1127
1128
target. Optionally, the MAC address can be changed to @var{mac}, the
device address set to @var{addr} (PCI cards only),
1129
1130
1131
1132
1133
and a @var{name} can be assigned for use in monitor commands.
Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
that the card should have; this option currently only affects virtio cards; set
@var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
NIC is created.  Qemu can emulate several different models of network card.
1134
Valid values for @var{type} are
1135
@code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er},
1136
1137
1138
1139
1140
@code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
@code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
Not all devices are supported on all targets.  Use -net nic,model=?
for a list of available devices for your target.

1141
@item -net user[,@var{option}][,@var{option}][,...]
1142
Use the user mode network stack which requires no administrator
1143
1144
privilege to run. Valid options are:

1145
@table @option
1146
1147
1148
1149
1150
1151
@item vlan=@var{n}
Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default).

@item name=@var{name}
Assign symbolic name for use in monitor commands.

1152
1153
1154
@item net=@var{addr}[/@var{mask}]
Set IP network address the guest will see. Optionally specify the netmask,
either in the form a.b.c.d or as number of valid top-most bits. Default is
Brad Hards's avatar
Brad Hards committed
1155
10.0.2.0/24.
1156
1157
1158
1159

@item host=@var{addr}
Specify the guest-visible address of the host. Default is the 2nd IP in the
guest network, i.e. x.x.x.2.
1160
1161
1162
1163
1164
1165
1166
1167
1168

@item restrict=y|yes|n|no
If this options is enabled, the guest will be isolated, i.e. it will not be
able to contact the host and no guest IP packets will be routed over the host
to the outside. This option does not affect explicitly set forwarding rule.

@item hostname=@var{name}
Specifies the client hostname reported by the builtin DHCP server.

1169
1170
@item dhcpstart=@var{addr}
Specify the first of the 16 IPs the built-in DHCP server can assign. Default
Brad Hards's avatar
Brad Hards committed
1171
is the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31.
1172
1173
1174
1175
1176
1177

@item dns=@var{addr}
Specify the guest-visible address of the virtual nameserver. The address must
be different from the host address. Default is the 3rd IP in the guest network,
i.e. x.x.x.3.

1178
1179
1180
1181
@item tftp=@var{dir}
When using the user mode network stack, activate a built-in TFTP
server. The files in @var{dir} will be exposed as the root of a TFTP server.
The TFTP client on the guest must be configured in binary mode (use the command
1182
@code{bin} of the Unix TFTP client).
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193

@item bootfile=@var{file}
When using the user mode network stack, broadcast @var{file} as the BOOTP
filename. In conjunction with @option{tftp}, this can be used to network boot
a guest from a local directory.

Example (using pxelinux):
@example
qemu -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
@end example

1194
@item smb=@var{dir}[,smbserver=@var{addr}]
1195
1196
When using the user mode network stack, activate a built-in SMB
server so that Windows OSes can access to the host files in @file{@var{dir}}
1197
1198
transparently. The IP address of the SMB server can be set to @var{addr}. By
default the 4th IP in the guest network is used, i.e. x.x.x.4.
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212

In the guest Windows OS, the line:
@example
10.0.2.4 smbserver
@end example
must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).

Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.

Note that a SAMBA server must be installed on the host OS in
@file{/usr/sbin/smbd}. QEMU was tested successfully with smbd versions from
Red Hat 9, Fedora Core 3 and OpenSUSE 11.x.

1213
@item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
1214
1215
1216
Redirect incoming TCP or UDP connections to the host port @var{hostport} to
the guest IP address @var{guestaddr} on guest port @var{guestport}. If
@var{guestaddr} is not specified, its value is x.x.x.15 (default first address
1217
1218
given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
be bound to a specific host interface. If no connection type is set, TCP is
1219
used. This option can be given multiple times.
1220
1221
1222
1223
1224
1225

For example, to redirect host X11 connection from screen 1 to guest
screen 0, use the following:

@example
# on the host
1226
qemu -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...]
1227
1228
1229
1230
1231
1232
1233
1234
1235
# this host xterm should open in the guest X11 server
xterm -display :1
@end example

To redirect telnet connections from host port 5555 to telnet port on
the guest, use the following:

@example
# on the host
1236
qemu -net user,hostfwd=tcp::5555-:23 [...]
1237
1238
1239
1240
1241
telnet localhost 5555
@end example

Then when you use on the host @code{telnet localhost 5555}, you
connect to the guest telnet server.
1242

1243
@item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
1244
1245
Forward guest TCP connections to the IP address @var{server} on port @var{port}
to the character device @var{dev}. This option can be given multiple times.
1246
1247
1248
1249
1250
1251
1252

@end table

Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still
processed and applied to -net user. Mixing them with the new configuration
syntax gives undefined results. Their use for new applications is discouraged
as they will be removed from future versions.
1253

Blue Swirl's avatar
Blue Swirl committed
1254
@item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}] [,script=@var{file}][,downscript=@var{dfile}]
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
Connect the host TAP network interface @var{name} to VLAN @var{n}, use
the network script @var{file} to configure it and the network script
@var{dfile} to deconfigure it. If @var{name} is not provided, the OS
automatically provides one. @option{fd}=@var{h} can be used to specify
the handle of an already opened host TAP interface. The default network
configure script is @file{/etc/qemu-ifup} and the default network
deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no}
or @option{downscript=no} to disable script execution. Example:

@example
qemu linux.img -net nic -net tap
@end example

More complicated example (two NICs, each one connected to a TAP device)
@example
qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
               -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
@end example

Blue Swirl's avatar
Blue Swirl committed
1274
@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293

Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
machine using a TCP socket connection. If @option{listen} is
specified, QEMU waits for incoming connections on @var{port}
(@var{host} is optional). @option{connect} is used to connect to
another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
specifies an already opened TCP socket.

Example:
@example
# launch a first QEMU instance
qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
               -net socket,listen=:1234
# connect the VLAN 0 of this instance to the VLAN 0
# of the first instance
qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
               -net socket,connect=127.0.0.1:1234
@end example

1294
@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]]
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333

Create a VLAN @var{n} shared with another QEMU virtual
machines using a UDP multicast socket, effectively making a bus for
every QEMU with same multicast address @var{maddr} and @var{port}.
NOTES:
@enumerate
@item
Several QEMU can be running on different hosts and share same bus (assuming
correct multicast setup for these hosts).
@item
mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
@url{http://user-mode-linux.sf.net}.
@item
Use @option{fd=h} to specify an already opened UDP multicast socket.
@end enumerate

Example:
@example
# launch one QEMU instance
qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
               -net socket,mcast=230.0.0.1:1234
# launch another QEMU instance on same "bus"
qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
               -net socket,mcast=230.0.0.1:1234
# launch yet another QEMU instance on same "bus"
qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
               -net socket,mcast=230.0.0.1:1234
@end example

Example (User Mode Linux compat.):
@example
# launch QEMU instance (note mcast address selected
# is UML's default)
qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
               -net socket,mcast=239.192.168.1:1102
# launch UML
/path/to/linux ubd0=/path/to/root_fs eth0=mcast
@end example

1334
1335
1336
1337
1338
1339
Example (send packets from host's 1.2.3.4):
@example
qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
               -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4
@end example

Blue Swirl's avatar
Blue Swirl committed
1340
@item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
and MODE @var{octalmode} to change default ownership and permissions for
communication port. This option is available only if QEMU has been compiled
with vde support enabled.

Example:
@example
# launch vde switch
vde_switch -F -sock /tmp/myswitch
# launch QEMU instance
qemu linux.img -net nic -net vde,sock=/tmp/myswitch
@end example

1355
1356
1357
1358
1359
@item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
At most @var{len} bytes (64k by default) per packet are stored. The file format is
libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.

1360
1361
1362
1363
1364
1365
1366
1367
@item -net none
Indicate that no network devices should be configured. It is used to
override the default configuration (@option{-net nic -net user}) which
is activated if no @option{-net} options are provided.

@end table
ETEXI

1368
1369
1370
1371
1372
DEFHEADING()

DEFHEADING(Character device options:)

DEF("chardev", HAS_ARG, QEMU_OPTION_chardev,
Jan Kiszka's avatar
Jan Kiszka committed
1373
    "-chardev null,id=id[,mux=on|off]\n"
1374
    "-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n"
Jan Kiszka's avatar
Jan Kiszka committed
1375
1376
    "         [,server][,nowait][,telnet][,mux=on|off] (tcp)\n"
    "-chardev socket,id=id,path=path[,server][,nowait][,telnet],[mux=on|off] (unix)\n"
1377
    "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n"
Jan Kiszka's avatar
Jan Kiszka committed
1378
1379
    "         [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n"
    "-chardev msmouse,id=id[,mux=on|off]\n"
1380
    "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n"
Jan Kiszka's avatar
Jan Kiszka committed
1381
1382
1383
    "         [,mux=on|off]\n"
    "-chardev file,id=id,path=path[,mux=on|off]\n"
    "-chardev pipe,id=id,path=path[,mux=on|off]\n"
1384
#ifdef _WIN32
Jan Kiszka's avatar
Jan Kiszka committed
1385
1386
    "-chardev console,id=id[,mux=on|off]\n"
    "-chardev serial,id=id,path=path[,mux=on|off]\n"
1387
#else
Jan Kiszka's avatar
Jan Kiszka committed
1388
    "-chardev pty,id=id[,mux=on|off]\n"
1389
    "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n"
1390
1391
#endif
#ifdef CONFIG_BRLAPI
Jan Kiszka's avatar
Jan Kiszka committed
1392
    "-chardev braille,id=id[,mux=on|off]\n"
1393
1394
1395
#endif
#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
        || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
Jan Kiszka's avatar
Jan Kiszka committed
1396
    "-chardev tty,id=id,path=path[,mux=on|off]\n"
1397
1398
#endif
#if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__)
Jan Kiszka's avatar
Jan Kiszka committed
1399
    "-chardev parport,id=id,path=path[,mux=on|off]\n"
Alon Levy's avatar
Alon Levy committed
1400
1401
1402
#endif
#if defined(CONFIG_SPICE)
    "-chardev spicevmc,id=id,name=name[,debug=debug]\n"
1403
#endif
1404
    , QEMU_ARCH_ALL
1405
1406
1407
1408
1409
1410
1411
)

STEXI

The general form of a character device option is:
@table @option

Jan Kiszka's avatar
Jan Kiszka committed
1412
@item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}]
1413
@findex -chardev
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
Backend is one of:
@option{null},
@option{socket},
@option{udp},
@option{msmouse},
@option{vc},
@option{file},
@option{pipe},
@option{console},
@option{serial},
@option{pty},
@option{stdio},
@option{braille},
@option{tty},
Alon Levy's avatar
Alon Levy committed
1428
1429
@option{parport},
@option{spicevmc}.
1430
1431
1432
1433
1434
The specific backend will determine the applicable options.

All devices must have an id, which can be any string up to 127 characters long.
It is used to uniquely identify this device in other command line directives.

Jan Kiszka's avatar
Jan Kiszka committed